babylon.module.d.ts 6.7 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752125753125754125755125756125757125758125759125760125761125762125763125764125765125766125767125768125769125770125771125772125773125774125775125776125777125778125779125780125781125782125783125784125785125786125787125788125789125790125791125792125793125794125795125796125797125798125799125800125801125802125803125804125805125806125807125808125809125810125811125812125813125814125815125816125817125818125819125820125821125822125823125824125825125826125827125828125829125830125831125832125833125834125835125836125837125838125839125840125841125842125843125844125845125846125847125848125849125850125851125852125853125854125855125856125857125858125859125860125861125862125863125864125865125866125867125868125869125870125871125872125873125874125875125876125877125878125879125880125881125882125883125884125885125886125887125888125889125890125891125892125893125894125895125896125897125898125899125900125901125902125903125904125905125906125907125908125909125910125911125912125913125914125915125916125917125918125919125920125921125922125923125924125925125926125927125928125929125930125931125932125933125934125935125936125937125938125939125940125941125942125943125944125945125946125947125948125949125950125951125952125953125954125955125956125957125958125959125960125961125962125963125964125965125966125967125968125969125970125971125972125973125974125975125976125977125978125979125980125981125982125983125984125985125986125987125988125989125990125991125992125993125994125995125996125997125998125999126000126001126002126003126004126005126006126007126008126009126010126011126012126013126014126015126016126017126018126019126020126021126022126023126024126025126026126027126028126029126030126031126032126033126034126035126036126037126038126039126040126041126042126043126044126045126046126047126048126049126050126051126052126053126054126055126056126057126058126059126060126061126062126063126064126065126066126067126068126069126070126071126072126073126074126075126076126077126078126079126080126081126082126083126084126085126086126087126088126089126090126091126092126093126094126095126096126097126098126099126100126101126102126103126104126105126106126107126108126109126110126111126112126113126114126115126116126117126118126119126120126121126122126123126124126125126126126127126128126129126130126131126132126133126134126135126136126137126138126139126140126141126142126143126144126145126146126147126148126149126150126151126152126153126154126155126156126157126158126159126160126161126162126163126164126165126166126167126168126169126170126171126172126173126174126175126176126177126178126179126180126181126182126183126184126185126186126187126188126189126190126191126192126193126194126195126196126197126198126199126200126201126202126203126204126205126206126207126208126209126210126211126212126213126214126215126216126217126218126219126220126221126222126223126224126225126226126227126228126229126230126231126232126233126234126235126236126237126238126239126240126241126242126243126244126245126246126247126248126249126250126251126252126253126254126255126256126257126258126259126260126261126262126263126264126265126266126267126268126269126270126271126272126273126274126275126276126277126278126279126280126281126282126283126284126285126286126287126288126289126290126291126292126293126294126295126296126297126298126299126300126301126302126303126304126305126306126307126308126309126310126311126312126313126314126315126316126317126318126319126320126321126322126323126324126325126326126327126328126329126330126331126332126333126334126335126336126337126338126339126340126341126342126343126344126345126346126347126348126349126350126351126352126353126354126355126356126357126358126359126360126361126362126363126364126365126366126367126368126369126370126371126372126373126374126375126376126377126378126379126380126381126382126383126384126385126386126387126388126389126390126391126392126393126394126395126396126397126398126399126400126401126402126403126404126405126406126407126408126409126410126411126412126413126414126415126416126417126418126419126420126421126422126423126424126425126426126427126428126429126430126431126432126433126434126435126436126437126438126439126440126441126442126443126444126445126446126447126448126449126450126451126452126453126454126455126456126457126458126459126460126461126462126463126464126465126466126467126468126469126470126471126472126473126474126475126476126477126478126479126480126481126482126483126484126485126486126487126488126489126490126491126492126493126494126495126496126497126498126499126500126501126502126503126504126505126506126507126508126509126510126511126512126513126514126515126516126517126518126519126520126521126522126523126524126525126526126527126528126529126530126531126532126533126534126535126536126537126538126539126540126541126542126543126544126545126546126547126548126549126550126551126552126553126554126555126556126557126558126559126560126561126562126563126564126565126566126567126568126569126570126571126572126573126574126575126576126577126578126579126580126581126582126583126584126585126586126587126588126589126590126591126592126593126594126595126596126597126598126599126600126601126602126603126604126605126606126607126608126609126610126611126612126613126614126615126616126617126618126619126620126621126622126623126624126625126626126627126628126629126630126631126632126633126634126635126636126637126638126639126640126641126642126643126644126645126646126647126648126649126650126651126652126653126654126655126656126657126658126659126660126661126662126663126664126665126666126667126668126669126670126671126672126673126674126675126676126677126678126679126680126681126682126683126684126685126686126687126688126689126690126691126692126693126694126695126696126697126698126699126700126701126702126703126704126705126706126707126708126709126710126711126712126713126714126715126716126717126718126719126720126721126722126723126724126725126726126727126728126729126730126731126732126733126734126735126736126737126738126739126740126741126742126743126744126745126746126747126748126749126750126751126752126753126754126755126756126757126758126759126760126761126762126763126764126765126766126767126768126769126770126771126772126773126774126775126776126777126778126779126780126781126782126783126784126785126786126787126788126789126790126791126792126793126794126795126796126797126798126799126800126801126802126803126804126805126806126807126808126809126810126811126812126813126814126815126816126817126818126819126820126821126822126823126824126825126826126827126828126829126830126831126832126833126834126835126836126837126838126839126840126841126842126843126844126845126846126847126848126849126850126851126852126853126854126855126856126857126858126859126860126861126862126863126864126865126866126867126868126869126870126871126872126873126874126875126876126877126878126879126880126881126882126883126884126885126886126887126888126889126890126891126892126893126894126895126896126897126898126899126900126901126902126903126904126905126906126907126908126909126910126911126912126913126914126915126916126917126918126919126920126921126922126923126924126925126926126927126928126929126930126931126932126933126934126935126936126937126938126939126940126941126942126943126944126945126946126947126948126949126950126951126952126953126954126955126956126957126958126959126960126961126962126963126964126965126966126967126968126969126970126971126972126973126974126975126976126977126978126979126980126981126982126983126984126985126986126987126988126989126990126991126992126993126994126995126996126997126998126999127000127001127002127003127004127005127006127007127008127009127010127011127012127013127014127015127016127017127018127019127020127021127022127023127024127025127026127027127028127029127030127031127032127033127034127035127036127037127038127039127040127041127042127043127044127045127046127047127048127049127050127051127052127053127054127055127056127057127058127059127060127061127062127063127064127065127066127067127068127069127070127071127072127073127074127075127076127077127078127079127080127081127082127083127084127085127086127087127088127089127090127091127092127093127094127095127096127097127098127099127100127101127102127103127104127105127106127107127108127109127110127111127112127113127114127115127116127117127118127119127120127121127122127123127124127125127126127127127128127129127130127131127132127133127134127135127136127137127138127139127140127141127142127143127144127145127146127147127148127149127150127151127152127153127154127155127156127157127158127159127160127161127162127163127164127165127166127167127168127169127170127171127172127173127174127175127176127177127178127179127180127181127182127183127184127185127186127187127188127189127190127191127192127193127194127195127196127197127198127199127200127201127202127203127204127205127206127207127208127209127210127211127212127213127214127215127216127217127218127219127220127221127222127223127224127225127226127227127228127229127230127231127232127233127234127235127236127237127238127239127240127241127242127243127244127245127246127247127248127249127250127251127252127253127254127255127256127257127258127259127260127261127262127263127264127265127266127267127268127269127270127271127272127273127274127275127276127277127278127279127280127281127282127283127284127285127286127287127288127289127290127291127292127293127294127295127296127297127298127299127300127301127302127303127304127305127306127307127308127309127310127311127312127313127314127315127316127317127318127319127320127321127322127323127324127325127326127327127328127329127330127331127332127333127334127335127336127337127338127339127340127341127342127343127344127345127346127347127348127349127350127351127352127353127354127355127356127357127358127359127360127361127362127363127364127365127366127367127368127369127370127371127372127373127374127375127376127377127378127379127380127381127382127383127384127385127386127387127388127389127390127391127392127393127394127395127396127397127398127399127400127401127402127403127404127405127406127407127408127409127410127411127412127413127414127415127416127417127418127419127420127421127422127423127424127425127426127427127428127429127430127431127432127433127434127435127436127437127438127439127440127441127442127443127444127445127446127447127448127449127450127451127452127453127454127455127456127457127458127459127460127461127462127463127464127465127466127467127468127469127470127471127472127473127474127475127476127477127478127479127480127481127482127483127484127485127486127487127488127489127490127491127492127493127494127495127496127497127498127499127500127501127502127503127504127505127506127507127508127509127510127511127512127513127514127515127516127517127518127519127520127521127522127523127524127525127526127527127528127529127530127531127532127533127534127535127536127537127538127539127540127541127542127543127544127545127546127547127548127549127550127551127552127553127554127555127556127557127558127559127560127561127562127563127564127565127566127567127568127569127570127571127572127573127574127575127576127577127578127579127580127581127582127583127584127585127586127587127588127589127590127591127592127593127594127595127596127597127598127599127600127601127602127603127604127605127606127607127608127609127610127611127612127613127614127615127616127617127618127619127620127621127622127623127624127625127626127627127628127629127630127631127632127633127634127635127636127637127638127639127640127641127642127643127644127645127646127647127648127649127650127651127652127653127654127655127656127657127658127659127660127661127662127663127664127665127666127667127668127669127670127671127672127673127674127675127676127677127678127679127680127681127682127683127684127685127686127687127688127689127690127691127692127693127694127695127696127697127698127699127700127701127702127703127704127705127706127707127708127709127710127711127712127713127714127715127716127717127718127719127720127721127722127723127724127725127726127727127728127729127730127731127732127733127734127735127736127737127738127739127740127741127742127743127744127745127746127747127748127749127750127751127752127753127754127755127756127757127758127759127760127761127762127763127764127765127766127767127768127769127770127771127772127773127774127775127776127777127778127779127780127781127782127783127784127785127786127787127788127789127790127791127792127793127794127795127796127797127798127799127800127801127802127803127804127805127806127807127808127809127810127811127812127813127814127815127816127817127818127819127820127821127822127823127824127825127826127827127828127829127830127831127832127833127834127835127836127837127838127839127840127841127842127843127844127845127846127847127848127849127850127851127852127853127854127855127856127857127858127859127860127861127862127863127864127865127866127867127868127869127870127871127872127873127874127875127876127877127878127879127880127881127882127883127884127885127886127887127888127889127890127891127892127893127894127895127896127897127898127899127900127901127902127903127904127905127906127907127908127909127910127911127912127913127914127915127916127917127918127919127920127921127922127923127924127925127926127927127928127929127930127931127932127933127934127935127936127937127938127939127940127941127942127943127944127945127946127947127948127949127950127951127952127953127954127955127956127957127958127959127960127961127962127963127964127965127966127967127968127969127970127971127972127973127974127975127976127977127978127979127980127981127982127983127984127985127986127987127988127989127990127991127992127993127994127995127996127997127998127999128000128001128002128003128004128005128006128007128008128009128010128011128012128013128014128015128016128017128018128019128020128021128022128023128024128025128026128027128028128029128030128031128032128033128034128035128036128037128038128039128040128041128042128043128044128045128046128047128048128049128050128051128052128053128054128055128056128057128058128059128060128061128062128063128064128065128066128067128068128069128070128071128072128073128074128075128076128077128078128079128080128081128082128083128084128085128086128087128088128089128090128091128092128093128094128095128096128097128098128099128100128101128102128103128104128105128106128107128108128109128110128111128112128113128114128115128116128117128118128119128120128121128122128123128124128125128126128127128128128129128130128131128132128133128134128135128136128137128138128139128140128141128142128143128144128145128146128147128148128149128150128151128152128153128154128155128156128157128158128159128160128161128162128163128164128165128166128167128168128169128170128171128172128173128174128175128176128177128178128179128180128181128182128183128184128185128186128187128188128189128190128191128192128193128194128195128196128197128198128199128200128201128202128203128204128205128206128207128208128209128210128211128212128213128214128215128216128217128218128219128220128221128222128223128224128225128226128227128228128229128230128231128232128233128234128235128236128237128238128239128240128241128242128243128244128245128246128247128248128249128250128251128252128253128254128255128256128257128258128259128260128261128262128263128264128265128266128267128268128269128270128271128272128273128274128275128276128277128278128279128280128281128282128283128284128285128286128287128288128289128290128291128292128293128294128295128296128297128298128299128300128301128302128303128304128305128306128307128308128309128310128311128312128313128314128315128316128317128318128319128320128321128322128323128324128325128326128327128328128329128330128331128332128333128334128335128336128337128338128339128340128341128342128343128344128345128346128347128348128349128350128351128352128353128354128355128356128357128358128359128360128361128362128363128364128365128366128367128368128369128370128371128372128373128374128375128376128377128378128379128380128381128382128383128384128385128386128387128388128389128390128391128392128393128394128395128396128397128398128399128400128401128402128403128404128405128406128407128408128409128410128411128412128413128414128415128416128417128418128419128420128421128422128423128424128425128426128427128428128429128430128431128432128433128434128435128436128437128438128439128440128441128442128443128444128445128446128447128448128449128450128451128452128453128454128455128456128457128458128459128460128461128462128463128464128465128466128467128468128469128470128471128472128473128474128475128476128477128478128479128480128481128482128483128484128485128486128487128488128489128490128491128492128493128494128495128496128497128498128499128500128501128502128503128504128505128506128507128508128509128510128511128512128513128514128515128516128517128518128519128520128521128522128523128524128525128526128527128528128529128530128531128532128533128534128535128536128537128538128539128540128541128542128543128544128545128546128547128548128549128550128551128552128553128554128555128556128557128558128559128560128561128562128563128564128565128566128567128568128569128570128571128572128573128574128575128576128577128578128579128580128581128582128583128584128585128586128587128588128589128590128591128592128593128594128595128596128597128598128599128600128601128602128603128604128605128606128607128608128609128610128611128612128613128614128615128616128617128618128619128620128621128622128623128624128625128626128627128628128629128630128631128632128633128634128635128636128637128638128639128640128641128642128643128644128645128646128647128648128649128650128651128652128653128654128655128656128657128658128659128660128661128662128663128664128665128666128667128668128669128670128671128672128673128674128675128676128677128678128679128680128681128682128683128684128685128686128687128688128689128690128691128692128693128694128695128696128697128698128699128700128701128702128703128704128705128706128707128708128709128710128711128712128713128714128715128716128717128718128719128720128721128722128723128724128725128726128727128728128729128730128731128732128733128734128735128736128737128738128739128740128741128742128743128744128745128746128747128748128749128750128751128752128753128754128755128756128757128758128759128760128761128762128763128764128765128766128767128768128769128770128771128772128773128774128775128776128777128778128779128780128781128782128783128784128785128786128787128788128789128790128791128792128793128794128795128796128797128798128799128800128801128802128803128804128805128806128807128808128809128810128811128812128813128814128815128816128817128818128819128820128821128822128823128824128825128826128827128828128829128830128831128832128833128834128835128836128837128838128839128840128841128842128843128844128845128846128847128848128849128850128851128852128853128854128855128856128857128858128859128860128861128862128863128864128865128866128867128868128869128870128871128872128873128874128875128876128877128878128879128880128881128882128883128884128885128886128887128888128889128890128891128892128893128894128895128896128897128898128899128900128901128902128903128904128905128906128907128908128909128910128911128912128913128914128915128916128917128918128919128920128921128922128923128924128925128926128927128928128929128930128931128932128933128934128935128936128937128938128939128940128941128942128943128944128945128946128947128948128949128950128951128952128953128954128955128956128957128958128959128960128961128962128963128964128965128966128967128968128969128970128971128972128973128974128975128976128977128978128979128980128981128982128983128984128985128986128987128988128989128990128991128992128993128994128995128996128997128998128999129000129001129002129003129004129005129006129007129008129009129010129011129012129013129014129015129016129017129018129019129020129021129022129023129024129025129026129027129028129029129030129031129032129033129034129035129036129037129038129039129040129041129042129043129044129045129046129047129048129049129050129051129052129053129054129055129056129057129058129059129060129061129062129063129064129065129066129067129068129069129070129071129072129073129074129075129076129077129078129079129080129081129082129083129084129085129086129087129088129089129090129091129092129093129094129095129096129097129098129099129100129101129102129103129104129105129106129107129108129109129110129111129112129113129114129115129116129117129118129119129120129121129122129123129124129125129126129127129128129129129130129131129132129133129134129135129136129137129138129139129140129141129142129143129144129145129146129147129148129149129150129151129152129153129154129155129156129157129158129159129160129161129162129163129164129165129166129167129168129169129170129171129172129173129174129175129176129177129178129179129180129181129182129183129184129185129186129187129188129189129190129191129192129193129194129195129196129197129198129199129200129201129202129203129204129205129206129207129208129209129210129211129212129213129214129215129216129217129218129219129220129221129222129223129224129225129226129227129228129229129230129231129232129233129234129235129236129237129238129239129240129241129242129243129244129245129246129247129248129249129250129251129252129253129254129255129256129257129258129259129260129261129262129263129264129265129266129267129268129269129270129271129272129273129274129275129276129277129278129279129280129281129282129283129284129285129286129287129288129289129290129291129292129293129294129295129296129297129298129299129300129301129302129303129304129305129306129307129308129309129310129311129312129313129314129315129316129317129318129319129320129321129322129323129324129325129326129327129328129329129330129331129332129333129334129335129336129337129338129339129340129341129342129343129344129345129346129347129348129349129350129351129352129353129354129355129356129357129358129359129360129361129362129363129364129365129366129367129368129369129370129371129372129373129374129375129376129377129378129379129380129381129382129383129384129385129386129387129388129389129390129391129392129393129394129395129396129397129398129399129400129401129402129403129404129405129406129407129408129409129410129411129412129413129414129415129416129417129418129419129420129421129422129423129424129425129426129427129428129429129430129431129432129433129434129435129436129437129438129439129440129441129442129443129444129445129446129447129448129449129450129451129452129453129454129455129456129457129458129459129460129461129462129463129464129465129466129467129468129469129470129471129472129473129474129475129476129477129478129479129480129481129482129483129484129485129486129487129488129489129490129491129492129493129494129495129496129497129498129499129500129501129502129503129504129505129506129507129508129509129510129511129512129513129514129515129516129517129518129519129520129521129522129523129524129525129526129527129528129529129530129531129532129533129534129535129536129537129538129539129540129541129542129543129544129545129546129547129548129549129550129551129552129553129554129555129556129557129558129559129560129561129562129563129564129565129566129567129568129569129570129571129572129573129574129575129576129577129578129579129580129581129582129583129584129585129586129587129588129589129590129591129592129593129594129595129596129597129598129599129600129601129602129603129604129605129606129607129608129609129610129611129612129613129614129615129616129617129618129619129620129621129622129623129624129625129626129627129628129629129630129631129632129633129634129635129636129637129638129639129640129641129642129643129644129645129646129647129648129649129650129651129652129653129654129655129656129657129658129659129660129661129662129663129664129665129666129667129668129669129670129671129672129673129674129675129676129677129678129679129680129681129682129683129684129685129686129687129688129689129690129691129692129693129694129695129696129697129698129699129700129701129702129703129704129705129706129707129708129709129710129711129712129713129714129715129716129717129718129719129720129721129722129723129724129725129726129727129728129729129730129731129732129733129734129735129736129737129738129739129740129741129742129743129744129745129746129747129748129749129750129751129752129753129754129755129756129757129758129759129760129761129762129763129764129765129766129767129768129769129770129771129772129773129774129775129776129777129778129779129780129781129782129783129784129785129786129787129788129789129790129791129792129793129794129795129796129797129798129799129800129801129802129803129804129805129806129807129808129809129810129811129812129813129814129815129816129817129818129819129820129821129822129823129824129825129826129827129828129829129830129831129832129833129834129835129836129837129838129839129840129841129842129843129844129845129846129847129848129849129850129851129852129853129854129855129856129857129858129859129860129861129862129863129864129865129866129867129868129869129870129871129872129873129874129875129876129877129878129879129880129881129882129883129884129885129886129887129888129889129890129891129892129893129894129895129896129897129898129899129900129901129902129903129904129905129906129907129908129909129910129911129912129913129914129915129916129917129918129919129920129921129922129923129924129925129926129927129928129929129930129931129932129933129934129935129936129937129938129939129940129941129942129943129944129945129946129947129948129949129950129951129952129953129954129955129956129957129958129959129960129961129962129963129964129965129966129967129968129969129970129971129972129973129974129975129976129977129978129979129980129981129982129983129984129985129986129987129988129989129990129991129992129993129994129995129996129997129998129999130000130001130002130003130004130005130006130007130008130009130010130011130012130013130014130015130016130017130018130019130020130021130022130023130024130025130026130027130028130029130030130031130032130033130034130035130036130037130038130039130040130041130042130043130044130045130046130047130048130049130050130051130052130053130054130055130056130057130058130059130060130061130062130063130064130065130066130067130068130069130070130071130072130073130074130075130076130077130078130079130080130081130082130083130084130085130086130087130088130089130090130091130092130093130094130095130096130097130098130099130100130101130102130103130104130105130106130107130108130109130110130111130112130113130114130115130116130117130118130119130120130121130122130123130124130125130126130127130128130129130130130131130132130133130134130135130136130137130138130139130140130141130142130143130144130145130146130147130148130149130150130151130152130153130154130155130156130157130158130159130160130161130162130163130164130165130166130167130168130169130170130171130172130173130174130175130176130177130178130179130180130181130182130183130184130185130186130187130188130189130190130191130192130193130194130195130196130197130198130199130200130201130202130203130204130205130206130207130208130209130210130211130212130213130214130215130216130217130218130219130220130221130222130223130224130225130226130227130228130229130230130231130232130233130234130235130236130237130238130239130240130241130242130243130244130245130246130247130248130249130250130251130252130253130254130255130256130257130258130259130260130261130262130263130264130265130266130267130268130269130270130271130272130273130274130275130276130277130278130279130280130281130282130283130284130285130286130287130288130289130290130291130292130293130294130295130296130297130298130299130300130301130302130303130304130305130306130307130308130309130310130311130312130313130314130315130316130317130318130319130320130321130322130323130324130325130326130327130328130329130330130331130332130333130334130335130336130337130338130339130340130341130342130343130344130345130346130347130348130349130350130351130352130353130354130355130356130357130358130359130360130361130362130363130364130365130366130367130368130369130370130371130372130373130374130375130376130377130378130379130380130381130382130383130384130385130386130387130388130389130390130391130392130393130394130395130396130397130398130399130400130401130402130403130404130405130406130407130408130409130410130411130412130413130414130415130416130417130418130419130420130421130422130423130424130425130426130427130428130429130430130431130432130433130434130435130436130437130438130439130440130441130442130443130444130445130446130447130448130449130450130451130452130453130454130455130456130457130458130459130460130461130462130463130464130465130466130467130468130469130470130471130472130473130474130475130476130477130478130479130480130481130482130483130484130485130486130487130488130489130490130491130492130493130494130495130496130497130498130499130500130501130502130503130504130505130506130507130508130509130510130511130512130513130514130515130516130517130518130519130520130521130522130523130524130525130526130527130528130529130530130531130532130533130534130535130536130537130538130539130540130541130542130543130544130545130546130547130548130549130550130551130552130553130554130555130556130557130558130559130560130561130562130563130564130565130566130567130568130569130570130571130572130573130574130575130576130577130578130579130580130581130582130583130584130585130586130587130588130589130590130591130592130593130594130595130596130597130598130599130600130601130602130603130604130605130606130607130608130609130610130611130612130613130614130615130616130617130618130619130620130621130622130623130624130625130626130627130628130629130630130631130632130633130634130635130636130637130638130639130640130641130642130643130644130645130646130647130648130649130650130651130652130653130654130655130656130657130658130659130660130661130662130663130664130665130666130667130668130669130670130671130672130673130674130675130676130677130678130679130680130681130682130683130684130685130686130687130688130689130690130691130692130693130694130695130696130697130698130699130700130701130702130703130704130705130706130707130708130709130710130711130712130713130714130715130716130717130718130719130720130721130722130723130724130725130726130727130728130729130730130731130732130733130734130735130736130737130738130739130740130741130742130743130744130745130746130747130748130749130750130751130752130753130754130755130756130757130758130759130760130761130762130763130764130765130766130767130768130769130770130771130772130773130774130775130776130777130778130779130780130781130782130783130784130785130786130787130788130789130790130791130792130793130794130795130796130797130798130799130800130801130802130803130804130805130806130807130808130809130810130811130812130813130814130815130816130817130818130819130820130821130822130823130824130825130826130827130828130829130830130831130832130833130834130835130836130837130838130839130840130841130842130843130844130845130846130847130848130849130850130851130852130853130854130855130856130857130858130859130860130861130862130863130864130865130866130867130868130869130870130871130872130873130874130875130876130877130878130879130880130881130882130883130884130885130886130887130888130889130890130891130892130893130894130895130896130897130898130899130900130901130902130903130904130905130906130907130908130909130910130911130912130913130914130915130916130917130918130919130920130921130922130923130924130925130926130927130928130929130930130931130932130933130934130935130936130937130938130939130940130941130942130943130944130945130946130947130948130949130950130951130952130953130954130955130956130957130958130959130960130961130962130963130964130965130966130967130968130969130970130971130972130973130974130975130976130977130978130979130980130981130982130983130984130985130986130987130988130989130990130991130992130993130994130995130996130997130998130999131000131001131002131003131004131005131006131007131008131009131010131011131012131013131014131015131016131017131018131019131020131021131022131023131024131025131026131027131028131029131030131031131032131033131034131035131036131037131038131039131040131041131042131043131044131045131046131047131048131049131050131051131052131053131054131055131056131057131058131059131060131061131062131063131064131065131066131067131068131069131070131071131072131073131074131075131076131077131078131079131080131081131082131083131084131085131086131087131088131089131090131091131092131093131094131095131096131097131098131099131100131101131102131103131104131105131106131107131108131109131110131111131112131113131114131115131116131117131118131119131120131121131122131123131124131125131126131127131128131129131130131131131132131133131134131135131136131137131138131139131140131141131142131143131144131145131146131147131148131149131150131151131152131153131154131155131156131157131158131159131160131161131162131163131164131165131166131167131168131169131170131171131172131173131174131175131176131177131178131179131180131181131182131183131184131185131186131187131188131189131190131191131192131193131194131195131196131197131198131199131200131201131202131203131204131205131206131207131208131209131210131211131212131213131214131215131216131217131218131219131220131221131222131223131224131225131226131227131228131229131230131231131232131233131234131235131236131237131238131239131240131241131242131243131244131245131246131247131248131249131250131251131252131253131254131255131256131257131258131259131260131261131262131263131264131265131266131267131268131269131270131271131272131273131274131275131276131277131278131279131280131281131282131283131284131285131286131287131288131289131290131291131292131293131294131295131296131297131298131299131300131301131302131303131304131305131306131307131308131309131310131311131312131313131314131315131316131317131318131319131320131321131322131323131324131325131326131327131328131329131330131331131332131333131334131335131336131337131338131339131340131341131342131343131344131345131346131347131348131349131350131351131352131353131354131355131356131357131358131359131360131361131362131363131364131365131366131367131368131369131370131371131372131373131374131375131376131377131378131379131380131381131382131383131384131385131386131387131388131389131390131391131392131393131394131395131396131397131398131399131400131401131402131403131404131405131406131407131408131409131410131411131412131413131414131415131416131417131418131419131420131421131422131423131424131425131426131427131428131429131430131431131432131433131434131435131436131437131438131439131440131441131442131443131444131445131446131447131448131449131450131451131452131453131454131455131456131457131458131459131460131461131462131463131464131465131466131467131468131469131470131471131472131473131474131475131476131477131478131479131480131481131482131483131484131485131486131487131488131489131490131491131492131493131494131495131496131497131498131499131500131501131502131503131504131505131506131507131508131509131510131511131512131513131514131515131516131517131518131519131520131521131522131523131524131525131526131527131528131529131530131531131532131533131534131535131536131537131538131539131540131541131542131543131544131545131546131547131548131549131550131551131552131553131554131555131556131557131558131559131560131561131562131563131564131565131566131567131568131569131570131571131572131573131574131575131576131577131578131579131580131581131582131583131584131585131586131587131588131589131590131591131592131593131594131595131596131597131598131599131600131601131602131603131604131605131606131607131608131609131610131611131612131613131614131615131616131617131618131619131620131621131622131623131624131625131626131627131628131629131630131631131632131633131634131635131636131637131638131639131640131641131642131643131644131645131646131647131648131649131650131651131652131653131654131655131656131657131658131659131660131661131662131663131664131665131666131667131668131669131670131671131672131673131674131675131676131677131678131679131680131681131682131683131684131685131686131687131688131689131690131691131692131693131694131695131696131697131698131699131700131701131702131703131704131705131706131707131708131709131710131711131712131713131714131715131716131717131718131719131720131721131722131723131724131725131726131727131728131729131730131731131732131733131734131735131736131737131738131739131740131741131742131743131744131745131746131747131748131749131750131751131752131753131754131755131756131757131758131759131760131761131762131763131764131765131766131767131768131769131770131771131772131773131774131775131776131777131778131779131780131781131782131783131784131785131786131787131788131789131790131791131792131793131794131795131796131797131798131799131800131801131802131803131804131805131806131807131808131809131810131811131812131813131814131815131816131817131818131819131820131821131822131823131824131825131826131827131828131829131830131831131832131833131834131835131836131837131838131839131840131841131842131843131844131845131846131847131848131849131850131851131852131853131854131855131856131857131858131859131860131861131862131863131864131865131866131867131868131869131870131871131872131873131874131875131876131877131878131879131880131881131882131883131884131885131886131887131888131889131890131891131892131893131894131895131896131897131898131899131900131901131902131903131904131905131906131907131908131909131910131911131912131913131914131915131916131917131918131919131920131921131922131923131924131925131926131927131928131929131930131931131932131933131934131935131936131937131938131939131940131941131942131943131944131945131946131947131948131949131950131951131952131953131954131955131956131957131958131959131960131961131962131963131964131965131966131967131968131969131970131971131972131973131974131975131976131977131978131979131980131981131982131983131984131985131986131987131988131989131990131991131992131993131994131995131996131997131998131999132000132001132002132003132004132005132006132007132008132009132010132011132012132013132014132015132016132017132018132019132020132021132022132023132024132025132026132027132028132029132030132031132032132033132034132035132036132037132038132039132040132041132042132043132044132045132046132047132048132049132050132051132052132053132054132055132056132057132058132059132060132061132062132063132064132065132066132067132068132069132070132071132072132073132074132075132076132077132078132079132080132081132082132083132084132085132086132087132088132089132090132091132092132093132094132095132096132097132098132099132100132101132102132103132104132105132106132107132108132109132110132111132112132113132114132115132116132117132118132119132120132121132122132123132124132125132126132127132128132129132130132131132132132133132134132135132136132137132138132139132140132141132142132143132144132145132146132147132148132149132150132151132152132153132154132155132156132157132158132159132160132161132162132163132164132165132166132167132168132169132170132171132172132173132174132175132176132177132178132179132180132181132182132183132184132185132186132187132188132189132190132191132192132193132194132195132196132197132198132199132200132201132202132203132204132205132206132207132208132209132210132211132212132213132214132215132216132217132218132219132220132221132222132223132224132225132226132227132228132229132230132231132232132233132234132235132236132237132238132239132240132241132242132243132244132245132246132247132248132249132250132251132252132253132254132255132256132257132258132259132260132261132262132263132264132265132266132267132268132269132270132271132272132273132274132275132276132277132278132279132280132281132282132283132284132285132286132287132288132289132290132291132292132293132294132295132296132297132298132299132300132301132302132303132304132305132306132307132308132309132310132311132312132313132314132315132316132317132318132319132320132321132322132323132324132325132326132327132328132329132330132331132332132333132334132335132336132337132338132339132340132341132342132343132344132345132346132347132348132349132350132351132352132353132354132355132356132357132358132359132360132361132362132363132364132365132366132367132368132369132370132371132372132373132374132375132376132377132378132379132380132381132382132383132384132385132386132387132388132389132390132391132392132393132394132395132396132397132398132399132400132401132402132403132404132405132406132407132408132409132410132411132412132413132414132415132416132417132418132419132420132421132422132423132424132425132426132427132428132429132430132431132432132433132434132435132436132437132438132439132440132441132442132443132444132445132446132447132448132449132450132451132452132453132454132455132456132457132458132459132460132461132462132463132464132465132466132467132468132469132470132471132472132473132474132475132476132477132478132479132480132481132482132483132484132485132486132487132488132489132490132491132492132493132494132495132496132497132498132499132500132501132502132503132504132505132506132507132508132509132510132511132512132513132514132515132516132517132518132519132520132521132522132523132524132525132526132527132528132529132530132531132532132533132534132535132536132537132538132539132540132541132542132543132544132545132546132547132548132549132550132551132552132553132554132555132556132557132558132559132560132561132562132563132564132565132566132567132568132569132570132571132572132573132574132575132576132577132578132579132580132581132582132583132584132585132586132587132588132589132590132591132592132593132594132595132596132597132598132599132600132601132602132603132604132605132606132607132608132609132610132611132612132613132614132615132616132617132618132619132620132621132622132623132624132625132626132627132628132629132630132631132632132633132634132635132636132637132638132639132640132641132642132643132644132645132646132647132648132649132650132651132652132653132654132655132656132657132658132659132660132661132662132663132664132665132666132667132668132669132670132671132672132673132674132675132676132677132678132679132680132681132682132683132684132685132686132687132688132689132690132691132692132693132694132695132696132697132698132699132700132701132702132703132704132705132706132707132708132709132710132711132712132713132714132715132716132717132718132719132720132721132722132723132724132725132726132727132728132729132730132731132732132733132734132735132736132737132738132739132740132741132742132743132744132745132746132747132748132749132750132751132752132753132754132755132756132757132758132759132760132761132762132763132764132765132766132767132768132769132770132771132772132773132774132775132776132777132778132779132780132781132782132783132784132785132786132787132788132789132790132791132792132793132794132795132796132797132798132799132800132801132802132803132804132805132806132807132808132809132810132811132812132813132814132815132816132817132818132819132820132821132822132823132824132825132826132827132828132829132830132831132832132833132834132835132836132837132838132839132840132841132842132843132844132845132846132847132848132849132850132851132852132853132854132855132856132857132858132859132860132861132862132863132864132865132866132867132868132869132870132871132872132873132874132875132876132877132878132879132880132881132882132883132884132885132886132887132888132889132890132891132892132893132894132895132896132897132898132899132900132901132902132903132904132905132906132907132908132909132910132911132912132913132914132915132916132917132918132919132920132921132922132923132924132925132926132927132928132929132930132931132932132933132934132935132936132937132938132939132940132941132942132943132944132945132946132947132948132949132950132951132952132953132954132955132956132957132958132959132960132961132962132963132964132965132966132967132968132969132970132971132972132973132974132975132976132977132978132979132980132981132982132983132984132985132986132987132988132989132990132991132992132993132994132995132996132997132998132999133000133001133002133003133004133005133006133007133008133009133010133011133012133013133014133015133016133017133018133019133020133021133022133023133024133025133026133027133028133029133030133031133032133033133034133035133036133037133038133039133040133041133042133043133044133045133046133047133048133049133050133051133052133053133054133055133056133057133058133059133060133061133062133063133064133065133066133067133068133069133070133071133072133073133074133075133076133077133078133079133080133081133082133083133084133085133086133087133088133089133090133091133092133093133094133095133096133097133098133099133100133101133102133103133104133105133106133107133108133109133110133111133112133113133114133115133116133117133118133119133120133121133122133123133124133125133126133127133128133129133130133131133132133133133134133135133136133137133138133139133140133141133142133143133144133145133146133147133148133149133150133151133152133153133154133155133156133157133158133159133160133161133162133163133164133165133166133167133168133169133170133171133172133173133174133175133176133177133178133179133180133181133182133183133184133185133186133187133188133189133190133191133192133193133194133195133196133197133198133199133200133201133202133203133204133205133206133207133208133209133210133211133212133213133214133215133216133217133218133219133220133221133222133223133224133225133226133227133228133229133230133231133232133233133234133235133236133237133238133239133240133241133242133243133244133245133246133247133248133249133250133251133252133253133254133255133256133257133258133259133260133261133262133263133264133265133266133267133268133269133270133271133272133273133274133275133276133277133278133279133280133281133282133283133284133285133286133287133288133289133290133291133292133293133294133295133296133297133298133299133300133301133302133303133304133305133306133307133308133309133310133311133312133313133314133315133316133317133318133319133320133321133322133323133324133325133326133327133328133329133330133331133332133333133334133335133336133337133338133339133340133341133342133343133344133345133346133347133348133349133350133351133352133353133354133355133356133357133358133359133360133361133362133363133364133365133366133367133368133369133370133371133372133373133374133375133376133377133378133379133380133381133382133383133384133385133386133387133388133389133390133391133392133393133394133395133396133397133398133399133400133401133402133403133404133405133406133407133408133409133410133411133412133413133414133415133416133417133418133419133420133421133422133423133424133425133426133427133428133429133430133431133432133433133434133435133436133437133438133439133440133441133442133443133444133445133446133447133448133449133450133451133452133453133454133455133456133457133458133459133460133461133462133463133464133465133466133467133468133469133470133471133472133473133474133475133476133477133478133479133480133481133482133483133484133485133486133487133488133489133490133491133492133493133494133495133496133497133498133499133500133501133502133503133504133505133506133507133508133509133510133511133512133513133514133515133516133517133518133519133520133521133522133523133524133525133526133527133528133529133530133531133532133533133534133535133536133537133538133539133540133541133542133543133544133545133546133547133548133549133550133551133552133553133554133555133556133557133558133559133560133561133562133563133564133565133566133567133568133569133570133571133572133573133574133575133576133577133578133579133580133581133582133583133584133585133586133587133588133589133590133591133592133593133594133595133596133597133598133599133600133601133602133603133604133605133606133607133608133609133610133611133612133613133614133615133616133617133618133619133620133621133622133623133624133625133626133627133628133629133630133631133632133633133634133635133636133637133638133639133640133641133642133643133644133645133646133647133648133649133650133651133652133653133654133655133656133657133658133659133660133661133662133663133664133665133666133667133668133669133670133671133672133673133674133675133676133677133678133679133680133681133682133683133684133685133686133687133688133689133690133691133692133693133694133695133696133697133698133699133700133701133702133703133704133705133706133707133708133709133710133711133712133713133714133715133716133717133718133719133720133721133722133723133724133725133726133727133728133729133730133731133732133733133734133735133736133737133738133739133740133741133742133743133744133745133746133747133748133749133750133751133752133753133754133755133756133757133758133759133760133761133762133763133764133765133766133767133768133769133770133771133772133773133774133775133776133777133778133779133780133781133782133783133784133785133786133787133788133789133790133791133792133793133794133795133796133797133798133799133800133801133802133803133804133805133806133807133808133809133810133811133812133813133814133815133816133817133818133819133820133821133822133823133824133825133826133827133828133829133830133831133832133833133834133835133836133837133838133839133840133841133842133843133844133845133846133847133848133849133850133851133852133853133854133855133856133857133858133859133860133861133862133863133864133865133866133867133868133869133870133871133872133873133874133875133876133877133878133879133880133881133882133883133884133885133886133887133888133889133890133891133892133893133894133895133896133897133898133899133900133901133902133903133904133905133906133907133908133909133910133911133912133913133914133915133916133917133918133919133920133921133922133923133924133925133926133927133928133929133930133931133932133933133934133935133936133937133938133939133940133941133942133943133944133945133946133947133948133949133950133951133952133953133954133955133956133957133958133959133960133961133962133963133964133965133966133967133968133969133970133971133972133973133974133975133976133977133978133979133980133981133982133983133984133985133986133987133988133989133990133991133992133993133994133995133996133997133998133999134000134001134002134003134004134005134006134007134008134009134010134011134012134013134014134015134016134017134018134019134020134021134022134023134024134025134026134027134028134029134030134031134032134033134034134035134036134037134038134039134040134041134042134043134044134045134046134047134048134049134050134051134052134053134054134055134056134057134058134059134060134061134062134063134064134065134066134067134068134069134070134071134072134073134074134075134076134077134078134079134080134081134082134083134084134085134086134087134088134089134090134091134092134093134094134095134096134097134098134099134100134101134102134103134104134105134106134107134108134109134110134111134112134113134114134115134116134117134118134119134120134121134122134123134124134125134126134127134128134129134130134131134132134133134134134135134136134137134138134139134140134141134142134143134144134145134146134147134148134149134150134151134152134153134154134155134156134157134158134159134160134161134162134163134164134165134166134167134168134169134170134171134172134173134174134175134176134177134178134179134180134181134182134183134184134185134186134187134188134189134190134191134192134193134194134195134196134197134198134199134200134201134202134203134204134205134206134207134208134209134210134211134212134213134214134215134216134217134218134219134220134221134222134223134224134225134226134227134228134229134230134231134232134233134234134235134236134237134238134239134240134241134242134243134244134245134246134247134248134249134250134251134252134253134254134255134256134257134258134259134260134261134262134263134264134265134266134267134268134269134270134271134272134273134274134275134276134277134278134279134280134281134282134283134284134285134286134287134288134289134290134291134292134293134294134295134296134297134298134299134300134301134302134303134304134305134306134307134308134309134310134311134312134313134314134315134316134317134318134319134320134321134322134323134324134325134326134327134328134329134330134331134332134333134334134335134336134337134338134339134340134341134342134343134344134345134346134347134348134349134350134351134352134353134354134355134356134357134358134359134360134361134362134363134364134365134366134367134368134369134370134371134372134373134374134375134376134377134378134379134380134381134382134383134384134385134386134387134388134389134390134391134392134393134394134395134396134397134398134399134400134401134402134403134404134405134406134407134408134409134410134411134412134413134414134415134416134417134418134419134420134421134422134423134424134425134426134427134428134429134430134431134432134433134434134435134436134437134438134439134440134441134442134443134444134445134446134447134448134449134450134451134452134453134454134455134456134457134458134459134460134461134462134463134464134465134466134467134468134469134470134471134472134473134474134475134476134477134478134479134480134481134482134483134484134485134486134487134488134489134490134491134492134493134494134495134496134497134498134499134500134501134502134503134504134505134506134507134508134509134510134511134512134513134514134515134516134517134518134519134520134521134522134523134524134525134526134527134528134529134530134531134532134533134534134535134536134537134538134539134540134541134542134543134544134545134546134547134548134549134550134551134552134553134554134555134556134557134558134559134560134561134562134563134564134565134566134567134568134569134570134571134572134573134574134575134576134577134578134579134580134581134582134583134584134585134586134587134588134589134590134591134592134593134594134595134596134597134598134599134600134601134602134603134604134605134606134607134608134609134610134611134612134613134614134615134616134617134618134619134620134621134622134623134624134625134626134627134628134629134630134631134632134633134634134635134636134637134638134639134640134641134642134643134644134645134646134647134648134649134650134651134652134653134654134655134656134657134658134659134660134661134662134663134664134665134666134667134668134669134670134671134672134673134674134675134676134677134678134679134680134681134682134683134684134685134686134687134688134689134690134691134692134693134694134695134696134697134698134699134700134701134702134703134704134705134706134707134708134709134710134711134712134713134714134715134716134717134718134719134720134721134722134723134724134725134726134727134728134729134730134731134732134733134734134735134736134737134738134739134740134741134742134743134744134745134746134747134748134749134750134751134752134753134754134755134756134757134758134759134760134761134762134763134764134765134766134767134768134769134770134771134772134773134774134775134776134777134778134779134780134781134782134783134784134785134786134787134788134789134790134791134792134793134794134795134796134797134798134799134800134801134802134803134804134805134806134807134808134809134810134811134812134813134814134815134816134817134818134819134820134821134822134823134824134825134826134827134828134829134830134831134832134833134834134835134836134837134838134839134840134841134842134843134844134845134846134847134848134849134850134851134852134853134854134855134856134857134858134859134860134861134862134863134864134865134866134867134868134869134870134871134872134873134874134875134876134877134878134879134880134881134882134883134884134885134886134887134888134889134890134891134892134893134894134895134896134897134898134899134900134901134902134903134904134905134906134907134908134909134910134911134912134913134914134915134916134917134918134919134920134921134922134923134924134925134926134927134928134929134930134931134932134933134934134935134936134937134938134939134940134941134942134943134944134945134946134947134948134949134950134951134952134953134954134955134956134957134958134959134960134961134962134963134964134965134966134967134968134969134970134971134972134973134974134975134976134977134978134979134980134981134982134983134984134985134986134987134988134989134990134991134992134993134994134995134996134997134998134999135000135001135002135003135004135005135006135007135008135009135010135011135012135013135014135015135016135017135018135019135020135021135022135023135024135025135026135027135028135029135030135031135032135033135034135035135036135037135038135039135040135041135042135043135044135045135046135047135048135049135050135051135052135053135054135055135056135057135058135059135060135061135062135063135064135065135066135067135068135069135070135071135072135073135074135075135076135077135078135079135080135081135082135083135084135085135086135087135088135089135090135091135092135093135094135095135096135097135098135099135100135101135102135103135104135105135106135107135108135109135110135111135112135113135114135115135116135117135118135119135120135121135122135123135124135125135126135127135128135129135130135131135132135133135134135135135136135137135138135139135140135141135142135143135144135145135146135147135148135149135150135151135152135153135154135155135156135157135158135159135160135161135162135163135164135165135166135167135168135169135170135171135172135173135174135175135176135177135178135179135180135181135182135183135184135185135186135187135188135189135190135191135192135193135194135195135196135197135198135199135200135201135202135203135204135205135206135207135208135209135210135211135212135213135214135215135216135217135218135219135220135221135222135223135224135225135226135227135228135229135230135231135232135233135234135235135236135237135238135239135240135241135242135243135244135245135246135247135248135249135250135251135252135253135254135255135256135257135258135259135260135261135262135263135264135265135266135267135268135269135270135271135272135273135274135275135276135277135278135279135280135281135282135283135284135285135286135287135288135289135290135291135292135293135294135295135296135297135298135299135300135301135302135303135304135305135306135307135308135309135310135311135312135313135314135315135316135317135318135319135320135321135322135323135324135325135326135327135328135329135330135331135332135333135334135335135336135337135338135339135340135341135342135343135344135345135346135347135348135349135350135351135352135353135354135355135356135357135358135359135360135361135362135363135364135365135366135367135368135369135370135371135372135373135374135375135376135377135378135379135380135381135382135383135384135385135386135387135388135389135390135391135392135393135394135395135396135397135398135399135400135401135402135403135404135405135406135407135408135409135410135411135412135413135414135415135416135417135418135419135420135421135422135423135424135425135426135427135428135429135430135431135432135433135434135435135436135437135438135439135440135441135442135443135444135445135446135447135448135449135450135451135452135453135454135455135456135457135458135459135460135461135462135463135464135465135466135467135468135469135470135471135472135473135474135475135476135477135478135479135480135481135482135483135484135485135486135487135488135489135490135491135492135493135494135495135496135497135498135499135500135501135502135503135504135505135506135507135508135509135510135511135512135513135514135515135516135517135518135519135520135521135522135523135524135525135526135527135528135529135530135531135532135533135534135535135536135537135538135539135540135541135542135543135544135545135546135547135548135549135550135551135552135553135554135555135556135557135558135559135560135561135562135563135564135565135566135567135568135569135570135571135572135573135574135575135576135577135578135579135580135581135582135583135584135585135586135587135588135589135590135591135592135593135594135595135596135597135598135599135600135601135602135603135604135605135606135607135608135609135610135611135612135613135614135615135616135617135618135619135620135621135622135623135624135625135626135627135628135629135630135631135632135633135634135635135636135637135638135639135640135641135642135643135644135645135646135647135648135649135650135651135652135653135654135655135656135657135658135659135660135661135662135663135664135665135666135667135668135669135670135671135672135673135674135675135676135677135678135679135680135681135682135683135684135685135686135687135688135689135690135691135692135693135694135695135696135697135698135699135700135701135702135703135704135705135706135707135708135709135710135711135712135713135714135715135716135717135718135719135720135721135722135723135724135725135726135727135728135729135730135731135732135733135734135735135736135737135738135739135740135741135742135743135744135745135746135747135748135749135750135751135752135753135754135755135756135757135758135759135760135761135762135763135764135765135766135767135768135769135770135771135772135773135774135775135776135777135778135779135780135781135782135783135784135785135786135787135788135789135790135791135792135793135794135795135796135797135798135799135800135801135802135803135804135805135806135807135808135809135810135811135812135813135814135815135816135817135818135819135820135821135822135823135824135825135826135827135828135829135830135831135832135833135834135835135836135837135838135839135840135841135842135843135844135845135846135847135848135849135850135851135852135853135854135855135856135857135858135859135860135861135862135863135864135865135866135867135868135869135870135871135872135873135874135875135876135877135878135879135880135881135882135883135884135885135886135887135888135889135890135891135892135893135894135895135896135897135898135899135900135901135902135903135904135905135906135907135908135909135910135911135912135913135914135915135916135917135918135919135920135921135922135923135924135925135926135927135928135929135930135931135932135933135934135935135936135937135938135939135940135941135942135943135944135945135946135947135948135949135950135951135952135953135954135955135956135957135958135959135960135961135962135963135964135965135966135967135968135969135970135971135972135973135974135975135976135977135978135979135980135981135982135983135984135985135986135987135988135989135990135991135992135993135994135995135996135997135998135999136000136001136002136003136004136005136006136007136008136009136010136011136012136013136014136015136016136017136018136019136020136021136022136023136024136025136026136027136028136029136030136031136032136033136034136035136036136037136038136039136040136041136042136043136044136045136046136047136048136049136050136051136052136053136054136055136056136057136058136059136060136061136062136063136064136065136066136067136068136069136070136071136072136073136074136075136076136077136078136079136080136081136082136083136084136085136086136087136088136089136090136091136092136093136094136095136096136097136098136099136100136101136102136103136104136105136106136107136108136109136110136111136112136113136114136115136116136117136118136119136120136121136122136123136124136125136126136127136128136129136130136131136132136133136134136135136136136137136138136139136140136141136142136143136144136145136146136147136148136149136150136151136152136153136154136155136156136157136158136159136160136161136162136163136164136165136166136167136168136169136170136171136172136173136174136175136176136177136178136179136180136181136182136183136184136185136186136187136188136189136190136191136192136193136194136195136196136197136198136199136200136201136202136203136204136205136206136207136208136209136210136211136212136213136214136215136216136217136218136219136220136221136222136223136224136225136226136227136228136229136230136231136232136233136234136235136236136237136238136239136240136241136242136243136244136245136246136247136248136249136250136251136252136253136254136255136256136257136258136259136260136261136262136263136264136265136266136267136268136269136270136271136272136273136274136275136276136277136278136279136280136281136282136283136284136285136286136287136288136289136290136291136292136293136294136295136296136297136298136299136300136301136302136303136304136305136306136307136308136309136310136311136312136313136314136315136316136317136318136319136320136321136322136323136324136325136326136327136328136329136330136331136332136333136334136335136336136337136338136339136340136341136342136343136344136345136346136347136348136349136350136351136352136353136354136355136356136357136358136359136360136361136362136363136364136365136366136367136368136369136370136371136372136373136374136375136376136377136378136379136380136381136382136383136384136385136386136387136388136389136390136391136392136393136394136395136396136397136398136399136400136401136402136403136404136405136406136407136408136409136410136411136412136413136414136415136416136417136418136419136420136421136422136423136424136425136426136427136428136429136430136431136432136433136434136435136436136437136438136439136440136441136442136443136444136445136446136447136448136449136450136451136452136453136454136455136456136457136458136459136460136461136462136463136464136465136466136467136468136469136470136471136472136473136474136475136476136477136478136479136480136481136482136483136484136485136486136487136488136489136490136491136492136493136494136495136496136497136498136499136500136501136502136503136504136505136506136507136508136509136510136511136512136513136514136515136516136517136518136519136520136521136522136523136524136525136526136527136528136529136530136531136532136533136534136535136536136537136538136539136540136541136542136543136544136545136546136547136548136549136550136551136552136553136554136555136556136557136558136559136560136561136562136563136564136565136566136567136568136569136570136571136572136573136574136575136576136577136578136579136580136581136582136583136584136585136586136587136588136589136590136591136592136593136594136595136596136597136598136599136600136601136602136603136604136605136606136607136608136609136610136611136612136613136614136615136616136617136618136619136620136621136622136623136624136625136626136627136628136629136630136631136632136633136634136635136636136637136638136639136640136641136642136643136644136645136646136647136648136649136650136651136652136653136654136655136656136657136658136659136660136661136662136663136664136665136666136667136668136669136670136671136672136673136674136675136676136677136678136679136680136681136682136683136684136685136686136687136688136689136690136691136692136693136694136695136696136697136698136699136700136701136702136703136704136705136706136707136708136709136710136711136712136713136714136715136716136717136718136719136720136721136722136723136724136725136726136727136728136729136730136731136732136733136734136735136736136737136738136739136740136741136742136743136744136745136746136747136748136749136750136751136752136753136754136755136756136757136758136759136760136761136762136763136764136765136766136767136768136769136770136771136772136773136774136775136776136777136778136779136780136781136782136783136784136785136786136787136788136789136790136791136792136793136794136795136796136797136798136799136800136801136802136803136804136805136806136807136808136809136810136811136812136813136814136815136816136817136818136819136820136821136822136823136824136825136826136827136828136829136830136831136832136833136834136835136836136837136838136839136840136841136842136843136844136845136846136847136848136849136850136851136852136853136854136855136856136857136858136859136860136861136862136863136864136865136866136867136868136869136870136871136872136873136874136875136876136877136878136879136880136881136882136883136884136885136886136887136888136889136890136891136892136893136894136895136896136897136898136899136900136901136902136903136904136905136906136907136908136909136910136911136912136913136914136915136916136917136918136919136920136921136922136923136924136925136926136927136928136929136930136931136932136933136934136935136936136937136938136939136940136941136942136943136944136945136946136947136948136949136950136951136952136953136954136955136956136957136958136959136960136961136962136963136964136965136966136967136968136969136970136971136972136973136974136975136976136977136978136979136980136981136982136983136984136985136986136987136988136989136990136991136992136993136994136995136996136997136998136999137000137001137002137003137004137005137006137007137008137009137010137011137012137013137014137015137016137017137018137019137020137021137022137023137024137025137026137027137028137029137030137031137032137033137034137035137036137037137038137039137040137041137042137043137044137045137046137047137048137049137050137051137052137053137054137055137056137057137058137059137060137061137062137063137064137065137066137067137068137069137070137071137072137073137074137075137076137077137078137079137080137081137082137083137084137085137086137087137088137089137090137091137092137093137094137095137096137097137098137099137100137101137102137103137104137105137106137107137108137109137110137111137112137113137114137115137116137117137118137119137120137121137122137123137124137125137126137127137128137129137130137131137132137133137134137135137136137137137138137139137140137141137142137143137144137145137146137147137148137149137150137151137152137153137154137155137156137157137158137159137160137161137162137163137164137165137166137167137168137169137170137171137172137173137174137175137176137177137178137179137180137181137182137183137184137185137186137187137188137189137190137191137192137193137194137195137196137197137198137199137200137201137202137203137204137205137206137207137208137209137210137211137212137213137214137215137216137217137218137219137220137221137222137223137224137225137226137227137228137229137230137231137232137233137234137235137236137237137238137239137240137241137242137243137244137245137246137247137248137249137250137251137252137253137254137255137256137257137258137259137260137261137262137263137264137265137266137267137268137269137270137271137272137273137274137275137276137277137278137279137280137281137282137283137284137285137286137287137288137289137290137291137292137293137294137295137296137297137298137299137300137301137302137303137304137305137306137307137308137309137310137311137312137313137314137315137316137317137318137319137320137321137322137323137324137325137326137327137328137329137330137331137332137333137334137335137336137337137338137339137340137341137342137343137344137345137346137347137348137349137350137351137352137353137354137355137356137357137358137359137360137361137362137363137364137365137366137367137368137369137370137371137372137373137374137375137376137377137378137379137380137381137382137383137384137385137386137387137388137389137390137391137392137393137394137395137396137397137398137399137400137401137402137403137404137405137406137407137408137409137410137411137412137413137414137415137416137417137418137419137420137421137422137423137424137425137426137427137428137429137430137431137432137433137434137435137436137437137438137439137440137441137442137443137444137445137446137447137448137449137450137451137452137453137454137455137456137457137458137459137460137461137462137463137464137465137466137467137468137469137470137471137472137473137474137475137476137477137478137479137480137481137482137483137484137485137486137487137488137489137490137491137492137493137494137495137496137497137498137499137500137501137502137503137504137505137506137507137508137509137510137511137512137513137514137515137516137517137518137519137520137521137522137523137524137525137526137527137528137529137530137531137532137533137534137535137536137537137538137539137540137541137542137543137544137545137546137547137548137549137550137551137552137553137554137555137556137557137558137559137560137561137562137563137564137565137566137567137568137569137570137571137572137573137574137575137576137577137578137579137580137581137582137583137584137585137586137587137588137589137590137591137592137593137594137595137596137597137598137599137600137601137602137603137604137605137606137607137608137609137610137611137612137613137614137615137616137617137618137619137620137621137622137623137624137625137626137627137628137629137630137631137632137633137634137635137636137637137638137639137640137641137642137643137644137645137646137647137648137649137650137651137652137653137654137655137656137657137658137659137660137661137662137663137664137665137666137667137668137669137670137671137672137673137674137675137676137677137678137679137680137681137682137683137684137685137686137687137688137689137690137691137692137693137694137695137696137697137698137699137700137701137702137703137704137705137706137707137708137709137710137711137712137713137714137715137716137717137718137719137720137721137722137723137724137725137726137727137728137729137730137731137732137733137734137735137736137737137738137739137740137741137742137743137744137745137746137747137748137749137750137751137752137753137754137755137756137757137758137759137760137761137762137763137764137765137766137767137768137769137770137771137772137773137774137775137776137777137778137779137780137781137782137783137784137785137786137787137788137789137790137791137792137793137794137795137796137797137798137799137800137801137802137803137804137805137806137807137808137809137810137811137812137813137814137815137816137817137818137819137820137821137822137823137824137825137826137827137828137829137830137831137832137833137834137835137836137837137838137839137840137841137842137843137844137845137846137847137848137849137850137851137852137853137854137855137856137857137858137859137860137861137862137863137864137865137866137867137868137869137870137871137872137873137874137875137876137877137878137879137880137881137882137883137884137885137886137887137888137889137890137891137892137893137894137895137896137897137898137899137900137901137902137903137904137905137906137907137908137909137910137911137912137913137914137915137916137917137918137919137920137921137922137923137924137925137926137927137928137929137930137931137932137933137934137935137936137937137938137939137940137941137942137943137944137945137946137947137948137949137950137951137952137953137954137955137956137957137958137959137960137961137962137963137964137965137966137967137968137969137970137971137972137973137974137975137976137977137978137979137980137981137982137983137984137985137986137987137988137989137990137991137992137993137994137995137996137997137998137999138000138001138002138003138004138005138006138007138008138009138010138011138012138013138014138015138016138017138018138019138020138021138022138023138024138025138026138027138028138029138030138031138032138033138034138035138036138037138038138039138040138041138042138043138044138045138046138047138048138049138050138051138052138053138054138055138056138057138058138059138060138061138062138063138064138065138066138067138068138069138070138071138072138073138074138075138076138077138078138079138080138081138082138083138084138085138086138087138088138089138090138091138092138093138094138095138096138097138098138099138100138101138102138103138104138105138106138107138108138109138110138111138112138113138114138115138116138117138118138119138120138121138122138123138124138125138126138127138128138129138130138131138132138133138134138135138136138137138138138139138140138141138142138143138144138145138146138147138148138149138150138151138152138153138154138155138156138157138158138159138160138161138162138163138164138165138166138167138168138169138170138171138172138173138174138175138176138177138178138179138180138181138182138183138184138185138186138187138188138189138190138191138192138193138194138195138196138197138198138199138200138201138202138203138204138205138206138207138208138209138210138211138212138213138214138215138216138217138218138219138220138221138222138223138224138225138226138227138228138229138230138231138232138233138234138235138236138237138238138239138240138241138242138243138244138245138246138247138248138249138250138251138252138253138254138255138256138257138258138259138260138261138262138263138264138265138266138267138268138269138270138271138272138273138274138275138276138277138278138279138280138281138282138283138284138285138286138287138288138289138290138291138292138293138294138295138296138297138298138299138300138301138302138303138304138305138306138307138308138309138310138311138312138313138314138315138316138317138318138319138320138321138322138323138324138325138326138327138328138329138330138331138332138333138334138335138336138337138338138339138340138341138342138343138344138345138346138347138348138349138350138351138352138353138354138355138356138357138358138359138360138361138362138363138364138365138366138367138368138369138370138371138372138373138374138375138376138377138378138379138380138381138382138383138384138385138386138387138388138389138390138391138392138393138394138395138396138397138398138399138400138401138402138403138404138405138406138407138408138409138410138411138412138413138414138415138416138417138418138419138420138421138422138423138424138425138426138427138428138429138430138431138432138433138434138435138436138437138438138439138440138441138442138443138444138445138446138447138448138449138450138451138452138453138454138455138456138457138458138459138460138461138462138463138464138465138466138467138468138469138470138471138472138473138474138475138476138477138478138479138480138481138482138483138484138485138486138487138488138489138490138491138492138493138494138495138496138497138498138499138500138501138502138503138504138505138506138507138508138509138510138511138512138513138514138515138516138517138518138519138520138521138522138523138524138525138526138527138528138529138530138531138532138533138534138535138536138537138538138539138540138541138542138543138544138545138546138547138548138549138550138551138552138553138554138555138556138557138558138559138560138561138562138563138564138565138566138567138568138569138570138571138572138573138574138575138576138577138578138579138580138581138582138583138584138585138586138587138588138589138590138591138592138593138594138595138596138597138598138599138600138601138602138603138604138605138606138607138608138609138610138611138612138613138614138615138616138617138618138619138620138621138622138623138624138625138626138627138628138629138630138631138632138633138634138635138636138637138638138639138640138641138642138643138644138645138646138647138648138649138650138651138652138653138654138655138656138657138658138659138660138661138662138663138664138665138666138667138668138669138670138671138672138673138674138675138676138677138678138679138680138681138682138683138684138685138686138687138688138689138690138691138692138693138694138695138696138697138698138699138700138701138702138703138704138705138706138707138708138709138710138711138712138713138714138715138716138717138718138719138720138721138722138723138724138725138726138727138728138729138730138731138732138733138734138735138736138737138738138739138740138741138742138743138744138745138746138747138748138749138750138751138752138753138754138755138756138757138758138759138760138761138762138763138764138765138766138767138768138769138770138771138772138773138774138775138776138777138778138779138780138781138782138783138784138785138786138787138788138789138790138791138792138793138794138795138796138797138798138799138800138801138802138803138804138805138806138807138808138809138810138811138812138813138814138815138816138817138818138819138820138821138822138823138824138825138826138827138828138829138830138831138832138833138834138835138836138837138838138839138840138841138842138843138844138845138846138847138848138849138850138851138852138853138854138855138856138857138858138859138860138861138862138863138864138865138866138867138868138869138870138871138872138873138874138875138876138877138878138879138880138881138882138883138884138885138886138887138888138889138890138891138892138893138894138895138896138897138898138899138900138901138902138903138904138905138906138907138908138909138910138911138912138913138914138915138916138917138918138919138920138921138922138923138924138925138926138927138928138929138930138931138932138933138934138935138936138937138938138939138940138941138942138943138944138945138946138947138948138949138950138951138952138953138954138955138956138957138958138959138960138961138962138963138964138965138966138967138968138969138970138971138972138973138974138975138976138977138978138979138980138981138982138983138984138985138986138987138988138989138990138991138992138993138994138995138996138997138998138999139000139001139002139003139004139005139006139007139008139009139010139011139012139013139014139015139016139017139018139019139020139021139022139023139024139025139026139027139028139029139030139031139032139033139034139035139036139037139038139039139040139041139042139043139044139045139046139047139048139049139050139051139052139053139054139055139056139057139058139059139060139061139062139063139064139065139066139067139068139069139070139071139072139073139074139075139076139077139078139079139080139081139082139083139084139085139086139087139088139089139090139091139092139093139094139095139096139097139098139099139100139101139102139103139104139105139106139107139108139109139110139111139112139113139114139115139116139117139118139119139120139121139122139123139124139125139126139127139128139129139130139131139132139133139134139135139136139137139138139139139140139141139142139143139144139145139146139147139148139149139150139151139152139153139154139155139156139157139158139159139160139161139162139163139164139165139166139167139168139169139170139171139172139173139174139175139176139177139178139179139180139181139182139183139184139185139186139187139188139189139190139191139192139193139194139195139196139197139198139199139200139201139202139203139204139205139206139207139208139209139210139211139212139213139214139215139216139217139218139219139220139221139222139223139224139225139226139227139228139229139230139231139232139233139234139235139236139237139238139239139240139241139242139243139244139245139246139247139248139249139250139251139252139253139254139255139256139257139258139259139260139261139262139263139264139265139266139267139268139269139270139271139272139273139274139275139276139277139278139279139280139281139282139283139284139285139286139287139288139289139290139291139292139293139294139295139296139297139298139299139300139301139302139303139304139305139306139307139308139309139310139311139312139313139314139315139316139317139318139319139320139321139322139323139324139325139326139327139328139329139330139331139332139333139334139335139336139337139338139339139340139341139342139343139344139345139346139347139348139349139350139351139352139353139354139355139356139357139358139359139360139361139362139363139364139365139366139367139368139369139370139371139372139373139374139375139376139377139378139379139380139381139382139383139384139385139386139387139388139389139390139391139392139393139394139395139396139397139398139399139400139401139402139403139404139405139406139407139408139409139410139411139412139413139414139415139416139417139418139419139420139421139422139423139424139425139426139427139428139429139430139431139432139433139434139435139436139437139438139439139440139441139442139443139444139445139446139447139448139449139450139451139452139453139454139455139456139457139458139459139460139461139462139463139464139465139466139467139468139469139470139471139472139473139474139475139476139477139478139479139480139481139482139483139484139485139486139487139488139489139490139491139492139493139494139495139496139497139498139499139500139501139502139503139504139505139506139507139508139509139510139511139512139513139514139515139516139517139518139519139520139521139522139523139524139525139526139527139528139529139530139531139532139533139534139535139536139537139538139539139540139541139542139543139544139545139546139547139548139549139550139551139552139553139554139555139556139557139558139559139560139561139562139563139564139565139566139567139568139569139570139571139572139573139574139575139576139577139578139579139580139581139582139583139584139585139586139587139588139589139590139591139592139593139594139595139596139597139598139599139600139601139602139603139604139605139606139607139608139609139610139611139612139613139614139615139616139617139618139619139620139621139622139623139624139625139626139627139628139629139630139631139632139633139634139635139636139637139638139639139640139641139642139643139644139645139646139647139648139649139650139651139652139653139654139655139656139657139658139659139660139661139662139663139664139665139666139667139668139669139670139671139672139673139674139675139676139677139678139679139680139681139682139683139684139685139686139687139688139689139690139691139692139693139694139695139696139697139698139699139700139701139702139703139704139705139706139707139708139709139710139711139712139713139714139715139716139717139718139719139720139721139722139723139724139725139726139727139728139729139730139731139732139733139734139735139736139737139738139739139740139741139742139743139744139745139746139747139748139749139750139751139752139753139754139755139756139757139758139759139760139761139762139763139764139765139766139767139768139769139770139771139772139773139774139775139776139777139778139779139780139781139782139783139784139785139786139787139788139789139790139791139792139793139794139795139796139797139798139799139800139801139802139803139804139805139806139807139808139809139810139811139812139813139814139815139816139817139818139819139820139821139822139823139824139825139826139827139828139829139830139831139832139833139834139835139836139837139838139839139840139841139842139843139844139845139846139847139848139849139850139851139852139853139854139855139856139857139858139859139860139861139862139863139864139865139866139867139868139869139870139871139872139873139874139875139876139877139878139879139880139881139882139883139884139885139886139887139888139889139890139891139892139893139894139895139896139897139898139899139900139901139902139903139904139905139906139907139908139909139910139911139912139913139914139915139916139917139918139919139920139921139922139923139924139925139926139927139928139929139930139931139932139933139934139935139936139937139938139939139940139941139942139943139944139945139946139947139948139949139950139951139952139953139954139955139956139957139958139959139960139961139962139963139964139965139966139967139968139969139970139971139972139973139974139975139976139977139978139979139980139981139982139983139984139985139986139987139988139989139990139991139992139993139994139995139996139997139998139999140000140001140002140003140004140005140006140007140008140009140010140011140012140013140014140015140016140017140018140019140020140021140022140023140024140025140026140027140028140029140030140031140032140033140034140035140036140037140038140039140040140041140042140043140044140045140046140047140048140049140050140051140052140053140054140055140056140057140058140059140060140061140062140063140064140065140066140067140068140069140070140071140072140073140074140075140076140077140078140079140080140081140082140083140084140085140086140087140088140089140090140091140092140093140094140095140096140097140098140099140100140101140102140103140104140105140106140107140108140109140110140111140112140113140114140115140116140117140118140119140120140121140122140123140124140125140126140127140128140129140130140131140132140133140134140135140136140137140138140139140140140141140142140143140144140145140146140147140148140149140150140151140152140153140154140155140156140157140158140159140160140161140162140163140164140165140166140167140168140169140170140171140172140173140174140175140176140177140178140179140180140181140182140183140184140185140186140187140188140189140190140191140192140193140194140195140196140197140198140199140200140201140202140203140204140205140206140207140208140209140210140211140212140213140214140215140216140217140218140219140220140221140222140223140224140225140226140227140228140229140230140231140232140233140234140235140236140237140238140239140240140241140242140243140244140245140246140247140248140249140250140251140252140253140254140255140256140257140258140259140260140261140262140263140264140265140266140267140268140269140270140271140272140273140274140275140276140277140278140279140280140281140282140283140284140285140286140287140288140289140290140291140292140293140294140295140296140297140298140299140300140301140302140303140304140305140306140307140308140309140310140311140312140313140314140315140316140317140318140319140320140321140322140323140324140325140326140327140328140329140330140331140332140333140334140335140336140337140338140339140340140341140342140343140344140345140346140347140348140349140350140351140352140353140354140355140356140357140358140359140360140361140362140363140364140365140366140367140368140369140370140371140372140373140374140375140376140377140378140379140380140381140382140383140384140385140386140387140388140389140390140391140392140393140394140395140396140397140398140399140400140401140402140403140404140405140406140407140408140409140410140411140412140413140414140415140416140417140418140419140420140421140422140423140424140425140426140427140428140429140430140431140432140433140434140435140436140437140438140439140440140441140442140443140444140445140446140447140448140449140450140451140452140453140454140455140456140457140458140459140460140461140462140463140464140465140466140467140468140469140470140471140472140473140474140475140476140477140478140479140480140481140482140483140484140485140486140487140488140489140490140491140492140493140494140495140496140497140498140499140500140501140502140503140504140505140506140507140508140509140510140511140512140513140514140515140516140517140518140519140520140521140522140523140524140525140526140527140528140529140530140531140532140533140534140535140536140537140538140539140540140541140542140543140544140545140546140547140548140549140550140551140552140553140554140555140556140557140558140559140560140561140562140563140564140565140566140567140568140569140570140571140572140573140574140575140576140577140578140579140580140581140582140583140584140585140586140587140588140589140590140591140592140593140594140595140596140597140598140599140600140601140602140603140604140605140606140607140608140609140610140611140612140613140614140615140616140617140618140619140620140621140622140623140624140625140626140627140628140629140630140631140632140633140634140635140636140637140638140639140640140641140642140643140644140645140646140647140648140649140650140651140652140653140654140655140656140657140658140659140660140661140662140663140664140665140666140667140668140669140670140671140672140673140674140675140676140677140678140679140680140681140682140683140684140685140686140687140688140689140690140691140692140693140694140695140696140697140698140699140700140701140702140703140704140705140706140707140708140709140710140711140712140713140714140715140716140717140718140719140720140721140722140723140724140725140726140727140728140729140730140731140732140733140734140735140736140737140738140739140740140741140742140743140744140745140746140747140748140749140750140751140752140753140754140755140756140757140758140759140760140761140762140763140764140765140766140767140768140769140770140771140772140773140774140775140776140777140778140779140780140781140782140783140784140785140786140787140788140789140790140791140792140793140794140795140796140797140798140799140800140801140802140803140804140805140806140807140808140809140810140811140812140813140814140815140816140817140818140819140820140821140822140823140824140825140826140827140828140829140830140831140832140833140834140835140836140837140838140839140840140841140842140843140844140845140846140847140848140849140850140851140852140853140854140855140856140857140858140859140860140861140862140863140864140865140866140867140868140869140870140871140872140873140874140875140876140877140878140879140880140881140882140883140884140885140886140887140888140889140890140891140892140893140894140895140896140897140898140899140900140901140902140903140904140905140906140907140908140909140910140911140912140913140914140915140916140917140918140919140920140921140922140923140924140925140926140927140928140929140930140931140932140933140934140935140936140937140938140939140940140941140942140943140944140945140946140947140948140949140950140951140952140953140954140955140956140957140958140959140960140961140962140963140964140965140966140967140968140969140970140971140972140973140974140975140976140977140978140979140980140981140982140983140984140985140986140987140988140989140990140991140992140993140994140995140996140997140998140999141000141001141002141003141004141005141006141007141008141009141010141011141012141013141014141015141016141017141018141019141020141021141022141023141024141025141026141027141028141029141030141031141032141033141034141035141036141037141038141039141040141041141042141043141044141045141046141047141048141049141050141051141052141053141054141055141056141057141058141059141060141061141062141063141064141065141066141067141068141069141070141071141072141073141074141075141076141077141078141079141080141081141082141083141084141085141086141087141088141089141090141091141092141093141094141095141096141097141098141099141100141101141102141103141104141105141106141107141108141109141110141111141112141113141114141115141116141117141118141119141120141121141122141123141124141125141126141127141128141129141130141131141132141133141134141135141136141137141138141139141140141141141142141143141144141145141146141147141148141149141150141151141152141153141154141155141156141157141158141159141160141161141162141163141164141165141166141167141168141169141170141171141172141173141174141175141176141177141178141179141180141181141182141183141184141185141186141187141188141189141190141191141192141193141194141195141196141197141198141199141200141201141202141203141204141205141206141207141208141209141210141211141212141213141214141215141216141217141218141219141220141221141222141223141224141225141226141227141228141229141230141231141232141233141234141235141236141237141238141239141240141241141242141243141244141245141246141247141248141249141250141251141252141253141254141255141256141257141258141259141260141261141262141263141264141265141266141267141268141269141270141271141272141273141274141275141276141277141278141279141280141281141282141283141284141285141286141287141288141289141290141291141292141293141294141295141296141297141298141299141300141301141302141303141304141305141306141307141308141309141310141311141312141313141314141315141316141317141318141319141320141321141322141323141324141325141326141327141328141329141330141331141332141333141334141335141336141337141338141339141340141341141342141343141344141345141346141347141348141349141350141351141352141353141354141355141356141357141358141359141360141361141362141363141364141365141366141367141368141369141370141371141372141373141374141375141376141377141378141379141380141381141382141383141384141385141386141387141388141389141390141391141392141393141394141395141396141397141398141399141400141401141402141403141404141405141406141407141408141409141410141411141412141413141414141415141416141417141418141419141420141421141422141423141424141425141426141427141428141429141430141431141432141433141434141435141436141437141438141439141440141441141442141443141444141445141446141447141448141449141450141451141452141453141454141455141456141457141458141459141460141461141462141463141464141465141466141467141468141469141470141471141472141473141474141475141476141477141478141479141480141481141482141483141484141485141486141487141488141489141490141491141492141493141494141495141496141497141498141499141500141501141502141503141504141505141506141507141508141509141510141511141512141513141514141515141516141517141518141519141520141521141522141523141524141525141526141527141528141529141530141531141532141533141534141535141536141537141538141539141540141541141542141543141544141545141546141547141548141549141550141551141552141553141554141555141556141557141558141559141560141561141562141563141564141565141566141567141568141569141570141571141572141573141574141575141576141577141578141579141580141581141582141583141584141585141586141587141588141589141590141591141592141593141594141595141596141597141598141599141600141601141602141603141604141605141606141607141608141609141610141611141612141613141614141615141616141617141618141619141620141621141622141623141624141625141626141627141628141629141630141631141632141633141634141635141636141637141638141639141640141641141642141643141644141645141646141647141648141649141650141651141652141653141654141655141656141657141658141659141660141661141662141663141664141665141666141667141668141669141670141671141672141673141674141675141676141677141678141679141680141681141682141683141684141685141686141687141688141689141690141691141692141693141694141695141696141697141698141699141700141701141702141703141704141705141706141707141708141709141710141711141712141713141714141715141716141717141718141719141720141721141722141723141724141725141726141727141728141729141730141731141732141733141734141735141736141737141738141739141740141741141742141743141744141745141746141747141748141749141750141751141752141753141754141755141756141757141758141759141760141761141762141763141764141765141766141767141768141769141770141771141772141773141774141775141776141777141778141779141780141781141782141783141784141785141786141787141788141789141790141791141792141793141794141795141796141797141798141799141800141801141802141803141804141805141806141807141808141809141810141811141812141813141814141815141816141817141818141819141820141821141822141823141824141825141826141827141828141829141830141831141832141833141834141835141836141837141838141839141840141841141842141843141844141845141846141847141848141849141850141851141852141853141854141855141856141857141858141859141860141861141862141863141864141865141866141867141868141869141870141871141872141873141874141875141876141877141878141879141880141881141882141883141884141885141886141887141888141889141890141891141892141893141894141895141896141897141898141899141900141901141902141903141904141905141906141907141908141909141910141911141912141913141914141915141916141917141918141919141920141921141922141923141924141925141926141927141928141929141930141931141932141933141934141935141936141937141938141939141940141941141942141943141944141945141946141947141948141949141950141951141952141953141954141955141956141957141958141959141960141961141962141963141964141965141966141967141968141969141970141971141972141973141974141975141976141977141978141979141980141981141982141983141984141985141986141987141988141989141990141991141992141993141994141995141996141997141998141999142000142001142002142003142004142005142006142007142008142009142010142011142012142013142014142015142016142017142018142019142020142021142022142023142024142025142026142027142028142029142030142031142032142033142034142035142036142037142038142039142040142041142042142043142044142045142046142047142048142049142050142051142052142053142054142055142056142057142058142059142060142061142062142063142064142065142066142067142068142069142070142071142072142073142074142075142076142077142078142079142080142081142082142083142084142085142086142087142088142089142090142091142092142093142094142095142096142097142098142099142100142101142102142103142104142105142106142107142108142109142110142111142112142113142114142115142116142117142118142119142120142121142122142123142124142125142126142127142128142129142130142131142132142133142134142135142136142137142138142139142140142141142142142143142144142145142146142147142148142149142150142151142152142153142154142155142156142157142158142159142160142161142162142163142164142165142166142167142168142169142170142171142172142173142174142175142176142177142178142179142180142181142182142183142184142185142186142187142188142189142190142191142192142193142194142195142196142197142198142199142200142201142202142203142204142205142206142207142208142209142210142211142212142213142214142215142216142217142218142219142220142221142222142223142224142225142226142227142228142229142230142231142232142233142234142235142236142237142238142239142240142241142242142243142244142245142246142247142248142249142250142251142252142253142254142255142256142257142258142259142260142261142262142263142264142265142266142267142268142269142270142271142272142273142274142275142276142277142278142279142280142281142282142283142284142285142286142287142288142289142290142291142292142293142294142295142296142297142298142299142300142301142302142303142304142305142306142307142308142309142310142311142312142313142314142315142316142317142318142319142320142321142322142323142324142325142326142327142328142329142330142331142332142333142334142335142336142337142338142339142340142341142342142343142344142345142346142347142348142349142350142351142352142353142354142355142356142357142358142359142360142361142362142363142364142365142366142367142368142369142370142371142372142373142374142375142376142377142378142379142380142381142382142383142384142385142386142387142388142389142390142391142392142393142394142395142396142397142398142399142400142401142402142403142404142405142406142407142408142409142410142411142412142413142414142415142416142417142418142419142420142421142422142423142424142425142426142427142428142429142430142431142432142433142434142435142436142437142438142439142440142441142442142443142444142445142446142447142448142449142450142451142452142453142454142455142456142457142458142459142460142461142462142463142464142465142466142467142468142469142470142471142472142473142474142475142476142477142478142479142480142481142482142483142484142485142486142487142488142489142490142491142492142493142494142495142496142497142498142499142500142501142502142503142504142505142506142507142508142509142510142511142512142513142514142515142516142517142518142519142520142521142522142523142524142525142526142527142528142529142530142531142532142533142534142535142536142537142538142539142540142541142542142543142544142545142546142547142548142549142550142551142552142553142554142555142556142557142558142559142560142561142562142563142564142565142566142567142568142569142570142571142572142573142574142575142576142577142578142579142580142581142582142583142584142585142586142587142588142589142590142591142592142593142594142595142596142597142598142599142600142601142602142603142604142605142606142607142608142609142610142611142612142613142614142615142616142617142618142619142620142621142622142623142624142625142626142627142628142629142630142631142632142633142634142635142636142637142638142639142640142641142642142643142644142645142646142647142648142649142650142651142652142653142654142655142656142657142658142659142660142661142662142663142664142665142666142667142668142669142670142671142672142673142674142675142676142677142678142679142680142681142682142683142684142685142686142687142688142689142690142691142692142693142694142695142696142697142698142699142700142701142702142703142704142705142706142707142708142709142710142711142712142713142714142715142716142717142718142719142720142721142722142723142724142725142726142727142728142729142730142731142732142733142734142735142736142737142738142739142740142741142742142743142744142745142746142747142748142749142750142751142752142753142754142755142756142757142758142759142760142761142762142763142764142765142766142767142768142769142770142771142772142773142774142775142776142777142778142779142780142781142782142783142784142785142786142787142788142789142790142791142792142793142794142795142796142797142798142799142800142801142802142803142804142805142806142807142808142809142810142811142812142813142814142815142816142817142818142819142820142821142822142823142824142825142826142827142828142829142830142831142832142833142834142835142836142837142838142839142840142841142842142843142844142845142846142847142848142849142850142851142852142853142854142855142856142857142858142859142860142861142862142863142864142865142866142867142868142869142870142871142872142873142874142875142876142877142878142879142880142881142882142883142884142885142886142887142888142889142890142891142892142893142894142895142896142897142898142899142900142901142902142903142904142905142906142907142908142909142910142911142912142913142914142915142916142917142918142919142920142921142922142923142924142925142926142927142928142929142930142931142932142933142934142935142936142937142938142939142940142941142942142943142944142945142946142947142948142949142950142951142952142953142954142955142956142957142958142959142960142961142962142963142964142965142966142967142968142969142970142971142972142973142974142975142976142977142978142979142980142981142982142983142984142985142986142987142988142989142990142991142992142993142994142995142996142997142998142999143000143001143002143003143004143005143006143007143008143009143010143011143012143013143014143015143016143017143018143019143020143021143022143023143024143025143026143027143028143029143030143031143032143033143034143035143036143037143038143039143040143041143042143043143044143045143046143047143048143049143050143051143052143053143054143055143056143057143058143059143060143061143062143063143064143065143066143067143068143069143070143071143072143073143074143075143076143077143078143079143080143081143082143083143084143085143086143087143088143089143090143091143092143093143094143095143096143097143098143099143100143101143102143103143104143105143106143107143108143109143110143111143112143113143114143115143116143117143118143119143120143121143122143123143124143125143126143127143128143129143130143131143132143133143134143135143136143137143138143139143140143141143142143143143144143145143146143147143148143149143150143151143152143153143154143155143156143157143158143159143160143161143162143163143164143165143166143167143168143169143170143171143172143173143174143175143176143177143178143179143180143181143182143183143184143185143186143187143188143189143190143191143192143193143194143195143196143197143198143199143200143201143202143203143204143205143206143207143208143209143210143211143212143213143214143215143216143217143218143219143220143221143222143223143224143225143226143227143228143229143230143231143232143233143234143235143236143237143238143239143240143241143242143243143244143245143246143247143248143249143250143251143252143253143254143255143256143257143258143259143260143261143262143263143264143265143266143267143268143269143270143271143272143273143274143275143276143277143278143279143280143281143282143283143284143285143286143287143288143289143290143291143292143293143294143295143296143297143298143299143300143301143302143303143304143305143306143307143308143309143310143311143312143313143314143315143316143317143318143319143320143321143322143323143324143325143326143327143328143329143330143331143332143333143334143335143336143337143338143339143340143341143342143343143344143345143346143347143348143349143350143351143352143353143354143355143356143357143358143359143360143361143362143363143364143365143366143367143368143369143370143371143372143373143374143375143376143377143378143379143380143381143382143383143384143385143386143387143388143389143390143391143392143393143394143395143396143397143398143399143400143401143402143403143404143405143406143407143408143409143410143411143412143413143414143415143416143417143418143419143420143421143422143423143424143425143426143427143428143429143430143431143432143433143434143435143436143437143438143439143440143441143442143443143444143445143446143447143448143449143450143451143452143453143454143455143456143457143458143459143460143461143462143463143464143465143466143467143468143469143470143471143472143473143474143475143476143477143478143479143480143481143482143483143484143485143486143487143488143489143490143491143492143493143494143495143496143497143498143499143500143501143502143503143504143505143506143507143508143509143510143511143512143513143514143515143516143517143518143519143520143521143522143523143524143525143526143527143528143529143530143531143532143533143534143535143536143537143538143539143540143541143542143543143544143545143546143547143548143549143550143551143552143553143554143555143556143557143558143559143560143561143562143563143564143565143566143567143568143569143570143571143572143573143574143575143576143577143578143579143580143581143582143583143584143585143586143587143588143589143590143591143592143593143594143595143596143597143598143599143600143601143602143603143604143605143606143607143608143609143610143611143612143613143614143615143616143617143618143619143620143621143622143623143624143625143626143627143628143629143630143631143632143633143634143635143636143637143638143639143640143641143642143643143644143645143646143647143648143649143650143651143652143653143654143655143656143657143658143659143660143661143662143663143664143665143666143667143668143669143670143671143672143673143674143675143676143677143678143679143680143681143682143683143684143685143686143687143688143689143690143691143692143693143694143695143696143697143698143699143700143701143702143703143704143705143706143707143708143709143710143711143712143713143714143715143716143717143718143719143720143721143722143723143724143725143726143727143728143729143730143731143732143733143734143735143736143737143738143739143740143741143742143743143744143745143746143747143748143749143750143751143752143753143754143755143756143757143758143759143760143761143762143763143764143765143766143767143768143769143770143771143772143773143774143775143776143777143778143779143780143781143782143783143784143785143786143787143788143789143790143791143792143793143794143795143796143797143798143799143800143801143802143803143804143805143806143807143808143809143810143811143812143813143814143815143816143817143818143819143820143821143822143823143824143825143826143827143828143829143830143831143832143833143834143835143836143837143838143839143840143841143842143843143844143845143846143847143848143849143850143851143852143853143854143855143856143857143858143859143860143861143862143863143864143865143866143867143868143869143870143871143872143873143874143875143876143877143878143879143880143881143882143883143884143885143886143887143888143889143890143891143892143893143894143895143896143897143898143899143900143901143902143903143904143905143906143907143908143909143910143911143912143913143914143915143916143917143918143919143920143921143922143923143924143925143926143927143928143929143930143931143932143933143934143935143936143937143938143939143940143941143942143943143944143945143946143947143948143949143950143951143952143953143954143955143956143957143958143959143960143961143962143963143964143965143966143967143968143969143970143971143972143973143974143975143976143977143978143979143980143981143982143983143984143985143986143987143988143989143990143991143992143993143994143995143996143997143998143999144000144001144002144003144004144005144006144007144008144009144010144011144012144013144014144015144016144017144018144019144020144021144022144023144024144025144026144027144028144029144030144031144032144033144034144035144036144037144038144039144040144041144042144043144044144045144046144047144048144049144050144051144052144053144054144055144056144057144058144059144060144061144062144063144064144065144066144067144068144069144070144071144072144073144074144075144076144077144078144079144080144081144082144083144084144085144086144087144088144089144090144091144092144093144094144095144096144097144098144099144100144101144102144103144104144105144106144107144108144109144110144111144112144113144114144115144116144117144118144119144120144121144122144123144124144125144126144127144128144129144130144131144132144133144134144135144136144137144138144139144140144141144142144143144144144145144146144147144148144149144150144151144152144153144154144155144156144157144158144159144160144161144162144163144164144165144166144167144168144169144170144171144172144173144174144175144176144177144178144179144180144181144182144183144184144185144186144187144188144189144190144191144192144193144194144195144196144197144198144199144200144201144202144203144204144205144206144207144208144209144210144211144212144213144214144215144216144217144218144219144220144221144222144223144224144225144226144227144228144229144230144231144232144233144234144235144236144237144238144239144240144241144242144243144244144245144246144247144248144249144250144251144252144253144254144255144256144257144258144259144260144261144262144263144264144265144266144267144268144269144270144271144272144273144274144275144276144277144278144279144280144281144282144283144284144285144286144287144288144289144290144291144292144293144294144295144296144297144298144299144300144301144302144303144304144305144306144307144308144309144310144311144312144313144314144315144316144317144318144319144320144321144322144323144324144325144326144327144328144329144330144331144332144333144334144335144336144337144338144339144340144341144342144343144344144345144346144347144348144349144350144351144352144353144354144355144356144357144358144359144360144361144362144363144364144365144366144367144368144369144370144371144372144373144374144375144376144377144378144379144380144381144382144383144384144385144386144387144388144389144390144391144392144393144394144395144396144397144398144399144400144401144402144403144404144405144406144407144408144409144410144411144412144413144414144415144416144417144418144419144420144421144422144423144424144425144426144427144428144429144430144431144432144433144434144435144436144437144438144439144440144441144442144443144444144445144446144447144448144449144450144451144452144453144454144455144456144457144458144459144460144461144462144463144464144465144466144467144468144469144470144471144472144473144474144475144476144477144478144479144480144481144482144483144484144485144486144487144488144489144490144491144492144493144494144495144496144497144498144499144500144501144502144503144504144505144506144507144508144509144510144511144512144513144514144515144516144517144518144519144520144521144522144523144524144525144526144527144528144529144530144531144532144533144534144535144536144537144538144539144540144541144542144543144544144545144546144547144548144549144550144551144552144553144554144555144556144557144558144559144560144561144562144563144564144565144566144567144568144569144570144571144572144573144574144575144576144577144578144579144580144581144582144583144584144585144586144587144588144589144590144591144592144593144594144595144596144597144598144599144600144601144602144603144604144605144606144607144608144609144610144611144612144613144614144615144616144617144618144619144620144621144622144623144624144625144626144627144628144629144630144631144632144633144634144635144636144637144638144639144640144641144642144643144644144645144646144647144648144649144650144651144652144653144654144655144656144657144658144659144660144661144662144663144664144665144666144667144668144669144670144671144672144673144674144675144676144677144678144679144680144681144682144683144684144685144686144687144688144689144690144691144692144693144694144695144696144697144698144699144700144701144702144703144704144705144706144707144708144709144710144711144712144713144714144715144716144717144718144719144720144721144722144723144724144725144726144727144728144729144730144731144732144733144734144735144736144737144738144739144740144741144742144743144744144745144746144747144748144749144750144751144752144753144754144755144756144757144758144759144760144761144762144763144764144765144766144767144768144769144770144771144772144773144774144775144776144777144778144779144780144781144782144783144784144785144786144787144788144789144790144791144792144793144794144795144796144797144798144799144800144801144802144803144804144805144806144807144808144809144810144811144812144813144814144815144816144817144818144819144820144821144822144823144824144825144826144827144828144829144830144831144832144833144834144835144836144837144838144839144840144841144842144843144844144845144846144847144848144849144850144851144852144853144854144855144856144857144858144859144860144861144862144863144864144865144866144867144868144869144870144871144872144873144874144875144876144877144878144879144880144881144882144883144884144885144886144887144888144889144890144891144892144893144894144895144896144897144898144899144900144901144902144903144904144905144906144907144908144909144910144911144912144913144914144915144916144917144918144919144920144921144922144923144924144925144926144927144928144929144930144931144932144933144934144935144936144937144938144939144940144941144942144943144944144945144946144947144948144949144950144951144952144953144954144955144956144957144958144959144960144961144962144963144964144965144966144967144968144969144970144971144972144973144974144975144976144977144978144979144980144981144982144983144984144985144986144987144988144989144990144991144992144993144994144995144996144997144998144999145000145001145002145003145004145005145006145007145008145009145010145011145012145013145014145015145016145017145018145019145020145021145022145023145024145025145026145027145028145029145030145031145032145033145034145035145036145037145038145039145040145041145042145043145044145045145046145047145048145049145050145051145052145053145054145055145056145057145058145059145060145061145062145063145064145065145066145067145068145069145070145071145072145073145074145075145076145077145078145079145080145081145082145083145084145085145086145087145088145089145090145091145092145093145094145095145096145097145098145099145100145101145102145103145104145105145106145107145108145109145110145111145112145113145114145115145116145117145118145119145120145121145122145123145124145125145126145127145128145129145130145131145132145133145134145135145136145137145138145139145140145141145142145143145144145145145146145147145148145149145150145151145152145153145154145155145156145157145158145159145160145161145162145163145164145165145166145167145168145169145170145171145172145173145174145175145176145177145178145179145180145181145182145183145184145185145186145187145188145189145190145191145192145193145194145195145196145197145198145199145200145201145202145203145204145205145206145207145208145209145210145211145212145213145214145215145216145217145218145219145220145221145222145223145224145225145226145227145228145229145230145231145232145233145234145235145236145237145238145239145240145241145242145243145244145245145246145247145248145249145250145251145252145253145254145255145256145257145258145259145260145261145262145263145264145265145266145267145268145269145270145271145272145273145274145275145276145277145278145279145280145281145282145283145284145285145286145287145288145289145290145291145292145293145294145295145296145297145298145299145300145301145302145303145304145305145306145307145308145309145310145311145312145313145314145315145316145317145318145319145320145321145322145323145324145325145326145327145328145329145330145331145332145333145334145335145336145337145338145339145340145341145342145343145344145345145346145347145348145349145350145351145352145353145354145355145356145357145358145359145360145361145362145363145364145365145366145367145368145369145370145371145372145373145374145375145376145377145378145379145380145381145382145383145384145385145386145387145388145389145390145391145392145393145394145395145396145397145398145399145400145401145402145403145404145405145406145407145408145409145410145411145412145413145414145415145416145417145418145419145420145421145422145423145424145425145426145427145428145429145430145431145432145433145434145435145436145437145438145439145440145441145442145443145444145445145446145447145448145449145450145451145452145453145454145455145456145457145458145459145460145461145462145463145464145465145466145467145468145469145470145471145472145473145474145475145476145477145478145479145480145481145482145483145484145485145486145487145488145489145490145491145492145493145494145495145496145497145498145499145500145501145502145503145504145505145506145507145508145509145510145511145512145513145514145515145516145517145518145519145520145521145522145523145524145525145526145527145528145529145530145531145532145533145534145535145536145537145538145539145540145541145542145543145544145545145546145547145548145549145550145551145552145553145554145555145556145557145558145559145560145561145562145563145564145565145566145567145568145569145570145571145572145573145574145575145576145577145578145579145580145581145582145583145584145585145586145587145588145589145590145591145592145593145594145595145596145597145598145599145600145601145602145603145604145605145606145607145608145609145610145611145612145613145614145615145616145617145618145619145620145621145622145623145624145625145626145627145628145629145630145631145632145633145634145635145636145637145638145639145640145641145642145643145644145645145646145647145648145649145650145651145652145653145654145655145656145657145658145659145660145661145662145663145664145665145666145667145668145669145670145671145672145673145674145675145676145677145678145679145680145681145682145683145684145685145686145687145688145689145690145691145692145693145694145695145696145697145698145699145700145701145702145703145704145705145706145707145708145709145710145711145712145713145714145715145716145717145718145719145720145721145722145723145724145725145726145727145728145729145730145731145732145733145734145735145736145737145738145739145740145741145742145743145744145745145746145747145748145749145750145751145752145753145754145755145756145757145758145759145760145761145762145763145764145765145766145767145768145769145770145771145772145773145774145775145776145777145778145779145780145781145782145783145784145785145786145787145788145789145790145791145792145793145794145795145796145797145798145799145800145801145802145803145804145805145806145807145808145809145810145811145812145813145814145815145816145817145818145819145820145821145822145823145824145825145826145827145828145829145830145831145832145833145834145835145836145837145838145839145840145841145842145843145844145845145846145847145848145849145850145851145852145853145854145855145856145857145858145859145860145861145862145863145864145865145866145867145868145869145870145871145872145873145874145875145876145877145878145879145880145881145882145883145884145885145886145887145888145889145890145891145892145893145894145895145896145897145898145899145900145901145902145903145904145905145906145907145908145909145910145911145912145913145914145915145916145917145918145919145920145921145922145923145924145925145926145927145928145929145930145931145932145933145934145935145936145937145938145939145940145941145942145943145944145945145946145947145948145949145950145951145952145953145954145955145956145957145958145959145960145961145962145963145964145965145966145967145968145969145970145971145972145973145974145975145976145977145978145979145980145981145982145983145984145985145986145987145988145989145990145991145992145993145994145995145996145997145998145999146000146001146002146003146004146005146006146007146008146009146010146011146012146013146014146015146016146017146018146019146020146021146022146023146024146025146026146027146028146029146030146031146032146033146034146035146036146037146038146039146040146041146042146043146044146045146046146047146048146049146050146051146052146053146054146055146056146057146058146059146060146061146062146063146064146065146066146067146068146069146070146071146072146073146074146075146076146077146078146079146080146081146082146083146084146085146086146087146088146089146090146091146092146093146094146095146096146097146098146099146100146101146102146103146104146105146106146107146108146109146110146111146112146113146114146115146116146117146118146119146120146121146122146123146124146125146126146127146128146129146130146131146132146133146134146135146136146137146138146139146140146141146142146143146144146145146146146147146148146149146150146151146152146153146154146155146156146157146158146159146160146161146162146163146164146165146166146167146168146169146170146171146172146173146174146175146176146177146178146179146180146181146182146183146184146185146186146187146188146189146190146191146192146193146194146195146196146197146198146199146200146201146202146203146204146205146206146207146208146209146210146211146212146213146214146215146216146217146218146219146220146221146222146223146224146225146226146227146228146229146230146231146232146233146234146235146236146237146238146239146240146241146242146243146244146245146246146247146248146249146250146251146252146253146254146255146256146257146258146259146260146261146262146263146264146265146266146267146268146269146270146271146272146273146274146275146276146277146278146279146280146281146282146283146284146285146286146287146288146289146290146291146292146293146294146295146296146297146298146299146300146301146302146303146304146305146306146307146308146309146310146311146312146313146314146315146316146317146318146319146320146321146322146323146324146325146326146327146328146329146330146331146332146333146334146335146336146337146338146339146340146341146342146343146344146345146346146347146348146349146350146351146352146353146354146355146356146357146358146359146360146361146362146363146364146365146366146367146368146369146370146371146372146373146374146375146376146377146378146379146380146381146382146383146384146385146386146387146388146389146390146391146392146393146394146395146396146397146398146399146400146401146402146403146404146405146406146407146408146409146410146411146412146413146414146415146416146417146418146419146420146421146422146423146424146425146426146427146428146429146430146431146432146433146434146435146436146437146438146439146440146441146442146443146444146445146446146447146448146449146450146451146452146453146454146455146456146457146458146459146460146461146462146463146464146465146466146467146468146469146470146471146472146473146474146475146476146477146478146479146480146481146482146483146484146485146486146487146488146489146490146491146492146493146494146495146496146497146498146499146500146501146502146503146504146505146506146507146508146509146510146511146512146513146514146515146516146517146518146519146520146521146522146523146524146525146526146527146528146529146530146531146532146533146534146535146536146537146538146539146540146541146542146543146544146545146546146547146548146549146550146551146552146553146554146555146556146557146558146559146560146561146562146563146564146565146566146567146568146569146570146571146572146573146574146575146576146577146578146579146580146581146582146583146584146585146586146587146588146589146590146591146592146593146594146595146596146597146598146599146600146601146602146603146604146605146606146607146608146609146610146611146612146613146614146615146616146617146618146619146620146621146622146623146624146625146626146627146628146629146630146631146632146633146634146635146636146637146638146639146640146641146642146643146644146645146646146647146648146649146650146651146652146653146654146655146656146657146658146659146660146661146662146663146664146665146666146667146668146669146670146671146672146673146674146675146676146677146678146679146680146681146682146683146684146685146686146687146688146689146690146691146692146693146694146695146696146697146698146699146700146701146702146703146704146705146706146707146708146709146710146711146712146713146714146715146716146717146718146719146720146721146722146723146724146725146726146727146728146729146730146731146732146733146734146735146736146737146738146739146740146741146742146743146744146745146746146747146748146749146750146751146752146753146754146755146756146757146758146759146760146761146762146763146764146765146766146767146768146769146770146771146772146773146774146775146776146777146778146779146780146781146782146783146784146785146786146787146788146789146790146791146792146793146794146795146796146797146798146799146800146801146802146803146804146805146806146807146808146809146810146811146812146813146814146815146816146817146818146819146820146821146822146823146824146825146826146827146828146829146830146831146832146833146834146835146836146837146838146839146840146841146842146843146844146845146846146847146848146849146850146851146852146853146854146855146856146857146858146859146860146861146862146863146864146865146866146867146868146869146870146871146872146873146874146875146876146877146878146879146880146881146882146883146884146885146886146887146888146889146890146891146892146893146894146895146896146897146898146899146900146901146902146903146904146905146906146907146908146909146910146911146912146913146914146915146916146917146918146919146920146921146922146923146924146925146926146927146928146929146930146931146932146933146934146935146936146937146938146939146940146941146942146943146944146945146946146947146948146949146950146951146952146953146954146955146956146957146958146959146960146961146962146963146964146965146966146967146968146969146970146971146972146973146974146975146976146977146978146979146980146981146982146983146984146985146986146987146988146989146990146991146992146993146994146995146996146997146998146999147000147001147002147003147004147005147006147007147008147009147010147011147012147013147014147015147016147017147018147019147020147021147022147023147024147025147026147027147028147029147030147031147032147033147034147035147036147037147038147039147040147041147042147043147044147045147046147047147048147049147050147051147052147053147054147055147056147057147058147059147060147061147062147063147064147065147066147067147068147069147070147071147072147073147074147075147076147077147078147079147080147081147082147083147084147085147086147087147088147089147090147091147092147093147094147095147096147097147098147099147100147101147102147103147104147105147106147107147108147109147110147111147112147113147114147115147116147117147118147119147120147121147122147123147124147125147126147127147128147129147130147131147132147133147134147135147136147137147138147139147140147141147142147143147144147145147146147147147148147149147150147151147152147153147154147155147156147157147158147159147160147161147162147163147164147165147166147167147168147169147170147171147172147173147174147175147176147177147178147179147180147181147182147183147184147185147186147187147188147189147190147191147192147193147194147195147196147197147198147199147200147201147202147203147204147205147206147207147208147209147210147211147212147213147214147215147216147217147218147219147220147221147222147223147224147225147226147227147228147229147230147231147232147233147234147235147236147237147238147239147240147241147242147243147244147245147246147247147248147249147250147251147252147253147254147255147256147257147258147259147260147261147262147263147264147265147266147267147268147269147270147271147272147273147274147275147276147277147278147279147280147281147282147283147284147285147286147287147288147289147290147291147292147293147294147295147296147297147298147299147300147301147302147303147304147305147306147307147308147309147310147311147312147313147314147315147316147317147318147319147320147321147322147323147324147325147326147327147328147329147330147331147332147333147334147335147336147337147338147339147340147341147342147343147344147345147346147347147348147349147350147351147352147353147354147355147356147357147358147359147360147361147362147363147364147365147366147367147368147369147370147371147372147373147374147375147376147377147378147379147380147381147382147383147384147385147386147387147388147389147390147391147392147393147394147395147396147397147398147399147400147401147402147403147404147405147406147407147408147409147410147411147412147413147414147415147416147417147418147419147420147421147422147423147424147425147426147427147428147429147430147431147432147433147434147435147436147437147438147439147440147441147442147443147444147445147446147447147448147449147450147451147452147453147454147455147456147457147458147459147460147461147462147463147464147465147466147467147468147469147470147471147472147473147474147475147476147477147478147479147480147481147482147483147484147485147486147487147488147489147490147491147492147493147494147495147496147497147498147499147500147501147502147503147504147505147506147507147508147509147510147511147512147513147514147515147516147517147518147519147520147521147522147523147524147525147526147527147528147529147530147531147532147533147534147535147536147537147538147539147540147541147542147543147544147545147546147547147548147549147550147551147552147553147554147555147556147557147558147559147560147561147562147563147564147565147566147567147568147569147570147571147572147573147574147575147576147577147578147579147580147581147582147583147584147585147586147587147588147589147590147591147592147593147594147595147596147597147598147599147600147601147602147603147604147605147606147607147608147609147610147611147612147613147614147615147616147617147618147619147620147621147622147623147624147625147626147627147628147629147630147631147632147633147634147635147636147637147638147639147640147641147642147643147644147645147646147647147648147649147650147651147652147653147654147655147656147657147658147659147660147661147662147663147664147665147666147667147668147669147670147671147672147673147674147675147676147677147678147679147680147681147682147683147684147685147686147687147688147689147690147691147692147693147694147695147696147697147698147699147700147701147702147703147704147705147706147707147708147709147710147711147712147713147714147715147716147717147718147719147720147721147722147723147724147725147726147727147728147729147730147731147732147733147734147735147736147737147738147739147740147741147742147743147744147745147746147747147748147749147750147751147752147753147754147755147756147757147758147759147760147761147762147763147764147765147766147767147768147769147770147771147772147773147774147775147776147777147778147779147780147781147782147783147784147785147786147787147788147789147790147791147792147793147794147795147796147797147798147799147800147801147802147803147804147805147806147807147808147809147810147811147812147813147814147815147816147817147818147819147820147821147822147823147824147825147826147827147828147829147830147831147832147833147834147835147836147837147838147839147840147841147842147843147844147845147846147847147848147849147850147851147852147853147854147855147856147857147858147859147860147861147862147863147864147865147866147867147868147869147870147871147872147873147874147875147876147877147878147879147880147881147882147883147884147885147886147887147888147889147890147891147892147893147894147895147896147897147898147899147900147901147902147903147904147905147906147907147908147909147910147911147912147913147914147915147916147917147918147919147920147921147922147923147924147925147926147927147928147929147930147931147932147933147934147935147936147937147938147939147940147941147942147943147944147945147946147947147948147949147950147951147952147953147954147955147956147957147958147959147960147961147962147963147964147965147966147967147968147969147970147971147972147973147974147975147976147977147978147979147980147981147982147983147984147985147986147987147988147989147990147991147992147993147994147995147996147997147998147999148000148001148002148003148004148005148006148007148008148009148010148011148012148013148014148015148016148017148018148019148020148021148022148023148024148025148026148027148028148029148030148031148032148033148034148035148036148037148038148039148040148041148042148043148044148045148046148047148048148049148050148051148052148053148054148055148056148057148058148059148060148061148062148063148064148065148066148067148068148069148070148071148072148073148074148075148076148077148078148079148080148081148082148083148084148085148086148087148088148089148090148091148092148093148094148095148096148097148098148099148100148101148102148103148104148105148106148107148108148109148110148111148112148113148114148115148116148117148118148119148120148121148122148123148124148125148126148127148128148129148130148131148132148133148134148135148136148137148138148139148140148141148142148143148144148145148146148147148148148149148150148151148152148153148154148155148156148157148158148159148160148161148162148163148164148165148166148167148168148169148170148171148172148173148174148175148176148177148178148179148180148181148182148183148184148185148186148187148188148189148190148191148192148193148194148195148196148197148198148199148200148201148202148203148204148205148206148207148208148209148210148211148212148213148214148215148216148217148218148219148220148221148222148223148224148225148226148227148228148229148230148231148232148233148234148235148236148237148238148239148240148241148242148243148244148245148246148247148248148249148250148251148252148253148254148255148256148257148258148259148260148261148262148263148264148265148266148267148268148269148270148271148272148273148274148275148276148277148278148279148280148281148282148283148284148285148286148287148288148289148290148291148292148293148294148295148296148297148298148299148300148301148302148303148304148305148306148307148308148309148310148311148312148313148314148315148316148317148318148319148320148321148322148323148324148325148326148327148328148329148330148331148332148333148334148335148336148337148338148339148340148341148342148343148344148345148346148347148348148349148350148351148352148353148354148355148356148357148358148359148360148361148362148363148364148365148366148367148368148369148370148371148372148373148374148375148376148377148378148379148380148381148382148383148384148385148386148387148388148389148390148391148392148393148394148395148396148397148398148399148400148401148402148403148404148405148406148407148408148409148410148411148412148413148414148415148416148417148418148419148420148421148422148423148424148425148426148427148428148429148430148431148432148433148434148435148436148437148438148439148440148441148442148443148444148445148446148447148448148449148450148451148452148453148454148455148456148457148458148459148460148461148462148463148464148465148466148467148468148469148470148471148472148473148474148475148476148477148478148479148480148481148482148483148484148485148486148487148488148489148490148491148492148493148494148495148496148497148498148499148500148501148502148503148504148505148506148507148508148509148510148511148512148513148514148515148516148517148518148519148520148521148522148523148524148525148526148527148528148529148530148531148532148533148534148535148536148537148538148539148540148541148542148543148544148545148546148547148548148549148550148551148552148553148554148555148556148557148558148559148560148561148562148563148564148565148566148567148568148569148570148571148572148573148574148575148576148577148578148579148580148581148582148583148584148585148586148587148588148589148590148591148592148593148594148595148596148597148598148599148600148601148602148603148604148605148606148607148608148609148610148611148612148613148614148615148616148617148618148619148620148621148622148623148624148625148626148627148628148629148630148631148632148633148634148635148636148637148638148639148640148641148642148643148644148645148646148647148648148649148650148651148652148653148654148655148656148657148658148659148660148661148662148663148664148665148666148667148668148669148670148671148672148673148674148675148676148677148678148679148680148681148682148683148684148685148686148687148688148689148690148691148692148693148694148695148696148697148698148699148700148701148702148703148704148705148706148707148708148709148710148711148712148713148714148715148716148717148718148719148720148721148722148723148724148725148726148727148728148729148730148731148732148733148734148735148736148737148738148739148740148741148742148743148744148745148746148747148748148749148750148751148752148753148754148755148756148757148758148759148760148761148762148763148764148765148766148767148768148769148770148771148772148773148774148775148776148777148778148779148780148781148782148783148784148785148786148787148788148789148790148791148792148793148794148795148796148797148798148799148800148801148802148803148804148805148806148807148808148809148810148811148812148813148814148815148816148817148818148819148820148821148822148823148824148825148826148827148828148829148830148831148832148833148834148835148836148837148838148839148840148841148842148843148844148845148846148847148848148849148850148851148852148853148854148855148856148857148858148859148860148861148862148863148864148865148866148867148868148869148870148871148872148873148874148875148876148877148878148879148880148881148882148883148884148885148886148887148888148889148890148891148892148893148894148895148896148897148898148899148900148901148902148903148904148905148906148907148908148909148910148911148912148913148914148915148916148917148918148919148920148921148922148923148924148925148926148927148928148929148930148931148932148933148934148935148936148937148938148939148940148941148942148943148944148945148946148947148948148949148950148951148952148953148954148955148956148957148958148959148960148961148962148963148964148965148966148967148968148969148970148971148972148973148974148975148976148977148978148979148980148981148982148983148984148985148986148987148988148989148990148991148992148993148994148995148996148997148998148999149000149001149002149003149004149005149006149007149008149009149010149011149012149013149014149015149016149017149018149019149020149021149022149023149024149025149026149027149028149029149030149031149032149033149034149035149036149037149038149039149040149041149042149043149044149045149046149047149048149049149050149051149052149053149054149055149056149057149058149059149060149061149062149063149064149065149066149067149068149069149070149071149072149073149074149075149076149077149078149079149080149081149082149083149084149085149086149087149088149089149090149091149092149093149094149095149096149097149098149099149100149101149102149103149104149105149106149107149108149109149110149111149112149113149114149115149116149117149118149119149120149121149122149123149124149125149126149127149128149129149130149131149132149133149134149135149136149137149138149139149140149141149142149143149144149145149146149147149148149149149150149151149152149153149154149155149156149157149158149159149160149161149162149163149164149165149166149167149168149169149170149171149172149173149174149175149176149177149178149179149180149181149182149183149184149185149186149187149188149189149190149191149192149193149194149195149196149197149198149199149200149201149202149203149204149205149206149207149208149209149210149211149212149213149214149215149216149217149218149219149220149221149222149223149224149225149226149227149228149229149230149231149232149233149234149235149236149237149238149239149240149241149242149243149244149245149246149247149248149249149250149251149252149253149254149255149256149257149258149259149260149261149262149263149264149265149266149267149268149269149270149271149272149273149274149275149276149277149278149279149280149281149282149283149284149285149286149287149288149289149290149291149292149293149294149295149296149297149298149299149300149301149302149303149304149305149306149307149308149309149310149311149312149313149314149315149316149317149318149319149320149321149322149323149324149325149326149327149328149329149330149331149332149333149334149335149336149337149338149339149340149341149342149343149344149345149346149347149348149349149350149351149352149353149354149355149356149357149358149359149360149361149362149363149364149365149366149367149368149369149370149371149372149373149374149375149376149377149378149379149380149381149382149383149384149385149386149387149388149389149390149391149392149393149394149395149396149397149398149399149400149401149402149403149404149405149406149407149408149409149410149411149412149413149414149415149416149417149418149419149420149421149422149423149424149425149426149427149428149429149430149431149432149433149434149435149436149437149438149439149440149441149442149443149444149445149446149447149448149449149450149451149452149453149454149455149456149457149458149459149460149461149462149463149464149465149466149467149468149469149470149471149472149473149474149475149476149477149478149479149480149481149482149483149484149485149486149487149488149489149490149491149492149493149494149495149496149497149498149499149500149501149502149503149504149505149506149507149508149509149510149511149512149513149514149515149516149517149518149519149520149521149522149523149524149525149526149527149528149529149530149531149532149533149534149535149536149537149538149539149540149541149542149543149544149545149546149547149548149549149550149551149552149553149554149555149556149557149558149559149560149561149562149563149564149565149566149567149568149569149570149571149572149573149574149575149576149577149578149579149580149581149582149583149584149585149586149587149588149589149590149591149592149593149594149595149596149597149598149599149600149601149602149603149604149605149606149607149608149609149610149611149612149613149614149615149616149617149618149619149620149621149622149623149624149625149626149627149628149629149630149631149632149633149634149635149636149637149638149639149640149641149642149643149644149645149646149647149648149649149650149651149652149653149654149655149656149657149658149659149660149661149662149663149664149665149666149667149668149669149670149671149672149673149674149675149676149677149678149679149680149681149682149683149684149685149686149687149688149689149690149691149692149693149694149695149696149697149698149699149700149701149702149703149704149705149706149707149708149709149710149711149712149713149714149715149716149717149718149719149720149721149722149723149724149725149726149727149728149729149730149731149732149733149734149735149736149737149738149739149740149741149742149743149744149745149746149747149748149749149750149751149752149753149754149755149756149757149758149759149760149761149762149763149764149765149766149767149768149769149770149771149772149773149774149775149776149777149778149779149780149781149782149783149784149785149786149787149788149789149790149791149792149793149794149795149796149797149798149799149800149801149802149803149804149805149806149807149808149809149810149811149812149813149814149815149816149817149818149819149820149821149822149823149824149825149826149827149828149829149830149831149832149833149834149835149836149837149838149839149840149841149842149843149844149845149846149847149848149849149850149851149852149853149854149855149856149857149858149859149860149861149862149863149864149865149866149867149868149869149870149871149872149873149874149875149876149877149878149879149880149881149882149883149884149885149886149887149888149889149890149891149892149893149894149895149896149897149898149899149900149901149902149903149904149905149906149907149908149909149910149911149912149913149914149915149916149917149918149919149920149921149922149923149924149925149926149927149928149929149930149931149932149933149934149935149936149937149938149939149940149941149942149943149944149945149946149947149948149949149950149951149952149953149954149955149956149957149958149959149960149961149962149963149964149965149966149967149968149969149970149971149972149973149974149975149976149977149978149979149980149981149982149983149984149985149986149987149988149989149990149991149992149993149994149995149996149997149998149999150000150001150002150003150004150005150006150007150008150009150010150011150012150013150014150015150016150017150018150019150020150021150022150023150024150025150026150027150028150029150030150031150032150033150034150035150036150037150038150039150040150041150042150043150044150045150046150047150048150049150050150051150052150053150054150055150056150057150058150059150060150061150062150063150064150065150066150067150068150069150070150071150072150073150074150075150076150077150078150079150080150081150082150083150084150085150086150087150088150089150090150091150092150093150094150095150096150097150098150099150100150101150102150103150104150105150106150107150108150109150110150111150112150113150114150115150116150117150118150119150120150121150122150123150124150125150126150127150128150129150130150131150132150133150134150135150136150137150138150139150140150141150142150143150144150145150146150147150148150149150150150151150152150153150154150155150156150157150158150159150160150161150162150163150164150165150166150167150168150169150170150171150172150173150174150175150176150177150178150179150180150181150182150183150184150185150186150187150188150189150190150191150192150193150194150195150196150197150198150199150200150201150202150203150204150205150206150207150208150209150210150211150212150213150214150215150216150217150218150219150220150221150222150223150224150225150226150227150228150229150230150231150232150233150234150235150236150237150238150239150240150241150242150243150244150245150246150247150248150249150250150251150252150253150254150255150256150257150258150259150260150261150262150263150264150265150266150267150268150269150270150271150272150273150274150275150276150277150278150279150280150281150282150283150284150285150286150287150288150289150290150291150292150293150294150295150296150297150298150299150300150301150302150303150304150305150306150307150308150309150310150311150312150313150314150315150316150317150318150319150320150321150322150323150324150325150326150327150328150329150330150331150332150333150334150335150336150337150338150339150340150341150342150343150344150345150346150347150348150349150350150351150352150353150354150355150356150357150358150359150360150361150362150363150364150365150366150367150368150369150370150371150372150373150374150375150376150377150378150379150380150381150382150383150384150385150386150387150388150389150390150391150392150393150394150395150396150397150398150399150400150401150402150403150404150405150406150407150408150409150410150411150412150413150414150415150416150417150418150419150420150421150422150423150424150425150426150427150428150429150430150431150432150433150434150435150436150437150438150439150440150441150442150443150444150445150446150447150448150449150450150451150452150453150454150455150456150457150458150459150460150461150462150463150464150465150466150467150468150469150470150471150472150473150474150475150476150477150478150479150480150481150482150483150484150485150486150487150488150489150490150491150492150493150494150495150496150497150498150499150500150501150502150503150504150505150506150507150508150509150510150511150512150513150514150515150516150517150518150519150520150521150522150523150524150525150526150527150528150529150530150531150532150533150534150535150536150537150538150539150540150541150542150543150544150545150546150547150548150549150550150551150552150553150554150555150556150557150558150559150560150561150562150563150564150565150566150567150568150569150570150571150572150573150574150575150576150577150578150579150580150581150582150583150584150585150586150587150588150589150590150591150592150593150594150595150596150597150598150599150600150601150602150603150604150605150606150607150608150609150610150611150612150613150614150615150616150617150618150619150620150621150622150623150624150625150626150627150628150629150630150631150632150633150634150635150636150637150638150639150640150641150642150643150644150645150646150647150648150649150650150651150652150653150654150655150656150657150658150659150660150661150662150663150664150665150666150667150668150669150670150671150672150673150674150675150676150677150678150679150680150681150682150683150684150685150686150687150688150689150690150691150692150693150694150695150696150697150698150699150700150701150702150703150704150705150706150707150708150709150710150711150712150713150714150715150716150717150718150719150720150721150722150723150724150725150726150727150728150729150730150731150732150733150734150735150736150737150738150739150740150741150742150743150744150745150746150747150748150749150750150751150752150753150754150755150756150757150758150759150760150761150762150763150764150765150766150767150768150769150770150771150772150773150774150775150776150777150778150779150780150781150782150783150784150785150786150787150788150789150790150791150792150793150794150795150796150797150798150799150800150801150802150803150804150805150806150807150808150809150810150811150812150813150814150815150816150817150818150819150820150821150822150823150824150825150826150827150828150829150830150831150832150833150834150835150836150837150838150839150840150841150842150843150844150845150846150847150848150849150850150851150852150853150854150855150856150857150858150859150860150861150862150863150864150865150866150867150868150869150870150871150872150873150874150875150876150877150878150879150880150881150882150883150884150885150886150887150888150889150890150891150892150893150894150895150896150897150898150899150900150901150902150903150904150905150906150907150908150909150910150911150912150913150914150915150916150917150918150919150920150921150922150923150924150925150926150927150928150929150930150931150932150933150934150935150936150937150938150939150940150941150942150943150944150945150946150947150948150949150950150951150952150953150954150955150956150957150958150959150960150961150962150963150964150965150966150967150968150969150970150971150972150973150974150975150976150977150978150979150980150981150982150983150984150985150986150987150988150989150990150991150992150993150994150995150996150997150998150999151000151001151002151003151004151005151006151007151008151009151010151011151012151013151014151015151016151017151018151019151020151021151022151023151024151025151026151027151028151029151030151031151032151033151034151035151036151037151038151039151040151041151042151043151044151045151046151047151048151049151050151051151052151053151054151055151056151057151058151059151060151061151062151063151064151065151066151067151068151069151070151071151072151073151074151075151076151077151078151079151080151081151082151083151084151085151086151087151088151089151090151091151092151093151094151095151096151097151098151099151100151101151102151103151104151105151106151107151108151109151110151111151112151113151114151115151116151117151118151119151120151121151122151123151124151125151126151127151128151129151130151131151132151133151134151135151136151137151138151139151140151141151142151143151144151145151146151147151148151149151150151151151152151153151154151155151156151157151158151159151160151161151162151163151164151165151166151167151168151169151170151171151172151173151174151175151176151177151178151179151180151181151182151183151184151185151186151187151188151189151190151191151192151193151194151195151196151197151198151199151200151201151202151203151204151205151206151207151208151209151210151211151212151213151214151215151216151217151218151219151220151221151222151223151224151225151226151227151228151229151230151231151232151233151234151235151236151237151238151239151240151241151242151243151244151245151246151247151248151249151250151251151252151253151254151255151256151257151258151259151260151261151262151263151264151265151266151267151268151269151270151271151272151273151274151275151276151277151278151279151280151281151282151283151284151285151286151287151288151289151290151291151292151293151294151295151296151297151298151299151300151301151302151303151304151305151306151307151308151309151310151311151312151313151314151315151316151317151318151319151320151321151322151323151324151325151326151327151328151329151330151331151332151333151334151335151336151337151338151339151340151341151342151343151344151345151346151347151348151349151350151351151352151353151354151355151356151357151358151359151360151361151362151363151364151365151366151367151368151369151370151371151372151373151374151375151376151377151378151379151380151381151382151383151384151385151386151387151388151389151390151391151392151393151394151395151396151397151398151399151400151401151402151403151404151405151406151407151408151409151410151411151412151413151414151415151416151417151418151419151420151421151422151423151424151425151426151427151428151429151430151431151432151433151434151435151436151437151438151439151440151441151442151443151444151445151446151447151448151449151450151451151452151453151454151455151456151457151458151459151460151461151462151463151464151465151466151467151468151469151470151471151472151473151474151475151476151477151478151479151480151481151482151483151484151485151486151487151488151489151490151491151492151493151494151495151496151497151498151499151500151501151502151503151504151505151506151507151508151509151510151511151512151513151514151515151516151517151518151519151520151521151522151523151524151525151526151527151528151529151530151531151532151533151534151535151536151537151538151539151540151541151542151543151544151545151546151547151548151549151550151551151552151553151554151555151556151557151558151559151560151561151562151563151564151565151566151567151568151569151570151571151572151573151574151575151576151577151578151579151580151581151582151583151584151585151586151587151588151589151590151591151592151593151594151595151596151597151598151599151600151601151602151603151604151605151606151607151608151609151610151611151612151613151614151615151616151617151618151619151620151621151622151623151624151625151626151627151628151629151630151631151632151633151634151635151636151637151638151639151640151641151642151643151644151645151646151647151648151649151650151651151652151653151654151655151656151657151658151659151660151661151662151663151664151665151666151667151668151669151670151671151672151673151674151675151676151677151678151679151680151681151682151683151684151685151686151687151688151689151690151691151692151693151694151695151696151697151698151699151700151701151702151703151704151705151706151707151708151709151710151711151712151713151714151715151716151717151718151719151720151721151722151723151724151725151726151727151728151729151730151731151732151733151734151735151736151737151738151739151740151741151742151743151744151745151746151747151748151749151750151751151752151753151754151755151756151757151758151759151760151761151762151763151764151765151766151767151768151769151770151771151772151773151774151775151776151777151778151779151780151781151782151783151784151785151786151787151788151789151790151791151792151793151794151795151796151797151798151799151800151801151802151803151804151805151806151807151808151809151810151811151812151813151814151815151816151817151818151819151820151821151822151823151824151825151826151827151828151829151830151831151832151833151834151835151836151837151838151839151840151841151842151843151844151845151846151847151848151849151850151851151852151853151854151855151856151857151858151859151860151861151862151863151864151865151866151867151868151869151870151871151872151873151874151875151876151877151878151879151880151881151882151883151884151885151886151887151888151889151890151891151892151893151894151895151896151897151898151899151900151901151902151903151904151905151906151907151908151909151910151911151912151913151914151915151916151917151918151919151920151921151922151923151924151925151926151927151928151929151930151931151932151933151934151935151936151937151938151939151940151941151942151943151944151945151946151947151948151949151950151951151952151953151954151955151956151957151958151959151960151961151962151963151964151965151966151967151968151969151970151971151972151973151974151975151976151977151978151979151980151981151982151983151984151985151986151987151988151989151990151991151992151993151994151995151996151997151998151999152000152001152002152003152004152005152006152007152008152009152010152011152012152013152014152015152016152017152018152019152020152021152022152023152024152025152026152027152028152029152030152031152032152033152034152035152036152037152038152039152040152041152042152043152044152045152046152047152048152049152050152051152052152053152054152055152056152057152058152059152060152061152062152063152064152065152066152067152068152069152070152071152072152073152074152075152076152077152078152079152080152081152082152083152084152085152086152087152088152089152090152091152092152093152094152095152096152097152098152099152100152101152102152103152104152105152106152107152108152109152110152111152112152113152114152115152116152117152118152119152120152121152122152123152124152125152126152127152128152129152130152131152132152133152134152135152136152137152138152139152140152141152142152143152144152145152146152147152148152149152150152151152152152153152154152155152156152157152158152159152160152161152162152163152164152165152166152167152168152169152170152171152172152173152174152175152176152177152178152179152180152181152182152183152184152185152186152187152188152189152190152191152192152193152194152195152196152197152198152199152200152201152202152203152204152205152206152207152208152209152210152211152212152213152214152215152216152217152218152219152220152221152222152223152224152225152226152227152228152229152230152231152232152233152234152235152236152237152238152239152240152241152242152243152244152245152246152247152248152249152250152251152252152253152254152255152256152257152258152259152260152261152262152263152264152265152266152267152268152269152270152271152272152273152274152275152276152277152278152279152280152281152282152283152284152285152286152287152288152289152290152291152292152293152294152295152296152297152298152299152300152301152302152303152304152305152306152307152308152309152310152311152312152313152314152315152316152317152318152319152320152321152322152323152324152325152326152327152328152329152330152331152332152333152334152335152336152337152338152339152340152341152342152343152344152345152346152347152348152349152350152351152352152353152354152355152356152357152358152359152360152361152362152363152364152365152366152367152368152369152370152371152372152373152374152375152376152377152378152379152380152381152382152383152384152385152386152387152388152389152390152391152392152393152394152395152396152397152398152399152400152401152402152403152404152405152406152407152408152409152410152411152412152413152414152415152416152417152418152419152420152421152422152423152424152425152426152427152428152429152430152431152432152433152434152435152436152437152438152439152440152441152442152443152444152445152446152447152448152449152450152451152452152453152454152455152456152457152458152459152460152461152462152463152464152465152466152467152468152469152470152471152472152473152474152475152476152477152478152479152480152481152482152483152484152485152486152487152488152489152490152491152492152493152494152495152496152497152498152499152500152501152502152503152504152505152506152507152508152509152510152511152512152513152514152515152516152517152518152519152520152521152522152523152524152525152526152527152528152529152530152531152532152533152534152535152536152537152538152539152540152541152542152543152544152545152546152547152548152549152550152551152552152553152554152555152556152557152558152559152560152561152562152563152564152565152566152567152568152569152570152571152572152573152574152575152576152577152578152579152580152581152582152583152584152585152586152587152588152589152590152591152592152593152594152595152596152597152598152599152600152601152602152603152604152605152606152607152608152609152610152611152612152613152614152615152616152617152618152619152620152621152622152623152624152625152626152627152628152629152630152631152632152633152634152635152636152637152638152639152640152641152642152643152644152645152646152647152648152649152650152651152652152653152654152655152656152657152658152659152660152661152662152663152664152665152666152667152668152669152670152671152672152673152674152675152676152677152678152679152680152681152682152683152684152685152686152687152688152689152690152691152692152693152694152695152696152697152698152699152700152701152702152703152704152705152706152707152708152709152710152711152712152713152714152715152716152717152718152719152720152721152722152723152724152725152726152727152728152729152730152731152732152733152734152735152736152737152738152739152740152741152742152743152744152745152746152747152748152749152750152751152752152753152754152755152756152757152758152759152760152761152762152763152764152765152766152767152768152769152770152771152772152773152774152775152776152777152778152779152780152781152782152783152784152785152786152787152788152789152790152791152792152793152794152795152796152797152798152799152800152801152802152803152804152805152806152807152808152809152810152811152812152813152814152815152816152817152818152819152820152821152822152823152824152825152826152827152828152829152830152831152832152833152834152835152836152837152838152839152840152841152842152843152844152845152846152847152848152849152850152851152852152853152854152855152856152857152858152859152860152861152862152863152864152865152866152867152868152869152870152871152872152873152874152875152876152877152878152879152880152881152882152883152884152885152886152887152888152889152890152891152892152893152894152895152896152897152898152899152900152901152902152903152904152905152906152907152908152909152910152911152912152913152914152915152916152917152918152919152920152921152922152923152924152925152926152927152928152929152930152931152932152933152934152935152936152937152938152939152940152941152942152943152944152945152946152947152948152949152950152951152952152953152954152955152956152957152958152959152960152961152962152963152964152965152966152967152968152969152970152971152972152973152974152975152976152977152978152979152980152981152982152983152984152985152986152987152988152989152990152991152992152993152994152995152996152997152998152999153000153001153002153003153004153005153006153007153008153009153010153011153012153013153014153015153016153017153018153019153020153021153022153023153024153025153026153027153028153029153030153031153032153033153034153035153036153037153038153039153040153041153042153043153044153045153046153047153048153049153050153051153052153053153054153055153056153057153058153059153060153061153062153063153064153065153066153067153068153069153070153071153072153073153074153075153076153077153078153079153080153081153082153083153084153085153086153087153088153089153090153091153092153093153094153095153096153097153098153099153100153101153102153103153104153105153106153107153108153109153110153111153112153113153114153115153116153117153118153119153120153121153122153123153124153125153126153127153128153129153130153131153132153133153134153135153136153137153138153139153140153141153142153143153144153145153146153147153148153149153150153151153152153153153154153155153156153157153158153159153160153161153162153163153164153165153166153167153168153169153170153171153172153173153174153175153176153177153178153179153180153181153182153183153184153185153186153187153188153189153190153191153192153193153194153195153196153197153198153199153200153201153202153203153204153205153206153207153208153209153210153211153212153213153214153215153216153217153218153219153220153221153222153223153224153225153226153227153228153229153230153231153232153233153234153235153236153237153238153239153240153241153242153243153244153245153246153247153248153249153250153251153252153253153254153255153256153257153258153259153260153261153262153263153264153265153266153267153268153269153270153271153272153273153274153275153276153277153278153279153280153281153282153283153284153285153286153287153288153289153290153291153292153293153294153295153296153297153298153299153300153301153302153303153304153305153306153307153308153309153310153311153312153313153314153315153316153317153318153319153320153321153322153323153324153325153326153327153328153329153330153331153332153333153334153335153336153337153338153339153340153341153342153343153344153345153346153347153348153349153350153351153352153353153354153355153356153357153358153359153360153361153362153363153364153365153366153367153368153369153370153371153372153373153374153375153376153377153378153379153380153381153382153383153384153385153386153387153388153389153390153391153392153393153394153395153396153397153398153399153400153401153402153403153404153405153406153407153408153409153410153411153412153413153414153415153416153417153418153419153420153421153422153423153424153425153426153427153428153429153430153431153432153433153434153435153436153437153438153439153440153441153442153443153444153445153446153447153448153449153450153451153452153453153454153455153456153457153458153459153460153461153462153463153464153465153466153467153468153469153470153471153472153473153474153475153476153477153478153479153480153481153482153483153484153485153486153487153488153489153490153491153492153493153494153495153496153497153498153499153500153501153502153503153504153505153506153507153508153509153510153511153512153513153514153515153516153517153518153519153520153521153522153523153524153525153526153527153528153529153530153531153532153533153534153535153536153537153538153539153540153541153542153543153544153545153546153547153548153549153550153551153552153553153554153555153556153557153558153559153560153561153562153563153564153565153566153567153568153569153570153571153572153573153574153575153576153577153578153579153580153581153582153583153584153585153586153587153588153589153590153591153592153593153594153595153596153597153598153599153600153601153602153603153604153605153606153607153608153609153610153611153612153613153614153615153616153617153618153619153620153621153622153623153624153625153626153627153628153629153630153631153632153633153634153635153636153637153638153639153640153641153642153643153644153645153646153647153648153649153650153651153652153653153654153655153656153657153658153659153660153661153662153663153664153665153666153667153668153669153670153671153672153673153674153675153676153677153678153679153680153681153682153683153684153685153686153687153688153689153690153691153692153693153694153695153696153697153698153699153700153701153702153703153704153705153706153707153708153709153710153711153712153713153714153715153716153717153718153719153720153721153722153723153724153725153726153727153728153729153730153731153732153733153734153735153736153737153738153739153740153741153742153743153744153745153746153747153748153749153750153751153752153753153754153755153756153757153758153759153760153761153762153763153764153765153766153767153768153769153770153771153772153773153774153775153776153777153778153779153780153781153782153783153784153785153786153787153788153789153790153791153792153793153794153795153796153797153798153799153800153801153802153803153804153805153806153807153808153809153810153811153812153813153814153815153816153817153818153819153820153821153822153823153824153825153826153827153828153829153830153831153832153833153834153835153836153837153838153839153840153841153842153843153844153845153846153847153848153849153850153851153852153853153854153855153856153857153858153859153860153861153862153863153864153865153866153867153868153869153870153871153872153873153874153875153876153877153878153879153880153881153882153883153884153885153886153887153888153889153890153891153892153893153894153895153896153897153898153899153900153901153902153903153904153905153906153907153908153909153910153911153912153913153914153915153916153917153918153919153920153921153922153923153924153925153926153927153928153929153930153931153932153933153934153935153936153937153938153939153940153941153942153943153944153945153946153947153948153949153950153951153952153953153954153955153956153957153958153959153960153961153962153963153964153965153966153967153968153969153970153971153972153973153974153975153976153977153978153979153980153981153982153983153984153985153986153987153988153989153990153991153992153993153994153995153996153997153998153999154000154001154002154003154004154005154006154007154008154009154010154011154012154013154014154015154016154017154018154019154020154021154022154023154024154025154026154027154028154029154030154031154032154033154034154035154036154037154038154039154040154041154042154043154044154045154046154047154048154049154050154051154052154053154054154055154056154057154058154059154060154061154062154063154064154065154066154067154068154069154070154071154072154073154074154075154076154077154078154079154080154081154082154083154084154085154086154087154088154089154090154091154092154093154094154095154096154097154098154099154100154101154102154103154104154105154106154107154108154109154110154111154112154113154114154115154116154117154118154119154120154121154122154123154124154125154126154127154128154129154130154131154132154133154134154135154136154137154138154139154140154141154142154143154144154145154146154147154148154149154150154151154152154153154154154155154156154157154158154159154160154161154162154163154164154165154166154167154168154169154170154171154172154173154174154175154176154177154178154179154180154181154182154183154184154185154186154187154188154189154190154191154192154193154194154195154196154197154198154199154200154201154202154203154204154205154206154207154208154209154210154211154212154213154214154215154216154217154218154219154220154221154222154223154224154225154226154227154228154229154230154231154232154233154234154235154236154237154238154239154240154241154242154243154244154245154246154247154248154249154250154251154252154253154254154255154256154257154258154259154260154261154262154263154264154265154266154267154268154269154270154271154272154273154274154275154276154277154278154279154280154281154282154283154284154285154286154287154288154289154290154291154292154293154294154295154296154297154298154299154300154301154302154303154304154305154306154307154308154309154310154311154312154313154314154315154316154317154318154319154320154321154322154323154324154325154326154327154328154329154330154331154332154333154334154335154336154337154338154339154340154341154342154343154344154345154346154347154348154349154350154351154352154353154354154355154356154357154358154359154360154361154362154363154364154365154366154367154368154369154370154371154372154373154374154375154376154377154378154379154380154381154382154383154384154385154386154387154388154389154390154391154392154393154394154395154396154397154398154399154400154401154402154403154404154405154406154407154408154409154410154411154412154413154414154415154416154417154418154419154420154421154422154423154424154425154426154427154428154429154430154431154432154433154434154435154436154437154438154439154440154441154442154443154444154445154446154447154448154449154450154451154452154453154454154455154456154457154458154459154460154461154462154463154464154465154466154467154468154469154470154471154472154473154474154475154476154477154478154479154480154481154482154483154484154485154486154487154488154489154490154491154492154493154494154495154496154497154498154499154500154501154502154503154504154505154506154507154508154509154510154511154512154513154514154515154516154517154518154519154520154521154522154523154524154525154526154527154528154529154530154531154532154533154534154535154536154537154538154539154540154541154542154543154544154545154546154547154548154549154550154551154552154553154554154555154556154557154558154559154560154561154562154563154564154565154566154567154568154569154570154571154572154573154574154575154576154577154578154579154580154581154582154583154584154585154586154587154588154589154590154591154592154593154594154595154596154597154598154599154600154601154602154603154604154605154606154607154608154609154610154611154612154613154614154615154616154617154618154619154620154621154622154623154624154625154626154627154628154629154630154631154632154633154634154635154636154637154638154639154640154641154642154643154644154645154646154647154648154649154650154651154652154653154654154655154656154657154658154659154660154661154662154663154664154665154666154667154668154669154670154671154672154673154674154675154676154677154678154679154680154681154682154683154684154685154686154687154688154689154690154691154692154693154694154695154696154697154698154699154700154701154702154703154704154705154706154707154708154709154710154711154712154713154714154715154716154717154718154719154720154721154722154723154724154725154726154727154728154729154730154731154732154733154734154735154736154737154738154739154740154741154742154743154744154745154746154747154748154749154750154751154752154753154754154755154756154757154758154759154760154761154762154763154764154765154766154767154768154769154770154771154772154773154774154775154776154777154778154779154780154781154782154783154784154785154786154787154788154789154790154791154792154793154794154795154796154797154798154799154800154801154802154803154804154805154806154807154808154809154810154811154812154813154814154815154816154817154818154819154820154821154822154823154824154825154826154827154828154829154830154831154832154833154834154835154836154837154838154839154840154841154842154843154844154845154846154847154848154849154850154851154852154853154854154855154856154857154858154859154860154861154862154863154864154865154866154867154868154869154870154871154872154873154874154875154876154877154878154879154880154881154882154883154884154885154886154887154888154889154890154891154892154893154894154895154896154897154898154899154900154901154902154903154904154905154906154907154908154909154910154911154912154913154914154915154916154917154918154919154920154921154922154923154924154925154926154927154928154929154930154931154932154933154934154935154936154937154938154939154940154941154942154943154944154945154946154947154948154949154950154951154952154953154954154955154956154957154958154959154960154961154962154963154964154965154966154967154968154969154970154971154972154973154974154975154976154977154978154979154980154981154982154983154984154985154986154987154988154989154990154991154992154993154994154995154996154997154998154999155000155001155002155003155004155005155006155007155008155009155010155011155012155013155014155015155016155017155018155019155020155021155022155023155024155025155026155027155028155029155030155031155032155033155034155035155036155037155038155039155040155041155042155043155044155045155046155047155048155049155050155051155052155053155054155055155056155057155058155059155060155061155062155063155064155065155066155067155068155069155070155071155072155073155074155075155076155077155078155079155080155081155082155083155084155085155086155087155088155089155090155091155092155093155094155095155096155097155098155099155100155101155102155103155104155105155106155107155108155109155110155111155112155113155114155115155116155117155118155119155120155121155122155123155124155125155126155127155128155129155130155131155132155133155134155135155136155137155138155139155140155141155142155143155144155145155146155147155148155149155150155151155152155153155154155155155156155157155158155159155160155161155162155163155164155165155166155167155168155169155170155171155172155173155174155175155176155177155178155179155180155181155182155183155184155185155186155187155188155189155190155191155192155193155194155195155196155197155198155199155200155201155202155203155204155205155206155207155208155209155210155211155212155213155214155215155216155217155218155219155220155221155222155223155224155225155226155227155228155229155230155231155232155233155234155235155236155237155238155239155240155241155242155243155244155245155246155247155248155249155250155251155252155253155254155255155256155257155258155259155260155261155262155263155264155265155266155267155268155269155270155271155272155273155274155275155276155277155278155279155280155281155282155283155284155285155286155287155288155289155290155291155292155293155294155295155296155297155298155299155300155301155302155303155304155305155306155307155308155309155310155311155312155313155314155315155316155317155318155319155320155321155322155323155324155325155326155327155328155329155330155331155332155333155334155335155336155337155338155339155340155341155342155343155344155345155346155347155348155349155350155351155352155353155354155355155356155357155358155359155360155361155362155363155364155365155366155367155368155369155370155371155372155373155374155375155376155377155378155379155380155381155382155383155384155385155386155387155388155389155390155391155392155393155394155395155396155397155398155399155400155401155402155403155404155405155406155407155408155409155410155411155412155413155414155415155416155417155418155419155420155421155422155423155424155425155426155427155428155429155430155431155432155433155434155435155436155437155438155439155440155441155442155443155444155445155446155447155448155449155450155451155452155453155454155455155456155457155458155459155460155461155462155463155464155465155466155467155468155469155470155471155472155473155474155475155476155477155478155479155480155481155482155483155484155485155486155487155488155489155490155491155492155493155494155495155496155497155498155499155500155501155502155503155504155505155506155507155508155509155510155511155512155513155514155515155516155517155518155519155520155521155522155523155524155525155526155527155528155529155530155531155532155533155534155535155536155537155538155539155540155541155542155543155544155545155546155547155548155549155550155551155552155553155554155555155556155557155558155559155560155561155562155563155564155565155566155567155568155569155570155571155572155573155574155575155576155577155578155579155580155581155582155583155584155585155586155587155588155589155590155591155592155593155594155595155596155597155598155599155600155601155602155603155604155605155606155607155608155609155610155611155612155613155614155615155616155617155618155619155620155621155622155623155624155625155626155627155628155629155630155631155632155633155634155635155636155637155638155639155640155641155642155643155644155645155646155647155648155649155650155651155652155653155654155655155656155657155658155659155660155661155662155663155664155665155666155667155668155669155670155671155672155673155674155675155676155677155678155679155680155681155682155683155684155685155686155687155688155689155690155691155692155693155694155695155696155697155698155699155700155701155702155703155704155705155706155707155708155709155710155711155712155713155714155715155716155717155718155719155720155721155722155723155724155725155726155727155728155729155730155731155732155733155734155735155736155737155738155739155740155741155742155743155744155745155746155747155748155749155750155751155752155753155754155755155756155757155758155759155760155761155762155763155764155765155766155767155768155769155770155771155772155773155774155775155776155777155778155779155780155781155782155783155784155785155786155787155788155789155790155791155792155793155794155795155796155797155798155799155800155801155802155803155804155805155806155807155808155809155810155811155812155813155814155815155816155817155818155819155820155821155822155823155824155825155826155827155828155829155830155831155832155833155834155835155836155837155838155839155840155841155842155843155844155845155846155847155848155849155850155851155852155853155854155855155856155857155858155859155860155861155862155863155864155865155866155867155868155869155870155871155872155873155874155875155876155877155878155879155880155881155882155883155884155885155886155887155888155889155890155891155892155893155894155895155896155897155898155899155900155901155902155903155904155905155906155907155908155909155910155911155912155913155914155915155916155917155918155919155920155921155922155923155924155925155926155927155928155929155930155931155932155933155934155935155936155937155938155939155940155941155942155943155944155945155946155947155948155949155950155951155952155953155954155955155956155957155958155959155960155961155962155963155964155965155966155967155968155969155970155971155972155973155974155975155976155977155978155979155980155981155982155983155984155985155986155987155988155989155990155991155992155993155994155995155996155997155998155999156000156001156002156003156004156005156006156007156008156009156010156011156012156013156014156015156016156017156018156019156020156021156022156023156024156025156026156027156028156029156030156031156032156033156034156035156036156037156038156039156040156041156042156043156044156045156046156047156048156049156050156051156052156053156054156055156056156057156058156059156060156061156062156063156064156065156066156067156068156069156070156071156072156073156074156075156076156077156078156079156080156081156082156083156084156085156086156087156088156089156090156091156092156093156094156095156096156097156098156099156100156101156102156103156104156105156106156107156108156109156110156111156112156113156114156115156116156117156118156119156120156121156122156123156124156125156126156127156128156129156130156131156132156133156134156135156136156137156138156139156140156141156142156143156144156145156146156147156148156149156150156151156152156153156154156155156156156157156158156159156160156161156162156163156164156165156166156167156168156169156170156171156172156173156174156175156176156177156178156179156180156181156182156183156184156185156186156187156188156189156190156191156192156193156194156195156196156197156198156199156200156201156202156203156204156205156206156207156208156209156210156211156212156213156214156215156216156217156218156219156220156221156222156223156224156225156226156227156228156229156230156231156232156233156234156235156236156237156238156239156240156241156242156243156244156245156246156247156248156249156250156251156252156253156254156255156256156257156258156259156260156261156262156263156264156265156266156267156268156269156270156271156272156273156274156275156276156277156278156279156280156281156282156283156284156285156286156287156288156289156290156291156292156293156294156295156296156297156298156299156300156301156302156303156304156305156306156307156308156309156310156311156312156313156314156315156316156317156318156319156320156321156322156323156324156325156326156327156328156329156330156331156332156333156334156335156336156337156338156339156340156341156342156343156344156345156346156347156348156349156350156351156352156353156354156355156356156357156358156359156360156361156362156363156364156365156366156367156368156369156370156371156372156373156374156375156376156377156378156379156380156381156382156383156384156385156386156387156388156389156390156391156392156393156394156395156396156397156398156399156400156401156402156403156404156405156406156407156408156409156410156411156412156413156414156415156416156417156418156419156420156421156422156423156424156425156426156427156428156429156430156431156432156433156434156435156436156437156438156439156440156441156442156443156444156445156446156447156448156449156450156451156452156453156454156455156456156457156458156459156460156461156462156463156464156465156466156467156468156469156470156471156472156473156474156475156476156477156478156479156480156481156482156483156484156485156486156487156488156489156490156491156492156493156494156495156496156497156498156499156500156501156502156503156504156505156506156507156508156509156510156511156512156513156514156515156516156517156518156519156520156521156522156523156524156525156526156527156528156529156530156531156532156533156534156535156536156537156538156539156540156541156542156543156544156545156546156547156548156549156550156551156552156553156554156555156556156557156558156559156560156561156562156563156564156565156566156567156568156569156570156571156572156573156574156575156576156577156578156579156580156581156582156583156584156585156586156587156588156589156590156591156592156593156594156595156596156597156598156599156600156601156602156603156604156605156606156607156608156609156610156611156612156613156614156615156616156617156618156619156620156621156622156623156624156625156626156627156628156629156630156631156632156633156634156635156636156637156638156639156640156641156642156643156644156645156646156647156648156649156650156651156652156653156654156655156656156657156658156659156660156661156662156663156664156665156666156667156668156669156670156671156672156673156674156675156676156677156678156679156680156681156682156683156684156685156686156687156688156689156690156691156692156693156694156695156696156697156698156699156700156701156702156703156704156705156706156707156708156709156710156711156712156713156714156715156716156717156718156719156720156721156722156723156724156725156726156727156728156729156730156731156732156733156734156735156736156737156738156739156740156741156742156743156744156745156746156747156748156749156750156751156752156753156754156755156756156757156758156759156760156761156762156763156764156765156766156767156768156769156770156771156772156773156774156775156776156777156778156779156780156781156782156783156784156785156786156787156788156789156790156791156792156793156794156795156796156797156798156799156800156801156802156803156804156805156806156807156808156809156810156811156812156813156814156815156816156817156818156819156820156821156822156823156824156825156826156827156828156829156830156831156832156833156834156835156836156837156838156839156840156841156842156843156844156845156846156847156848156849156850156851156852156853156854156855156856156857156858156859156860156861156862156863156864156865156866156867156868156869156870156871156872156873156874156875156876156877156878156879156880156881156882156883156884156885156886156887156888156889156890156891156892156893156894156895156896156897156898156899156900156901156902156903156904156905156906156907156908156909156910156911156912156913156914156915156916156917156918156919156920156921156922156923156924156925156926156927156928156929156930156931156932156933156934156935156936156937156938156939156940156941156942156943156944156945156946156947156948156949156950156951156952156953156954156955156956156957156958156959156960156961156962156963156964156965156966156967156968156969156970156971156972156973156974156975156976156977156978156979156980156981156982156983156984156985156986156987156988156989156990156991156992156993156994156995156996156997156998156999157000157001157002157003157004157005157006157007157008157009
  1. declare module "babylonjs/types" {
  2. /** Alias type for value that can be null */
  3. export type Nullable<T> = T | null;
  4. /**
  5. * Alias type for number that are floats
  6. * @ignorenaming
  7. */
  8. export type float = number;
  9. /**
  10. * Alias type for number that are doubles.
  11. * @ignorenaming
  12. */
  13. export type double = number;
  14. /**
  15. * Alias type for number that are integer
  16. * @ignorenaming
  17. */
  18. export type int = number;
  19. /** Alias type for number array or Float32Array */
  20. export type FloatArray = number[] | Float32Array;
  21. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  22. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  23. /**
  24. * Alias for types that can be used by a Buffer or VertexBuffer.
  25. */
  26. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  27. /**
  28. * Alias type for primitive types
  29. * @ignorenaming
  30. */
  31. type Primitive = undefined | null | boolean | string | number | Function;
  32. /**
  33. * Type modifier to make all the properties of an object Readonly
  34. */
  35. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  36. /**
  37. * Type modifier to make all the properties of an object Readonly recursively
  38. */
  39. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  40. /**
  41. * Type modifier to make object properties readonly.
  42. */
  43. export type DeepImmutableObject<T> = {
  44. readonly [K in keyof T]: DeepImmutable<T[K]>;
  45. };
  46. /** @hidden */
  47. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  48. }
  49. }
  50. declare module "babylonjs/Misc/observable" {
  51. import { Nullable } from "babylonjs/types";
  52. /**
  53. * A class serves as a medium between the observable and its observers
  54. */
  55. export class EventState {
  56. /**
  57. * Create a new EventState
  58. * @param mask defines the mask associated with this state
  59. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  60. * @param target defines the original target of the state
  61. * @param currentTarget defines the current target of the state
  62. */
  63. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  64. /**
  65. * Initialize the current event state
  66. * @param mask defines the mask associated with this state
  67. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  68. * @param target defines the original target of the state
  69. * @param currentTarget defines the current target of the state
  70. * @returns the current event state
  71. */
  72. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  73. /**
  74. * An Observer can set this property to true to prevent subsequent observers of being notified
  75. */
  76. skipNextObservers: boolean;
  77. /**
  78. * Get the mask value that were used to trigger the event corresponding to this EventState object
  79. */
  80. mask: number;
  81. /**
  82. * The object that originally notified the event
  83. */
  84. target?: any;
  85. /**
  86. * The current object in the bubbling phase
  87. */
  88. currentTarget?: any;
  89. /**
  90. * This will be populated with the return value of the last function that was executed.
  91. * If it is the first function in the callback chain it will be the event data.
  92. */
  93. lastReturnValue?: any;
  94. }
  95. /**
  96. * Represent an Observer registered to a given Observable object.
  97. */
  98. export class Observer<T> {
  99. /**
  100. * Defines the callback to call when the observer is notified
  101. */
  102. callback: (eventData: T, eventState: EventState) => void;
  103. /**
  104. * Defines the mask of the observer (used to filter notifications)
  105. */
  106. mask: number;
  107. /**
  108. * Defines the current scope used to restore the JS context
  109. */
  110. scope: any;
  111. /** @hidden */
  112. _willBeUnregistered: boolean;
  113. /**
  114. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  115. */
  116. unregisterOnNextCall: boolean;
  117. /**
  118. * Creates a new observer
  119. * @param callback defines the callback to call when the observer is notified
  120. * @param mask defines the mask of the observer (used to filter notifications)
  121. * @param scope defines the current scope used to restore the JS context
  122. */
  123. constructor(
  124. /**
  125. * Defines the callback to call when the observer is notified
  126. */
  127. callback: (eventData: T, eventState: EventState) => void,
  128. /**
  129. * Defines the mask of the observer (used to filter notifications)
  130. */
  131. mask: number,
  132. /**
  133. * Defines the current scope used to restore the JS context
  134. */
  135. scope?: any);
  136. }
  137. /**
  138. * Represent a list of observers registered to multiple Observables object.
  139. */
  140. export class MultiObserver<T> {
  141. private _observers;
  142. private _observables;
  143. /**
  144. * Release associated resources
  145. */
  146. dispose(): void;
  147. /**
  148. * Raise a callback when one of the observable will notify
  149. * @param observables defines a list of observables to watch
  150. * @param callback defines the callback to call on notification
  151. * @param mask defines the mask used to filter notifications
  152. * @param scope defines the current scope used to restore the JS context
  153. * @returns the new MultiObserver
  154. */
  155. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  156. }
  157. /**
  158. * The Observable class is a simple implementation of the Observable pattern.
  159. *
  160. * There's one slight particularity though: a given Observable can notify its observer using a particular mask value, only the Observers registered with this mask value will be notified.
  161. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  162. * For instance you may have a given Observable that have four different types of notifications: Move (mask = 0x01), Stop (mask = 0x02), Turn Right (mask = 0X04), Turn Left (mask = 0X08).
  163. * A given observer can register itself with only Move and Stop (mask = 0x03), then it will only be notified when one of these two occurs and will never be for Turn Left/Right.
  164. */
  165. export class Observable<T> {
  166. private _observers;
  167. private _eventState;
  168. private _onObserverAdded;
  169. /**
  170. * Gets the list of observers
  171. */
  172. get observers(): Array<Observer<T>>;
  173. /**
  174. * Creates a new observable
  175. * @param onObserverAdded defines a callback to call when a new observer is added
  176. */
  177. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  178. /**
  179. * Create a new Observer with the specified callback
  180. * @param callback the callback that will be executed for that Observer
  181. * @param mask the mask used to filter observers
  182. * @param insertFirst if true the callback will be inserted at the first position, hence executed before the others ones. If false (default behavior) the callback will be inserted at the last position, executed after all the others already present.
  183. * @param scope optional scope for the callback to be called from
  184. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  185. * @returns the new observer created for the callback
  186. */
  187. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  188. /**
  189. * Create a new Observer with the specified callback and unregisters after the next notification
  190. * @param callback the callback that will be executed for that Observer
  191. * @returns the new observer created for the callback
  192. */
  193. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  194. /**
  195. * Remove an Observer from the Observable object
  196. * @param observer the instance of the Observer to remove
  197. * @returns false if it doesn't belong to this Observable
  198. */
  199. remove(observer: Nullable<Observer<T>>): boolean;
  200. /**
  201. * Remove a callback from the Observable object
  202. * @param callback the callback to remove
  203. * @param scope optional scope. If used only the callbacks with this scope will be removed
  204. * @returns false if it doesn't belong to this Observable
  205. */
  206. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  207. private _deferUnregister;
  208. private _remove;
  209. /**
  210. * Moves the observable to the top of the observer list making it get called first when notified
  211. * @param observer the observer to move
  212. */
  213. makeObserverTopPriority(observer: Observer<T>): void;
  214. /**
  215. * Moves the observable to the bottom of the observer list making it get called last when notified
  216. * @param observer the observer to move
  217. */
  218. makeObserverBottomPriority(observer: Observer<T>): void;
  219. /**
  220. * Notify all Observers by calling their respective callback with the given data
  221. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  222. * @param eventData defines the data to send to all observers
  223. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  224. * @param target defines the original target of the state
  225. * @param currentTarget defines the current target of the state
  226. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  227. */
  228. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  229. /**
  230. * Calling this will execute each callback, expecting it to be a promise or return a value.
  231. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  232. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  233. * and it is crucial that all callbacks will be executed.
  234. * The order of the callbacks is kept, callbacks are not executed parallel.
  235. *
  236. * @param eventData The data to be sent to each callback
  237. * @param mask is used to filter observers defaults to -1
  238. * @param target defines the callback target (see EventState)
  239. * @param currentTarget defines he current object in the bubbling phase
  240. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  241. */
  242. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  243. /**
  244. * Notify a specific observer
  245. * @param observer defines the observer to notify
  246. * @param eventData defines the data to be sent to each callback
  247. * @param mask is used to filter observers defaults to -1
  248. */
  249. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  250. /**
  251. * Gets a boolean indicating if the observable has at least one observer
  252. * @returns true is the Observable has at least one Observer registered
  253. */
  254. hasObservers(): boolean;
  255. /**
  256. * Clear the list of observers
  257. */
  258. clear(): void;
  259. /**
  260. * Clone the current observable
  261. * @returns a new observable
  262. */
  263. clone(): Observable<T>;
  264. /**
  265. * Does this observable handles observer registered with a given mask
  266. * @param mask defines the mask to be tested
  267. * @return whether or not one observer registered with the given mask is handeled
  268. **/
  269. hasSpecificMask(mask?: number): boolean;
  270. }
  271. }
  272. declare module "babylonjs/Misc/domManagement" {
  273. /**
  274. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  275. * Babylon.js
  276. */
  277. export class DomManagement {
  278. /**
  279. * Checks if the window object exists
  280. * @returns true if the window object exists
  281. */
  282. static IsWindowObjectExist(): boolean;
  283. /**
  284. * Checks if the navigator object exists
  285. * @returns true if the navigator object exists
  286. */
  287. static IsNavigatorAvailable(): boolean;
  288. /**
  289. * Check if the document object exists
  290. * @returns true if the document object exists
  291. */
  292. static IsDocumentAvailable(): boolean;
  293. /**
  294. * Extracts text content from a DOM element hierarchy
  295. * @param element defines the root element
  296. * @returns a string
  297. */
  298. static GetDOMTextContent(element: HTMLElement): string;
  299. }
  300. }
  301. declare module "babylonjs/Misc/logger" {
  302. /**
  303. * Logger used througouht the application to allow configuration of
  304. * the log level required for the messages.
  305. */
  306. export class Logger {
  307. /**
  308. * No log
  309. */
  310. static readonly NoneLogLevel: number;
  311. /**
  312. * Only message logs
  313. */
  314. static readonly MessageLogLevel: number;
  315. /**
  316. * Only warning logs
  317. */
  318. static readonly WarningLogLevel: number;
  319. /**
  320. * Only error logs
  321. */
  322. static readonly ErrorLogLevel: number;
  323. /**
  324. * All logs
  325. */
  326. static readonly AllLogLevel: number;
  327. private static _LogCache;
  328. /**
  329. * Gets a value indicating the number of loading errors
  330. * @ignorenaming
  331. */
  332. static errorsCount: number;
  333. /**
  334. * Callback called when a new log is added
  335. */
  336. static OnNewCacheEntry: (entry: string) => void;
  337. private static _AddLogEntry;
  338. private static _FormatMessage;
  339. private static _LogDisabled;
  340. private static _LogEnabled;
  341. private static _WarnDisabled;
  342. private static _WarnEnabled;
  343. private static _ErrorDisabled;
  344. private static _ErrorEnabled;
  345. /**
  346. * Log a message to the console
  347. */
  348. static Log: (message: string) => void;
  349. /**
  350. * Write a warning message to the console
  351. */
  352. static Warn: (message: string) => void;
  353. /**
  354. * Write an error message to the console
  355. */
  356. static Error: (message: string) => void;
  357. /**
  358. * Gets current log cache (list of logs)
  359. */
  360. static get LogCache(): string;
  361. /**
  362. * Clears the log cache
  363. */
  364. static ClearLogCache(): void;
  365. /**
  366. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  367. */
  368. static set LogLevels(level: number);
  369. }
  370. }
  371. declare module "babylonjs/Misc/typeStore" {
  372. /** @hidden */
  373. export class _TypeStore {
  374. /** @hidden */
  375. static RegisteredTypes: {
  376. [key: string]: Object;
  377. };
  378. /** @hidden */
  379. static GetClass(fqdn: string): any;
  380. }
  381. }
  382. declare module "babylonjs/Misc/stringTools" {
  383. /**
  384. * Helper to manipulate strings
  385. */
  386. export class StringTools {
  387. /**
  388. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  389. * @param str Source string
  390. * @param suffix Suffix to search for in the source string
  391. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  392. */
  393. static EndsWith(str: string, suffix: string): boolean;
  394. /**
  395. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  396. * @param str Source string
  397. * @param suffix Suffix to search for in the source string
  398. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  399. */
  400. static StartsWith(str: string, suffix: string): boolean;
  401. /**
  402. * Decodes a buffer into a string
  403. * @param buffer The buffer to decode
  404. * @returns The decoded string
  405. */
  406. static Decode(buffer: Uint8Array | Uint16Array): string;
  407. /**
  408. * Encode a buffer to a base64 string
  409. * @param buffer defines the buffer to encode
  410. * @returns the encoded string
  411. */
  412. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  413. /**
  414. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  415. * @param num the number to convert and pad
  416. * @param length the expected length of the string
  417. * @returns the padded string
  418. */
  419. static PadNumber(num: number, length: number): string;
  420. }
  421. }
  422. declare module "babylonjs/Misc/deepCopier" {
  423. /**
  424. * Class containing a set of static utilities functions for deep copy.
  425. */
  426. export class DeepCopier {
  427. /**
  428. * Tries to copy an object by duplicating every property
  429. * @param source defines the source object
  430. * @param destination defines the target object
  431. * @param doNotCopyList defines a list of properties to avoid
  432. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  433. */
  434. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  435. }
  436. }
  437. declare module "babylonjs/Misc/precisionDate" {
  438. /**
  439. * Class containing a set of static utilities functions for precision date
  440. */
  441. export class PrecisionDate {
  442. /**
  443. * Gets either window.performance.now() if supported or Date.now() else
  444. */
  445. static get Now(): number;
  446. }
  447. }
  448. declare module "babylonjs/Misc/devTools" {
  449. /** @hidden */
  450. export class _DevTools {
  451. static WarnImport(name: string): string;
  452. }
  453. }
  454. declare module "babylonjs/Misc/interfaces/iWebRequest" {
  455. /**
  456. * Interface used to define the mechanism to get data from the network
  457. */
  458. export interface IWebRequest {
  459. /**
  460. * Returns client's response url
  461. */
  462. responseURL: string;
  463. /**
  464. * Returns client's status
  465. */
  466. status: number;
  467. /**
  468. * Returns client's status as a text
  469. */
  470. statusText: string;
  471. }
  472. }
  473. declare module "babylonjs/Misc/webRequest" {
  474. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  475. import { Nullable } from "babylonjs/types";
  476. /**
  477. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  478. */
  479. export class WebRequest implements IWebRequest {
  480. private _xhr;
  481. /**
  482. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  483. * i.e. when loading files, where the server/service expects an Authorization header
  484. */
  485. static CustomRequestHeaders: {
  486. [key: string]: string;
  487. };
  488. /**
  489. * Add callback functions in this array to update all the requests before they get sent to the network
  490. */
  491. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  492. private _injectCustomRequestHeaders;
  493. /**
  494. * Gets or sets a function to be called when loading progress changes
  495. */
  496. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  497. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  498. /**
  499. * Returns client's state
  500. */
  501. get readyState(): number;
  502. /**
  503. * Returns client's status
  504. */
  505. get status(): number;
  506. /**
  507. * Returns client's status as a text
  508. */
  509. get statusText(): string;
  510. /**
  511. * Returns client's response
  512. */
  513. get response(): any;
  514. /**
  515. * Returns client's response url
  516. */
  517. get responseURL(): string;
  518. /**
  519. * Returns client's response as text
  520. */
  521. get responseText(): string;
  522. /**
  523. * Gets or sets the expected response type
  524. */
  525. get responseType(): XMLHttpRequestResponseType;
  526. set responseType(value: XMLHttpRequestResponseType);
  527. /** @hidden */
  528. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  529. /** @hidden */
  530. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  531. /**
  532. * Cancels any network activity
  533. */
  534. abort(): void;
  535. /**
  536. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  537. * @param body defines an optional request body
  538. */
  539. send(body?: Document | BodyInit | null): void;
  540. /**
  541. * Sets the request method, request URL
  542. * @param method defines the method to use (GET, POST, etc..)
  543. * @param url defines the url to connect with
  544. */
  545. open(method: string, url: string): void;
  546. /**
  547. * Sets the value of a request header.
  548. * @param name The name of the header whose value is to be set
  549. * @param value The value to set as the body of the header
  550. */
  551. setRequestHeader(name: string, value: string): void;
  552. /**
  553. * Get the string containing the text of a particular header's value.
  554. * @param name The name of the header
  555. * @returns The string containing the text of the given header name
  556. */
  557. getResponseHeader(name: string): Nullable<string>;
  558. }
  559. }
  560. declare module "babylonjs/Misc/fileRequest" {
  561. import { Observable } from "babylonjs/Misc/observable";
  562. /**
  563. * File request interface
  564. */
  565. export interface IFileRequest {
  566. /**
  567. * Raised when the request is complete (success or error).
  568. */
  569. onCompleteObservable: Observable<IFileRequest>;
  570. /**
  571. * Aborts the request for a file.
  572. */
  573. abort: () => void;
  574. }
  575. }
  576. declare module "babylonjs/Materials/Textures/renderTargetCreationOptions" {
  577. /**
  578. * Define options used to create a render target texture
  579. */
  580. export class RenderTargetCreationOptions {
  581. /**
  582. * Specifies is mipmaps must be generated
  583. */
  584. generateMipMaps?: boolean;
  585. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  586. generateDepthBuffer?: boolean;
  587. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  588. generateStencilBuffer?: boolean;
  589. /** Defines texture type (int by default) */
  590. type?: number;
  591. /** Defines sampling mode (trilinear by default) */
  592. samplingMode?: number;
  593. /** Defines format (RGBA by default) */
  594. format?: number;
  595. }
  596. }
  597. declare module "babylonjs/Engines/constants" {
  598. /** Defines the cross module used constants to avoid circular dependncies */
  599. export class Constants {
  600. /** Defines that alpha blending is disabled */
  601. static readonly ALPHA_DISABLE: number;
  602. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  603. static readonly ALPHA_ADD: number;
  604. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  605. static readonly ALPHA_COMBINE: number;
  606. /** Defines that alpha blending is DEST - SRC * DEST */
  607. static readonly ALPHA_SUBTRACT: number;
  608. /** Defines that alpha blending is SRC * DEST */
  609. static readonly ALPHA_MULTIPLY: number;
  610. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  611. static readonly ALPHA_MAXIMIZED: number;
  612. /** Defines that alpha blending is SRC + DEST */
  613. static readonly ALPHA_ONEONE: number;
  614. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  615. static readonly ALPHA_PREMULTIPLIED: number;
  616. /**
  617. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  618. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  619. */
  620. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  621. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  622. static readonly ALPHA_INTERPOLATE: number;
  623. /**
  624. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  625. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  626. */
  627. static readonly ALPHA_SCREENMODE: number;
  628. /**
  629. * Defines that alpha blending is SRC + DST
  630. * Alpha will be set to SRC ALPHA + DST ALPHA
  631. */
  632. static readonly ALPHA_ONEONE_ONEONE: number;
  633. /**
  634. * Defines that alpha blending is SRC * DST ALPHA + DST
  635. * Alpha will be set to 0
  636. */
  637. static readonly ALPHA_ALPHATOCOLOR: number;
  638. /**
  639. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  640. */
  641. static readonly ALPHA_REVERSEONEMINUS: number;
  642. /**
  643. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  644. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  645. */
  646. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  647. /**
  648. * Defines that alpha blending is SRC + DST
  649. * Alpha will be set to SRC ALPHA
  650. */
  651. static readonly ALPHA_ONEONE_ONEZERO: number;
  652. /**
  653. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  654. * Alpha will be set to DST ALPHA
  655. */
  656. static readonly ALPHA_EXCLUSION: number;
  657. /** Defines that alpha blending equation a SUM */
  658. static readonly ALPHA_EQUATION_ADD: number;
  659. /** Defines that alpha blending equation a SUBSTRACTION */
  660. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  661. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  662. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  663. /** Defines that alpha blending equation a MAX operation */
  664. static readonly ALPHA_EQUATION_MAX: number;
  665. /** Defines that alpha blending equation a MIN operation */
  666. static readonly ALPHA_EQUATION_MIN: number;
  667. /**
  668. * Defines that alpha blending equation a DARKEN operation:
  669. * It takes the min of the src and sums the alpha channels.
  670. */
  671. static readonly ALPHA_EQUATION_DARKEN: number;
  672. /** Defines that the ressource is not delayed*/
  673. static readonly DELAYLOADSTATE_NONE: number;
  674. /** Defines that the ressource was successfully delay loaded */
  675. static readonly DELAYLOADSTATE_LOADED: number;
  676. /** Defines that the ressource is currently delay loading */
  677. static readonly DELAYLOADSTATE_LOADING: number;
  678. /** Defines that the ressource is delayed and has not started loading */
  679. static readonly DELAYLOADSTATE_NOTLOADED: number;
  680. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  681. static readonly NEVER: number;
  682. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  683. static readonly ALWAYS: number;
  684. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  685. static readonly LESS: number;
  686. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  687. static readonly EQUAL: number;
  688. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than or equal to the stored value */
  689. static readonly LEQUAL: number;
  690. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  691. static readonly GREATER: number;
  692. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than or equal to the stored value */
  693. static readonly GEQUAL: number;
  694. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is not equal to the stored value */
  695. static readonly NOTEQUAL: number;
  696. /** Passed to stencilOperation to specify that stencil value must be kept */
  697. static readonly KEEP: number;
  698. /** Passed to stencilOperation to specify that stencil value must be replaced */
  699. static readonly REPLACE: number;
  700. /** Passed to stencilOperation to specify that stencil value must be incremented */
  701. static readonly INCR: number;
  702. /** Passed to stencilOperation to specify that stencil value must be decremented */
  703. static readonly DECR: number;
  704. /** Passed to stencilOperation to specify that stencil value must be inverted */
  705. static readonly INVERT: number;
  706. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  707. static readonly INCR_WRAP: number;
  708. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  709. static readonly DECR_WRAP: number;
  710. /** Texture is not repeating outside of 0..1 UVs */
  711. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  712. /** Texture is repeating outside of 0..1 UVs */
  713. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  714. /** Texture is repeating and mirrored */
  715. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  716. /** ALPHA */
  717. static readonly TEXTUREFORMAT_ALPHA: number;
  718. /** LUMINANCE */
  719. static readonly TEXTUREFORMAT_LUMINANCE: number;
  720. /** LUMINANCE_ALPHA */
  721. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  722. /** RGB */
  723. static readonly TEXTUREFORMAT_RGB: number;
  724. /** RGBA */
  725. static readonly TEXTUREFORMAT_RGBA: number;
  726. /** RED */
  727. static readonly TEXTUREFORMAT_RED: number;
  728. /** RED (2nd reference) */
  729. static readonly TEXTUREFORMAT_R: number;
  730. /** RG */
  731. static readonly TEXTUREFORMAT_RG: number;
  732. /** RED_INTEGER */
  733. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  734. /** RED_INTEGER (2nd reference) */
  735. static readonly TEXTUREFORMAT_R_INTEGER: number;
  736. /** RG_INTEGER */
  737. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  738. /** RGB_INTEGER */
  739. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  740. /** RGBA_INTEGER */
  741. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  742. /** UNSIGNED_BYTE */
  743. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  744. /** UNSIGNED_BYTE (2nd reference) */
  745. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  746. /** FLOAT */
  747. static readonly TEXTURETYPE_FLOAT: number;
  748. /** HALF_FLOAT */
  749. static readonly TEXTURETYPE_HALF_FLOAT: number;
  750. /** BYTE */
  751. static readonly TEXTURETYPE_BYTE: number;
  752. /** SHORT */
  753. static readonly TEXTURETYPE_SHORT: number;
  754. /** UNSIGNED_SHORT */
  755. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  756. /** INT */
  757. static readonly TEXTURETYPE_INT: number;
  758. /** UNSIGNED_INT */
  759. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  760. /** UNSIGNED_SHORT_4_4_4_4 */
  761. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  762. /** UNSIGNED_SHORT_5_5_5_1 */
  763. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  764. /** UNSIGNED_SHORT_5_6_5 */
  765. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  766. /** UNSIGNED_INT_2_10_10_10_REV */
  767. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  768. /** UNSIGNED_INT_24_8 */
  769. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  770. /** UNSIGNED_INT_10F_11F_11F_REV */
  771. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  772. /** UNSIGNED_INT_5_9_9_9_REV */
  773. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  774. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  775. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  776. /** nearest is mag = nearest and min = nearest and no mip */
  777. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  778. /** mag = nearest and min = nearest and mip = none */
  779. static readonly TEXTURE_NEAREST_NEAREST: number;
  780. /** Bilinear is mag = linear and min = linear and no mip */
  781. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  782. /** mag = linear and min = linear and mip = none */
  783. static readonly TEXTURE_LINEAR_LINEAR: number;
  784. /** Trilinear is mag = linear and min = linear and mip = linear */
  785. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  786. /** Trilinear is mag = linear and min = linear and mip = linear */
  787. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  788. /** mag = nearest and min = nearest and mip = nearest */
  789. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  790. /** mag = nearest and min = linear and mip = nearest */
  791. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  792. /** mag = nearest and min = linear and mip = linear */
  793. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  794. /** mag = nearest and min = linear and mip = none */
  795. static readonly TEXTURE_NEAREST_LINEAR: number;
  796. /** nearest is mag = nearest and min = nearest and mip = linear */
  797. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  798. /** mag = linear and min = nearest and mip = nearest */
  799. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  800. /** mag = linear and min = nearest and mip = linear */
  801. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  802. /** Bilinear is mag = linear and min = linear and mip = nearest */
  803. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  804. /** mag = linear and min = nearest and mip = none */
  805. static readonly TEXTURE_LINEAR_NEAREST: number;
  806. /** Explicit coordinates mode */
  807. static readonly TEXTURE_EXPLICIT_MODE: number;
  808. /** Spherical coordinates mode */
  809. static readonly TEXTURE_SPHERICAL_MODE: number;
  810. /** Planar coordinates mode */
  811. static readonly TEXTURE_PLANAR_MODE: number;
  812. /** Cubic coordinates mode */
  813. static readonly TEXTURE_CUBIC_MODE: number;
  814. /** Projection coordinates mode */
  815. static readonly TEXTURE_PROJECTION_MODE: number;
  816. /** Skybox coordinates mode */
  817. static readonly TEXTURE_SKYBOX_MODE: number;
  818. /** Inverse Cubic coordinates mode */
  819. static readonly TEXTURE_INVCUBIC_MODE: number;
  820. /** Equirectangular coordinates mode */
  821. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  822. /** Equirectangular Fixed coordinates mode */
  823. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  824. /** Equirectangular Fixed Mirrored coordinates mode */
  825. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  826. /** Offline (baking) quality for texture filtering */
  827. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  828. /** High quality for texture filtering */
  829. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  830. /** Medium quality for texture filtering */
  831. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  832. /** Low quality for texture filtering */
  833. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  834. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  835. static readonly SCALEMODE_FLOOR: number;
  836. /** Defines that texture rescaling will look for the nearest power of 2 size */
  837. static readonly SCALEMODE_NEAREST: number;
  838. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  839. static readonly SCALEMODE_CEILING: number;
  840. /**
  841. * The dirty texture flag value
  842. */
  843. static readonly MATERIAL_TextureDirtyFlag: number;
  844. /**
  845. * The dirty light flag value
  846. */
  847. static readonly MATERIAL_LightDirtyFlag: number;
  848. /**
  849. * The dirty fresnel flag value
  850. */
  851. static readonly MATERIAL_FresnelDirtyFlag: number;
  852. /**
  853. * The dirty attribute flag value
  854. */
  855. static readonly MATERIAL_AttributesDirtyFlag: number;
  856. /**
  857. * The dirty misc flag value
  858. */
  859. static readonly MATERIAL_MiscDirtyFlag: number;
  860. /**
  861. * The all dirty flag value
  862. */
  863. static readonly MATERIAL_AllDirtyFlag: number;
  864. /**
  865. * Returns the triangle fill mode
  866. */
  867. static readonly MATERIAL_TriangleFillMode: number;
  868. /**
  869. * Returns the wireframe mode
  870. */
  871. static readonly MATERIAL_WireFrameFillMode: number;
  872. /**
  873. * Returns the point fill mode
  874. */
  875. static readonly MATERIAL_PointFillMode: number;
  876. /**
  877. * Returns the point list draw mode
  878. */
  879. static readonly MATERIAL_PointListDrawMode: number;
  880. /**
  881. * Returns the line list draw mode
  882. */
  883. static readonly MATERIAL_LineListDrawMode: number;
  884. /**
  885. * Returns the line loop draw mode
  886. */
  887. static readonly MATERIAL_LineLoopDrawMode: number;
  888. /**
  889. * Returns the line strip draw mode
  890. */
  891. static readonly MATERIAL_LineStripDrawMode: number;
  892. /**
  893. * Returns the triangle strip draw mode
  894. */
  895. static readonly MATERIAL_TriangleStripDrawMode: number;
  896. /**
  897. * Returns the triangle fan draw mode
  898. */
  899. static readonly MATERIAL_TriangleFanDrawMode: number;
  900. /**
  901. * Stores the clock-wise side orientation
  902. */
  903. static readonly MATERIAL_ClockWiseSideOrientation: number;
  904. /**
  905. * Stores the counter clock-wise side orientation
  906. */
  907. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  908. /**
  909. * Nothing
  910. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  911. */
  912. static readonly ACTION_NothingTrigger: number;
  913. /**
  914. * On pick
  915. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  916. */
  917. static readonly ACTION_OnPickTrigger: number;
  918. /**
  919. * On left pick
  920. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  921. */
  922. static readonly ACTION_OnLeftPickTrigger: number;
  923. /**
  924. * On right pick
  925. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  926. */
  927. static readonly ACTION_OnRightPickTrigger: number;
  928. /**
  929. * On center pick
  930. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  931. */
  932. static readonly ACTION_OnCenterPickTrigger: number;
  933. /**
  934. * On pick down
  935. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  936. */
  937. static readonly ACTION_OnPickDownTrigger: number;
  938. /**
  939. * On double pick
  940. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  941. */
  942. static readonly ACTION_OnDoublePickTrigger: number;
  943. /**
  944. * On pick up
  945. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  946. */
  947. static readonly ACTION_OnPickUpTrigger: number;
  948. /**
  949. * On pick out.
  950. * This trigger will only be raised if you also declared a OnPickDown
  951. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  952. */
  953. static readonly ACTION_OnPickOutTrigger: number;
  954. /**
  955. * On long press
  956. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  957. */
  958. static readonly ACTION_OnLongPressTrigger: number;
  959. /**
  960. * On pointer over
  961. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  962. */
  963. static readonly ACTION_OnPointerOverTrigger: number;
  964. /**
  965. * On pointer out
  966. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  967. */
  968. static readonly ACTION_OnPointerOutTrigger: number;
  969. /**
  970. * On every frame
  971. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  972. */
  973. static readonly ACTION_OnEveryFrameTrigger: number;
  974. /**
  975. * On intersection enter
  976. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  977. */
  978. static readonly ACTION_OnIntersectionEnterTrigger: number;
  979. /**
  980. * On intersection exit
  981. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  982. */
  983. static readonly ACTION_OnIntersectionExitTrigger: number;
  984. /**
  985. * On key down
  986. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  987. */
  988. static readonly ACTION_OnKeyDownTrigger: number;
  989. /**
  990. * On key up
  991. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  992. */
  993. static readonly ACTION_OnKeyUpTrigger: number;
  994. /**
  995. * Billboard mode will only apply to Y axis
  996. */
  997. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  998. /**
  999. * Billboard mode will apply to all axes
  1000. */
  1001. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  1002. /**
  1003. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  1004. */
  1005. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  1006. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  1007. * Test order :
  1008. * Is the bounding sphere outside the frustum ?
  1009. * If not, are the bounding box vertices outside the frustum ?
  1010. * It not, then the cullable object is in the frustum.
  1011. */
  1012. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  1013. /** Culling strategy : Bounding Sphere Only.
  1014. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  1015. * It's also less accurate than the standard because some not visible objects can still be selected.
  1016. * Test : is the bounding sphere outside the frustum ?
  1017. * If not, then the cullable object is in the frustum.
  1018. */
  1019. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  1020. /** Culling strategy : Optimistic Inclusion.
  1021. * This in an inclusion test first, then the standard exclusion test.
  1022. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  1023. * This could also be a little slower than the standard test when the tested object center is not the frustum but one of its bounding box vertex is still inside.
  1024. * Anyway, it's as accurate as the standard strategy.
  1025. * Test :
  1026. * Is the cullable object bounding sphere center in the frustum ?
  1027. * If not, apply the default culling strategy.
  1028. */
  1029. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  1030. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  1031. * This in an inclusion test first, then the bounding sphere only exclusion test.
  1032. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  1033. * This could also be a little slower than the BoundingSphereOnly strategy when the tested object center is not in the frustum but its bounding sphere still intersects it.
  1034. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  1035. * Test :
  1036. * Is the cullable object bounding sphere center in the frustum ?
  1037. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  1038. */
  1039. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  1040. /**
  1041. * No logging while loading
  1042. */
  1043. static readonly SCENELOADER_NO_LOGGING: number;
  1044. /**
  1045. * Minimal logging while loading
  1046. */
  1047. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  1048. /**
  1049. * Summary logging while loading
  1050. */
  1051. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  1052. /**
  1053. * Detailled logging while loading
  1054. */
  1055. static readonly SCENELOADER_DETAILED_LOGGING: number;
  1056. /**
  1057. * Constant used to retrieve the irradiance texture index in the textures array in the prepass
  1058. * using getIndex(Constants.PREPASS_IRRADIANCE_TEXTURE_TYPE)
  1059. */
  1060. static readonly PREPASS_IRRADIANCE_TEXTURE_TYPE: number;
  1061. /**
  1062. * Constant used to retrieve the position texture index in the textures array in the prepass
  1063. * using getIndex(Constants.PREPASS_POSITION_TEXTURE_INDEX)
  1064. */
  1065. static readonly PREPASS_POSITION_TEXTURE_TYPE: number;
  1066. /**
  1067. * Constant used to retrieve the velocity texture index in the textures array in the prepass
  1068. * using getIndex(Constants.PREPASS_VELOCITY_TEXTURE_INDEX)
  1069. */
  1070. static readonly PREPASS_VELOCITY_TEXTURE_TYPE: number;
  1071. /**
  1072. * Constant used to retrieve the reflectivity texture index in the textures array in the prepass
  1073. * using the getIndex(Constants.PREPASS_REFLECTIVITY_TEXTURE_TYPE)
  1074. */
  1075. static readonly PREPASS_REFLECTIVITY_TEXTURE_TYPE: number;
  1076. /**
  1077. * Constant used to retrieve the lit color texture index in the textures array in the prepass
  1078. * using the getIndex(Constants.PREPASS_COLOR_TEXTURE_TYPE)
  1079. */
  1080. static readonly PREPASS_COLOR_TEXTURE_TYPE: number;
  1081. /**
  1082. * Constant used to retrieve depth + normal index in the textures array in the prepass
  1083. * using the getIndex(Constants.PREPASS_DEPTHNORMAL_TEXTURE_TYPE)
  1084. */
  1085. static readonly PREPASS_DEPTHNORMAL_TEXTURE_TYPE: number;
  1086. /**
  1087. * Constant used to retrieve albedo index in the textures array in the prepass
  1088. * using the getIndex(Constants.PREPASS_ALBEDO_TEXTURE_TYPE)
  1089. */
  1090. static readonly PREPASS_ALBEDO_TEXTURE_TYPE: number;
  1091. }
  1092. }
  1093. declare module "babylonjs/Materials/Textures/internalTextureLoader" {
  1094. import { Nullable } from "babylonjs/types";
  1095. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  1096. /**
  1097. * This represents the required contract to create a new type of texture loader.
  1098. */
  1099. export interface IInternalTextureLoader {
  1100. /**
  1101. * Defines wether the loader supports cascade loading the different faces.
  1102. */
  1103. supportCascades: boolean;
  1104. /**
  1105. * This returns if the loader support the current file information.
  1106. * @param extension defines the file extension of the file being loaded
  1107. * @param mimeType defines the optional mime type of the file being loaded
  1108. * @returns true if the loader can load the specified file
  1109. */
  1110. canLoad(extension: string, mimeType?: string): boolean;
  1111. /**
  1112. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  1113. * @param data contains the texture data
  1114. * @param texture defines the BabylonJS internal texture
  1115. * @param createPolynomials will be true if polynomials have been requested
  1116. * @param onLoad defines the callback to trigger once the texture is ready
  1117. * @param onError defines the callback to trigger in case of error
  1118. */
  1119. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  1120. /**
  1121. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  1122. * @param data contains the texture data
  1123. * @param texture defines the BabylonJS internal texture
  1124. * @param callback defines the method to call once ready to upload
  1125. */
  1126. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  1127. }
  1128. }
  1129. declare module "babylonjs/Engines/IPipelineContext" {
  1130. /**
  1131. * Class used to store and describe the pipeline context associated with an effect
  1132. */
  1133. export interface IPipelineContext {
  1134. /**
  1135. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  1136. */
  1137. isAsync: boolean;
  1138. /**
  1139. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  1140. */
  1141. isReady: boolean;
  1142. /** @hidden */
  1143. _getVertexShaderCode(): string | null;
  1144. /** @hidden */
  1145. _getFragmentShaderCode(): string | null;
  1146. /** @hidden */
  1147. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  1148. }
  1149. }
  1150. declare module "babylonjs/Meshes/dataBuffer" {
  1151. /**
  1152. * Class used to store gfx data (like WebGLBuffer)
  1153. */
  1154. export class DataBuffer {
  1155. /**
  1156. * Gets or sets the number of objects referencing this buffer
  1157. */
  1158. references: number;
  1159. /** Gets or sets the size of the underlying buffer */
  1160. capacity: number;
  1161. /**
  1162. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  1163. */
  1164. is32Bits: boolean;
  1165. /**
  1166. * Gets the underlying buffer
  1167. */
  1168. get underlyingResource(): any;
  1169. }
  1170. }
  1171. declare module "babylonjs/Engines/Processors/iShaderProcessor" {
  1172. /** @hidden */
  1173. export interface IShaderProcessor {
  1174. attributeProcessor?: (attribute: string) => string;
  1175. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  1176. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  1177. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  1178. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  1179. lineProcessor?: (line: string, isFragment: boolean) => string;
  1180. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1181. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1182. }
  1183. }
  1184. declare module "babylonjs/Engines/Processors/shaderProcessingOptions" {
  1185. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  1186. /** @hidden */
  1187. export interface ProcessingOptions {
  1188. defines: string[];
  1189. indexParameters: any;
  1190. isFragment: boolean;
  1191. shouldUseHighPrecisionShader: boolean;
  1192. supportsUniformBuffers: boolean;
  1193. shadersRepository: string;
  1194. includesShadersStore: {
  1195. [key: string]: string;
  1196. };
  1197. processor?: IShaderProcessor;
  1198. version: string;
  1199. platformName: string;
  1200. lookForClosingBracketForUniformBuffer?: boolean;
  1201. }
  1202. }
  1203. declare module "babylonjs/Engines/Processors/shaderCodeNode" {
  1204. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1205. /** @hidden */
  1206. export class ShaderCodeNode {
  1207. line: string;
  1208. children: ShaderCodeNode[];
  1209. additionalDefineKey?: string;
  1210. additionalDefineValue?: string;
  1211. isValid(preprocessors: {
  1212. [key: string]: string;
  1213. }): boolean;
  1214. process(preprocessors: {
  1215. [key: string]: string;
  1216. }, options: ProcessingOptions): string;
  1217. }
  1218. }
  1219. declare module "babylonjs/Engines/Processors/shaderCodeCursor" {
  1220. /** @hidden */
  1221. export class ShaderCodeCursor {
  1222. private _lines;
  1223. lineIndex: number;
  1224. get currentLine(): string;
  1225. get canRead(): boolean;
  1226. set lines(value: string[]);
  1227. }
  1228. }
  1229. declare module "babylonjs/Engines/Processors/shaderCodeConditionNode" {
  1230. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1231. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1232. /** @hidden */
  1233. export class ShaderCodeConditionNode extends ShaderCodeNode {
  1234. process(preprocessors: {
  1235. [key: string]: string;
  1236. }, options: ProcessingOptions): string;
  1237. }
  1238. }
  1239. declare module "babylonjs/Engines/Processors/Expressions/shaderDefineExpression" {
  1240. /** @hidden */
  1241. export class ShaderDefineExpression {
  1242. isTrue(preprocessors: {
  1243. [key: string]: string;
  1244. }): boolean;
  1245. private static _OperatorPriority;
  1246. private static _Stack;
  1247. static postfixToInfix(postfix: string[]): string;
  1248. static infixToPostfix(infix: string): string[];
  1249. }
  1250. }
  1251. declare module "babylonjs/Engines/Processors/shaderCodeTestNode" {
  1252. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1253. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1254. /** @hidden */
  1255. export class ShaderCodeTestNode extends ShaderCodeNode {
  1256. testExpression: ShaderDefineExpression;
  1257. isValid(preprocessors: {
  1258. [key: string]: string;
  1259. }): boolean;
  1260. }
  1261. }
  1262. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator" {
  1263. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1264. /** @hidden */
  1265. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  1266. define: string;
  1267. not: boolean;
  1268. constructor(define: string, not?: boolean);
  1269. isTrue(preprocessors: {
  1270. [key: string]: string;
  1271. }): boolean;
  1272. }
  1273. }
  1274. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator" {
  1275. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1276. /** @hidden */
  1277. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  1278. leftOperand: ShaderDefineExpression;
  1279. rightOperand: ShaderDefineExpression;
  1280. isTrue(preprocessors: {
  1281. [key: string]: string;
  1282. }): boolean;
  1283. }
  1284. }
  1285. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator" {
  1286. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1287. /** @hidden */
  1288. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  1289. leftOperand: ShaderDefineExpression;
  1290. rightOperand: ShaderDefineExpression;
  1291. isTrue(preprocessors: {
  1292. [key: string]: string;
  1293. }): boolean;
  1294. }
  1295. }
  1296. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator" {
  1297. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1298. /** @hidden */
  1299. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  1300. define: string;
  1301. operand: string;
  1302. testValue: string;
  1303. constructor(define: string, operand: string, testValue: string);
  1304. isTrue(preprocessors: {
  1305. [key: string]: string;
  1306. }): boolean;
  1307. }
  1308. }
  1309. declare module "babylonjs/Offline/IOfflineProvider" {
  1310. /**
  1311. * Class used to enable access to offline support
  1312. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  1313. */
  1314. export interface IOfflineProvider {
  1315. /**
  1316. * Gets a boolean indicating if scene must be saved in the database
  1317. */
  1318. enableSceneOffline: boolean;
  1319. /**
  1320. * Gets a boolean indicating if textures must be saved in the database
  1321. */
  1322. enableTexturesOffline: boolean;
  1323. /**
  1324. * Open the offline support and make it available
  1325. * @param successCallback defines the callback to call on success
  1326. * @param errorCallback defines the callback to call on error
  1327. */
  1328. open(successCallback: () => void, errorCallback: () => void): void;
  1329. /**
  1330. * Loads an image from the offline support
  1331. * @param url defines the url to load from
  1332. * @param image defines the target DOM image
  1333. */
  1334. loadImage(url: string, image: HTMLImageElement): void;
  1335. /**
  1336. * Loads a file from offline support
  1337. * @param url defines the URL to load from
  1338. * @param sceneLoaded defines a callback to call on success
  1339. * @param progressCallBack defines a callback to call when progress changed
  1340. * @param errorCallback defines a callback to call on error
  1341. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  1342. */
  1343. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  1344. }
  1345. }
  1346. declare module "babylonjs/Misc/filesInputStore" {
  1347. /**
  1348. * Class used to help managing file picking and drag'n'drop
  1349. * File Storage
  1350. */
  1351. export class FilesInputStore {
  1352. /**
  1353. * List of files ready to be loaded
  1354. */
  1355. static FilesToLoad: {
  1356. [key: string]: File;
  1357. };
  1358. }
  1359. }
  1360. declare module "babylonjs/Misc/retryStrategy" {
  1361. import { WebRequest } from "babylonjs/Misc/webRequest";
  1362. /**
  1363. * Class used to define a retry strategy when error happens while loading assets
  1364. */
  1365. export class RetryStrategy {
  1366. /**
  1367. * Function used to defines an exponential back off strategy
  1368. * @param maxRetries defines the maximum number of retries (3 by default)
  1369. * @param baseInterval defines the interval between retries
  1370. * @returns the strategy function to use
  1371. */
  1372. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  1373. }
  1374. }
  1375. declare module "babylonjs/Misc/baseError" {
  1376. /**
  1377. * @ignore
  1378. * Application error to support additional information when loading a file
  1379. */
  1380. export abstract class BaseError extends Error {
  1381. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  1382. }
  1383. }
  1384. declare module "babylonjs/Misc/fileTools" {
  1385. import { WebRequest } from "babylonjs/Misc/webRequest";
  1386. import { Nullable } from "babylonjs/types";
  1387. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1388. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1389. import { BaseError } from "babylonjs/Misc/baseError";
  1390. /** @ignore */
  1391. export class LoadFileError extends BaseError {
  1392. request?: WebRequest;
  1393. file?: File;
  1394. /**
  1395. * Creates a new LoadFileError
  1396. * @param message defines the message of the error
  1397. * @param request defines the optional web request
  1398. * @param file defines the optional file
  1399. */
  1400. constructor(message: string, object?: WebRequest | File);
  1401. }
  1402. /** @ignore */
  1403. export class RequestFileError extends BaseError {
  1404. request: WebRequest;
  1405. /**
  1406. * Creates a new LoadFileError
  1407. * @param message defines the message of the error
  1408. * @param request defines the optional web request
  1409. */
  1410. constructor(message: string, request: WebRequest);
  1411. }
  1412. /** @ignore */
  1413. export class ReadFileError extends BaseError {
  1414. file: File;
  1415. /**
  1416. * Creates a new ReadFileError
  1417. * @param message defines the message of the error
  1418. * @param file defines the optional file
  1419. */
  1420. constructor(message: string, file: File);
  1421. }
  1422. /**
  1423. * @hidden
  1424. */
  1425. export class FileTools {
  1426. /**
  1427. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  1428. */
  1429. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  1430. /**
  1431. * Gets or sets the base URL to use to load assets
  1432. */
  1433. static BaseUrl: string;
  1434. /**
  1435. * Default behaviour for cors in the application.
  1436. * It can be a string if the expected behavior is identical in the entire app.
  1437. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  1438. */
  1439. static CorsBehavior: string | ((url: string | string[]) => string);
  1440. /**
  1441. * Gets or sets a function used to pre-process url before using them to load assets
  1442. */
  1443. static PreprocessUrl: (url: string) => string;
  1444. /**
  1445. * Removes unwanted characters from an url
  1446. * @param url defines the url to clean
  1447. * @returns the cleaned url
  1448. */
  1449. private static _CleanUrl;
  1450. /**
  1451. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  1452. * @param url define the url we are trying
  1453. * @param element define the dom element where to configure the cors policy
  1454. */
  1455. static SetCorsBehavior(url: string | string[], element: {
  1456. crossOrigin: string | null;
  1457. }): void;
  1458. /**
  1459. * Loads an image as an HTMLImageElement.
  1460. * @param input url string, ArrayBuffer, or Blob to load
  1461. * @param onLoad callback called when the image successfully loads
  1462. * @param onError callback called when the image fails to load
  1463. * @param offlineProvider offline provider for caching
  1464. * @param mimeType optional mime type
  1465. * @returns the HTMLImageElement of the loaded image
  1466. */
  1467. 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>;
  1468. /**
  1469. * Reads a file from a File object
  1470. * @param file defines the file to load
  1471. * @param onSuccess defines the callback to call when data is loaded
  1472. * @param onProgress defines the callback to call during loading process
  1473. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  1474. * @param onError defines the callback to call when an error occurs
  1475. * @returns a file request object
  1476. */
  1477. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  1478. /**
  1479. * Loads a file from a url
  1480. * @param url url to load
  1481. * @param onSuccess callback called when the file successfully loads
  1482. * @param onProgress callback called while file is loading (if the server supports this mode)
  1483. * @param offlineProvider defines the offline provider for caching
  1484. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1485. * @param onError callback called when the file fails to load
  1486. * @returns a file request object
  1487. */
  1488. 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;
  1489. /**
  1490. * Loads a file
  1491. * @param url url to load
  1492. * @param onSuccess callback called when the file successfully loads
  1493. * @param onProgress callback called while file is loading (if the server supports this mode)
  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. * @param onOpened callback called when the web request is opened
  1497. * @returns a file request object
  1498. */
  1499. 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;
  1500. /**
  1501. * Checks if the loaded document was accessed via `file:`-Protocol.
  1502. * @returns boolean
  1503. */
  1504. static IsFileURL(): boolean;
  1505. }
  1506. }
  1507. declare module "babylonjs/Engines/Processors/shaderProcessor" {
  1508. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1509. import { WebRequest } from "babylonjs/Misc/webRequest";
  1510. import { LoadFileError } from "babylonjs/Misc/fileTools";
  1511. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1512. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1513. /** @hidden */
  1514. export class ShaderProcessor {
  1515. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  1516. private static _ProcessPrecision;
  1517. private static _ExtractOperation;
  1518. private static _BuildSubExpression;
  1519. private static _BuildExpression;
  1520. private static _MoveCursorWithinIf;
  1521. private static _MoveCursor;
  1522. private static _EvaluatePreProcessors;
  1523. private static _PreparePreProcessors;
  1524. private static _ProcessShaderConversion;
  1525. private static _ProcessIncludes;
  1526. /**
  1527. * Loads a file from a url
  1528. * @param url url to load
  1529. * @param onSuccess callback called when the file successfully loads
  1530. * @param onProgress callback called while file is loading (if the server supports this mode)
  1531. * @param offlineProvider defines the offline provider for caching
  1532. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1533. * @param onError callback called when the file fails to load
  1534. * @returns a file request object
  1535. * @hidden
  1536. */
  1537. 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;
  1538. }
  1539. }
  1540. declare module "babylonjs/Maths/math.like" {
  1541. import { float, int, DeepImmutable } from "babylonjs/types";
  1542. /**
  1543. * @hidden
  1544. */
  1545. export interface IColor4Like {
  1546. r: float;
  1547. g: float;
  1548. b: float;
  1549. a: float;
  1550. }
  1551. /**
  1552. * @hidden
  1553. */
  1554. export interface IColor3Like {
  1555. r: float;
  1556. g: float;
  1557. b: float;
  1558. }
  1559. /**
  1560. * @hidden
  1561. */
  1562. export interface IVector4Like {
  1563. x: float;
  1564. y: float;
  1565. z: float;
  1566. w: float;
  1567. }
  1568. /**
  1569. * @hidden
  1570. */
  1571. export interface IVector3Like {
  1572. x: float;
  1573. y: float;
  1574. z: float;
  1575. }
  1576. /**
  1577. * @hidden
  1578. */
  1579. export interface IVector2Like {
  1580. x: float;
  1581. y: float;
  1582. }
  1583. /**
  1584. * @hidden
  1585. */
  1586. export interface IMatrixLike {
  1587. toArray(): DeepImmutable<Float32Array | Array<number>>;
  1588. updateFlag: int;
  1589. }
  1590. /**
  1591. * @hidden
  1592. */
  1593. export interface IViewportLike {
  1594. x: float;
  1595. y: float;
  1596. width: float;
  1597. height: float;
  1598. }
  1599. /**
  1600. * @hidden
  1601. */
  1602. export interface IPlaneLike {
  1603. normal: IVector3Like;
  1604. d: float;
  1605. normalize(): void;
  1606. }
  1607. }
  1608. declare module "babylonjs/Materials/iEffectFallbacks" {
  1609. import { Effect } from "babylonjs/Materials/effect";
  1610. /**
  1611. * Interface used to define common properties for effect fallbacks
  1612. */
  1613. export interface IEffectFallbacks {
  1614. /**
  1615. * Removes the defines that should be removed when falling back.
  1616. * @param currentDefines defines the current define statements for the shader.
  1617. * @param effect defines the current effect we try to compile
  1618. * @returns The resulting defines with defines of the current rank removed.
  1619. */
  1620. reduce(currentDefines: string, effect: Effect): string;
  1621. /**
  1622. * Removes the fallback from the bound mesh.
  1623. */
  1624. unBindMesh(): void;
  1625. /**
  1626. * Checks to see if more fallbacks are still availible.
  1627. */
  1628. hasMoreFallbacks: boolean;
  1629. }
  1630. }
  1631. declare module "babylonjs/Misc/andOrNotEvaluator" {
  1632. /**
  1633. * Class used to evalaute queries containing `and` and `or` operators
  1634. */
  1635. export class AndOrNotEvaluator {
  1636. /**
  1637. * Evaluate a query
  1638. * @param query defines the query to evaluate
  1639. * @param evaluateCallback defines the callback used to filter result
  1640. * @returns true if the query matches
  1641. */
  1642. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  1643. private static _HandleParenthesisContent;
  1644. private static _SimplifyNegation;
  1645. }
  1646. }
  1647. declare module "babylonjs/Misc/tags" {
  1648. /**
  1649. * Class used to store custom tags
  1650. */
  1651. export class Tags {
  1652. /**
  1653. * Adds support for tags on the given object
  1654. * @param obj defines the object to use
  1655. */
  1656. static EnableFor(obj: any): void;
  1657. /**
  1658. * Removes tags support
  1659. * @param obj defines the object to use
  1660. */
  1661. static DisableFor(obj: any): void;
  1662. /**
  1663. * Gets a boolean indicating if the given object has tags
  1664. * @param obj defines the object to use
  1665. * @returns a boolean
  1666. */
  1667. static HasTags(obj: any): boolean;
  1668. /**
  1669. * Gets the tags available on a given object
  1670. * @param obj defines the object to use
  1671. * @param asString defines if the tags must be returned as a string instead of an array of strings
  1672. * @returns the tags
  1673. */
  1674. static GetTags(obj: any, asString?: boolean): any;
  1675. /**
  1676. * Adds tags to an object
  1677. * @param obj defines the object to use
  1678. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  1679. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  1680. */
  1681. static AddTagsTo(obj: any, tagsString: string): void;
  1682. /**
  1683. * @hidden
  1684. */
  1685. static _AddTagTo(obj: any, tag: string): void;
  1686. /**
  1687. * Removes specific tags from a specific object
  1688. * @param obj defines the object to use
  1689. * @param tagsString defines the tags to remove
  1690. */
  1691. static RemoveTagsFrom(obj: any, tagsString: string): void;
  1692. /**
  1693. * @hidden
  1694. */
  1695. static _RemoveTagFrom(obj: any, tag: string): void;
  1696. /**
  1697. * Defines if tags hosted on an object match a given query
  1698. * @param obj defines the object to use
  1699. * @param tagsQuery defines the tag query
  1700. * @returns a boolean
  1701. */
  1702. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  1703. }
  1704. }
  1705. declare module "babylonjs/Maths/math.scalar" {
  1706. /**
  1707. * Scalar computation library
  1708. */
  1709. export class Scalar {
  1710. /**
  1711. * Two pi constants convenient for computation.
  1712. */
  1713. static TwoPi: number;
  1714. /**
  1715. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1716. * @param a number
  1717. * @param b number
  1718. * @param epsilon (default = 1.401298E-45)
  1719. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1720. */
  1721. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  1722. /**
  1723. * Returns a string : the upper case translation of the number i to hexadecimal.
  1724. * @param i number
  1725. * @returns the upper case translation of the number i to hexadecimal.
  1726. */
  1727. static ToHex(i: number): string;
  1728. /**
  1729. * Returns -1 if value is negative and +1 is value is positive.
  1730. * @param value the value
  1731. * @returns the value itself if it's equal to zero.
  1732. */
  1733. static Sign(value: number): number;
  1734. /**
  1735. * Returns the value itself if it's between min and max.
  1736. * Returns min if the value is lower than min.
  1737. * Returns max if the value is greater than max.
  1738. * @param value the value to clmap
  1739. * @param min the min value to clamp to (default: 0)
  1740. * @param max the max value to clamp to (default: 1)
  1741. * @returns the clamped value
  1742. */
  1743. static Clamp(value: number, min?: number, max?: number): number;
  1744. /**
  1745. * the log2 of value.
  1746. * @param value the value to compute log2 of
  1747. * @returns the log2 of value.
  1748. */
  1749. static Log2(value: number): number;
  1750. /**
  1751. * Loops the value, so that it is never larger than length and never smaller than 0.
  1752. *
  1753. * This is similar to the modulo operator but it works with floating point numbers.
  1754. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  1755. * With t = 5 and length = 2.5, the result would be 0.0.
  1756. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  1757. * @param value the value
  1758. * @param length the length
  1759. * @returns the looped value
  1760. */
  1761. static Repeat(value: number, length: number): number;
  1762. /**
  1763. * Normalize the value between 0.0 and 1.0 using min and max values
  1764. * @param value value to normalize
  1765. * @param min max to normalize between
  1766. * @param max min to normalize between
  1767. * @returns the normalized value
  1768. */
  1769. static Normalize(value: number, min: number, max: number): number;
  1770. /**
  1771. * Denormalize the value from 0.0 and 1.0 using min and max values
  1772. * @param normalized value to denormalize
  1773. * @param min max to denormalize between
  1774. * @param max min to denormalize between
  1775. * @returns the denormalized value
  1776. */
  1777. static Denormalize(normalized: number, min: number, max: number): number;
  1778. /**
  1779. * Calculates the shortest difference between two given angles given in degrees.
  1780. * @param current current angle in degrees
  1781. * @param target target angle in degrees
  1782. * @returns the delta
  1783. */
  1784. static DeltaAngle(current: number, target: number): number;
  1785. /**
  1786. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  1787. * @param tx value
  1788. * @param length length
  1789. * @returns The returned value will move back and forth between 0 and length
  1790. */
  1791. static PingPong(tx: number, length: number): number;
  1792. /**
  1793. * Interpolates between min and max with smoothing at the limits.
  1794. *
  1795. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  1796. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  1797. * @param from from
  1798. * @param to to
  1799. * @param tx value
  1800. * @returns the smooth stepped value
  1801. */
  1802. static SmoothStep(from: number, to: number, tx: number): number;
  1803. /**
  1804. * Moves a value current towards target.
  1805. *
  1806. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  1807. * Negative values of maxDelta pushes the value away from target.
  1808. * @param current current value
  1809. * @param target target value
  1810. * @param maxDelta max distance to move
  1811. * @returns resulting value
  1812. */
  1813. static MoveTowards(current: number, target: number, maxDelta: number): number;
  1814. /**
  1815. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1816. *
  1817. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  1818. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  1819. * @param current current value
  1820. * @param target target value
  1821. * @param maxDelta max distance to move
  1822. * @returns resulting angle
  1823. */
  1824. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  1825. /**
  1826. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  1827. * @param start start value
  1828. * @param end target value
  1829. * @param amount amount to lerp between
  1830. * @returns the lerped value
  1831. */
  1832. static Lerp(start: number, end: number, amount: number): number;
  1833. /**
  1834. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1835. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  1836. * @param start start value
  1837. * @param end target value
  1838. * @param amount amount to lerp between
  1839. * @returns the lerped value
  1840. */
  1841. static LerpAngle(start: number, end: number, amount: number): number;
  1842. /**
  1843. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  1844. * @param a start value
  1845. * @param b target value
  1846. * @param value value between a and b
  1847. * @returns the inverseLerp value
  1848. */
  1849. static InverseLerp(a: number, b: number, value: number): number;
  1850. /**
  1851. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  1852. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  1853. * @param value1 spline value
  1854. * @param tangent1 spline value
  1855. * @param value2 spline value
  1856. * @param tangent2 spline value
  1857. * @param amount input value
  1858. * @returns hermite result
  1859. */
  1860. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  1861. /**
  1862. * Returns a random float number between and min and max values
  1863. * @param min min value of random
  1864. * @param max max value of random
  1865. * @returns random value
  1866. */
  1867. static RandomRange(min: number, max: number): number;
  1868. /**
  1869. * This function returns percentage of a number in a given range.
  1870. *
  1871. * RangeToPercent(40,20,60) will return 0.5 (50%)
  1872. * RangeToPercent(34,0,100) will return 0.34 (34%)
  1873. * @param number to convert to percentage
  1874. * @param min min range
  1875. * @param max max range
  1876. * @returns the percentage
  1877. */
  1878. static RangeToPercent(number: number, min: number, max: number): number;
  1879. /**
  1880. * This function returns number that corresponds to the percentage in a given range.
  1881. *
  1882. * PercentToRange(0.34,0,100) will return 34.
  1883. * @param percent to convert to number
  1884. * @param min min range
  1885. * @param max max range
  1886. * @returns the number
  1887. */
  1888. static PercentToRange(percent: number, min: number, max: number): number;
  1889. /**
  1890. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  1891. * @param angle The angle to normalize in radian.
  1892. * @return The converted angle.
  1893. */
  1894. static NormalizeRadians(angle: number): number;
  1895. }
  1896. }
  1897. declare module "babylonjs/Maths/math.constants" {
  1898. /**
  1899. * Constant used to convert a value to gamma space
  1900. * @ignorenaming
  1901. */
  1902. export const ToGammaSpace: number;
  1903. /**
  1904. * Constant used to convert a value to linear space
  1905. * @ignorenaming
  1906. */
  1907. export const ToLinearSpace = 2.2;
  1908. /**
  1909. * Constant used to define the minimal number value in Babylon.js
  1910. * @ignorenaming
  1911. */
  1912. let Epsilon: number;
  1913. export { Epsilon };
  1914. }
  1915. declare module "babylonjs/Maths/math.viewport" {
  1916. /**
  1917. * Class used to represent a viewport on screen
  1918. */
  1919. export class Viewport {
  1920. /** viewport left coordinate */
  1921. x: number;
  1922. /** viewport top coordinate */
  1923. y: number;
  1924. /**viewport width */
  1925. width: number;
  1926. /** viewport height */
  1927. height: number;
  1928. /**
  1929. * Creates a Viewport object located at (x, y) and sized (width, height)
  1930. * @param x defines viewport left coordinate
  1931. * @param y defines viewport top coordinate
  1932. * @param width defines the viewport width
  1933. * @param height defines the viewport height
  1934. */
  1935. constructor(
  1936. /** viewport left coordinate */
  1937. x: number,
  1938. /** viewport top coordinate */
  1939. y: number,
  1940. /**viewport width */
  1941. width: number,
  1942. /** viewport height */
  1943. height: number);
  1944. /**
  1945. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  1946. * @param renderWidth defines the rendering width
  1947. * @param renderHeight defines the rendering height
  1948. * @returns a new Viewport
  1949. */
  1950. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  1951. /**
  1952. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  1953. * @param renderWidth defines the rendering width
  1954. * @param renderHeight defines the rendering height
  1955. * @param ref defines the target viewport
  1956. * @returns the current viewport
  1957. */
  1958. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  1959. /**
  1960. * Returns a new Viewport copied from the current one
  1961. * @returns a new Viewport
  1962. */
  1963. clone(): Viewport;
  1964. }
  1965. }
  1966. declare module "babylonjs/Misc/arrayTools" {
  1967. /**
  1968. * Class containing a set of static utilities functions for arrays.
  1969. */
  1970. export class ArrayTools {
  1971. /**
  1972. * Returns an array of the given size filled with element built from the given constructor and the paramters
  1973. * @param size the number of element to construct and put in the array
  1974. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  1975. * @returns a new array filled with new objects
  1976. */
  1977. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  1978. }
  1979. }
  1980. declare module "babylonjs/Maths/math.plane" {
  1981. import { DeepImmutable } from "babylonjs/types";
  1982. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  1983. /**
  1984. * Represents a plane by the equation ax + by + cz + d = 0
  1985. */
  1986. export class Plane {
  1987. private static _TmpMatrix;
  1988. /**
  1989. * Normal of the plane (a,b,c)
  1990. */
  1991. normal: Vector3;
  1992. /**
  1993. * d component of the plane
  1994. */
  1995. d: number;
  1996. /**
  1997. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  1998. * @param a a component of the plane
  1999. * @param b b component of the plane
  2000. * @param c c component of the plane
  2001. * @param d d component of the plane
  2002. */
  2003. constructor(a: number, b: number, c: number, d: number);
  2004. /**
  2005. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  2006. */
  2007. asArray(): number[];
  2008. /**
  2009. * @returns a new plane copied from the current Plane.
  2010. */
  2011. clone(): Plane;
  2012. /**
  2013. * @returns the string "Plane".
  2014. */
  2015. getClassName(): string;
  2016. /**
  2017. * @returns the Plane hash code.
  2018. */
  2019. getHashCode(): number;
  2020. /**
  2021. * Normalize the current Plane in place.
  2022. * @returns the updated Plane.
  2023. */
  2024. normalize(): Plane;
  2025. /**
  2026. * Applies a transformation the plane and returns the result
  2027. * @param transformation the transformation matrix to be applied to the plane
  2028. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  2029. */
  2030. transform(transformation: DeepImmutable<Matrix>): Plane;
  2031. /**
  2032. * Compute the dot product between the point and the plane normal
  2033. * @param point point to calculate the dot product with
  2034. * @returns the dot product (float) of the point coordinates and the plane normal.
  2035. */
  2036. dotCoordinate(point: DeepImmutable<Vector3>): number;
  2037. /**
  2038. * Updates the current Plane from the plane defined by the three given points.
  2039. * @param point1 one of the points used to contruct the plane
  2040. * @param point2 one of the points used to contruct the plane
  2041. * @param point3 one of the points used to contruct the plane
  2042. * @returns the updated Plane.
  2043. */
  2044. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  2045. /**
  2046. * Checks if the plane is facing a given direction
  2047. * @param direction the direction to check if the plane is facing
  2048. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  2049. * @returns True is the vector "direction" is the same side than the plane normal.
  2050. */
  2051. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  2052. /**
  2053. * Calculates the distance to a point
  2054. * @param point point to calculate distance to
  2055. * @returns the signed distance (float) from the given point to the Plane.
  2056. */
  2057. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  2058. /**
  2059. * Creates a plane from an array
  2060. * @param array the array to create a plane from
  2061. * @returns a new Plane from the given array.
  2062. */
  2063. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  2064. /**
  2065. * Creates a plane from three points
  2066. * @param point1 point used to create the plane
  2067. * @param point2 point used to create the plane
  2068. * @param point3 point used to create the plane
  2069. * @returns a new Plane defined by the three given points.
  2070. */
  2071. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  2072. /**
  2073. * Creates a plane from an origin point and a normal
  2074. * @param origin origin of the plane to be constructed
  2075. * @param normal normal of the plane to be constructed
  2076. * @returns a new Plane the normal vector to this plane at the given origin point.
  2077. * Note : the vector "normal" is updated because normalized.
  2078. */
  2079. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  2080. /**
  2081. * Calculates the distance from a plane and a point
  2082. * @param origin origin of the plane to be constructed
  2083. * @param normal normal of the plane to be constructed
  2084. * @param point point to calculate distance to
  2085. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  2086. */
  2087. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  2088. }
  2089. }
  2090. declare module "babylonjs/Engines/performanceConfigurator" {
  2091. /** @hidden */
  2092. export class PerformanceConfigurator {
  2093. /** @hidden */
  2094. static MatrixUse64Bits: boolean;
  2095. /** @hidden */
  2096. static MatrixTrackPrecisionChange: boolean;
  2097. /** @hidden */
  2098. static MatrixCurrentType: any;
  2099. /** @hidden */
  2100. static MatrixTrackedMatrices: Array<any> | null;
  2101. /** @hidden */
  2102. static SetMatrixPrecision(use64bits: boolean): void;
  2103. }
  2104. }
  2105. declare module "babylonjs/Maths/math.vector" {
  2106. import { Viewport } from "babylonjs/Maths/math.viewport";
  2107. import { DeepImmutable, Nullable, FloatArray, float } from "babylonjs/types";
  2108. import { IPlaneLike } from "babylonjs/Maths/math.like";
  2109. import { Plane } from "babylonjs/Maths/math.plane";
  2110. /**
  2111. * Class representing a vector containing 2 coordinates
  2112. */
  2113. export class Vector2 {
  2114. /** defines the first coordinate */
  2115. x: number;
  2116. /** defines the second coordinate */
  2117. y: number;
  2118. /**
  2119. * Creates a new Vector2 from the given x and y coordinates
  2120. * @param x defines the first coordinate
  2121. * @param y defines the second coordinate
  2122. */
  2123. constructor(
  2124. /** defines the first coordinate */
  2125. x?: number,
  2126. /** defines the second coordinate */
  2127. y?: number);
  2128. /**
  2129. * Gets a string with the Vector2 coordinates
  2130. * @returns a string with the Vector2 coordinates
  2131. */
  2132. toString(): string;
  2133. /**
  2134. * Gets class name
  2135. * @returns the string "Vector2"
  2136. */
  2137. getClassName(): string;
  2138. /**
  2139. * Gets current vector hash code
  2140. * @returns the Vector2 hash code as a number
  2141. */
  2142. getHashCode(): number;
  2143. /**
  2144. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  2145. * @param array defines the source array
  2146. * @param index defines the offset in source array
  2147. * @returns the current Vector2
  2148. */
  2149. toArray(array: FloatArray, index?: number): Vector2;
  2150. /**
  2151. * Update the current vector from an array
  2152. * @param array defines the destination array
  2153. * @param index defines the offset in the destination array
  2154. * @returns the current Vector3
  2155. */
  2156. fromArray(array: FloatArray, index?: number): Vector2;
  2157. /**
  2158. * Copy the current vector to an array
  2159. * @returns a new array with 2 elements: the Vector2 coordinates.
  2160. */
  2161. asArray(): number[];
  2162. /**
  2163. * Sets the Vector2 coordinates with the given Vector2 coordinates
  2164. * @param source defines the source Vector2
  2165. * @returns the current updated Vector2
  2166. */
  2167. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  2168. /**
  2169. * Sets the Vector2 coordinates with the given floats
  2170. * @param x defines the first coordinate
  2171. * @param y defines the second coordinate
  2172. * @returns the current updated Vector2
  2173. */
  2174. copyFromFloats(x: number, y: number): Vector2;
  2175. /**
  2176. * Sets the Vector2 coordinates with the given floats
  2177. * @param x defines the first coordinate
  2178. * @param y defines the second coordinate
  2179. * @returns the current updated Vector2
  2180. */
  2181. set(x: number, y: number): Vector2;
  2182. /**
  2183. * Add another vector with the current one
  2184. * @param otherVector defines the other vector
  2185. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  2186. */
  2187. add(otherVector: DeepImmutable<Vector2>): Vector2;
  2188. /**
  2189. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  2190. * @param otherVector defines the other vector
  2191. * @param result defines the target vector
  2192. * @returns the unmodified current Vector2
  2193. */
  2194. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2195. /**
  2196. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  2197. * @param otherVector defines the other vector
  2198. * @returns the current updated Vector2
  2199. */
  2200. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2201. /**
  2202. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  2203. * @param otherVector defines the other vector
  2204. * @returns a new Vector2
  2205. */
  2206. addVector3(otherVector: Vector3): Vector2;
  2207. /**
  2208. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  2209. * @param otherVector defines the other vector
  2210. * @returns a new Vector2
  2211. */
  2212. subtract(otherVector: Vector2): Vector2;
  2213. /**
  2214. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  2215. * @param otherVector defines the other vector
  2216. * @param result defines the target vector
  2217. * @returns the unmodified current Vector2
  2218. */
  2219. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2220. /**
  2221. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  2222. * @param otherVector defines the other vector
  2223. * @returns the current updated Vector2
  2224. */
  2225. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2226. /**
  2227. * Multiplies in place the current Vector2 coordinates by the given ones
  2228. * @param otherVector defines the other vector
  2229. * @returns the current updated Vector2
  2230. */
  2231. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2232. /**
  2233. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  2234. * @param otherVector defines the other vector
  2235. * @returns a new Vector2
  2236. */
  2237. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  2238. /**
  2239. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  2240. * @param otherVector defines the other vector
  2241. * @param result defines the target vector
  2242. * @returns the unmodified current Vector2
  2243. */
  2244. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2245. /**
  2246. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  2247. * @param x defines the first coordinate
  2248. * @param y defines the second coordinate
  2249. * @returns a new Vector2
  2250. */
  2251. multiplyByFloats(x: number, y: number): Vector2;
  2252. /**
  2253. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  2254. * @param otherVector defines the other vector
  2255. * @returns a new Vector2
  2256. */
  2257. divide(otherVector: Vector2): Vector2;
  2258. /**
  2259. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  2260. * @param otherVector defines the other vector
  2261. * @param result defines the target vector
  2262. * @returns the unmodified current Vector2
  2263. */
  2264. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2265. /**
  2266. * Divides the current Vector2 coordinates by the given ones
  2267. * @param otherVector defines the other vector
  2268. * @returns the current updated Vector2
  2269. */
  2270. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2271. /**
  2272. * Gets a new Vector2 with current Vector2 negated coordinates
  2273. * @returns a new Vector2
  2274. */
  2275. negate(): Vector2;
  2276. /**
  2277. * Negate this vector in place
  2278. * @returns this
  2279. */
  2280. negateInPlace(): Vector2;
  2281. /**
  2282. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  2283. * @param result defines the Vector3 object where to store the result
  2284. * @returns the current Vector2
  2285. */
  2286. negateToRef(result: Vector2): Vector2;
  2287. /**
  2288. * Multiply the Vector2 coordinates by scale
  2289. * @param scale defines the scaling factor
  2290. * @returns the current updated Vector2
  2291. */
  2292. scaleInPlace(scale: number): Vector2;
  2293. /**
  2294. * Returns a new Vector2 scaled by "scale" from the current Vector2
  2295. * @param scale defines the scaling factor
  2296. * @returns a new Vector2
  2297. */
  2298. scale(scale: number): Vector2;
  2299. /**
  2300. * Scale the current Vector2 values by a factor to a given Vector2
  2301. * @param scale defines the scale factor
  2302. * @param result defines the Vector2 object where to store the result
  2303. * @returns the unmodified current Vector2
  2304. */
  2305. scaleToRef(scale: number, result: Vector2): Vector2;
  2306. /**
  2307. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  2308. * @param scale defines the scale factor
  2309. * @param result defines the Vector2 object where to store the result
  2310. * @returns the unmodified current Vector2
  2311. */
  2312. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  2313. /**
  2314. * Gets a boolean if two vectors are equals
  2315. * @param otherVector defines the other vector
  2316. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  2317. */
  2318. equals(otherVector: DeepImmutable<Vector2>): boolean;
  2319. /**
  2320. * Gets a boolean if two vectors are equals (using an epsilon value)
  2321. * @param otherVector defines the other vector
  2322. * @param epsilon defines the minimal distance to consider equality
  2323. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  2324. */
  2325. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  2326. /**
  2327. * Gets a new Vector2 from current Vector2 floored values
  2328. * @returns a new Vector2
  2329. */
  2330. floor(): Vector2;
  2331. /**
  2332. * Gets a new Vector2 from current Vector2 floored values
  2333. * @returns a new Vector2
  2334. */
  2335. fract(): Vector2;
  2336. /**
  2337. * Gets the length of the vector
  2338. * @returns the vector length (float)
  2339. */
  2340. length(): number;
  2341. /**
  2342. * Gets the vector squared length
  2343. * @returns the vector squared length (float)
  2344. */
  2345. lengthSquared(): number;
  2346. /**
  2347. * Normalize the vector
  2348. * @returns the current updated Vector2
  2349. */
  2350. normalize(): Vector2;
  2351. /**
  2352. * Gets a new Vector2 copied from the Vector2
  2353. * @returns a new Vector2
  2354. */
  2355. clone(): Vector2;
  2356. /**
  2357. * Gets a new Vector2(0, 0)
  2358. * @returns a new Vector2
  2359. */
  2360. static Zero(): Vector2;
  2361. /**
  2362. * Gets a new Vector2(1, 1)
  2363. * @returns a new Vector2
  2364. */
  2365. static One(): Vector2;
  2366. /**
  2367. * Gets a new Vector2 set from the given index element of the given array
  2368. * @param array defines the data source
  2369. * @param offset defines the offset in the data source
  2370. * @returns a new Vector2
  2371. */
  2372. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  2373. /**
  2374. * Sets "result" from the given index element of the given array
  2375. * @param array defines the data source
  2376. * @param offset defines the offset in the data source
  2377. * @param result defines the target vector
  2378. */
  2379. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  2380. /**
  2381. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  2382. * @param value1 defines 1st point of control
  2383. * @param value2 defines 2nd point of control
  2384. * @param value3 defines 3rd point of control
  2385. * @param value4 defines 4th point of control
  2386. * @param amount defines the interpolation factor
  2387. * @returns a new Vector2
  2388. */
  2389. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  2390. /**
  2391. * 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".
  2392. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  2393. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  2394. * @param value defines the value to clamp
  2395. * @param min defines the lower limit
  2396. * @param max defines the upper limit
  2397. * @returns a new Vector2
  2398. */
  2399. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  2400. /**
  2401. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  2402. * @param value1 defines the 1st control point
  2403. * @param tangent1 defines the outgoing tangent
  2404. * @param value2 defines the 2nd control point
  2405. * @param tangent2 defines the incoming tangent
  2406. * @param amount defines the interpolation factor
  2407. * @returns a new Vector2
  2408. */
  2409. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  2410. /**
  2411. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  2412. * @param start defines the start vector
  2413. * @param end defines the end vector
  2414. * @param amount defines the interpolation factor
  2415. * @returns a new Vector2
  2416. */
  2417. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  2418. /**
  2419. * Gets the dot product of the vector "left" and the vector "right"
  2420. * @param left defines first vector
  2421. * @param right defines second vector
  2422. * @returns the dot product (float)
  2423. */
  2424. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  2425. /**
  2426. * Returns a new Vector2 equal to the normalized given vector
  2427. * @param vector defines the vector to normalize
  2428. * @returns a new Vector2
  2429. */
  2430. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  2431. /**
  2432. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  2433. * @param left defines 1st vector
  2434. * @param right defines 2nd vector
  2435. * @returns a new Vector2
  2436. */
  2437. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2438. /**
  2439. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  2440. * @param left defines 1st vector
  2441. * @param right defines 2nd vector
  2442. * @returns a new Vector2
  2443. */
  2444. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2445. /**
  2446. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  2447. * @param vector defines the vector to transform
  2448. * @param transformation defines the matrix to apply
  2449. * @returns a new Vector2
  2450. */
  2451. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  2452. /**
  2453. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  2454. * @param vector defines the vector to transform
  2455. * @param transformation defines the matrix to apply
  2456. * @param result defines the target vector
  2457. */
  2458. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  2459. /**
  2460. * Determines if a given vector is included in a triangle
  2461. * @param p defines the vector to test
  2462. * @param p0 defines 1st triangle point
  2463. * @param p1 defines 2nd triangle point
  2464. * @param p2 defines 3rd triangle point
  2465. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  2466. */
  2467. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  2468. /**
  2469. * Gets the distance between the vectors "value1" and "value2"
  2470. * @param value1 defines first vector
  2471. * @param value2 defines second vector
  2472. * @returns the distance between vectors
  2473. */
  2474. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2475. /**
  2476. * Returns the squared distance between the vectors "value1" and "value2"
  2477. * @param value1 defines first vector
  2478. * @param value2 defines second vector
  2479. * @returns the squared distance between vectors
  2480. */
  2481. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2482. /**
  2483. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  2484. * @param value1 defines first vector
  2485. * @param value2 defines second vector
  2486. * @returns a new Vector2
  2487. */
  2488. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  2489. /**
  2490. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  2491. * @param p defines the middle point
  2492. * @param segA defines one point of the segment
  2493. * @param segB defines the other point of the segment
  2494. * @returns the shortest distance
  2495. */
  2496. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  2497. }
  2498. /**
  2499. * Class used to store (x,y,z) vector representation
  2500. * A Vector3 is the main object used in 3D geometry
  2501. * It can represent etiher the coordinates of a point the space, either a direction
  2502. * Reminder: js uses a left handed forward facing system
  2503. */
  2504. export class Vector3 {
  2505. private static _UpReadOnly;
  2506. private static _ZeroReadOnly;
  2507. /** @hidden */
  2508. _x: number;
  2509. /** @hidden */
  2510. _y: number;
  2511. /** @hidden */
  2512. _z: number;
  2513. /** @hidden */
  2514. _isDirty: boolean;
  2515. /** Gets or sets the x coordinate */
  2516. get x(): number;
  2517. set x(value: number);
  2518. /** Gets or sets the y coordinate */
  2519. get y(): number;
  2520. set y(value: number);
  2521. /** Gets or sets the z coordinate */
  2522. get z(): number;
  2523. set z(value: number);
  2524. /**
  2525. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  2526. * @param x defines the first coordinates (on X axis)
  2527. * @param y defines the second coordinates (on Y axis)
  2528. * @param z defines the third coordinates (on Z axis)
  2529. */
  2530. constructor(x?: number, y?: number, z?: number);
  2531. /**
  2532. * Creates a string representation of the Vector3
  2533. * @returns a string with the Vector3 coordinates.
  2534. */
  2535. toString(): string;
  2536. /**
  2537. * Gets the class name
  2538. * @returns the string "Vector3"
  2539. */
  2540. getClassName(): string;
  2541. /**
  2542. * Creates the Vector3 hash code
  2543. * @returns a number which tends to be unique between Vector3 instances
  2544. */
  2545. getHashCode(): number;
  2546. /**
  2547. * Creates an array containing three elements : the coordinates of the Vector3
  2548. * @returns a new array of numbers
  2549. */
  2550. asArray(): number[];
  2551. /**
  2552. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  2553. * @param array defines the destination array
  2554. * @param index defines the offset in the destination array
  2555. * @returns the current Vector3
  2556. */
  2557. toArray(array: FloatArray, index?: number): Vector3;
  2558. /**
  2559. * Update the current vector from an array
  2560. * @param array defines the destination array
  2561. * @param index defines the offset in the destination array
  2562. * @returns the current Vector3
  2563. */
  2564. fromArray(array: FloatArray, index?: number): Vector3;
  2565. /**
  2566. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  2567. * @returns a new Quaternion object, computed from the Vector3 coordinates
  2568. */
  2569. toQuaternion(): Quaternion;
  2570. /**
  2571. * Adds the given vector to the current Vector3
  2572. * @param otherVector defines the second operand
  2573. * @returns the current updated Vector3
  2574. */
  2575. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2576. /**
  2577. * Adds the given coordinates to the current Vector3
  2578. * @param x defines the x coordinate of the operand
  2579. * @param y defines the y coordinate of the operand
  2580. * @param z defines the z coordinate of the operand
  2581. * @returns the current updated Vector3
  2582. */
  2583. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2584. /**
  2585. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  2586. * @param otherVector defines the second operand
  2587. * @returns the resulting Vector3
  2588. */
  2589. add(otherVector: DeepImmutable<Vector3>): Vector3;
  2590. /**
  2591. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  2592. * @param otherVector defines the second operand
  2593. * @param result defines the Vector3 object where to store the result
  2594. * @returns the current Vector3
  2595. */
  2596. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2597. /**
  2598. * Subtract the given vector from the current Vector3
  2599. * @param otherVector defines the second operand
  2600. * @returns the current updated Vector3
  2601. */
  2602. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2603. /**
  2604. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  2605. * @param otherVector defines the second operand
  2606. * @returns the resulting Vector3
  2607. */
  2608. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  2609. /**
  2610. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  2611. * @param otherVector defines the second operand
  2612. * @param result defines the Vector3 object where to store the result
  2613. * @returns the current Vector3
  2614. */
  2615. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2616. /**
  2617. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  2618. * @param x defines the x coordinate of the operand
  2619. * @param y defines the y coordinate of the operand
  2620. * @param z defines the z coordinate of the operand
  2621. * @returns the resulting Vector3
  2622. */
  2623. subtractFromFloats(x: number, y: number, z: number): Vector3;
  2624. /**
  2625. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  2626. * @param x defines the x coordinate of the operand
  2627. * @param y defines the y coordinate of the operand
  2628. * @param z defines the z coordinate of the operand
  2629. * @param result defines the Vector3 object where to store the result
  2630. * @returns the current Vector3
  2631. */
  2632. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  2633. /**
  2634. * Gets a new Vector3 set with the current Vector3 negated coordinates
  2635. * @returns a new Vector3
  2636. */
  2637. negate(): Vector3;
  2638. /**
  2639. * Negate this vector in place
  2640. * @returns this
  2641. */
  2642. negateInPlace(): Vector3;
  2643. /**
  2644. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  2645. * @param result defines the Vector3 object where to store the result
  2646. * @returns the current Vector3
  2647. */
  2648. negateToRef(result: Vector3): Vector3;
  2649. /**
  2650. * Multiplies the Vector3 coordinates by the float "scale"
  2651. * @param scale defines the multiplier factor
  2652. * @returns the current updated Vector3
  2653. */
  2654. scaleInPlace(scale: number): Vector3;
  2655. /**
  2656. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  2657. * @param scale defines the multiplier factor
  2658. * @returns a new Vector3
  2659. */
  2660. scale(scale: number): Vector3;
  2661. /**
  2662. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  2663. * @param scale defines the multiplier factor
  2664. * @param result defines the Vector3 object where to store the result
  2665. * @returns the current Vector3
  2666. */
  2667. scaleToRef(scale: number, result: Vector3): Vector3;
  2668. /**
  2669. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  2670. * @param scale defines the scale factor
  2671. * @param result defines the Vector3 object where to store the result
  2672. * @returns the unmodified current Vector3
  2673. */
  2674. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  2675. /**
  2676. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  2677. * @param origin defines the origin of the projection ray
  2678. * @param plane defines the plane to project to
  2679. * @returns the projected vector3
  2680. */
  2681. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  2682. /**
  2683. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  2684. * @param origin defines the origin of the projection ray
  2685. * @param plane defines the plane to project to
  2686. * @param result defines the Vector3 where to store the result
  2687. */
  2688. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  2689. /**
  2690. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  2691. * @param otherVector defines the second operand
  2692. * @returns true if both vectors are equals
  2693. */
  2694. equals(otherVector: DeepImmutable<Vector3>): boolean;
  2695. /**
  2696. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  2697. * @param otherVector defines the second operand
  2698. * @param epsilon defines the minimal distance to define values as equals
  2699. * @returns true if both vectors are distant less than epsilon
  2700. */
  2701. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  2702. /**
  2703. * Returns true if the current Vector3 coordinates equals the given floats
  2704. * @param x defines the x coordinate of the operand
  2705. * @param y defines the y coordinate of the operand
  2706. * @param z defines the z coordinate of the operand
  2707. * @returns true if both vectors are equals
  2708. */
  2709. equalsToFloats(x: number, y: number, z: number): boolean;
  2710. /**
  2711. * Multiplies the current Vector3 coordinates by the given ones
  2712. * @param otherVector defines the second operand
  2713. * @returns the current updated Vector3
  2714. */
  2715. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2716. /**
  2717. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  2718. * @param otherVector defines the second operand
  2719. * @returns the new Vector3
  2720. */
  2721. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  2722. /**
  2723. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  2724. * @param otherVector defines the second operand
  2725. * @param result defines the Vector3 object where to store the result
  2726. * @returns the current Vector3
  2727. */
  2728. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2729. /**
  2730. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  2731. * @param x defines the x coordinate of the operand
  2732. * @param y defines the y coordinate of the operand
  2733. * @param z defines the z coordinate of the operand
  2734. * @returns the new Vector3
  2735. */
  2736. multiplyByFloats(x: number, y: number, z: number): Vector3;
  2737. /**
  2738. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  2739. * @param otherVector defines the second operand
  2740. * @returns the new Vector3
  2741. */
  2742. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  2743. /**
  2744. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  2745. * @param otherVector defines the second operand
  2746. * @param result defines the Vector3 object where to store the result
  2747. * @returns the current Vector3
  2748. */
  2749. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2750. /**
  2751. * Divides the current Vector3 coordinates by the given ones.
  2752. * @param otherVector defines the second operand
  2753. * @returns the current updated Vector3
  2754. */
  2755. divideInPlace(otherVector: Vector3): Vector3;
  2756. /**
  2757. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  2758. * @param other defines the second operand
  2759. * @returns the current updated Vector3
  2760. */
  2761. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2762. /**
  2763. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  2764. * @param other defines the second operand
  2765. * @returns the current updated Vector3
  2766. */
  2767. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2768. /**
  2769. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  2770. * @param x defines the x coordinate of the operand
  2771. * @param y defines the y coordinate of the operand
  2772. * @param z defines the z coordinate of the operand
  2773. * @returns the current updated Vector3
  2774. */
  2775. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2776. /**
  2777. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  2778. * @param x defines the x coordinate of the operand
  2779. * @param y defines the y coordinate of the operand
  2780. * @param z defines the z coordinate of the operand
  2781. * @returns the current updated Vector3
  2782. */
  2783. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2784. /**
  2785. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  2786. * Check if is non uniform within a certain amount of decimal places to account for this
  2787. * @param epsilon the amount the values can differ
  2788. * @returns if the the vector is non uniform to a certain number of decimal places
  2789. */
  2790. isNonUniformWithinEpsilon(epsilon: number): boolean;
  2791. /**
  2792. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  2793. */
  2794. get isNonUniform(): boolean;
  2795. /**
  2796. * Gets a new Vector3 from current Vector3 floored values
  2797. * @returns a new Vector3
  2798. */
  2799. floor(): Vector3;
  2800. /**
  2801. * Gets a new Vector3 from current Vector3 floored values
  2802. * @returns a new Vector3
  2803. */
  2804. fract(): Vector3;
  2805. /**
  2806. * Gets the length of the Vector3
  2807. * @returns the length of the Vector3
  2808. */
  2809. length(): number;
  2810. /**
  2811. * Gets the squared length of the Vector3
  2812. * @returns squared length of the Vector3
  2813. */
  2814. lengthSquared(): number;
  2815. /**
  2816. * Normalize the current Vector3.
  2817. * Please note that this is an in place operation.
  2818. * @returns the current updated Vector3
  2819. */
  2820. normalize(): Vector3;
  2821. /**
  2822. * Reorders the x y z properties of the vector in place
  2823. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  2824. * @returns the current updated vector
  2825. */
  2826. reorderInPlace(order: string): this;
  2827. /**
  2828. * Rotates the vector around 0,0,0 by a quaternion
  2829. * @param quaternion the rotation quaternion
  2830. * @param result vector to store the result
  2831. * @returns the resulting vector
  2832. */
  2833. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  2834. /**
  2835. * Rotates a vector around a given point
  2836. * @param quaternion the rotation quaternion
  2837. * @param point the point to rotate around
  2838. * @param result vector to store the result
  2839. * @returns the resulting vector
  2840. */
  2841. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  2842. /**
  2843. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  2844. * The cross product is then orthogonal to both current and "other"
  2845. * @param other defines the right operand
  2846. * @returns the cross product
  2847. */
  2848. cross(other: Vector3): Vector3;
  2849. /**
  2850. * Normalize the current Vector3 with the given input length.
  2851. * Please note that this is an in place operation.
  2852. * @param len the length of the vector
  2853. * @returns the current updated Vector3
  2854. */
  2855. normalizeFromLength(len: number): Vector3;
  2856. /**
  2857. * Normalize the current Vector3 to a new vector
  2858. * @returns the new Vector3
  2859. */
  2860. normalizeToNew(): Vector3;
  2861. /**
  2862. * Normalize the current Vector3 to the reference
  2863. * @param reference define the Vector3 to update
  2864. * @returns the updated Vector3
  2865. */
  2866. normalizeToRef(reference: Vector3): Vector3;
  2867. /**
  2868. * Creates a new Vector3 copied from the current Vector3
  2869. * @returns the new Vector3
  2870. */
  2871. clone(): Vector3;
  2872. /**
  2873. * Copies the given vector coordinates to the current Vector3 ones
  2874. * @param source defines the source Vector3
  2875. * @returns the current updated Vector3
  2876. */
  2877. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  2878. /**
  2879. * Copies the given floats to the current Vector3 coordinates
  2880. * @param x defines the x coordinate of the operand
  2881. * @param y defines the y coordinate of the operand
  2882. * @param z defines the z coordinate of the operand
  2883. * @returns the current updated Vector3
  2884. */
  2885. copyFromFloats(x: number, y: number, z: number): Vector3;
  2886. /**
  2887. * Copies the given floats to the current Vector3 coordinates
  2888. * @param x defines the x coordinate of the operand
  2889. * @param y defines the y coordinate of the operand
  2890. * @param z defines the z coordinate of the operand
  2891. * @returns the current updated Vector3
  2892. */
  2893. set(x: number, y: number, z: number): Vector3;
  2894. /**
  2895. * Copies the given float to the current Vector3 coordinates
  2896. * @param v defines the x, y and z coordinates of the operand
  2897. * @returns the current updated Vector3
  2898. */
  2899. setAll(v: number): Vector3;
  2900. /**
  2901. * Get the clip factor between two vectors
  2902. * @param vector0 defines the first operand
  2903. * @param vector1 defines the second operand
  2904. * @param axis defines the axis to use
  2905. * @param size defines the size along the axis
  2906. * @returns the clip factor
  2907. */
  2908. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  2909. /**
  2910. * Get angle between two vectors
  2911. * @param vector0 angle between vector0 and vector1
  2912. * @param vector1 angle between vector0 and vector1
  2913. * @param normal direction of the normal
  2914. * @return the angle between vector0 and vector1
  2915. */
  2916. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  2917. /**
  2918. * Returns a new Vector3 set from the index "offset" of the given array
  2919. * @param array defines the source array
  2920. * @param offset defines the offset in the source array
  2921. * @returns the new Vector3
  2922. */
  2923. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  2924. /**
  2925. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  2926. * @param array defines the source array
  2927. * @param offset defines the offset in the source array
  2928. * @returns the new Vector3
  2929. * @deprecated Please use FromArray instead.
  2930. */
  2931. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  2932. /**
  2933. * Sets the given vector "result" with the element values from the index "offset" of the given array
  2934. * @param array defines the source array
  2935. * @param offset defines the offset in the source array
  2936. * @param result defines the Vector3 where to store the result
  2937. */
  2938. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  2939. /**
  2940. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  2941. * @param array defines the source array
  2942. * @param offset defines the offset in the source array
  2943. * @param result defines the Vector3 where to store the result
  2944. * @deprecated Please use FromArrayToRef instead.
  2945. */
  2946. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  2947. /**
  2948. * Sets the given vector "result" with the given floats.
  2949. * @param x defines the x coordinate of the source
  2950. * @param y defines the y coordinate of the source
  2951. * @param z defines the z coordinate of the source
  2952. * @param result defines the Vector3 where to store the result
  2953. */
  2954. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  2955. /**
  2956. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  2957. * @returns a new empty Vector3
  2958. */
  2959. static Zero(): Vector3;
  2960. /**
  2961. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  2962. * @returns a new unit Vector3
  2963. */
  2964. static One(): Vector3;
  2965. /**
  2966. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  2967. * @returns a new up Vector3
  2968. */
  2969. static Up(): Vector3;
  2970. /**
  2971. * Gets a up Vector3 that must not be updated
  2972. */
  2973. static get UpReadOnly(): DeepImmutable<Vector3>;
  2974. /**
  2975. * Gets a zero Vector3 that must not be updated
  2976. */
  2977. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  2978. /**
  2979. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  2980. * @returns a new down Vector3
  2981. */
  2982. static Down(): Vector3;
  2983. /**
  2984. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  2985. * @param rightHandedSystem is the scene right-handed (negative z)
  2986. * @returns a new forward Vector3
  2987. */
  2988. static Forward(rightHandedSystem?: boolean): Vector3;
  2989. /**
  2990. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  2991. * @param rightHandedSystem is the scene right-handed (negative-z)
  2992. * @returns a new forward Vector3
  2993. */
  2994. static Backward(rightHandedSystem?: boolean): Vector3;
  2995. /**
  2996. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  2997. * @returns a new right Vector3
  2998. */
  2999. static Right(): Vector3;
  3000. /**
  3001. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  3002. * @returns a new left Vector3
  3003. */
  3004. static Left(): Vector3;
  3005. /**
  3006. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  3007. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  3008. * @param vector defines the Vector3 to transform
  3009. * @param transformation defines the transformation matrix
  3010. * @returns the transformed Vector3
  3011. */
  3012. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  3013. /**
  3014. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  3015. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  3016. * @param vector defines the Vector3 to transform
  3017. * @param transformation defines the transformation matrix
  3018. * @param result defines the Vector3 where to store the result
  3019. */
  3020. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3021. /**
  3022. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  3023. * This method computes tranformed coordinates only, not transformed direction vectors
  3024. * @param x define the x coordinate of the source vector
  3025. * @param y define the y coordinate of the source vector
  3026. * @param z define the z coordinate of the source vector
  3027. * @param transformation defines the transformation matrix
  3028. * @param result defines the Vector3 where to store the result
  3029. */
  3030. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3031. /**
  3032. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  3033. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3034. * @param vector defines the Vector3 to transform
  3035. * @param transformation defines the transformation matrix
  3036. * @returns the new Vector3
  3037. */
  3038. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  3039. /**
  3040. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  3041. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3042. * @param vector defines the Vector3 to transform
  3043. * @param transformation defines the transformation matrix
  3044. * @param result defines the Vector3 where to store the result
  3045. */
  3046. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3047. /**
  3048. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  3049. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3050. * @param x define the x coordinate of the source vector
  3051. * @param y define the y coordinate of the source vector
  3052. * @param z define the z coordinate of the source vector
  3053. * @param transformation defines the transformation matrix
  3054. * @param result defines the Vector3 where to store the result
  3055. */
  3056. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3057. /**
  3058. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  3059. * @param value1 defines the first control point
  3060. * @param value2 defines the second control point
  3061. * @param value3 defines the third control point
  3062. * @param value4 defines the fourth control point
  3063. * @param amount defines the amount on the spline to use
  3064. * @returns the new Vector3
  3065. */
  3066. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  3067. /**
  3068. * 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"
  3069. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3070. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3071. * @param value defines the current value
  3072. * @param min defines the lower range value
  3073. * @param max defines the upper range value
  3074. * @returns the new Vector3
  3075. */
  3076. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  3077. /**
  3078. * 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"
  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. * @param result defines the Vector3 where to store the result
  3085. */
  3086. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  3087. /**
  3088. * Checks if a given vector is inside a specific range
  3089. * @param v defines the vector to test
  3090. * @param min defines the minimum range
  3091. * @param max defines the maximum range
  3092. */
  3093. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  3094. /**
  3095. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  3096. * @param value1 defines the first control point
  3097. * @param tangent1 defines the first tangent vector
  3098. * @param value2 defines the second control point
  3099. * @param tangent2 defines the second tangent vector
  3100. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  3101. * @returns the new Vector3
  3102. */
  3103. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  3104. /**
  3105. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  3106. * @param start defines the start value
  3107. * @param end defines the end value
  3108. * @param amount max defines amount between both (between 0 and 1)
  3109. * @returns the new Vector3
  3110. */
  3111. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  3112. /**
  3113. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  3114. * @param start defines the start value
  3115. * @param end defines the end value
  3116. * @param amount max defines amount between both (between 0 and 1)
  3117. * @param result defines the Vector3 where to store the result
  3118. */
  3119. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  3120. /**
  3121. * Returns the dot product (float) between the vectors "left" and "right"
  3122. * @param left defines the left operand
  3123. * @param right defines the right operand
  3124. * @returns the dot product
  3125. */
  3126. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  3127. /**
  3128. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  3129. * The cross product is then orthogonal to both "left" and "right"
  3130. * @param left defines the left operand
  3131. * @param right defines the right operand
  3132. * @returns the cross product
  3133. */
  3134. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3135. /**
  3136. * Sets the given vector "result" with the cross product of "left" and "right"
  3137. * The cross product is then orthogonal to both "left" and "right"
  3138. * @param left defines the left operand
  3139. * @param right defines the right operand
  3140. * @param result defines the Vector3 where to store the result
  3141. */
  3142. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  3143. /**
  3144. * Returns a new Vector3 as the normalization of the given vector
  3145. * @param vector defines the Vector3 to normalize
  3146. * @returns the new Vector3
  3147. */
  3148. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  3149. /**
  3150. * Sets the given vector "result" with the normalization of the given first vector
  3151. * @param vector defines the Vector3 to normalize
  3152. * @param result defines the Vector3 where to store the result
  3153. */
  3154. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  3155. /**
  3156. * Project a Vector3 onto screen space
  3157. * @param vector defines the Vector3 to project
  3158. * @param world defines the world matrix to use
  3159. * @param transform defines the transform (view x projection) matrix to use
  3160. * @param viewport defines the screen viewport to use
  3161. * @returns the new Vector3
  3162. */
  3163. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  3164. /** @hidden */
  3165. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  3166. /**
  3167. * Unproject from screen space to object space
  3168. * @param source defines the screen space Vector3 to use
  3169. * @param viewportWidth defines the current width of the viewport
  3170. * @param viewportHeight defines the current height of the viewport
  3171. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3172. * @param transform defines the transform (view x projection) matrix to use
  3173. * @returns the new Vector3
  3174. */
  3175. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  3176. /**
  3177. * Unproject from screen space to object space
  3178. * @param source defines the screen space Vector3 to use
  3179. * @param viewportWidth defines the current width of the viewport
  3180. * @param viewportHeight defines the current height of the viewport
  3181. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3182. * @param view defines the view matrix to use
  3183. * @param projection defines the projection matrix to use
  3184. * @returns the new Vector3
  3185. */
  3186. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  3187. /**
  3188. * Unproject from screen space to object space
  3189. * @param source defines the screen space Vector3 to use
  3190. * @param viewportWidth defines the current width of the viewport
  3191. * @param viewportHeight defines the current height of the viewport
  3192. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3193. * @param view defines the view matrix to use
  3194. * @param projection defines the projection matrix to use
  3195. * @param result defines the Vector3 where to store the result
  3196. */
  3197. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3198. /**
  3199. * Unproject from screen space to object space
  3200. * @param sourceX defines the screen space x coordinate to use
  3201. * @param sourceY defines the screen space y coordinate to use
  3202. * @param sourceZ defines the screen space z coordinate to use
  3203. * @param viewportWidth defines the current width of the viewport
  3204. * @param viewportHeight defines the current height of the viewport
  3205. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3206. * @param view defines the view matrix to use
  3207. * @param projection defines the projection matrix to use
  3208. * @param result defines the Vector3 where to store the result
  3209. */
  3210. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3211. /**
  3212. * Gets the minimal coordinate values between two Vector3
  3213. * @param left defines the first operand
  3214. * @param right defines the second operand
  3215. * @returns the new Vector3
  3216. */
  3217. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3218. /**
  3219. * Gets the maximal coordinate values between two Vector3
  3220. * @param left defines the first operand
  3221. * @param right defines the second operand
  3222. * @returns the new Vector3
  3223. */
  3224. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3225. /**
  3226. * Returns the distance between the vectors "value1" and "value2"
  3227. * @param value1 defines the first operand
  3228. * @param value2 defines the second operand
  3229. * @returns the distance
  3230. */
  3231. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3232. /**
  3233. * Returns the squared distance between the vectors "value1" and "value2"
  3234. * @param value1 defines the first operand
  3235. * @param value2 defines the second operand
  3236. * @returns the squared distance
  3237. */
  3238. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3239. /**
  3240. * Returns a new Vector3 located at the center between "value1" and "value2"
  3241. * @param value1 defines the first operand
  3242. * @param value2 defines the second operand
  3243. * @returns the new Vector3
  3244. */
  3245. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  3246. /**
  3247. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  3248. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  3249. * to something in order to rotate it from its local system to the given target system
  3250. * Note: axis1, axis2 and axis3 are normalized during this operation
  3251. * @param axis1 defines the first axis
  3252. * @param axis2 defines the second axis
  3253. * @param axis3 defines the third axis
  3254. * @returns a new Vector3
  3255. */
  3256. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  3257. /**
  3258. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  3259. * @param axis1 defines the first axis
  3260. * @param axis2 defines the second axis
  3261. * @param axis3 defines the third axis
  3262. * @param ref defines the Vector3 where to store the result
  3263. */
  3264. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  3265. }
  3266. /**
  3267. * Vector4 class created for EulerAngle class conversion to Quaternion
  3268. */
  3269. export class Vector4 {
  3270. /** x value of the vector */
  3271. x: number;
  3272. /** y value of the vector */
  3273. y: number;
  3274. /** z value of the vector */
  3275. z: number;
  3276. /** w value of the vector */
  3277. w: number;
  3278. /**
  3279. * Creates a Vector4 object from the given floats.
  3280. * @param x x value of the vector
  3281. * @param y y value of the vector
  3282. * @param z z value of the vector
  3283. * @param w w value of the vector
  3284. */
  3285. constructor(
  3286. /** x value of the vector */
  3287. x: number,
  3288. /** y value of the vector */
  3289. y: number,
  3290. /** z value of the vector */
  3291. z: number,
  3292. /** w value of the vector */
  3293. w: number);
  3294. /**
  3295. * Returns the string with the Vector4 coordinates.
  3296. * @returns a string containing all the vector values
  3297. */
  3298. toString(): string;
  3299. /**
  3300. * Returns the string "Vector4".
  3301. * @returns "Vector4"
  3302. */
  3303. getClassName(): string;
  3304. /**
  3305. * Returns the Vector4 hash code.
  3306. * @returns a unique hash code
  3307. */
  3308. getHashCode(): number;
  3309. /**
  3310. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  3311. * @returns the resulting array
  3312. */
  3313. asArray(): number[];
  3314. /**
  3315. * Populates the given array from the given index with the Vector4 coordinates.
  3316. * @param array array to populate
  3317. * @param index index of the array to start at (default: 0)
  3318. * @returns the Vector4.
  3319. */
  3320. toArray(array: FloatArray, index?: number): Vector4;
  3321. /**
  3322. * Update the current vector from an array
  3323. * @param array defines the destination array
  3324. * @param index defines the offset in the destination array
  3325. * @returns the current Vector3
  3326. */
  3327. fromArray(array: FloatArray, index?: number): Vector4;
  3328. /**
  3329. * Adds the given vector to the current Vector4.
  3330. * @param otherVector the vector to add
  3331. * @returns the updated Vector4.
  3332. */
  3333. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3334. /**
  3335. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  3336. * @param otherVector the vector to add
  3337. * @returns the resulting vector
  3338. */
  3339. add(otherVector: DeepImmutable<Vector4>): Vector4;
  3340. /**
  3341. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  3342. * @param otherVector the vector to add
  3343. * @param result the vector to store the result
  3344. * @returns the current Vector4.
  3345. */
  3346. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3347. /**
  3348. * Subtract in place the given vector from the current Vector4.
  3349. * @param otherVector the vector to subtract
  3350. * @returns the updated Vector4.
  3351. */
  3352. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3353. /**
  3354. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  3355. * @param otherVector the vector to add
  3356. * @returns the new vector with the result
  3357. */
  3358. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  3359. /**
  3360. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  3361. * @param otherVector the vector to subtract
  3362. * @param result the vector to store the result
  3363. * @returns the current Vector4.
  3364. */
  3365. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3366. /**
  3367. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3368. */
  3369. /**
  3370. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3371. * @param x value to subtract
  3372. * @param y value to subtract
  3373. * @param z value to subtract
  3374. * @param w value to subtract
  3375. * @returns new vector containing the result
  3376. */
  3377. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3378. /**
  3379. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3380. * @param x value to subtract
  3381. * @param y value to subtract
  3382. * @param z value to subtract
  3383. * @param w value to subtract
  3384. * @param result the vector to store the result in
  3385. * @returns the current Vector4.
  3386. */
  3387. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  3388. /**
  3389. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  3390. * @returns a new vector with the negated values
  3391. */
  3392. negate(): Vector4;
  3393. /**
  3394. * Negate this vector in place
  3395. * @returns this
  3396. */
  3397. negateInPlace(): Vector4;
  3398. /**
  3399. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  3400. * @param result defines the Vector3 object where to store the result
  3401. * @returns the current Vector4
  3402. */
  3403. negateToRef(result: Vector4): Vector4;
  3404. /**
  3405. * Multiplies the current Vector4 coordinates by scale (float).
  3406. * @param scale the number to scale with
  3407. * @returns the updated Vector4.
  3408. */
  3409. scaleInPlace(scale: number): Vector4;
  3410. /**
  3411. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  3412. * @param scale the number to scale with
  3413. * @returns a new vector with the result
  3414. */
  3415. scale(scale: number): Vector4;
  3416. /**
  3417. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  3418. * @param scale the number to scale with
  3419. * @param result a vector to store the result in
  3420. * @returns the current Vector4.
  3421. */
  3422. scaleToRef(scale: number, result: Vector4): Vector4;
  3423. /**
  3424. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  3425. * @param scale defines the scale factor
  3426. * @param result defines the Vector4 object where to store the result
  3427. * @returns the unmodified current Vector4
  3428. */
  3429. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  3430. /**
  3431. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  3432. * @param otherVector the vector to compare against
  3433. * @returns true if they are equal
  3434. */
  3435. equals(otherVector: DeepImmutable<Vector4>): boolean;
  3436. /**
  3437. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  3438. * @param otherVector vector to compare against
  3439. * @param epsilon (Default: very small number)
  3440. * @returns true if they are equal
  3441. */
  3442. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  3443. /**
  3444. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  3445. * @param x x value to compare against
  3446. * @param y y value to compare against
  3447. * @param z z value to compare against
  3448. * @param w w value to compare against
  3449. * @returns true if equal
  3450. */
  3451. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  3452. /**
  3453. * Multiplies in place the current Vector4 by the given one.
  3454. * @param otherVector vector to multiple with
  3455. * @returns the updated Vector4.
  3456. */
  3457. multiplyInPlace(otherVector: Vector4): Vector4;
  3458. /**
  3459. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  3460. * @param otherVector vector to multiple with
  3461. * @returns resulting new vector
  3462. */
  3463. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  3464. /**
  3465. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  3466. * @param otherVector vector to multiple with
  3467. * @param result vector to store the result
  3468. * @returns the current Vector4.
  3469. */
  3470. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3471. /**
  3472. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  3473. * @param x x value multiply with
  3474. * @param y y value multiply with
  3475. * @param z z value multiply with
  3476. * @param w w value multiply with
  3477. * @returns resulting new vector
  3478. */
  3479. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  3480. /**
  3481. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  3482. * @param otherVector vector to devide with
  3483. * @returns resulting new vector
  3484. */
  3485. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  3486. /**
  3487. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  3488. * @param otherVector vector to devide with
  3489. * @param result vector to store the result
  3490. * @returns the current Vector4.
  3491. */
  3492. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3493. /**
  3494. * Divides the current Vector3 coordinates by the given ones.
  3495. * @param otherVector vector to devide with
  3496. * @returns the updated Vector3.
  3497. */
  3498. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3499. /**
  3500. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  3501. * @param other defines the second operand
  3502. * @returns the current updated Vector4
  3503. */
  3504. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3505. /**
  3506. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  3507. * @param other defines the second operand
  3508. * @returns the current updated Vector4
  3509. */
  3510. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3511. /**
  3512. * Gets a new Vector4 from current Vector4 floored values
  3513. * @returns a new Vector4
  3514. */
  3515. floor(): Vector4;
  3516. /**
  3517. * Gets a new Vector4 from current Vector3 floored values
  3518. * @returns a new Vector4
  3519. */
  3520. fract(): Vector4;
  3521. /**
  3522. * Returns the Vector4 length (float).
  3523. * @returns the length
  3524. */
  3525. length(): number;
  3526. /**
  3527. * Returns the Vector4 squared length (float).
  3528. * @returns the length squared
  3529. */
  3530. lengthSquared(): number;
  3531. /**
  3532. * Normalizes in place the Vector4.
  3533. * @returns the updated Vector4.
  3534. */
  3535. normalize(): Vector4;
  3536. /**
  3537. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  3538. * @returns this converted to a new vector3
  3539. */
  3540. toVector3(): Vector3;
  3541. /**
  3542. * Returns a new Vector4 copied from the current one.
  3543. * @returns the new cloned vector
  3544. */
  3545. clone(): Vector4;
  3546. /**
  3547. * Updates the current Vector4 with the given one coordinates.
  3548. * @param source the source vector to copy from
  3549. * @returns the updated Vector4.
  3550. */
  3551. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  3552. /**
  3553. * Updates the current Vector4 coordinates with the given floats.
  3554. * @param x float to copy from
  3555. * @param y float to copy from
  3556. * @param z float to copy from
  3557. * @param w float to copy from
  3558. * @returns the updated Vector4.
  3559. */
  3560. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3561. /**
  3562. * Updates the current Vector4 coordinates with the given floats.
  3563. * @param x float to set from
  3564. * @param y float to set from
  3565. * @param z float to set from
  3566. * @param w float to set from
  3567. * @returns the updated Vector4.
  3568. */
  3569. set(x: number, y: number, z: number, w: number): Vector4;
  3570. /**
  3571. * Copies the given float to the current Vector3 coordinates
  3572. * @param v defines the x, y, z and w coordinates of the operand
  3573. * @returns the current updated Vector3
  3574. */
  3575. setAll(v: number): Vector4;
  3576. /**
  3577. * Returns a new Vector4 set from the starting index of the given array.
  3578. * @param array the array to pull values from
  3579. * @param offset the offset into the array to start at
  3580. * @returns the new vector
  3581. */
  3582. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  3583. /**
  3584. * Updates the given vector "result" from the starting index of the given array.
  3585. * @param array the array to pull values from
  3586. * @param offset the offset into the array to start at
  3587. * @param result the vector to store the result in
  3588. */
  3589. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  3590. /**
  3591. * Updates the given vector "result" from the starting index of the given Float32Array.
  3592. * @param array the array to pull values from
  3593. * @param offset the offset into the array to start at
  3594. * @param result the vector to store the result in
  3595. */
  3596. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  3597. /**
  3598. * Updates the given vector "result" coordinates from the given floats.
  3599. * @param x float to set from
  3600. * @param y float to set from
  3601. * @param z float to set from
  3602. * @param w float to set from
  3603. * @param result the vector to the floats in
  3604. */
  3605. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  3606. /**
  3607. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  3608. * @returns the new vector
  3609. */
  3610. static Zero(): Vector4;
  3611. /**
  3612. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  3613. * @returns the new vector
  3614. */
  3615. static One(): Vector4;
  3616. /**
  3617. * Returns a new normalized Vector4 from the given one.
  3618. * @param vector the vector to normalize
  3619. * @returns the vector
  3620. */
  3621. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  3622. /**
  3623. * Updates the given vector "result" from the normalization of the given one.
  3624. * @param vector the vector to normalize
  3625. * @param result the vector to store the result in
  3626. */
  3627. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  3628. /**
  3629. * Returns a vector with the minimum values from the left and right vectors
  3630. * @param left left vector to minimize
  3631. * @param right right vector to minimize
  3632. * @returns a new vector with the minimum of the left and right vector values
  3633. */
  3634. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3635. /**
  3636. * Returns a vector with the maximum values from the left and right vectors
  3637. * @param left left vector to maximize
  3638. * @param right right vector to maximize
  3639. * @returns a new vector with the maximum of the left and right vector values
  3640. */
  3641. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3642. /**
  3643. * Returns the distance (float) between the vectors "value1" and "value2".
  3644. * @param value1 value to calulate the distance between
  3645. * @param value2 value to calulate the distance between
  3646. * @return the distance between the two vectors
  3647. */
  3648. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3649. /**
  3650. * Returns the squared distance (float) between the vectors "value1" and "value2".
  3651. * @param value1 value to calulate the distance between
  3652. * @param value2 value to calulate the distance between
  3653. * @return the distance between the two vectors squared
  3654. */
  3655. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3656. /**
  3657. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  3658. * @param value1 value to calulate the center between
  3659. * @param value2 value to calulate the center between
  3660. * @return the center between the two vectors
  3661. */
  3662. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  3663. /**
  3664. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  3665. * This methods computes transformed normalized direction vectors only.
  3666. * @param vector the vector to transform
  3667. * @param transformation the transformation matrix to apply
  3668. * @returns the new vector
  3669. */
  3670. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  3671. /**
  3672. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  3673. * This methods computes transformed normalized direction vectors only.
  3674. * @param vector the vector to transform
  3675. * @param transformation the transformation matrix to apply
  3676. * @param result the vector to store the result in
  3677. */
  3678. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3679. /**
  3680. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  3681. * This methods computes transformed normalized direction vectors only.
  3682. * @param x value to transform
  3683. * @param y value to transform
  3684. * @param z value to transform
  3685. * @param w value to transform
  3686. * @param transformation the transformation matrix to apply
  3687. * @param result the vector to store the results in
  3688. */
  3689. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3690. /**
  3691. * Creates a new Vector4 from a Vector3
  3692. * @param source defines the source data
  3693. * @param w defines the 4th component (default is 0)
  3694. * @returns a new Vector4
  3695. */
  3696. static FromVector3(source: Vector3, w?: number): Vector4;
  3697. }
  3698. /**
  3699. * Class used to store quaternion data
  3700. * @see https://en.wikipedia.org/wiki/Quaternion
  3701. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  3702. */
  3703. export class Quaternion {
  3704. /** @hidden */
  3705. _x: number;
  3706. /** @hidden */
  3707. _y: number;
  3708. /** @hidden */
  3709. _z: number;
  3710. /** @hidden */
  3711. _w: number;
  3712. /** @hidden */
  3713. _isDirty: boolean;
  3714. /** Gets or sets the x coordinate */
  3715. get x(): number;
  3716. set x(value: number);
  3717. /** Gets or sets the y coordinate */
  3718. get y(): number;
  3719. set y(value: number);
  3720. /** Gets or sets the z coordinate */
  3721. get z(): number;
  3722. set z(value: number);
  3723. /** Gets or sets the w coordinate */
  3724. get w(): number;
  3725. set w(value: number);
  3726. /**
  3727. * Creates a new Quaternion from the given floats
  3728. * @param x defines the first component (0 by default)
  3729. * @param y defines the second component (0 by default)
  3730. * @param z defines the third component (0 by default)
  3731. * @param w defines the fourth component (1.0 by default)
  3732. */
  3733. constructor(x?: number, y?: number, z?: number, w?: number);
  3734. /**
  3735. * Gets a string representation for the current quaternion
  3736. * @returns a string with the Quaternion coordinates
  3737. */
  3738. toString(): string;
  3739. /**
  3740. * Gets the class name of the quaternion
  3741. * @returns the string "Quaternion"
  3742. */
  3743. getClassName(): string;
  3744. /**
  3745. * Gets a hash code for this quaternion
  3746. * @returns the quaternion hash code
  3747. */
  3748. getHashCode(): number;
  3749. /**
  3750. * Copy the quaternion to an array
  3751. * @returns a new array populated with 4 elements from the quaternion coordinates
  3752. */
  3753. asArray(): number[];
  3754. /**
  3755. * Check if two quaternions are equals
  3756. * @param otherQuaternion defines the second operand
  3757. * @return true if the current quaternion and the given one coordinates are strictly equals
  3758. */
  3759. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  3760. /**
  3761. * Gets a boolean if two quaternions are equals (using an epsilon value)
  3762. * @param otherQuaternion defines the other quaternion
  3763. * @param epsilon defines the minimal distance to consider equality
  3764. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  3765. */
  3766. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  3767. /**
  3768. * Clone the current quaternion
  3769. * @returns a new quaternion copied from the current one
  3770. */
  3771. clone(): Quaternion;
  3772. /**
  3773. * Copy a quaternion to the current one
  3774. * @param other defines the other quaternion
  3775. * @returns the updated current quaternion
  3776. */
  3777. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  3778. /**
  3779. * Updates the current quaternion with the given float coordinates
  3780. * @param x defines the x coordinate
  3781. * @param y defines the y coordinate
  3782. * @param z defines the z coordinate
  3783. * @param w defines the w coordinate
  3784. * @returns the updated current quaternion
  3785. */
  3786. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  3787. /**
  3788. * Updates the current quaternion from the given float coordinates
  3789. * @param x defines the x coordinate
  3790. * @param y defines the y coordinate
  3791. * @param z defines the z coordinate
  3792. * @param w defines the w coordinate
  3793. * @returns the updated current quaternion
  3794. */
  3795. set(x: number, y: number, z: number, w: number): Quaternion;
  3796. /**
  3797. * Adds two quaternions
  3798. * @param other defines the second operand
  3799. * @returns a new quaternion as the addition result of the given one and the current quaternion
  3800. */
  3801. add(other: DeepImmutable<Quaternion>): Quaternion;
  3802. /**
  3803. * Add a quaternion to the current one
  3804. * @param other defines the quaternion to add
  3805. * @returns the current quaternion
  3806. */
  3807. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  3808. /**
  3809. * Subtract two quaternions
  3810. * @param other defines the second operand
  3811. * @returns a new quaternion as the subtraction result of the given one from the current one
  3812. */
  3813. subtract(other: Quaternion): Quaternion;
  3814. /**
  3815. * Multiplies the current quaternion by a scale factor
  3816. * @param value defines the scale factor
  3817. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  3818. */
  3819. scale(value: number): Quaternion;
  3820. /**
  3821. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  3822. * @param scale defines the scale factor
  3823. * @param result defines the Quaternion object where to store the result
  3824. * @returns the unmodified current quaternion
  3825. */
  3826. scaleToRef(scale: number, result: Quaternion): Quaternion;
  3827. /**
  3828. * Multiplies in place the current quaternion by a scale factor
  3829. * @param value defines the scale factor
  3830. * @returns the current modified quaternion
  3831. */
  3832. scaleInPlace(value: number): Quaternion;
  3833. /**
  3834. * Scale the current quaternion values by a factor and add the result to a given quaternion
  3835. * @param scale defines the scale factor
  3836. * @param result defines the Quaternion object where to store the result
  3837. * @returns the unmodified current quaternion
  3838. */
  3839. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  3840. /**
  3841. * Multiplies two quaternions
  3842. * @param q1 defines the second operand
  3843. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  3844. */
  3845. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  3846. /**
  3847. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  3848. * @param q1 defines the second operand
  3849. * @param result defines the target quaternion
  3850. * @returns the current quaternion
  3851. */
  3852. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  3853. /**
  3854. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  3855. * @param q1 defines the second operand
  3856. * @returns the currentupdated quaternion
  3857. */
  3858. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  3859. /**
  3860. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  3861. * @param ref defines the target quaternion
  3862. * @returns the current quaternion
  3863. */
  3864. conjugateToRef(ref: Quaternion): Quaternion;
  3865. /**
  3866. * Conjugates in place (1-q) the current quaternion
  3867. * @returns the current updated quaternion
  3868. */
  3869. conjugateInPlace(): Quaternion;
  3870. /**
  3871. * Conjugates in place (1-q) the current quaternion
  3872. * @returns a new quaternion
  3873. */
  3874. conjugate(): Quaternion;
  3875. /**
  3876. * Gets length of current quaternion
  3877. * @returns the quaternion length (float)
  3878. */
  3879. length(): number;
  3880. /**
  3881. * Normalize in place the current quaternion
  3882. * @returns the current updated quaternion
  3883. */
  3884. normalize(): Quaternion;
  3885. /**
  3886. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  3887. * @param order is a reserved parameter and is ignored for now
  3888. * @returns a new Vector3 containing the Euler angles
  3889. */
  3890. toEulerAngles(order?: string): Vector3;
  3891. /**
  3892. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  3893. * @param result defines the vector which will be filled with the Euler angles
  3894. * @returns the current unchanged quaternion
  3895. */
  3896. toEulerAnglesToRef(result: Vector3): Quaternion;
  3897. /**
  3898. * Updates the given rotation matrix with the current quaternion values
  3899. * @param result defines the target matrix
  3900. * @returns the current unchanged quaternion
  3901. */
  3902. toRotationMatrix(result: Matrix): Quaternion;
  3903. /**
  3904. * Updates the current quaternion from the given rotation matrix values
  3905. * @param matrix defines the source matrix
  3906. * @returns the current updated quaternion
  3907. */
  3908. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3909. /**
  3910. * Creates a new quaternion from a rotation matrix
  3911. * @param matrix defines the source matrix
  3912. * @returns a new quaternion created from the given rotation matrix values
  3913. */
  3914. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3915. /**
  3916. * Updates the given quaternion with the given rotation matrix values
  3917. * @param matrix defines the source matrix
  3918. * @param result defines the target quaternion
  3919. */
  3920. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  3921. /**
  3922. * Returns the dot product (float) between the quaternions "left" and "right"
  3923. * @param left defines the left operand
  3924. * @param right defines the right operand
  3925. * @returns the dot product
  3926. */
  3927. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  3928. /**
  3929. * Checks if the two quaternions are close to each other
  3930. * @param quat0 defines the first quaternion to check
  3931. * @param quat1 defines the second quaternion to check
  3932. * @returns true if the two quaternions are close to each other
  3933. */
  3934. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  3935. /**
  3936. * Creates an empty quaternion
  3937. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  3938. */
  3939. static Zero(): Quaternion;
  3940. /**
  3941. * Inverse a given quaternion
  3942. * @param q defines the source quaternion
  3943. * @returns a new quaternion as the inverted current quaternion
  3944. */
  3945. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  3946. /**
  3947. * Inverse a given quaternion
  3948. * @param q defines the source quaternion
  3949. * @param result the quaternion the result will be stored in
  3950. * @returns the result quaternion
  3951. */
  3952. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  3953. /**
  3954. * Creates an identity quaternion
  3955. * @returns the identity quaternion
  3956. */
  3957. static Identity(): Quaternion;
  3958. /**
  3959. * Gets a boolean indicating if the given quaternion is identity
  3960. * @param quaternion defines the quaternion to check
  3961. * @returns true if the quaternion is identity
  3962. */
  3963. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  3964. /**
  3965. * Creates a quaternion from a rotation around an axis
  3966. * @param axis defines the axis to use
  3967. * @param angle defines the angle to use
  3968. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  3969. */
  3970. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  3971. /**
  3972. * Creates a rotation around an axis and stores it into the given quaternion
  3973. * @param axis defines the axis to use
  3974. * @param angle defines the angle to use
  3975. * @param result defines the target quaternion
  3976. * @returns the target quaternion
  3977. */
  3978. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  3979. /**
  3980. * Creates a new quaternion from data stored into an array
  3981. * @param array defines the data source
  3982. * @param offset defines the offset in the source array where the data starts
  3983. * @returns a new quaternion
  3984. */
  3985. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  3986. /**
  3987. * Updates the given quaternion "result" from the starting index of the given array.
  3988. * @param array the array to pull values from
  3989. * @param offset the offset into the array to start at
  3990. * @param result the quaternion to store the result in
  3991. */
  3992. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  3993. /**
  3994. * Create a quaternion from Euler rotation angles
  3995. * @param x Pitch
  3996. * @param y Yaw
  3997. * @param z Roll
  3998. * @returns the new Quaternion
  3999. */
  4000. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  4001. /**
  4002. * Updates a quaternion from Euler rotation angles
  4003. * @param x Pitch
  4004. * @param y Yaw
  4005. * @param z Roll
  4006. * @param result the quaternion to store the result
  4007. * @returns the updated quaternion
  4008. */
  4009. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  4010. /**
  4011. * Create a quaternion from Euler rotation vector
  4012. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  4013. * @returns the new Quaternion
  4014. */
  4015. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  4016. /**
  4017. * Updates a quaternion from Euler rotation vector
  4018. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  4019. * @param result the quaternion to store the result
  4020. * @returns the updated quaternion
  4021. */
  4022. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  4023. /**
  4024. * Creates a new quaternion from the given Euler float angles (y, x, z)
  4025. * @param yaw defines the rotation around Y axis
  4026. * @param pitch defines the rotation around X axis
  4027. * @param roll defines the rotation around Z axis
  4028. * @returns the new quaternion
  4029. */
  4030. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  4031. /**
  4032. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  4033. * @param yaw defines the rotation around Y axis
  4034. * @param pitch defines the rotation around X axis
  4035. * @param roll defines the rotation around Z axis
  4036. * @param result defines the target quaternion
  4037. */
  4038. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  4039. /**
  4040. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  4041. * @param alpha defines the rotation around first axis
  4042. * @param beta defines the rotation around second axis
  4043. * @param gamma defines the rotation around third axis
  4044. * @returns the new quaternion
  4045. */
  4046. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  4047. /**
  4048. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  4049. * @param alpha defines the rotation around first axis
  4050. * @param beta defines the rotation around second axis
  4051. * @param gamma defines the rotation around third axis
  4052. * @param result defines the target quaternion
  4053. */
  4054. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  4055. /**
  4056. * 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)
  4057. * @param axis1 defines the first axis
  4058. * @param axis2 defines the second axis
  4059. * @param axis3 defines the third axis
  4060. * @returns the new quaternion
  4061. */
  4062. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  4063. /**
  4064. * 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
  4065. * @param axis1 defines the first axis
  4066. * @param axis2 defines the second axis
  4067. * @param axis3 defines the third axis
  4068. * @param ref defines the target quaternion
  4069. */
  4070. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  4071. /**
  4072. * Interpolates between two quaternions
  4073. * @param left defines first quaternion
  4074. * @param right defines second quaternion
  4075. * @param amount defines the gradient to use
  4076. * @returns the new interpolated quaternion
  4077. */
  4078. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4079. /**
  4080. * Interpolates between two quaternions and stores it into a target quaternion
  4081. * @param left defines first quaternion
  4082. * @param right defines second quaternion
  4083. * @param amount defines the gradient to use
  4084. * @param result defines the target quaternion
  4085. */
  4086. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  4087. /**
  4088. * Interpolate between two quaternions using Hermite interpolation
  4089. * @param value1 defines first quaternion
  4090. * @param tangent1 defines the incoming tangent
  4091. * @param value2 defines second quaternion
  4092. * @param tangent2 defines the outgoing tangent
  4093. * @param amount defines the target quaternion
  4094. * @returns the new interpolated quaternion
  4095. */
  4096. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4097. }
  4098. /**
  4099. * Class used to store matrix data (4x4)
  4100. */
  4101. export class Matrix {
  4102. /**
  4103. * Gets the precision of matrix computations
  4104. */
  4105. static get Use64Bits(): boolean;
  4106. private static _updateFlagSeed;
  4107. private static _identityReadOnly;
  4108. private _isIdentity;
  4109. private _isIdentityDirty;
  4110. private _isIdentity3x2;
  4111. private _isIdentity3x2Dirty;
  4112. /**
  4113. * Gets the update flag of the matrix which is an unique number for the matrix.
  4114. * It will be incremented every time the matrix data change.
  4115. * You can use it to speed the comparison between two versions of the same matrix.
  4116. */
  4117. updateFlag: number;
  4118. private readonly _m;
  4119. /**
  4120. * Gets the internal data of the matrix
  4121. */
  4122. get m(): DeepImmutable<Float32Array | Array<number>>;
  4123. /** @hidden */
  4124. _markAsUpdated(): void;
  4125. /** @hidden */
  4126. private _updateIdentityStatus;
  4127. /**
  4128. * Creates an empty matrix (filled with zeros)
  4129. */
  4130. constructor();
  4131. /**
  4132. * Check if the current matrix is identity
  4133. * @returns true is the matrix is the identity matrix
  4134. */
  4135. isIdentity(): boolean;
  4136. /**
  4137. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  4138. * @returns true is the matrix is the identity matrix
  4139. */
  4140. isIdentityAs3x2(): boolean;
  4141. /**
  4142. * Gets the determinant of the matrix
  4143. * @returns the matrix determinant
  4144. */
  4145. determinant(): number;
  4146. /**
  4147. * Returns the matrix as a Float32Array or Array<number>
  4148. * @returns the matrix underlying array
  4149. */
  4150. toArray(): DeepImmutable<Float32Array | Array<number>>;
  4151. /**
  4152. * Returns the matrix as a Float32Array or Array<number>
  4153. * @returns the matrix underlying array.
  4154. */
  4155. asArray(): DeepImmutable<Float32Array | Array<number>>;
  4156. /**
  4157. * Inverts the current matrix in place
  4158. * @returns the current inverted matrix
  4159. */
  4160. invert(): Matrix;
  4161. /**
  4162. * Sets all the matrix elements to zero
  4163. * @returns the current matrix
  4164. */
  4165. reset(): Matrix;
  4166. /**
  4167. * Adds the current matrix with a second one
  4168. * @param other defines the matrix to add
  4169. * @returns a new matrix as the addition of the current matrix and the given one
  4170. */
  4171. add(other: DeepImmutable<Matrix>): Matrix;
  4172. /**
  4173. * Sets the given matrix "result" to the addition of the current matrix and the given one
  4174. * @param other defines the matrix to add
  4175. * @param result defines the target matrix
  4176. * @returns the current matrix
  4177. */
  4178. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4179. /**
  4180. * Adds in place the given matrix to the current matrix
  4181. * @param other defines the second operand
  4182. * @returns the current updated matrix
  4183. */
  4184. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  4185. /**
  4186. * Sets the given matrix to the current inverted Matrix
  4187. * @param other defines the target matrix
  4188. * @returns the unmodified current matrix
  4189. */
  4190. invertToRef(other: Matrix): Matrix;
  4191. /**
  4192. * add a value at the specified position in the current Matrix
  4193. * @param index the index of the value within the matrix. between 0 and 15.
  4194. * @param value the value to be added
  4195. * @returns the current updated matrix
  4196. */
  4197. addAtIndex(index: number, value: number): Matrix;
  4198. /**
  4199. * mutiply the specified position in the current Matrix by a value
  4200. * @param index the index of the value within the matrix. between 0 and 15.
  4201. * @param value the value to be added
  4202. * @returns the current updated matrix
  4203. */
  4204. multiplyAtIndex(index: number, value: number): Matrix;
  4205. /**
  4206. * Inserts the translation vector (using 3 floats) in the current matrix
  4207. * @param x defines the 1st component of the translation
  4208. * @param y defines the 2nd component of the translation
  4209. * @param z defines the 3rd component of the translation
  4210. * @returns the current updated matrix
  4211. */
  4212. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4213. /**
  4214. * Adds the translation vector (using 3 floats) in the current matrix
  4215. * @param x defines the 1st component of the translation
  4216. * @param y defines the 2nd component of the translation
  4217. * @param z defines the 3rd component of the translation
  4218. * @returns the current updated matrix
  4219. */
  4220. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4221. /**
  4222. * Inserts the translation vector in the current matrix
  4223. * @param vector3 defines the translation to insert
  4224. * @returns the current updated matrix
  4225. */
  4226. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  4227. /**
  4228. * Gets the translation value of the current matrix
  4229. * @returns a new Vector3 as the extracted translation from the matrix
  4230. */
  4231. getTranslation(): Vector3;
  4232. /**
  4233. * Fill a Vector3 with the extracted translation from the matrix
  4234. * @param result defines the Vector3 where to store the translation
  4235. * @returns the current matrix
  4236. */
  4237. getTranslationToRef(result: Vector3): Matrix;
  4238. /**
  4239. * Remove rotation and scaling part from the matrix
  4240. * @returns the updated matrix
  4241. */
  4242. removeRotationAndScaling(): Matrix;
  4243. /**
  4244. * Multiply two matrices
  4245. * @param other defines the second operand
  4246. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  4247. */
  4248. multiply(other: DeepImmutable<Matrix>): Matrix;
  4249. /**
  4250. * Copy the current matrix from the given one
  4251. * @param other defines the source matrix
  4252. * @returns the current updated matrix
  4253. */
  4254. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  4255. /**
  4256. * Populates the given array from the starting index with the current matrix values
  4257. * @param array defines the target array
  4258. * @param offset defines the offset in the target array where to start storing values
  4259. * @returns the current matrix
  4260. */
  4261. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  4262. /**
  4263. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  4264. * @param other defines the second operand
  4265. * @param result defines the matrix where to store the multiplication
  4266. * @returns the current matrix
  4267. */
  4268. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4269. /**
  4270. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  4271. * @param other defines the second operand
  4272. * @param result defines the array where to store the multiplication
  4273. * @param offset defines the offset in the target array where to start storing values
  4274. * @returns the current matrix
  4275. */
  4276. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  4277. /**
  4278. * Check equality between this matrix and a second one
  4279. * @param value defines the second matrix to compare
  4280. * @returns true is the current matrix and the given one values are strictly equal
  4281. */
  4282. equals(value: DeepImmutable<Matrix>): boolean;
  4283. /**
  4284. * Clone the current matrix
  4285. * @returns a new matrix from the current matrix
  4286. */
  4287. clone(): Matrix;
  4288. /**
  4289. * Returns the name of the current matrix class
  4290. * @returns the string "Matrix"
  4291. */
  4292. getClassName(): string;
  4293. /**
  4294. * Gets the hash code of the current matrix
  4295. * @returns the hash code
  4296. */
  4297. getHashCode(): number;
  4298. /**
  4299. * Decomposes the current Matrix into a translation, rotation and scaling components
  4300. * @param scale defines the scale vector3 given as a reference to update
  4301. * @param rotation defines the rotation quaternion given as a reference to update
  4302. * @param translation defines the translation vector3 given as a reference to update
  4303. * @returns true if operation was successful
  4304. */
  4305. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  4306. /**
  4307. * Gets specific row of the matrix
  4308. * @param index defines the number of the row to get
  4309. * @returns the index-th row of the current matrix as a new Vector4
  4310. */
  4311. getRow(index: number): Nullable<Vector4>;
  4312. /**
  4313. * Sets the index-th row of the current matrix to the vector4 values
  4314. * @param index defines the number of the row to set
  4315. * @param row defines the target vector4
  4316. * @returns the updated current matrix
  4317. */
  4318. setRow(index: number, row: Vector4): Matrix;
  4319. /**
  4320. * Compute the transpose of the matrix
  4321. * @returns the new transposed matrix
  4322. */
  4323. transpose(): Matrix;
  4324. /**
  4325. * Compute the transpose of the matrix and store it in a given matrix
  4326. * @param result defines the target matrix
  4327. * @returns the current matrix
  4328. */
  4329. transposeToRef(result: Matrix): Matrix;
  4330. /**
  4331. * Sets the index-th row of the current matrix with the given 4 x float values
  4332. * @param index defines the row index
  4333. * @param x defines the x component to set
  4334. * @param y defines the y component to set
  4335. * @param z defines the z component to set
  4336. * @param w defines the w component to set
  4337. * @returns the updated current matrix
  4338. */
  4339. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  4340. /**
  4341. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  4342. * @param scale defines the scale factor
  4343. * @returns a new matrix
  4344. */
  4345. scale(scale: number): Matrix;
  4346. /**
  4347. * Scale the current matrix values by a factor to a given result matrix
  4348. * @param scale defines the scale factor
  4349. * @param result defines the matrix to store the result
  4350. * @returns the current matrix
  4351. */
  4352. scaleToRef(scale: number, result: Matrix): Matrix;
  4353. /**
  4354. * Scale the current matrix values by a factor and add the result to a given matrix
  4355. * @param scale defines the scale factor
  4356. * @param result defines the Matrix to store the result
  4357. * @returns the current matrix
  4358. */
  4359. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  4360. /**
  4361. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  4362. * @param ref matrix to store the result
  4363. */
  4364. toNormalMatrix(ref: Matrix): void;
  4365. /**
  4366. * Gets only rotation part of the current matrix
  4367. * @returns a new matrix sets to the extracted rotation matrix from the current one
  4368. */
  4369. getRotationMatrix(): Matrix;
  4370. /**
  4371. * Extracts the rotation matrix from the current one and sets it as the given "result"
  4372. * @param result defines the target matrix to store data to
  4373. * @returns the current matrix
  4374. */
  4375. getRotationMatrixToRef(result: Matrix): Matrix;
  4376. /**
  4377. * Toggles model matrix from being right handed to left handed in place and vice versa
  4378. */
  4379. toggleModelMatrixHandInPlace(): void;
  4380. /**
  4381. * Toggles projection matrix from being right handed to left handed in place and vice versa
  4382. */
  4383. toggleProjectionMatrixHandInPlace(): void;
  4384. /**
  4385. * Creates a matrix from an array
  4386. * @param array defines the source array
  4387. * @param offset defines an offset in the source array
  4388. * @returns a new Matrix set from the starting index of the given array
  4389. */
  4390. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  4391. /**
  4392. * Copy the content of an array into a given matrix
  4393. * @param array defines the source array
  4394. * @param offset defines an offset in the source array
  4395. * @param result defines the target matrix
  4396. */
  4397. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  4398. /**
  4399. * Stores an array into a matrix after having multiplied each component by a given factor
  4400. * @param array defines the source array
  4401. * @param offset defines the offset in the source array
  4402. * @param scale defines the scaling factor
  4403. * @param result defines the target matrix
  4404. */
  4405. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  4406. /**
  4407. * Gets an identity matrix that must not be updated
  4408. */
  4409. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  4410. /**
  4411. * Stores a list of values (16) inside a given matrix
  4412. * @param initialM11 defines 1st value of 1st row
  4413. * @param initialM12 defines 2nd value of 1st row
  4414. * @param initialM13 defines 3rd value of 1st row
  4415. * @param initialM14 defines 4th value of 1st row
  4416. * @param initialM21 defines 1st value of 2nd row
  4417. * @param initialM22 defines 2nd value of 2nd row
  4418. * @param initialM23 defines 3rd value of 2nd row
  4419. * @param initialM24 defines 4th value of 2nd row
  4420. * @param initialM31 defines 1st value of 3rd row
  4421. * @param initialM32 defines 2nd value of 3rd row
  4422. * @param initialM33 defines 3rd value of 3rd row
  4423. * @param initialM34 defines 4th value of 3rd row
  4424. * @param initialM41 defines 1st value of 4th row
  4425. * @param initialM42 defines 2nd value of 4th row
  4426. * @param initialM43 defines 3rd value of 4th row
  4427. * @param initialM44 defines 4th value of 4th row
  4428. * @param result defines the target matrix
  4429. */
  4430. 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;
  4431. /**
  4432. * Creates new matrix from a list of values (16)
  4433. * @param initialM11 defines 1st value of 1st row
  4434. * @param initialM12 defines 2nd value of 1st row
  4435. * @param initialM13 defines 3rd value of 1st row
  4436. * @param initialM14 defines 4th value of 1st row
  4437. * @param initialM21 defines 1st value of 2nd row
  4438. * @param initialM22 defines 2nd value of 2nd row
  4439. * @param initialM23 defines 3rd value of 2nd row
  4440. * @param initialM24 defines 4th value of 2nd row
  4441. * @param initialM31 defines 1st value of 3rd row
  4442. * @param initialM32 defines 2nd value of 3rd row
  4443. * @param initialM33 defines 3rd value of 3rd row
  4444. * @param initialM34 defines 4th value of 3rd row
  4445. * @param initialM41 defines 1st value of 4th row
  4446. * @param initialM42 defines 2nd value of 4th row
  4447. * @param initialM43 defines 3rd value of 4th row
  4448. * @param initialM44 defines 4th value of 4th row
  4449. * @returns the new matrix
  4450. */
  4451. 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;
  4452. /**
  4453. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4454. * @param scale defines the scale vector3
  4455. * @param rotation defines the rotation quaternion
  4456. * @param translation defines the translation vector3
  4457. * @returns a new matrix
  4458. */
  4459. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  4460. /**
  4461. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4462. * @param scale defines the scale vector3
  4463. * @param rotation defines the rotation quaternion
  4464. * @param translation defines the translation vector3
  4465. * @param result defines the target matrix
  4466. */
  4467. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  4468. /**
  4469. * Creates a new identity matrix
  4470. * @returns a new identity matrix
  4471. */
  4472. static Identity(): Matrix;
  4473. /**
  4474. * Creates a new identity matrix and stores the result in a given matrix
  4475. * @param result defines the target matrix
  4476. */
  4477. static IdentityToRef(result: Matrix): void;
  4478. /**
  4479. * Creates a new zero matrix
  4480. * @returns a new zero matrix
  4481. */
  4482. static Zero(): Matrix;
  4483. /**
  4484. * Creates a new rotation matrix for "angle" radians around the X axis
  4485. * @param angle defines the angle (in radians) to use
  4486. * @return the new matrix
  4487. */
  4488. static RotationX(angle: number): Matrix;
  4489. /**
  4490. * Creates a new matrix as the invert of a given matrix
  4491. * @param source defines the source matrix
  4492. * @returns the new matrix
  4493. */
  4494. static Invert(source: DeepImmutable<Matrix>): Matrix;
  4495. /**
  4496. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  4497. * @param angle defines the angle (in radians) to use
  4498. * @param result defines the target matrix
  4499. */
  4500. static RotationXToRef(angle: number, result: Matrix): void;
  4501. /**
  4502. * Creates a new rotation matrix for "angle" radians around the Y axis
  4503. * @param angle defines the angle (in radians) to use
  4504. * @return the new matrix
  4505. */
  4506. static RotationY(angle: number): Matrix;
  4507. /**
  4508. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  4509. * @param angle defines the angle (in radians) to use
  4510. * @param result defines the target matrix
  4511. */
  4512. static RotationYToRef(angle: number, result: Matrix): void;
  4513. /**
  4514. * Creates a new rotation matrix for "angle" radians around the Z axis
  4515. * @param angle defines the angle (in radians) to use
  4516. * @return the new matrix
  4517. */
  4518. static RotationZ(angle: number): Matrix;
  4519. /**
  4520. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  4521. * @param angle defines the angle (in radians) to use
  4522. * @param result defines the target matrix
  4523. */
  4524. static RotationZToRef(angle: number, result: Matrix): void;
  4525. /**
  4526. * Creates a new rotation matrix for "angle" radians around the given axis
  4527. * @param axis defines the axis to use
  4528. * @param angle defines the angle (in radians) to use
  4529. * @return the new matrix
  4530. */
  4531. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  4532. /**
  4533. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  4534. * @param axis defines the axis to use
  4535. * @param angle defines the angle (in radians) to use
  4536. * @param result defines the target matrix
  4537. */
  4538. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  4539. /**
  4540. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  4541. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  4542. * @param from defines the vector to align
  4543. * @param to defines the vector to align to
  4544. * @param result defines the target matrix
  4545. */
  4546. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  4547. /**
  4548. * Creates a rotation matrix
  4549. * @param yaw defines the yaw angle in radians (Y axis)
  4550. * @param pitch defines the pitch angle in radians (X axis)
  4551. * @param roll defines the roll angle in radians (Z axis)
  4552. * @returns the new rotation matrix
  4553. */
  4554. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  4555. /**
  4556. * Creates a rotation matrix and stores it in a given matrix
  4557. * @param yaw defines the yaw angle in radians (Y axis)
  4558. * @param pitch defines the pitch angle in radians (X axis)
  4559. * @param roll defines the roll angle in radians (Z axis)
  4560. * @param result defines the target matrix
  4561. */
  4562. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  4563. /**
  4564. * Creates a scaling matrix
  4565. * @param x defines the scale factor on X axis
  4566. * @param y defines the scale factor on Y axis
  4567. * @param z defines the scale factor on Z axis
  4568. * @returns the new matrix
  4569. */
  4570. static Scaling(x: number, y: number, z: number): Matrix;
  4571. /**
  4572. * Creates a scaling matrix and stores it in a given matrix
  4573. * @param x defines the scale factor on X axis
  4574. * @param y defines the scale factor on Y axis
  4575. * @param z defines the scale factor on Z axis
  4576. * @param result defines the target matrix
  4577. */
  4578. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  4579. /**
  4580. * Creates a translation matrix
  4581. * @param x defines the translation on X axis
  4582. * @param y defines the translation on Y axis
  4583. * @param z defines the translationon Z axis
  4584. * @returns the new matrix
  4585. */
  4586. static Translation(x: number, y: number, z: number): Matrix;
  4587. /**
  4588. * Creates a translation matrix and stores it in a given matrix
  4589. * @param x defines the translation on X axis
  4590. * @param y defines the translation on Y axis
  4591. * @param z defines the translationon Z axis
  4592. * @param result defines the target matrix
  4593. */
  4594. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  4595. /**
  4596. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4597. * @param startValue defines the start value
  4598. * @param endValue defines the end value
  4599. * @param gradient defines the gradient factor
  4600. * @returns the new matrix
  4601. */
  4602. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4603. /**
  4604. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4605. * @param startValue defines the start value
  4606. * @param endValue defines the end value
  4607. * @param gradient defines the gradient factor
  4608. * @param result defines the Matrix object where to store data
  4609. */
  4610. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4611. /**
  4612. * Builds a new matrix whose values are computed by:
  4613. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4614. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4615. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4616. * @param startValue defines the first matrix
  4617. * @param endValue defines the second matrix
  4618. * @param gradient defines the gradient between the two matrices
  4619. * @returns the new matrix
  4620. */
  4621. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4622. /**
  4623. * Update a matrix to values which are computed by:
  4624. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4625. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4626. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4627. * @param startValue defines the first matrix
  4628. * @param endValue defines the second matrix
  4629. * @param gradient defines the gradient between the two matrices
  4630. * @param result defines the target matrix
  4631. */
  4632. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4633. /**
  4634. * Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up"
  4635. * This function works in left handed mode
  4636. * @param eye defines the final position of the entity
  4637. * @param target defines where the entity should look at
  4638. * @param up defines the up vector for the entity
  4639. * @returns the new matrix
  4640. */
  4641. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4642. /**
  4643. * Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up".
  4644. * This function works in left handed mode
  4645. * @param eye defines the final position of the entity
  4646. * @param target defines where the entity should look at
  4647. * @param up defines the up vector for the entity
  4648. * @param result defines the target matrix
  4649. */
  4650. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4651. /**
  4652. * 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"
  4653. * This function works in right handed mode
  4654. * @param eye defines the final position of the entity
  4655. * @param target defines where the entity should look at
  4656. * @param up defines the up vector for the entity
  4657. * @returns the new matrix
  4658. */
  4659. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4660. /**
  4661. * 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".
  4662. * This function works in right handed mode
  4663. * @param eye defines the final position of the entity
  4664. * @param target defines where the entity should look at
  4665. * @param up defines the up vector for the entity
  4666. * @param result defines the target matrix
  4667. */
  4668. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4669. /**
  4670. * Create a left-handed orthographic projection matrix
  4671. * @param width defines the viewport width
  4672. * @param height defines the viewport height
  4673. * @param znear defines the near clip plane
  4674. * @param zfar defines the far clip plane
  4675. * @returns a new matrix as a left-handed orthographic projection matrix
  4676. */
  4677. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4678. /**
  4679. * Store a left-handed orthographic projection to a given matrix
  4680. * @param width defines the viewport width
  4681. * @param height defines the viewport height
  4682. * @param znear defines the near clip plane
  4683. * @param zfar defines the far clip plane
  4684. * @param result defines the target matrix
  4685. */
  4686. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  4687. /**
  4688. * Create a left-handed orthographic projection matrix
  4689. * @param left defines the viewport left coordinate
  4690. * @param right defines the viewport right coordinate
  4691. * @param bottom defines the viewport bottom coordinate
  4692. * @param top defines the viewport top coordinate
  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 OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4698. /**
  4699. * Stores a left-handed orthographic projection into a given matrix
  4700. * @param left defines the viewport left coordinate
  4701. * @param right defines the viewport right coordinate
  4702. * @param bottom defines the viewport bottom coordinate
  4703. * @param top defines the viewport top coordinate
  4704. * @param znear defines the near clip plane
  4705. * @param zfar defines the far clip plane
  4706. * @param result defines the target matrix
  4707. */
  4708. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4709. /**
  4710. * Creates a right-handed orthographic projection matrix
  4711. * @param left defines the viewport left coordinate
  4712. * @param right defines the viewport right coordinate
  4713. * @param bottom defines the viewport bottom coordinate
  4714. * @param top defines the viewport top coordinate
  4715. * @param znear defines the near clip plane
  4716. * @param zfar defines the far clip plane
  4717. * @returns a new matrix as a right-handed orthographic projection matrix
  4718. */
  4719. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4720. /**
  4721. * Stores a right-handed orthographic projection into a given matrix
  4722. * @param left defines the viewport left coordinate
  4723. * @param right defines the viewport right coordinate
  4724. * @param bottom defines the viewport bottom coordinate
  4725. * @param top defines the viewport top coordinate
  4726. * @param znear defines the near clip plane
  4727. * @param zfar defines the far clip plane
  4728. * @param result defines the target matrix
  4729. */
  4730. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4731. /**
  4732. * Creates a left-handed perspective projection matrix
  4733. * @param width defines the viewport width
  4734. * @param height defines the viewport height
  4735. * @param znear defines the near clip plane
  4736. * @param zfar defines the far clip plane
  4737. * @returns a new matrix as a left-handed perspective projection matrix
  4738. */
  4739. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4740. /**
  4741. * Creates a left-handed perspective projection matrix
  4742. * @param fov defines the horizontal field of view
  4743. * @param aspect defines the aspect ratio
  4744. * @param znear defines the near clip plane
  4745. * @param zfar defines the far clip plane
  4746. * @returns a new matrix as a left-handed perspective projection matrix
  4747. */
  4748. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4749. /**
  4750. * Stores a left-handed perspective projection into a given matrix
  4751. * @param fov defines the horizontal field of view
  4752. * @param aspect defines the aspect ratio
  4753. * @param znear defines the near clip plane
  4754. * @param zfar defines the far clip plane
  4755. * @param result defines the target matrix
  4756. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4757. */
  4758. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4759. /**
  4760. * Stores a left-handed perspective projection into a given matrix with depth reversed
  4761. * @param fov defines the horizontal field of view
  4762. * @param aspect defines the aspect ratio
  4763. * @param znear defines the near clip plane
  4764. * @param zfar not used as infinity is used as far clip
  4765. * @param result defines the target matrix
  4766. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4767. */
  4768. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4769. /**
  4770. * Creates a right-handed perspective projection 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. * @returns a new matrix as a right-handed perspective projection matrix
  4776. */
  4777. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4778. /**
  4779. * Stores a right-handed perspective projection into a given matrix
  4780. * @param fov defines the horizontal field of view
  4781. * @param aspect defines the aspect ratio
  4782. * @param znear defines the near clip plane
  4783. * @param zfar defines the far clip plane
  4784. * @param result defines the target matrix
  4785. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4786. */
  4787. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4788. /**
  4789. * Stores a right-handed perspective projection into a given matrix
  4790. * @param fov defines the horizontal field of view
  4791. * @param aspect defines the aspect ratio
  4792. * @param znear defines the near clip plane
  4793. * @param zfar not used as infinity is used as far clip
  4794. * @param result defines the target matrix
  4795. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4796. */
  4797. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4798. /**
  4799. * Stores a perspective projection for WebVR info a given matrix
  4800. * @param fov defines the field of view
  4801. * @param znear defines the near clip plane
  4802. * @param zfar defines the far clip plane
  4803. * @param result defines the target matrix
  4804. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  4805. */
  4806. static PerspectiveFovWebVRToRef(fov: {
  4807. upDegrees: number;
  4808. downDegrees: number;
  4809. leftDegrees: number;
  4810. rightDegrees: number;
  4811. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  4812. /**
  4813. * Computes a complete transformation matrix
  4814. * @param viewport defines the viewport to use
  4815. * @param world defines the world matrix
  4816. * @param view defines the view matrix
  4817. * @param projection defines the projection matrix
  4818. * @param zmin defines the near clip plane
  4819. * @param zmax defines the far clip plane
  4820. * @returns the transformation matrix
  4821. */
  4822. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  4823. /**
  4824. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  4825. * @param matrix defines the matrix to use
  4826. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  4827. */
  4828. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  4829. /**
  4830. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  4831. * @param matrix defines the matrix to use
  4832. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  4833. */
  4834. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  4835. /**
  4836. * Compute the transpose of a given matrix
  4837. * @param matrix defines the matrix to transpose
  4838. * @returns the new matrix
  4839. */
  4840. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  4841. /**
  4842. * Compute the transpose of a matrix and store it in a target matrix
  4843. * @param matrix defines the matrix to transpose
  4844. * @param result defines the target matrix
  4845. */
  4846. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  4847. /**
  4848. * Computes a reflection matrix from a plane
  4849. * @param plane defines the reflection plane
  4850. * @returns a new matrix
  4851. */
  4852. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  4853. /**
  4854. * Computes a reflection matrix from a plane
  4855. * @param plane defines the reflection plane
  4856. * @param result defines the target matrix
  4857. */
  4858. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  4859. /**
  4860. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  4861. * @param xaxis defines the value of the 1st axis
  4862. * @param yaxis defines the value of the 2nd axis
  4863. * @param zaxis defines the value of the 3rd axis
  4864. * @param result defines the target matrix
  4865. */
  4866. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  4867. /**
  4868. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  4869. * @param quat defines the quaternion to use
  4870. * @param result defines the target matrix
  4871. */
  4872. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  4873. }
  4874. /**
  4875. * @hidden
  4876. */
  4877. export class TmpVectors {
  4878. static Vector2: Vector2[];
  4879. static Vector3: Vector3[];
  4880. static Vector4: Vector4[];
  4881. static Quaternion: Quaternion[];
  4882. static Matrix: Matrix[];
  4883. }
  4884. }
  4885. declare module "babylonjs/Maths/math.path" {
  4886. import { DeepImmutable, Nullable } from "babylonjs/types";
  4887. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  4888. /**
  4889. * Defines potential orientation for back face culling
  4890. */
  4891. export enum Orientation {
  4892. /**
  4893. * Clockwise
  4894. */
  4895. CW = 0,
  4896. /** Counter clockwise */
  4897. CCW = 1
  4898. }
  4899. /** Class used to represent a Bezier curve */
  4900. export class BezierCurve {
  4901. /**
  4902. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  4903. * @param t defines the time
  4904. * @param x1 defines the left coordinate on X axis
  4905. * @param y1 defines the left coordinate on Y axis
  4906. * @param x2 defines the right coordinate on X axis
  4907. * @param y2 defines the right coordinate on Y axis
  4908. * @returns the interpolated value
  4909. */
  4910. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  4911. }
  4912. /**
  4913. * Defines angle representation
  4914. */
  4915. export class Angle {
  4916. private _radians;
  4917. /**
  4918. * Creates an Angle object of "radians" radians (float).
  4919. * @param radians the angle in radians
  4920. */
  4921. constructor(radians: number);
  4922. /**
  4923. * Get value in degrees
  4924. * @returns the Angle value in degrees (float)
  4925. */
  4926. degrees(): number;
  4927. /**
  4928. * Get value in radians
  4929. * @returns the Angle value in radians (float)
  4930. */
  4931. radians(): number;
  4932. /**
  4933. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  4934. * @param a defines first point as the origin
  4935. * @param b defines point
  4936. * @returns a new Angle
  4937. */
  4938. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  4939. /**
  4940. * Gets a new Angle object from the given float in radians
  4941. * @param radians defines the angle value in radians
  4942. * @returns a new Angle
  4943. */
  4944. static FromRadians(radians: number): Angle;
  4945. /**
  4946. * Gets a new Angle object from the given float in degrees
  4947. * @param degrees defines the angle value in degrees
  4948. * @returns a new Angle
  4949. */
  4950. static FromDegrees(degrees: number): Angle;
  4951. }
  4952. /**
  4953. * This represents an arc in a 2d space.
  4954. */
  4955. export class Arc2 {
  4956. /** Defines the start point of the arc */
  4957. startPoint: Vector2;
  4958. /** Defines the mid point of the arc */
  4959. midPoint: Vector2;
  4960. /** Defines the end point of the arc */
  4961. endPoint: Vector2;
  4962. /**
  4963. * Defines the center point of the arc.
  4964. */
  4965. centerPoint: Vector2;
  4966. /**
  4967. * Defines the radius of the arc.
  4968. */
  4969. radius: number;
  4970. /**
  4971. * Defines the angle of the arc (from mid point to end point).
  4972. */
  4973. angle: Angle;
  4974. /**
  4975. * Defines the start angle of the arc (from start point to middle point).
  4976. */
  4977. startAngle: Angle;
  4978. /**
  4979. * Defines the orientation of the arc (clock wise/counter clock wise).
  4980. */
  4981. orientation: Orientation;
  4982. /**
  4983. * Creates an Arc object from the three given points : start, middle and end.
  4984. * @param startPoint Defines the start point of the arc
  4985. * @param midPoint Defines the midlle point of the arc
  4986. * @param endPoint Defines the end point of the arc
  4987. */
  4988. constructor(
  4989. /** Defines the start point of the arc */
  4990. startPoint: Vector2,
  4991. /** Defines the mid point of the arc */
  4992. midPoint: Vector2,
  4993. /** Defines the end point of the arc */
  4994. endPoint: Vector2);
  4995. }
  4996. /**
  4997. * Represents a 2D path made up of multiple 2D points
  4998. */
  4999. export class Path2 {
  5000. private _points;
  5001. private _length;
  5002. /**
  5003. * If the path start and end point are the same
  5004. */
  5005. closed: boolean;
  5006. /**
  5007. * Creates a Path2 object from the starting 2D coordinates x and y.
  5008. * @param x the starting points x value
  5009. * @param y the starting points y value
  5010. */
  5011. constructor(x: number, y: number);
  5012. /**
  5013. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  5014. * @param x the added points x value
  5015. * @param y the added points y value
  5016. * @returns the updated Path2.
  5017. */
  5018. addLineTo(x: number, y: number): Path2;
  5019. /**
  5020. * 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.
  5021. * @param midX middle point x value
  5022. * @param midY middle point y value
  5023. * @param endX end point x value
  5024. * @param endY end point y value
  5025. * @param numberOfSegments (default: 36)
  5026. * @returns the updated Path2.
  5027. */
  5028. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  5029. /**
  5030. * Closes the Path2.
  5031. * @returns the Path2.
  5032. */
  5033. close(): Path2;
  5034. /**
  5035. * Gets the sum of the distance between each sequential point in the path
  5036. * @returns the Path2 total length (float).
  5037. */
  5038. length(): number;
  5039. /**
  5040. * Gets the points which construct the path
  5041. * @returns the Path2 internal array of points.
  5042. */
  5043. getPoints(): Vector2[];
  5044. /**
  5045. * Retreives the point at the distance aways from the starting point
  5046. * @param normalizedLengthPosition the length along the path to retreive the point from
  5047. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  5048. */
  5049. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  5050. /**
  5051. * Creates a new path starting from an x and y position
  5052. * @param x starting x value
  5053. * @param y starting y value
  5054. * @returns a new Path2 starting at the coordinates (x, y).
  5055. */
  5056. static StartingAt(x: number, y: number): Path2;
  5057. }
  5058. /**
  5059. * Represents a 3D path made up of multiple 3D points
  5060. */
  5061. export class Path3D {
  5062. /**
  5063. * an array of Vector3, the curve axis of the Path3D
  5064. */
  5065. path: Vector3[];
  5066. private _curve;
  5067. private _distances;
  5068. private _tangents;
  5069. private _normals;
  5070. private _binormals;
  5071. private _raw;
  5072. private _alignTangentsWithPath;
  5073. private readonly _pointAtData;
  5074. /**
  5075. * new Path3D(path, normal, raw)
  5076. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  5077. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  5078. * @param path an array of Vector3, the curve axis of the Path3D
  5079. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  5080. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  5081. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  5082. */
  5083. constructor(
  5084. /**
  5085. * an array of Vector3, the curve axis of the Path3D
  5086. */
  5087. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  5088. /**
  5089. * Returns the Path3D array of successive Vector3 designing its curve.
  5090. * @returns the Path3D array of successive Vector3 designing its curve.
  5091. */
  5092. getCurve(): Vector3[];
  5093. /**
  5094. * Returns the Path3D array of successive Vector3 designing its curve.
  5095. * @returns the Path3D array of successive Vector3 designing its curve.
  5096. */
  5097. getPoints(): Vector3[];
  5098. /**
  5099. * @returns the computed length (float) of the path.
  5100. */
  5101. length(): number;
  5102. /**
  5103. * Returns an array populated with tangent vectors on each Path3D curve point.
  5104. * @returns an array populated with tangent vectors on each Path3D curve point.
  5105. */
  5106. getTangents(): Vector3[];
  5107. /**
  5108. * Returns an array populated with normal vectors on each Path3D curve point.
  5109. * @returns an array populated with normal vectors on each Path3D curve point.
  5110. */
  5111. getNormals(): Vector3[];
  5112. /**
  5113. * Returns an array populated with binormal vectors on each Path3D curve point.
  5114. * @returns an array populated with binormal vectors on each Path3D curve point.
  5115. */
  5116. getBinormals(): Vector3[];
  5117. /**
  5118. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  5119. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  5120. */
  5121. getDistances(): number[];
  5122. /**
  5123. * Returns an interpolated point along this path
  5124. * @param position the position of the point along this path, from 0.0 to 1.0
  5125. * @returns a new Vector3 as the point
  5126. */
  5127. getPointAt(position: number): Vector3;
  5128. /**
  5129. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5130. * @param position the position of the point along this path, from 0.0 to 1.0
  5131. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  5132. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  5133. */
  5134. getTangentAt(position: number, interpolated?: boolean): Vector3;
  5135. /**
  5136. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5137. * @param position the position of the point along this path, from 0.0 to 1.0
  5138. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  5139. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  5140. */
  5141. getNormalAt(position: number, interpolated?: boolean): Vector3;
  5142. /**
  5143. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  5144. * @param position the position of the point along this path, from 0.0 to 1.0
  5145. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  5146. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  5147. */
  5148. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  5149. /**
  5150. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  5151. * @param position the position of the point along this path, from 0.0 to 1.0
  5152. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  5153. */
  5154. getDistanceAt(position: number): number;
  5155. /**
  5156. * Returns the array index of the previous point of an interpolated point along this path
  5157. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5158. * @returns the array index
  5159. */
  5160. getPreviousPointIndexAt(position: number): number;
  5161. /**
  5162. * 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)
  5163. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5164. * @returns the sub position
  5165. */
  5166. getSubPositionAt(position: number): number;
  5167. /**
  5168. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  5169. * @param target the vector of which to get the closest position to
  5170. * @returns the position of the closest virtual point on this path to the target vector
  5171. */
  5172. getClosestPositionTo(target: Vector3): number;
  5173. /**
  5174. * Returns a sub path (slice) of this path
  5175. * @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
  5176. * @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
  5177. * @returns a sub path (slice) of this path
  5178. */
  5179. slice(start?: number, end?: number): Path3D;
  5180. /**
  5181. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  5182. * @param path path which all values are copied into the curves points
  5183. * @param firstNormal which should be projected onto the curve
  5184. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  5185. * @returns the same object updated.
  5186. */
  5187. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  5188. private _compute;
  5189. private _getFirstNonNullVector;
  5190. private _getLastNonNullVector;
  5191. private _normalVector;
  5192. /**
  5193. * Updates the point at data for an interpolated point along this curve
  5194. * @param position the position of the point along this curve, from 0.0 to 1.0
  5195. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  5196. * @returns the (updated) point at data
  5197. */
  5198. private _updatePointAtData;
  5199. /**
  5200. * Updates the point at data from the specified parameters
  5201. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  5202. * @param point the interpolated point
  5203. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  5204. */
  5205. private _setPointAtData;
  5206. /**
  5207. * Updates the point at interpolation matrix for the tangents, normals and binormals
  5208. */
  5209. private _updateInterpolationMatrix;
  5210. }
  5211. /**
  5212. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5213. * A Curve3 is designed from a series of successive Vector3.
  5214. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  5215. */
  5216. export class Curve3 {
  5217. private _points;
  5218. private _length;
  5219. /**
  5220. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  5221. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  5222. * @param v1 (Vector3) the control point
  5223. * @param v2 (Vector3) the end point of the Quadratic Bezier
  5224. * @param nbPoints (integer) the wanted number of points in the curve
  5225. * @returns the created Curve3
  5226. */
  5227. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5228. /**
  5229. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  5230. * @param v0 (Vector3) the origin point of the Cubic Bezier
  5231. * @param v1 (Vector3) the first control point
  5232. * @param v2 (Vector3) the second control point
  5233. * @param v3 (Vector3) the end point of the Cubic Bezier
  5234. * @param nbPoints (integer) the wanted number of points in the curve
  5235. * @returns the created Curve3
  5236. */
  5237. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5238. /**
  5239. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  5240. * @param p1 (Vector3) the origin point of the Hermite Spline
  5241. * @param t1 (Vector3) the tangent vector at the origin point
  5242. * @param p2 (Vector3) the end point of the Hermite Spline
  5243. * @param t2 (Vector3) the tangent vector at the end point
  5244. * @param nbPoints (integer) the wanted number of points in the curve
  5245. * @returns the created Curve3
  5246. */
  5247. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5248. /**
  5249. * Returns a Curve3 object along a CatmullRom Spline curve :
  5250. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  5251. * @param nbPoints (integer) the wanted number of points between each curve control points
  5252. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  5253. * @returns the created Curve3
  5254. */
  5255. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  5256. /**
  5257. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5258. * A Curve3 is designed from a series of successive Vector3.
  5259. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  5260. * @param points points which make up the curve
  5261. */
  5262. constructor(points: Vector3[]);
  5263. /**
  5264. * @returns the Curve3 stored array of successive Vector3
  5265. */
  5266. getPoints(): Vector3[];
  5267. /**
  5268. * @returns the computed length (float) of the curve.
  5269. */
  5270. length(): number;
  5271. /**
  5272. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  5273. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  5274. * curveA and curveB keep unchanged.
  5275. * @param curve the curve to continue from this curve
  5276. * @returns the newly constructed curve
  5277. */
  5278. continue(curve: DeepImmutable<Curve3>): Curve3;
  5279. private _computeLength;
  5280. }
  5281. }
  5282. declare module "babylonjs/Animations/easing" {
  5283. /**
  5284. * This represents the main contract an easing function should follow.
  5285. * Easing functions are used throughout the animation system.
  5286. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5287. */
  5288. export interface IEasingFunction {
  5289. /**
  5290. * Given an input gradient between 0 and 1, this returns the corrseponding value
  5291. * of the easing function.
  5292. * The link below provides some of the most common examples of easing functions.
  5293. * @see https://easings.net/
  5294. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5295. * @returns the corresponding value on the curve defined by the easing function
  5296. */
  5297. ease(gradient: number): number;
  5298. }
  5299. /**
  5300. * Base class used for every default easing function.
  5301. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5302. */
  5303. export class EasingFunction implements IEasingFunction {
  5304. /**
  5305. * Interpolation follows the mathematical formula associated with the easing function.
  5306. */
  5307. static readonly EASINGMODE_EASEIN: number;
  5308. /**
  5309. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  5310. */
  5311. static readonly EASINGMODE_EASEOUT: number;
  5312. /**
  5313. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  5314. */
  5315. static readonly EASINGMODE_EASEINOUT: number;
  5316. private _easingMode;
  5317. /**
  5318. * Sets the easing mode of the current function.
  5319. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  5320. */
  5321. setEasingMode(easingMode: number): void;
  5322. /**
  5323. * Gets the current easing mode.
  5324. * @returns the easing mode
  5325. */
  5326. getEasingMode(): number;
  5327. /**
  5328. * @hidden
  5329. */
  5330. easeInCore(gradient: number): number;
  5331. /**
  5332. * Given an input gradient between 0 and 1, this returns the corresponding value
  5333. * of the easing function.
  5334. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5335. * @returns the corresponding value on the curve defined by the easing function
  5336. */
  5337. ease(gradient: number): number;
  5338. }
  5339. /**
  5340. * Easing function with a circle shape (see link below).
  5341. * @see https://easings.net/#easeInCirc
  5342. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5343. */
  5344. export class CircleEase extends EasingFunction implements IEasingFunction {
  5345. /** @hidden */
  5346. easeInCore(gradient: number): number;
  5347. }
  5348. /**
  5349. * Easing function with a ease back shape (see link below).
  5350. * @see https://easings.net/#easeInBack
  5351. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5352. */
  5353. export class BackEase extends EasingFunction implements IEasingFunction {
  5354. /** Defines the amplitude of the function */
  5355. amplitude: number;
  5356. /**
  5357. * Instantiates a back ease easing
  5358. * @see https://easings.net/#easeInBack
  5359. * @param amplitude Defines the amplitude of the function
  5360. */
  5361. constructor(
  5362. /** Defines the amplitude of the function */
  5363. amplitude?: number);
  5364. /** @hidden */
  5365. easeInCore(gradient: number): number;
  5366. }
  5367. /**
  5368. * Easing function with a bouncing shape (see link below).
  5369. * @see https://easings.net/#easeInBounce
  5370. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5371. */
  5372. export class BounceEase extends EasingFunction implements IEasingFunction {
  5373. /** Defines the number of bounces */
  5374. bounces: number;
  5375. /** Defines the amplitude of the bounce */
  5376. bounciness: number;
  5377. /**
  5378. * Instantiates a bounce easing
  5379. * @see https://easings.net/#easeInBounce
  5380. * @param bounces Defines the number of bounces
  5381. * @param bounciness Defines the amplitude of the bounce
  5382. */
  5383. constructor(
  5384. /** Defines the number of bounces */
  5385. bounces?: number,
  5386. /** Defines the amplitude of the bounce */
  5387. bounciness?: number);
  5388. /** @hidden */
  5389. easeInCore(gradient: number): number;
  5390. }
  5391. /**
  5392. * Easing function with a power of 3 shape (see link below).
  5393. * @see https://easings.net/#easeInCubic
  5394. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5395. */
  5396. export class CubicEase extends EasingFunction implements IEasingFunction {
  5397. /** @hidden */
  5398. easeInCore(gradient: number): number;
  5399. }
  5400. /**
  5401. * Easing function with an elastic shape (see link below).
  5402. * @see https://easings.net/#easeInElastic
  5403. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5404. */
  5405. export class ElasticEase extends EasingFunction implements IEasingFunction {
  5406. /** Defines the number of oscillations*/
  5407. oscillations: number;
  5408. /** Defines the amplitude of the oscillations*/
  5409. springiness: number;
  5410. /**
  5411. * Instantiates an elastic easing function
  5412. * @see https://easings.net/#easeInElastic
  5413. * @param oscillations Defines the number of oscillations
  5414. * @param springiness Defines the amplitude of the oscillations
  5415. */
  5416. constructor(
  5417. /** Defines the number of oscillations*/
  5418. oscillations?: number,
  5419. /** Defines the amplitude of the oscillations*/
  5420. springiness?: number);
  5421. /** @hidden */
  5422. easeInCore(gradient: number): number;
  5423. }
  5424. /**
  5425. * Easing function with an exponential shape (see link below).
  5426. * @see https://easings.net/#easeInExpo
  5427. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5428. */
  5429. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  5430. /** Defines the exponent of the function */
  5431. exponent: number;
  5432. /**
  5433. * Instantiates an exponential easing function
  5434. * @see https://easings.net/#easeInExpo
  5435. * @param exponent Defines the exponent of the function
  5436. */
  5437. constructor(
  5438. /** Defines the exponent of the function */
  5439. exponent?: number);
  5440. /** @hidden */
  5441. easeInCore(gradient: number): number;
  5442. }
  5443. /**
  5444. * Easing function with a power shape (see link below).
  5445. * @see https://easings.net/#easeInQuad
  5446. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5447. */
  5448. export class PowerEase extends EasingFunction implements IEasingFunction {
  5449. /** Defines the power of the function */
  5450. power: number;
  5451. /**
  5452. * Instantiates an power base easing function
  5453. * @see https://easings.net/#easeInQuad
  5454. * @param power Defines the power of the function
  5455. */
  5456. constructor(
  5457. /** Defines the power of the function */
  5458. power?: number);
  5459. /** @hidden */
  5460. easeInCore(gradient: number): number;
  5461. }
  5462. /**
  5463. * Easing function with a power of 2 shape (see link below).
  5464. * @see https://easings.net/#easeInQuad
  5465. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5466. */
  5467. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  5468. /** @hidden */
  5469. easeInCore(gradient: number): number;
  5470. }
  5471. /**
  5472. * Easing function with a power of 4 shape (see link below).
  5473. * @see https://easings.net/#easeInQuart
  5474. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5475. */
  5476. export class QuarticEase extends EasingFunction implements IEasingFunction {
  5477. /** @hidden */
  5478. easeInCore(gradient: number): number;
  5479. }
  5480. /**
  5481. * Easing function with a power of 5 shape (see link below).
  5482. * @see https://easings.net/#easeInQuint
  5483. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5484. */
  5485. export class QuinticEase extends EasingFunction implements IEasingFunction {
  5486. /** @hidden */
  5487. easeInCore(gradient: number): number;
  5488. }
  5489. /**
  5490. * Easing function with a sin shape (see link below).
  5491. * @see https://easings.net/#easeInSine
  5492. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5493. */
  5494. export class SineEase extends EasingFunction implements IEasingFunction {
  5495. /** @hidden */
  5496. easeInCore(gradient: number): number;
  5497. }
  5498. /**
  5499. * Easing function with a bezier shape (see link below).
  5500. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5501. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5502. */
  5503. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  5504. /** Defines the x component of the start tangent in the bezier curve */
  5505. x1: number;
  5506. /** Defines the y component of the start tangent in the bezier curve */
  5507. y1: number;
  5508. /** Defines the x component of the end tangent in the bezier curve */
  5509. x2: number;
  5510. /** Defines the y component of the end tangent in the bezier curve */
  5511. y2: number;
  5512. /**
  5513. * Instantiates a bezier function
  5514. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5515. * @param x1 Defines the x component of the start tangent in the bezier curve
  5516. * @param y1 Defines the y component of the start tangent in the bezier curve
  5517. * @param x2 Defines the x component of the end tangent in the bezier curve
  5518. * @param y2 Defines the y component of the end tangent in the bezier curve
  5519. */
  5520. constructor(
  5521. /** Defines the x component of the start tangent in the bezier curve */
  5522. x1?: number,
  5523. /** Defines the y component of the start tangent in the bezier curve */
  5524. y1?: number,
  5525. /** Defines the x component of the end tangent in the bezier curve */
  5526. x2?: number,
  5527. /** Defines the y component of the end tangent in the bezier curve */
  5528. y2?: number);
  5529. /** @hidden */
  5530. easeInCore(gradient: number): number;
  5531. }
  5532. }
  5533. declare module "babylonjs/Maths/math.color" {
  5534. import { DeepImmutable, FloatArray } from "babylonjs/types";
  5535. /**
  5536. * Class used to hold a RBG color
  5537. */
  5538. export class Color3 {
  5539. /**
  5540. * Defines the red component (between 0 and 1, default is 0)
  5541. */
  5542. r: number;
  5543. /**
  5544. * Defines the green component (between 0 and 1, default is 0)
  5545. */
  5546. g: number;
  5547. /**
  5548. * Defines the blue component (between 0 and 1, default is 0)
  5549. */
  5550. b: number;
  5551. /**
  5552. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  5553. * @param r defines the red component (between 0 and 1, default is 0)
  5554. * @param g defines the green component (between 0 and 1, default is 0)
  5555. * @param b defines the blue component (between 0 and 1, default is 0)
  5556. */
  5557. constructor(
  5558. /**
  5559. * Defines the red component (between 0 and 1, default is 0)
  5560. */
  5561. r?: number,
  5562. /**
  5563. * Defines the green component (between 0 and 1, default is 0)
  5564. */
  5565. g?: number,
  5566. /**
  5567. * Defines the blue component (between 0 and 1, default is 0)
  5568. */
  5569. b?: number);
  5570. /**
  5571. * Creates a string with the Color3 current values
  5572. * @returns the string representation of the Color3 object
  5573. */
  5574. toString(): string;
  5575. /**
  5576. * Returns the string "Color3"
  5577. * @returns "Color3"
  5578. */
  5579. getClassName(): string;
  5580. /**
  5581. * Compute the Color3 hash code
  5582. * @returns an unique number that can be used to hash Color3 objects
  5583. */
  5584. getHashCode(): number;
  5585. /**
  5586. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  5587. * @param array defines the array where to store the r,g,b components
  5588. * @param index defines an optional index in the target array to define where to start storing values
  5589. * @returns the current Color3 object
  5590. */
  5591. toArray(array: FloatArray, index?: number): Color3;
  5592. /**
  5593. * Update the current color with values stored in an array from the starting index of the given array
  5594. * @param array defines the source array
  5595. * @param offset defines an offset in the source array
  5596. * @returns the current Color3 object
  5597. */
  5598. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5599. /**
  5600. * Returns a new Color4 object from the current Color3 and the given alpha
  5601. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  5602. * @returns a new Color4 object
  5603. */
  5604. toColor4(alpha?: number): Color4;
  5605. /**
  5606. * Returns a new array populated with 3 numeric elements : red, green and blue values
  5607. * @returns the new array
  5608. */
  5609. asArray(): number[];
  5610. /**
  5611. * Returns the luminance value
  5612. * @returns a float value
  5613. */
  5614. toLuminance(): number;
  5615. /**
  5616. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  5617. * @param otherColor defines the second operand
  5618. * @returns the new Color3 object
  5619. */
  5620. multiply(otherColor: DeepImmutable<Color3>): Color3;
  5621. /**
  5622. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  5623. * @param otherColor defines the second operand
  5624. * @param result defines the Color3 object where to store the result
  5625. * @returns the current Color3
  5626. */
  5627. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5628. /**
  5629. * Determines equality between Color3 objects
  5630. * @param otherColor defines the second operand
  5631. * @returns true if the rgb values are equal to the given ones
  5632. */
  5633. equals(otherColor: DeepImmutable<Color3>): boolean;
  5634. /**
  5635. * Determines equality between the current Color3 object and a set of r,b,g values
  5636. * @param r defines the red component to check
  5637. * @param g defines the green component to check
  5638. * @param b defines the blue component to check
  5639. * @returns true if the rgb values are equal to the given ones
  5640. */
  5641. equalsFloats(r: number, g: number, b: number): boolean;
  5642. /**
  5643. * Multiplies in place each rgb value by scale
  5644. * @param scale defines the scaling factor
  5645. * @returns the updated Color3
  5646. */
  5647. scale(scale: number): Color3;
  5648. /**
  5649. * Multiplies the rgb values by scale and stores the result into "result"
  5650. * @param scale defines the scaling factor
  5651. * @param result defines the Color3 object where to store the result
  5652. * @returns the unmodified current Color3
  5653. */
  5654. scaleToRef(scale: number, result: Color3): Color3;
  5655. /**
  5656. * Scale the current Color3 values by a factor and add the result to a given Color3
  5657. * @param scale defines the scale factor
  5658. * @param result defines color to store the result into
  5659. * @returns the unmodified current Color3
  5660. */
  5661. scaleAndAddToRef(scale: number, result: Color3): Color3;
  5662. /**
  5663. * Clamps the rgb values by the min and max values and stores the result into "result"
  5664. * @param min defines minimum clamping value (default is 0)
  5665. * @param max defines maximum clamping value (default is 1)
  5666. * @param result defines color to store the result into
  5667. * @returns the original Color3
  5668. */
  5669. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  5670. /**
  5671. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  5672. * @param otherColor defines the second operand
  5673. * @returns the new Color3
  5674. */
  5675. add(otherColor: DeepImmutable<Color3>): Color3;
  5676. /**
  5677. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  5678. * @param otherColor defines the second operand
  5679. * @param result defines Color3 object to store the result into
  5680. * @returns the unmodified current Color3
  5681. */
  5682. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5683. /**
  5684. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  5685. * @param otherColor defines the second operand
  5686. * @returns the new Color3
  5687. */
  5688. subtract(otherColor: DeepImmutable<Color3>): Color3;
  5689. /**
  5690. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  5691. * @param otherColor defines the second operand
  5692. * @param result defines Color3 object to store the result into
  5693. * @returns the unmodified current Color3
  5694. */
  5695. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5696. /**
  5697. * Copy the current object
  5698. * @returns a new Color3 copied the current one
  5699. */
  5700. clone(): Color3;
  5701. /**
  5702. * Copies the rgb values from the source in the current Color3
  5703. * @param source defines the source Color3 object
  5704. * @returns the updated Color3 object
  5705. */
  5706. copyFrom(source: DeepImmutable<Color3>): Color3;
  5707. /**
  5708. * Updates the Color3 rgb values from the given floats
  5709. * @param r defines the red component to read from
  5710. * @param g defines the green component to read from
  5711. * @param b defines the blue component to read from
  5712. * @returns the current Color3 object
  5713. */
  5714. copyFromFloats(r: number, g: number, b: number): Color3;
  5715. /**
  5716. * Updates the Color3 rgb values from the given floats
  5717. * @param r defines the red component to read from
  5718. * @param g defines the green component to read from
  5719. * @param b defines the blue component to read from
  5720. * @returns the current Color3 object
  5721. */
  5722. set(r: number, g: number, b: number): Color3;
  5723. /**
  5724. * Compute the Color3 hexadecimal code as a string
  5725. * @returns a string containing the hexadecimal representation of the Color3 object
  5726. */
  5727. toHexString(): string;
  5728. /**
  5729. * Computes a new Color3 converted from the current one to linear space
  5730. * @returns a new Color3 object
  5731. */
  5732. toLinearSpace(): Color3;
  5733. /**
  5734. * Converts current color in rgb space to HSV values
  5735. * @returns a new color3 representing the HSV values
  5736. */
  5737. toHSV(): Color3;
  5738. /**
  5739. * Converts current color in rgb space to HSV values
  5740. * @param result defines the Color3 where to store the HSV values
  5741. */
  5742. toHSVToRef(result: Color3): void;
  5743. /**
  5744. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  5745. * @param convertedColor defines the Color3 object where to store the linear space version
  5746. * @returns the unmodified Color3
  5747. */
  5748. toLinearSpaceToRef(convertedColor: Color3): Color3;
  5749. /**
  5750. * Computes a new Color3 converted from the current one to gamma space
  5751. * @returns a new Color3 object
  5752. */
  5753. toGammaSpace(): Color3;
  5754. /**
  5755. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  5756. * @param convertedColor defines the Color3 object where to store the gamma space version
  5757. * @returns the unmodified Color3
  5758. */
  5759. toGammaSpaceToRef(convertedColor: Color3): Color3;
  5760. private static _BlackReadOnly;
  5761. /**
  5762. * Convert Hue, saturation and value to a Color3 (RGB)
  5763. * @param hue defines the hue
  5764. * @param saturation defines the saturation
  5765. * @param value defines the value
  5766. * @param result defines the Color3 where to store the RGB values
  5767. */
  5768. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  5769. /**
  5770. * Creates a new Color3 from the string containing valid hexadecimal values
  5771. * @param hex defines a string containing valid hexadecimal values
  5772. * @returns a new Color3 object
  5773. */
  5774. static FromHexString(hex: string): Color3;
  5775. /**
  5776. * Creates a new Color3 from the starting index of the given array
  5777. * @param array defines the source array
  5778. * @param offset defines an offset in the source array
  5779. * @returns a new Color3 object
  5780. */
  5781. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5782. /**
  5783. * Creates a new Color3 from the starting index element of the given array
  5784. * @param array defines the source array to read from
  5785. * @param offset defines the offset in the source array
  5786. * @param result defines the target Color3 object
  5787. */
  5788. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  5789. /**
  5790. * Creates a new Color3 from integer values (< 256)
  5791. * @param r defines the red component to read from (value between 0 and 255)
  5792. * @param g defines the green component to read from (value between 0 and 255)
  5793. * @param b defines the blue component to read from (value between 0 and 255)
  5794. * @returns a new Color3 object
  5795. */
  5796. static FromInts(r: number, g: number, b: number): Color3;
  5797. /**
  5798. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5799. * @param start defines the start Color3 value
  5800. * @param end defines the end Color3 value
  5801. * @param amount defines the gradient value between start and end
  5802. * @returns a new Color3 object
  5803. */
  5804. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  5805. /**
  5806. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5807. * @param left defines the start value
  5808. * @param right defines the end value
  5809. * @param amount defines the gradient factor
  5810. * @param result defines the Color3 object where to store the result
  5811. */
  5812. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  5813. /**
  5814. * Returns a Color3 value containing a red color
  5815. * @returns a new Color3 object
  5816. */
  5817. static Red(): Color3;
  5818. /**
  5819. * Returns a Color3 value containing a green color
  5820. * @returns a new Color3 object
  5821. */
  5822. static Green(): Color3;
  5823. /**
  5824. * Returns a Color3 value containing a blue color
  5825. * @returns a new Color3 object
  5826. */
  5827. static Blue(): Color3;
  5828. /**
  5829. * Returns a Color3 value containing a black color
  5830. * @returns a new Color3 object
  5831. */
  5832. static Black(): Color3;
  5833. /**
  5834. * Gets a Color3 value containing a black color that must not be updated
  5835. */
  5836. static get BlackReadOnly(): DeepImmutable<Color3>;
  5837. /**
  5838. * Returns a Color3 value containing a white color
  5839. * @returns a new Color3 object
  5840. */
  5841. static White(): Color3;
  5842. /**
  5843. * Returns a Color3 value containing a purple color
  5844. * @returns a new Color3 object
  5845. */
  5846. static Purple(): Color3;
  5847. /**
  5848. * Returns a Color3 value containing a magenta color
  5849. * @returns a new Color3 object
  5850. */
  5851. static Magenta(): Color3;
  5852. /**
  5853. * Returns a Color3 value containing a yellow color
  5854. * @returns a new Color3 object
  5855. */
  5856. static Yellow(): Color3;
  5857. /**
  5858. * Returns a Color3 value containing a gray color
  5859. * @returns a new Color3 object
  5860. */
  5861. static Gray(): Color3;
  5862. /**
  5863. * Returns a Color3 value containing a teal color
  5864. * @returns a new Color3 object
  5865. */
  5866. static Teal(): Color3;
  5867. /**
  5868. * Returns a Color3 value containing a random color
  5869. * @returns a new Color3 object
  5870. */
  5871. static Random(): Color3;
  5872. }
  5873. /**
  5874. * Class used to hold a RBGA color
  5875. */
  5876. export class Color4 {
  5877. /**
  5878. * Defines the red component (between 0 and 1, default is 0)
  5879. */
  5880. r: number;
  5881. /**
  5882. * Defines the green component (between 0 and 1, default is 0)
  5883. */
  5884. g: number;
  5885. /**
  5886. * Defines the blue component (between 0 and 1, default is 0)
  5887. */
  5888. b: number;
  5889. /**
  5890. * Defines the alpha component (between 0 and 1, default is 1)
  5891. */
  5892. a: number;
  5893. /**
  5894. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  5895. * @param r defines the red component (between 0 and 1, default is 0)
  5896. * @param g defines the green component (between 0 and 1, default is 0)
  5897. * @param b defines the blue component (between 0 and 1, default is 0)
  5898. * @param a defines the alpha component (between 0 and 1, default is 1)
  5899. */
  5900. constructor(
  5901. /**
  5902. * Defines the red component (between 0 and 1, default is 0)
  5903. */
  5904. r?: number,
  5905. /**
  5906. * Defines the green component (between 0 and 1, default is 0)
  5907. */
  5908. g?: number,
  5909. /**
  5910. * Defines the blue component (between 0 and 1, default is 0)
  5911. */
  5912. b?: number,
  5913. /**
  5914. * Defines the alpha component (between 0 and 1, default is 1)
  5915. */
  5916. a?: number);
  5917. /**
  5918. * Adds in place the given Color4 values to the current Color4 object
  5919. * @param right defines the second operand
  5920. * @returns the current updated Color4 object
  5921. */
  5922. addInPlace(right: DeepImmutable<Color4>): Color4;
  5923. /**
  5924. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  5925. * @returns the new array
  5926. */
  5927. asArray(): number[];
  5928. /**
  5929. * Stores from the starting index in the given array the Color4 successive values
  5930. * @param array defines the array where to store the r,g,b components
  5931. * @param index defines an optional index in the target array to define where to start storing values
  5932. * @returns the current Color4 object
  5933. */
  5934. toArray(array: number[], index?: number): Color4;
  5935. /**
  5936. * Update the current color with values stored in an array from the starting index of the given array
  5937. * @param array defines the source array
  5938. * @param offset defines an offset in the source array
  5939. * @returns the current Color4 object
  5940. */
  5941. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  5942. /**
  5943. * Determines equality between Color4 objects
  5944. * @param otherColor defines the second operand
  5945. * @returns true if the rgba values are equal to the given ones
  5946. */
  5947. equals(otherColor: DeepImmutable<Color4>): boolean;
  5948. /**
  5949. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  5950. * @param right defines the second operand
  5951. * @returns a new Color4 object
  5952. */
  5953. add(right: DeepImmutable<Color4>): Color4;
  5954. /**
  5955. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  5956. * @param right defines the second operand
  5957. * @returns a new Color4 object
  5958. */
  5959. subtract(right: DeepImmutable<Color4>): Color4;
  5960. /**
  5961. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  5962. * @param right defines the second operand
  5963. * @param result defines the Color4 object where to store the result
  5964. * @returns the current Color4 object
  5965. */
  5966. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  5967. /**
  5968. * Creates a new Color4 with the current Color4 values multiplied by scale
  5969. * @param scale defines the scaling factor to apply
  5970. * @returns a new Color4 object
  5971. */
  5972. scale(scale: number): Color4;
  5973. /**
  5974. * Multiplies the current Color4 values by scale and stores the result in "result"
  5975. * @param scale defines the scaling factor to apply
  5976. * @param result defines the Color4 object where to store the result
  5977. * @returns the current unmodified Color4
  5978. */
  5979. scaleToRef(scale: number, result: Color4): Color4;
  5980. /**
  5981. * Scale the current Color4 values by a factor and add the result to a given Color4
  5982. * @param scale defines the scale factor
  5983. * @param result defines the Color4 object where to store the result
  5984. * @returns the unmodified current Color4
  5985. */
  5986. scaleAndAddToRef(scale: number, result: Color4): Color4;
  5987. /**
  5988. * Clamps the rgb values by the min and max values and stores the result into "result"
  5989. * @param min defines minimum clamping value (default is 0)
  5990. * @param max defines maximum clamping value (default is 1)
  5991. * @param result defines color to store the result into.
  5992. * @returns the cuurent Color4
  5993. */
  5994. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  5995. /**
  5996. * Multipy an Color4 value by another and return a new Color4 object
  5997. * @param color defines the Color4 value to multiply by
  5998. * @returns a new Color4 object
  5999. */
  6000. multiply(color: Color4): Color4;
  6001. /**
  6002. * Multipy a Color4 value by another and push the result in a reference value
  6003. * @param color defines the Color4 value to multiply by
  6004. * @param result defines the Color4 to fill the result in
  6005. * @returns the result Color4
  6006. */
  6007. multiplyToRef(color: Color4, result: Color4): Color4;
  6008. /**
  6009. * Creates a string with the Color4 current values
  6010. * @returns the string representation of the Color4 object
  6011. */
  6012. toString(): string;
  6013. /**
  6014. * Returns the string "Color4"
  6015. * @returns "Color4"
  6016. */
  6017. getClassName(): string;
  6018. /**
  6019. * Compute the Color4 hash code
  6020. * @returns an unique number that can be used to hash Color4 objects
  6021. */
  6022. getHashCode(): number;
  6023. /**
  6024. * Creates a new Color4 copied from the current one
  6025. * @returns a new Color4 object
  6026. */
  6027. clone(): Color4;
  6028. /**
  6029. * Copies the given Color4 values into the current one
  6030. * @param source defines the source Color4 object
  6031. * @returns the current updated Color4 object
  6032. */
  6033. copyFrom(source: Color4): Color4;
  6034. /**
  6035. * Copies the given float values into the current one
  6036. * @param r defines the red component to read from
  6037. * @param g defines the green component to read from
  6038. * @param b defines the blue component to read from
  6039. * @param a defines the alpha component to read from
  6040. * @returns the current updated Color4 object
  6041. */
  6042. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  6043. /**
  6044. * Copies the given float values into the current one
  6045. * @param r defines the red component to read from
  6046. * @param g defines the green component to read from
  6047. * @param b defines the blue component to read from
  6048. * @param a defines the alpha component to read from
  6049. * @returns the current updated Color4 object
  6050. */
  6051. set(r: number, g: number, b: number, a: number): Color4;
  6052. /**
  6053. * Compute the Color4 hexadecimal code as a string
  6054. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  6055. * @returns a string containing the hexadecimal representation of the Color4 object
  6056. */
  6057. toHexString(returnAsColor3?: boolean): string;
  6058. /**
  6059. * Computes a new Color4 converted from the current one to linear space
  6060. * @returns a new Color4 object
  6061. */
  6062. toLinearSpace(): Color4;
  6063. /**
  6064. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  6065. * @param convertedColor defines the Color4 object where to store the linear space version
  6066. * @returns the unmodified Color4
  6067. */
  6068. toLinearSpaceToRef(convertedColor: Color4): Color4;
  6069. /**
  6070. * Computes a new Color4 converted from the current one to gamma space
  6071. * @returns a new Color4 object
  6072. */
  6073. toGammaSpace(): Color4;
  6074. /**
  6075. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  6076. * @param convertedColor defines the Color4 object where to store the gamma space version
  6077. * @returns the unmodified Color4
  6078. */
  6079. toGammaSpaceToRef(convertedColor: Color4): Color4;
  6080. /**
  6081. * Creates a new Color4 from the string containing valid hexadecimal values
  6082. * @param hex defines a string containing valid hexadecimal values
  6083. * @returns a new Color4 object
  6084. */
  6085. static FromHexString(hex: string): Color4;
  6086. /**
  6087. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6088. * @param left defines the start value
  6089. * @param right defines the end value
  6090. * @param amount defines the gradient factor
  6091. * @returns a new Color4 object
  6092. */
  6093. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  6094. /**
  6095. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6096. * @param left defines the start value
  6097. * @param right defines the end value
  6098. * @param amount defines the gradient factor
  6099. * @param result defines the Color4 object where to store data
  6100. */
  6101. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  6102. /**
  6103. * Creates a new Color4 from a Color3 and an alpha value
  6104. * @param color3 defines the source Color3 to read from
  6105. * @param alpha defines the alpha component (1.0 by default)
  6106. * @returns a new Color4 object
  6107. */
  6108. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  6109. /**
  6110. * Creates a new Color4 from the starting index element of the given array
  6111. * @param array defines the source array to read from
  6112. * @param offset defines the offset in the source array
  6113. * @returns a new Color4 object
  6114. */
  6115. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  6116. /**
  6117. * Creates a new Color4 from the starting index element of the given array
  6118. * @param array defines the source array to read from
  6119. * @param offset defines the offset in the source array
  6120. * @param result defines the target Color4 object
  6121. */
  6122. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  6123. /**
  6124. * Creates a new Color3 from integer values (< 256)
  6125. * @param r defines the red component to read from (value between 0 and 255)
  6126. * @param g defines the green component to read from (value between 0 and 255)
  6127. * @param b defines the blue component to read from (value between 0 and 255)
  6128. * @param a defines the alpha component to read from (value between 0 and 255)
  6129. * @returns a new Color3 object
  6130. */
  6131. static FromInts(r: number, g: number, b: number, a: number): Color4;
  6132. /**
  6133. * Check the content of a given array and convert it to an array containing RGBA data
  6134. * If the original array was already containing count * 4 values then it is returned directly
  6135. * @param colors defines the array to check
  6136. * @param count defines the number of RGBA data to expect
  6137. * @returns an array containing count * 4 values (RGBA)
  6138. */
  6139. static CheckColors4(colors: number[], count: number): number[];
  6140. }
  6141. /**
  6142. * @hidden
  6143. */
  6144. export class TmpColors {
  6145. static Color3: Color3[];
  6146. static Color4: Color4[];
  6147. }
  6148. }
  6149. declare module "babylonjs/Animations/animationKey" {
  6150. /**
  6151. * Defines an interface which represents an animation key frame
  6152. */
  6153. export interface IAnimationKey {
  6154. /**
  6155. * Frame of the key frame
  6156. */
  6157. frame: number;
  6158. /**
  6159. * Value at the specifies key frame
  6160. */
  6161. value: any;
  6162. /**
  6163. * The input tangent for the cubic hermite spline
  6164. */
  6165. inTangent?: any;
  6166. /**
  6167. * The output tangent for the cubic hermite spline
  6168. */
  6169. outTangent?: any;
  6170. /**
  6171. * The animation interpolation type
  6172. */
  6173. interpolation?: AnimationKeyInterpolation;
  6174. }
  6175. /**
  6176. * Enum for the animation key frame interpolation type
  6177. */
  6178. export enum AnimationKeyInterpolation {
  6179. /**
  6180. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  6181. */
  6182. STEP = 1
  6183. }
  6184. }
  6185. declare module "babylonjs/Animations/animationRange" {
  6186. /**
  6187. * Represents the range of an animation
  6188. */
  6189. export class AnimationRange {
  6190. /**The name of the animation range**/
  6191. name: string;
  6192. /**The starting frame of the animation */
  6193. from: number;
  6194. /**The ending frame of the animation*/
  6195. to: number;
  6196. /**
  6197. * Initializes the range of an animation
  6198. * @param name The name of the animation range
  6199. * @param from The starting frame of the animation
  6200. * @param to The ending frame of the animation
  6201. */
  6202. constructor(
  6203. /**The name of the animation range**/
  6204. name: string,
  6205. /**The starting frame of the animation */
  6206. from: number,
  6207. /**The ending frame of the animation*/
  6208. to: number);
  6209. /**
  6210. * Makes a copy of the animation range
  6211. * @returns A copy of the animation range
  6212. */
  6213. clone(): AnimationRange;
  6214. }
  6215. }
  6216. declare module "babylonjs/Animations/animationEvent" {
  6217. /**
  6218. * Composed of a frame, and an action function
  6219. */
  6220. export class AnimationEvent {
  6221. /** The frame for which the event is triggered **/
  6222. frame: number;
  6223. /** The event to perform when triggered **/
  6224. action: (currentFrame: number) => void;
  6225. /** Specifies if the event should be triggered only once**/
  6226. onlyOnce?: boolean | undefined;
  6227. /**
  6228. * Specifies if the animation event is done
  6229. */
  6230. isDone: boolean;
  6231. /**
  6232. * Initializes the animation event
  6233. * @param frame The frame for which the event is triggered
  6234. * @param action The event to perform when triggered
  6235. * @param onlyOnce Specifies if the event should be triggered only once
  6236. */
  6237. constructor(
  6238. /** The frame for which the event is triggered **/
  6239. frame: number,
  6240. /** The event to perform when triggered **/
  6241. action: (currentFrame: number) => void,
  6242. /** Specifies if the event should be triggered only once**/
  6243. onlyOnce?: boolean | undefined);
  6244. /** @hidden */
  6245. _clone(): AnimationEvent;
  6246. }
  6247. }
  6248. declare module "babylonjs/Behaviors/behavior" {
  6249. import { Nullable } from "babylonjs/types";
  6250. /**
  6251. * Interface used to define a behavior
  6252. */
  6253. export interface Behavior<T> {
  6254. /** gets or sets behavior's name */
  6255. name: string;
  6256. /**
  6257. * Function called when the behavior needs to be initialized (after attaching it to a target)
  6258. */
  6259. init(): void;
  6260. /**
  6261. * Called when the behavior is attached to a target
  6262. * @param target defines the target where the behavior is attached to
  6263. */
  6264. attach(target: T): void;
  6265. /**
  6266. * Called when the behavior is detached from its target
  6267. */
  6268. detach(): void;
  6269. }
  6270. /**
  6271. * Interface implemented by classes supporting behaviors
  6272. */
  6273. export interface IBehaviorAware<T> {
  6274. /**
  6275. * Attach a behavior
  6276. * @param behavior defines the behavior to attach
  6277. * @returns the current host
  6278. */
  6279. addBehavior(behavior: Behavior<T>): T;
  6280. /**
  6281. * Remove a behavior from the current object
  6282. * @param behavior defines the behavior to detach
  6283. * @returns the current host
  6284. */
  6285. removeBehavior(behavior: Behavior<T>): T;
  6286. /**
  6287. * Gets a behavior using its name to search
  6288. * @param name defines the name to search
  6289. * @returns the behavior or null if not found
  6290. */
  6291. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  6292. }
  6293. }
  6294. declare module "babylonjs/Misc/smartArray" {
  6295. /**
  6296. * Defines an array and its length.
  6297. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  6298. */
  6299. export interface ISmartArrayLike<T> {
  6300. /**
  6301. * The data of the array.
  6302. */
  6303. data: Array<T>;
  6304. /**
  6305. * The active length of the array.
  6306. */
  6307. length: number;
  6308. }
  6309. /**
  6310. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6311. */
  6312. export class SmartArray<T> implements ISmartArrayLike<T> {
  6313. /**
  6314. * The full set of data from the array.
  6315. */
  6316. data: Array<T>;
  6317. /**
  6318. * The active length of the array.
  6319. */
  6320. length: number;
  6321. protected _id: number;
  6322. /**
  6323. * Instantiates a Smart Array.
  6324. * @param capacity defines the default capacity of the array.
  6325. */
  6326. constructor(capacity: number);
  6327. /**
  6328. * Pushes a value at the end of the active data.
  6329. * @param value defines the object to push in the array.
  6330. */
  6331. push(value: T): void;
  6332. /**
  6333. * Iterates over the active data and apply the lambda to them.
  6334. * @param func defines the action to apply on each value.
  6335. */
  6336. forEach(func: (content: T) => void): void;
  6337. /**
  6338. * Sorts the full sets of data.
  6339. * @param compareFn defines the comparison function to apply.
  6340. */
  6341. sort(compareFn: (a: T, b: T) => number): void;
  6342. /**
  6343. * Resets the active data to an empty array.
  6344. */
  6345. reset(): void;
  6346. /**
  6347. * Releases all the data from the array as well as the array.
  6348. */
  6349. dispose(): void;
  6350. /**
  6351. * Concats the active data with a given array.
  6352. * @param array defines the data to concatenate with.
  6353. */
  6354. concat(array: any): void;
  6355. /**
  6356. * Returns the position of a value in the active data.
  6357. * @param value defines the value to find the index for
  6358. * @returns the index if found in the active data otherwise -1
  6359. */
  6360. indexOf(value: T): number;
  6361. /**
  6362. * Returns whether an element is part of the active data.
  6363. * @param value defines the value to look for
  6364. * @returns true if found in the active data otherwise false
  6365. */
  6366. contains(value: T): boolean;
  6367. private static _GlobalId;
  6368. }
  6369. /**
  6370. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6371. * The data in this array can only be present once
  6372. */
  6373. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  6374. private _duplicateId;
  6375. /**
  6376. * Pushes a value at the end of the active data.
  6377. * THIS DOES NOT PREVENT DUPPLICATE DATA
  6378. * @param value defines the object to push in the array.
  6379. */
  6380. push(value: T): void;
  6381. /**
  6382. * Pushes a value at the end of the active data.
  6383. * If the data is already present, it won t be added again
  6384. * @param value defines the object to push in the array.
  6385. * @returns true if added false if it was already present
  6386. */
  6387. pushNoDuplicate(value: T): boolean;
  6388. /**
  6389. * Resets the active data to an empty array.
  6390. */
  6391. reset(): void;
  6392. /**
  6393. * Concats the active data with a given array.
  6394. * This ensures no dupplicate will be present in the result.
  6395. * @param array defines the data to concatenate with.
  6396. */
  6397. concatWithNoDuplicate(array: any): void;
  6398. }
  6399. }
  6400. declare module "babylonjs/Cameras/cameraInputsManager" {
  6401. import { Nullable } from "babylonjs/types";
  6402. import { Camera } from "babylonjs/Cameras/camera";
  6403. /**
  6404. * @ignore
  6405. * This is a list of all the different input types that are available in the application.
  6406. * Fo instance: ArcRotateCameraGamepadInput...
  6407. */
  6408. export var CameraInputTypes: {};
  6409. /**
  6410. * This is the contract to implement in order to create a new input class.
  6411. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  6412. */
  6413. export interface ICameraInput<TCamera extends Camera> {
  6414. /**
  6415. * Defines the camera the input is attached to.
  6416. */
  6417. camera: Nullable<TCamera>;
  6418. /**
  6419. * Gets the class name of the current intput.
  6420. * @returns the class name
  6421. */
  6422. getClassName(): string;
  6423. /**
  6424. * Get the friendly name associated with the input class.
  6425. * @returns the input friendly name
  6426. */
  6427. getSimpleName(): string;
  6428. /**
  6429. * Attach the input controls to a specific dom element to get the input from.
  6430. * @param element Defines the element the controls should be listened from
  6431. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6432. */
  6433. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  6434. /**
  6435. * Detach the current controls from the specified dom element.
  6436. * @param element Defines the element to stop listening the inputs from
  6437. */
  6438. detachControl(element: Nullable<HTMLElement>): void;
  6439. /**
  6440. * Update the current camera state depending on the inputs that have been used this frame.
  6441. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6442. */
  6443. checkInputs?: () => void;
  6444. }
  6445. /**
  6446. * Represents a map of input types to input instance or input index to input instance.
  6447. */
  6448. export interface CameraInputsMap<TCamera extends Camera> {
  6449. /**
  6450. * Accessor to the input by input type.
  6451. */
  6452. [name: string]: ICameraInput<TCamera>;
  6453. /**
  6454. * Accessor to the input by input index.
  6455. */
  6456. [idx: number]: ICameraInput<TCamera>;
  6457. }
  6458. /**
  6459. * This represents the input manager used within a camera.
  6460. * It helps dealing with all the different kind of input attached to a camera.
  6461. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  6462. */
  6463. export class CameraInputsManager<TCamera extends Camera> {
  6464. /**
  6465. * Defines the list of inputs attahed to the camera.
  6466. */
  6467. attached: CameraInputsMap<TCamera>;
  6468. /**
  6469. * Defines the dom element the camera is collecting inputs from.
  6470. * This is null if the controls have not been attached.
  6471. */
  6472. attachedElement: Nullable<HTMLElement>;
  6473. /**
  6474. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6475. */
  6476. noPreventDefault: boolean;
  6477. /**
  6478. * Defined the camera the input manager belongs to.
  6479. */
  6480. camera: TCamera;
  6481. /**
  6482. * Update the current camera state depending on the inputs that have been used this frame.
  6483. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6484. */
  6485. checkInputs: () => void;
  6486. /**
  6487. * Instantiate a new Camera Input Manager.
  6488. * @param camera Defines the camera the input manager blongs to
  6489. */
  6490. constructor(camera: TCamera);
  6491. /**
  6492. * Add an input method to a camera
  6493. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  6494. * @param input camera input method
  6495. */
  6496. add(input: ICameraInput<TCamera>): void;
  6497. /**
  6498. * Remove a specific input method from a camera
  6499. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  6500. * @param inputToRemove camera input method
  6501. */
  6502. remove(inputToRemove: ICameraInput<TCamera>): void;
  6503. /**
  6504. * Remove a specific input type from a camera
  6505. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  6506. * @param inputType the type of the input to remove
  6507. */
  6508. removeByType(inputType: string): void;
  6509. private _addCheckInputs;
  6510. /**
  6511. * Attach the input controls to the currently attached dom element to listen the events from.
  6512. * @param input Defines the input to attach
  6513. */
  6514. attachInput(input: ICameraInput<TCamera>): void;
  6515. /**
  6516. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  6517. * @param element Defines the dom element to collect the events from
  6518. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6519. */
  6520. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  6521. /**
  6522. * Detach the current manager inputs controls from a specific dom element.
  6523. * @param element Defines the dom element to collect the events from
  6524. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  6525. */
  6526. detachElement(element: HTMLElement, disconnect?: boolean): void;
  6527. /**
  6528. * Rebuild the dynamic inputCheck function from the current list of
  6529. * defined inputs in the manager.
  6530. */
  6531. rebuildInputCheck(): void;
  6532. /**
  6533. * Remove all attached input methods from a camera
  6534. */
  6535. clear(): void;
  6536. /**
  6537. * Serialize the current input manager attached to a camera.
  6538. * This ensures than once parsed,
  6539. * the input associated to the camera will be identical to the current ones
  6540. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  6541. */
  6542. serialize(serializedCamera: any): void;
  6543. /**
  6544. * Parses an input manager serialized JSON to restore the previous list of inputs
  6545. * and states associated to a camera.
  6546. * @param parsedCamera Defines the JSON to parse
  6547. */
  6548. parse(parsedCamera: any): void;
  6549. }
  6550. }
  6551. declare module "babylonjs/Meshes/buffer" {
  6552. import { Nullable, DataArray } from "babylonjs/types";
  6553. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  6554. /**
  6555. * Class used to store data that will be store in GPU memory
  6556. */
  6557. export class Buffer {
  6558. private _engine;
  6559. private _buffer;
  6560. /** @hidden */
  6561. _data: Nullable<DataArray>;
  6562. private _updatable;
  6563. private _instanced;
  6564. private _divisor;
  6565. /**
  6566. * Gets the byte stride.
  6567. */
  6568. readonly byteStride: number;
  6569. /**
  6570. * Constructor
  6571. * @param engine the engine
  6572. * @param data the data to use for this buffer
  6573. * @param updatable whether the data is updatable
  6574. * @param stride the stride (optional)
  6575. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6576. * @param instanced whether the buffer is instanced (optional)
  6577. * @param useBytes set to true if the stride in in bytes (optional)
  6578. * @param divisor sets an optional divisor for instances (1 by default)
  6579. */
  6580. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  6581. /**
  6582. * Create a new VertexBuffer based on the current buffer
  6583. * @param kind defines the vertex buffer kind (position, normal, etc.)
  6584. * @param offset defines offset in the buffer (0 by default)
  6585. * @param size defines the size in floats of attributes (position is 3 for instance)
  6586. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  6587. * @param instanced defines if the vertex buffer contains indexed data
  6588. * @param useBytes defines if the offset and stride are in bytes *
  6589. * @param divisor sets an optional divisor for instances (1 by default)
  6590. * @returns the new vertex buffer
  6591. */
  6592. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  6593. /**
  6594. * Gets a boolean indicating if the Buffer is updatable?
  6595. * @returns true if the buffer is updatable
  6596. */
  6597. isUpdatable(): boolean;
  6598. /**
  6599. * Gets current buffer's data
  6600. * @returns a DataArray or null
  6601. */
  6602. getData(): Nullable<DataArray>;
  6603. /**
  6604. * Gets underlying native buffer
  6605. * @returns underlying native buffer
  6606. */
  6607. getBuffer(): Nullable<DataBuffer>;
  6608. /**
  6609. * Gets the stride in float32 units (i.e. byte stride / 4).
  6610. * May not be an integer if the byte stride is not divisible by 4.
  6611. * @returns the stride in float32 units
  6612. * @deprecated Please use byteStride instead.
  6613. */
  6614. getStrideSize(): number;
  6615. /**
  6616. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6617. * @param data defines the data to store
  6618. */
  6619. create(data?: Nullable<DataArray>): void;
  6620. /** @hidden */
  6621. _rebuild(): void;
  6622. /**
  6623. * Update current buffer data
  6624. * @param data defines the data to store
  6625. */
  6626. update(data: DataArray): void;
  6627. /**
  6628. * Updates the data directly.
  6629. * @param data the new data
  6630. * @param offset the new offset
  6631. * @param vertexCount the vertex count (optional)
  6632. * @param useBytes set to true if the offset is in bytes
  6633. */
  6634. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  6635. /**
  6636. * Release all resources
  6637. */
  6638. dispose(): void;
  6639. }
  6640. /**
  6641. * Specialized buffer used to store vertex data
  6642. */
  6643. export class VertexBuffer {
  6644. /** @hidden */
  6645. _buffer: Buffer;
  6646. private _kind;
  6647. private _size;
  6648. private _ownsBuffer;
  6649. private _instanced;
  6650. private _instanceDivisor;
  6651. /**
  6652. * The byte type.
  6653. */
  6654. static readonly BYTE: number;
  6655. /**
  6656. * The unsigned byte type.
  6657. */
  6658. static readonly UNSIGNED_BYTE: number;
  6659. /**
  6660. * The short type.
  6661. */
  6662. static readonly SHORT: number;
  6663. /**
  6664. * The unsigned short type.
  6665. */
  6666. static readonly UNSIGNED_SHORT: number;
  6667. /**
  6668. * The integer type.
  6669. */
  6670. static readonly INT: number;
  6671. /**
  6672. * The unsigned integer type.
  6673. */
  6674. static readonly UNSIGNED_INT: number;
  6675. /**
  6676. * The float type.
  6677. */
  6678. static readonly FLOAT: number;
  6679. /**
  6680. * Gets or sets the instance divisor when in instanced mode
  6681. */
  6682. get instanceDivisor(): number;
  6683. set instanceDivisor(value: number);
  6684. /**
  6685. * Gets the byte stride.
  6686. */
  6687. readonly byteStride: number;
  6688. /**
  6689. * Gets the byte offset.
  6690. */
  6691. readonly byteOffset: number;
  6692. /**
  6693. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  6694. */
  6695. readonly normalized: boolean;
  6696. /**
  6697. * Gets the data type of each component in the array.
  6698. */
  6699. readonly type: number;
  6700. /**
  6701. * Constructor
  6702. * @param engine the engine
  6703. * @param data the data to use for this vertex buffer
  6704. * @param kind the vertex buffer kind
  6705. * @param updatable whether the data is updatable
  6706. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6707. * @param stride the stride (optional)
  6708. * @param instanced whether the buffer is instanced (optional)
  6709. * @param offset the offset of the data (optional)
  6710. * @param size the number of components (optional)
  6711. * @param type the type of the component (optional)
  6712. * @param normalized whether the data contains normalized data (optional)
  6713. * @param useBytes set to true if stride and offset are in bytes (optional)
  6714. * @param divisor defines the instance divisor to use (1 by default)
  6715. */
  6716. 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);
  6717. /** @hidden */
  6718. _rebuild(): void;
  6719. /**
  6720. * Returns the kind of the VertexBuffer (string)
  6721. * @returns a string
  6722. */
  6723. getKind(): string;
  6724. /**
  6725. * Gets a boolean indicating if the VertexBuffer is updatable?
  6726. * @returns true if the buffer is updatable
  6727. */
  6728. isUpdatable(): boolean;
  6729. /**
  6730. * Gets current buffer's data
  6731. * @returns a DataArray or null
  6732. */
  6733. getData(): Nullable<DataArray>;
  6734. /**
  6735. * Gets underlying native buffer
  6736. * @returns underlying native buffer
  6737. */
  6738. getBuffer(): Nullable<DataBuffer>;
  6739. /**
  6740. * Gets the stride in float32 units (i.e. byte stride / 4).
  6741. * May not be an integer if the byte stride is not divisible by 4.
  6742. * @returns the stride in float32 units
  6743. * @deprecated Please use byteStride instead.
  6744. */
  6745. getStrideSize(): number;
  6746. /**
  6747. * Returns the offset as a multiple of the type byte length.
  6748. * @returns the offset in bytes
  6749. * @deprecated Please use byteOffset instead.
  6750. */
  6751. getOffset(): number;
  6752. /**
  6753. * Returns the number of components per vertex attribute (integer)
  6754. * @returns the size in float
  6755. */
  6756. getSize(): number;
  6757. /**
  6758. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  6759. * @returns true if this buffer is instanced
  6760. */
  6761. getIsInstanced(): boolean;
  6762. /**
  6763. * Returns the instancing divisor, zero for non-instanced (integer).
  6764. * @returns a number
  6765. */
  6766. getInstanceDivisor(): number;
  6767. /**
  6768. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6769. * @param data defines the data to store
  6770. */
  6771. create(data?: DataArray): void;
  6772. /**
  6773. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  6774. * This function will create a new buffer if the current one is not updatable
  6775. * @param data defines the data to store
  6776. */
  6777. update(data: DataArray): void;
  6778. /**
  6779. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  6780. * Returns the directly updated WebGLBuffer.
  6781. * @param data the new data
  6782. * @param offset the new offset
  6783. * @param useBytes set to true if the offset is in bytes
  6784. */
  6785. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  6786. /**
  6787. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  6788. */
  6789. dispose(): void;
  6790. /**
  6791. * Enumerates each value of this vertex buffer as numbers.
  6792. * @param count the number of values to enumerate
  6793. * @param callback the callback function called for each value
  6794. */
  6795. forEach(count: number, callback: (value: number, index: number) => void): void;
  6796. /**
  6797. * Positions
  6798. */
  6799. static readonly PositionKind: string;
  6800. /**
  6801. * Normals
  6802. */
  6803. static readonly NormalKind: string;
  6804. /**
  6805. * Tangents
  6806. */
  6807. static readonly TangentKind: string;
  6808. /**
  6809. * Texture coordinates
  6810. */
  6811. static readonly UVKind: string;
  6812. /**
  6813. * Texture coordinates 2
  6814. */
  6815. static readonly UV2Kind: string;
  6816. /**
  6817. * Texture coordinates 3
  6818. */
  6819. static readonly UV3Kind: string;
  6820. /**
  6821. * Texture coordinates 4
  6822. */
  6823. static readonly UV4Kind: string;
  6824. /**
  6825. * Texture coordinates 5
  6826. */
  6827. static readonly UV5Kind: string;
  6828. /**
  6829. * Texture coordinates 6
  6830. */
  6831. static readonly UV6Kind: string;
  6832. /**
  6833. * Colors
  6834. */
  6835. static readonly ColorKind: string;
  6836. /**
  6837. * Matrix indices (for bones)
  6838. */
  6839. static readonly MatricesIndicesKind: string;
  6840. /**
  6841. * Matrix weights (for bones)
  6842. */
  6843. static readonly MatricesWeightsKind: string;
  6844. /**
  6845. * Additional matrix indices (for bones)
  6846. */
  6847. static readonly MatricesIndicesExtraKind: string;
  6848. /**
  6849. * Additional matrix weights (for bones)
  6850. */
  6851. static readonly MatricesWeightsExtraKind: string;
  6852. /**
  6853. * Deduces the stride given a kind.
  6854. * @param kind The kind string to deduce
  6855. * @returns The deduced stride
  6856. */
  6857. static DeduceStride(kind: string): number;
  6858. /**
  6859. * Gets the byte length of the given type.
  6860. * @param type the type
  6861. * @returns the number of bytes
  6862. */
  6863. static GetTypeByteLength(type: number): number;
  6864. /**
  6865. * Enumerates each value of the given parameters as numbers.
  6866. * @param data the data to enumerate
  6867. * @param byteOffset the byte offset of the data
  6868. * @param byteStride the byte stride of the data
  6869. * @param componentCount the number of components per element
  6870. * @param componentType the type of the component
  6871. * @param count the number of values to enumerate
  6872. * @param normalized whether the data is normalized
  6873. * @param callback the callback function called for each value
  6874. */
  6875. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  6876. private static _GetFloatValue;
  6877. }
  6878. }
  6879. declare module "babylonjs/Meshes/Builders/capsuleBuilder" {
  6880. import { Vector3 } from "babylonjs/Maths/math.vector";
  6881. import { Mesh } from "babylonjs/Meshes/mesh";
  6882. /**
  6883. * The options Interface for creating a Capsule Mesh
  6884. */
  6885. export interface ICreateCapsuleOptions {
  6886. /** The Orientation of the capsule. Default : Vector3.Up() */
  6887. orientation?: Vector3;
  6888. /** Number of sub segments on the tube section of the capsule running parallel to orientation. */
  6889. subdivisions: number;
  6890. /** Number of cylindrical segments on the capsule. */
  6891. tessellation: number;
  6892. /** Height or Length of the capsule. */
  6893. height: number;
  6894. /** Radius of the capsule. */
  6895. radius: number;
  6896. /** Number of sub segments on the cap sections of the capsule running parallel to orientation. */
  6897. capSubdivisions: number;
  6898. /** Overwrite for the top radius. */
  6899. radiusTop?: number;
  6900. /** Overwrite for the bottom radius. */
  6901. radiusBottom?: number;
  6902. /** Overwrite for the top capSubdivisions. */
  6903. topCapSubdivisions?: number;
  6904. /** Overwrite for the bottom capSubdivisions. */
  6905. bottomCapSubdivisions?: number;
  6906. }
  6907. /**
  6908. * Class containing static functions to help procedurally build meshes
  6909. */
  6910. export class CapsuleBuilder {
  6911. /**
  6912. * Creates a capsule or a pill mesh
  6913. * @param name defines the name of the mesh
  6914. * @param options The constructors options.
  6915. * @param scene The scene the mesh is scoped to.
  6916. * @returns Capsule Mesh
  6917. */
  6918. static CreateCapsule(name: string, options: ICreateCapsuleOptions | undefined, scene: any): Mesh;
  6919. }
  6920. }
  6921. declare module "babylonjs/Collisions/intersectionInfo" {
  6922. import { Nullable } from "babylonjs/types";
  6923. /**
  6924. * @hidden
  6925. */
  6926. export class IntersectionInfo {
  6927. bu: Nullable<number>;
  6928. bv: Nullable<number>;
  6929. distance: number;
  6930. faceId: number;
  6931. subMeshId: number;
  6932. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  6933. }
  6934. }
  6935. declare module "babylonjs/Culling/boundingSphere" {
  6936. import { DeepImmutable } from "babylonjs/types";
  6937. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6938. import { Plane } from "babylonjs/Maths/math.plane";
  6939. /**
  6940. * Class used to store bounding sphere information
  6941. */
  6942. export class BoundingSphere {
  6943. /**
  6944. * Gets the center of the bounding sphere in local space
  6945. */
  6946. readonly center: Vector3;
  6947. /**
  6948. * Radius of the bounding sphere in local space
  6949. */
  6950. radius: number;
  6951. /**
  6952. * Gets the center of the bounding sphere in world space
  6953. */
  6954. readonly centerWorld: Vector3;
  6955. /**
  6956. * Radius of the bounding sphere in world space
  6957. */
  6958. radiusWorld: number;
  6959. /**
  6960. * Gets the minimum vector in local space
  6961. */
  6962. readonly minimum: Vector3;
  6963. /**
  6964. * Gets the maximum vector in local space
  6965. */
  6966. readonly maximum: Vector3;
  6967. private _worldMatrix;
  6968. private static readonly TmpVector3;
  6969. /**
  6970. * Creates a new bounding sphere
  6971. * @param min defines the minimum vector (in local space)
  6972. * @param max defines the maximum vector (in local space)
  6973. * @param worldMatrix defines the new world matrix
  6974. */
  6975. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6976. /**
  6977. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  6978. * @param min defines the new minimum vector (in local space)
  6979. * @param max defines the new maximum vector (in local space)
  6980. * @param worldMatrix defines the new world matrix
  6981. */
  6982. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6983. /**
  6984. * Scale the current bounding sphere by applying a scale factor
  6985. * @param factor defines the scale factor to apply
  6986. * @returns the current bounding box
  6987. */
  6988. scale(factor: number): BoundingSphere;
  6989. /**
  6990. * Gets the world matrix of the bounding box
  6991. * @returns a matrix
  6992. */
  6993. getWorldMatrix(): DeepImmutable<Matrix>;
  6994. /** @hidden */
  6995. _update(worldMatrix: DeepImmutable<Matrix>): void;
  6996. /**
  6997. * Tests if the bounding sphere is intersecting the frustum planes
  6998. * @param frustumPlanes defines the frustum planes to test
  6999. * @returns true if there is an intersection
  7000. */
  7001. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7002. /**
  7003. * Tests if the bounding sphere center is in between the frustum planes.
  7004. * Used for optimistic fast inclusion.
  7005. * @param frustumPlanes defines the frustum planes to test
  7006. * @returns true if the sphere center is in between the frustum planes
  7007. */
  7008. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7009. /**
  7010. * Tests if a point is inside the bounding sphere
  7011. * @param point defines the point to test
  7012. * @returns true if the point is inside the bounding sphere
  7013. */
  7014. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7015. /**
  7016. * Checks if two sphere intersct
  7017. * @param sphere0 sphere 0
  7018. * @param sphere1 sphere 1
  7019. * @returns true if the speres intersect
  7020. */
  7021. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  7022. }
  7023. }
  7024. declare module "babylonjs/Culling/boundingBox" {
  7025. import { DeepImmutable } from "babylonjs/types";
  7026. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7027. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  7028. import { ICullable } from "babylonjs/Culling/boundingInfo";
  7029. import { Plane } from "babylonjs/Maths/math.plane";
  7030. /**
  7031. * Class used to store bounding box information
  7032. */
  7033. export class BoundingBox implements ICullable {
  7034. /**
  7035. * Gets the 8 vectors representing the bounding box in local space
  7036. */
  7037. readonly vectors: Vector3[];
  7038. /**
  7039. * Gets the center of the bounding box in local space
  7040. */
  7041. readonly center: Vector3;
  7042. /**
  7043. * Gets the center of the bounding box in world space
  7044. */
  7045. readonly centerWorld: Vector3;
  7046. /**
  7047. * Gets the extend size in local space
  7048. */
  7049. readonly extendSize: Vector3;
  7050. /**
  7051. * Gets the extend size in world space
  7052. */
  7053. readonly extendSizeWorld: Vector3;
  7054. /**
  7055. * Gets the OBB (object bounding box) directions
  7056. */
  7057. readonly directions: Vector3[];
  7058. /**
  7059. * Gets the 8 vectors representing the bounding box in world space
  7060. */
  7061. readonly vectorsWorld: Vector3[];
  7062. /**
  7063. * Gets the minimum vector in world space
  7064. */
  7065. readonly minimumWorld: Vector3;
  7066. /**
  7067. * Gets the maximum vector in world space
  7068. */
  7069. readonly maximumWorld: Vector3;
  7070. /**
  7071. * Gets the minimum vector in local space
  7072. */
  7073. readonly minimum: Vector3;
  7074. /**
  7075. * Gets the maximum vector in local space
  7076. */
  7077. readonly maximum: Vector3;
  7078. private _worldMatrix;
  7079. private static readonly TmpVector3;
  7080. /**
  7081. * @hidden
  7082. */
  7083. _tag: number;
  7084. /**
  7085. * Creates a new bounding box
  7086. * @param min defines the minimum vector (in local space)
  7087. * @param max defines the maximum vector (in local space)
  7088. * @param worldMatrix defines the new world matrix
  7089. */
  7090. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7091. /**
  7092. * Recreates the entire bounding box from scratch as if we call the constructor in place
  7093. * @param min defines the new minimum vector (in local space)
  7094. * @param max defines the new maximum vector (in local space)
  7095. * @param worldMatrix defines the new world matrix
  7096. */
  7097. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7098. /**
  7099. * Scale the current bounding box by applying a scale factor
  7100. * @param factor defines the scale factor to apply
  7101. * @returns the current bounding box
  7102. */
  7103. scale(factor: number): BoundingBox;
  7104. /**
  7105. * Gets the world matrix of the bounding box
  7106. * @returns a matrix
  7107. */
  7108. getWorldMatrix(): DeepImmutable<Matrix>;
  7109. /** @hidden */
  7110. _update(world: DeepImmutable<Matrix>): void;
  7111. /**
  7112. * Tests if the bounding box is intersecting the frustum planes
  7113. * @param frustumPlanes defines the frustum planes to test
  7114. * @returns true if there is an intersection
  7115. */
  7116. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7117. /**
  7118. * Tests if the bounding box is entirely inside the frustum planes
  7119. * @param frustumPlanes defines the frustum planes to test
  7120. * @returns true if there is an inclusion
  7121. */
  7122. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7123. /**
  7124. * Tests if a point is inside the bounding box
  7125. * @param point defines the point to test
  7126. * @returns true if the point is inside the bounding box
  7127. */
  7128. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7129. /**
  7130. * Tests if the bounding box intersects with a bounding sphere
  7131. * @param sphere defines the sphere to test
  7132. * @returns true if there is an intersection
  7133. */
  7134. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  7135. /**
  7136. * Tests if the bounding box intersects with a box defined by a min and max vectors
  7137. * @param min defines the min vector to use
  7138. * @param max defines the max vector to use
  7139. * @returns true if there is an intersection
  7140. */
  7141. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  7142. /**
  7143. * Tests if two bounding boxes are intersections
  7144. * @param box0 defines the first box to test
  7145. * @param box1 defines the second box to test
  7146. * @returns true if there is an intersection
  7147. */
  7148. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  7149. /**
  7150. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  7151. * @param minPoint defines the minimum vector of the bounding box
  7152. * @param maxPoint defines the maximum vector of the bounding box
  7153. * @param sphereCenter defines the sphere center
  7154. * @param sphereRadius defines the sphere radius
  7155. * @returns true if there is an intersection
  7156. */
  7157. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  7158. /**
  7159. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  7160. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7161. * @param frustumPlanes defines the frustum planes to test
  7162. * @return true if there is an inclusion
  7163. */
  7164. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7165. /**
  7166. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  7167. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7168. * @param frustumPlanes defines the frustum planes to test
  7169. * @return true if there is an intersection
  7170. */
  7171. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7172. }
  7173. }
  7174. declare module "babylonjs/Collisions/collider" {
  7175. import { Nullable, IndicesArray } from "babylonjs/types";
  7176. import { Vector3 } from "babylonjs/Maths/math.vector";
  7177. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  7178. import { Plane } from "babylonjs/Maths/math.plane";
  7179. /** @hidden */
  7180. export class Collider {
  7181. /** Define if a collision was found */
  7182. collisionFound: boolean;
  7183. /**
  7184. * Define last intersection point in local space
  7185. */
  7186. intersectionPoint: Vector3;
  7187. /**
  7188. * Define last collided mesh
  7189. */
  7190. collidedMesh: Nullable<AbstractMesh>;
  7191. private _collisionPoint;
  7192. private _planeIntersectionPoint;
  7193. private _tempVector;
  7194. private _tempVector2;
  7195. private _tempVector3;
  7196. private _tempVector4;
  7197. private _edge;
  7198. private _baseToVertex;
  7199. private _destinationPoint;
  7200. private _slidePlaneNormal;
  7201. private _displacementVector;
  7202. /** @hidden */
  7203. _radius: Vector3;
  7204. /** @hidden */
  7205. _retry: number;
  7206. private _velocity;
  7207. private _basePoint;
  7208. private _epsilon;
  7209. /** @hidden */
  7210. _velocityWorldLength: number;
  7211. /** @hidden */
  7212. _basePointWorld: Vector3;
  7213. private _velocityWorld;
  7214. private _normalizedVelocity;
  7215. /** @hidden */
  7216. _initialVelocity: Vector3;
  7217. /** @hidden */
  7218. _initialPosition: Vector3;
  7219. private _nearestDistance;
  7220. private _collisionMask;
  7221. get collisionMask(): number;
  7222. set collisionMask(mask: number);
  7223. /**
  7224. * Gets the plane normal used to compute the sliding response (in local space)
  7225. */
  7226. get slidePlaneNormal(): Vector3;
  7227. /** @hidden */
  7228. _initialize(source: Vector3, dir: Vector3, e: number): void;
  7229. /** @hidden */
  7230. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  7231. /** @hidden */
  7232. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  7233. /** @hidden */
  7234. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7235. /** @hidden */
  7236. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7237. /** @hidden */
  7238. _getResponse(pos: Vector3, vel: Vector3): void;
  7239. }
  7240. }
  7241. declare module "babylonjs/Culling/boundingInfo" {
  7242. import { DeepImmutable } from "babylonjs/types";
  7243. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7244. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  7245. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  7246. import { Plane } from "babylonjs/Maths/math.plane";
  7247. import { Collider } from "babylonjs/Collisions/collider";
  7248. /**
  7249. * Interface for cullable objects
  7250. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  7251. */
  7252. export interface ICullable {
  7253. /**
  7254. * Checks if the object or part of the object is in the frustum
  7255. * @param frustumPlanes Camera near/planes
  7256. * @returns true if the object is in frustum otherwise false
  7257. */
  7258. isInFrustum(frustumPlanes: Plane[]): boolean;
  7259. /**
  7260. * Checks if a cullable object (mesh...) is in the camera frustum
  7261. * Unlike isInFrustum this cheks the full bounding box
  7262. * @param frustumPlanes Camera near/planes
  7263. * @returns true if the object is in frustum otherwise false
  7264. */
  7265. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  7266. }
  7267. /**
  7268. * Info for a bounding data of a mesh
  7269. */
  7270. export class BoundingInfo implements ICullable {
  7271. /**
  7272. * Bounding box for the mesh
  7273. */
  7274. readonly boundingBox: BoundingBox;
  7275. /**
  7276. * Bounding sphere for the mesh
  7277. */
  7278. readonly boundingSphere: BoundingSphere;
  7279. private _isLocked;
  7280. private static readonly TmpVector3;
  7281. /**
  7282. * Constructs bounding info
  7283. * @param minimum min vector of the bounding box/sphere
  7284. * @param maximum max vector of the bounding box/sphere
  7285. * @param worldMatrix defines the new world matrix
  7286. */
  7287. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7288. /**
  7289. * Recreates the entire bounding info from scratch as if we call the constructor in place
  7290. * @param min defines the new minimum vector (in local space)
  7291. * @param max defines the new maximum vector (in local space)
  7292. * @param worldMatrix defines the new world matrix
  7293. */
  7294. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7295. /**
  7296. * min vector of the bounding box/sphere
  7297. */
  7298. get minimum(): Vector3;
  7299. /**
  7300. * max vector of the bounding box/sphere
  7301. */
  7302. get maximum(): Vector3;
  7303. /**
  7304. * If the info is locked and won't be updated to avoid perf overhead
  7305. */
  7306. get isLocked(): boolean;
  7307. set isLocked(value: boolean);
  7308. /**
  7309. * Updates the bounding sphere and box
  7310. * @param world world matrix to be used to update
  7311. */
  7312. update(world: DeepImmutable<Matrix>): void;
  7313. /**
  7314. * Recreate the bounding info to be centered around a specific point given a specific extend.
  7315. * @param center New center of the bounding info
  7316. * @param extend New extend of the bounding info
  7317. * @returns the current bounding info
  7318. */
  7319. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  7320. /**
  7321. * Scale the current bounding info by applying a scale factor
  7322. * @param factor defines the scale factor to apply
  7323. * @returns the current bounding info
  7324. */
  7325. scale(factor: number): BoundingInfo;
  7326. /**
  7327. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  7328. * @param frustumPlanes defines the frustum to test
  7329. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  7330. * @returns true if the bounding info is in the frustum planes
  7331. */
  7332. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  7333. /**
  7334. * Gets the world distance between the min and max points of the bounding box
  7335. */
  7336. get diagonalLength(): number;
  7337. /**
  7338. * Checks if a cullable object (mesh...) is in the camera frustum
  7339. * Unlike isInFrustum this cheks the full bounding box
  7340. * @param frustumPlanes Camera near/planes
  7341. * @returns true if the object is in frustum otherwise false
  7342. */
  7343. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7344. /** @hidden */
  7345. _checkCollision(collider: Collider): boolean;
  7346. /**
  7347. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  7348. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7349. * @param point the point to check intersection with
  7350. * @returns if the point intersects
  7351. */
  7352. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7353. /**
  7354. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  7355. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7356. * @param boundingInfo the bounding info to check intersection with
  7357. * @param precise if the intersection should be done using OBB
  7358. * @returns if the bounding info intersects
  7359. */
  7360. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  7361. }
  7362. }
  7363. declare module "babylonjs/Maths/math.functions" {
  7364. import { FloatArray, Nullable, IndicesArray } from "babylonjs/types";
  7365. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  7366. /**
  7367. * Extracts minimum and maximum values from a list of indexed positions
  7368. * @param positions defines the positions to use
  7369. * @param indices defines the indices to the positions
  7370. * @param indexStart defines the start index
  7371. * @param indexCount defines the end index
  7372. * @param bias defines bias value to add to the result
  7373. * @return minimum and maximum values
  7374. */
  7375. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  7376. minimum: Vector3;
  7377. maximum: Vector3;
  7378. };
  7379. /**
  7380. * Extracts minimum and maximum values from a list of positions
  7381. * @param positions defines the positions to use
  7382. * @param start defines the start index in the positions array
  7383. * @param count defines the number of positions to handle
  7384. * @param bias defines bias value to add to the result
  7385. * @param stride defines the stride size to use (distance between two positions in the positions array)
  7386. * @return minimum and maximum values
  7387. */
  7388. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  7389. minimum: Vector3;
  7390. maximum: Vector3;
  7391. };
  7392. }
  7393. declare module "babylonjs/Meshes/WebGL/webGLDataBuffer" {
  7394. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7395. /** @hidden */
  7396. export class WebGLDataBuffer extends DataBuffer {
  7397. private _buffer;
  7398. constructor(resource: WebGLBuffer);
  7399. get underlyingResource(): any;
  7400. }
  7401. }
  7402. declare module "babylonjs/Engines/WebGL/webGLPipelineContext" {
  7403. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7404. import { Nullable } from "babylonjs/types";
  7405. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7406. /** @hidden */
  7407. export class WebGLPipelineContext implements IPipelineContext {
  7408. engine: ThinEngine;
  7409. program: Nullable<WebGLProgram>;
  7410. context?: WebGLRenderingContext;
  7411. vertexShader?: WebGLShader;
  7412. fragmentShader?: WebGLShader;
  7413. isParallelCompiled: boolean;
  7414. onCompiled?: () => void;
  7415. transformFeedback?: WebGLTransformFeedback | null;
  7416. vertexCompilationError: Nullable<string>;
  7417. fragmentCompilationError: Nullable<string>;
  7418. programLinkError: Nullable<string>;
  7419. programValidationError: Nullable<string>;
  7420. get isAsync(): boolean;
  7421. get isReady(): boolean;
  7422. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  7423. _getVertexShaderCode(): string | null;
  7424. _getFragmentShaderCode(): string | null;
  7425. }
  7426. }
  7427. declare module "babylonjs/Engines/Extensions/engine.uniformBuffer" {
  7428. import { FloatArray, Nullable } from "babylonjs/types";
  7429. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7430. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7431. module "babylonjs/Engines/thinEngine" {
  7432. interface ThinEngine {
  7433. /**
  7434. * Create an uniform buffer
  7435. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7436. * @param elements defines the content of the uniform buffer
  7437. * @returns the webGL uniform buffer
  7438. */
  7439. createUniformBuffer(elements: FloatArray): DataBuffer;
  7440. /**
  7441. * Create a dynamic uniform buffer
  7442. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7443. * @param elements defines the content of the uniform buffer
  7444. * @returns the webGL uniform buffer
  7445. */
  7446. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  7447. /**
  7448. * Update an existing uniform buffer
  7449. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7450. * @param uniformBuffer defines the target uniform buffer
  7451. * @param elements defines the content to update
  7452. * @param offset defines the offset in the uniform buffer where update should start
  7453. * @param count defines the size of the data to update
  7454. */
  7455. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  7456. /**
  7457. * Bind an uniform buffer to the current webGL context
  7458. * @param buffer defines the buffer to bind
  7459. */
  7460. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  7461. /**
  7462. * Bind a buffer to the current webGL context at a given location
  7463. * @param buffer defines the buffer to bind
  7464. * @param location defines the index where to bind the buffer
  7465. */
  7466. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  7467. /**
  7468. * Bind a specific block at a given index in a specific shader program
  7469. * @param pipelineContext defines the pipeline context to use
  7470. * @param blockName defines the block name
  7471. * @param index defines the index where to bind the block
  7472. */
  7473. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  7474. }
  7475. }
  7476. }
  7477. declare module "babylonjs/Materials/uniformBuffer" {
  7478. import { Nullable, FloatArray } from "babylonjs/types";
  7479. import { Matrix, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  7480. import { Engine } from "babylonjs/Engines/engine";
  7481. import { Effect } from "babylonjs/Materials/effect";
  7482. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7483. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7484. import { Color3 } from "babylonjs/Maths/math.color";
  7485. import "babylonjs/Engines/Extensions/engine.uniformBuffer";
  7486. /**
  7487. * Uniform buffer objects.
  7488. *
  7489. * Handles blocks of uniform on the GPU.
  7490. *
  7491. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7492. *
  7493. * For more information, please refer to :
  7494. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7495. */
  7496. export class UniformBuffer {
  7497. private _engine;
  7498. private _buffer;
  7499. private _data;
  7500. private _bufferData;
  7501. private _dynamic?;
  7502. private _uniformLocations;
  7503. private _uniformSizes;
  7504. private _uniformLocationPointer;
  7505. private _needSync;
  7506. private _noUBO;
  7507. private _currentEffect;
  7508. /** @hidden */
  7509. _alreadyBound: boolean;
  7510. private static _MAX_UNIFORM_SIZE;
  7511. private static _tempBuffer;
  7512. /**
  7513. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  7514. * This is dynamic to allow compat with webgl 1 and 2.
  7515. * You will need to pass the name of the uniform as well as the value.
  7516. */
  7517. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  7518. /**
  7519. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  7520. * This is dynamic to allow compat with webgl 1 and 2.
  7521. * You will need to pass the name of the uniform as well as the value.
  7522. */
  7523. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  7524. /**
  7525. * Lambda to Update a single float in a uniform buffer.
  7526. * This is dynamic to allow compat with webgl 1 and 2.
  7527. * You will need to pass the name of the uniform as well as the value.
  7528. */
  7529. updateFloat: (name: string, x: number) => void;
  7530. /**
  7531. * Lambda to Update a vec2 of float in a uniform buffer.
  7532. * This is dynamic to allow compat with webgl 1 and 2.
  7533. * You will need to pass the name of the uniform as well as the value.
  7534. */
  7535. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  7536. /**
  7537. * Lambda to Update a vec3 of float in a uniform buffer.
  7538. * This is dynamic to allow compat with webgl 1 and 2.
  7539. * You will need to pass the name of the uniform as well as the value.
  7540. */
  7541. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  7542. /**
  7543. * Lambda to Update a vec4 of float in a uniform buffer.
  7544. * This is dynamic to allow compat with webgl 1 and 2.
  7545. * You will need to pass the name of the uniform as well as the value.
  7546. */
  7547. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  7548. /**
  7549. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  7550. * This is dynamic to allow compat with webgl 1 and 2.
  7551. * You will need to pass the name of the uniform as well as the value.
  7552. */
  7553. updateMatrix: (name: string, mat: Matrix) => void;
  7554. /**
  7555. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  7556. * This is dynamic to allow compat with webgl 1 and 2.
  7557. * You will need to pass the name of the uniform as well as the value.
  7558. */
  7559. updateVector3: (name: string, vector: Vector3) => void;
  7560. /**
  7561. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  7562. * This is dynamic to allow compat with webgl 1 and 2.
  7563. * You will need to pass the name of the uniform as well as the value.
  7564. */
  7565. updateVector4: (name: string, vector: Vector4) => void;
  7566. /**
  7567. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  7568. * This is dynamic to allow compat with webgl 1 and 2.
  7569. * You will need to pass the name of the uniform as well as the value.
  7570. */
  7571. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  7572. /**
  7573. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  7574. * This is dynamic to allow compat with webgl 1 and 2.
  7575. * You will need to pass the name of the uniform as well as the value.
  7576. */
  7577. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  7578. /**
  7579. * Instantiates a new Uniform buffer objects.
  7580. *
  7581. * Handles blocks of uniform on the GPU.
  7582. *
  7583. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7584. *
  7585. * For more information, please refer to :
  7586. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7587. * @param engine Define the engine the buffer is associated with
  7588. * @param data Define the data contained in the buffer
  7589. * @param dynamic Define if the buffer is updatable
  7590. */
  7591. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  7592. /**
  7593. * Indicates if the buffer is using the WebGL2 UBO implementation,
  7594. * or just falling back on setUniformXXX calls.
  7595. */
  7596. get useUbo(): boolean;
  7597. /**
  7598. * Indicates if the WebGL underlying uniform buffer is in sync
  7599. * with the javascript cache data.
  7600. */
  7601. get isSync(): boolean;
  7602. /**
  7603. * Indicates if the WebGL underlying uniform buffer is dynamic.
  7604. * Also, a dynamic UniformBuffer will disable cache verification and always
  7605. * update the underlying WebGL uniform buffer to the GPU.
  7606. * @returns if Dynamic, otherwise false
  7607. */
  7608. isDynamic(): boolean;
  7609. /**
  7610. * The data cache on JS side.
  7611. * @returns the underlying data as a float array
  7612. */
  7613. getData(): Float32Array;
  7614. /**
  7615. * The underlying WebGL Uniform buffer.
  7616. * @returns the webgl buffer
  7617. */
  7618. getBuffer(): Nullable<DataBuffer>;
  7619. /**
  7620. * std140 layout specifies how to align data within an UBO structure.
  7621. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  7622. * for specs.
  7623. */
  7624. private _fillAlignment;
  7625. /**
  7626. * Adds an uniform in the buffer.
  7627. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  7628. * for the layout to be correct !
  7629. * @param name Name of the uniform, as used in the uniform block in the shader.
  7630. * @param size Data size, or data directly.
  7631. */
  7632. addUniform(name: string, size: number | number[]): void;
  7633. /**
  7634. * Adds a Matrix 4x4 to the uniform buffer.
  7635. * @param name Name of the uniform, as used in the uniform block in the shader.
  7636. * @param mat A 4x4 matrix.
  7637. */
  7638. addMatrix(name: string, mat: Matrix): void;
  7639. /**
  7640. * Adds a vec2 to the uniform buffer.
  7641. * @param name Name of the uniform, as used in the uniform block in the shader.
  7642. * @param x Define the x component value of the vec2
  7643. * @param y Define the y component value of the vec2
  7644. */
  7645. addFloat2(name: string, x: number, y: number): void;
  7646. /**
  7647. * Adds a vec3 to the uniform buffer.
  7648. * @param name Name of the uniform, as used in the uniform block in the shader.
  7649. * @param x Define the x component value of the vec3
  7650. * @param y Define the y component value of the vec3
  7651. * @param z Define the z component value of the vec3
  7652. */
  7653. addFloat3(name: string, x: number, y: number, z: number): void;
  7654. /**
  7655. * Adds a vec3 to the uniform buffer.
  7656. * @param name Name of the uniform, as used in the uniform block in the shader.
  7657. * @param color Define the vec3 from a Color
  7658. */
  7659. addColor3(name: string, color: Color3): void;
  7660. /**
  7661. * Adds a vec4 to the uniform buffer.
  7662. * @param name Name of the uniform, as used in the uniform block in the shader.
  7663. * @param color Define the rgb components from a Color
  7664. * @param alpha Define the a component of the vec4
  7665. */
  7666. addColor4(name: string, color: Color3, alpha: number): void;
  7667. /**
  7668. * Adds a vec3 to the uniform buffer.
  7669. * @param name Name of the uniform, as used in the uniform block in the shader.
  7670. * @param vector Define the vec3 components from a Vector
  7671. */
  7672. addVector3(name: string, vector: Vector3): void;
  7673. /**
  7674. * Adds a Matrix 3x3 to the uniform buffer.
  7675. * @param name Name of the uniform, as used in the uniform block in the shader.
  7676. */
  7677. addMatrix3x3(name: string): void;
  7678. /**
  7679. * Adds a Matrix 2x2 to the uniform buffer.
  7680. * @param name Name of the uniform, as used in the uniform block in the shader.
  7681. */
  7682. addMatrix2x2(name: string): void;
  7683. /**
  7684. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  7685. */
  7686. create(): void;
  7687. /** @hidden */
  7688. _rebuild(): void;
  7689. /**
  7690. * Updates the WebGL Uniform Buffer on the GPU.
  7691. * If the `dynamic` flag is set to true, no cache comparison is done.
  7692. * Otherwise, the buffer will be updated only if the cache differs.
  7693. */
  7694. update(): void;
  7695. /**
  7696. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  7697. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7698. * @param data Define the flattened data
  7699. * @param size Define the size of the data.
  7700. */
  7701. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  7702. private _valueCache;
  7703. private _cacheMatrix;
  7704. private _updateMatrix3x3ForUniform;
  7705. private _updateMatrix3x3ForEffect;
  7706. private _updateMatrix2x2ForEffect;
  7707. private _updateMatrix2x2ForUniform;
  7708. private _updateFloatForEffect;
  7709. private _updateFloatForUniform;
  7710. private _updateFloat2ForEffect;
  7711. private _updateFloat2ForUniform;
  7712. private _updateFloat3ForEffect;
  7713. private _updateFloat3ForUniform;
  7714. private _updateFloat4ForEffect;
  7715. private _updateFloat4ForUniform;
  7716. private _updateMatrixForEffect;
  7717. private _updateMatrixForUniform;
  7718. private _updateVector3ForEffect;
  7719. private _updateVector3ForUniform;
  7720. private _updateVector4ForEffect;
  7721. private _updateVector4ForUniform;
  7722. private _updateColor3ForEffect;
  7723. private _updateColor3ForUniform;
  7724. private _updateColor4ForEffect;
  7725. private _updateColor4ForUniform;
  7726. /**
  7727. * Sets a sampler uniform on the effect.
  7728. * @param name Define the name of the sampler.
  7729. * @param texture Define the texture to set in the sampler
  7730. */
  7731. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  7732. /**
  7733. * Directly updates the value of the uniform in the cache AND on the GPU.
  7734. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7735. * @param data Define the flattened data
  7736. */
  7737. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  7738. /**
  7739. * Binds this uniform buffer to an effect.
  7740. * @param effect Define the effect to bind the buffer to
  7741. * @param name Name of the uniform block in the shader.
  7742. */
  7743. bindToEffect(effect: Effect, name: string): void;
  7744. /**
  7745. * Disposes the uniform buffer.
  7746. */
  7747. dispose(): void;
  7748. }
  7749. }
  7750. declare module "babylonjs/Misc/iInspectable" {
  7751. /**
  7752. * Enum that determines the text-wrapping mode to use.
  7753. */
  7754. export enum InspectableType {
  7755. /**
  7756. * Checkbox for booleans
  7757. */
  7758. Checkbox = 0,
  7759. /**
  7760. * Sliders for numbers
  7761. */
  7762. Slider = 1,
  7763. /**
  7764. * Vector3
  7765. */
  7766. Vector3 = 2,
  7767. /**
  7768. * Quaternions
  7769. */
  7770. Quaternion = 3,
  7771. /**
  7772. * Color3
  7773. */
  7774. Color3 = 4,
  7775. /**
  7776. * String
  7777. */
  7778. String = 5
  7779. }
  7780. /**
  7781. * Interface used to define custom inspectable properties.
  7782. * This interface is used by the inspector to display custom property grids
  7783. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  7784. */
  7785. export interface IInspectable {
  7786. /**
  7787. * Gets the label to display
  7788. */
  7789. label: string;
  7790. /**
  7791. * Gets the name of the property to edit
  7792. */
  7793. propertyName: string;
  7794. /**
  7795. * Gets the type of the editor to use
  7796. */
  7797. type: InspectableType;
  7798. /**
  7799. * Gets the minimum value of the property when using in "slider" mode
  7800. */
  7801. min?: number;
  7802. /**
  7803. * Gets the maximum value of the property when using in "slider" mode
  7804. */
  7805. max?: number;
  7806. /**
  7807. * Gets the setp to use when using in "slider" mode
  7808. */
  7809. step?: number;
  7810. }
  7811. }
  7812. declare module "babylonjs/Misc/timingTools" {
  7813. /**
  7814. * Class used to provide helper for timing
  7815. */
  7816. export class TimingTools {
  7817. /**
  7818. * Polyfill for setImmediate
  7819. * @param action defines the action to execute after the current execution block
  7820. */
  7821. static SetImmediate(action: () => void): void;
  7822. }
  7823. }
  7824. declare module "babylonjs/Misc/instantiationTools" {
  7825. /**
  7826. * Class used to enable instatition of objects by class name
  7827. */
  7828. export class InstantiationTools {
  7829. /**
  7830. * Use this object to register external classes like custom textures or material
  7831. * to allow the laoders to instantiate them
  7832. */
  7833. static RegisteredExternalClasses: {
  7834. [key: string]: Object;
  7835. };
  7836. /**
  7837. * Tries to instantiate a new object from a given class name
  7838. * @param className defines the class name to instantiate
  7839. * @returns the new object or null if the system was not able to do the instantiation
  7840. */
  7841. static Instantiate(className: string): any;
  7842. }
  7843. }
  7844. declare module "babylonjs/Engines/depthTextureCreationOptions" {
  7845. /**
  7846. * Define options used to create a depth texture
  7847. */
  7848. export class DepthTextureCreationOptions {
  7849. /** Specifies whether or not a stencil should be allocated in the texture */
  7850. generateStencil?: boolean;
  7851. /** Specifies whether or not bilinear filtering is enable on the texture */
  7852. bilinearFiltering?: boolean;
  7853. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  7854. comparisonFunction?: number;
  7855. /** Specifies if the created texture is a cube texture */
  7856. isCube?: boolean;
  7857. }
  7858. }
  7859. declare module "babylonjs/Engines/Extensions/engine.cubeTexture" {
  7860. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  7861. import { Nullable } from "babylonjs/types";
  7862. import { Scene } from "babylonjs/scene";
  7863. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  7864. module "babylonjs/Engines/thinEngine" {
  7865. interface ThinEngine {
  7866. /**
  7867. * Creates a depth stencil cube texture.
  7868. * This is only available in WebGL 2.
  7869. * @param size The size of face edge in the cube texture.
  7870. * @param options The options defining the cube texture.
  7871. * @returns The cube texture
  7872. */
  7873. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  7874. /**
  7875. * Creates a cube texture
  7876. * @param rootUrl defines the url where the files to load is located
  7877. * @param scene defines the current scene
  7878. * @param files defines the list of files to load (1 per face)
  7879. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7880. * @param onLoad defines an optional callback raised when the texture is loaded
  7881. * @param onError defines an optional callback raised if there is an issue to load the texture
  7882. * @param format defines the format of the data
  7883. * @param forcedExtension defines the extension to use to pick the right loader
  7884. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7885. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7886. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7887. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  7888. * @returns the cube texture as an InternalTexture
  7889. */
  7890. 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;
  7891. /**
  7892. * Creates a cube texture
  7893. * @param rootUrl defines the url where the files to load is located
  7894. * @param scene defines the current scene
  7895. * @param files defines the list of files to load (1 per face)
  7896. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7897. * @param onLoad defines an optional callback raised when the texture is loaded
  7898. * @param onError defines an optional callback raised if there is an issue to load the texture
  7899. * @param format defines the format of the data
  7900. * @param forcedExtension defines the extension to use to pick the right loader
  7901. * @returns the cube texture as an InternalTexture
  7902. */
  7903. 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;
  7904. /**
  7905. * Creates a cube texture
  7906. * @param rootUrl defines the url where the files to load is located
  7907. * @param scene defines the current scene
  7908. * @param files defines the list of files to load (1 per face)
  7909. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7910. * @param onLoad defines an optional callback raised when the texture is loaded
  7911. * @param onError defines an optional callback raised if there is an issue to load the texture
  7912. * @param format defines the format of the data
  7913. * @param forcedExtension defines the extension to use to pick the right loader
  7914. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7915. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7916. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7917. * @returns the cube texture as an InternalTexture
  7918. */
  7919. 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;
  7920. /** @hidden */
  7921. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  7922. /** @hidden */
  7923. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  7924. /** @hidden */
  7925. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7926. /** @hidden */
  7927. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7928. /**
  7929. * @hidden
  7930. */
  7931. _setCubeMapTextureParams(loadMipmap: boolean): void;
  7932. }
  7933. }
  7934. }
  7935. declare module "babylonjs/Materials/Textures/cubeTexture" {
  7936. import { Nullable } from "babylonjs/types";
  7937. import { Scene } from "babylonjs/scene";
  7938. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7939. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7940. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7941. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  7942. import { Observable } from "babylonjs/Misc/observable";
  7943. /**
  7944. * Class for creating a cube texture
  7945. */
  7946. export class CubeTexture extends BaseTexture {
  7947. private _delayedOnLoad;
  7948. /**
  7949. * Observable triggered once the texture has been loaded.
  7950. */
  7951. onLoadObservable: Observable<CubeTexture>;
  7952. /**
  7953. * The url of the texture
  7954. */
  7955. url: string;
  7956. /**
  7957. * Gets or sets the center of the bounding box associated with the cube texture.
  7958. * It must define where the camera used to render the texture was set
  7959. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7960. */
  7961. boundingBoxPosition: Vector3;
  7962. private _boundingBoxSize;
  7963. /**
  7964. * Gets or sets the size of the bounding box associated with the cube texture
  7965. * When defined, the cubemap will switch to local mode
  7966. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  7967. * @example https://www.babylonjs-playground.com/#RNASML
  7968. */
  7969. set boundingBoxSize(value: Vector3);
  7970. /**
  7971. * Returns the bounding box size
  7972. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7973. */
  7974. get boundingBoxSize(): Vector3;
  7975. protected _rotationY: number;
  7976. /**
  7977. * Sets texture matrix rotation angle around Y axis in radians.
  7978. */
  7979. set rotationY(value: number);
  7980. /**
  7981. * Gets texture matrix rotation angle around Y axis radians.
  7982. */
  7983. get rotationY(): number;
  7984. /**
  7985. * Are mip maps generated for this texture or not.
  7986. */
  7987. get noMipmap(): boolean;
  7988. private _noMipmap;
  7989. private _files;
  7990. protected _forcedExtension: Nullable<string>;
  7991. private _extensions;
  7992. private _textureMatrix;
  7993. private _format;
  7994. private _createPolynomials;
  7995. /**
  7996. * Creates a cube texture from an array of image urls
  7997. * @param files defines an array of image urls
  7998. * @param scene defines the hosting scene
  7999. * @param noMipmap specifies if mip maps are not used
  8000. * @returns a cube texture
  8001. */
  8002. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  8003. /**
  8004. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  8005. * @param url defines the url of the prefiltered texture
  8006. * @param scene defines the scene the texture is attached to
  8007. * @param forcedExtension defines the extension of the file if different from the url
  8008. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  8009. * @return the prefiltered texture
  8010. */
  8011. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  8012. /**
  8013. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  8014. * as prefiltered data.
  8015. * @param rootUrl defines the url of the texture or the root name of the six images
  8016. * @param null defines the scene or engine the texture is attached to
  8017. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  8018. * @param noMipmap defines if mipmaps should be created or not
  8019. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  8020. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  8021. * @param onError defines a callback triggered in case of error during load
  8022. * @param format defines the internal format to use for the texture once loaded
  8023. * @param prefiltered defines whether or not the texture is created from prefiltered data
  8024. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  8025. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  8026. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  8027. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  8028. * @return the cube texture
  8029. */
  8030. 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);
  8031. /**
  8032. * Get the current class name of the texture useful for serialization or dynamic coding.
  8033. * @returns "CubeTexture"
  8034. */
  8035. getClassName(): string;
  8036. /**
  8037. * Update the url (and optional buffer) of this texture if url was null during construction.
  8038. * @param url the url of the texture
  8039. * @param forcedExtension defines the extension to use
  8040. * @param onLoad callback called when the texture is loaded (defaults to null)
  8041. * @param prefiltered Defines whether the updated texture is prefiltered or not
  8042. */
  8043. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  8044. /**
  8045. * Delays loading of the cube texture
  8046. * @param forcedExtension defines the extension to use
  8047. */
  8048. delayLoad(forcedExtension?: string): void;
  8049. /**
  8050. * Returns the reflection texture matrix
  8051. * @returns the reflection texture matrix
  8052. */
  8053. getReflectionTextureMatrix(): Matrix;
  8054. /**
  8055. * Sets the reflection texture matrix
  8056. * @param value Reflection texture matrix
  8057. */
  8058. setReflectionTextureMatrix(value: Matrix): void;
  8059. /**
  8060. * Parses text to create a cube texture
  8061. * @param parsedTexture define the serialized text to read from
  8062. * @param scene defines the hosting scene
  8063. * @param rootUrl defines the root url of the cube texture
  8064. * @returns a cube texture
  8065. */
  8066. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  8067. /**
  8068. * Makes a clone, or deep copy, of the cube texture
  8069. * @returns a new cube texture
  8070. */
  8071. clone(): CubeTexture;
  8072. }
  8073. }
  8074. declare module "babylonjs/Materials/materialDefines" {
  8075. /**
  8076. * Manages the defines for the Material
  8077. */
  8078. export class MaterialDefines {
  8079. /** @hidden */
  8080. protected _keys: string[];
  8081. private _isDirty;
  8082. /** @hidden */
  8083. _renderId: number;
  8084. /** @hidden */
  8085. _areLightsDirty: boolean;
  8086. /** @hidden */
  8087. _areLightsDisposed: boolean;
  8088. /** @hidden */
  8089. _areAttributesDirty: boolean;
  8090. /** @hidden */
  8091. _areTexturesDirty: boolean;
  8092. /** @hidden */
  8093. _areFresnelDirty: boolean;
  8094. /** @hidden */
  8095. _areMiscDirty: boolean;
  8096. /** @hidden */
  8097. _areImageProcessingDirty: boolean;
  8098. /** @hidden */
  8099. _normals: boolean;
  8100. /** @hidden */
  8101. _uvs: boolean;
  8102. /** @hidden */
  8103. _needNormals: boolean;
  8104. /** @hidden */
  8105. _needUVs: boolean;
  8106. [id: string]: any;
  8107. /**
  8108. * Specifies if the material needs to be re-calculated
  8109. */
  8110. get isDirty(): boolean;
  8111. /**
  8112. * Marks the material to indicate that it has been re-calculated
  8113. */
  8114. markAsProcessed(): void;
  8115. /**
  8116. * Marks the material to indicate that it needs to be re-calculated
  8117. */
  8118. markAsUnprocessed(): void;
  8119. /**
  8120. * Marks the material to indicate all of its defines need to be re-calculated
  8121. */
  8122. markAllAsDirty(): void;
  8123. /**
  8124. * Marks the material to indicate that image processing needs to be re-calculated
  8125. */
  8126. markAsImageProcessingDirty(): void;
  8127. /**
  8128. * Marks the material to indicate the lights need to be re-calculated
  8129. * @param disposed Defines whether the light is dirty due to dispose or not
  8130. */
  8131. markAsLightDirty(disposed?: boolean): void;
  8132. /**
  8133. * Marks the attribute state as changed
  8134. */
  8135. markAsAttributesDirty(): void;
  8136. /**
  8137. * Marks the texture state as changed
  8138. */
  8139. markAsTexturesDirty(): void;
  8140. /**
  8141. * Marks the fresnel state as changed
  8142. */
  8143. markAsFresnelDirty(): void;
  8144. /**
  8145. * Marks the misc state as changed
  8146. */
  8147. markAsMiscDirty(): void;
  8148. /**
  8149. * Rebuilds the material defines
  8150. */
  8151. rebuild(): void;
  8152. /**
  8153. * Specifies if two material defines are equal
  8154. * @param other - A material define instance to compare to
  8155. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  8156. */
  8157. isEqual(other: MaterialDefines): boolean;
  8158. /**
  8159. * Clones this instance's defines to another instance
  8160. * @param other - material defines to clone values to
  8161. */
  8162. cloneTo(other: MaterialDefines): void;
  8163. /**
  8164. * Resets the material define values
  8165. */
  8166. reset(): void;
  8167. /**
  8168. * Converts the material define values to a string
  8169. * @returns - String of material define information
  8170. */
  8171. toString(): string;
  8172. }
  8173. }
  8174. declare module "babylonjs/Materials/colorCurves" {
  8175. import { Effect } from "babylonjs/Materials/effect";
  8176. /**
  8177. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  8178. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  8179. * 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;
  8180. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  8181. */
  8182. export class ColorCurves {
  8183. private _dirty;
  8184. private _tempColor;
  8185. private _globalCurve;
  8186. private _highlightsCurve;
  8187. private _midtonesCurve;
  8188. private _shadowsCurve;
  8189. private _positiveCurve;
  8190. private _negativeCurve;
  8191. private _globalHue;
  8192. private _globalDensity;
  8193. private _globalSaturation;
  8194. private _globalExposure;
  8195. /**
  8196. * Gets the global Hue value.
  8197. * 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).
  8198. */
  8199. get globalHue(): number;
  8200. /**
  8201. * Sets the global Hue value.
  8202. * 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).
  8203. */
  8204. set globalHue(value: number);
  8205. /**
  8206. * Gets the global Density value.
  8207. * 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.
  8208. * Values less than zero provide a filter of opposite hue.
  8209. */
  8210. get globalDensity(): number;
  8211. /**
  8212. * Sets the global Density value.
  8213. * 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.
  8214. * Values less than zero provide a filter of opposite hue.
  8215. */
  8216. set globalDensity(value: number);
  8217. /**
  8218. * Gets the global Saturation value.
  8219. * 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.
  8220. */
  8221. get globalSaturation(): number;
  8222. /**
  8223. * Sets the global Saturation value.
  8224. * 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.
  8225. */
  8226. set globalSaturation(value: number);
  8227. /**
  8228. * Gets the global Exposure value.
  8229. * 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.
  8230. */
  8231. get globalExposure(): number;
  8232. /**
  8233. * Sets the global Exposure value.
  8234. * 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.
  8235. */
  8236. set globalExposure(value: number);
  8237. private _highlightsHue;
  8238. private _highlightsDensity;
  8239. private _highlightsSaturation;
  8240. private _highlightsExposure;
  8241. /**
  8242. * Gets the highlights Hue value.
  8243. * 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).
  8244. */
  8245. get highlightsHue(): number;
  8246. /**
  8247. * Sets the highlights Hue value.
  8248. * 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).
  8249. */
  8250. set highlightsHue(value: number);
  8251. /**
  8252. * Gets the highlights Density value.
  8253. * 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.
  8254. * Values less than zero provide a filter of opposite hue.
  8255. */
  8256. get highlightsDensity(): number;
  8257. /**
  8258. * Sets the highlights Density value.
  8259. * 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.
  8260. * Values less than zero provide a filter of opposite hue.
  8261. */
  8262. set highlightsDensity(value: number);
  8263. /**
  8264. * Gets the highlights Saturation value.
  8265. * 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.
  8266. */
  8267. get highlightsSaturation(): number;
  8268. /**
  8269. * Sets the highlights Saturation value.
  8270. * 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.
  8271. */
  8272. set highlightsSaturation(value: number);
  8273. /**
  8274. * Gets the highlights Exposure value.
  8275. * 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.
  8276. */
  8277. get highlightsExposure(): number;
  8278. /**
  8279. * Sets the highlights Exposure value.
  8280. * 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.
  8281. */
  8282. set highlightsExposure(value: number);
  8283. private _midtonesHue;
  8284. private _midtonesDensity;
  8285. private _midtonesSaturation;
  8286. private _midtonesExposure;
  8287. /**
  8288. * Gets the midtones Hue value.
  8289. * 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).
  8290. */
  8291. get midtonesHue(): number;
  8292. /**
  8293. * Sets the midtones Hue value.
  8294. * 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).
  8295. */
  8296. set midtonesHue(value: number);
  8297. /**
  8298. * Gets the midtones Density value.
  8299. * 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.
  8300. * Values less than zero provide a filter of opposite hue.
  8301. */
  8302. get midtonesDensity(): number;
  8303. /**
  8304. * Sets the midtones Density value.
  8305. * 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.
  8306. * Values less than zero provide a filter of opposite hue.
  8307. */
  8308. set midtonesDensity(value: number);
  8309. /**
  8310. * Gets the midtones Saturation value.
  8311. * 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.
  8312. */
  8313. get midtonesSaturation(): number;
  8314. /**
  8315. * Sets the midtones Saturation value.
  8316. * 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.
  8317. */
  8318. set midtonesSaturation(value: number);
  8319. /**
  8320. * Gets the midtones Exposure value.
  8321. * 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.
  8322. */
  8323. get midtonesExposure(): number;
  8324. /**
  8325. * Sets the midtones Exposure value.
  8326. * 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.
  8327. */
  8328. set midtonesExposure(value: number);
  8329. private _shadowsHue;
  8330. private _shadowsDensity;
  8331. private _shadowsSaturation;
  8332. private _shadowsExposure;
  8333. /**
  8334. * Gets the shadows Hue value.
  8335. * 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).
  8336. */
  8337. get shadowsHue(): number;
  8338. /**
  8339. * Sets the shadows Hue value.
  8340. * 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).
  8341. */
  8342. set shadowsHue(value: number);
  8343. /**
  8344. * Gets the shadows Density value.
  8345. * 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.
  8346. * Values less than zero provide a filter of opposite hue.
  8347. */
  8348. get shadowsDensity(): number;
  8349. /**
  8350. * Sets the shadows Density value.
  8351. * 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.
  8352. * Values less than zero provide a filter of opposite hue.
  8353. */
  8354. set shadowsDensity(value: number);
  8355. /**
  8356. * Gets the shadows Saturation value.
  8357. * 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.
  8358. */
  8359. get shadowsSaturation(): number;
  8360. /**
  8361. * Sets the shadows Saturation value.
  8362. * 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.
  8363. */
  8364. set shadowsSaturation(value: number);
  8365. /**
  8366. * Gets the shadows Exposure value.
  8367. * 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.
  8368. */
  8369. get shadowsExposure(): number;
  8370. /**
  8371. * Sets the shadows Exposure value.
  8372. * 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.
  8373. */
  8374. set shadowsExposure(value: number);
  8375. /**
  8376. * Returns the class name
  8377. * @returns The class name
  8378. */
  8379. getClassName(): string;
  8380. /**
  8381. * Binds the color curves to the shader.
  8382. * @param colorCurves The color curve to bind
  8383. * @param effect The effect to bind to
  8384. * @param positiveUniform The positive uniform shader parameter
  8385. * @param neutralUniform The neutral uniform shader parameter
  8386. * @param negativeUniform The negative uniform shader parameter
  8387. */
  8388. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  8389. /**
  8390. * Prepare the list of uniforms associated with the ColorCurves effects.
  8391. * @param uniformsList The list of uniforms used in the effect
  8392. */
  8393. static PrepareUniforms(uniformsList: string[]): void;
  8394. /**
  8395. * Returns color grading data based on a hue, density, saturation and exposure value.
  8396. * @param filterHue The hue of the color filter.
  8397. * @param filterDensity The density of the color filter.
  8398. * @param saturation The saturation.
  8399. * @param exposure The exposure.
  8400. * @param result The result data container.
  8401. */
  8402. private getColorGradingDataToRef;
  8403. /**
  8404. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  8405. * @param value The input slider value in range [-100,100].
  8406. * @returns Adjusted value.
  8407. */
  8408. private static applyColorGradingSliderNonlinear;
  8409. /**
  8410. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  8411. * @param hue The hue (H) input.
  8412. * @param saturation The saturation (S) input.
  8413. * @param brightness The brightness (B) input.
  8414. * @result An RGBA color represented as Vector4.
  8415. */
  8416. private static fromHSBToRef;
  8417. /**
  8418. * Returns a value clamped between min and max
  8419. * @param value The value to clamp
  8420. * @param min The minimum of value
  8421. * @param max The maximum of value
  8422. * @returns The clamped value.
  8423. */
  8424. private static clamp;
  8425. /**
  8426. * Clones the current color curve instance.
  8427. * @return The cloned curves
  8428. */
  8429. clone(): ColorCurves;
  8430. /**
  8431. * Serializes the current color curve instance to a json representation.
  8432. * @return a JSON representation
  8433. */
  8434. serialize(): any;
  8435. /**
  8436. * Parses the color curve from a json representation.
  8437. * @param source the JSON source to parse
  8438. * @return The parsed curves
  8439. */
  8440. static Parse(source: any): ColorCurves;
  8441. }
  8442. }
  8443. declare module "babylonjs/Materials/imageProcessingConfiguration" {
  8444. import { Observable } from "babylonjs/Misc/observable";
  8445. import { Nullable } from "babylonjs/types";
  8446. import { Color4 } from "babylonjs/Maths/math.color";
  8447. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  8448. import { Effect } from "babylonjs/Materials/effect";
  8449. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  8450. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  8451. /**
  8452. * Interface to follow in your material defines to integrate easily the
  8453. * Image proccessing functions.
  8454. * @hidden
  8455. */
  8456. export interface IImageProcessingConfigurationDefines {
  8457. IMAGEPROCESSING: boolean;
  8458. VIGNETTE: boolean;
  8459. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8460. VIGNETTEBLENDMODEOPAQUE: boolean;
  8461. TONEMAPPING: boolean;
  8462. TONEMAPPING_ACES: boolean;
  8463. CONTRAST: boolean;
  8464. EXPOSURE: boolean;
  8465. COLORCURVES: boolean;
  8466. COLORGRADING: boolean;
  8467. COLORGRADING3D: boolean;
  8468. SAMPLER3DGREENDEPTH: boolean;
  8469. SAMPLER3DBGRMAP: boolean;
  8470. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8471. }
  8472. /**
  8473. * @hidden
  8474. */
  8475. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  8476. IMAGEPROCESSING: boolean;
  8477. VIGNETTE: boolean;
  8478. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8479. VIGNETTEBLENDMODEOPAQUE: boolean;
  8480. TONEMAPPING: boolean;
  8481. TONEMAPPING_ACES: boolean;
  8482. CONTRAST: boolean;
  8483. COLORCURVES: boolean;
  8484. COLORGRADING: boolean;
  8485. COLORGRADING3D: boolean;
  8486. SAMPLER3DGREENDEPTH: boolean;
  8487. SAMPLER3DBGRMAP: boolean;
  8488. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8489. EXPOSURE: boolean;
  8490. constructor();
  8491. }
  8492. /**
  8493. * This groups together the common properties used for image processing either in direct forward pass
  8494. * or through post processing effect depending on the use of the image processing pipeline in your scene
  8495. * or not.
  8496. */
  8497. export class ImageProcessingConfiguration {
  8498. /**
  8499. * Default tone mapping applied in BabylonJS.
  8500. */
  8501. static readonly TONEMAPPING_STANDARD: number;
  8502. /**
  8503. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  8504. * to other engines rendering to increase portability.
  8505. */
  8506. static readonly TONEMAPPING_ACES: number;
  8507. /**
  8508. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  8509. */
  8510. colorCurves: Nullable<ColorCurves>;
  8511. private _colorCurvesEnabled;
  8512. /**
  8513. * Gets wether the color curves effect is enabled.
  8514. */
  8515. get colorCurvesEnabled(): boolean;
  8516. /**
  8517. * Sets wether the color curves effect is enabled.
  8518. */
  8519. set colorCurvesEnabled(value: boolean);
  8520. private _colorGradingTexture;
  8521. /**
  8522. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8523. */
  8524. get colorGradingTexture(): Nullable<BaseTexture>;
  8525. /**
  8526. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8527. */
  8528. set colorGradingTexture(value: Nullable<BaseTexture>);
  8529. private _colorGradingEnabled;
  8530. /**
  8531. * Gets wether the color grading effect is enabled.
  8532. */
  8533. get colorGradingEnabled(): boolean;
  8534. /**
  8535. * Sets wether the color grading effect is enabled.
  8536. */
  8537. set colorGradingEnabled(value: boolean);
  8538. private _colorGradingWithGreenDepth;
  8539. /**
  8540. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  8541. */
  8542. get colorGradingWithGreenDepth(): boolean;
  8543. /**
  8544. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  8545. */
  8546. set colorGradingWithGreenDepth(value: boolean);
  8547. private _colorGradingBGR;
  8548. /**
  8549. * Gets wether the color grading texture contains BGR values.
  8550. */
  8551. get colorGradingBGR(): boolean;
  8552. /**
  8553. * Sets wether the color grading texture contains BGR values.
  8554. */
  8555. set colorGradingBGR(value: boolean);
  8556. /** @hidden */
  8557. _exposure: number;
  8558. /**
  8559. * Gets the Exposure used in the effect.
  8560. */
  8561. get exposure(): number;
  8562. /**
  8563. * Sets the Exposure used in the effect.
  8564. */
  8565. set exposure(value: number);
  8566. private _toneMappingEnabled;
  8567. /**
  8568. * Gets wether the tone mapping effect is enabled.
  8569. */
  8570. get toneMappingEnabled(): boolean;
  8571. /**
  8572. * Sets wether the tone mapping effect is enabled.
  8573. */
  8574. set toneMappingEnabled(value: boolean);
  8575. private _toneMappingType;
  8576. /**
  8577. * Gets the type of tone mapping effect.
  8578. */
  8579. get toneMappingType(): number;
  8580. /**
  8581. * Sets the type of tone mapping effect used in BabylonJS.
  8582. */
  8583. set toneMappingType(value: number);
  8584. protected _contrast: number;
  8585. /**
  8586. * Gets the contrast used in the effect.
  8587. */
  8588. get contrast(): number;
  8589. /**
  8590. * Sets the contrast used in the effect.
  8591. */
  8592. set contrast(value: number);
  8593. /**
  8594. * Vignette stretch size.
  8595. */
  8596. vignetteStretch: number;
  8597. /**
  8598. * Vignette centre X Offset.
  8599. */
  8600. vignetteCentreX: number;
  8601. /**
  8602. * Vignette centre Y Offset.
  8603. */
  8604. vignetteCentreY: number;
  8605. /**
  8606. * Vignette weight or intensity of the vignette effect.
  8607. */
  8608. vignetteWeight: number;
  8609. /**
  8610. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  8611. * if vignetteEnabled is set to true.
  8612. */
  8613. vignetteColor: Color4;
  8614. /**
  8615. * Camera field of view used by the Vignette effect.
  8616. */
  8617. vignetteCameraFov: number;
  8618. private _vignetteBlendMode;
  8619. /**
  8620. * Gets the vignette blend mode allowing different kind of effect.
  8621. */
  8622. get vignetteBlendMode(): number;
  8623. /**
  8624. * Sets the vignette blend mode allowing different kind of effect.
  8625. */
  8626. set vignetteBlendMode(value: number);
  8627. private _vignetteEnabled;
  8628. /**
  8629. * Gets wether the vignette effect is enabled.
  8630. */
  8631. get vignetteEnabled(): boolean;
  8632. /**
  8633. * Sets wether the vignette effect is enabled.
  8634. */
  8635. set vignetteEnabled(value: boolean);
  8636. private _applyByPostProcess;
  8637. /**
  8638. * Gets wether the image processing is applied through a post process or not.
  8639. */
  8640. get applyByPostProcess(): boolean;
  8641. /**
  8642. * Sets wether the image processing is applied through a post process or not.
  8643. */
  8644. set applyByPostProcess(value: boolean);
  8645. private _isEnabled;
  8646. /**
  8647. * Gets wether the image processing is enabled or not.
  8648. */
  8649. get isEnabled(): boolean;
  8650. /**
  8651. * Sets wether the image processing is enabled or not.
  8652. */
  8653. set isEnabled(value: boolean);
  8654. /**
  8655. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  8656. */
  8657. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  8658. /**
  8659. * Method called each time the image processing information changes requires to recompile the effect.
  8660. */
  8661. protected _updateParameters(): void;
  8662. /**
  8663. * Gets the current class name.
  8664. * @return "ImageProcessingConfiguration"
  8665. */
  8666. getClassName(): string;
  8667. /**
  8668. * Prepare the list of uniforms associated with the Image Processing effects.
  8669. * @param uniforms The list of uniforms used in the effect
  8670. * @param defines the list of defines currently in use
  8671. */
  8672. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  8673. /**
  8674. * Prepare the list of samplers associated with the Image Processing effects.
  8675. * @param samplersList The list of uniforms used in the effect
  8676. * @param defines the list of defines currently in use
  8677. */
  8678. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  8679. /**
  8680. * Prepare the list of defines associated to the shader.
  8681. * @param defines the list of defines to complete
  8682. * @param forPostProcess Define if we are currently in post process mode or not
  8683. */
  8684. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  8685. /**
  8686. * Returns true if all the image processing information are ready.
  8687. * @returns True if ready, otherwise, false
  8688. */
  8689. isReady(): boolean;
  8690. /**
  8691. * Binds the image processing to the shader.
  8692. * @param effect The effect to bind to
  8693. * @param overrideAspectRatio Override the aspect ratio of the effect
  8694. */
  8695. bind(effect: Effect, overrideAspectRatio?: number): void;
  8696. /**
  8697. * Clones the current image processing instance.
  8698. * @return The cloned image processing
  8699. */
  8700. clone(): ImageProcessingConfiguration;
  8701. /**
  8702. * Serializes the current image processing instance to a json representation.
  8703. * @return a JSON representation
  8704. */
  8705. serialize(): any;
  8706. /**
  8707. * Parses the image processing from a json representation.
  8708. * @param source the JSON source to parse
  8709. * @return The parsed image processing
  8710. */
  8711. static Parse(source: any): ImageProcessingConfiguration;
  8712. private static _VIGNETTEMODE_MULTIPLY;
  8713. private static _VIGNETTEMODE_OPAQUE;
  8714. /**
  8715. * Used to apply the vignette as a mix with the pixel color.
  8716. */
  8717. static get VIGNETTEMODE_MULTIPLY(): number;
  8718. /**
  8719. * Used to apply the vignette as a replacement of the pixel color.
  8720. */
  8721. static get VIGNETTEMODE_OPAQUE(): number;
  8722. }
  8723. }
  8724. declare module "babylonjs/Shaders/postprocess.vertex" {
  8725. /** @hidden */
  8726. export var postprocessVertexShader: {
  8727. name: string;
  8728. shader: string;
  8729. };
  8730. }
  8731. declare module "babylonjs/Engines/Extensions/engine.renderTarget" {
  8732. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  8733. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  8734. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  8735. /**
  8736. * Type used to define a render target texture size (either with a number or with a rect width and height)
  8737. */
  8738. export type RenderTargetTextureSize = number | {
  8739. width: number;
  8740. height: number;
  8741. layers?: number;
  8742. };
  8743. module "babylonjs/Engines/thinEngine" {
  8744. interface ThinEngine {
  8745. /**
  8746. * Creates a new render target texture
  8747. * @param size defines the size of the texture
  8748. * @param options defines the options used to create the texture
  8749. * @returns a new render target texture stored in an InternalTexture
  8750. */
  8751. createRenderTargetTexture(size: RenderTargetTextureSize, options: boolean | RenderTargetCreationOptions): InternalTexture;
  8752. /**
  8753. * Creates a depth stencil texture.
  8754. * This is only available in WebGL 2 or with the depth texture extension available.
  8755. * @param size The size of face edge in the texture.
  8756. * @param options The options defining the texture.
  8757. * @returns The texture
  8758. */
  8759. createDepthStencilTexture(size: RenderTargetTextureSize, options: DepthTextureCreationOptions): InternalTexture;
  8760. /** @hidden */
  8761. _createDepthStencilTexture(size: RenderTargetTextureSize, options: DepthTextureCreationOptions): InternalTexture;
  8762. }
  8763. }
  8764. }
  8765. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes" {
  8766. /**
  8767. * Defines the kind of connection point for node based material
  8768. */
  8769. export enum NodeMaterialBlockConnectionPointTypes {
  8770. /** Float */
  8771. Float = 1,
  8772. /** Int */
  8773. Int = 2,
  8774. /** Vector2 */
  8775. Vector2 = 4,
  8776. /** Vector3 */
  8777. Vector3 = 8,
  8778. /** Vector4 */
  8779. Vector4 = 16,
  8780. /** Color3 */
  8781. Color3 = 32,
  8782. /** Color4 */
  8783. Color4 = 64,
  8784. /** Matrix */
  8785. Matrix = 128,
  8786. /** Custom object */
  8787. Object = 256,
  8788. /** Detect type based on connection */
  8789. AutoDetect = 1024,
  8790. /** Output type that will be defined by input type */
  8791. BasedOnInput = 2048
  8792. }
  8793. }
  8794. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets" {
  8795. /**
  8796. * Enum used to define the target of a block
  8797. */
  8798. export enum NodeMaterialBlockTargets {
  8799. /** Vertex shader */
  8800. Vertex = 1,
  8801. /** Fragment shader */
  8802. Fragment = 2,
  8803. /** Neutral */
  8804. Neutral = 4,
  8805. /** Vertex and Fragment */
  8806. VertexAndFragment = 3
  8807. }
  8808. }
  8809. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode" {
  8810. /**
  8811. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  8812. */
  8813. export enum NodeMaterialBlockConnectionPointMode {
  8814. /** Value is an uniform */
  8815. Uniform = 0,
  8816. /** Value is a mesh attribute */
  8817. Attribute = 1,
  8818. /** Value is a varying between vertex and fragment shaders */
  8819. Varying = 2,
  8820. /** Mode is undefined */
  8821. Undefined = 3
  8822. }
  8823. }
  8824. declare module "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues" {
  8825. /**
  8826. * Enum used to define system values e.g. values automatically provided by the system
  8827. */
  8828. export enum NodeMaterialSystemValues {
  8829. /** World */
  8830. World = 1,
  8831. /** View */
  8832. View = 2,
  8833. /** Projection */
  8834. Projection = 3,
  8835. /** ViewProjection */
  8836. ViewProjection = 4,
  8837. /** WorldView */
  8838. WorldView = 5,
  8839. /** WorldViewProjection */
  8840. WorldViewProjection = 6,
  8841. /** CameraPosition */
  8842. CameraPosition = 7,
  8843. /** Fog Color */
  8844. FogColor = 8,
  8845. /** Delta time */
  8846. DeltaTime = 9
  8847. }
  8848. }
  8849. declare module "babylonjs/Maths/math.axis" {
  8850. import { Vector3 } from "babylonjs/Maths/math.vector";
  8851. /** Defines supported spaces */
  8852. export enum Space {
  8853. /** Local (object) space */
  8854. LOCAL = 0,
  8855. /** World space */
  8856. WORLD = 1,
  8857. /** Bone space */
  8858. BONE = 2
  8859. }
  8860. /** Defines the 3 main axes */
  8861. export class Axis {
  8862. /** X axis */
  8863. static X: Vector3;
  8864. /** Y axis */
  8865. static Y: Vector3;
  8866. /** Z axis */
  8867. static Z: Vector3;
  8868. }
  8869. }
  8870. declare module "babylonjs/Maths/math.frustum" {
  8871. import { Matrix } from "babylonjs/Maths/math.vector";
  8872. import { DeepImmutable } from "babylonjs/types";
  8873. import { Plane } from "babylonjs/Maths/math.plane";
  8874. /**
  8875. * Represents a camera frustum
  8876. */
  8877. export class Frustum {
  8878. /**
  8879. * Gets the planes representing the frustum
  8880. * @param transform matrix to be applied to the returned planes
  8881. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  8882. */
  8883. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  8884. /**
  8885. * Gets the near frustum plane transformed by the transform matrix
  8886. * @param transform transformation matrix to be applied to the resulting frustum plane
  8887. * @param frustumPlane the resuling frustum plane
  8888. */
  8889. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8890. /**
  8891. * Gets the far frustum plane transformed by the transform matrix
  8892. * @param transform transformation matrix to be applied to the resulting frustum plane
  8893. * @param frustumPlane the resuling frustum plane
  8894. */
  8895. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8896. /**
  8897. * Gets the left frustum plane transformed by the transform matrix
  8898. * @param transform transformation matrix to be applied to the resulting frustum plane
  8899. * @param frustumPlane the resuling frustum plane
  8900. */
  8901. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8902. /**
  8903. * Gets the right frustum plane transformed by the transform matrix
  8904. * @param transform transformation matrix to be applied to the resulting frustum plane
  8905. * @param frustumPlane the resuling frustum plane
  8906. */
  8907. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8908. /**
  8909. * Gets the top frustum plane transformed by the transform matrix
  8910. * @param transform transformation matrix to be applied to the resulting frustum plane
  8911. * @param frustumPlane the resuling frustum plane
  8912. */
  8913. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8914. /**
  8915. * Gets the bottom frustum plane transformed by the transform matrix
  8916. * @param transform transformation matrix to be applied to the resulting frustum plane
  8917. * @param frustumPlane the resuling frustum plane
  8918. */
  8919. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8920. /**
  8921. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  8922. * @param transform transformation matrix to be applied to the resulting frustum planes
  8923. * @param frustumPlanes the resuling frustum planes
  8924. */
  8925. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  8926. }
  8927. }
  8928. declare module "babylonjs/Maths/math.size" {
  8929. /**
  8930. * Interface for the size containing width and height
  8931. */
  8932. export interface ISize {
  8933. /**
  8934. * Width
  8935. */
  8936. width: number;
  8937. /**
  8938. * Heighht
  8939. */
  8940. height: number;
  8941. }
  8942. /**
  8943. * Size containing widht and height
  8944. */
  8945. export class Size implements ISize {
  8946. /**
  8947. * Width
  8948. */
  8949. width: number;
  8950. /**
  8951. * Height
  8952. */
  8953. height: number;
  8954. /**
  8955. * Creates a Size object from the given width and height (floats).
  8956. * @param width width of the new size
  8957. * @param height height of the new size
  8958. */
  8959. constructor(width: number, height: number);
  8960. /**
  8961. * Returns a string with the Size width and height
  8962. * @returns a string with the Size width and height
  8963. */
  8964. toString(): string;
  8965. /**
  8966. * "Size"
  8967. * @returns the string "Size"
  8968. */
  8969. getClassName(): string;
  8970. /**
  8971. * Returns the Size hash code.
  8972. * @returns a hash code for a unique width and height
  8973. */
  8974. getHashCode(): number;
  8975. /**
  8976. * Updates the current size from the given one.
  8977. * @param src the given size
  8978. */
  8979. copyFrom(src: Size): void;
  8980. /**
  8981. * Updates in place the current Size from the given floats.
  8982. * @param width width of the new size
  8983. * @param height height of the new size
  8984. * @returns the updated Size.
  8985. */
  8986. copyFromFloats(width: number, height: number): Size;
  8987. /**
  8988. * Updates in place the current Size from the given floats.
  8989. * @param width width to set
  8990. * @param height height to set
  8991. * @returns the updated Size.
  8992. */
  8993. set(width: number, height: number): Size;
  8994. /**
  8995. * Multiplies the width and height by numbers
  8996. * @param w factor to multiple the width by
  8997. * @param h factor to multiple the height by
  8998. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  8999. */
  9000. multiplyByFloats(w: number, h: number): Size;
  9001. /**
  9002. * Clones the size
  9003. * @returns a new Size copied from the given one.
  9004. */
  9005. clone(): Size;
  9006. /**
  9007. * True if the current Size and the given one width and height are strictly equal.
  9008. * @param other the other size to compare against
  9009. * @returns True if the current Size and the given one width and height are strictly equal.
  9010. */
  9011. equals(other: Size): boolean;
  9012. /**
  9013. * The surface of the Size : width * height (float).
  9014. */
  9015. get surface(): number;
  9016. /**
  9017. * Create a new size of zero
  9018. * @returns a new Size set to (0.0, 0.0)
  9019. */
  9020. static Zero(): Size;
  9021. /**
  9022. * Sums the width and height of two sizes
  9023. * @param otherSize size to add to this size
  9024. * @returns a new Size set as the addition result of the current Size and the given one.
  9025. */
  9026. add(otherSize: Size): Size;
  9027. /**
  9028. * Subtracts the width and height of two
  9029. * @param otherSize size to subtract to this size
  9030. * @returns a new Size set as the subtraction result of the given one from the current Size.
  9031. */
  9032. subtract(otherSize: Size): Size;
  9033. /**
  9034. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  9035. * @param start starting size to lerp between
  9036. * @param end end size to lerp between
  9037. * @param amount amount to lerp between the start and end values
  9038. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  9039. */
  9040. static Lerp(start: Size, end: Size, amount: number): Size;
  9041. }
  9042. }
  9043. declare module "babylonjs/Maths/math.vertexFormat" {
  9044. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  9045. /**
  9046. * Contains position and normal vectors for a vertex
  9047. */
  9048. export class PositionNormalVertex {
  9049. /** the position of the vertex (defaut: 0,0,0) */
  9050. position: Vector3;
  9051. /** the normal of the vertex (defaut: 0,1,0) */
  9052. normal: Vector3;
  9053. /**
  9054. * Creates a PositionNormalVertex
  9055. * @param position the position of the vertex (defaut: 0,0,0)
  9056. * @param normal the normal of the vertex (defaut: 0,1,0)
  9057. */
  9058. constructor(
  9059. /** the position of the vertex (defaut: 0,0,0) */
  9060. position?: Vector3,
  9061. /** the normal of the vertex (defaut: 0,1,0) */
  9062. normal?: Vector3);
  9063. /**
  9064. * Clones the PositionNormalVertex
  9065. * @returns the cloned PositionNormalVertex
  9066. */
  9067. clone(): PositionNormalVertex;
  9068. }
  9069. /**
  9070. * Contains position, normal and uv vectors for a vertex
  9071. */
  9072. export class PositionNormalTextureVertex {
  9073. /** the position of the vertex (defaut: 0,0,0) */
  9074. position: Vector3;
  9075. /** the normal of the vertex (defaut: 0,1,0) */
  9076. normal: Vector3;
  9077. /** the uv of the vertex (default: 0,0) */
  9078. uv: Vector2;
  9079. /**
  9080. * Creates a PositionNormalTextureVertex
  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. * @param uv the uv of the vertex (default: 0,0)
  9084. */
  9085. constructor(
  9086. /** the position of the vertex (defaut: 0,0,0) */
  9087. position?: Vector3,
  9088. /** the normal of the vertex (defaut: 0,1,0) */
  9089. normal?: Vector3,
  9090. /** the uv of the vertex (default: 0,0) */
  9091. uv?: Vector2);
  9092. /**
  9093. * Clones the PositionNormalTextureVertex
  9094. * @returns the cloned PositionNormalTextureVertex
  9095. */
  9096. clone(): PositionNormalTextureVertex;
  9097. }
  9098. }
  9099. declare module "babylonjs/Maths/math" {
  9100. export * from "babylonjs/Maths/math.axis";
  9101. export * from "babylonjs/Maths/math.color";
  9102. export * from "babylonjs/Maths/math.constants";
  9103. export * from "babylonjs/Maths/math.frustum";
  9104. export * from "babylonjs/Maths/math.path";
  9105. export * from "babylonjs/Maths/math.plane";
  9106. export * from "babylonjs/Maths/math.size";
  9107. export * from "babylonjs/Maths/math.vector";
  9108. export * from "babylonjs/Maths/math.vertexFormat";
  9109. export * from "babylonjs/Maths/math.viewport";
  9110. }
  9111. declare module "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes" {
  9112. /**
  9113. * Enum defining the type of animations supported by InputBlock
  9114. */
  9115. export enum AnimatedInputBlockTypes {
  9116. /** No animation */
  9117. None = 0,
  9118. /** Time based animation. Will only work for floats */
  9119. Time = 1
  9120. }
  9121. }
  9122. declare module "babylonjs/Lights/shadowLight" {
  9123. import { Camera } from "babylonjs/Cameras/camera";
  9124. import { Scene } from "babylonjs/scene";
  9125. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  9126. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9127. import { Light } from "babylonjs/Lights/light";
  9128. /**
  9129. * Interface describing all the common properties and methods a shadow light needs to implement.
  9130. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  9131. * as well as binding the different shadow properties to the effects.
  9132. */
  9133. export interface IShadowLight extends Light {
  9134. /**
  9135. * The light id in the scene (used in scene.findLighById for instance)
  9136. */
  9137. id: string;
  9138. /**
  9139. * The position the shdow will be casted from.
  9140. */
  9141. position: Vector3;
  9142. /**
  9143. * In 2d mode (needCube being false), the direction used to cast the shadow.
  9144. */
  9145. direction: Vector3;
  9146. /**
  9147. * The transformed position. Position of the light in world space taking parenting in account.
  9148. */
  9149. transformedPosition: Vector3;
  9150. /**
  9151. * The transformed direction. Direction of the light in world space taking parenting in account.
  9152. */
  9153. transformedDirection: Vector3;
  9154. /**
  9155. * The friendly name of the light in the scene.
  9156. */
  9157. name: string;
  9158. /**
  9159. * Defines the shadow projection clipping minimum z value.
  9160. */
  9161. shadowMinZ: number;
  9162. /**
  9163. * Defines the shadow projection clipping maximum z value.
  9164. */
  9165. shadowMaxZ: number;
  9166. /**
  9167. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  9168. * @returns true if the information has been computed, false if it does not need to (no parenting)
  9169. */
  9170. computeTransformedInformation(): boolean;
  9171. /**
  9172. * Gets the scene the light belongs to.
  9173. * @returns The scene
  9174. */
  9175. getScene(): Scene;
  9176. /**
  9177. * Callback defining a custom Projection Matrix Builder.
  9178. * This can be used to override the default projection matrix computation.
  9179. */
  9180. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  9181. /**
  9182. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9183. * @param matrix The materix to updated with the projection information
  9184. * @param viewMatrix The transform matrix of the light
  9185. * @param renderList The list of mesh to render in the map
  9186. * @returns The current light
  9187. */
  9188. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9189. /**
  9190. * Gets the current depth scale used in ESM.
  9191. * @returns The scale
  9192. */
  9193. getDepthScale(): number;
  9194. /**
  9195. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9196. * @returns true if a cube texture needs to be use
  9197. */
  9198. needCube(): boolean;
  9199. /**
  9200. * Detects if the projection matrix requires to be recomputed this frame.
  9201. * @returns true if it requires to be recomputed otherwise, false.
  9202. */
  9203. needProjectionMatrixCompute(): boolean;
  9204. /**
  9205. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9206. */
  9207. forceProjectionMatrixCompute(): void;
  9208. /**
  9209. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  9210. * @param faceIndex The index of the face we are computed the direction to generate shadow
  9211. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  9212. */
  9213. getShadowDirection(faceIndex?: number): Vector3;
  9214. /**
  9215. * Gets the minZ used for shadow according to both the scene and the light.
  9216. * @param activeCamera The camera we are returning the min for
  9217. * @returns the depth min z
  9218. */
  9219. getDepthMinZ(activeCamera: Camera): number;
  9220. /**
  9221. * Gets the maxZ used for shadow according to both the scene and the light.
  9222. * @param activeCamera The camera we are returning the max for
  9223. * @returns the depth max z
  9224. */
  9225. getDepthMaxZ(activeCamera: Camera): number;
  9226. }
  9227. /**
  9228. * Base implementation IShadowLight
  9229. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  9230. */
  9231. export abstract class ShadowLight extends Light implements IShadowLight {
  9232. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  9233. protected _position: Vector3;
  9234. protected _setPosition(value: Vector3): void;
  9235. /**
  9236. * Sets the position the shadow will be casted from. Also use as the light position for both
  9237. * point and spot lights.
  9238. */
  9239. get position(): Vector3;
  9240. /**
  9241. * Sets the position the shadow will be casted from. Also use as the light position for both
  9242. * point and spot lights.
  9243. */
  9244. set position(value: Vector3);
  9245. protected _direction: Vector3;
  9246. protected _setDirection(value: Vector3): void;
  9247. /**
  9248. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  9249. * Also use as the light direction on spot and directional lights.
  9250. */
  9251. get direction(): Vector3;
  9252. /**
  9253. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  9254. * Also use as the light direction on spot and directional lights.
  9255. */
  9256. set direction(value: Vector3);
  9257. protected _shadowMinZ: number;
  9258. /**
  9259. * Gets the shadow projection clipping minimum z value.
  9260. */
  9261. get shadowMinZ(): number;
  9262. /**
  9263. * Sets the shadow projection clipping minimum z value.
  9264. */
  9265. set shadowMinZ(value: number);
  9266. protected _shadowMaxZ: number;
  9267. /**
  9268. * Sets the shadow projection clipping maximum z value.
  9269. */
  9270. get shadowMaxZ(): number;
  9271. /**
  9272. * Gets the shadow projection clipping maximum z value.
  9273. */
  9274. set shadowMaxZ(value: number);
  9275. /**
  9276. * Callback defining a custom Projection Matrix Builder.
  9277. * This can be used to override the default projection matrix computation.
  9278. */
  9279. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  9280. /**
  9281. * The transformed position. Position of the light in world space taking parenting in account.
  9282. */
  9283. transformedPosition: Vector3;
  9284. /**
  9285. * The transformed direction. Direction of the light in world space taking parenting in account.
  9286. */
  9287. transformedDirection: Vector3;
  9288. private _needProjectionMatrixCompute;
  9289. /**
  9290. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  9291. * @returns true if the information has been computed, false if it does not need to (no parenting)
  9292. */
  9293. computeTransformedInformation(): boolean;
  9294. /**
  9295. * Return the depth scale used for the shadow map.
  9296. * @returns the depth scale.
  9297. */
  9298. getDepthScale(): number;
  9299. /**
  9300. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  9301. * @param faceIndex The index of the face we are computed the direction to generate shadow
  9302. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  9303. */
  9304. getShadowDirection(faceIndex?: number): Vector3;
  9305. /**
  9306. * Returns the ShadowLight absolute position in the World.
  9307. * @returns the position vector in world space
  9308. */
  9309. getAbsolutePosition(): Vector3;
  9310. /**
  9311. * Sets the ShadowLight direction toward the passed target.
  9312. * @param target The point to target in local space
  9313. * @returns the updated ShadowLight direction
  9314. */
  9315. setDirectionToTarget(target: Vector3): Vector3;
  9316. /**
  9317. * Returns the light rotation in euler definition.
  9318. * @returns the x y z rotation in local space.
  9319. */
  9320. getRotation(): Vector3;
  9321. /**
  9322. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9323. * @returns true if a cube texture needs to be use
  9324. */
  9325. needCube(): boolean;
  9326. /**
  9327. * Detects if the projection matrix requires to be recomputed this frame.
  9328. * @returns true if it requires to be recomputed otherwise, false.
  9329. */
  9330. needProjectionMatrixCompute(): boolean;
  9331. /**
  9332. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9333. */
  9334. forceProjectionMatrixCompute(): void;
  9335. /** @hidden */
  9336. _initCache(): void;
  9337. /** @hidden */
  9338. _isSynchronized(): boolean;
  9339. /**
  9340. * Computes the world matrix of the node
  9341. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  9342. * @returns the world matrix
  9343. */
  9344. computeWorldMatrix(force?: boolean): Matrix;
  9345. /**
  9346. * Gets the minZ used for shadow according to both the scene and the light.
  9347. * @param activeCamera The camera we are returning the min for
  9348. * @returns the depth min z
  9349. */
  9350. getDepthMinZ(activeCamera: Camera): number;
  9351. /**
  9352. * Gets the maxZ used for shadow according to both the scene and the light.
  9353. * @param activeCamera The camera we are returning the max for
  9354. * @returns the depth max z
  9355. */
  9356. getDepthMaxZ(activeCamera: Camera): number;
  9357. /**
  9358. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9359. * @param matrix The materix to updated with the projection information
  9360. * @param viewMatrix The transform matrix of the light
  9361. * @param renderList The list of mesh to render in the map
  9362. * @returns The current light
  9363. */
  9364. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9365. }
  9366. }
  9367. declare module "babylonjs/Shaders/ShadersInclude/packingFunctions" {
  9368. /** @hidden */
  9369. export var packingFunctions: {
  9370. name: string;
  9371. shader: string;
  9372. };
  9373. }
  9374. declare module "babylonjs/Shaders/ShadersInclude/bayerDitherFunctions" {
  9375. /** @hidden */
  9376. export var bayerDitherFunctions: {
  9377. name: string;
  9378. shader: string;
  9379. };
  9380. }
  9381. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragmentDeclaration" {
  9382. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  9383. import "babylonjs/Shaders/ShadersInclude/bayerDitherFunctions";
  9384. /** @hidden */
  9385. export var shadowMapFragmentDeclaration: {
  9386. name: string;
  9387. shader: string;
  9388. };
  9389. }
  9390. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration" {
  9391. /** @hidden */
  9392. export var clipPlaneFragmentDeclaration: {
  9393. name: string;
  9394. shader: string;
  9395. };
  9396. }
  9397. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragment" {
  9398. /** @hidden */
  9399. export var clipPlaneFragment: {
  9400. name: string;
  9401. shader: string;
  9402. };
  9403. }
  9404. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragment" {
  9405. /** @hidden */
  9406. export var shadowMapFragment: {
  9407. name: string;
  9408. shader: string;
  9409. };
  9410. }
  9411. declare module "babylonjs/Shaders/shadowMap.fragment" {
  9412. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentDeclaration";
  9413. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  9414. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  9415. import "babylonjs/Shaders/ShadersInclude/shadowMapFragment";
  9416. /** @hidden */
  9417. export var shadowMapPixelShader: {
  9418. name: string;
  9419. shader: string;
  9420. };
  9421. }
  9422. declare module "babylonjs/Shaders/ShadersInclude/bonesDeclaration" {
  9423. /** @hidden */
  9424. export var bonesDeclaration: {
  9425. name: string;
  9426. shader: string;
  9427. };
  9428. }
  9429. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration" {
  9430. /** @hidden */
  9431. export var morphTargetsVertexGlobalDeclaration: {
  9432. name: string;
  9433. shader: string;
  9434. };
  9435. }
  9436. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration" {
  9437. /** @hidden */
  9438. export var morphTargetsVertexDeclaration: {
  9439. name: string;
  9440. shader: string;
  9441. };
  9442. }
  9443. declare module "babylonjs/Shaders/ShadersInclude/instancesDeclaration" {
  9444. /** @hidden */
  9445. export var instancesDeclaration: {
  9446. name: string;
  9447. shader: string;
  9448. };
  9449. }
  9450. declare module "babylonjs/Shaders/ShadersInclude/helperFunctions" {
  9451. /** @hidden */
  9452. export var helperFunctions: {
  9453. name: string;
  9454. shader: string;
  9455. };
  9456. }
  9457. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexDeclaration" {
  9458. /** @hidden */
  9459. export var shadowMapVertexDeclaration: {
  9460. name: string;
  9461. shader: string;
  9462. };
  9463. }
  9464. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration" {
  9465. /** @hidden */
  9466. export var clipPlaneVertexDeclaration: {
  9467. name: string;
  9468. shader: string;
  9469. };
  9470. }
  9471. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertex" {
  9472. /** @hidden */
  9473. export var morphTargetsVertex: {
  9474. name: string;
  9475. shader: string;
  9476. };
  9477. }
  9478. declare module "babylonjs/Shaders/ShadersInclude/instancesVertex" {
  9479. /** @hidden */
  9480. export var instancesVertex: {
  9481. name: string;
  9482. shader: string;
  9483. };
  9484. }
  9485. declare module "babylonjs/Shaders/ShadersInclude/bonesVertex" {
  9486. /** @hidden */
  9487. export var bonesVertex: {
  9488. name: string;
  9489. shader: string;
  9490. };
  9491. }
  9492. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexNormalBias" {
  9493. /** @hidden */
  9494. export var shadowMapVertexNormalBias: {
  9495. name: string;
  9496. shader: string;
  9497. };
  9498. }
  9499. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexMetric" {
  9500. /** @hidden */
  9501. export var shadowMapVertexMetric: {
  9502. name: string;
  9503. shader: string;
  9504. };
  9505. }
  9506. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertex" {
  9507. /** @hidden */
  9508. export var clipPlaneVertex: {
  9509. name: string;
  9510. shader: string;
  9511. };
  9512. }
  9513. declare module "babylonjs/Shaders/shadowMap.vertex" {
  9514. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  9515. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  9516. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  9517. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  9518. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  9519. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexDeclaration";
  9520. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  9521. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  9522. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  9523. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  9524. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexNormalBias";
  9525. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexMetric";
  9526. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  9527. /** @hidden */
  9528. export var shadowMapVertexShader: {
  9529. name: string;
  9530. shader: string;
  9531. };
  9532. }
  9533. declare module "babylonjs/Shaders/depthBoxBlur.fragment" {
  9534. /** @hidden */
  9535. export var depthBoxBlurPixelShader: {
  9536. name: string;
  9537. shader: string;
  9538. };
  9539. }
  9540. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow" {
  9541. /** @hidden */
  9542. export var shadowMapFragmentSoftTransparentShadow: {
  9543. name: string;
  9544. shader: string;
  9545. };
  9546. }
  9547. declare module "babylonjs/Materials/effectFallbacks" {
  9548. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  9549. import { Effect } from "babylonjs/Materials/effect";
  9550. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9551. /**
  9552. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  9553. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  9554. */
  9555. export class EffectFallbacks implements IEffectFallbacks {
  9556. private _defines;
  9557. private _currentRank;
  9558. private _maxRank;
  9559. private _mesh;
  9560. /**
  9561. * Removes the fallback from the bound mesh.
  9562. */
  9563. unBindMesh(): void;
  9564. /**
  9565. * Adds a fallback on the specified property.
  9566. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9567. * @param define The name of the define in the shader
  9568. */
  9569. addFallback(rank: number, define: string): void;
  9570. /**
  9571. * Sets the mesh to use CPU skinning when needing to fallback.
  9572. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9573. * @param mesh The mesh to use the fallbacks.
  9574. */
  9575. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  9576. /**
  9577. * Checks to see if more fallbacks are still availible.
  9578. */
  9579. get hasMoreFallbacks(): boolean;
  9580. /**
  9581. * Removes the defines that should be removed when falling back.
  9582. * @param currentDefines defines the current define statements for the shader.
  9583. * @param effect defines the current effect we try to compile
  9584. * @returns The resulting defines with defines of the current rank removed.
  9585. */
  9586. reduce(currentDefines: string, effect: Effect): string;
  9587. }
  9588. }
  9589. declare module "babylonjs/Actions/action" {
  9590. import { Observable } from "babylonjs/Misc/observable";
  9591. import { Condition } from "babylonjs/Actions/condition";
  9592. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  9593. import { Nullable } from "babylonjs/types";
  9594. import { Scene } from "babylonjs/scene";
  9595. import { ActionManager } from "babylonjs/Actions/actionManager";
  9596. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9597. import { Node } from "babylonjs/node";
  9598. /**
  9599. * Interface used to define Action
  9600. */
  9601. export interface IAction {
  9602. /**
  9603. * Trigger for the action
  9604. */
  9605. trigger: number;
  9606. /** Options of the trigger */
  9607. triggerOptions: any;
  9608. /**
  9609. * Gets the trigger parameters
  9610. * @returns the trigger parameters
  9611. */
  9612. getTriggerParameter(): any;
  9613. /**
  9614. * Internal only - executes current action event
  9615. * @hidden
  9616. */
  9617. _executeCurrent(evt?: ActionEvent): void;
  9618. /**
  9619. * Serialize placeholder for child classes
  9620. * @param parent of child
  9621. * @returns the serialized object
  9622. */
  9623. serialize(parent: any): any;
  9624. /**
  9625. * Internal only
  9626. * @hidden
  9627. */
  9628. _prepare(): void;
  9629. /**
  9630. * Internal only - manager for action
  9631. * @hidden
  9632. */
  9633. _actionManager: Nullable<AbstractActionManager>;
  9634. /**
  9635. * Adds action to chain of actions, may be a DoNothingAction
  9636. * @param action defines the next action to execute
  9637. * @returns The action passed in
  9638. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9639. */
  9640. then(action: IAction): IAction;
  9641. }
  9642. /**
  9643. * The action to be carried out following a trigger
  9644. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  9645. */
  9646. export class Action implements IAction {
  9647. /** the trigger, with or without parameters, for the action */
  9648. triggerOptions: any;
  9649. /**
  9650. * Trigger for the action
  9651. */
  9652. trigger: number;
  9653. /**
  9654. * Internal only - manager for action
  9655. * @hidden
  9656. */
  9657. _actionManager: ActionManager;
  9658. private _nextActiveAction;
  9659. private _child;
  9660. private _condition?;
  9661. private _triggerParameter;
  9662. /**
  9663. * An event triggered prior to action being executed.
  9664. */
  9665. onBeforeExecuteObservable: Observable<Action>;
  9666. /**
  9667. * Creates a new Action
  9668. * @param triggerOptions the trigger, with or without parameters, for the action
  9669. * @param condition an optional determinant of action
  9670. */
  9671. constructor(
  9672. /** the trigger, with or without parameters, for the action */
  9673. triggerOptions: any, condition?: Condition);
  9674. /**
  9675. * Internal only
  9676. * @hidden
  9677. */
  9678. _prepare(): void;
  9679. /**
  9680. * Gets the trigger parameters
  9681. * @returns the trigger parameters
  9682. */
  9683. getTriggerParameter(): any;
  9684. /**
  9685. * Internal only - executes current action event
  9686. * @hidden
  9687. */
  9688. _executeCurrent(evt?: ActionEvent): void;
  9689. /**
  9690. * Execute placeholder for child classes
  9691. * @param evt optional action event
  9692. */
  9693. execute(evt?: ActionEvent): void;
  9694. /**
  9695. * Skips to next active action
  9696. */
  9697. skipToNextActiveAction(): void;
  9698. /**
  9699. * Adds action to chain of actions, may be a DoNothingAction
  9700. * @param action defines the next action to execute
  9701. * @returns The action passed in
  9702. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9703. */
  9704. then(action: Action): Action;
  9705. /**
  9706. * Internal only
  9707. * @hidden
  9708. */
  9709. _getProperty(propertyPath: string): string;
  9710. /**
  9711. * Internal only
  9712. * @hidden
  9713. */
  9714. _getEffectiveTarget(target: any, propertyPath: string): any;
  9715. /**
  9716. * Serialize placeholder for child classes
  9717. * @param parent of child
  9718. * @returns the serialized object
  9719. */
  9720. serialize(parent: any): any;
  9721. /**
  9722. * Internal only called by serialize
  9723. * @hidden
  9724. */
  9725. protected _serialize(serializedAction: any, parent?: any): any;
  9726. /**
  9727. * Internal only
  9728. * @hidden
  9729. */
  9730. static _SerializeValueAsString: (value: any) => string;
  9731. /**
  9732. * Internal only
  9733. * @hidden
  9734. */
  9735. static _GetTargetProperty: (target: Scene | Node) => {
  9736. name: string;
  9737. targetType: string;
  9738. value: string;
  9739. };
  9740. }
  9741. }
  9742. declare module "babylonjs/Actions/condition" {
  9743. import { ActionManager } from "babylonjs/Actions/actionManager";
  9744. /**
  9745. * A Condition applied to an Action
  9746. */
  9747. export class Condition {
  9748. /**
  9749. * Internal only - manager for action
  9750. * @hidden
  9751. */
  9752. _actionManager: ActionManager;
  9753. /**
  9754. * Internal only
  9755. * @hidden
  9756. */
  9757. _evaluationId: number;
  9758. /**
  9759. * Internal only
  9760. * @hidden
  9761. */
  9762. _currentResult: boolean;
  9763. /**
  9764. * Creates a new Condition
  9765. * @param actionManager the manager of the action the condition is applied to
  9766. */
  9767. constructor(actionManager: ActionManager);
  9768. /**
  9769. * Check if the current condition is valid
  9770. * @returns a boolean
  9771. */
  9772. isValid(): boolean;
  9773. /**
  9774. * Internal only
  9775. * @hidden
  9776. */
  9777. _getProperty(propertyPath: string): string;
  9778. /**
  9779. * Internal only
  9780. * @hidden
  9781. */
  9782. _getEffectiveTarget(target: any, propertyPath: string): any;
  9783. /**
  9784. * Serialize placeholder for child classes
  9785. * @returns the serialized object
  9786. */
  9787. serialize(): any;
  9788. /**
  9789. * Internal only
  9790. * @hidden
  9791. */
  9792. protected _serialize(serializedCondition: any): any;
  9793. }
  9794. /**
  9795. * Defines specific conditional operators as extensions of Condition
  9796. */
  9797. export class ValueCondition extends Condition {
  9798. /** path to specify the property of the target the conditional operator uses */
  9799. propertyPath: string;
  9800. /** the value compared by the conditional operator against the current value of the property */
  9801. value: any;
  9802. /** the conditional operator, default ValueCondition.IsEqual */
  9803. operator: number;
  9804. /**
  9805. * Internal only
  9806. * @hidden
  9807. */
  9808. private static _IsEqual;
  9809. /**
  9810. * Internal only
  9811. * @hidden
  9812. */
  9813. private static _IsDifferent;
  9814. /**
  9815. * Internal only
  9816. * @hidden
  9817. */
  9818. private static _IsGreater;
  9819. /**
  9820. * Internal only
  9821. * @hidden
  9822. */
  9823. private static _IsLesser;
  9824. /**
  9825. * returns the number for IsEqual
  9826. */
  9827. static get IsEqual(): number;
  9828. /**
  9829. * Returns the number for IsDifferent
  9830. */
  9831. static get IsDifferent(): number;
  9832. /**
  9833. * Returns the number for IsGreater
  9834. */
  9835. static get IsGreater(): number;
  9836. /**
  9837. * Returns the number for IsLesser
  9838. */
  9839. static get IsLesser(): number;
  9840. /**
  9841. * Internal only The action manager for the condition
  9842. * @hidden
  9843. */
  9844. _actionManager: ActionManager;
  9845. /**
  9846. * Internal only
  9847. * @hidden
  9848. */
  9849. private _target;
  9850. /**
  9851. * Internal only
  9852. * @hidden
  9853. */
  9854. private _effectiveTarget;
  9855. /**
  9856. * Internal only
  9857. * @hidden
  9858. */
  9859. private _property;
  9860. /**
  9861. * Creates a new ValueCondition
  9862. * @param actionManager manager for the action the condition applies to
  9863. * @param target for the action
  9864. * @param propertyPath path to specify the property of the target the conditional operator uses
  9865. * @param value the value compared by the conditional operator against the current value of the property
  9866. * @param operator the conditional operator, default ValueCondition.IsEqual
  9867. */
  9868. constructor(actionManager: ActionManager, target: any,
  9869. /** path to specify the property of the target the conditional operator uses */
  9870. propertyPath: string,
  9871. /** the value compared by the conditional operator against the current value of the property */
  9872. value: any,
  9873. /** the conditional operator, default ValueCondition.IsEqual */
  9874. operator?: number);
  9875. /**
  9876. * Compares the given value with the property value for the specified conditional operator
  9877. * @returns the result of the comparison
  9878. */
  9879. isValid(): boolean;
  9880. /**
  9881. * Serialize the ValueCondition into a JSON compatible object
  9882. * @returns serialization object
  9883. */
  9884. serialize(): any;
  9885. /**
  9886. * Gets the name of the conditional operator for the ValueCondition
  9887. * @param operator the conditional operator
  9888. * @returns the name
  9889. */
  9890. static GetOperatorName(operator: number): string;
  9891. }
  9892. /**
  9893. * Defines a predicate condition as an extension of Condition
  9894. */
  9895. export class PredicateCondition extends Condition {
  9896. /** defines the predicate function used to validate the condition */
  9897. predicate: () => boolean;
  9898. /**
  9899. * Internal only - manager for action
  9900. * @hidden
  9901. */
  9902. _actionManager: ActionManager;
  9903. /**
  9904. * Creates a new PredicateCondition
  9905. * @param actionManager manager for the action the condition applies to
  9906. * @param predicate defines the predicate function used to validate the condition
  9907. */
  9908. constructor(actionManager: ActionManager,
  9909. /** defines the predicate function used to validate the condition */
  9910. predicate: () => boolean);
  9911. /**
  9912. * @returns the validity of the predicate condition
  9913. */
  9914. isValid(): boolean;
  9915. }
  9916. /**
  9917. * Defines a state condition as an extension of Condition
  9918. */
  9919. export class StateCondition extends Condition {
  9920. /** Value to compare with target state */
  9921. value: string;
  9922. /**
  9923. * Internal only - manager for action
  9924. * @hidden
  9925. */
  9926. _actionManager: ActionManager;
  9927. /**
  9928. * Internal only
  9929. * @hidden
  9930. */
  9931. private _target;
  9932. /**
  9933. * Creates a new StateCondition
  9934. * @param actionManager manager for the action the condition applies to
  9935. * @param target of the condition
  9936. * @param value to compare with target state
  9937. */
  9938. constructor(actionManager: ActionManager, target: any,
  9939. /** Value to compare with target state */
  9940. value: string);
  9941. /**
  9942. * Gets a boolean indicating if the current condition is met
  9943. * @returns the validity of the state
  9944. */
  9945. isValid(): boolean;
  9946. /**
  9947. * Serialize the StateCondition into a JSON compatible object
  9948. * @returns serialization object
  9949. */
  9950. serialize(): any;
  9951. }
  9952. }
  9953. declare module "babylonjs/Actions/directActions" {
  9954. import { Action } from "babylonjs/Actions/action";
  9955. import { Condition } from "babylonjs/Actions/condition";
  9956. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9957. /**
  9958. * This defines an action responsible to toggle a boolean once triggered.
  9959. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9960. */
  9961. export class SwitchBooleanAction extends Action {
  9962. /**
  9963. * The path to the boolean property in the target object
  9964. */
  9965. propertyPath: string;
  9966. private _target;
  9967. private _effectiveTarget;
  9968. private _property;
  9969. /**
  9970. * Instantiate the action
  9971. * @param triggerOptions defines the trigger options
  9972. * @param target defines the object containing the boolean
  9973. * @param propertyPath defines the path to the boolean property in the target object
  9974. * @param condition defines the trigger related conditions
  9975. */
  9976. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  9977. /** @hidden */
  9978. _prepare(): void;
  9979. /**
  9980. * Execute the action toggle the boolean value.
  9981. */
  9982. execute(): void;
  9983. /**
  9984. * Serializes the actions and its related information.
  9985. * @param parent defines the object to serialize in
  9986. * @returns the serialized object
  9987. */
  9988. serialize(parent: any): any;
  9989. }
  9990. /**
  9991. * This defines an action responsible to set a the state field of the target
  9992. * to a desired value once triggered.
  9993. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9994. */
  9995. export class SetStateAction extends Action {
  9996. /**
  9997. * The value to store in the state field.
  9998. */
  9999. value: string;
  10000. private _target;
  10001. /**
  10002. * Instantiate the action
  10003. * @param triggerOptions defines the trigger options
  10004. * @param target defines the object containing the state property
  10005. * @param value defines the value to store in the state field
  10006. * @param condition defines the trigger related conditions
  10007. */
  10008. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  10009. /**
  10010. * Execute the action and store the value on the target state property.
  10011. */
  10012. execute(): void;
  10013. /**
  10014. * Serializes the actions and its related information.
  10015. * @param parent defines the object to serialize in
  10016. * @returns the serialized object
  10017. */
  10018. serialize(parent: any): any;
  10019. }
  10020. /**
  10021. * This defines an action responsible to set a property of the target
  10022. * to a desired value once triggered.
  10023. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10024. */
  10025. export class SetValueAction extends Action {
  10026. /**
  10027. * The path of the property to set in the target.
  10028. */
  10029. propertyPath: string;
  10030. /**
  10031. * The value to set in the property
  10032. */
  10033. value: any;
  10034. private _target;
  10035. private _effectiveTarget;
  10036. private _property;
  10037. /**
  10038. * Instantiate the action
  10039. * @param triggerOptions defines the trigger options
  10040. * @param target defines the object containing the property
  10041. * @param propertyPath defines the path of the property to set in the target
  10042. * @param value defines the value to set in the property
  10043. * @param condition defines the trigger related conditions
  10044. */
  10045. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10046. /** @hidden */
  10047. _prepare(): void;
  10048. /**
  10049. * Execute the action and set the targetted property to the desired value.
  10050. */
  10051. execute(): void;
  10052. /**
  10053. * Serializes the actions and its related information.
  10054. * @param parent defines the object to serialize in
  10055. * @returns the serialized object
  10056. */
  10057. serialize(parent: any): any;
  10058. }
  10059. /**
  10060. * This defines an action responsible to increment the target value
  10061. * to a desired value once triggered.
  10062. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10063. */
  10064. export class IncrementValueAction extends Action {
  10065. /**
  10066. * The path of the property to increment in the target.
  10067. */
  10068. propertyPath: string;
  10069. /**
  10070. * The value we should increment the property by.
  10071. */
  10072. value: any;
  10073. private _target;
  10074. private _effectiveTarget;
  10075. private _property;
  10076. /**
  10077. * Instantiate the action
  10078. * @param triggerOptions defines the trigger options
  10079. * @param target defines the object containing the property
  10080. * @param propertyPath defines the path of the property to increment in the target
  10081. * @param value defines the value value we should increment the property by
  10082. * @param condition defines the trigger related conditions
  10083. */
  10084. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10085. /** @hidden */
  10086. _prepare(): void;
  10087. /**
  10088. * Execute the action and increment the target of the value amount.
  10089. */
  10090. execute(): void;
  10091. /**
  10092. * Serializes the actions and its related information.
  10093. * @param parent defines the object to serialize in
  10094. * @returns the serialized object
  10095. */
  10096. serialize(parent: any): any;
  10097. }
  10098. /**
  10099. * This defines an action responsible to start an animation once triggered.
  10100. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10101. */
  10102. export class PlayAnimationAction extends Action {
  10103. /**
  10104. * Where the animation should start (animation frame)
  10105. */
  10106. from: number;
  10107. /**
  10108. * Where the animation should stop (animation frame)
  10109. */
  10110. to: number;
  10111. /**
  10112. * Define if the animation should loop or stop after the first play.
  10113. */
  10114. loop?: boolean;
  10115. private _target;
  10116. /**
  10117. * Instantiate the action
  10118. * @param triggerOptions defines the trigger options
  10119. * @param target defines the target animation or animation name
  10120. * @param from defines from where the animation should start (animation frame)
  10121. * @param end defines where the animation should stop (animation frame)
  10122. * @param loop defines if the animation should loop or stop after the first play
  10123. * @param condition defines the trigger related conditions
  10124. */
  10125. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  10126. /** @hidden */
  10127. _prepare(): void;
  10128. /**
  10129. * Execute the action and play the animation.
  10130. */
  10131. execute(): void;
  10132. /**
  10133. * Serializes the actions and its related information.
  10134. * @param parent defines the object to serialize in
  10135. * @returns the serialized object
  10136. */
  10137. serialize(parent: any): any;
  10138. }
  10139. /**
  10140. * This defines an action responsible to stop an animation once triggered.
  10141. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10142. */
  10143. export class StopAnimationAction extends Action {
  10144. private _target;
  10145. /**
  10146. * Instantiate the action
  10147. * @param triggerOptions defines the trigger options
  10148. * @param target defines the target animation or animation name
  10149. * @param condition defines the trigger related conditions
  10150. */
  10151. constructor(triggerOptions: any, target: any, condition?: Condition);
  10152. /** @hidden */
  10153. _prepare(): void;
  10154. /**
  10155. * Execute the action and stop 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 that does nothing once triggered.
  10167. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10168. */
  10169. export class DoNothingAction extends Action {
  10170. /**
  10171. * Instantiate the action
  10172. * @param triggerOptions defines the trigger options
  10173. * @param condition defines the trigger related conditions
  10174. */
  10175. constructor(triggerOptions?: any, condition?: Condition);
  10176. /**
  10177. * Execute the action and do nothing.
  10178. */
  10179. execute(): void;
  10180. /**
  10181. * Serializes the actions and its related information.
  10182. * @param parent defines the object to serialize in
  10183. * @returns the serialized object
  10184. */
  10185. serialize(parent: any): any;
  10186. }
  10187. /**
  10188. * This defines an action responsible to trigger several actions once triggered.
  10189. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10190. */
  10191. export class CombineAction extends Action {
  10192. /**
  10193. * The list of aggregated animations to run.
  10194. */
  10195. children: Action[];
  10196. /**
  10197. * Instantiate the action
  10198. * @param triggerOptions defines the trigger options
  10199. * @param children defines the list of aggregated animations to run
  10200. * @param condition defines the trigger related conditions
  10201. */
  10202. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  10203. /** @hidden */
  10204. _prepare(): void;
  10205. /**
  10206. * Execute the action and executes all the aggregated actions.
  10207. */
  10208. execute(evt: ActionEvent): void;
  10209. /**
  10210. * Serializes the actions and its related information.
  10211. * @param parent defines the object to serialize in
  10212. * @returns the serialized object
  10213. */
  10214. serialize(parent: any): any;
  10215. }
  10216. /**
  10217. * This defines an action responsible to run code (external event) once triggered.
  10218. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10219. */
  10220. export class ExecuteCodeAction extends Action {
  10221. /**
  10222. * The callback function to run.
  10223. */
  10224. func: (evt: ActionEvent) => void;
  10225. /**
  10226. * Instantiate the action
  10227. * @param triggerOptions defines the trigger options
  10228. * @param func defines the callback function to run
  10229. * @param condition defines the trigger related conditions
  10230. */
  10231. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  10232. /**
  10233. * Execute the action and run the attached code.
  10234. */
  10235. execute(evt: ActionEvent): void;
  10236. }
  10237. /**
  10238. * This defines an action responsible to set the parent property of the target once triggered.
  10239. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10240. */
  10241. export class SetParentAction extends Action {
  10242. private _parent;
  10243. private _target;
  10244. /**
  10245. * Instantiate the action
  10246. * @param triggerOptions defines the trigger options
  10247. * @param target defines the target containing the parent property
  10248. * @param parent defines from where the animation should start (animation frame)
  10249. * @param condition defines the trigger related conditions
  10250. */
  10251. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  10252. /** @hidden */
  10253. _prepare(): void;
  10254. /**
  10255. * Execute the action and set the parent property.
  10256. */
  10257. execute(): void;
  10258. /**
  10259. * Serializes the actions and its related information.
  10260. * @param parent defines the object to serialize in
  10261. * @returns the serialized object
  10262. */
  10263. serialize(parent: any): any;
  10264. }
  10265. }
  10266. declare module "babylonjs/Actions/actionManager" {
  10267. import { Nullable } from "babylonjs/types";
  10268. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10269. import { Scene } from "babylonjs/scene";
  10270. import { IAction } from "babylonjs/Actions/action";
  10271. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  10272. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10273. /**
  10274. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  10275. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  10276. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10277. */
  10278. export class ActionManager extends AbstractActionManager {
  10279. /**
  10280. * Nothing
  10281. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10282. */
  10283. static readonly NothingTrigger: number;
  10284. /**
  10285. * On pick
  10286. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10287. */
  10288. static readonly OnPickTrigger: number;
  10289. /**
  10290. * On left pick
  10291. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10292. */
  10293. static readonly OnLeftPickTrigger: number;
  10294. /**
  10295. * On right pick
  10296. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10297. */
  10298. static readonly OnRightPickTrigger: number;
  10299. /**
  10300. * On center pick
  10301. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10302. */
  10303. static readonly OnCenterPickTrigger: number;
  10304. /**
  10305. * On pick down
  10306. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10307. */
  10308. static readonly OnPickDownTrigger: number;
  10309. /**
  10310. * On double pick
  10311. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10312. */
  10313. static readonly OnDoublePickTrigger: number;
  10314. /**
  10315. * On pick up
  10316. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10317. */
  10318. static readonly OnPickUpTrigger: number;
  10319. /**
  10320. * On pick out.
  10321. * This trigger will only be raised if you also declared a OnPickDown
  10322. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10323. */
  10324. static readonly OnPickOutTrigger: number;
  10325. /**
  10326. * On long press
  10327. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10328. */
  10329. static readonly OnLongPressTrigger: number;
  10330. /**
  10331. * On pointer over
  10332. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10333. */
  10334. static readonly OnPointerOverTrigger: number;
  10335. /**
  10336. * On pointer out
  10337. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10338. */
  10339. static readonly OnPointerOutTrigger: number;
  10340. /**
  10341. * On every frame
  10342. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10343. */
  10344. static readonly OnEveryFrameTrigger: number;
  10345. /**
  10346. * On intersection enter
  10347. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10348. */
  10349. static readonly OnIntersectionEnterTrigger: number;
  10350. /**
  10351. * On intersection exit
  10352. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10353. */
  10354. static readonly OnIntersectionExitTrigger: number;
  10355. /**
  10356. * On key down
  10357. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10358. */
  10359. static readonly OnKeyDownTrigger: number;
  10360. /**
  10361. * On key up
  10362. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10363. */
  10364. static readonly OnKeyUpTrigger: number;
  10365. private _scene;
  10366. /**
  10367. * Creates a new action manager
  10368. * @param scene defines the hosting scene
  10369. */
  10370. constructor(scene: Scene);
  10371. /**
  10372. * Releases all associated resources
  10373. */
  10374. dispose(): void;
  10375. /**
  10376. * Gets hosting scene
  10377. * @returns the hosting scene
  10378. */
  10379. getScene(): Scene;
  10380. /**
  10381. * Does this action manager handles actions of any of the given triggers
  10382. * @param triggers defines the triggers to be tested
  10383. * @return a boolean indicating whether one (or more) of the triggers is handled
  10384. */
  10385. hasSpecificTriggers(triggers: number[]): boolean;
  10386. /**
  10387. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  10388. * speed.
  10389. * @param triggerA defines the trigger to be tested
  10390. * @param triggerB defines the trigger to be tested
  10391. * @return a boolean indicating whether one (or more) of the triggers is handled
  10392. */
  10393. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  10394. /**
  10395. * Does this action manager handles actions of a given trigger
  10396. * @param trigger defines the trigger to be tested
  10397. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  10398. * @return whether the trigger is handled
  10399. */
  10400. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  10401. /**
  10402. * Does this action manager has pointer triggers
  10403. */
  10404. get hasPointerTriggers(): boolean;
  10405. /**
  10406. * Does this action manager has pick triggers
  10407. */
  10408. get hasPickTriggers(): boolean;
  10409. /**
  10410. * Registers an action to this action manager
  10411. * @param action defines the action to be registered
  10412. * @return the action amended (prepared) after registration
  10413. */
  10414. registerAction(action: IAction): Nullable<IAction>;
  10415. /**
  10416. * Unregisters an action to this action manager
  10417. * @param action defines the action to be unregistered
  10418. * @return a boolean indicating whether the action has been unregistered
  10419. */
  10420. unregisterAction(action: IAction): Boolean;
  10421. /**
  10422. * Process a specific trigger
  10423. * @param trigger defines the trigger to process
  10424. * @param evt defines the event details to be processed
  10425. */
  10426. processTrigger(trigger: number, evt?: IActionEvent): void;
  10427. /** @hidden */
  10428. _getEffectiveTarget(target: any, propertyPath: string): any;
  10429. /** @hidden */
  10430. _getProperty(propertyPath: string): string;
  10431. /**
  10432. * Serialize this manager to a JSON object
  10433. * @param name defines the property name to store this manager
  10434. * @returns a JSON representation of this manager
  10435. */
  10436. serialize(name: string): any;
  10437. /**
  10438. * Creates a new ActionManager from a JSON data
  10439. * @param parsedActions defines the JSON data to read from
  10440. * @param object defines the hosting mesh
  10441. * @param scene defines the hosting scene
  10442. */
  10443. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  10444. /**
  10445. * Get a trigger name by index
  10446. * @param trigger defines the trigger index
  10447. * @returns a trigger name
  10448. */
  10449. static GetTriggerName(trigger: number): string;
  10450. }
  10451. }
  10452. declare module "babylonjs/Sprites/sprite" {
  10453. import { Vector3 } from "babylonjs/Maths/math.vector";
  10454. import { Nullable } from "babylonjs/types";
  10455. import { ActionManager } from "babylonjs/Actions/actionManager";
  10456. import { ISpriteManager, SpriteManager } from "babylonjs/Sprites/spriteManager";
  10457. import { Color4 } from "babylonjs/Maths/math.color";
  10458. import { Observable } from "babylonjs/Misc/observable";
  10459. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  10460. import { Animation } from "babylonjs/Animations/animation";
  10461. /**
  10462. * Class used to represent a sprite
  10463. * @see https://doc.babylonjs.com/babylon101/sprites
  10464. */
  10465. export class Sprite implements IAnimatable {
  10466. /** defines the name */
  10467. name: string;
  10468. /** Gets or sets the current world position */
  10469. position: Vector3;
  10470. /** Gets or sets the main color */
  10471. color: Color4;
  10472. /** Gets or sets the width */
  10473. width: number;
  10474. /** Gets or sets the height */
  10475. height: number;
  10476. /** Gets or sets rotation angle */
  10477. angle: number;
  10478. /** Gets or sets the cell index in the sprite sheet */
  10479. cellIndex: number;
  10480. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  10481. cellRef: string;
  10482. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  10483. invertU: boolean;
  10484. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  10485. invertV: boolean;
  10486. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  10487. disposeWhenFinishedAnimating: boolean;
  10488. /** Gets the list of attached animations */
  10489. animations: Nullable<Array<Animation>>;
  10490. /** Gets or sets a boolean indicating if the sprite can be picked */
  10491. isPickable: boolean;
  10492. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  10493. useAlphaForPicking: boolean;
  10494. /** @hidden */
  10495. _xOffset: number;
  10496. /** @hidden */
  10497. _yOffset: number;
  10498. /** @hidden */
  10499. _xSize: number;
  10500. /** @hidden */
  10501. _ySize: number;
  10502. /**
  10503. * Gets or sets the associated action manager
  10504. */
  10505. actionManager: Nullable<ActionManager>;
  10506. /**
  10507. * An event triggered when the control has been disposed
  10508. */
  10509. onDisposeObservable: Observable<Sprite>;
  10510. private _animationStarted;
  10511. private _loopAnimation;
  10512. private _fromIndex;
  10513. private _toIndex;
  10514. private _delay;
  10515. private _direction;
  10516. private _manager;
  10517. private _time;
  10518. private _onAnimationEnd;
  10519. /**
  10520. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  10521. */
  10522. isVisible: boolean;
  10523. /**
  10524. * Gets or sets the sprite size
  10525. */
  10526. get size(): number;
  10527. set size(value: number);
  10528. /**
  10529. * Returns a boolean indicating if the animation is started
  10530. */
  10531. get animationStarted(): boolean;
  10532. /**
  10533. * Gets or sets the unique id of the sprite
  10534. */
  10535. uniqueId: number;
  10536. /**
  10537. * Gets the manager of this sprite
  10538. */
  10539. get manager(): ISpriteManager;
  10540. /**
  10541. * Creates a new Sprite
  10542. * @param name defines the name
  10543. * @param manager defines the manager
  10544. */
  10545. constructor(
  10546. /** defines the name */
  10547. name: string, manager: ISpriteManager);
  10548. /**
  10549. * Returns the string "Sprite"
  10550. * @returns "Sprite"
  10551. */
  10552. getClassName(): string;
  10553. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  10554. get fromIndex(): number;
  10555. set fromIndex(value: number);
  10556. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  10557. get toIndex(): number;
  10558. set toIndex(value: number);
  10559. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  10560. get loopAnimation(): boolean;
  10561. set loopAnimation(value: boolean);
  10562. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  10563. get delay(): number;
  10564. set delay(value: number);
  10565. /**
  10566. * Starts an animation
  10567. * @param from defines the initial key
  10568. * @param to defines the end key
  10569. * @param loop defines if the animation must loop
  10570. * @param delay defines the start delay (in ms)
  10571. * @param onAnimationEnd defines a callback to call when animation ends
  10572. */
  10573. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  10574. /** Stops current animation (if any) */
  10575. stopAnimation(): void;
  10576. /** @hidden */
  10577. _animate(deltaTime: number): void;
  10578. /** Release associated resources */
  10579. dispose(): void;
  10580. /**
  10581. * Serializes the sprite to a JSON object
  10582. * @returns the JSON object
  10583. */
  10584. serialize(): any;
  10585. /**
  10586. * Parses a JSON object to create a new sprite
  10587. * @param parsedSprite The JSON object to parse
  10588. * @param manager defines the hosting manager
  10589. * @returns the new sprite
  10590. */
  10591. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  10592. }
  10593. }
  10594. declare module "babylonjs/Collisions/pickingInfo" {
  10595. import { Nullable } from "babylonjs/types";
  10596. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  10597. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10598. import { Sprite } from "babylonjs/Sprites/sprite";
  10599. import { Ray } from "babylonjs/Culling/ray";
  10600. /**
  10601. * Information about the result of picking within a scene
  10602. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  10603. */
  10604. export class PickingInfo {
  10605. /** @hidden */
  10606. _pickingUnavailable: boolean;
  10607. /**
  10608. * If the pick collided with an object
  10609. */
  10610. hit: boolean;
  10611. /**
  10612. * Distance away where the pick collided
  10613. */
  10614. distance: number;
  10615. /**
  10616. * The location of pick collision
  10617. */
  10618. pickedPoint: Nullable<Vector3>;
  10619. /**
  10620. * The mesh corresponding the the pick collision
  10621. */
  10622. pickedMesh: Nullable<AbstractMesh>;
  10623. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  10624. bu: number;
  10625. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  10626. bv: number;
  10627. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10628. faceId: number;
  10629. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10630. subMeshFaceId: number;
  10631. /** Id of the the submesh that was picked */
  10632. subMeshId: number;
  10633. /** If a sprite was picked, this will be the sprite the pick collided with */
  10634. pickedSprite: Nullable<Sprite>;
  10635. /** If we are pikcing a mesh with thin instance, this will give you the picked thin instance */
  10636. thinInstanceIndex: number;
  10637. /**
  10638. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  10639. */
  10640. originMesh: Nullable<AbstractMesh>;
  10641. /**
  10642. * The ray that was used to perform the picking.
  10643. */
  10644. ray: Nullable<Ray>;
  10645. /**
  10646. * Gets the normal correspodning to the face the pick collided with
  10647. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  10648. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  10649. * @returns The normal correspodning to the face the pick collided with
  10650. */
  10651. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  10652. /**
  10653. * Gets the texture coordinates of where the pick occured
  10654. * @returns the vector containing the coordnates of the texture
  10655. */
  10656. getTextureCoordinates(): Nullable<Vector2>;
  10657. }
  10658. }
  10659. declare module "babylonjs/Culling/ray" {
  10660. import { DeepImmutable, Nullable, float } from "babylonjs/types";
  10661. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  10662. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10663. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10664. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  10665. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  10666. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  10667. import { Plane } from "babylonjs/Maths/math.plane";
  10668. /**
  10669. * Class representing a ray with position and direction
  10670. */
  10671. export class Ray {
  10672. /** origin point */
  10673. origin: Vector3;
  10674. /** direction */
  10675. direction: Vector3;
  10676. /** length of the ray */
  10677. length: number;
  10678. private static readonly _TmpVector3;
  10679. private _tmpRay;
  10680. /**
  10681. * Creates a new ray
  10682. * @param origin origin point
  10683. * @param direction direction
  10684. * @param length length of the ray
  10685. */
  10686. constructor(
  10687. /** origin point */
  10688. origin: Vector3,
  10689. /** direction */
  10690. direction: Vector3,
  10691. /** length of the ray */
  10692. length?: number);
  10693. /**
  10694. * Checks if the ray intersects a box
  10695. * This does not account for the ray lenght by design to improve perfs.
  10696. * @param minimum bound of the box
  10697. * @param maximum bound of the box
  10698. * @param intersectionTreshold extra extend to be added to the box in all direction
  10699. * @returns if the box was hit
  10700. */
  10701. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  10702. /**
  10703. * Checks if the ray intersects a box
  10704. * This does not account for the ray lenght by design to improve perfs.
  10705. * @param box the bounding box to check
  10706. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  10707. * @returns if the box was hit
  10708. */
  10709. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  10710. /**
  10711. * If the ray hits a sphere
  10712. * @param sphere the bounding sphere to check
  10713. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  10714. * @returns true if it hits the sphere
  10715. */
  10716. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  10717. /**
  10718. * If the ray hits a triange
  10719. * @param vertex0 triangle vertex
  10720. * @param vertex1 triangle vertex
  10721. * @param vertex2 triangle vertex
  10722. * @returns intersection information if hit
  10723. */
  10724. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  10725. /**
  10726. * Checks if ray intersects a plane
  10727. * @param plane the plane to check
  10728. * @returns the distance away it was hit
  10729. */
  10730. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  10731. /**
  10732. * Calculate the intercept of a ray on a given axis
  10733. * @param axis to check 'x' | 'y' | 'z'
  10734. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  10735. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  10736. */
  10737. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  10738. /**
  10739. * Checks if ray intersects a mesh
  10740. * @param mesh the mesh to check
  10741. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10742. * @returns picking info of the intersecton
  10743. */
  10744. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  10745. /**
  10746. * Checks if ray intersects a mesh
  10747. * @param meshes the meshes to check
  10748. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10749. * @param results array to store result in
  10750. * @returns Array of picking infos
  10751. */
  10752. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  10753. private _comparePickingInfo;
  10754. private static smallnum;
  10755. private static rayl;
  10756. /**
  10757. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  10758. * @param sega the first point of the segment to test the intersection against
  10759. * @param segb the second point of the segment to test the intersection against
  10760. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  10761. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  10762. */
  10763. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  10764. /**
  10765. * Update the ray from viewport position
  10766. * @param x position
  10767. * @param y y position
  10768. * @param viewportWidth viewport width
  10769. * @param viewportHeight viewport height
  10770. * @param world world matrix
  10771. * @param view view matrix
  10772. * @param projection projection matrix
  10773. * @returns this ray updated
  10774. */
  10775. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10776. /**
  10777. * Creates a ray with origin and direction of 0,0,0
  10778. * @returns the new ray
  10779. */
  10780. static Zero(): Ray;
  10781. /**
  10782. * Creates a new ray from screen space and viewport
  10783. * @param x position
  10784. * @param y y position
  10785. * @param viewportWidth viewport width
  10786. * @param viewportHeight viewport height
  10787. * @param world world matrix
  10788. * @param view view matrix
  10789. * @param projection projection matrix
  10790. * @returns new ray
  10791. */
  10792. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10793. /**
  10794. * 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
  10795. * transformed to the given world matrix.
  10796. * @param origin The origin point
  10797. * @param end The end point
  10798. * @param world a matrix to transform the ray to. Default is the identity matrix.
  10799. * @returns the new ray
  10800. */
  10801. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  10802. /**
  10803. * Transforms a ray by a matrix
  10804. * @param ray ray to transform
  10805. * @param matrix matrix to apply
  10806. * @returns the resulting new ray
  10807. */
  10808. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  10809. /**
  10810. * Transforms a ray by a matrix
  10811. * @param ray ray to transform
  10812. * @param matrix matrix to apply
  10813. * @param result ray to store result in
  10814. */
  10815. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  10816. /**
  10817. * Unproject a ray from screen space to object space
  10818. * @param sourceX defines the screen space x coordinate to use
  10819. * @param sourceY defines the screen space y coordinate to use
  10820. * @param viewportWidth defines the current width of the viewport
  10821. * @param viewportHeight defines the current height of the viewport
  10822. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  10823. * @param view defines the view matrix to use
  10824. * @param projection defines the projection matrix to use
  10825. */
  10826. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  10827. }
  10828. /**
  10829. * Type used to define predicate used to select faces when a mesh intersection is detected
  10830. */
  10831. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  10832. module "babylonjs/scene" {
  10833. interface Scene {
  10834. /** @hidden */
  10835. _tempPickingRay: Nullable<Ray>;
  10836. /** @hidden */
  10837. _cachedRayForTransform: Ray;
  10838. /** @hidden */
  10839. _pickWithRayInverseMatrix: Matrix;
  10840. /** @hidden */
  10841. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  10842. /** @hidden */
  10843. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  10844. /** @hidden */
  10845. _internalPickForMesh(pickingInfo: Nullable<PickingInfo>, rayFunction: (world: Matrix) => Ray, mesh: AbstractMesh, world: Matrix, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  10846. }
  10847. }
  10848. }
  10849. declare module "babylonjs/sceneComponent" {
  10850. import { Scene } from "babylonjs/scene";
  10851. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10852. import { SubMesh } from "babylonjs/Meshes/subMesh";
  10853. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  10854. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  10855. import { Nullable } from "babylonjs/types";
  10856. import { Camera } from "babylonjs/Cameras/camera";
  10857. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  10858. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10859. import { AbstractScene } from "babylonjs/abstractScene";
  10860. import { Mesh } from "babylonjs/Meshes/mesh";
  10861. /**
  10862. * Groups all the scene component constants in one place to ease maintenance.
  10863. * @hidden
  10864. */
  10865. export class SceneComponentConstants {
  10866. static readonly NAME_EFFECTLAYER: string;
  10867. static readonly NAME_LAYER: string;
  10868. static readonly NAME_LENSFLARESYSTEM: string;
  10869. static readonly NAME_BOUNDINGBOXRENDERER: string;
  10870. static readonly NAME_PARTICLESYSTEM: string;
  10871. static readonly NAME_GAMEPAD: string;
  10872. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  10873. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  10874. static readonly NAME_PREPASSRENDERER: string;
  10875. static readonly NAME_DEPTHRENDERER: string;
  10876. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  10877. static readonly NAME_SPRITE: string;
  10878. static readonly NAME_SUBSURFACE: string;
  10879. static readonly NAME_OUTLINERENDERER: string;
  10880. static readonly NAME_PROCEDURALTEXTURE: string;
  10881. static readonly NAME_SHADOWGENERATOR: string;
  10882. static readonly NAME_OCTREE: string;
  10883. static readonly NAME_PHYSICSENGINE: string;
  10884. static readonly NAME_AUDIO: string;
  10885. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  10886. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10887. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  10888. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10889. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  10890. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  10891. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  10892. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  10893. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  10894. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  10895. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  10896. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  10897. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  10898. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  10899. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  10900. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  10901. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  10902. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  10903. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  10904. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  10905. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  10906. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  10907. static readonly STEP_AFTERRENDER_AUDIO: number;
  10908. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  10909. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  10910. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  10911. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  10912. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  10913. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  10914. static readonly STEP_POINTERMOVE_SPRITE: number;
  10915. static readonly STEP_POINTERDOWN_SPRITE: number;
  10916. static readonly STEP_POINTERUP_SPRITE: number;
  10917. }
  10918. /**
  10919. * This represents a scene component.
  10920. *
  10921. * This is used to decouple the dependency the scene is having on the different workloads like
  10922. * layers, post processes...
  10923. */
  10924. export interface ISceneComponent {
  10925. /**
  10926. * The name of the component. Each component must have a unique name.
  10927. */
  10928. name: string;
  10929. /**
  10930. * The scene the component belongs to.
  10931. */
  10932. scene: Scene;
  10933. /**
  10934. * Register the component to one instance of a scene.
  10935. */
  10936. register(): void;
  10937. /**
  10938. * Rebuilds the elements related to this component in case of
  10939. * context lost for instance.
  10940. */
  10941. rebuild(): void;
  10942. /**
  10943. * Disposes the component and the associated ressources.
  10944. */
  10945. dispose(): void;
  10946. }
  10947. /**
  10948. * This represents a SERIALIZABLE scene component.
  10949. *
  10950. * This extends Scene Component to add Serialization methods on top.
  10951. */
  10952. export interface ISceneSerializableComponent extends ISceneComponent {
  10953. /**
  10954. * Adds all the elements from the container to the scene
  10955. * @param container the container holding the elements
  10956. */
  10957. addFromContainer(container: AbstractScene): void;
  10958. /**
  10959. * Removes all the elements in the container from the scene
  10960. * @param container contains the elements to remove
  10961. * @param dispose if the removed element should be disposed (default: false)
  10962. */
  10963. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  10964. /**
  10965. * Serializes the component data to the specified json object
  10966. * @param serializationObject The object to serialize to
  10967. */
  10968. serialize(serializationObject: any): void;
  10969. }
  10970. /**
  10971. * Strong typing of a Mesh related stage step action
  10972. */
  10973. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  10974. /**
  10975. * Strong typing of a Evaluate Sub Mesh related stage step action
  10976. */
  10977. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  10978. /**
  10979. * Strong typing of a Active Mesh related stage step action
  10980. */
  10981. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  10982. /**
  10983. * Strong typing of a Camera related stage step action
  10984. */
  10985. export type CameraStageAction = (camera: Camera) => void;
  10986. /**
  10987. * Strong typing of a Camera Frame buffer related stage step action
  10988. */
  10989. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  10990. /**
  10991. * Strong typing of a Render Target related stage step action
  10992. */
  10993. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  10994. /**
  10995. * Strong typing of a RenderingGroup related stage step action
  10996. */
  10997. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  10998. /**
  10999. * Strong typing of a Mesh Render related stage step action
  11000. */
  11001. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  11002. /**
  11003. * Strong typing of a simple stage step action
  11004. */
  11005. export type SimpleStageAction = () => void;
  11006. /**
  11007. * Strong typing of a render target action.
  11008. */
  11009. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  11010. /**
  11011. * Strong typing of a pointer move action.
  11012. */
  11013. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  11014. /**
  11015. * Strong typing of a pointer up/down action.
  11016. */
  11017. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  11018. /**
  11019. * Representation of a stage in the scene (Basically a list of ordered steps)
  11020. * @hidden
  11021. */
  11022. export class Stage<T extends Function> extends Array<{
  11023. index: number;
  11024. component: ISceneComponent;
  11025. action: T;
  11026. }> {
  11027. /**
  11028. * Hide ctor from the rest of the world.
  11029. * @param items The items to add.
  11030. */
  11031. private constructor();
  11032. /**
  11033. * Creates a new Stage.
  11034. * @returns A new instance of a Stage
  11035. */
  11036. static Create<T extends Function>(): Stage<T>;
  11037. /**
  11038. * Registers a step in an ordered way in the targeted stage.
  11039. * @param index Defines the position to register the step in
  11040. * @param component Defines the component attached to the step
  11041. * @param action Defines the action to launch during the step
  11042. */
  11043. registerStep(index: number, component: ISceneComponent, action: T): void;
  11044. /**
  11045. * Clears all the steps from the stage.
  11046. */
  11047. clear(): void;
  11048. }
  11049. }
  11050. declare module "babylonjs/Sprites/spriteSceneComponent" {
  11051. import { Nullable } from "babylonjs/types";
  11052. import { Observable } from "babylonjs/Misc/observable";
  11053. import { Scene } from "babylonjs/scene";
  11054. import { Sprite } from "babylonjs/Sprites/sprite";
  11055. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  11056. import { Ray } from "babylonjs/Culling/ray";
  11057. import { Camera } from "babylonjs/Cameras/camera";
  11058. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11059. import { ISceneComponent } from "babylonjs/sceneComponent";
  11060. module "babylonjs/scene" {
  11061. interface Scene {
  11062. /** @hidden */
  11063. _pointerOverSprite: Nullable<Sprite>;
  11064. /** @hidden */
  11065. _pickedDownSprite: Nullable<Sprite>;
  11066. /** @hidden */
  11067. _tempSpritePickingRay: Nullable<Ray>;
  11068. /**
  11069. * All of the sprite managers added to this scene
  11070. * @see https://doc.babylonjs.com/babylon101/sprites
  11071. */
  11072. spriteManagers: Array<ISpriteManager>;
  11073. /**
  11074. * An event triggered when sprites rendering is about to start
  11075. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11076. */
  11077. onBeforeSpritesRenderingObservable: Observable<Scene>;
  11078. /**
  11079. * An event triggered when sprites rendering is done
  11080. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11081. */
  11082. onAfterSpritesRenderingObservable: Observable<Scene>;
  11083. /** @hidden */
  11084. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11085. /** Launch a ray to try to pick a sprite in the scene
  11086. * @param x position on screen
  11087. * @param y position on screen
  11088. * @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
  11089. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11090. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11091. * @returns a PickingInfo
  11092. */
  11093. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11094. /** Use the given ray to pick a sprite in the scene
  11095. * @param ray The ray (in world space) to use to pick meshes
  11096. * @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
  11097. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11098. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11099. * @returns a PickingInfo
  11100. */
  11101. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11102. /** @hidden */
  11103. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11104. /** Launch a ray to try to pick sprites in the scene
  11105. * @param x position on screen
  11106. * @param y position on screen
  11107. * @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
  11108. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11109. * @returns a PickingInfo array
  11110. */
  11111. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11112. /** Use the given ray to pick sprites in the scene
  11113. * @param ray The ray (in world space) to use to pick meshes
  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 camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11116. * @returns a PickingInfo array
  11117. */
  11118. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11119. /**
  11120. * Force the sprite under the pointer
  11121. * @param sprite defines the sprite to use
  11122. */
  11123. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  11124. /**
  11125. * Gets the sprite under the pointer
  11126. * @returns a Sprite or null if no sprite is under the pointer
  11127. */
  11128. getPointerOverSprite(): Nullable<Sprite>;
  11129. }
  11130. }
  11131. /**
  11132. * Defines the sprite scene component responsible to manage sprites
  11133. * in a given scene.
  11134. */
  11135. export class SpriteSceneComponent implements ISceneComponent {
  11136. /**
  11137. * The component name helpfull to identify the component in the list of scene components.
  11138. */
  11139. readonly name: string;
  11140. /**
  11141. * The scene the component belongs to.
  11142. */
  11143. scene: Scene;
  11144. /** @hidden */
  11145. private _spritePredicate;
  11146. /**
  11147. * Creates a new instance of the component for the given scene
  11148. * @param scene Defines the scene to register the component in
  11149. */
  11150. constructor(scene: Scene);
  11151. /**
  11152. * Registers the component in a given scene
  11153. */
  11154. register(): void;
  11155. /**
  11156. * Rebuilds the elements related to this component in case of
  11157. * context lost for instance.
  11158. */
  11159. rebuild(): void;
  11160. /**
  11161. * Disposes the component and the associated ressources.
  11162. */
  11163. dispose(): void;
  11164. private _pickSpriteButKeepRay;
  11165. private _pointerMove;
  11166. private _pointerDown;
  11167. private _pointerUp;
  11168. }
  11169. }
  11170. declare module "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration" {
  11171. /** @hidden */
  11172. export var fogFragmentDeclaration: {
  11173. name: string;
  11174. shader: string;
  11175. };
  11176. }
  11177. declare module "babylonjs/Shaders/ShadersInclude/fogFragment" {
  11178. /** @hidden */
  11179. export var fogFragment: {
  11180. name: string;
  11181. shader: string;
  11182. };
  11183. }
  11184. declare module "babylonjs/Shaders/sprites.fragment" {
  11185. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  11186. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  11187. /** @hidden */
  11188. export var spritesPixelShader: {
  11189. name: string;
  11190. shader: string;
  11191. };
  11192. }
  11193. declare module "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration" {
  11194. /** @hidden */
  11195. export var fogVertexDeclaration: {
  11196. name: string;
  11197. shader: string;
  11198. };
  11199. }
  11200. declare module "babylonjs/Shaders/sprites.vertex" {
  11201. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  11202. /** @hidden */
  11203. export var spritesVertexShader: {
  11204. name: string;
  11205. shader: string;
  11206. };
  11207. }
  11208. declare module "babylonjs/Sprites/spriteManager" {
  11209. import { IDisposable, Scene } from "babylonjs/scene";
  11210. import { Nullable } from "babylonjs/types";
  11211. import { Observable } from "babylonjs/Misc/observable";
  11212. import { Sprite } from "babylonjs/Sprites/sprite";
  11213. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11214. import { Camera } from "babylonjs/Cameras/camera";
  11215. import { Texture } from "babylonjs/Materials/Textures/texture";
  11216. import "babylonjs/Shaders/sprites.fragment";
  11217. import "babylonjs/Shaders/sprites.vertex";
  11218. import { Ray } from "babylonjs/Culling/ray";
  11219. /**
  11220. * Defines the minimum interface to fullfil in order to be a sprite manager.
  11221. */
  11222. export interface ISpriteManager extends IDisposable {
  11223. /**
  11224. * Gets manager's name
  11225. */
  11226. name: string;
  11227. /**
  11228. * Restricts the camera to viewing objects with the same layerMask.
  11229. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  11230. */
  11231. layerMask: number;
  11232. /**
  11233. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  11234. */
  11235. isPickable: boolean;
  11236. /**
  11237. * Gets the hosting scene
  11238. */
  11239. scene: Scene;
  11240. /**
  11241. * Specifies the rendering group id for this mesh (0 by default)
  11242. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  11243. */
  11244. renderingGroupId: number;
  11245. /**
  11246. * Defines the list of sprites managed by the manager.
  11247. */
  11248. sprites: Array<Sprite>;
  11249. /**
  11250. * Gets or sets the spritesheet texture
  11251. */
  11252. texture: Texture;
  11253. /** Defines the default width of a cell in the spritesheet */
  11254. cellWidth: number;
  11255. /** Defines the default height of a cell in the spritesheet */
  11256. cellHeight: number;
  11257. /**
  11258. * Tests the intersection of a sprite with a specific ray.
  11259. * @param ray The ray we are sending to test the collision
  11260. * @param camera The camera space we are sending rays in
  11261. * @param predicate A predicate allowing excluding sprites from the list of object to test
  11262. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11263. * @returns picking info or null.
  11264. */
  11265. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11266. /**
  11267. * Intersects the sprites with a ray
  11268. * @param ray defines the ray to intersect with
  11269. * @param camera defines the current active camera
  11270. * @param predicate defines a predicate used to select candidate sprites
  11271. * @returns null if no hit or a PickingInfo array
  11272. */
  11273. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11274. /**
  11275. * Renders the list of sprites on screen.
  11276. */
  11277. render(): void;
  11278. }
  11279. /**
  11280. * Class used to manage multiple sprites on the same spritesheet
  11281. * @see https://doc.babylonjs.com/babylon101/sprites
  11282. */
  11283. export class SpriteManager implements ISpriteManager {
  11284. /** defines the manager's name */
  11285. name: string;
  11286. /** Define the Url to load snippets */
  11287. static SnippetUrl: string;
  11288. /** Snippet ID if the manager was created from the snippet server */
  11289. snippetId: string;
  11290. /** Gets the list of sprites */
  11291. sprites: Sprite[];
  11292. /** Gets or sets the rendering group id (0 by default) */
  11293. renderingGroupId: number;
  11294. /** Gets or sets camera layer mask */
  11295. layerMask: number;
  11296. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  11297. fogEnabled: boolean;
  11298. /** Gets or sets a boolean indicating if the sprites are pickable */
  11299. isPickable: boolean;
  11300. /** Defines the default width of a cell in the spritesheet */
  11301. cellWidth: number;
  11302. /** Defines the default height of a cell in the spritesheet */
  11303. cellHeight: number;
  11304. /** Associative array from JSON sprite data file */
  11305. private _cellData;
  11306. /** Array of sprite names from JSON sprite data file */
  11307. private _spriteMap;
  11308. /** True when packed cell data from JSON file is ready*/
  11309. private _packedAndReady;
  11310. private _textureContent;
  11311. private _useInstancing;
  11312. /**
  11313. * An event triggered when the manager is disposed.
  11314. */
  11315. onDisposeObservable: Observable<SpriteManager>;
  11316. private _onDisposeObserver;
  11317. /**
  11318. * Callback called when the manager is disposed
  11319. */
  11320. set onDispose(callback: () => void);
  11321. private _capacity;
  11322. private _fromPacked;
  11323. private _spriteTexture;
  11324. private _epsilon;
  11325. private _scene;
  11326. private _vertexData;
  11327. private _buffer;
  11328. private _vertexBuffers;
  11329. private _spriteBuffer;
  11330. private _indexBuffer;
  11331. private _effectBase;
  11332. private _effectFog;
  11333. private _vertexBufferSize;
  11334. /**
  11335. * Gets or sets the unique id of the sprite
  11336. */
  11337. uniqueId: number;
  11338. /**
  11339. * Gets the array of sprites
  11340. */
  11341. get children(): Sprite[];
  11342. /**
  11343. * Gets the hosting scene
  11344. */
  11345. get scene(): Scene;
  11346. /**
  11347. * Gets the capacity of the manager
  11348. */
  11349. get capacity(): number;
  11350. /**
  11351. * Gets or sets the spritesheet texture
  11352. */
  11353. get texture(): Texture;
  11354. set texture(value: Texture);
  11355. private _blendMode;
  11356. /**
  11357. * Blend mode use to render the particle, it can be any of
  11358. * the static Constants.ALPHA_x properties provided in this class.
  11359. * Default value is Constants.ALPHA_COMBINE
  11360. */
  11361. get blendMode(): number;
  11362. set blendMode(blendMode: number);
  11363. /** Disables writing to the depth buffer when rendering the sprites.
  11364. * It can be handy to disable depth writing when using textures without alpha channel
  11365. * and setting some specific blend modes.
  11366. */
  11367. disableDepthWrite: boolean;
  11368. /**
  11369. * Creates a new sprite manager
  11370. * @param name defines the manager's name
  11371. * @param imgUrl defines the sprite sheet url
  11372. * @param capacity defines the maximum allowed number of sprites
  11373. * @param cellSize defines the size of a sprite cell
  11374. * @param scene defines the hosting scene
  11375. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  11376. * @param samplingMode defines the smapling mode to use with spritesheet
  11377. * @param fromPacked set to false; do not alter
  11378. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  11379. */
  11380. constructor(
  11381. /** defines the manager's name */
  11382. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  11383. /**
  11384. * Returns the string "SpriteManager"
  11385. * @returns "SpriteManager"
  11386. */
  11387. getClassName(): string;
  11388. private _makePacked;
  11389. private _appendSpriteVertex;
  11390. private _checkTextureAlpha;
  11391. /**
  11392. * Intersects the sprites with a ray
  11393. * @param ray defines the ray to intersect with
  11394. * @param camera defines the current active camera
  11395. * @param predicate defines a predicate used to select candidate sprites
  11396. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  11397. * @returns null if no hit or a PickingInfo
  11398. */
  11399. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11400. /**
  11401. * Intersects the sprites with a ray
  11402. * @param ray defines the ray to intersect with
  11403. * @param camera defines the current active camera
  11404. * @param predicate defines a predicate used to select candidate sprites
  11405. * @returns null if no hit or a PickingInfo array
  11406. */
  11407. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11408. /**
  11409. * Render all child sprites
  11410. */
  11411. render(): void;
  11412. /**
  11413. * Release associated resources
  11414. */
  11415. dispose(): void;
  11416. /**
  11417. * Serializes the sprite manager to a JSON object
  11418. * @param serializeTexture defines if the texture must be serialized as well
  11419. * @returns the JSON object
  11420. */
  11421. serialize(serializeTexture?: boolean): any;
  11422. /**
  11423. * Parses a JSON object to create a new sprite manager.
  11424. * @param parsedManager The JSON object to parse
  11425. * @param scene The scene to create the sprite managerin
  11426. * @param rootUrl The root url to use to load external dependencies like texture
  11427. * @returns the new sprite manager
  11428. */
  11429. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  11430. /**
  11431. * Creates a sprite manager from a snippet saved in a remote file
  11432. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  11433. * @param url defines the url to load from
  11434. * @param scene defines the hosting scene
  11435. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11436. * @returns a promise that will resolve to the new sprite manager
  11437. */
  11438. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11439. /**
  11440. * Creates a sprite manager from a snippet saved by the sprite editor
  11441. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  11442. * @param scene defines the hosting scene
  11443. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11444. * @returns a promise that will resolve to the new sprite manager
  11445. */
  11446. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11447. }
  11448. }
  11449. declare module "babylonjs/Misc/gradients" {
  11450. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  11451. /** Interface used by value gradients (color, factor, ...) */
  11452. export interface IValueGradient {
  11453. /**
  11454. * Gets or sets the gradient value (between 0 and 1)
  11455. */
  11456. gradient: number;
  11457. }
  11458. /** Class used to store color4 gradient */
  11459. export class ColorGradient implements IValueGradient {
  11460. /**
  11461. * Gets or sets the gradient value (between 0 and 1)
  11462. */
  11463. gradient: number;
  11464. /**
  11465. * Gets or sets first associated color
  11466. */
  11467. color1: Color4;
  11468. /**
  11469. * Gets or sets second associated color
  11470. */
  11471. color2?: Color4 | undefined;
  11472. /**
  11473. * Creates a new color4 gradient
  11474. * @param gradient gets or sets the gradient value (between 0 and 1)
  11475. * @param color1 gets or sets first associated color
  11476. * @param color2 gets or sets first second color
  11477. */
  11478. constructor(
  11479. /**
  11480. * Gets or sets the gradient value (between 0 and 1)
  11481. */
  11482. gradient: number,
  11483. /**
  11484. * Gets or sets first associated color
  11485. */
  11486. color1: Color4,
  11487. /**
  11488. * Gets or sets second associated color
  11489. */
  11490. color2?: Color4 | undefined);
  11491. /**
  11492. * Will get a color picked randomly between color1 and color2.
  11493. * If color2 is undefined then color1 will be used
  11494. * @param result defines the target Color4 to store the result in
  11495. */
  11496. getColorToRef(result: Color4): void;
  11497. }
  11498. /** Class used to store color 3 gradient */
  11499. export class Color3Gradient implements IValueGradient {
  11500. /**
  11501. * Gets or sets the gradient value (between 0 and 1)
  11502. */
  11503. gradient: number;
  11504. /**
  11505. * Gets or sets the associated color
  11506. */
  11507. color: Color3;
  11508. /**
  11509. * Creates a new color3 gradient
  11510. * @param gradient gets or sets the gradient value (between 0 and 1)
  11511. * @param color gets or sets associated color
  11512. */
  11513. constructor(
  11514. /**
  11515. * Gets or sets the gradient value (between 0 and 1)
  11516. */
  11517. gradient: number,
  11518. /**
  11519. * Gets or sets the associated color
  11520. */
  11521. color: Color3);
  11522. }
  11523. /** Class used to store factor gradient */
  11524. export class FactorGradient implements IValueGradient {
  11525. /**
  11526. * Gets or sets the gradient value (between 0 and 1)
  11527. */
  11528. gradient: number;
  11529. /**
  11530. * Gets or sets first associated factor
  11531. */
  11532. factor1: number;
  11533. /**
  11534. * Gets or sets second associated factor
  11535. */
  11536. factor2?: number | undefined;
  11537. /**
  11538. * Creates a new factor gradient
  11539. * @param gradient gets or sets the gradient value (between 0 and 1)
  11540. * @param factor1 gets or sets first associated factor
  11541. * @param factor2 gets or sets second associated factor
  11542. */
  11543. constructor(
  11544. /**
  11545. * Gets or sets the gradient value (between 0 and 1)
  11546. */
  11547. gradient: number,
  11548. /**
  11549. * Gets or sets first associated factor
  11550. */
  11551. factor1: number,
  11552. /**
  11553. * Gets or sets second associated factor
  11554. */
  11555. factor2?: number | undefined);
  11556. /**
  11557. * Will get a number picked randomly between factor1 and factor2.
  11558. * If factor2 is undefined then factor1 will be used
  11559. * @returns the picked number
  11560. */
  11561. getFactor(): number;
  11562. }
  11563. /**
  11564. * Helper used to simplify some generic gradient tasks
  11565. */
  11566. export class GradientHelper {
  11567. /**
  11568. * Gets the current gradient from an array of IValueGradient
  11569. * @param ratio defines the current ratio to get
  11570. * @param gradients defines the array of IValueGradient
  11571. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  11572. */
  11573. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  11574. }
  11575. }
  11576. declare module "babylonjs/Engines/Extensions/engine.rawTexture" {
  11577. import { Nullable } from "babylonjs/types";
  11578. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11579. import { Scene } from "babylonjs/scene";
  11580. module "babylonjs/Engines/thinEngine" {
  11581. interface ThinEngine {
  11582. /**
  11583. * Creates a raw texture
  11584. * @param data defines the data to store in the texture
  11585. * @param width defines the width of the texture
  11586. * @param height defines the height of the texture
  11587. * @param format defines the format of the data
  11588. * @param generateMipMaps defines if the engine should generate the mip levels
  11589. * @param invertY defines if data must be stored with Y axis inverted
  11590. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  11591. * @param compression defines the compression used (null by default)
  11592. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11593. * @returns the raw texture inside an InternalTexture
  11594. */
  11595. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  11596. /**
  11597. * Update a raw texture
  11598. * @param texture defines the texture to update
  11599. * @param data defines the data to store in the texture
  11600. * @param format defines the format of the data
  11601. * @param invertY defines if data must be stored with Y axis inverted
  11602. */
  11603. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11604. /**
  11605. * Update a raw texture
  11606. * @param texture defines the texture to update
  11607. * @param data defines the data to store in the texture
  11608. * @param format defines the format of the data
  11609. * @param invertY defines if data must be stored with Y axis inverted
  11610. * @param compression defines the compression used (null by default)
  11611. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11612. */
  11613. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  11614. /**
  11615. * Creates a new raw cube texture
  11616. * @param data defines the array of data to use to create each face
  11617. * @param size defines the size of the textures
  11618. * @param format defines the format of the data
  11619. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11620. * @param generateMipMaps defines if the engine should generate the mip levels
  11621. * @param invertY defines if data must be stored with Y axis inverted
  11622. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11623. * @param compression defines the compression used (null by default)
  11624. * @returns the cube texture as an InternalTexture
  11625. */
  11626. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  11627. /**
  11628. * Update a raw cube texture
  11629. * @param texture defines the texture to udpdate
  11630. * @param data defines the data to store
  11631. * @param format defines the data format
  11632. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11633. * @param invertY defines if data must be stored with Y axis inverted
  11634. */
  11635. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  11636. /**
  11637. * Update a raw cube texture
  11638. * @param texture defines the texture to udpdate
  11639. * @param data defines the data to store
  11640. * @param format defines the data format
  11641. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11642. * @param invertY defines if data must be stored with Y axis inverted
  11643. * @param compression defines the compression used (null by default)
  11644. */
  11645. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  11646. /**
  11647. * Update a raw cube texture
  11648. * @param texture defines the texture to udpdate
  11649. * @param data defines the data to store
  11650. * @param format defines the data format
  11651. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11652. * @param invertY defines if data must be stored with Y axis inverted
  11653. * @param compression defines the compression used (null by default)
  11654. * @param level defines which level of the texture to update
  11655. */
  11656. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  11657. /**
  11658. * Creates a new raw cube texture from a specified url
  11659. * @param url defines the url where the data is located
  11660. * @param scene defines the current scene
  11661. * @param size defines the size of the textures
  11662. * @param format defines the format of the data
  11663. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11664. * @param noMipmap defines if the engine should avoid generating the mip levels
  11665. * @param callback defines a callback used to extract texture data from loaded data
  11666. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11667. * @param onLoad defines a callback called when texture is loaded
  11668. * @param onError defines a callback called if there is an error
  11669. * @returns the cube texture as an InternalTexture
  11670. */
  11671. 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;
  11672. /**
  11673. * Creates a new raw cube texture from a specified url
  11674. * @param url defines the url where the data is located
  11675. * @param scene defines the current scene
  11676. * @param size defines the size of the textures
  11677. * @param format defines the format of the data
  11678. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11679. * @param noMipmap defines if the engine should avoid generating the mip levels
  11680. * @param callback defines a callback used to extract texture data from loaded data
  11681. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11682. * @param onLoad defines a callback called when texture is loaded
  11683. * @param onError defines a callback called if there is an error
  11684. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11685. * @param invertY defines if data must be stored with Y axis inverted
  11686. * @returns the cube texture as an InternalTexture
  11687. */
  11688. 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;
  11689. /**
  11690. * Creates a new raw 3D texture
  11691. * @param data defines the data used to create the texture
  11692. * @param width defines the width of the texture
  11693. * @param height defines the height of the texture
  11694. * @param depth defines the depth of the texture
  11695. * @param format defines the format of the texture
  11696. * @param generateMipMaps defines if the engine must generate mip levels
  11697. * @param invertY defines if data must be stored with Y axis inverted
  11698. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11699. * @param compression defines the compressed used (can be null)
  11700. * @param textureType defines the compressed used (can be null)
  11701. * @returns a new raw 3D texture (stored in an InternalTexture)
  11702. */
  11703. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11704. /**
  11705. * Update a raw 3D texture
  11706. * @param texture defines the texture to update
  11707. * @param data defines the data to store
  11708. * @param format defines the data format
  11709. * @param invertY defines if data must be stored with Y axis inverted
  11710. */
  11711. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11712. /**
  11713. * Update a raw 3D texture
  11714. * @param texture defines the texture to update
  11715. * @param data defines the data to store
  11716. * @param format defines the data format
  11717. * @param invertY defines if data must be stored with Y axis inverted
  11718. * @param compression defines the used compression (can be null)
  11719. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11720. */
  11721. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11722. /**
  11723. * Creates a new raw 2D array texture
  11724. * @param data defines the data used to create the texture
  11725. * @param width defines the width of the texture
  11726. * @param height defines the height of the texture
  11727. * @param depth defines the number of layers of the texture
  11728. * @param format defines the format of the texture
  11729. * @param generateMipMaps defines if the engine must generate mip levels
  11730. * @param invertY defines if data must be stored with Y axis inverted
  11731. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11732. * @param compression defines the compressed used (can be null)
  11733. * @param textureType defines the compressed used (can be null)
  11734. * @returns a new raw 2D array texture (stored in an InternalTexture)
  11735. */
  11736. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11737. /**
  11738. * Update a raw 2D array texture
  11739. * @param texture defines the texture to update
  11740. * @param data defines the data to store
  11741. * @param format defines the data format
  11742. * @param invertY defines if data must be stored with Y axis inverted
  11743. */
  11744. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11745. /**
  11746. * Update a raw 2D array texture
  11747. * @param texture defines the texture to update
  11748. * @param data defines the data to store
  11749. * @param format defines the data format
  11750. * @param invertY defines if data must be stored with Y axis inverted
  11751. * @param compression defines the used compression (can be null)
  11752. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11753. */
  11754. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11755. }
  11756. }
  11757. }
  11758. declare module "babylonjs/Materials/Textures/rawTexture" {
  11759. import { Texture } from "babylonjs/Materials/Textures/texture";
  11760. import "babylonjs/Engines/Extensions/engine.rawTexture";
  11761. import { Nullable } from "babylonjs/types";
  11762. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  11763. import { Scene } from "babylonjs/scene";
  11764. /**
  11765. * Raw texture can help creating a texture directly from an array of data.
  11766. * This can be super useful if you either get the data from an uncompressed source or
  11767. * if you wish to create your texture pixel by pixel.
  11768. */
  11769. export class RawTexture extends Texture {
  11770. /**
  11771. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11772. */
  11773. format: number;
  11774. /**
  11775. * Instantiates a new RawTexture.
  11776. * Raw texture can help creating a texture directly from an array of data.
  11777. * This can be super useful if you either get the data from an uncompressed source or
  11778. * if you wish to create your texture pixel by pixel.
  11779. * @param data define the array of data to use to create the texture
  11780. * @param width define the width of the texture
  11781. * @param height define the height of the texture
  11782. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11783. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11784. * @param generateMipMaps define whether mip maps should be generated or not
  11785. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11786. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11787. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11788. */
  11789. constructor(data: ArrayBufferView, width: number, height: number,
  11790. /**
  11791. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11792. */
  11793. format: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  11794. /**
  11795. * Updates the texture underlying data.
  11796. * @param data Define the new data of the texture
  11797. */
  11798. update(data: ArrayBufferView): void;
  11799. /**
  11800. * Creates a luminance texture from some data.
  11801. * @param data Define the texture data
  11802. * @param width Define the width of the texture
  11803. * @param height Define the height of the texture
  11804. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11805. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11806. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11807. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11808. * @returns the luminance texture
  11809. */
  11810. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11811. /**
  11812. * Creates a luminance alpha texture from some data.
  11813. * @param data Define the texture data
  11814. * @param width Define the width of the texture
  11815. * @param height Define the height of the texture
  11816. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11817. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11818. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11819. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11820. * @returns the luminance alpha texture
  11821. */
  11822. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11823. /**
  11824. * Creates an alpha texture from some data.
  11825. * @param data Define the texture data
  11826. * @param width Define the width of the texture
  11827. * @param height Define the height of the texture
  11828. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11829. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11830. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11831. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11832. * @returns the alpha texture
  11833. */
  11834. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11835. /**
  11836. * Creates a RGB texture from some data.
  11837. * @param data Define the texture data
  11838. * @param width Define the width of the texture
  11839. * @param height Define the height of the texture
  11840. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11841. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11842. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11843. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11844. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11845. * @returns the RGB alpha texture
  11846. */
  11847. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11848. /**
  11849. * Creates a RGBA texture from some data.
  11850. * @param data Define the texture data
  11851. * @param width Define the width of the texture
  11852. * @param height Define the height of the texture
  11853. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11854. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11855. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11856. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11857. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11858. * @returns the RGBA texture
  11859. */
  11860. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11861. /**
  11862. * Creates a R texture from some data.
  11863. * @param data Define the texture data
  11864. * @param width Define the width of the texture
  11865. * @param height Define the height of the texture
  11866. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11867. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11868. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11869. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11870. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11871. * @returns the R texture
  11872. */
  11873. static CreateRTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11874. }
  11875. }
  11876. declare module "babylonjs/Engines/Extensions/engine.dynamicBuffer" {
  11877. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  11878. import { IndicesArray, DataArray } from "babylonjs/types";
  11879. module "babylonjs/Engines/thinEngine" {
  11880. interface ThinEngine {
  11881. /**
  11882. * Update a dynamic index buffer
  11883. * @param indexBuffer defines the target index buffer
  11884. * @param indices defines the data to update
  11885. * @param offset defines the offset in the target index buffer where update should start
  11886. */
  11887. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  11888. /**
  11889. * Updates a dynamic vertex buffer.
  11890. * @param vertexBuffer the vertex buffer to update
  11891. * @param data the data used to update the vertex buffer
  11892. * @param byteOffset the byte offset of the data
  11893. * @param byteLength the byte length of the data
  11894. */
  11895. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  11896. }
  11897. }
  11898. }
  11899. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent" {
  11900. import { Scene } from "babylonjs/scene";
  11901. import { ISceneComponent } from "babylonjs/sceneComponent";
  11902. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  11903. module "babylonjs/abstractScene" {
  11904. interface AbstractScene {
  11905. /**
  11906. * The list of procedural textures added to the scene
  11907. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11908. */
  11909. proceduralTextures: Array<ProceduralTexture>;
  11910. }
  11911. }
  11912. /**
  11913. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  11914. * in a given scene.
  11915. */
  11916. export class ProceduralTextureSceneComponent implements ISceneComponent {
  11917. /**
  11918. * The component name helpfull to identify the component in the list of scene components.
  11919. */
  11920. readonly name: string;
  11921. /**
  11922. * The scene the component belongs to.
  11923. */
  11924. scene: Scene;
  11925. /**
  11926. * Creates a new instance of the component for the given scene
  11927. * @param scene Defines the scene to register the component in
  11928. */
  11929. constructor(scene: Scene);
  11930. /**
  11931. * Registers the component in a given scene
  11932. */
  11933. register(): void;
  11934. /**
  11935. * Rebuilds the elements related to this component in case of
  11936. * context lost for instance.
  11937. */
  11938. rebuild(): void;
  11939. /**
  11940. * Disposes the component and the associated ressources.
  11941. */
  11942. dispose(): void;
  11943. private _beforeClear;
  11944. }
  11945. }
  11946. declare module "babylonjs/Engines/Extensions/engine.renderTargetCube" {
  11947. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11948. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  11949. module "babylonjs/Engines/thinEngine" {
  11950. interface ThinEngine {
  11951. /**
  11952. * Creates a new render target cube texture
  11953. * @param size defines the size of the texture
  11954. * @param options defines the options used to create the texture
  11955. * @returns a new render target cube texture stored in an InternalTexture
  11956. */
  11957. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  11958. }
  11959. }
  11960. }
  11961. declare module "babylonjs/Shaders/procedural.vertex" {
  11962. /** @hidden */
  11963. export var proceduralVertexShader: {
  11964. name: string;
  11965. shader: string;
  11966. };
  11967. }
  11968. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTexture" {
  11969. import { Observable } from "babylonjs/Misc/observable";
  11970. import { Nullable } from "babylonjs/types";
  11971. import { Scene } from "babylonjs/scene";
  11972. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  11973. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  11974. import { Effect } from "babylonjs/Materials/effect";
  11975. import { Texture } from "babylonjs/Materials/Textures/texture";
  11976. import "babylonjs/Engines/Extensions/engine.renderTarget";
  11977. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  11978. import "babylonjs/Shaders/procedural.vertex";
  11979. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  11980. import { RenderTargetTextureSize } from "babylonjs/Engines/Extensions/engine.renderTarget";
  11981. /**
  11982. * 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.
  11983. * This is the base class of any Procedural texture and contains most of the shareable code.
  11984. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11985. */
  11986. export class ProceduralTexture extends Texture {
  11987. /**
  11988. * Define if the texture is enabled or not (disabled texture will not render)
  11989. */
  11990. isEnabled: boolean;
  11991. /**
  11992. * Define if the texture must be cleared before rendering (default is true)
  11993. */
  11994. autoClear: boolean;
  11995. /**
  11996. * Callback called when the texture is generated
  11997. */
  11998. onGenerated: () => void;
  11999. /**
  12000. * Event raised when the texture is generated
  12001. */
  12002. onGeneratedObservable: Observable<ProceduralTexture>;
  12003. /**
  12004. * Event raised before the texture is generated
  12005. */
  12006. onBeforeGenerationObservable: Observable<ProceduralTexture>;
  12007. /**
  12008. * Gets or sets the node material used to create this texture (null if the texture was manually created)
  12009. */
  12010. nodeMaterialSource: Nullable<NodeMaterial>;
  12011. /** @hidden */
  12012. _generateMipMaps: boolean;
  12013. /** @hidden **/
  12014. _effect: Effect;
  12015. /** @hidden */
  12016. _textures: {
  12017. [key: string]: Texture;
  12018. };
  12019. /** @hidden */
  12020. protected _fallbackTexture: Nullable<Texture>;
  12021. private _size;
  12022. private _currentRefreshId;
  12023. private _frameId;
  12024. private _refreshRate;
  12025. private _vertexBuffers;
  12026. private _indexBuffer;
  12027. private _uniforms;
  12028. private _samplers;
  12029. private _fragment;
  12030. private _floats;
  12031. private _ints;
  12032. private _floatsArrays;
  12033. private _colors3;
  12034. private _colors4;
  12035. private _vectors2;
  12036. private _vectors3;
  12037. private _matrices;
  12038. private _fallbackTextureUsed;
  12039. private _fullEngine;
  12040. private _cachedDefines;
  12041. private _contentUpdateId;
  12042. private _contentData;
  12043. /**
  12044. * Instantiates a new procedural texture.
  12045. * 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.
  12046. * This is the base class of any Procedural texture and contains most of the shareable code.
  12047. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  12048. * @param name Define the name of the texture
  12049. * @param size Define the size of the texture to create
  12050. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  12051. * @param scene Define the scene the texture belongs to
  12052. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  12053. * @param generateMipMaps Define if the texture should creates mip maps or not
  12054. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  12055. */
  12056. constructor(name: string, size: RenderTargetTextureSize, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  12057. /**
  12058. * The effect that is created when initializing the post process.
  12059. * @returns The created effect corresponding the the postprocess.
  12060. */
  12061. getEffect(): Effect;
  12062. /**
  12063. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  12064. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  12065. */
  12066. getContent(): Nullable<ArrayBufferView>;
  12067. private _createIndexBuffer;
  12068. /** @hidden */
  12069. _rebuild(): void;
  12070. /**
  12071. * Resets the texture in order to recreate its associated resources.
  12072. * This can be called in case of context loss
  12073. */
  12074. reset(): void;
  12075. protected _getDefines(): string;
  12076. /**
  12077. * Is the texture ready to be used ? (rendered at least once)
  12078. * @returns true if ready, otherwise, false.
  12079. */
  12080. isReady(): boolean;
  12081. /**
  12082. * Resets the refresh counter of the texture and start bak from scratch.
  12083. * Could be useful to regenerate the texture if it is setup to render only once.
  12084. */
  12085. resetRefreshCounter(): void;
  12086. /**
  12087. * Set the fragment shader to use in order to render the texture.
  12088. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  12089. */
  12090. setFragment(fragment: any): void;
  12091. /**
  12092. * Define the refresh rate of the texture or the rendering frequency.
  12093. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  12094. */
  12095. get refreshRate(): number;
  12096. set refreshRate(value: number);
  12097. /** @hidden */
  12098. _shouldRender(): boolean;
  12099. /**
  12100. * Get the size the texture is rendering at.
  12101. * @returns the size (on cube texture it is always squared)
  12102. */
  12103. getRenderSize(): RenderTargetTextureSize;
  12104. /**
  12105. * Resize the texture to new value.
  12106. * @param size Define the new size the texture should have
  12107. * @param generateMipMaps Define whether the new texture should create mip maps
  12108. */
  12109. resize(size: number, generateMipMaps: boolean): void;
  12110. private _checkUniform;
  12111. /**
  12112. * Set a texture in the shader program used to render.
  12113. * @param name Define the name of the uniform samplers as defined in the shader
  12114. * @param texture Define the texture to bind to this sampler
  12115. * @return the texture itself allowing "fluent" like uniform updates
  12116. */
  12117. setTexture(name: string, texture: Texture): ProceduralTexture;
  12118. /**
  12119. * Set a float in the shader.
  12120. * @param name Define the name of the uniform as defined in the shader
  12121. * @param value Define the value to give to the uniform
  12122. * @return the texture itself allowing "fluent" like uniform updates
  12123. */
  12124. setFloat(name: string, value: number): ProceduralTexture;
  12125. /**
  12126. * Set a int in the shader.
  12127. * @param name Define the name of the uniform as defined in the shader
  12128. * @param value Define the value to give to the uniform
  12129. * @return the texture itself allowing "fluent" like uniform updates
  12130. */
  12131. setInt(name: string, value: number): ProceduralTexture;
  12132. /**
  12133. * Set an array of floats in the shader.
  12134. * @param name Define the name of the uniform as defined in the shader
  12135. * @param value Define the value to give to the uniform
  12136. * @return the texture itself allowing "fluent" like uniform updates
  12137. */
  12138. setFloats(name: string, value: number[]): ProceduralTexture;
  12139. /**
  12140. * Set a vec3 in the shader from a Color3.
  12141. * @param name Define the name of the uniform as defined in the shader
  12142. * @param value Define the value to give to the uniform
  12143. * @return the texture itself allowing "fluent" like uniform updates
  12144. */
  12145. setColor3(name: string, value: Color3): ProceduralTexture;
  12146. /**
  12147. * Set a vec4 in the shader from a Color4.
  12148. * @param name Define the name of the uniform as defined in the shader
  12149. * @param value Define the value to give to the uniform
  12150. * @return the texture itself allowing "fluent" like uniform updates
  12151. */
  12152. setColor4(name: string, value: Color4): ProceduralTexture;
  12153. /**
  12154. * Set a vec2 in the shader from a Vector2.
  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. setVector2(name: string, value: Vector2): ProceduralTexture;
  12160. /**
  12161. * Set a vec3 in the shader from a Vector3.
  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. setVector3(name: string, value: Vector3): ProceduralTexture;
  12167. /**
  12168. * Set a mat4 in the shader from a MAtrix.
  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. setMatrix(name: string, value: Matrix): ProceduralTexture;
  12174. /**
  12175. * Render the texture to its associated render target.
  12176. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  12177. */
  12178. render(useCameraPostProcess?: boolean): void;
  12179. /**
  12180. * Clone the texture.
  12181. * @returns the cloned texture
  12182. */
  12183. clone(): ProceduralTexture;
  12184. /**
  12185. * Dispose the texture and release its asoociated resources.
  12186. */
  12187. dispose(): void;
  12188. }
  12189. }
  12190. declare module "babylonjs/Particles/baseParticleSystem" {
  12191. import { Nullable } from "babylonjs/types";
  12192. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  12193. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  12194. import { ImageProcessingConfiguration, ImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  12195. import { ColorGradient, FactorGradient, Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  12196. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, CylinderDirectedParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  12197. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  12198. import { Color4 } from "babylonjs/Maths/math.color";
  12199. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12200. import "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  12201. import { Animation } from "babylonjs/Animations/animation";
  12202. import { Scene } from "babylonjs/scene";
  12203. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  12204. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  12205. /**
  12206. * This represents the base class for particle system in Babylon.
  12207. * 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.
  12208. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12209. * @example https://doc.babylonjs.com/babylon101/particles
  12210. */
  12211. export class BaseParticleSystem {
  12212. /**
  12213. * Source color is added to the destination color without alpha affecting the result
  12214. */
  12215. static BLENDMODE_ONEONE: number;
  12216. /**
  12217. * Blend current color and particle color using particle’s alpha
  12218. */
  12219. static BLENDMODE_STANDARD: number;
  12220. /**
  12221. * Add current color and particle color multiplied by particle’s alpha
  12222. */
  12223. static BLENDMODE_ADD: number;
  12224. /**
  12225. * Multiply current color with particle color
  12226. */
  12227. static BLENDMODE_MULTIPLY: number;
  12228. /**
  12229. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  12230. */
  12231. static BLENDMODE_MULTIPLYADD: number;
  12232. /**
  12233. * List of animations used by the particle system.
  12234. */
  12235. animations: Animation[];
  12236. /**
  12237. * Gets or sets the unique id of the particle system
  12238. */
  12239. uniqueId: number;
  12240. /**
  12241. * The id of the Particle system.
  12242. */
  12243. id: string;
  12244. /**
  12245. * The friendly name of the Particle system.
  12246. */
  12247. name: string;
  12248. /**
  12249. * Snippet ID if the particle system was created from the snippet server
  12250. */
  12251. snippetId: string;
  12252. /**
  12253. * The rendering group used by the Particle system to chose when to render.
  12254. */
  12255. renderingGroupId: number;
  12256. /**
  12257. * The emitter represents the Mesh or position we are attaching the particle system to.
  12258. */
  12259. emitter: Nullable<AbstractMesh | Vector3>;
  12260. /**
  12261. * The maximum number of particles to emit per frame
  12262. */
  12263. emitRate: number;
  12264. /**
  12265. * If you want to launch only a few particles at once, that can be done, as well.
  12266. */
  12267. manualEmitCount: number;
  12268. /**
  12269. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  12270. */
  12271. updateSpeed: number;
  12272. /**
  12273. * The amount of time the particle system is running (depends of the overall update speed).
  12274. */
  12275. targetStopDuration: number;
  12276. /**
  12277. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  12278. */
  12279. disposeOnStop: boolean;
  12280. /**
  12281. * Minimum power of emitting particles.
  12282. */
  12283. minEmitPower: number;
  12284. /**
  12285. * Maximum power of emitting particles.
  12286. */
  12287. maxEmitPower: number;
  12288. /**
  12289. * Minimum life time of emitting particles.
  12290. */
  12291. minLifeTime: number;
  12292. /**
  12293. * Maximum life time of emitting particles.
  12294. */
  12295. maxLifeTime: number;
  12296. /**
  12297. * Minimum Size of emitting particles.
  12298. */
  12299. minSize: number;
  12300. /**
  12301. * Maximum Size of emitting particles.
  12302. */
  12303. maxSize: number;
  12304. /**
  12305. * Minimum scale of emitting particles on X axis.
  12306. */
  12307. minScaleX: number;
  12308. /**
  12309. * Maximum scale of emitting particles on X axis.
  12310. */
  12311. maxScaleX: number;
  12312. /**
  12313. * Minimum scale of emitting particles on Y axis.
  12314. */
  12315. minScaleY: number;
  12316. /**
  12317. * Maximum scale of emitting particles on Y axis.
  12318. */
  12319. maxScaleY: number;
  12320. /**
  12321. * Gets or sets the minimal initial rotation in radians.
  12322. */
  12323. minInitialRotation: number;
  12324. /**
  12325. * Gets or sets the maximal initial rotation in radians.
  12326. */
  12327. maxInitialRotation: number;
  12328. /**
  12329. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  12330. */
  12331. minAngularSpeed: number;
  12332. /**
  12333. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  12334. */
  12335. maxAngularSpeed: number;
  12336. /**
  12337. * The texture used to render each particle. (this can be a spritesheet)
  12338. */
  12339. particleTexture: Nullable<BaseTexture>;
  12340. /**
  12341. * The layer mask we are rendering the particles through.
  12342. */
  12343. layerMask: number;
  12344. /**
  12345. * This can help using your own shader to render the particle system.
  12346. * The according effect will be created
  12347. */
  12348. customShader: any;
  12349. /**
  12350. * By default particle system starts as soon as they are created. This prevents the
  12351. * automatic start to happen and let you decide when to start emitting particles.
  12352. */
  12353. preventAutoStart: boolean;
  12354. private _noiseTexture;
  12355. /**
  12356. * Gets or sets a texture used to add random noise to particle positions
  12357. */
  12358. get noiseTexture(): Nullable<ProceduralTexture>;
  12359. set noiseTexture(value: Nullable<ProceduralTexture>);
  12360. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  12361. noiseStrength: Vector3;
  12362. /**
  12363. * Callback triggered when the particle animation is ending.
  12364. */
  12365. onAnimationEnd: Nullable<() => void>;
  12366. /**
  12367. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  12368. */
  12369. blendMode: number;
  12370. /**
  12371. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  12372. * to override the particles.
  12373. */
  12374. forceDepthWrite: boolean;
  12375. /** 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 */
  12376. preWarmCycles: number;
  12377. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  12378. preWarmStepOffset: number;
  12379. /**
  12380. * 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)
  12381. */
  12382. spriteCellChangeSpeed: number;
  12383. /**
  12384. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  12385. */
  12386. startSpriteCellID: number;
  12387. /**
  12388. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  12389. */
  12390. endSpriteCellID: number;
  12391. /**
  12392. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  12393. */
  12394. spriteCellWidth: number;
  12395. /**
  12396. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  12397. */
  12398. spriteCellHeight: number;
  12399. /**
  12400. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  12401. */
  12402. spriteRandomStartCell: boolean;
  12403. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  12404. translationPivot: Vector2;
  12405. /** @hidden */
  12406. protected _isAnimationSheetEnabled: boolean;
  12407. /**
  12408. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  12409. */
  12410. beginAnimationOnStart: boolean;
  12411. /**
  12412. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  12413. */
  12414. beginAnimationFrom: number;
  12415. /**
  12416. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  12417. */
  12418. beginAnimationTo: number;
  12419. /**
  12420. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  12421. */
  12422. beginAnimationLoop: boolean;
  12423. /**
  12424. * Gets or sets a world offset applied to all particles
  12425. */
  12426. worldOffset: Vector3;
  12427. /**
  12428. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  12429. */
  12430. get isAnimationSheetEnabled(): boolean;
  12431. set isAnimationSheetEnabled(value: boolean);
  12432. /**
  12433. * Get hosting scene
  12434. * @returns the scene
  12435. */
  12436. getScene(): Nullable<Scene>;
  12437. /**
  12438. * You can use gravity if you want to give an orientation to your particles.
  12439. */
  12440. gravity: Vector3;
  12441. protected _colorGradients: Nullable<Array<ColorGradient>>;
  12442. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  12443. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  12444. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  12445. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  12446. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  12447. protected _dragGradients: Nullable<Array<FactorGradient>>;
  12448. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  12449. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  12450. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  12451. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  12452. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  12453. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  12454. /**
  12455. * Defines the delay in milliseconds before starting the system (0 by default)
  12456. */
  12457. startDelay: number;
  12458. /**
  12459. * Gets the current list of drag gradients.
  12460. * You must use addDragGradient and removeDragGradient to udpate this list
  12461. * @returns the list of drag gradients
  12462. */
  12463. getDragGradients(): Nullable<Array<FactorGradient>>;
  12464. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  12465. limitVelocityDamping: number;
  12466. /**
  12467. * Gets the current list of limit velocity gradients.
  12468. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  12469. * @returns the list of limit velocity gradients
  12470. */
  12471. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  12472. /**
  12473. * Gets the current list of color gradients.
  12474. * You must use addColorGradient and removeColorGradient to udpate this list
  12475. * @returns the list of color gradients
  12476. */
  12477. getColorGradients(): Nullable<Array<ColorGradient>>;
  12478. /**
  12479. * Gets the current list of size gradients.
  12480. * You must use addSizeGradient and removeSizeGradient to udpate this list
  12481. * @returns the list of size gradients
  12482. */
  12483. getSizeGradients(): Nullable<Array<FactorGradient>>;
  12484. /**
  12485. * Gets the current list of color remap gradients.
  12486. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  12487. * @returns the list of color remap gradients
  12488. */
  12489. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  12490. /**
  12491. * Gets the current list of alpha remap gradients.
  12492. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  12493. * @returns the list of alpha remap gradients
  12494. */
  12495. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  12496. /**
  12497. * Gets the current list of life time gradients.
  12498. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  12499. * @returns the list of life time gradients
  12500. */
  12501. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  12502. /**
  12503. * Gets the current list of angular speed gradients.
  12504. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  12505. * @returns the list of angular speed gradients
  12506. */
  12507. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  12508. /**
  12509. * Gets the current list of velocity gradients.
  12510. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  12511. * @returns the list of velocity gradients
  12512. */
  12513. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  12514. /**
  12515. * Gets the current list of start size gradients.
  12516. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  12517. * @returns the list of start size gradients
  12518. */
  12519. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  12520. /**
  12521. * Gets the current list of emit rate gradients.
  12522. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  12523. * @returns the list of emit rate gradients
  12524. */
  12525. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  12526. /**
  12527. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12528. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12529. */
  12530. get direction1(): Vector3;
  12531. set direction1(value: Vector3);
  12532. /**
  12533. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12534. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12535. */
  12536. get direction2(): Vector3;
  12537. set direction2(value: Vector3);
  12538. /**
  12539. * 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.
  12540. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12541. */
  12542. get minEmitBox(): Vector3;
  12543. set minEmitBox(value: Vector3);
  12544. /**
  12545. * 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.
  12546. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12547. */
  12548. get maxEmitBox(): Vector3;
  12549. set maxEmitBox(value: Vector3);
  12550. /**
  12551. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12552. */
  12553. color1: Color4;
  12554. /**
  12555. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12556. */
  12557. color2: Color4;
  12558. /**
  12559. * Color the particle will have at the end of its lifetime
  12560. */
  12561. colorDead: Color4;
  12562. /**
  12563. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  12564. */
  12565. textureMask: Color4;
  12566. /**
  12567. * The particle emitter type defines the emitter used by the particle system.
  12568. * It can be for example box, sphere, or cone...
  12569. */
  12570. particleEmitterType: IParticleEmitterType;
  12571. /** @hidden */
  12572. _isSubEmitter: boolean;
  12573. /**
  12574. * Gets or sets the billboard mode to use when isBillboardBased = true.
  12575. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  12576. */
  12577. billboardMode: number;
  12578. protected _isBillboardBased: boolean;
  12579. /**
  12580. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  12581. */
  12582. get isBillboardBased(): boolean;
  12583. set isBillboardBased(value: boolean);
  12584. /**
  12585. * The scene the particle system belongs to.
  12586. */
  12587. protected _scene: Nullable<Scene>;
  12588. /**
  12589. * The engine the particle system belongs to.
  12590. */
  12591. protected _engine: ThinEngine;
  12592. /**
  12593. * Local cache of defines for image processing.
  12594. */
  12595. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  12596. /**
  12597. * Default configuration related to image processing available in the standard Material.
  12598. */
  12599. protected _imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  12600. /**
  12601. * Gets the image processing configuration used either in this material.
  12602. */
  12603. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  12604. /**
  12605. * Sets the Default image processing configuration used either in the this material.
  12606. *
  12607. * If sets to null, the scene one is in use.
  12608. */
  12609. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  12610. /**
  12611. * Attaches a new image processing configuration to the Standard Material.
  12612. * @param configuration
  12613. */
  12614. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  12615. /** @hidden */
  12616. protected _reset(): void;
  12617. /** @hidden */
  12618. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  12619. /**
  12620. * Instantiates a particle system.
  12621. * 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.
  12622. * @param name The name of the particle system
  12623. */
  12624. constructor(name: string);
  12625. /**
  12626. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  12627. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12628. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12629. * @returns the emitter
  12630. */
  12631. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  12632. /**
  12633. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  12634. * @param radius The radius of the hemisphere to emit from
  12635. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12636. * @returns the emitter
  12637. */
  12638. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  12639. /**
  12640. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  12641. * @param radius The radius of the sphere to emit from
  12642. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12643. * @returns the emitter
  12644. */
  12645. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  12646. /**
  12647. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  12648. * @param radius The radius of the sphere to emit from
  12649. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  12650. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  12651. * @returns the emitter
  12652. */
  12653. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  12654. /**
  12655. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  12656. * @param radius The radius of the emission cylinder
  12657. * @param height The height of the emission cylinder
  12658. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  12659. * @param directionRandomizer How much to randomize the particle direction [0-1]
  12660. * @returns the emitter
  12661. */
  12662. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  12663. /**
  12664. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  12665. * @param radius The radius of the cylinder to emit from
  12666. * @param height The height of the emission cylinder
  12667. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  12668. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  12669. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  12670. * @returns the emitter
  12671. */
  12672. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  12673. /**
  12674. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  12675. * @param radius The radius of the cone to emit from
  12676. * @param angle The base angle of the cone
  12677. * @returns the emitter
  12678. */
  12679. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  12680. /**
  12681. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  12682. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12683. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12684. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12685. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12686. * @returns the emitter
  12687. */
  12688. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  12689. }
  12690. }
  12691. declare module "babylonjs/Particles/subEmitter" {
  12692. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12693. import { Scene } from "babylonjs/scene";
  12694. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  12695. /**
  12696. * Type of sub emitter
  12697. */
  12698. export enum SubEmitterType {
  12699. /**
  12700. * Attached to the particle over it's lifetime
  12701. */
  12702. ATTACHED = 0,
  12703. /**
  12704. * Created when the particle dies
  12705. */
  12706. END = 1
  12707. }
  12708. /**
  12709. * Sub emitter class used to emit particles from an existing particle
  12710. */
  12711. export class SubEmitter {
  12712. /**
  12713. * the particle system to be used by the sub emitter
  12714. */
  12715. particleSystem: ParticleSystem;
  12716. /**
  12717. * Type of the submitter (Default: END)
  12718. */
  12719. type: SubEmitterType;
  12720. /**
  12721. * 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)
  12722. * Note: This only is supported when using an emitter of type Mesh
  12723. */
  12724. inheritDirection: boolean;
  12725. /**
  12726. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  12727. */
  12728. inheritedVelocityAmount: number;
  12729. /**
  12730. * Creates a sub emitter
  12731. * @param particleSystem the particle system to be used by the sub emitter
  12732. */
  12733. constructor(
  12734. /**
  12735. * the particle system to be used by the sub emitter
  12736. */
  12737. particleSystem: ParticleSystem);
  12738. /**
  12739. * Clones the sub emitter
  12740. * @returns the cloned sub emitter
  12741. */
  12742. clone(): SubEmitter;
  12743. /**
  12744. * Serialize current object to a JSON object
  12745. * @returns the serialized object
  12746. */
  12747. serialize(): any;
  12748. /** @hidden */
  12749. static _ParseParticleSystem(system: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): ParticleSystem;
  12750. /**
  12751. * Creates a new SubEmitter from a serialized JSON version
  12752. * @param serializationObject defines the JSON object to read from
  12753. * @param sceneOrEngine defines the hosting scene or the hosting engine
  12754. * @param rootUrl defines the rootUrl for data loading
  12755. * @returns a new SubEmitter
  12756. */
  12757. static Parse(serializationObject: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): SubEmitter;
  12758. /** Release associated resources */
  12759. dispose(): void;
  12760. }
  12761. }
  12762. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration" {
  12763. /** @hidden */
  12764. export var imageProcessingDeclaration: {
  12765. name: string;
  12766. shader: string;
  12767. };
  12768. }
  12769. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions" {
  12770. /** @hidden */
  12771. export var imageProcessingFunctions: {
  12772. name: string;
  12773. shader: string;
  12774. };
  12775. }
  12776. declare module "babylonjs/Shaders/particles.fragment" {
  12777. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  12778. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  12779. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  12780. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  12781. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  12782. /** @hidden */
  12783. export var particlesPixelShader: {
  12784. name: string;
  12785. shader: string;
  12786. };
  12787. }
  12788. declare module "babylonjs/Shaders/particles.vertex" {
  12789. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  12790. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  12791. /** @hidden */
  12792. export var particlesVertexShader: {
  12793. name: string;
  12794. shader: string;
  12795. };
  12796. }
  12797. declare module "babylonjs/Misc/interfaces/iClipPlanesHolder" {
  12798. import { Nullable } from "babylonjs/types";
  12799. import { Plane } from "babylonjs/Maths/math";
  12800. /**
  12801. * Interface used to define entities containing multiple clip planes
  12802. */
  12803. export interface IClipPlanesHolder {
  12804. /**
  12805. * Gets or sets the active clipplane 1
  12806. */
  12807. clipPlane: Nullable<Plane>;
  12808. /**
  12809. * Gets or sets the active clipplane 2
  12810. */
  12811. clipPlane2: Nullable<Plane>;
  12812. /**
  12813. * Gets or sets the active clipplane 3
  12814. */
  12815. clipPlane3: Nullable<Plane>;
  12816. /**
  12817. * Gets or sets the active clipplane 4
  12818. */
  12819. clipPlane4: Nullable<Plane>;
  12820. /**
  12821. * Gets or sets the active clipplane 5
  12822. */
  12823. clipPlane5: Nullable<Plane>;
  12824. /**
  12825. * Gets or sets the active clipplane 6
  12826. */
  12827. clipPlane6: Nullable<Plane>;
  12828. }
  12829. }
  12830. declare module "babylonjs/Materials/thinMaterialHelper" {
  12831. import { Effect } from "babylonjs/Materials/effect";
  12832. import { IClipPlanesHolder } from "babylonjs/Misc/interfaces/iClipPlanesHolder";
  12833. /**
  12834. * "Static Class" containing a few commonly used helper while dealing with material for rendering purpose.
  12835. *
  12836. * It is complementary with MaterialHelper but provides completely independent functions (for tree shaking sake)
  12837. *
  12838. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  12839. */
  12840. export class ThinMaterialHelper {
  12841. /**
  12842. * Binds the clip plane information from the holder to the effect.
  12843. * @param effect The effect we are binding the data to
  12844. * @param holder The entity containing the clip plane information
  12845. */
  12846. static BindClipPlane(effect: Effect, holder: IClipPlanesHolder): void;
  12847. }
  12848. }
  12849. declare module "babylonjs/Engines/Extensions/engine.alpha" {
  12850. module "babylonjs/Engines/thinEngine" {
  12851. interface ThinEngine {
  12852. /**
  12853. * Sets alpha constants used by some alpha blending modes
  12854. * @param r defines the red component
  12855. * @param g defines the green component
  12856. * @param b defines the blue component
  12857. * @param a defines the alpha component
  12858. */
  12859. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  12860. /**
  12861. * Sets the current alpha mode
  12862. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  12863. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  12864. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  12865. */
  12866. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  12867. /**
  12868. * Gets the current alpha mode
  12869. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  12870. * @returns the current alpha mode
  12871. */
  12872. getAlphaMode(): number;
  12873. /**
  12874. * Sets the current alpha equation
  12875. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  12876. */
  12877. setAlphaEquation(equation: number): void;
  12878. /**
  12879. * Gets the current alpha equation.
  12880. * @returns the current alpha equation
  12881. */
  12882. getAlphaEquation(): number;
  12883. }
  12884. }
  12885. }
  12886. declare module "babylonjs/Particles/particleSystem" {
  12887. import { Nullable } from "babylonjs/types";
  12888. import { FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  12889. import { Observable } from "babylonjs/Misc/observable";
  12890. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  12891. import { Effect } from "babylonjs/Materials/effect";
  12892. import { IDisposable } from "babylonjs/scene";
  12893. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  12894. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  12895. import { Particle } from "babylonjs/Particles/particle";
  12896. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  12897. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  12898. import "babylonjs/Shaders/particles.fragment";
  12899. import "babylonjs/Shaders/particles.vertex";
  12900. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  12901. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12902. import "babylonjs/Engines/Extensions/engine.alpha";
  12903. import { Scene } from "babylonjs/scene";
  12904. /**
  12905. * This represents a particle system in Babylon.
  12906. * 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.
  12907. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12908. * @example https://doc.babylonjs.com/babylon101/particles
  12909. */
  12910. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  12911. /**
  12912. * Billboard mode will only apply to Y axis
  12913. */
  12914. static readonly BILLBOARDMODE_Y: number;
  12915. /**
  12916. * Billboard mode will apply to all axes
  12917. */
  12918. static readonly BILLBOARDMODE_ALL: number;
  12919. /**
  12920. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  12921. */
  12922. static readonly BILLBOARDMODE_STRETCHED: number;
  12923. /**
  12924. * This function can be defined to provide custom update for active particles.
  12925. * This function will be called instead of regular update (age, position, color, etc.).
  12926. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  12927. */
  12928. updateFunction: (particles: Particle[]) => void;
  12929. private _emitterWorldMatrix;
  12930. /**
  12931. * This function can be defined to specify initial direction for every new particle.
  12932. * It by default use the emitterType defined function
  12933. */
  12934. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12935. /**
  12936. * This function can be defined to specify initial position for every new particle.
  12937. * It by default use the emitterType defined function
  12938. */
  12939. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12940. /**
  12941. * @hidden
  12942. */
  12943. _inheritedVelocityOffset: Vector3;
  12944. /**
  12945. * An event triggered when the system is disposed
  12946. */
  12947. onDisposeObservable: Observable<IParticleSystem>;
  12948. private _onDisposeObserver;
  12949. /**
  12950. * Sets a callback that will be triggered when the system is disposed
  12951. */
  12952. set onDispose(callback: () => void);
  12953. private _particles;
  12954. private _epsilon;
  12955. private _capacity;
  12956. private _stockParticles;
  12957. private _newPartsExcess;
  12958. private _vertexData;
  12959. private _vertexBuffer;
  12960. private _vertexBuffers;
  12961. private _spriteBuffer;
  12962. private _indexBuffer;
  12963. private _effect;
  12964. private _customEffect;
  12965. private _cachedDefines;
  12966. private _scaledColorStep;
  12967. private _colorDiff;
  12968. private _scaledDirection;
  12969. private _scaledGravity;
  12970. private _currentRenderId;
  12971. private _alive;
  12972. private _useInstancing;
  12973. private _started;
  12974. private _stopped;
  12975. private _actualFrame;
  12976. private _scaledUpdateSpeed;
  12977. private _vertexBufferSize;
  12978. /** @hidden */
  12979. _currentEmitRateGradient: Nullable<FactorGradient>;
  12980. /** @hidden */
  12981. _currentEmitRate1: number;
  12982. /** @hidden */
  12983. _currentEmitRate2: number;
  12984. /** @hidden */
  12985. _currentStartSizeGradient: Nullable<FactorGradient>;
  12986. /** @hidden */
  12987. _currentStartSize1: number;
  12988. /** @hidden */
  12989. _currentStartSize2: number;
  12990. private readonly _rawTextureWidth;
  12991. private _rampGradientsTexture;
  12992. private _useRampGradients;
  12993. /** Gets or sets a matrix to use to compute projection */
  12994. defaultProjectionMatrix: Matrix;
  12995. /** Gets or sets a matrix to use to compute view */
  12996. defaultViewMatrix: Matrix;
  12997. /** Gets or sets a boolean indicating that ramp gradients must be used
  12998. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  12999. */
  13000. get useRampGradients(): boolean;
  13001. set useRampGradients(value: boolean);
  13002. /**
  13003. * 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.
  13004. * 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: [])
  13005. */
  13006. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  13007. private _subEmitters;
  13008. /**
  13009. * @hidden
  13010. * If the particle systems emitter should be disposed when the particle system is disposed
  13011. */
  13012. _disposeEmitterOnDispose: boolean;
  13013. /**
  13014. * The current active Sub-systems, this property is used by the root particle system only.
  13015. */
  13016. activeSubSystems: Array<ParticleSystem>;
  13017. /**
  13018. * Specifies if the particles are updated in emitter local space or world space
  13019. */
  13020. isLocal: boolean;
  13021. private _rootParticleSystem;
  13022. /**
  13023. * Gets the current list of active particles
  13024. */
  13025. get particles(): Particle[];
  13026. /**
  13027. * Gets the number of particles active at the same time.
  13028. * @returns The number of active particles.
  13029. */
  13030. getActiveCount(): number;
  13031. /**
  13032. * Returns the string "ParticleSystem"
  13033. * @returns a string containing the class name
  13034. */
  13035. getClassName(): string;
  13036. /**
  13037. * Gets a boolean indicating that the system is stopping
  13038. * @returns true if the system is currently stopping
  13039. */
  13040. isStopping(): boolean;
  13041. /**
  13042. * Gets the custom effect used to render the particles
  13043. * @param blendMode Blend mode for which the effect should be retrieved
  13044. * @returns The effect
  13045. */
  13046. getCustomEffect(blendMode?: number): Nullable<Effect>;
  13047. /**
  13048. * Sets the custom effect used to render the particles
  13049. * @param effect The effect to set
  13050. * @param blendMode Blend mode for which the effect should be set
  13051. */
  13052. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  13053. /** @hidden */
  13054. private _onBeforeDrawParticlesObservable;
  13055. /**
  13056. * Observable that will be called just before the particles are drawn
  13057. */
  13058. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  13059. /**
  13060. * Gets the name of the particle vertex shader
  13061. */
  13062. get vertexShaderName(): string;
  13063. /**
  13064. * Instantiates a particle system.
  13065. * 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.
  13066. * @param name The name of the particle system
  13067. * @param capacity The max number of particles alive at the same time
  13068. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  13069. * @param customEffect a custom effect used to change the way particles are rendered by default
  13070. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  13071. * @param epsilon Offset used to render the particles
  13072. */
  13073. constructor(name: string, capacity: number, sceneOrEngine: Scene | ThinEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  13074. private _addFactorGradient;
  13075. private _removeFactorGradient;
  13076. /**
  13077. * Adds a new life time gradient
  13078. * @param gradient defines the gradient to use (between 0 and 1)
  13079. * @param factor defines the life time factor to affect to the specified gradient
  13080. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13081. * @returns the current particle system
  13082. */
  13083. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13084. /**
  13085. * Remove a specific life time gradient
  13086. * @param gradient defines the gradient to remove
  13087. * @returns the current particle system
  13088. */
  13089. removeLifeTimeGradient(gradient: number): IParticleSystem;
  13090. /**
  13091. * Adds a new size gradient
  13092. * @param gradient defines the gradient to use (between 0 and 1)
  13093. * @param factor defines the size factor to affect to the specified gradient
  13094. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13095. * @returns the current particle system
  13096. */
  13097. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13098. /**
  13099. * Remove a specific size gradient
  13100. * @param gradient defines the gradient to remove
  13101. * @returns the current particle system
  13102. */
  13103. removeSizeGradient(gradient: number): IParticleSystem;
  13104. /**
  13105. * Adds a new color remap gradient
  13106. * @param gradient defines the gradient to use (between 0 and 1)
  13107. * @param min defines the color remap minimal range
  13108. * @param max defines the color remap maximal range
  13109. * @returns the current particle system
  13110. */
  13111. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  13112. /**
  13113. * Remove a specific color remap gradient
  13114. * @param gradient defines the gradient to remove
  13115. * @returns the current particle system
  13116. */
  13117. removeColorRemapGradient(gradient: number): IParticleSystem;
  13118. /**
  13119. * Adds a new alpha remap gradient
  13120. * @param gradient defines the gradient to use (between 0 and 1)
  13121. * @param min defines the alpha remap minimal range
  13122. * @param max defines the alpha remap maximal range
  13123. * @returns the current particle system
  13124. */
  13125. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  13126. /**
  13127. * Remove a specific alpha remap gradient
  13128. * @param gradient defines the gradient to remove
  13129. * @returns the current particle system
  13130. */
  13131. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  13132. /**
  13133. * Adds a new angular speed gradient
  13134. * @param gradient defines the gradient to use (between 0 and 1)
  13135. * @param factor defines the angular speed to affect to the specified gradient
  13136. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13137. * @returns the current particle system
  13138. */
  13139. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13140. /**
  13141. * Remove a specific angular speed gradient
  13142. * @param gradient defines the gradient to remove
  13143. * @returns the current particle system
  13144. */
  13145. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  13146. /**
  13147. * Adds a new velocity gradient
  13148. * @param gradient defines the gradient to use (between 0 and 1)
  13149. * @param factor defines the velocity to affect to the specified gradient
  13150. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13151. * @returns the current particle system
  13152. */
  13153. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13154. /**
  13155. * Remove a specific velocity gradient
  13156. * @param gradient defines the gradient to remove
  13157. * @returns the current particle system
  13158. */
  13159. removeVelocityGradient(gradient: number): IParticleSystem;
  13160. /**
  13161. * Adds a new limit velocity gradient
  13162. * @param gradient defines the gradient to use (between 0 and 1)
  13163. * @param factor defines the limit velocity value to affect to the specified gradient
  13164. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13165. * @returns the current particle system
  13166. */
  13167. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13168. /**
  13169. * Remove a specific limit velocity gradient
  13170. * @param gradient defines the gradient to remove
  13171. * @returns the current particle system
  13172. */
  13173. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  13174. /**
  13175. * Adds a new drag gradient
  13176. * @param gradient defines the gradient to use (between 0 and 1)
  13177. * @param factor defines the drag value to affect to the specified gradient
  13178. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13179. * @returns the current particle system
  13180. */
  13181. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13182. /**
  13183. * Remove a specific drag gradient
  13184. * @param gradient defines the gradient to remove
  13185. * @returns the current particle system
  13186. */
  13187. removeDragGradient(gradient: number): IParticleSystem;
  13188. /**
  13189. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  13190. * @param gradient defines the gradient to use (between 0 and 1)
  13191. * @param factor defines the emit rate value to affect to the specified gradient
  13192. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13193. * @returns the current particle system
  13194. */
  13195. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13196. /**
  13197. * Remove a specific emit rate gradient
  13198. * @param gradient defines the gradient to remove
  13199. * @returns the current particle system
  13200. */
  13201. removeEmitRateGradient(gradient: number): IParticleSystem;
  13202. /**
  13203. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  13204. * @param gradient defines the gradient to use (between 0 and 1)
  13205. * @param factor defines the start size value to affect to the specified gradient
  13206. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13207. * @returns the current particle system
  13208. */
  13209. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13210. /**
  13211. * Remove a specific start size gradient
  13212. * @param gradient defines the gradient to remove
  13213. * @returns the current particle system
  13214. */
  13215. removeStartSizeGradient(gradient: number): IParticleSystem;
  13216. private _createRampGradientTexture;
  13217. /**
  13218. * Gets the current list of ramp gradients.
  13219. * You must use addRampGradient and removeRampGradient to udpate this list
  13220. * @returns the list of ramp gradients
  13221. */
  13222. getRampGradients(): Nullable<Array<Color3Gradient>>;
  13223. /** Force the system to rebuild all gradients that need to be resync */
  13224. forceRefreshGradients(): void;
  13225. private _syncRampGradientTexture;
  13226. /**
  13227. * Adds a new ramp gradient used to remap particle colors
  13228. * @param gradient defines the gradient to use (between 0 and 1)
  13229. * @param color defines the color to affect to the specified gradient
  13230. * @returns the current particle system
  13231. */
  13232. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  13233. /**
  13234. * Remove a specific ramp gradient
  13235. * @param gradient defines the gradient to remove
  13236. * @returns the current particle system
  13237. */
  13238. removeRampGradient(gradient: number): ParticleSystem;
  13239. /**
  13240. * Adds a new color gradient
  13241. * @param gradient defines the gradient to use (between 0 and 1)
  13242. * @param color1 defines the color to affect to the specified gradient
  13243. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  13244. * @returns this particle system
  13245. */
  13246. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  13247. /**
  13248. * Remove a specific color gradient
  13249. * @param gradient defines the gradient to remove
  13250. * @returns this particle system
  13251. */
  13252. removeColorGradient(gradient: number): IParticleSystem;
  13253. private _fetchR;
  13254. protected _reset(): void;
  13255. private _resetEffect;
  13256. private _createVertexBuffers;
  13257. private _createIndexBuffer;
  13258. /**
  13259. * Gets the maximum number of particles active at the same time.
  13260. * @returns The max number of active particles.
  13261. */
  13262. getCapacity(): number;
  13263. /**
  13264. * Gets whether there are still active particles in the system.
  13265. * @returns True if it is alive, otherwise false.
  13266. */
  13267. isAlive(): boolean;
  13268. /**
  13269. * Gets if the system has been started. (Note: this will still be true after stop is called)
  13270. * @returns True if it has been started, otherwise false.
  13271. */
  13272. isStarted(): boolean;
  13273. private _prepareSubEmitterInternalArray;
  13274. /**
  13275. * Starts the particle system and begins to emit
  13276. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  13277. */
  13278. start(delay?: number): void;
  13279. /**
  13280. * Stops the particle system.
  13281. * @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.
  13282. */
  13283. stop(stopSubEmitters?: boolean): void;
  13284. /**
  13285. * Remove all active particles
  13286. */
  13287. reset(): void;
  13288. /**
  13289. * @hidden (for internal use only)
  13290. */
  13291. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  13292. /**
  13293. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  13294. * Its lifetime will start back at 0.
  13295. */
  13296. recycleParticle: (particle: Particle) => void;
  13297. private _stopSubEmitters;
  13298. private _createParticle;
  13299. private _removeFromRoot;
  13300. private _emitFromParticle;
  13301. private _update;
  13302. /** @hidden */
  13303. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  13304. /** @hidden */
  13305. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  13306. /**
  13307. * Fill the defines array according to the current settings of the particle system
  13308. * @param defines Array to be updated
  13309. * @param blendMode blend mode to take into account when updating the array
  13310. */
  13311. fillDefines(defines: Array<string>, blendMode: number): void;
  13312. /**
  13313. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  13314. * @param uniforms Uniforms array to fill
  13315. * @param attributes Attributes array to fill
  13316. * @param samplers Samplers array to fill
  13317. */
  13318. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  13319. /** @hidden */
  13320. private _getEffect;
  13321. /**
  13322. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  13323. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  13324. */
  13325. animate(preWarmOnly?: boolean): void;
  13326. private _appendParticleVertices;
  13327. /**
  13328. * Rebuilds the particle system.
  13329. */
  13330. rebuild(): void;
  13331. /**
  13332. * Is this system ready to be used/rendered
  13333. * @return true if the system is ready
  13334. */
  13335. isReady(): boolean;
  13336. private _render;
  13337. /**
  13338. * Renders the particle system in its current state.
  13339. * @returns the current number of particles
  13340. */
  13341. render(): number;
  13342. /**
  13343. * Disposes the particle system and free the associated resources
  13344. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  13345. */
  13346. dispose(disposeTexture?: boolean): void;
  13347. /**
  13348. * Clones the particle system.
  13349. * @param name The name of the cloned object
  13350. * @param newEmitter The new emitter to use
  13351. * @returns the cloned particle system
  13352. */
  13353. clone(name: string, newEmitter: any): ParticleSystem;
  13354. /**
  13355. * Serializes the particle system to a JSON object
  13356. * @param serializeTexture defines if the texture must be serialized as well
  13357. * @returns the JSON object
  13358. */
  13359. serialize(serializeTexture?: boolean): any;
  13360. /** @hidden */
  13361. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  13362. /** @hidden */
  13363. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, sceneOrEngine: Scene | ThinEngine, rootUrl: string): void;
  13364. /**
  13365. * Parses a JSON object to create a particle system.
  13366. * @param parsedParticleSystem The JSON object to parse
  13367. * @param sceneOrEngine The scene or the engine to create the particle system in
  13368. * @param rootUrl The root url to use to load external dependencies like texture
  13369. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  13370. * @returns the Parsed particle system
  13371. */
  13372. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  13373. }
  13374. }
  13375. declare module "babylonjs/Particles/particle" {
  13376. import { Nullable } from "babylonjs/types";
  13377. import { Vector2, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  13378. import { Color4 } from "babylonjs/Maths/math.color";
  13379. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  13380. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  13381. import { ColorGradient, FactorGradient } from "babylonjs/Misc/gradients";
  13382. /**
  13383. * A particle represents one of the element emitted by a particle system.
  13384. * This is mainly define by its coordinates, direction, velocity and age.
  13385. */
  13386. export class Particle {
  13387. /**
  13388. * The particle system the particle belongs to.
  13389. */
  13390. particleSystem: ParticleSystem;
  13391. private static _Count;
  13392. /**
  13393. * Unique ID of the particle
  13394. */
  13395. id: number;
  13396. /**
  13397. * The world position of the particle in the scene.
  13398. */
  13399. position: Vector3;
  13400. /**
  13401. * The world direction of the particle in the scene.
  13402. */
  13403. direction: Vector3;
  13404. /**
  13405. * The color of the particle.
  13406. */
  13407. color: Color4;
  13408. /**
  13409. * The color change of the particle per step.
  13410. */
  13411. colorStep: Color4;
  13412. /**
  13413. * Defines how long will the life of the particle be.
  13414. */
  13415. lifeTime: number;
  13416. /**
  13417. * The current age of the particle.
  13418. */
  13419. age: number;
  13420. /**
  13421. * The current size of the particle.
  13422. */
  13423. size: number;
  13424. /**
  13425. * The current scale of the particle.
  13426. */
  13427. scale: Vector2;
  13428. /**
  13429. * The current angle of the particle.
  13430. */
  13431. angle: number;
  13432. /**
  13433. * Defines how fast is the angle changing.
  13434. */
  13435. angularSpeed: number;
  13436. /**
  13437. * Defines the cell index used by the particle to be rendered from a sprite.
  13438. */
  13439. cellIndex: number;
  13440. /**
  13441. * The information required to support color remapping
  13442. */
  13443. remapData: Vector4;
  13444. /** @hidden */
  13445. _randomCellOffset?: number;
  13446. /** @hidden */
  13447. _initialDirection: Nullable<Vector3>;
  13448. /** @hidden */
  13449. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  13450. /** @hidden */
  13451. _initialStartSpriteCellID: number;
  13452. /** @hidden */
  13453. _initialEndSpriteCellID: number;
  13454. /** @hidden */
  13455. _currentColorGradient: Nullable<ColorGradient>;
  13456. /** @hidden */
  13457. _currentColor1: Color4;
  13458. /** @hidden */
  13459. _currentColor2: Color4;
  13460. /** @hidden */
  13461. _currentSizeGradient: Nullable<FactorGradient>;
  13462. /** @hidden */
  13463. _currentSize1: number;
  13464. /** @hidden */
  13465. _currentSize2: number;
  13466. /** @hidden */
  13467. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  13468. /** @hidden */
  13469. _currentAngularSpeed1: number;
  13470. /** @hidden */
  13471. _currentAngularSpeed2: number;
  13472. /** @hidden */
  13473. _currentVelocityGradient: Nullable<FactorGradient>;
  13474. /** @hidden */
  13475. _currentVelocity1: number;
  13476. /** @hidden */
  13477. _currentVelocity2: number;
  13478. /** @hidden */
  13479. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  13480. /** @hidden */
  13481. _currentLimitVelocity1: number;
  13482. /** @hidden */
  13483. _currentLimitVelocity2: number;
  13484. /** @hidden */
  13485. _currentDragGradient: Nullable<FactorGradient>;
  13486. /** @hidden */
  13487. _currentDrag1: number;
  13488. /** @hidden */
  13489. _currentDrag2: number;
  13490. /** @hidden */
  13491. _randomNoiseCoordinates1: Vector3;
  13492. /** @hidden */
  13493. _randomNoiseCoordinates2: Vector3;
  13494. /** @hidden */
  13495. _localPosition?: Vector3;
  13496. /**
  13497. * Creates a new instance Particle
  13498. * @param particleSystem the particle system the particle belongs to
  13499. */
  13500. constructor(
  13501. /**
  13502. * The particle system the particle belongs to.
  13503. */
  13504. particleSystem: ParticleSystem);
  13505. private updateCellInfoFromSystem;
  13506. /**
  13507. * Defines how the sprite cell index is updated for the particle
  13508. */
  13509. updateCellIndex(): void;
  13510. /** @hidden */
  13511. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  13512. /** @hidden */
  13513. _inheritParticleInfoToSubEmitters(): void;
  13514. /** @hidden */
  13515. _reset(): void;
  13516. /**
  13517. * Copy the properties of particle to another one.
  13518. * @param other the particle to copy the information to.
  13519. */
  13520. copyTo(other: Particle): void;
  13521. }
  13522. }
  13523. declare module "babylonjs/Particles/EmitterTypes/IParticleEmitterType" {
  13524. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13525. import { Effect } from "babylonjs/Materials/effect";
  13526. import { Particle } from "babylonjs/Particles/particle";
  13527. import { Nullable } from "babylonjs/types";
  13528. import { Scene } from "babylonjs/scene";
  13529. /**
  13530. * Particle emitter represents a volume emitting particles.
  13531. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  13532. */
  13533. export interface IParticleEmitterType {
  13534. /**
  13535. * Called by the particle System when the direction is computed for the created particle.
  13536. * @param worldMatrix is the world matrix of the particle system
  13537. * @param directionToUpdate is the direction vector to update with the result
  13538. * @param particle is the particle we are computed the direction for
  13539. * @param isLocal defines if the direction should be set in local space
  13540. */
  13541. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13542. /**
  13543. * Called by the particle System when the position is computed for the created particle.
  13544. * @param worldMatrix is the world matrix of the particle system
  13545. * @param positionToUpdate is the position vector to update with the result
  13546. * @param particle is the particle we are computed the position for
  13547. * @param isLocal defines if the position should be set in local space
  13548. */
  13549. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13550. /**
  13551. * Clones the current emitter and returns a copy of it
  13552. * @returns the new emitter
  13553. */
  13554. clone(): IParticleEmitterType;
  13555. /**
  13556. * Called by the GPUParticleSystem to setup the update shader
  13557. * @param effect defines the update shader
  13558. */
  13559. applyToShader(effect: Effect): void;
  13560. /**
  13561. * Returns a string to use to update the GPU particles update shader
  13562. * @returns the effect defines string
  13563. */
  13564. getEffectDefines(): string;
  13565. /**
  13566. * Returns a string representing the class name
  13567. * @returns a string containing the class name
  13568. */
  13569. getClassName(): string;
  13570. /**
  13571. * Serializes the particle system to a JSON object.
  13572. * @returns the JSON object
  13573. */
  13574. serialize(): any;
  13575. /**
  13576. * Parse properties from a JSON object
  13577. * @param serializationObject defines the JSON object
  13578. * @param scene defines the hosting scene
  13579. */
  13580. parse(serializationObject: any, scene: Nullable<Scene>): void;
  13581. }
  13582. }
  13583. declare module "babylonjs/Particles/EmitterTypes/boxParticleEmitter" {
  13584. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13585. import { Effect } from "babylonjs/Materials/effect";
  13586. import { Particle } from "babylonjs/Particles/particle";
  13587. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13588. /**
  13589. * Particle emitter emitting particles from the inside of a box.
  13590. * It emits the particles randomly between 2 given directions.
  13591. */
  13592. export class BoxParticleEmitter implements IParticleEmitterType {
  13593. /**
  13594. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13595. */
  13596. direction1: Vector3;
  13597. /**
  13598. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13599. */
  13600. direction2: Vector3;
  13601. /**
  13602. * 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.
  13603. */
  13604. minEmitBox: Vector3;
  13605. /**
  13606. * 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.
  13607. */
  13608. maxEmitBox: Vector3;
  13609. /**
  13610. * Creates a new instance BoxParticleEmitter
  13611. */
  13612. constructor();
  13613. /**
  13614. * Called by the particle System when the direction is computed for the created particle.
  13615. * @param worldMatrix is the world matrix of the particle system
  13616. * @param directionToUpdate is the direction vector to update with the result
  13617. * @param particle is the particle we are computed the direction for
  13618. * @param isLocal defines if the direction should be set in local space
  13619. */
  13620. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13621. /**
  13622. * Called by the particle System when the position is computed for the created particle.
  13623. * @param worldMatrix is the world matrix of the particle system
  13624. * @param positionToUpdate is the position vector to update with the result
  13625. * @param particle is the particle we are computed the position for
  13626. * @param isLocal defines if the position should be set in local space
  13627. */
  13628. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13629. /**
  13630. * Clones the current emitter and returns a copy of it
  13631. * @returns the new emitter
  13632. */
  13633. clone(): BoxParticleEmitter;
  13634. /**
  13635. * Called by the GPUParticleSystem to setup the update shader
  13636. * @param effect defines the update shader
  13637. */
  13638. applyToShader(effect: Effect): void;
  13639. /**
  13640. * Returns a string to use to update the GPU particles update shader
  13641. * @returns a string containng the defines string
  13642. */
  13643. getEffectDefines(): string;
  13644. /**
  13645. * Returns the string "BoxParticleEmitter"
  13646. * @returns a string containing the class name
  13647. */
  13648. getClassName(): string;
  13649. /**
  13650. * Serializes the particle system to a JSON object.
  13651. * @returns the JSON object
  13652. */
  13653. serialize(): any;
  13654. /**
  13655. * Parse properties from a JSON object
  13656. * @param serializationObject defines the JSON object
  13657. */
  13658. parse(serializationObject: any): void;
  13659. }
  13660. }
  13661. declare module "babylonjs/Particles/EmitterTypes/coneParticleEmitter" {
  13662. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13663. import { Effect } from "babylonjs/Materials/effect";
  13664. import { Particle } from "babylonjs/Particles/particle";
  13665. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13666. /**
  13667. * Particle emitter emitting particles from the inside of a cone.
  13668. * It emits the particles alongside the cone volume from the base to the particle.
  13669. * The emission direction might be randomized.
  13670. */
  13671. export class ConeParticleEmitter implements IParticleEmitterType {
  13672. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13673. directionRandomizer: number;
  13674. private _radius;
  13675. private _angle;
  13676. private _height;
  13677. /**
  13678. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  13679. */
  13680. radiusRange: number;
  13681. /**
  13682. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  13683. */
  13684. heightRange: number;
  13685. /**
  13686. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  13687. */
  13688. emitFromSpawnPointOnly: boolean;
  13689. /**
  13690. * Gets or sets the radius of the emission cone
  13691. */
  13692. get radius(): number;
  13693. set radius(value: number);
  13694. /**
  13695. * Gets or sets the angle of the emission cone
  13696. */
  13697. get angle(): number;
  13698. set angle(value: number);
  13699. private _buildHeight;
  13700. /**
  13701. * Creates a new instance ConeParticleEmitter
  13702. * @param radius the radius of the emission cone (1 by default)
  13703. * @param angle the cone base angle (PI by default)
  13704. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  13705. */
  13706. constructor(radius?: number, angle?: number,
  13707. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13708. directionRandomizer?: number);
  13709. /**
  13710. * Called by the particle System when the direction is computed for the created particle.
  13711. * @param worldMatrix is the world matrix of the particle system
  13712. * @param directionToUpdate is the direction vector to update with the result
  13713. * @param particle is the particle we are computed the direction for
  13714. * @param isLocal defines if the direction should be set in local space
  13715. */
  13716. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13717. /**
  13718. * Called by the particle System when the position is computed for the created particle.
  13719. * @param worldMatrix is the world matrix of the particle system
  13720. * @param positionToUpdate is the position vector to update with the result
  13721. * @param particle is the particle we are computed the position for
  13722. * @param isLocal defines if the position should be set in local space
  13723. */
  13724. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13725. /**
  13726. * Clones the current emitter and returns a copy of it
  13727. * @returns the new emitter
  13728. */
  13729. clone(): ConeParticleEmitter;
  13730. /**
  13731. * Called by the GPUParticleSystem to setup the update shader
  13732. * @param effect defines the update shader
  13733. */
  13734. applyToShader(effect: Effect): void;
  13735. /**
  13736. * Returns a string to use to update the GPU particles update shader
  13737. * @returns a string containng the defines string
  13738. */
  13739. getEffectDefines(): string;
  13740. /**
  13741. * Returns the string "ConeParticleEmitter"
  13742. * @returns a string containing the class name
  13743. */
  13744. getClassName(): string;
  13745. /**
  13746. * Serializes the particle system to a JSON object.
  13747. * @returns the JSON object
  13748. */
  13749. serialize(): any;
  13750. /**
  13751. * Parse properties from a JSON object
  13752. * @param serializationObject defines the JSON object
  13753. */
  13754. parse(serializationObject: any): void;
  13755. }
  13756. }
  13757. declare module "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter" {
  13758. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13759. import { Effect } from "babylonjs/Materials/effect";
  13760. import { Particle } from "babylonjs/Particles/particle";
  13761. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13762. /**
  13763. * Particle emitter emitting particles from the inside of a cylinder.
  13764. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  13765. */
  13766. export class CylinderParticleEmitter implements IParticleEmitterType {
  13767. /**
  13768. * The radius of the emission cylinder.
  13769. */
  13770. radius: number;
  13771. /**
  13772. * The height of the emission cylinder.
  13773. */
  13774. height: number;
  13775. /**
  13776. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13777. */
  13778. radiusRange: number;
  13779. /**
  13780. * How much to randomize the particle direction [0-1].
  13781. */
  13782. directionRandomizer: number;
  13783. /**
  13784. * Creates a new instance CylinderParticleEmitter
  13785. * @param radius the radius of the emission cylinder (1 by default)
  13786. * @param height the height of the emission cylinder (1 by default)
  13787. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13788. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13789. */
  13790. constructor(
  13791. /**
  13792. * The radius of the emission cylinder.
  13793. */
  13794. radius?: number,
  13795. /**
  13796. * The height of the emission cylinder.
  13797. */
  13798. height?: number,
  13799. /**
  13800. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13801. */
  13802. radiusRange?: number,
  13803. /**
  13804. * How much to randomize the particle direction [0-1].
  13805. */
  13806. directionRandomizer?: number);
  13807. /**
  13808. * Called by the particle System when the direction is computed for the created particle.
  13809. * @param worldMatrix is the world matrix of the particle system
  13810. * @param directionToUpdate is the direction vector to update with the result
  13811. * @param particle is the particle we are computed the direction for
  13812. * @param isLocal defines if the direction should be set in local space
  13813. */
  13814. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13815. /**
  13816. * Called by the particle System when the position is computed for the created particle.
  13817. * @param worldMatrix is the world matrix of the particle system
  13818. * @param positionToUpdate is the position vector to update with the result
  13819. * @param particle is the particle we are computed the position for
  13820. * @param isLocal defines if the position should be set in local space
  13821. */
  13822. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13823. /**
  13824. * Clones the current emitter and returns a copy of it
  13825. * @returns the new emitter
  13826. */
  13827. clone(): CylinderParticleEmitter;
  13828. /**
  13829. * Called by the GPUParticleSystem to setup the update shader
  13830. * @param effect defines the update shader
  13831. */
  13832. applyToShader(effect: Effect): void;
  13833. /**
  13834. * Returns a string to use to update the GPU particles update shader
  13835. * @returns a string containng the defines string
  13836. */
  13837. getEffectDefines(): string;
  13838. /**
  13839. * Returns the string "CylinderParticleEmitter"
  13840. * @returns a string containing the class name
  13841. */
  13842. getClassName(): string;
  13843. /**
  13844. * Serializes the particle system to a JSON object.
  13845. * @returns the JSON object
  13846. */
  13847. serialize(): any;
  13848. /**
  13849. * Parse properties from a JSON object
  13850. * @param serializationObject defines the JSON object
  13851. */
  13852. parse(serializationObject: any): void;
  13853. }
  13854. /**
  13855. * Particle emitter emitting particles from the inside of a cylinder.
  13856. * It emits the particles randomly between two vectors.
  13857. */
  13858. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  13859. /**
  13860. * The min limit of the emission direction.
  13861. */
  13862. direction1: Vector3;
  13863. /**
  13864. * The max limit of the emission direction.
  13865. */
  13866. direction2: Vector3;
  13867. /**
  13868. * Creates a new instance CylinderDirectedParticleEmitter
  13869. * @param radius the radius of the emission cylinder (1 by default)
  13870. * @param height the height of the emission cylinder (1 by default)
  13871. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13872. * @param direction1 the min limit of the emission direction (up vector by default)
  13873. * @param direction2 the max limit of the emission direction (up vector by default)
  13874. */
  13875. constructor(radius?: number, height?: number, radiusRange?: number,
  13876. /**
  13877. * The min limit of the emission direction.
  13878. */
  13879. direction1?: Vector3,
  13880. /**
  13881. * The max limit of the emission direction.
  13882. */
  13883. direction2?: Vector3);
  13884. /**
  13885. * Called by the particle System when the direction is computed for the created particle.
  13886. * @param worldMatrix is the world matrix of the particle system
  13887. * @param directionToUpdate is the direction vector to update with the result
  13888. * @param particle is the particle we are computed the direction for
  13889. */
  13890. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  13891. /**
  13892. * Clones the current emitter and returns a copy of it
  13893. * @returns the new emitter
  13894. */
  13895. clone(): CylinderDirectedParticleEmitter;
  13896. /**
  13897. * Called by the GPUParticleSystem to setup the update shader
  13898. * @param effect defines the update shader
  13899. */
  13900. applyToShader(effect: Effect): void;
  13901. /**
  13902. * Returns a string to use to update the GPU particles update shader
  13903. * @returns a string containng the defines string
  13904. */
  13905. getEffectDefines(): string;
  13906. /**
  13907. * Returns the string "CylinderDirectedParticleEmitter"
  13908. * @returns a string containing the class name
  13909. */
  13910. getClassName(): string;
  13911. /**
  13912. * Serializes the particle system to a JSON object.
  13913. * @returns the JSON object
  13914. */
  13915. serialize(): any;
  13916. /**
  13917. * Parse properties from a JSON object
  13918. * @param serializationObject defines the JSON object
  13919. */
  13920. parse(serializationObject: any): void;
  13921. }
  13922. }
  13923. declare module "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter" {
  13924. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13925. import { Effect } from "babylonjs/Materials/effect";
  13926. import { Particle } from "babylonjs/Particles/particle";
  13927. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13928. /**
  13929. * Particle emitter emitting particles from the inside of a hemisphere.
  13930. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  13931. */
  13932. export class HemisphericParticleEmitter implements IParticleEmitterType {
  13933. /**
  13934. * The radius of the emission hemisphere.
  13935. */
  13936. radius: number;
  13937. /**
  13938. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13939. */
  13940. radiusRange: number;
  13941. /**
  13942. * How much to randomize the particle direction [0-1].
  13943. */
  13944. directionRandomizer: number;
  13945. /**
  13946. * Creates a new instance HemisphericParticleEmitter
  13947. * @param radius the radius of the emission hemisphere (1 by default)
  13948. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13949. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13950. */
  13951. constructor(
  13952. /**
  13953. * The radius of the emission hemisphere.
  13954. */
  13955. radius?: number,
  13956. /**
  13957. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13958. */
  13959. radiusRange?: number,
  13960. /**
  13961. * How much to randomize the particle direction [0-1].
  13962. */
  13963. directionRandomizer?: number);
  13964. /**
  13965. * Called by the particle System when the direction is computed for the created particle.
  13966. * @param worldMatrix is the world matrix of the particle system
  13967. * @param directionToUpdate is the direction vector to update with the result
  13968. * @param particle is the particle we are computed the direction for
  13969. * @param isLocal defines if the direction should be set in local space
  13970. */
  13971. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13972. /**
  13973. * Called by the particle System when the position is computed for the created particle.
  13974. * @param worldMatrix is the world matrix of the particle system
  13975. * @param positionToUpdate is the position vector to update with the result
  13976. * @param particle is the particle we are computed the position for
  13977. * @param isLocal defines if the position should be set in local space
  13978. */
  13979. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13980. /**
  13981. * Clones the current emitter and returns a copy of it
  13982. * @returns the new emitter
  13983. */
  13984. clone(): HemisphericParticleEmitter;
  13985. /**
  13986. * Called by the GPUParticleSystem to setup the update shader
  13987. * @param effect defines the update shader
  13988. */
  13989. applyToShader(effect: Effect): void;
  13990. /**
  13991. * Returns a string to use to update the GPU particles update shader
  13992. * @returns a string containng the defines string
  13993. */
  13994. getEffectDefines(): string;
  13995. /**
  13996. * Returns the string "HemisphericParticleEmitter"
  13997. * @returns a string containing the class name
  13998. */
  13999. getClassName(): string;
  14000. /**
  14001. * Serializes the particle system to a JSON object.
  14002. * @returns the JSON object
  14003. */
  14004. serialize(): any;
  14005. /**
  14006. * Parse properties from a JSON object
  14007. * @param serializationObject defines the JSON object
  14008. */
  14009. parse(serializationObject: any): void;
  14010. }
  14011. }
  14012. declare module "babylonjs/Particles/EmitterTypes/pointParticleEmitter" {
  14013. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14014. import { Effect } from "babylonjs/Materials/effect";
  14015. import { Particle } from "babylonjs/Particles/particle";
  14016. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14017. /**
  14018. * Particle emitter emitting particles from a point.
  14019. * It emits the particles randomly between 2 given directions.
  14020. */
  14021. export class PointParticleEmitter implements IParticleEmitterType {
  14022. /**
  14023. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14024. */
  14025. direction1: Vector3;
  14026. /**
  14027. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14028. */
  14029. direction2: Vector3;
  14030. /**
  14031. * Creates a new instance PointParticleEmitter
  14032. */
  14033. constructor();
  14034. /**
  14035. * Called by the particle System when the direction is computed for the created particle.
  14036. * @param worldMatrix is the world matrix of the particle system
  14037. * @param directionToUpdate is the direction vector to update with the result
  14038. * @param particle is the particle we are computed the direction for
  14039. * @param isLocal defines if the direction should be set in local space
  14040. */
  14041. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14042. /**
  14043. * Called by the particle System when the position is computed for the created particle.
  14044. * @param worldMatrix is the world matrix of the particle system
  14045. * @param positionToUpdate is the position vector to update with the result
  14046. * @param particle is the particle we are computed the position for
  14047. * @param isLocal defines if the position should be set in local space
  14048. */
  14049. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14050. /**
  14051. * Clones the current emitter and returns a copy of it
  14052. * @returns the new emitter
  14053. */
  14054. clone(): PointParticleEmitter;
  14055. /**
  14056. * Called by the GPUParticleSystem to setup the update shader
  14057. * @param effect defines the update shader
  14058. */
  14059. applyToShader(effect: Effect): void;
  14060. /**
  14061. * Returns a string to use to update the GPU particles update shader
  14062. * @returns a string containng the defines string
  14063. */
  14064. getEffectDefines(): string;
  14065. /**
  14066. * Returns the string "PointParticleEmitter"
  14067. * @returns a string containing the class name
  14068. */
  14069. getClassName(): string;
  14070. /**
  14071. * Serializes the particle system to a JSON object.
  14072. * @returns the JSON object
  14073. */
  14074. serialize(): any;
  14075. /**
  14076. * Parse properties from a JSON object
  14077. * @param serializationObject defines the JSON object
  14078. */
  14079. parse(serializationObject: any): void;
  14080. }
  14081. }
  14082. declare module "babylonjs/Particles/EmitterTypes/sphereParticleEmitter" {
  14083. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14084. import { Effect } from "babylonjs/Materials/effect";
  14085. import { Particle } from "babylonjs/Particles/particle";
  14086. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14087. /**
  14088. * Particle emitter emitting particles from the inside of a sphere.
  14089. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  14090. */
  14091. export class SphereParticleEmitter implements IParticleEmitterType {
  14092. /**
  14093. * The radius of the emission sphere.
  14094. */
  14095. radius: number;
  14096. /**
  14097. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  14098. */
  14099. radiusRange: number;
  14100. /**
  14101. * How much to randomize the particle direction [0-1].
  14102. */
  14103. directionRandomizer: number;
  14104. /**
  14105. * Creates a new instance SphereParticleEmitter
  14106. * @param radius the radius of the emission sphere (1 by default)
  14107. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  14108. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  14109. */
  14110. constructor(
  14111. /**
  14112. * The radius of the emission sphere.
  14113. */
  14114. radius?: number,
  14115. /**
  14116. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  14117. */
  14118. radiusRange?: number,
  14119. /**
  14120. * How much to randomize the particle direction [0-1].
  14121. */
  14122. directionRandomizer?: number);
  14123. /**
  14124. * Called by the particle System when the direction is computed for the created particle.
  14125. * @param worldMatrix is the world matrix of the particle system
  14126. * @param directionToUpdate is the direction vector to update with the result
  14127. * @param particle is the particle we are computed the direction for
  14128. * @param isLocal defines if the direction should be set in local space
  14129. */
  14130. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14131. /**
  14132. * Called by the particle System when the position is computed for the created particle.
  14133. * @param worldMatrix is the world matrix of the particle system
  14134. * @param positionToUpdate is the position vector to update with the result
  14135. * @param particle is the particle we are computed the position for
  14136. * @param isLocal defines if the position should be set in local space
  14137. */
  14138. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14139. /**
  14140. * Clones the current emitter and returns a copy of it
  14141. * @returns the new emitter
  14142. */
  14143. clone(): SphereParticleEmitter;
  14144. /**
  14145. * Called by the GPUParticleSystem to setup the update shader
  14146. * @param effect defines the update shader
  14147. */
  14148. applyToShader(effect: Effect): void;
  14149. /**
  14150. * Returns a string to use to update the GPU particles update shader
  14151. * @returns a string containng the defines string
  14152. */
  14153. getEffectDefines(): string;
  14154. /**
  14155. * Returns the string "SphereParticleEmitter"
  14156. * @returns a string containing the class name
  14157. */
  14158. getClassName(): string;
  14159. /**
  14160. * Serializes the particle system to a JSON object.
  14161. * @returns the JSON object
  14162. */
  14163. serialize(): any;
  14164. /**
  14165. * Parse properties from a JSON object
  14166. * @param serializationObject defines the JSON object
  14167. */
  14168. parse(serializationObject: any): void;
  14169. }
  14170. /**
  14171. * Particle emitter emitting particles from the inside of a sphere.
  14172. * It emits the particles randomly between two vectors.
  14173. */
  14174. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  14175. /**
  14176. * The min limit of the emission direction.
  14177. */
  14178. direction1: Vector3;
  14179. /**
  14180. * The max limit of the emission direction.
  14181. */
  14182. direction2: Vector3;
  14183. /**
  14184. * Creates a new instance SphereDirectedParticleEmitter
  14185. * @param radius the radius of the emission sphere (1 by default)
  14186. * @param direction1 the min limit of the emission direction (up vector by default)
  14187. * @param direction2 the max limit of the emission direction (up vector by default)
  14188. */
  14189. constructor(radius?: number,
  14190. /**
  14191. * The min limit of the emission direction.
  14192. */
  14193. direction1?: Vector3,
  14194. /**
  14195. * The max limit of the emission direction.
  14196. */
  14197. direction2?: Vector3);
  14198. /**
  14199. * Called by the particle System when the direction is computed for the created particle.
  14200. * @param worldMatrix is the world matrix of the particle system
  14201. * @param directionToUpdate is the direction vector to update with the result
  14202. * @param particle is the particle we are computed the direction for
  14203. */
  14204. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  14205. /**
  14206. * Clones the current emitter and returns a copy of it
  14207. * @returns the new emitter
  14208. */
  14209. clone(): SphereDirectedParticleEmitter;
  14210. /**
  14211. * Called by the GPUParticleSystem to setup the update shader
  14212. * @param effect defines the update shader
  14213. */
  14214. applyToShader(effect: Effect): void;
  14215. /**
  14216. * Returns a string to use to update the GPU particles update shader
  14217. * @returns a string containng the defines string
  14218. */
  14219. getEffectDefines(): string;
  14220. /**
  14221. * Returns the string "SphereDirectedParticleEmitter"
  14222. * @returns a string containing the class name
  14223. */
  14224. getClassName(): string;
  14225. /**
  14226. * Serializes the particle system to a JSON object.
  14227. * @returns the JSON object
  14228. */
  14229. serialize(): any;
  14230. /**
  14231. * Parse properties from a JSON object
  14232. * @param serializationObject defines the JSON object
  14233. */
  14234. parse(serializationObject: any): void;
  14235. }
  14236. }
  14237. declare module "babylonjs/Particles/EmitterTypes/customParticleEmitter" {
  14238. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14239. import { Effect } from "babylonjs/Materials/effect";
  14240. import { Particle } from "babylonjs/Particles/particle";
  14241. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14242. import { Nullable } from "babylonjs/types";
  14243. /**
  14244. * Particle emitter emitting particles from a custom list of positions.
  14245. */
  14246. export class CustomParticleEmitter implements IParticleEmitterType {
  14247. /**
  14248. * Gets or sets the position generator that will create the inital position of each particle.
  14249. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  14250. */
  14251. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  14252. /**
  14253. * Gets or sets the destination generator that will create the final destination of each particle.
  14254. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  14255. */
  14256. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  14257. /**
  14258. * Creates a new instance CustomParticleEmitter
  14259. */
  14260. constructor();
  14261. /**
  14262. * Called by the particle System when the direction is computed for the created particle.
  14263. * @param worldMatrix is the world matrix of the particle system
  14264. * @param directionToUpdate is the direction vector to update with the result
  14265. * @param particle is the particle we are computed the direction for
  14266. * @param isLocal defines if the direction should be set in local space
  14267. */
  14268. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14269. /**
  14270. * Called by the particle System when the position is computed for the created particle.
  14271. * @param worldMatrix is the world matrix of the particle system
  14272. * @param positionToUpdate is the position vector to update with the result
  14273. * @param particle is the particle we are computed the position for
  14274. * @param isLocal defines if the position should be set in local space
  14275. */
  14276. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14277. /**
  14278. * Clones the current emitter and returns a copy of it
  14279. * @returns the new emitter
  14280. */
  14281. clone(): CustomParticleEmitter;
  14282. /**
  14283. * Called by the GPUParticleSystem to setup the update shader
  14284. * @param effect defines the update shader
  14285. */
  14286. applyToShader(effect: Effect): void;
  14287. /**
  14288. * Returns a string to use to update the GPU particles update shader
  14289. * @returns a string containng the defines string
  14290. */
  14291. getEffectDefines(): string;
  14292. /**
  14293. * Returns the string "PointParticleEmitter"
  14294. * @returns a string containing the class name
  14295. */
  14296. getClassName(): string;
  14297. /**
  14298. * Serializes the particle system to a JSON object.
  14299. * @returns the JSON object
  14300. */
  14301. serialize(): any;
  14302. /**
  14303. * Parse properties from a JSON object
  14304. * @param serializationObject defines the JSON object
  14305. */
  14306. parse(serializationObject: any): void;
  14307. }
  14308. }
  14309. declare module "babylonjs/Particles/EmitterTypes/meshParticleEmitter" {
  14310. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14311. import { Effect } from "babylonjs/Materials/effect";
  14312. import { Particle } from "babylonjs/Particles/particle";
  14313. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14314. import { Nullable } from "babylonjs/types";
  14315. import { Scene } from "babylonjs/scene";
  14316. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14317. /**
  14318. * Particle emitter emitting particles from the inside of a box.
  14319. * It emits the particles randomly between 2 given directions.
  14320. */
  14321. export class MeshParticleEmitter implements IParticleEmitterType {
  14322. private _indices;
  14323. private _positions;
  14324. private _normals;
  14325. private _storedNormal;
  14326. private _mesh;
  14327. /**
  14328. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14329. */
  14330. direction1: Vector3;
  14331. /**
  14332. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14333. */
  14334. direction2: Vector3;
  14335. /**
  14336. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  14337. */
  14338. useMeshNormalsForDirection: boolean;
  14339. /** Defines the mesh to use as source */
  14340. get mesh(): Nullable<AbstractMesh>;
  14341. set mesh(value: Nullable<AbstractMesh>);
  14342. /**
  14343. * Creates a new instance MeshParticleEmitter
  14344. * @param mesh defines the mesh to use as source
  14345. */
  14346. constructor(mesh?: Nullable<AbstractMesh>);
  14347. /**
  14348. * Called by the particle System when the direction is computed for the created particle.
  14349. * @param worldMatrix is the world matrix of the particle system
  14350. * @param directionToUpdate is the direction vector to update with the result
  14351. * @param particle is the particle we are computed the direction for
  14352. * @param isLocal defines if the direction should be set in local space
  14353. */
  14354. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14355. /**
  14356. * Called by the particle System when the position is computed for the created particle.
  14357. * @param worldMatrix is the world matrix of the particle system
  14358. * @param positionToUpdate is the position vector to update with the result
  14359. * @param particle is the particle we are computed the position for
  14360. * @param isLocal defines if the position should be set in local space
  14361. */
  14362. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14363. /**
  14364. * Clones the current emitter and returns a copy of it
  14365. * @returns the new emitter
  14366. */
  14367. clone(): MeshParticleEmitter;
  14368. /**
  14369. * Called by the GPUParticleSystem to setup the update shader
  14370. * @param effect defines the update shader
  14371. */
  14372. applyToShader(effect: Effect): void;
  14373. /**
  14374. * Returns a string to use to update the GPU particles update shader
  14375. * @returns a string containng the defines string
  14376. */
  14377. getEffectDefines(): string;
  14378. /**
  14379. * Returns the string "BoxParticleEmitter"
  14380. * @returns a string containing the class name
  14381. */
  14382. getClassName(): string;
  14383. /**
  14384. * Serializes the particle system to a JSON object.
  14385. * @returns the JSON object
  14386. */
  14387. serialize(): any;
  14388. /**
  14389. * Parse properties from a JSON object
  14390. * @param serializationObject defines the JSON object
  14391. * @param scene defines the hosting scene
  14392. */
  14393. parse(serializationObject: any, scene: Nullable<Scene>): void;
  14394. }
  14395. }
  14396. declare module "babylonjs/Particles/EmitterTypes/index" {
  14397. export * from "babylonjs/Particles/EmitterTypes/boxParticleEmitter";
  14398. export * from "babylonjs/Particles/EmitterTypes/coneParticleEmitter";
  14399. export * from "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter";
  14400. export * from "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter";
  14401. export * from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14402. export * from "babylonjs/Particles/EmitterTypes/pointParticleEmitter";
  14403. export * from "babylonjs/Particles/EmitterTypes/sphereParticleEmitter";
  14404. export * from "babylonjs/Particles/EmitterTypes/customParticleEmitter";
  14405. export * from "babylonjs/Particles/EmitterTypes/meshParticleEmitter";
  14406. }
  14407. declare module "babylonjs/Particles/IParticleSystem" {
  14408. import { Nullable } from "babylonjs/types";
  14409. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14410. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  14411. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  14412. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  14413. import { Scene } from "babylonjs/scene";
  14414. import { ColorGradient, FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  14415. import { Effect } from "babylonjs/Materials/effect";
  14416. import { Observable } from "babylonjs/Misc/observable";
  14417. import { Animation } from "babylonjs/Animations/animation";
  14418. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14419. /**
  14420. * Interface representing a particle system in Babylon.js.
  14421. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  14422. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  14423. */
  14424. export interface IParticleSystem {
  14425. /**
  14426. * List of animations used by the particle system.
  14427. */
  14428. animations: Animation[];
  14429. /**
  14430. * The id of the Particle system.
  14431. */
  14432. id: string;
  14433. /**
  14434. * The name of the Particle system.
  14435. */
  14436. name: string;
  14437. /**
  14438. * The emitter represents the Mesh or position we are attaching the particle system to.
  14439. */
  14440. emitter: Nullable<AbstractMesh | Vector3>;
  14441. /**
  14442. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  14443. */
  14444. isBillboardBased: boolean;
  14445. /**
  14446. * The rendering group used by the Particle system to chose when to render.
  14447. */
  14448. renderingGroupId: number;
  14449. /**
  14450. * The layer mask we are rendering the particles through.
  14451. */
  14452. layerMask: number;
  14453. /**
  14454. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  14455. */
  14456. updateSpeed: number;
  14457. /**
  14458. * The amount of time the particle system is running (depends of the overall update speed).
  14459. */
  14460. targetStopDuration: number;
  14461. /**
  14462. * The texture used to render each particle. (this can be a spritesheet)
  14463. */
  14464. particleTexture: Nullable<BaseTexture>;
  14465. /**
  14466. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  14467. */
  14468. blendMode: number;
  14469. /**
  14470. * Minimum life time of emitting particles.
  14471. */
  14472. minLifeTime: number;
  14473. /**
  14474. * Maximum life time of emitting particles.
  14475. */
  14476. maxLifeTime: number;
  14477. /**
  14478. * Minimum Size of emitting particles.
  14479. */
  14480. minSize: number;
  14481. /**
  14482. * Maximum Size of emitting particles.
  14483. */
  14484. maxSize: number;
  14485. /**
  14486. * Minimum scale of emitting particles on X axis.
  14487. */
  14488. minScaleX: number;
  14489. /**
  14490. * Maximum scale of emitting particles on X axis.
  14491. */
  14492. maxScaleX: number;
  14493. /**
  14494. * Minimum scale of emitting particles on Y axis.
  14495. */
  14496. minScaleY: number;
  14497. /**
  14498. * Maximum scale of emitting particles on Y axis.
  14499. */
  14500. maxScaleY: number;
  14501. /**
  14502. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14503. */
  14504. color1: Color4;
  14505. /**
  14506. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14507. */
  14508. color2: Color4;
  14509. /**
  14510. * Color the particle will have at the end of its lifetime.
  14511. */
  14512. colorDead: Color4;
  14513. /**
  14514. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  14515. */
  14516. emitRate: number;
  14517. /**
  14518. * You can use gravity if you want to give an orientation to your particles.
  14519. */
  14520. gravity: Vector3;
  14521. /**
  14522. * Minimum power of emitting particles.
  14523. */
  14524. minEmitPower: number;
  14525. /**
  14526. * Maximum power of emitting particles.
  14527. */
  14528. maxEmitPower: number;
  14529. /**
  14530. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  14531. */
  14532. minAngularSpeed: number;
  14533. /**
  14534. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  14535. */
  14536. maxAngularSpeed: number;
  14537. /**
  14538. * Gets or sets the minimal initial rotation in radians.
  14539. */
  14540. minInitialRotation: number;
  14541. /**
  14542. * Gets or sets the maximal initial rotation in radians.
  14543. */
  14544. maxInitialRotation: number;
  14545. /**
  14546. * The particle emitter type defines the emitter used by the particle system.
  14547. * It can be for example box, sphere, or cone...
  14548. */
  14549. particleEmitterType: Nullable<IParticleEmitterType>;
  14550. /**
  14551. * Defines the delay in milliseconds before starting the system (0 by default)
  14552. */
  14553. startDelay: number;
  14554. /**
  14555. * 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
  14556. */
  14557. preWarmCycles: number;
  14558. /**
  14559. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  14560. */
  14561. preWarmStepOffset: number;
  14562. /**
  14563. * 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)
  14564. */
  14565. spriteCellChangeSpeed: number;
  14566. /**
  14567. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  14568. */
  14569. startSpriteCellID: number;
  14570. /**
  14571. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  14572. */
  14573. endSpriteCellID: number;
  14574. /**
  14575. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  14576. */
  14577. spriteCellWidth: number;
  14578. /**
  14579. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  14580. */
  14581. spriteCellHeight: number;
  14582. /**
  14583. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  14584. */
  14585. spriteRandomStartCell: boolean;
  14586. /**
  14587. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  14588. */
  14589. isAnimationSheetEnabled: boolean;
  14590. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  14591. translationPivot: Vector2;
  14592. /**
  14593. * Gets or sets a texture used to add random noise to particle positions
  14594. */
  14595. noiseTexture: Nullable<BaseTexture>;
  14596. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  14597. noiseStrength: Vector3;
  14598. /**
  14599. * Gets or sets the billboard mode to use when isBillboardBased = true.
  14600. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  14601. */
  14602. billboardMode: number;
  14603. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  14604. limitVelocityDamping: number;
  14605. /**
  14606. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  14607. */
  14608. beginAnimationOnStart: boolean;
  14609. /**
  14610. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  14611. */
  14612. beginAnimationFrom: number;
  14613. /**
  14614. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  14615. */
  14616. beginAnimationTo: number;
  14617. /**
  14618. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  14619. */
  14620. beginAnimationLoop: boolean;
  14621. /**
  14622. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  14623. */
  14624. disposeOnStop: boolean;
  14625. /**
  14626. * Specifies if the particles are updated in emitter local space or world space
  14627. */
  14628. isLocal: boolean;
  14629. /** Snippet ID if the particle system was created from the snippet server */
  14630. snippetId: string;
  14631. /** Gets or sets a matrix to use to compute projection */
  14632. defaultProjectionMatrix: Matrix;
  14633. /**
  14634. * Gets the maximum number of particles active at the same time.
  14635. * @returns The max number of active particles.
  14636. */
  14637. getCapacity(): number;
  14638. /**
  14639. * Gets the number of particles active at the same time.
  14640. * @returns The number of active particles.
  14641. */
  14642. getActiveCount(): number;
  14643. /**
  14644. * Gets if the system has been started. (Note: this will still be true after stop is called)
  14645. * @returns True if it has been started, otherwise false.
  14646. */
  14647. isStarted(): boolean;
  14648. /**
  14649. * Animates the particle system for this frame.
  14650. */
  14651. animate(): void;
  14652. /**
  14653. * Renders the particle system in its current state.
  14654. * @returns the current number of particles
  14655. */
  14656. render(): number;
  14657. /**
  14658. * Dispose the particle system and frees its associated resources.
  14659. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  14660. */
  14661. dispose(disposeTexture?: boolean): void;
  14662. /**
  14663. * An event triggered when the system is disposed
  14664. */
  14665. onDisposeObservable: Observable<IParticleSystem>;
  14666. /**
  14667. * Clones the particle system.
  14668. * @param name The name of the cloned object
  14669. * @param newEmitter The new emitter to use
  14670. * @returns the cloned particle system
  14671. */
  14672. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  14673. /**
  14674. * Serializes the particle system to a JSON object
  14675. * @param serializeTexture defines if the texture must be serialized as well
  14676. * @returns the JSON object
  14677. */
  14678. serialize(serializeTexture: boolean): any;
  14679. /**
  14680. * Rebuild the particle system
  14681. */
  14682. rebuild(): void;
  14683. /** Force the system to rebuild all gradients that need to be resync */
  14684. forceRefreshGradients(): void;
  14685. /**
  14686. * Starts the particle system and begins to emit
  14687. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  14688. */
  14689. start(delay?: number): void;
  14690. /**
  14691. * Stops the particle system.
  14692. */
  14693. stop(): void;
  14694. /**
  14695. * Remove all active particles
  14696. */
  14697. reset(): void;
  14698. /**
  14699. * Gets a boolean indicating that the system is stopping
  14700. * @returns true if the system is currently stopping
  14701. */
  14702. isStopping(): boolean;
  14703. /**
  14704. * Is this system ready to be used/rendered
  14705. * @return true if the system is ready
  14706. */
  14707. isReady(): boolean;
  14708. /**
  14709. * Returns the string "ParticleSystem"
  14710. * @returns a string containing the class name
  14711. */
  14712. getClassName(): string;
  14713. /**
  14714. * Gets the custom effect used to render the particles
  14715. * @param blendMode Blend mode for which the effect should be retrieved
  14716. * @returns The effect
  14717. */
  14718. getCustomEffect(blendMode: number): Nullable<Effect>;
  14719. /**
  14720. * Sets the custom effect used to render the particles
  14721. * @param effect The effect to set
  14722. * @param blendMode Blend mode for which the effect should be set
  14723. */
  14724. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  14725. /**
  14726. * Fill the defines array according to the current settings of the particle system
  14727. * @param defines Array to be updated
  14728. * @param blendMode blend mode to take into account when updating the array
  14729. */
  14730. fillDefines(defines: Array<string>, blendMode: number): void;
  14731. /**
  14732. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  14733. * @param uniforms Uniforms array to fill
  14734. * @param attributes Attributes array to fill
  14735. * @param samplers Samplers array to fill
  14736. */
  14737. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  14738. /**
  14739. * Observable that will be called just before the particles are drawn
  14740. */
  14741. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  14742. /**
  14743. * Gets the name of the particle vertex shader
  14744. */
  14745. vertexShaderName: string;
  14746. /**
  14747. * Adds a new color gradient
  14748. * @param gradient defines the gradient to use (between 0 and 1)
  14749. * @param color1 defines the color to affect to the specified gradient
  14750. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  14751. * @returns the current particle system
  14752. */
  14753. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  14754. /**
  14755. * Remove a specific color gradient
  14756. * @param gradient defines the gradient to remove
  14757. * @returns the current particle system
  14758. */
  14759. removeColorGradient(gradient: number): IParticleSystem;
  14760. /**
  14761. * Adds a new size gradient
  14762. * @param gradient defines the gradient to use (between 0 and 1)
  14763. * @param factor defines the size factor to affect to the specified gradient
  14764. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14765. * @returns the current particle system
  14766. */
  14767. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14768. /**
  14769. * Remove a specific size gradient
  14770. * @param gradient defines the gradient to remove
  14771. * @returns the current particle system
  14772. */
  14773. removeSizeGradient(gradient: number): IParticleSystem;
  14774. /**
  14775. * Gets the current list of color gradients.
  14776. * You must use addColorGradient and removeColorGradient to udpate this list
  14777. * @returns the list of color gradients
  14778. */
  14779. getColorGradients(): Nullable<Array<ColorGradient>>;
  14780. /**
  14781. * Gets the current list of size gradients.
  14782. * You must use addSizeGradient and removeSizeGradient to udpate this list
  14783. * @returns the list of size gradients
  14784. */
  14785. getSizeGradients(): Nullable<Array<FactorGradient>>;
  14786. /**
  14787. * Gets the current list of angular speed gradients.
  14788. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  14789. * @returns the list of angular speed gradients
  14790. */
  14791. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  14792. /**
  14793. * Adds a new angular speed gradient
  14794. * @param gradient defines the gradient to use (between 0 and 1)
  14795. * @param factor defines the angular speed to affect to the specified gradient
  14796. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14797. * @returns the current particle system
  14798. */
  14799. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14800. /**
  14801. * Remove a specific angular speed gradient
  14802. * @param gradient defines the gradient to remove
  14803. * @returns the current particle system
  14804. */
  14805. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  14806. /**
  14807. * Gets the current list of velocity gradients.
  14808. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  14809. * @returns the list of velocity gradients
  14810. */
  14811. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  14812. /**
  14813. * Adds a new velocity gradient
  14814. * @param gradient defines the gradient to use (between 0 and 1)
  14815. * @param factor defines the velocity to affect to the specified gradient
  14816. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14817. * @returns the current particle system
  14818. */
  14819. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14820. /**
  14821. * Remove a specific velocity gradient
  14822. * @param gradient defines the gradient to remove
  14823. * @returns the current particle system
  14824. */
  14825. removeVelocityGradient(gradient: number): IParticleSystem;
  14826. /**
  14827. * Gets the current list of limit velocity gradients.
  14828. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  14829. * @returns the list of limit velocity gradients
  14830. */
  14831. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  14832. /**
  14833. * Adds a new limit velocity gradient
  14834. * @param gradient defines the gradient to use (between 0 and 1)
  14835. * @param factor defines the limit velocity to affect to the specified gradient
  14836. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14837. * @returns the current particle system
  14838. */
  14839. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14840. /**
  14841. * Remove a specific limit velocity gradient
  14842. * @param gradient defines the gradient to remove
  14843. * @returns the current particle system
  14844. */
  14845. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  14846. /**
  14847. * Adds a new drag gradient
  14848. * @param gradient defines the gradient to use (between 0 and 1)
  14849. * @param factor defines the drag to affect to the specified gradient
  14850. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14851. * @returns the current particle system
  14852. */
  14853. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14854. /**
  14855. * Remove a specific drag gradient
  14856. * @param gradient defines the gradient to remove
  14857. * @returns the current particle system
  14858. */
  14859. removeDragGradient(gradient: number): IParticleSystem;
  14860. /**
  14861. * Gets the current list of drag gradients.
  14862. * You must use addDragGradient and removeDragGradient to udpate this list
  14863. * @returns the list of drag gradients
  14864. */
  14865. getDragGradients(): Nullable<Array<FactorGradient>>;
  14866. /**
  14867. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  14868. * @param gradient defines the gradient to use (between 0 and 1)
  14869. * @param factor defines the emit rate to affect to the specified gradient
  14870. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14871. * @returns the current particle system
  14872. */
  14873. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14874. /**
  14875. * Remove a specific emit rate gradient
  14876. * @param gradient defines the gradient to remove
  14877. * @returns the current particle system
  14878. */
  14879. removeEmitRateGradient(gradient: number): IParticleSystem;
  14880. /**
  14881. * Gets the current list of emit rate gradients.
  14882. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  14883. * @returns the list of emit rate gradients
  14884. */
  14885. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  14886. /**
  14887. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  14888. * @param gradient defines the gradient to use (between 0 and 1)
  14889. * @param factor defines the start size to affect to the specified gradient
  14890. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14891. * @returns the current particle system
  14892. */
  14893. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14894. /**
  14895. * Remove a specific start size gradient
  14896. * @param gradient defines the gradient to remove
  14897. * @returns the current particle system
  14898. */
  14899. removeStartSizeGradient(gradient: number): IParticleSystem;
  14900. /**
  14901. * Gets the current list of start size gradients.
  14902. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  14903. * @returns the list of start size gradients
  14904. */
  14905. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  14906. /**
  14907. * Adds a new life time gradient
  14908. * @param gradient defines the gradient to use (between 0 and 1)
  14909. * @param factor defines the life time factor to affect to the specified gradient
  14910. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14911. * @returns the current particle system
  14912. */
  14913. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14914. /**
  14915. * Remove a specific life time gradient
  14916. * @param gradient defines the gradient to remove
  14917. * @returns the current particle system
  14918. */
  14919. removeLifeTimeGradient(gradient: number): IParticleSystem;
  14920. /**
  14921. * Gets the current list of life time gradients.
  14922. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  14923. * @returns the list of life time gradients
  14924. */
  14925. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  14926. /**
  14927. * Gets the current list of color gradients.
  14928. * You must use addColorGradient and removeColorGradient to udpate this list
  14929. * @returns the list of color gradients
  14930. */
  14931. getColorGradients(): Nullable<Array<ColorGradient>>;
  14932. /**
  14933. * Adds a new ramp gradient used to remap particle colors
  14934. * @param gradient defines the gradient to use (between 0 and 1)
  14935. * @param color defines the color to affect to the specified gradient
  14936. * @returns the current particle system
  14937. */
  14938. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  14939. /**
  14940. * Gets the current list of ramp gradients.
  14941. * You must use addRampGradient and removeRampGradient to udpate this list
  14942. * @returns the list of ramp gradients
  14943. */
  14944. getRampGradients(): Nullable<Array<Color3Gradient>>;
  14945. /** Gets or sets a boolean indicating that ramp gradients must be used
  14946. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  14947. */
  14948. useRampGradients: boolean;
  14949. /**
  14950. * Adds a new color remap gradient
  14951. * @param gradient defines the gradient to use (between 0 and 1)
  14952. * @param min defines the color remap minimal range
  14953. * @param max defines the color remap maximal range
  14954. * @returns the current particle system
  14955. */
  14956. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  14957. /**
  14958. * Gets the current list of color remap gradients.
  14959. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  14960. * @returns the list of color remap gradients
  14961. */
  14962. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  14963. /**
  14964. * Adds a new alpha remap gradient
  14965. * @param gradient defines the gradient to use (between 0 and 1)
  14966. * @param min defines the alpha remap minimal range
  14967. * @param max defines the alpha remap maximal range
  14968. * @returns the current particle system
  14969. */
  14970. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  14971. /**
  14972. * Gets the current list of alpha remap gradients.
  14973. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  14974. * @returns the list of alpha remap gradients
  14975. */
  14976. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  14977. /**
  14978. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  14979. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  14980. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  14981. * @returns the emitter
  14982. */
  14983. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  14984. /**
  14985. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  14986. * @param radius The radius of the hemisphere to emit from
  14987. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14988. * @returns the emitter
  14989. */
  14990. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  14991. /**
  14992. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  14993. * @param radius The radius of the sphere to emit from
  14994. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14995. * @returns the emitter
  14996. */
  14997. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  14998. /**
  14999. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  15000. * @param radius The radius of the sphere to emit from
  15001. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  15002. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  15003. * @returns the emitter
  15004. */
  15005. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  15006. /**
  15007. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  15008. * @param radius The radius of the emission cylinder
  15009. * @param height The height of the emission cylinder
  15010. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  15011. * @param directionRandomizer How much to randomize the particle direction [0-1]
  15012. * @returns the emitter
  15013. */
  15014. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  15015. /**
  15016. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  15017. * @param radius The radius of the cylinder to emit from
  15018. * @param height The height of the emission cylinder
  15019. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  15020. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  15021. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  15022. * @returns the emitter
  15023. */
  15024. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  15025. /**
  15026. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  15027. * @param radius The radius of the cone to emit from
  15028. * @param angle The base angle of the cone
  15029. * @returns the emitter
  15030. */
  15031. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  15032. /**
  15033. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  15034. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  15035. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  15036. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  15037. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  15038. * @returns the emitter
  15039. */
  15040. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  15041. /**
  15042. * Get hosting scene
  15043. * @returns the scene
  15044. */
  15045. getScene(): Nullable<Scene>;
  15046. }
  15047. }
  15048. declare module "babylonjs/Meshes/transformNode" {
  15049. import { DeepImmutable } from "babylonjs/types";
  15050. import { Observable } from "babylonjs/Misc/observable";
  15051. import { Nullable } from "babylonjs/types";
  15052. import { Camera } from "babylonjs/Cameras/camera";
  15053. import { Scene } from "babylonjs/scene";
  15054. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  15055. import { Node } from "babylonjs/node";
  15056. import { Bone } from "babylonjs/Bones/bone";
  15057. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  15058. import { Space } from "babylonjs/Maths/math.axis";
  15059. /**
  15060. * 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.
  15061. * @see https://doc.babylonjs.com/how_to/transformnode
  15062. */
  15063. export class TransformNode extends Node {
  15064. /**
  15065. * Object will not rotate to face the camera
  15066. */
  15067. static BILLBOARDMODE_NONE: number;
  15068. /**
  15069. * Object will rotate to face the camera but only on the x axis
  15070. */
  15071. static BILLBOARDMODE_X: number;
  15072. /**
  15073. * Object will rotate to face the camera but only on the y axis
  15074. */
  15075. static BILLBOARDMODE_Y: number;
  15076. /**
  15077. * Object will rotate to face the camera but only on the z axis
  15078. */
  15079. static BILLBOARDMODE_Z: number;
  15080. /**
  15081. * Object will rotate to face the camera
  15082. */
  15083. static BILLBOARDMODE_ALL: number;
  15084. /**
  15085. * Object will rotate to face the camera's position instead of orientation
  15086. */
  15087. static BILLBOARDMODE_USE_POSITION: number;
  15088. private static _TmpRotation;
  15089. private static _TmpScaling;
  15090. private static _TmpTranslation;
  15091. private _forward;
  15092. private _forwardInverted;
  15093. private _up;
  15094. private _right;
  15095. private _rightInverted;
  15096. private _position;
  15097. private _rotation;
  15098. private _rotationQuaternion;
  15099. protected _scaling: Vector3;
  15100. protected _isDirty: boolean;
  15101. private _transformToBoneReferal;
  15102. private _isAbsoluteSynced;
  15103. private _billboardMode;
  15104. /**
  15105. * Gets or sets the billboard mode. Default is 0.
  15106. *
  15107. * | Value | Type | Description |
  15108. * | --- | --- | --- |
  15109. * | 0 | BILLBOARDMODE_NONE | |
  15110. * | 1 | BILLBOARDMODE_X | |
  15111. * | 2 | BILLBOARDMODE_Y | |
  15112. * | 4 | BILLBOARDMODE_Z | |
  15113. * | 7 | BILLBOARDMODE_ALL | |
  15114. *
  15115. */
  15116. get billboardMode(): number;
  15117. set billboardMode(value: number);
  15118. private _preserveParentRotationForBillboard;
  15119. /**
  15120. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  15121. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  15122. */
  15123. get preserveParentRotationForBillboard(): boolean;
  15124. set preserveParentRotationForBillboard(value: boolean);
  15125. /**
  15126. * 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
  15127. */
  15128. scalingDeterminant: number;
  15129. private _infiniteDistance;
  15130. /**
  15131. * Gets or sets the distance of the object to max, often used by skybox
  15132. */
  15133. get infiniteDistance(): boolean;
  15134. set infiniteDistance(value: boolean);
  15135. /**
  15136. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  15137. * By default the system will update normals to compensate
  15138. */
  15139. ignoreNonUniformScaling: boolean;
  15140. /**
  15141. * 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
  15142. */
  15143. reIntegrateRotationIntoRotationQuaternion: boolean;
  15144. /** @hidden */
  15145. _poseMatrix: Nullable<Matrix>;
  15146. /** @hidden */
  15147. _localMatrix: Matrix;
  15148. private _usePivotMatrix;
  15149. private _absolutePosition;
  15150. private _absoluteScaling;
  15151. private _absoluteRotationQuaternion;
  15152. private _pivotMatrix;
  15153. private _pivotMatrixInverse;
  15154. /** @hidden */
  15155. _postMultiplyPivotMatrix: boolean;
  15156. protected _isWorldMatrixFrozen: boolean;
  15157. /** @hidden */
  15158. _indexInSceneTransformNodesArray: number;
  15159. /**
  15160. * An event triggered after the world matrix is updated
  15161. */
  15162. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  15163. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  15164. /**
  15165. * Gets a string identifying the name of the class
  15166. * @returns "TransformNode" string
  15167. */
  15168. getClassName(): string;
  15169. /**
  15170. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  15171. */
  15172. get position(): Vector3;
  15173. set position(newPosition: Vector3);
  15174. /**
  15175. * 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)).
  15176. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  15177. */
  15178. get rotation(): Vector3;
  15179. set rotation(newRotation: Vector3);
  15180. /**
  15181. * 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)).
  15182. */
  15183. get scaling(): Vector3;
  15184. set scaling(newScaling: Vector3);
  15185. /**
  15186. * 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).
  15187. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  15188. */
  15189. get rotationQuaternion(): Nullable<Quaternion>;
  15190. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  15191. /**
  15192. * The forward direction of that transform in world space.
  15193. */
  15194. get forward(): Vector3;
  15195. /**
  15196. * The up direction of that transform in world space.
  15197. */
  15198. get up(): Vector3;
  15199. /**
  15200. * The right direction of that transform in world space.
  15201. */
  15202. get right(): Vector3;
  15203. /**
  15204. * Copies the parameter passed Matrix into the mesh Pose matrix.
  15205. * @param matrix the matrix to copy the pose from
  15206. * @returns this TransformNode.
  15207. */
  15208. updatePoseMatrix(matrix: Matrix): TransformNode;
  15209. /**
  15210. * Returns the mesh Pose matrix.
  15211. * @returns the pose matrix
  15212. */
  15213. getPoseMatrix(): Matrix;
  15214. /** @hidden */
  15215. _isSynchronized(): boolean;
  15216. /** @hidden */
  15217. _initCache(): void;
  15218. /**
  15219. * Flag the transform node as dirty (Forcing it to update everything)
  15220. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  15221. * @returns this transform node
  15222. */
  15223. markAsDirty(property: string): TransformNode;
  15224. /**
  15225. * Returns the current mesh absolute position.
  15226. * Returns a Vector3.
  15227. */
  15228. get absolutePosition(): Vector3;
  15229. /**
  15230. * Returns the current mesh absolute scaling.
  15231. * Returns a Vector3.
  15232. */
  15233. get absoluteScaling(): Vector3;
  15234. /**
  15235. * Returns the current mesh absolute rotation.
  15236. * Returns a Quaternion.
  15237. */
  15238. get absoluteRotationQuaternion(): Quaternion;
  15239. /**
  15240. * Sets a new matrix to apply before all other transformation
  15241. * @param matrix defines the transform matrix
  15242. * @returns the current TransformNode
  15243. */
  15244. setPreTransformMatrix(matrix: Matrix): TransformNode;
  15245. /**
  15246. * Sets a new pivot matrix to the current node
  15247. * @param matrix defines the new pivot matrix to use
  15248. * @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
  15249. * @returns the current TransformNode
  15250. */
  15251. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  15252. /**
  15253. * Returns the mesh pivot matrix.
  15254. * Default : Identity.
  15255. * @returns the matrix
  15256. */
  15257. getPivotMatrix(): Matrix;
  15258. /**
  15259. * Instantiate (when possible) or clone that node with its hierarchy
  15260. * @param newParent defines the new parent to use for the instance (or clone)
  15261. * @param options defines options to configure how copy is done
  15262. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  15263. * @returns an instance (or a clone) of the current node with its hiearchy
  15264. */
  15265. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  15266. doNotInstantiate: boolean;
  15267. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  15268. /**
  15269. * Prevents the World matrix to be computed any longer
  15270. * @param newWorldMatrix defines an optional matrix to use as world matrix
  15271. * @returns the TransformNode.
  15272. */
  15273. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  15274. /**
  15275. * Allows back the World matrix computation.
  15276. * @returns the TransformNode.
  15277. */
  15278. unfreezeWorldMatrix(): this;
  15279. /**
  15280. * True if the World matrix has been frozen.
  15281. */
  15282. get isWorldMatrixFrozen(): boolean;
  15283. /**
  15284. * Retuns the mesh absolute position in the World.
  15285. * @returns a Vector3.
  15286. */
  15287. getAbsolutePosition(): Vector3;
  15288. /**
  15289. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  15290. * @param absolutePosition the absolute position to set
  15291. * @returns the TransformNode.
  15292. */
  15293. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  15294. /**
  15295. * Sets the mesh position in its local space.
  15296. * @param vector3 the position to set in localspace
  15297. * @returns the TransformNode.
  15298. */
  15299. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  15300. /**
  15301. * Returns the mesh position in the local space from the current World matrix values.
  15302. * @returns a new Vector3.
  15303. */
  15304. getPositionExpressedInLocalSpace(): Vector3;
  15305. /**
  15306. * Translates the mesh along the passed Vector3 in its local space.
  15307. * @param vector3 the distance to translate in localspace
  15308. * @returns the TransformNode.
  15309. */
  15310. locallyTranslate(vector3: Vector3): TransformNode;
  15311. private static _lookAtVectorCache;
  15312. /**
  15313. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  15314. * @param targetPoint the position (must be in same space as current mesh) to look at
  15315. * @param yawCor optional yaw (y-axis) correction in radians
  15316. * @param pitchCor optional pitch (x-axis) correction in radians
  15317. * @param rollCor optional roll (z-axis) correction in radians
  15318. * @param space the choosen space of the target
  15319. * @returns the TransformNode.
  15320. */
  15321. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  15322. /**
  15323. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15324. * This Vector3 is expressed in the World space.
  15325. * @param localAxis axis to rotate
  15326. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15327. */
  15328. getDirection(localAxis: Vector3): Vector3;
  15329. /**
  15330. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  15331. * localAxis is expressed in the mesh local space.
  15332. * result is computed in the Wordl space from the mesh World matrix.
  15333. * @param localAxis axis to rotate
  15334. * @param result the resulting transformnode
  15335. * @returns this TransformNode.
  15336. */
  15337. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  15338. /**
  15339. * Sets this transform node rotation to the given local axis.
  15340. * @param localAxis the axis in local space
  15341. * @param yawCor optional yaw (y-axis) correction in radians
  15342. * @param pitchCor optional pitch (x-axis) correction in radians
  15343. * @param rollCor optional roll (z-axis) correction in radians
  15344. * @returns this TransformNode
  15345. */
  15346. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  15347. /**
  15348. * Sets a new pivot point to the current node
  15349. * @param point defines the new pivot point to use
  15350. * @param space defines if the point is in world or local space (local by default)
  15351. * @returns the current TransformNode
  15352. */
  15353. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  15354. /**
  15355. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  15356. * @returns the pivot point
  15357. */
  15358. getPivotPoint(): Vector3;
  15359. /**
  15360. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  15361. * @param result the vector3 to store the result
  15362. * @returns this TransformNode.
  15363. */
  15364. getPivotPointToRef(result: Vector3): TransformNode;
  15365. /**
  15366. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  15367. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  15368. */
  15369. getAbsolutePivotPoint(): Vector3;
  15370. /**
  15371. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  15372. * @param result vector3 to store the result
  15373. * @returns this TransformNode.
  15374. */
  15375. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  15376. /**
  15377. * Defines the passed node as the parent of the current node.
  15378. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  15379. * @see https://doc.babylonjs.com/how_to/parenting
  15380. * @param node the node ot set as the parent
  15381. * @returns this TransformNode.
  15382. */
  15383. setParent(node: Nullable<Node>): TransformNode;
  15384. private _nonUniformScaling;
  15385. /**
  15386. * True if the scaling property of this object is non uniform eg. (1,2,1)
  15387. */
  15388. get nonUniformScaling(): boolean;
  15389. /** @hidden */
  15390. _updateNonUniformScalingState(value: boolean): boolean;
  15391. /**
  15392. * Attach the current TransformNode to another TransformNode associated with a bone
  15393. * @param bone Bone affecting the TransformNode
  15394. * @param affectedTransformNode TransformNode associated with the bone
  15395. * @returns this object
  15396. */
  15397. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  15398. /**
  15399. * Detach the transform node if its associated with a bone
  15400. * @returns this object
  15401. */
  15402. detachFromBone(): TransformNode;
  15403. private static _rotationAxisCache;
  15404. /**
  15405. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  15406. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15407. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15408. * The passed axis is also normalized.
  15409. * @param axis the axis to rotate around
  15410. * @param amount the amount to rotate in radians
  15411. * @param space Space to rotate in (Default: local)
  15412. * @returns the TransformNode.
  15413. */
  15414. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  15415. /**
  15416. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  15417. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15418. * The passed axis is also normalized. .
  15419. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  15420. * @param point the point to rotate around
  15421. * @param axis the axis to rotate around
  15422. * @param amount the amount to rotate in radians
  15423. * @returns the TransformNode
  15424. */
  15425. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  15426. /**
  15427. * Translates the mesh along the axis vector for the passed distance in the given space.
  15428. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15429. * @param axis the axis to translate in
  15430. * @param distance the distance to translate
  15431. * @param space Space to rotate in (Default: local)
  15432. * @returns the TransformNode.
  15433. */
  15434. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  15435. /**
  15436. * Adds a rotation step to the mesh current rotation.
  15437. * x, y, z are Euler angles expressed in radians.
  15438. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  15439. * This means this rotation is made in the mesh local space only.
  15440. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  15441. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  15442. * ```javascript
  15443. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  15444. * ```
  15445. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  15446. * 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.
  15447. * @param x Rotation to add
  15448. * @param y Rotation to add
  15449. * @param z Rotation to add
  15450. * @returns the TransformNode.
  15451. */
  15452. addRotation(x: number, y: number, z: number): TransformNode;
  15453. /**
  15454. * @hidden
  15455. */
  15456. protected _getEffectiveParent(): Nullable<Node>;
  15457. /**
  15458. * Computes the world matrix of the node
  15459. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  15460. * @returns the world matrix
  15461. */
  15462. computeWorldMatrix(force?: boolean): Matrix;
  15463. /**
  15464. * Resets this nodeTransform's local matrix to Matrix.Identity().
  15465. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  15466. */
  15467. resetLocalMatrix(independentOfChildren?: boolean): void;
  15468. protected _afterComputeWorldMatrix(): void;
  15469. /**
  15470. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  15471. * @param func callback function to add
  15472. *
  15473. * @returns the TransformNode.
  15474. */
  15475. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15476. /**
  15477. * Removes a registered callback function.
  15478. * @param func callback function to remove
  15479. * @returns the TransformNode.
  15480. */
  15481. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15482. /**
  15483. * Gets the position of the current mesh in camera space
  15484. * @param camera defines the camera to use
  15485. * @returns a position
  15486. */
  15487. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  15488. /**
  15489. * Returns the distance from the mesh to the active camera
  15490. * @param camera defines the camera to use
  15491. * @returns the distance
  15492. */
  15493. getDistanceToCamera(camera?: Nullable<Camera>): number;
  15494. /**
  15495. * Clone the current transform node
  15496. * @param name Name of the new clone
  15497. * @param newParent New parent for the clone
  15498. * @param doNotCloneChildren Do not clone children hierarchy
  15499. * @returns the new transform node
  15500. */
  15501. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  15502. /**
  15503. * Serializes the objects information.
  15504. * @param currentSerializationObject defines the object to serialize in
  15505. * @returns the serialized object
  15506. */
  15507. serialize(currentSerializationObject?: any): any;
  15508. /**
  15509. * Returns a new TransformNode object parsed from the source provided.
  15510. * @param parsedTransformNode is the source.
  15511. * @param scene the scne the object belongs to
  15512. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  15513. * @returns a new TransformNode object parsed from the source provided.
  15514. */
  15515. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  15516. /**
  15517. * Get all child-transformNodes of this node
  15518. * @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
  15519. * @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
  15520. * @returns an array of TransformNode
  15521. */
  15522. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  15523. /**
  15524. * Releases resources associated with this transform node.
  15525. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  15526. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  15527. */
  15528. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  15529. /**
  15530. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  15531. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  15532. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  15533. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  15534. * @returns the current mesh
  15535. */
  15536. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  15537. private _syncAbsoluteScalingAndRotation;
  15538. }
  15539. }
  15540. declare module "babylonjs/Animations/animationPropertiesOverride" {
  15541. /**
  15542. * Class used to override all child animations of a given target
  15543. */
  15544. export class AnimationPropertiesOverride {
  15545. /**
  15546. * Gets or sets a value indicating if animation blending must be used
  15547. */
  15548. enableBlending: boolean;
  15549. /**
  15550. * Gets or sets the blending speed to use when enableBlending is true
  15551. */
  15552. blendingSpeed: number;
  15553. /**
  15554. * Gets or sets the default loop mode to use
  15555. */
  15556. loopMode: number;
  15557. }
  15558. }
  15559. declare module "babylonjs/Bones/bone" {
  15560. import { Skeleton } from "babylonjs/Bones/skeleton";
  15561. import { Vector3, Quaternion, Matrix } from "babylonjs/Maths/math.vector";
  15562. import { Nullable } from "babylonjs/types";
  15563. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  15564. import { TransformNode } from "babylonjs/Meshes/transformNode";
  15565. import { Node } from "babylonjs/node";
  15566. import { Space } from "babylonjs/Maths/math.axis";
  15567. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  15568. /**
  15569. * Class used to store bone information
  15570. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  15571. */
  15572. export class Bone extends Node {
  15573. /**
  15574. * defines the bone name
  15575. */
  15576. name: string;
  15577. private static _tmpVecs;
  15578. private static _tmpQuat;
  15579. private static _tmpMats;
  15580. /**
  15581. * Gets the list of child bones
  15582. */
  15583. children: Bone[];
  15584. /** Gets the animations associated with this bone */
  15585. animations: import("babylonjs/Animations/animation").Animation[];
  15586. /**
  15587. * Gets or sets bone length
  15588. */
  15589. length: number;
  15590. /**
  15591. * @hidden Internal only
  15592. * Set this value to map this bone to a different index in the transform matrices
  15593. * Set this value to -1 to exclude the bone from the transform matrices
  15594. */
  15595. _index: Nullable<number>;
  15596. private _skeleton;
  15597. private _localMatrix;
  15598. private _restPose;
  15599. private _bindPose;
  15600. private _baseMatrix;
  15601. private _absoluteTransform;
  15602. private _invertedAbsoluteTransform;
  15603. private _parent;
  15604. private _scalingDeterminant;
  15605. private _worldTransform;
  15606. private _localScaling;
  15607. private _localRotation;
  15608. private _localPosition;
  15609. private _needToDecompose;
  15610. private _needToCompose;
  15611. /** @hidden */
  15612. _linkedTransformNode: Nullable<TransformNode>;
  15613. /** @hidden */
  15614. _waitingTransformNodeId: Nullable<string>;
  15615. /** @hidden */
  15616. get _matrix(): Matrix;
  15617. /** @hidden */
  15618. set _matrix(value: Matrix);
  15619. /**
  15620. * Create a new bone
  15621. * @param name defines the bone name
  15622. * @param skeleton defines the parent skeleton
  15623. * @param parentBone defines the parent (can be null if the bone is the root)
  15624. * @param localMatrix defines the local matrix
  15625. * @param restPose defines the rest pose matrix
  15626. * @param baseMatrix defines the base matrix
  15627. * @param index defines index of the bone in the hiearchy
  15628. */
  15629. constructor(
  15630. /**
  15631. * defines the bone name
  15632. */
  15633. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  15634. /**
  15635. * Gets the current object class name.
  15636. * @return the class name
  15637. */
  15638. getClassName(): string;
  15639. /**
  15640. * Gets the parent skeleton
  15641. * @returns a skeleton
  15642. */
  15643. getSkeleton(): Skeleton;
  15644. /**
  15645. * Gets parent bone
  15646. * @returns a bone or null if the bone is the root of the bone hierarchy
  15647. */
  15648. getParent(): Nullable<Bone>;
  15649. /**
  15650. * Returns an array containing the root bones
  15651. * @returns an array containing the root bones
  15652. */
  15653. getChildren(): Array<Bone>;
  15654. /**
  15655. * Gets the node index in matrix array generated for rendering
  15656. * @returns the node index
  15657. */
  15658. getIndex(): number;
  15659. /**
  15660. * Sets the parent bone
  15661. * @param parent defines the parent (can be null if the bone is the root)
  15662. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15663. */
  15664. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  15665. /**
  15666. * Gets the local matrix
  15667. * @returns a matrix
  15668. */
  15669. getLocalMatrix(): Matrix;
  15670. /**
  15671. * Gets the base matrix (initial matrix which remains unchanged)
  15672. * @returns a matrix
  15673. */
  15674. getBaseMatrix(): Matrix;
  15675. /**
  15676. * Gets the rest pose matrix
  15677. * @returns a matrix
  15678. */
  15679. getRestPose(): Matrix;
  15680. /**
  15681. * Sets the rest pose matrix
  15682. * @param matrix the local-space rest pose to set for this bone
  15683. */
  15684. setRestPose(matrix: Matrix): void;
  15685. /**
  15686. * Gets the bind pose matrix
  15687. * @returns the bind pose matrix
  15688. */
  15689. getBindPose(): Matrix;
  15690. /**
  15691. * Sets the bind pose matrix
  15692. * @param matrix the local-space bind pose to set for this bone
  15693. */
  15694. setBindPose(matrix: Matrix): void;
  15695. /**
  15696. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  15697. */
  15698. getWorldMatrix(): Matrix;
  15699. /**
  15700. * Sets the local matrix to rest pose matrix
  15701. */
  15702. returnToRest(): void;
  15703. /**
  15704. * Gets the inverse of the absolute transform matrix.
  15705. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  15706. * @returns a matrix
  15707. */
  15708. getInvertedAbsoluteTransform(): Matrix;
  15709. /**
  15710. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  15711. * @returns a matrix
  15712. */
  15713. getAbsoluteTransform(): Matrix;
  15714. /**
  15715. * Links with the given transform node.
  15716. * The local matrix of this bone is copied from the transform node every frame.
  15717. * @param transformNode defines the transform node to link to
  15718. */
  15719. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  15720. /**
  15721. * Gets the node used to drive the bone's transformation
  15722. * @returns a transform node or null
  15723. */
  15724. getTransformNode(): Nullable<TransformNode>;
  15725. /** Gets or sets current position (in local space) */
  15726. get position(): Vector3;
  15727. set position(newPosition: Vector3);
  15728. /** Gets or sets current rotation (in local space) */
  15729. get rotation(): Vector3;
  15730. set rotation(newRotation: Vector3);
  15731. /** Gets or sets current rotation quaternion (in local space) */
  15732. get rotationQuaternion(): Quaternion;
  15733. set rotationQuaternion(newRotation: Quaternion);
  15734. /** Gets or sets current scaling (in local space) */
  15735. get scaling(): Vector3;
  15736. set scaling(newScaling: Vector3);
  15737. /**
  15738. * Gets the animation properties override
  15739. */
  15740. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  15741. private _decompose;
  15742. private _compose;
  15743. /**
  15744. * Update the base and local matrices
  15745. * @param matrix defines the new base or local matrix
  15746. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15747. * @param updateLocalMatrix defines if the local matrix should be updated
  15748. */
  15749. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  15750. /** @hidden */
  15751. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  15752. /**
  15753. * Flag the bone as dirty (Forcing it to update everything)
  15754. */
  15755. markAsDirty(): void;
  15756. /** @hidden */
  15757. _markAsDirtyAndCompose(): void;
  15758. private _markAsDirtyAndDecompose;
  15759. /**
  15760. * Translate the bone in local or world space
  15761. * @param vec The amount to translate the bone
  15762. * @param space The space that the translation is in
  15763. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15764. */
  15765. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15766. /**
  15767. * Set the postion of the bone in local or world space
  15768. * @param position The position to set the bone
  15769. * @param space The space that the position is in
  15770. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15771. */
  15772. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15773. /**
  15774. * Set the absolute position of the bone (world space)
  15775. * @param position The position to set the bone
  15776. * @param mesh The mesh that this bone is attached to
  15777. */
  15778. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  15779. /**
  15780. * Scale the bone on the x, y and z axes (in local space)
  15781. * @param x The amount to scale the bone on the x axis
  15782. * @param y The amount to scale the bone on the y axis
  15783. * @param z The amount to scale the bone on the z axis
  15784. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  15785. */
  15786. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  15787. /**
  15788. * Set the bone scaling in local space
  15789. * @param scale defines the scaling vector
  15790. */
  15791. setScale(scale: Vector3): void;
  15792. /**
  15793. * Gets the current scaling in local space
  15794. * @returns the current scaling vector
  15795. */
  15796. getScale(): Vector3;
  15797. /**
  15798. * Gets the current scaling in local space and stores it in a target vector
  15799. * @param result defines the target vector
  15800. */
  15801. getScaleToRef(result: Vector3): void;
  15802. /**
  15803. * Set the yaw, pitch, and roll of the bone in local or world space
  15804. * @param yaw The rotation of the bone on the y axis
  15805. * @param pitch The rotation of the bone on the x axis
  15806. * @param roll The rotation of the bone on the z axis
  15807. * @param space The space that the axes of rotation are in
  15808. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15809. */
  15810. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  15811. /**
  15812. * Add a rotation to the bone on an axis in local or world space
  15813. * @param axis The axis to rotate the bone on
  15814. * @param amount The amount to rotate the bone
  15815. * @param space The space that the axis is in
  15816. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15817. */
  15818. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  15819. /**
  15820. * Set the rotation of the bone to a particular axis angle in local or world space
  15821. * @param axis The axis to rotate the bone on
  15822. * @param angle The angle that the bone should be rotated to
  15823. * @param space The space that the axis is in
  15824. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15825. */
  15826. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  15827. /**
  15828. * Set the euler rotation of the bone in local or world space
  15829. * @param rotation The euler rotation that the bone should be set to
  15830. * @param space The space that the rotation is in
  15831. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15832. */
  15833. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15834. /**
  15835. * Set the quaternion rotation of the bone in local or world space
  15836. * @param quat The quaternion rotation that the bone should be set to
  15837. * @param space The space that the rotation is in
  15838. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15839. */
  15840. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  15841. /**
  15842. * Set the rotation matrix of the bone in local or world space
  15843. * @param rotMat The rotation matrix that the bone should be set to
  15844. * @param space The space that the rotation is in
  15845. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15846. */
  15847. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  15848. private _rotateWithMatrix;
  15849. private _getNegativeRotationToRef;
  15850. /**
  15851. * Get the position of the bone in local or world space
  15852. * @param space The space that the returned position is in
  15853. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15854. * @returns The position of the bone
  15855. */
  15856. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15857. /**
  15858. * Copy the position of the bone to a vector3 in local or world space
  15859. * @param space The space that the returned position is in
  15860. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15861. * @param result The vector3 to copy the position to
  15862. */
  15863. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  15864. /**
  15865. * Get the absolute position of the bone (world space)
  15866. * @param mesh The mesh that this bone is attached to
  15867. * @returns The absolute position of the bone
  15868. */
  15869. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  15870. /**
  15871. * Copy the absolute position of the bone (world space) to the result param
  15872. * @param mesh The mesh that this bone is attached to
  15873. * @param result The vector3 to copy the absolute position to
  15874. */
  15875. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  15876. /**
  15877. * Compute the absolute transforms of this bone and its children
  15878. */
  15879. computeAbsoluteTransforms(): void;
  15880. /**
  15881. * Get the world direction from an axis that is in the local space of the bone
  15882. * @param localAxis The local direction that is used to compute the world direction
  15883. * @param mesh The mesh that this bone is attached to
  15884. * @returns The world direction
  15885. */
  15886. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15887. /**
  15888. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  15889. * @param localAxis The local direction that is used to compute the world direction
  15890. * @param mesh The mesh that this bone is attached to
  15891. * @param result The vector3 that the world direction will be copied to
  15892. */
  15893. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15894. /**
  15895. * Get the euler rotation of the bone in local or world space
  15896. * @param space The space that the rotation should be in
  15897. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15898. * @returns The euler rotation
  15899. */
  15900. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15901. /**
  15902. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  15903. * @param space The space that the rotation should be in
  15904. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15905. * @param result The vector3 that the rotation should be copied to
  15906. */
  15907. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15908. /**
  15909. * Get the quaternion rotation of the bone in either local or world space
  15910. * @param space The space that the rotation should be in
  15911. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15912. * @returns The quaternion rotation
  15913. */
  15914. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  15915. /**
  15916. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  15917. * @param space The space that the rotation should be in
  15918. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15919. * @param result The quaternion that the rotation should be copied to
  15920. */
  15921. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  15922. /**
  15923. * Get the rotation matrix of the bone in local or world space
  15924. * @param space The space that the rotation should be in
  15925. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15926. * @returns The rotation matrix
  15927. */
  15928. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  15929. /**
  15930. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  15931. * @param space The space that the rotation should be in
  15932. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15933. * @param result The quaternion that the rotation should be copied to
  15934. */
  15935. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  15936. /**
  15937. * Get the world position of a point that is in the local space of the bone
  15938. * @param position The local position
  15939. * @param mesh The mesh that this bone is attached to
  15940. * @returns The world position
  15941. */
  15942. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15943. /**
  15944. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  15945. * @param position The local position
  15946. * @param mesh The mesh that this bone is attached to
  15947. * @param result The vector3 that the world position should be copied to
  15948. */
  15949. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15950. /**
  15951. * Get the local position of a point that is in world space
  15952. * @param position The world position
  15953. * @param mesh The mesh that this bone is attached to
  15954. * @returns The local position
  15955. */
  15956. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15957. /**
  15958. * Get the local position of a point that is in world space and copy it to the result param
  15959. * @param position The world position
  15960. * @param mesh The mesh that this bone is attached to
  15961. * @param result The vector3 that the local position should be copied to
  15962. */
  15963. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15964. /**
  15965. * Set the current local matrix as the restPose for this bone.
  15966. */
  15967. setCurrentPoseAsRest(): void;
  15968. }
  15969. }
  15970. declare module "babylonjs/Animations/runtimeAnimation" {
  15971. import { Animation, _IAnimationState } from "babylonjs/Animations/animation";
  15972. import { Animatable } from "babylonjs/Animations/animatable";
  15973. import { Scene } from "babylonjs/scene";
  15974. /**
  15975. * Defines a runtime animation
  15976. */
  15977. export class RuntimeAnimation {
  15978. private _events;
  15979. /**
  15980. * The current frame of the runtime animation
  15981. */
  15982. private _currentFrame;
  15983. /**
  15984. * The animation used by the runtime animation
  15985. */
  15986. private _animation;
  15987. /**
  15988. * The target of the runtime animation
  15989. */
  15990. private _target;
  15991. /**
  15992. * The initiating animatable
  15993. */
  15994. private _host;
  15995. /**
  15996. * The original value of the runtime animation
  15997. */
  15998. private _originalValue;
  15999. /**
  16000. * The original blend value of the runtime animation
  16001. */
  16002. private _originalBlendValue;
  16003. /**
  16004. * The offsets cache of the runtime animation
  16005. */
  16006. private _offsetsCache;
  16007. /**
  16008. * The high limits cache of the runtime animation
  16009. */
  16010. private _highLimitsCache;
  16011. /**
  16012. * Specifies if the runtime animation has been stopped
  16013. */
  16014. private _stopped;
  16015. /**
  16016. * The blending factor of the runtime animation
  16017. */
  16018. private _blendingFactor;
  16019. /**
  16020. * The BabylonJS scene
  16021. */
  16022. private _scene;
  16023. /**
  16024. * The current value of the runtime animation
  16025. */
  16026. private _currentValue;
  16027. /** @hidden */
  16028. _animationState: _IAnimationState;
  16029. /**
  16030. * The active target of the runtime animation
  16031. */
  16032. private _activeTargets;
  16033. private _currentActiveTarget;
  16034. private _directTarget;
  16035. /**
  16036. * The target path of the runtime animation
  16037. */
  16038. private _targetPath;
  16039. /**
  16040. * The weight of the runtime animation
  16041. */
  16042. private _weight;
  16043. /**
  16044. * The ratio offset of the runtime animation
  16045. */
  16046. private _ratioOffset;
  16047. /**
  16048. * The previous delay of the runtime animation
  16049. */
  16050. private _previousDelay;
  16051. /**
  16052. * The previous ratio of the runtime animation
  16053. */
  16054. private _previousRatio;
  16055. private _enableBlending;
  16056. private _keys;
  16057. private _minFrame;
  16058. private _maxFrame;
  16059. private _minValue;
  16060. private _maxValue;
  16061. private _targetIsArray;
  16062. /**
  16063. * Gets the current frame of the runtime animation
  16064. */
  16065. get currentFrame(): number;
  16066. /**
  16067. * Gets the weight of the runtime animation
  16068. */
  16069. get weight(): number;
  16070. /**
  16071. * Gets the current value of the runtime animation
  16072. */
  16073. get currentValue(): any;
  16074. /**
  16075. * Gets the target path of the runtime animation
  16076. */
  16077. get targetPath(): string;
  16078. /**
  16079. * Gets the actual target of the runtime animation
  16080. */
  16081. get target(): any;
  16082. /**
  16083. * Gets the additive state of the runtime animation
  16084. */
  16085. get isAdditive(): boolean;
  16086. /** @hidden */
  16087. _onLoop: () => void;
  16088. /**
  16089. * Create a new RuntimeAnimation object
  16090. * @param target defines the target of the animation
  16091. * @param animation defines the source animation object
  16092. * @param scene defines the hosting scene
  16093. * @param host defines the initiating Animatable
  16094. */
  16095. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  16096. private _preparePath;
  16097. /**
  16098. * Gets the animation from the runtime animation
  16099. */
  16100. get animation(): Animation;
  16101. /**
  16102. * Resets the runtime animation to the beginning
  16103. * @param restoreOriginal defines whether to restore the target property to the original value
  16104. */
  16105. reset(restoreOriginal?: boolean): void;
  16106. /**
  16107. * Specifies if the runtime animation is stopped
  16108. * @returns Boolean specifying if the runtime animation is stopped
  16109. */
  16110. isStopped(): boolean;
  16111. /**
  16112. * Disposes of the runtime animation
  16113. */
  16114. dispose(): void;
  16115. /**
  16116. * Apply the interpolated value to the target
  16117. * @param currentValue defines the value computed by the animation
  16118. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  16119. */
  16120. setValue(currentValue: any, weight: number): void;
  16121. private _getOriginalValues;
  16122. private _setValue;
  16123. /**
  16124. * Gets the loop pmode of the runtime animation
  16125. * @returns Loop Mode
  16126. */
  16127. private _getCorrectLoopMode;
  16128. /**
  16129. * Move the current animation to a given frame
  16130. * @param frame defines the frame to move to
  16131. */
  16132. goToFrame(frame: number): void;
  16133. /**
  16134. * @hidden Internal use only
  16135. */
  16136. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  16137. /**
  16138. * Execute the current animation
  16139. * @param delay defines the delay to add to the current frame
  16140. * @param from defines the lower bound of the animation range
  16141. * @param to defines the upper bound of the animation range
  16142. * @param loop defines if the current animation must loop
  16143. * @param speedRatio defines the current speed ratio
  16144. * @param weight defines the weight of the animation (default is -1 so no weight)
  16145. * @param onLoop optional callback called when animation loops
  16146. * @returns a boolean indicating if the animation is running
  16147. */
  16148. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  16149. }
  16150. }
  16151. declare module "babylonjs/Animations/animatable" {
  16152. import { Animation } from "babylonjs/Animations/animation";
  16153. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  16154. import { Nullable } from "babylonjs/types";
  16155. import { Observable } from "babylonjs/Misc/observable";
  16156. import { Scene } from "babylonjs/scene";
  16157. import { Matrix, Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  16158. import { Node } from "babylonjs/node";
  16159. /**
  16160. * Class used to store an actual running animation
  16161. */
  16162. export class Animatable {
  16163. /** defines the target object */
  16164. target: any;
  16165. /** defines the starting frame number (default is 0) */
  16166. fromFrame: number;
  16167. /** defines the ending frame number (default is 100) */
  16168. toFrame: number;
  16169. /** defines if the animation must loop (default is false) */
  16170. loopAnimation: boolean;
  16171. /** defines a callback to call when animation ends if it is not looping */
  16172. onAnimationEnd?: (() => void) | null | undefined;
  16173. /** defines a callback to call when animation loops */
  16174. onAnimationLoop?: (() => void) | null | undefined;
  16175. /** defines whether the animation should be evaluated additively */
  16176. isAdditive: boolean;
  16177. private _localDelayOffset;
  16178. private _pausedDelay;
  16179. private _runtimeAnimations;
  16180. private _paused;
  16181. private _scene;
  16182. private _speedRatio;
  16183. private _weight;
  16184. private _syncRoot;
  16185. /**
  16186. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  16187. * This will only apply for non looping animation (default is true)
  16188. */
  16189. disposeOnEnd: boolean;
  16190. /**
  16191. * Gets a boolean indicating if the animation has started
  16192. */
  16193. animationStarted: boolean;
  16194. /**
  16195. * Observer raised when the animation ends
  16196. */
  16197. onAnimationEndObservable: Observable<Animatable>;
  16198. /**
  16199. * Observer raised when the animation loops
  16200. */
  16201. onAnimationLoopObservable: Observable<Animatable>;
  16202. /**
  16203. * Gets the root Animatable used to synchronize and normalize animations
  16204. */
  16205. get syncRoot(): Nullable<Animatable>;
  16206. /**
  16207. * Gets the current frame of the first RuntimeAnimation
  16208. * Used to synchronize Animatables
  16209. */
  16210. get masterFrame(): number;
  16211. /**
  16212. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  16213. */
  16214. get weight(): number;
  16215. set weight(value: number);
  16216. /**
  16217. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  16218. */
  16219. get speedRatio(): number;
  16220. set speedRatio(value: number);
  16221. /**
  16222. * Creates a new Animatable
  16223. * @param scene defines the hosting scene
  16224. * @param target defines the target object
  16225. * @param fromFrame defines the starting frame number (default is 0)
  16226. * @param toFrame defines the ending frame number (default is 100)
  16227. * @param loopAnimation defines if the animation must loop (default is false)
  16228. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  16229. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  16230. * @param animations defines a group of animation to add to the new Animatable
  16231. * @param onAnimationLoop defines a callback to call when animation loops
  16232. * @param isAdditive defines whether the animation should be evaluated additively
  16233. */
  16234. constructor(scene: Scene,
  16235. /** defines the target object */
  16236. target: any,
  16237. /** defines the starting frame number (default is 0) */
  16238. fromFrame?: number,
  16239. /** defines the ending frame number (default is 100) */
  16240. toFrame?: number,
  16241. /** defines if the animation must loop (default is false) */
  16242. loopAnimation?: boolean, speedRatio?: number,
  16243. /** defines a callback to call when animation ends if it is not looping */
  16244. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  16245. /** defines a callback to call when animation loops */
  16246. onAnimationLoop?: (() => void) | null | undefined,
  16247. /** defines whether the animation should be evaluated additively */
  16248. isAdditive?: boolean);
  16249. /**
  16250. * Synchronize and normalize current Animatable with a source Animatable
  16251. * This is useful when using animation weights and when animations are not of the same length
  16252. * @param root defines the root Animatable to synchronize with
  16253. * @returns the current Animatable
  16254. */
  16255. syncWith(root: Animatable): Animatable;
  16256. /**
  16257. * Gets the list of runtime animations
  16258. * @returns an array of RuntimeAnimation
  16259. */
  16260. getAnimations(): RuntimeAnimation[];
  16261. /**
  16262. * Adds more animations to the current animatable
  16263. * @param target defines the target of the animations
  16264. * @param animations defines the new animations to add
  16265. */
  16266. appendAnimations(target: any, animations: Animation[]): void;
  16267. /**
  16268. * Gets the source animation for a specific property
  16269. * @param property defines the propertyu to look for
  16270. * @returns null or the source animation for the given property
  16271. */
  16272. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  16273. /**
  16274. * Gets the runtime animation for a specific property
  16275. * @param property defines the propertyu to look for
  16276. * @returns null or the runtime animation for the given property
  16277. */
  16278. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  16279. /**
  16280. * Resets the animatable to its original state
  16281. */
  16282. reset(): void;
  16283. /**
  16284. * Allows the animatable to blend with current running animations
  16285. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16286. * @param blendingSpeed defines the blending speed to use
  16287. */
  16288. enableBlending(blendingSpeed: number): void;
  16289. /**
  16290. * Disable animation blending
  16291. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16292. */
  16293. disableBlending(): void;
  16294. /**
  16295. * Jump directly to a given frame
  16296. * @param frame defines the frame to jump to
  16297. */
  16298. goToFrame(frame: number): void;
  16299. /**
  16300. * Pause the animation
  16301. */
  16302. pause(): void;
  16303. /**
  16304. * Restart the animation
  16305. */
  16306. restart(): void;
  16307. private _raiseOnAnimationEnd;
  16308. /**
  16309. * Stop and delete the current animation
  16310. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  16311. * @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)
  16312. */
  16313. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  16314. /**
  16315. * Wait asynchronously for the animation to end
  16316. * @returns a promise which will be fullfilled when the animation ends
  16317. */
  16318. waitAsync(): Promise<Animatable>;
  16319. /** @hidden */
  16320. _animate(delay: number): boolean;
  16321. }
  16322. module "babylonjs/scene" {
  16323. interface Scene {
  16324. /** @hidden */
  16325. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  16326. /** @hidden */
  16327. _processLateAnimationBindingsForMatrices(holder: {
  16328. totalWeight: number;
  16329. totalAdditiveWeight: number;
  16330. animations: RuntimeAnimation[];
  16331. additiveAnimations: RuntimeAnimation[];
  16332. originalValue: Matrix;
  16333. }): any;
  16334. /** @hidden */
  16335. _processLateAnimationBindingsForQuaternions(holder: {
  16336. totalWeight: number;
  16337. totalAdditiveWeight: number;
  16338. animations: RuntimeAnimation[];
  16339. additiveAnimations: RuntimeAnimation[];
  16340. originalValue: Quaternion;
  16341. }, refQuaternion: Quaternion): Quaternion;
  16342. /** @hidden */
  16343. _processLateAnimationBindings(): void;
  16344. /**
  16345. * Will start the animation sequence of a given target
  16346. * @param target defines the target
  16347. * @param from defines from which frame should animation start
  16348. * @param to defines until which frame should animation run.
  16349. * @param weight defines the weight to apply to the animation (1.0 by default)
  16350. * @param loop defines if the animation loops
  16351. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16352. * @param onAnimationEnd defines the function to be executed when the animation ends
  16353. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16354. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16355. * @param onAnimationLoop defines the callback to call when an animation loops
  16356. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16357. * @returns the animatable object created for this animation
  16358. */
  16359. 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;
  16360. /**
  16361. * Will start the animation sequence of a given target
  16362. * @param target defines the target
  16363. * @param from defines from which frame should animation start
  16364. * @param to defines until which frame should animation run.
  16365. * @param loop defines if the animation loops
  16366. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16367. * @param onAnimationEnd defines the function to be executed when the animation ends
  16368. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16369. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16370. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  16371. * @param onAnimationLoop defines the callback to call when an animation loops
  16372. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16373. * @returns the animatable object created for this animation
  16374. */
  16375. 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;
  16376. /**
  16377. * Will start the animation sequence of a given target and its hierarchy
  16378. * @param target defines the target
  16379. * @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.
  16380. * @param from defines from which frame should animation start
  16381. * @param to defines until which frame should animation run.
  16382. * @param loop defines if the animation loops
  16383. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16384. * @param onAnimationEnd defines the function to be executed when the animation ends
  16385. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16386. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16387. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16388. * @param onAnimationLoop defines the callback to call when an animation loops
  16389. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16390. * @returns the list of created animatables
  16391. */
  16392. 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[];
  16393. /**
  16394. * Begin a new animation on a given node
  16395. * @param target defines the target where the animation will take place
  16396. * @param animations defines the list of animations to start
  16397. * @param from defines the initial value
  16398. * @param to defines the final value
  16399. * @param loop defines if you want animation to loop (off by default)
  16400. * @param speedRatio defines the speed ratio to apply to all animations
  16401. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16402. * @param onAnimationLoop defines the callback to call when an animation loops
  16403. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16404. * @returns the list of created animatables
  16405. */
  16406. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16407. /**
  16408. * Begin a new animation on a given node and its hierarchy
  16409. * @param target defines the root node where the animation will take place
  16410. * @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.
  16411. * @param animations defines the list of animations to start
  16412. * @param from defines the initial value
  16413. * @param to defines the final value
  16414. * @param loop defines if you want animation to loop (off by default)
  16415. * @param speedRatio defines the speed ratio to apply to all animations
  16416. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16417. * @param onAnimationLoop defines the callback to call when an animation loops
  16418. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16419. * @returns the list of animatables created for all nodes
  16420. */
  16421. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  16422. /**
  16423. * Gets the animatable associated with a specific target
  16424. * @param target defines the target of the animatable
  16425. * @returns the required animatable if found
  16426. */
  16427. getAnimatableByTarget(target: any): Nullable<Animatable>;
  16428. /**
  16429. * Gets all animatables associated with a given target
  16430. * @param target defines the target to look animatables for
  16431. * @returns an array of Animatables
  16432. */
  16433. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  16434. /**
  16435. * Stops and removes all animations that have been applied to the scene
  16436. */
  16437. stopAllAnimations(): void;
  16438. /**
  16439. * Gets the current delta time used by animation engine
  16440. */
  16441. deltaTime: number;
  16442. }
  16443. }
  16444. module "babylonjs/Bones/bone" {
  16445. interface Bone {
  16446. /**
  16447. * Copy an animation range from another bone
  16448. * @param source defines the source bone
  16449. * @param rangeName defines the range name to copy
  16450. * @param frameOffset defines the frame offset
  16451. * @param rescaleAsRequired defines if rescaling must be applied if required
  16452. * @param skelDimensionsRatio defines the scaling ratio
  16453. * @returns true if operation was successful
  16454. */
  16455. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  16456. }
  16457. }
  16458. }
  16459. declare module "babylonjs/Bones/skeleton" {
  16460. import { Bone } from "babylonjs/Bones/bone";
  16461. import { Observable } from "babylonjs/Misc/observable";
  16462. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16463. import { Scene } from "babylonjs/scene";
  16464. import { Nullable } from "babylonjs/types";
  16465. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16466. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  16467. import { Animatable } from "babylonjs/Animations/animatable";
  16468. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  16469. import { Animation } from "babylonjs/Animations/animation";
  16470. import { AnimationRange } from "babylonjs/Animations/animationRange";
  16471. import { IInspectable } from "babylonjs/Misc/iInspectable";
  16472. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  16473. /**
  16474. * Class used to handle skinning animations
  16475. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  16476. */
  16477. export class Skeleton implements IAnimatable {
  16478. /** defines the skeleton name */
  16479. name: string;
  16480. /** defines the skeleton Id */
  16481. id: string;
  16482. /**
  16483. * Defines the list of child bones
  16484. */
  16485. bones: Bone[];
  16486. /**
  16487. * Defines an estimate of the dimension of the skeleton at rest
  16488. */
  16489. dimensionsAtRest: Vector3;
  16490. /**
  16491. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  16492. */
  16493. needInitialSkinMatrix: boolean;
  16494. /**
  16495. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  16496. */
  16497. overrideMesh: Nullable<AbstractMesh>;
  16498. /**
  16499. * Gets the list of animations attached to this skeleton
  16500. */
  16501. animations: Array<Animation>;
  16502. private _scene;
  16503. private _isDirty;
  16504. private _transformMatrices;
  16505. private _transformMatrixTexture;
  16506. private _meshesWithPoseMatrix;
  16507. private _animatables;
  16508. private _identity;
  16509. private _synchronizedWithMesh;
  16510. private _ranges;
  16511. private _lastAbsoluteTransformsUpdateId;
  16512. private _canUseTextureForBones;
  16513. private _uniqueId;
  16514. /** @hidden */
  16515. _numBonesWithLinkedTransformNode: number;
  16516. /** @hidden */
  16517. _hasWaitingData: Nullable<boolean>;
  16518. /** @hidden */
  16519. _waitingOverrideMeshId: Nullable<string>;
  16520. /**
  16521. * Specifies if the skeleton should be serialized
  16522. */
  16523. doNotSerialize: boolean;
  16524. private _useTextureToStoreBoneMatrices;
  16525. /**
  16526. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  16527. * Please note that this option is not available if the hardware does not support it
  16528. */
  16529. get useTextureToStoreBoneMatrices(): boolean;
  16530. set useTextureToStoreBoneMatrices(value: boolean);
  16531. private _animationPropertiesOverride;
  16532. /**
  16533. * Gets or sets the animation properties override
  16534. */
  16535. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  16536. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  16537. /**
  16538. * List of inspectable custom properties (used by the Inspector)
  16539. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  16540. */
  16541. inspectableCustomProperties: IInspectable[];
  16542. /**
  16543. * An observable triggered before computing the skeleton's matrices
  16544. */
  16545. onBeforeComputeObservable: Observable<Skeleton>;
  16546. /**
  16547. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  16548. */
  16549. get isUsingTextureForMatrices(): boolean;
  16550. /**
  16551. * Gets the unique ID of this skeleton
  16552. */
  16553. get uniqueId(): number;
  16554. /**
  16555. * Creates a new skeleton
  16556. * @param name defines the skeleton name
  16557. * @param id defines the skeleton Id
  16558. * @param scene defines the hosting scene
  16559. */
  16560. constructor(
  16561. /** defines the skeleton name */
  16562. name: string,
  16563. /** defines the skeleton Id */
  16564. id: string, scene: Scene);
  16565. /**
  16566. * Gets the current object class name.
  16567. * @return the class name
  16568. */
  16569. getClassName(): string;
  16570. /**
  16571. * Returns an array containing the root bones
  16572. * @returns an array containing the root bones
  16573. */
  16574. getChildren(): Array<Bone>;
  16575. /**
  16576. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  16577. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16578. * @returns a Float32Array containing matrices data
  16579. */
  16580. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  16581. /**
  16582. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  16583. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16584. * @returns a raw texture containing the data
  16585. */
  16586. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  16587. /**
  16588. * Gets the current hosting scene
  16589. * @returns a scene object
  16590. */
  16591. getScene(): Scene;
  16592. /**
  16593. * Gets a string representing the current skeleton data
  16594. * @param fullDetails defines a boolean indicating if we want a verbose version
  16595. * @returns a string representing the current skeleton data
  16596. */
  16597. toString(fullDetails?: boolean): string;
  16598. /**
  16599. * Get bone's index searching by name
  16600. * @param name defines bone's name to search for
  16601. * @return the indice of the bone. Returns -1 if not found
  16602. */
  16603. getBoneIndexByName(name: string): number;
  16604. /**
  16605. * Creater a new animation range
  16606. * @param name defines the name of the range
  16607. * @param from defines the start key
  16608. * @param to defines the end key
  16609. */
  16610. createAnimationRange(name: string, from: number, to: number): void;
  16611. /**
  16612. * Delete a specific animation range
  16613. * @param name defines the name of the range
  16614. * @param deleteFrames defines if frames must be removed as well
  16615. */
  16616. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  16617. /**
  16618. * Gets a specific animation range
  16619. * @param name defines the name of the range to look for
  16620. * @returns the requested animation range or null if not found
  16621. */
  16622. getAnimationRange(name: string): Nullable<AnimationRange>;
  16623. /**
  16624. * Gets the list of all animation ranges defined on this skeleton
  16625. * @returns an array
  16626. */
  16627. getAnimationRanges(): Nullable<AnimationRange>[];
  16628. /**
  16629. * Copy animation range from a source skeleton.
  16630. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  16631. * @param source defines the source skeleton
  16632. * @param name defines the name of the range to copy
  16633. * @param rescaleAsRequired defines if rescaling must be applied if required
  16634. * @returns true if operation was successful
  16635. */
  16636. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  16637. /**
  16638. * Forces the skeleton to go to rest pose
  16639. */
  16640. returnToRest(): void;
  16641. private _getHighestAnimationFrame;
  16642. /**
  16643. * Begin a specific animation range
  16644. * @param name defines the name of the range to start
  16645. * @param loop defines if looping must be turned on (false by default)
  16646. * @param speedRatio defines the speed ratio to apply (1 by default)
  16647. * @param onAnimationEnd defines a callback which will be called when animation will end
  16648. * @returns a new animatable
  16649. */
  16650. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  16651. /**
  16652. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  16653. * @param skeleton defines the Skeleton containing the animation range to convert
  16654. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  16655. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  16656. * @returns the original skeleton
  16657. */
  16658. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  16659. /** @hidden */
  16660. _markAsDirty(): void;
  16661. /** @hidden */
  16662. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16663. /** @hidden */
  16664. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16665. private _computeTransformMatrices;
  16666. /**
  16667. * Build all resources required to render a skeleton
  16668. */
  16669. prepare(): void;
  16670. /**
  16671. * Gets the list of animatables currently running for this skeleton
  16672. * @returns an array of animatables
  16673. */
  16674. getAnimatables(): IAnimatable[];
  16675. /**
  16676. * Clone the current skeleton
  16677. * @param name defines the name of the new skeleton
  16678. * @param id defines the id of the new skeleton
  16679. * @returns the new skeleton
  16680. */
  16681. clone(name: string, id?: string): Skeleton;
  16682. /**
  16683. * Enable animation blending for this skeleton
  16684. * @param blendingSpeed defines the blending speed to apply
  16685. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16686. */
  16687. enableBlending(blendingSpeed?: number): void;
  16688. /**
  16689. * Releases all resources associated with the current skeleton
  16690. */
  16691. dispose(): void;
  16692. /**
  16693. * Serialize the skeleton in a JSON object
  16694. * @returns a JSON object
  16695. */
  16696. serialize(): any;
  16697. /**
  16698. * Creates a new skeleton from serialized data
  16699. * @param parsedSkeleton defines the serialized data
  16700. * @param scene defines the hosting scene
  16701. * @returns a new skeleton
  16702. */
  16703. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  16704. /**
  16705. * Compute all node absolute transforms
  16706. * @param forceUpdate defines if computation must be done even if cache is up to date
  16707. */
  16708. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  16709. /**
  16710. * Gets the root pose matrix
  16711. * @returns a matrix
  16712. */
  16713. getPoseMatrix(): Nullable<Matrix>;
  16714. /**
  16715. * Sorts bones per internal index
  16716. */
  16717. sortBones(): void;
  16718. private _sortBones;
  16719. /**
  16720. * Set the current local matrix as the restPose for all bones in the skeleton.
  16721. */
  16722. setCurrentPoseAsRest(): void;
  16723. }
  16724. }
  16725. declare module "babylonjs/Meshes/instancedMesh" {
  16726. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  16727. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16728. import { Camera } from "babylonjs/Cameras/camera";
  16729. import { Node } from "babylonjs/node";
  16730. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16731. import { Mesh } from "babylonjs/Meshes/mesh";
  16732. import { Material } from "babylonjs/Materials/material";
  16733. import { Skeleton } from "babylonjs/Bones/skeleton";
  16734. import { Light } from "babylonjs/Lights/light";
  16735. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  16736. /**
  16737. * Creates an instance based on a source mesh.
  16738. */
  16739. export class InstancedMesh extends AbstractMesh {
  16740. private _sourceMesh;
  16741. private _currentLOD;
  16742. /** @hidden */
  16743. _indexInSourceMeshInstanceArray: number;
  16744. constructor(name: string, source: Mesh);
  16745. /**
  16746. * Returns the string "InstancedMesh".
  16747. */
  16748. getClassName(): string;
  16749. /** Gets the list of lights affecting that mesh */
  16750. get lightSources(): Light[];
  16751. _resyncLightSources(): void;
  16752. _resyncLightSource(light: Light): void;
  16753. _removeLightSource(light: Light, dispose: boolean): void;
  16754. /**
  16755. * If the source mesh receives shadows
  16756. */
  16757. get receiveShadows(): boolean;
  16758. /**
  16759. * The material of the source mesh
  16760. */
  16761. get material(): Nullable<Material>;
  16762. /**
  16763. * Visibility of the source mesh
  16764. */
  16765. get visibility(): number;
  16766. /**
  16767. * Skeleton of the source mesh
  16768. */
  16769. get skeleton(): Nullable<Skeleton>;
  16770. /**
  16771. * Rendering ground id of the source mesh
  16772. */
  16773. get renderingGroupId(): number;
  16774. set renderingGroupId(value: number);
  16775. /**
  16776. * Returns the total number of vertices (integer).
  16777. */
  16778. getTotalVertices(): number;
  16779. /**
  16780. * Returns a positive integer : the total number of indices in this mesh geometry.
  16781. * @returns the numner of indices or zero if the mesh has no geometry.
  16782. */
  16783. getTotalIndices(): number;
  16784. /**
  16785. * The source mesh of the instance
  16786. */
  16787. get sourceMesh(): Mesh;
  16788. /**
  16789. * Creates a new InstancedMesh object from the mesh model.
  16790. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  16791. * @param name defines the name of the new instance
  16792. * @returns a new InstancedMesh
  16793. */
  16794. createInstance(name: string): InstancedMesh;
  16795. /**
  16796. * Is this node ready to be used/rendered
  16797. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  16798. * @return {boolean} is it ready
  16799. */
  16800. isReady(completeCheck?: boolean): boolean;
  16801. /**
  16802. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  16803. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  16804. * @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.
  16805. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  16806. */
  16807. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  16808. /**
  16809. * Sets the vertex data of the mesh geometry for the requested `kind`.
  16810. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  16811. * The `data` are either a numeric array either a Float32Array.
  16812. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  16813. * 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).
  16814. * Note that a new underlying VertexBuffer object is created each call.
  16815. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  16816. *
  16817. * Possible `kind` values :
  16818. * - VertexBuffer.PositionKind
  16819. * - VertexBuffer.UVKind
  16820. * - VertexBuffer.UV2Kind
  16821. * - VertexBuffer.UV3Kind
  16822. * - VertexBuffer.UV4Kind
  16823. * - VertexBuffer.UV5Kind
  16824. * - VertexBuffer.UV6Kind
  16825. * - VertexBuffer.ColorKind
  16826. * - VertexBuffer.MatricesIndicesKind
  16827. * - VertexBuffer.MatricesIndicesExtraKind
  16828. * - VertexBuffer.MatricesWeightsKind
  16829. * - VertexBuffer.MatricesWeightsExtraKind
  16830. *
  16831. * Returns the Mesh.
  16832. */
  16833. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  16834. /**
  16835. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  16836. * If the mesh has no geometry, it is simply returned as it is.
  16837. * The `data` are either a numeric array either a Float32Array.
  16838. * No new underlying VertexBuffer object is created.
  16839. * 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.
  16840. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  16841. *
  16842. * Possible `kind` values :
  16843. * - VertexBuffer.PositionKind
  16844. * - VertexBuffer.UVKind
  16845. * - VertexBuffer.UV2Kind
  16846. * - VertexBuffer.UV3Kind
  16847. * - VertexBuffer.UV4Kind
  16848. * - VertexBuffer.UV5Kind
  16849. * - VertexBuffer.UV6Kind
  16850. * - VertexBuffer.ColorKind
  16851. * - VertexBuffer.MatricesIndicesKind
  16852. * - VertexBuffer.MatricesIndicesExtraKind
  16853. * - VertexBuffer.MatricesWeightsKind
  16854. * - VertexBuffer.MatricesWeightsExtraKind
  16855. *
  16856. * Returns the Mesh.
  16857. */
  16858. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  16859. /**
  16860. * Sets the mesh indices.
  16861. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  16862. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  16863. * This method creates a new index buffer each call.
  16864. * Returns the Mesh.
  16865. */
  16866. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  16867. /**
  16868. * Boolean : True if the mesh owns the requested kind of data.
  16869. */
  16870. isVerticesDataPresent(kind: string): boolean;
  16871. /**
  16872. * Returns an array of indices (IndicesArray).
  16873. */
  16874. getIndices(): Nullable<IndicesArray>;
  16875. get _positions(): Nullable<Vector3[]>;
  16876. /**
  16877. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  16878. * This means the mesh underlying bounding box and sphere are recomputed.
  16879. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  16880. * @returns the current mesh
  16881. */
  16882. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  16883. /** @hidden */
  16884. _preActivate(): InstancedMesh;
  16885. /** @hidden */
  16886. _activate(renderId: number, intermediateRendering: boolean): boolean;
  16887. /** @hidden */
  16888. _postActivate(): void;
  16889. getWorldMatrix(): Matrix;
  16890. get isAnInstance(): boolean;
  16891. /**
  16892. * Returns the current associated LOD AbstractMesh.
  16893. */
  16894. getLOD(camera: Camera): AbstractMesh;
  16895. /** @hidden */
  16896. _preActivateForIntermediateRendering(renderId: number): Mesh;
  16897. /** @hidden */
  16898. _syncSubMeshes(): InstancedMesh;
  16899. /** @hidden */
  16900. _generatePointsArray(): boolean;
  16901. /** @hidden */
  16902. _updateBoundingInfo(): AbstractMesh;
  16903. /**
  16904. * Creates a new InstancedMesh from the current mesh.
  16905. * - name (string) : the cloned mesh name
  16906. * - newParent (optional Node) : the optional Node to parent the clone to.
  16907. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  16908. *
  16909. * Returns the clone.
  16910. */
  16911. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  16912. /**
  16913. * Disposes the InstancedMesh.
  16914. * Returns nothing.
  16915. */
  16916. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  16917. }
  16918. module "babylonjs/Meshes/mesh" {
  16919. interface Mesh {
  16920. /**
  16921. * Register a custom buffer that will be instanced
  16922. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16923. * @param kind defines the buffer kind
  16924. * @param stride defines the stride in floats
  16925. */
  16926. registerInstancedBuffer(kind: string, stride: number): void;
  16927. /**
  16928. * true to use the edge renderer for all instances of this mesh
  16929. */
  16930. edgesShareWithInstances: boolean;
  16931. /** @hidden */
  16932. _userInstancedBuffersStorage: {
  16933. data: {
  16934. [key: string]: Float32Array;
  16935. };
  16936. sizes: {
  16937. [key: string]: number;
  16938. };
  16939. vertexBuffers: {
  16940. [key: string]: Nullable<VertexBuffer>;
  16941. };
  16942. strides: {
  16943. [key: string]: number;
  16944. };
  16945. };
  16946. }
  16947. }
  16948. module "babylonjs/Meshes/abstractMesh" {
  16949. interface AbstractMesh {
  16950. /**
  16951. * Object used to store instanced buffers defined by user
  16952. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16953. */
  16954. instancedBuffers: {
  16955. [key: string]: any;
  16956. };
  16957. }
  16958. }
  16959. }
  16960. declare module "babylonjs/Materials/shaderMaterial" {
  16961. import { Nullable } from "babylonjs/types";
  16962. import { Scene } from "babylonjs/scene";
  16963. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  16964. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16965. import { Mesh } from "babylonjs/Meshes/mesh";
  16966. import { SubMesh } from "babylonjs/Meshes/subMesh";
  16967. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  16968. import { Effect } from "babylonjs/Materials/effect";
  16969. import { Material } from "babylonjs/Materials/material";
  16970. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  16971. /**
  16972. * Defines the options associated with the creation of a shader material.
  16973. */
  16974. export interface IShaderMaterialOptions {
  16975. /**
  16976. * Does the material work in alpha blend mode
  16977. */
  16978. needAlphaBlending: boolean;
  16979. /**
  16980. * Does the material work in alpha test mode
  16981. */
  16982. needAlphaTesting: boolean;
  16983. /**
  16984. * The list of attribute names used in the shader
  16985. */
  16986. attributes: string[];
  16987. /**
  16988. * The list of unifrom names used in the shader
  16989. */
  16990. uniforms: string[];
  16991. /**
  16992. * The list of UBO names used in the shader
  16993. */
  16994. uniformBuffers: string[];
  16995. /**
  16996. * The list of sampler names used in the shader
  16997. */
  16998. samplers: string[];
  16999. /**
  17000. * The list of defines used in the shader
  17001. */
  17002. defines: string[];
  17003. }
  17004. /**
  17005. * 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.
  17006. *
  17007. * This returned material effects how the mesh will look based on the code in the shaders.
  17008. *
  17009. * @see https://doc.babylonjs.com/how_to/shader_material
  17010. */
  17011. export class ShaderMaterial extends Material {
  17012. private _shaderPath;
  17013. private _options;
  17014. private _textures;
  17015. private _textureArrays;
  17016. private _floats;
  17017. private _ints;
  17018. private _floatsArrays;
  17019. private _colors3;
  17020. private _colors3Arrays;
  17021. private _colors4;
  17022. private _colors4Arrays;
  17023. private _vectors2;
  17024. private _vectors3;
  17025. private _vectors4;
  17026. private _matrices;
  17027. private _matrixArrays;
  17028. private _matrices3x3;
  17029. private _matrices2x2;
  17030. private _vectors2Arrays;
  17031. private _vectors3Arrays;
  17032. private _vectors4Arrays;
  17033. private _cachedWorldViewMatrix;
  17034. private _cachedWorldViewProjectionMatrix;
  17035. private _renderId;
  17036. private _multiview;
  17037. private _cachedDefines;
  17038. /** Define the Url to load snippets */
  17039. static SnippetUrl: string;
  17040. /** Snippet ID if the material was created from the snippet server */
  17041. snippetId: string;
  17042. /**
  17043. * Instantiate a new shader material.
  17044. * 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.
  17045. * This returned material effects how the mesh will look based on the code in the shaders.
  17046. * @see https://doc.babylonjs.com/how_to/shader_material
  17047. * @param name Define the name of the material in the scene
  17048. * @param scene Define the scene the material belongs to
  17049. * @param shaderPath Defines the route to the shader code in one of three ways:
  17050. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  17051. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  17052. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  17053. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  17054. * @param options Define the options used to create the shader
  17055. */
  17056. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  17057. /**
  17058. * Gets the shader path used to define the shader code
  17059. * It can be modified to trigger a new compilation
  17060. */
  17061. get shaderPath(): any;
  17062. /**
  17063. * Sets the shader path used to define the shader code
  17064. * It can be modified to trigger a new compilation
  17065. */
  17066. set shaderPath(shaderPath: any);
  17067. /**
  17068. * Gets the options used to compile the shader.
  17069. * They can be modified to trigger a new compilation
  17070. */
  17071. get options(): IShaderMaterialOptions;
  17072. /**
  17073. * Gets the current class name of the material e.g. "ShaderMaterial"
  17074. * Mainly use in serialization.
  17075. * @returns the class name
  17076. */
  17077. getClassName(): string;
  17078. /**
  17079. * Specifies if the material will require alpha blending
  17080. * @returns a boolean specifying if alpha blending is needed
  17081. */
  17082. needAlphaBlending(): boolean;
  17083. /**
  17084. * Specifies if this material should be rendered in alpha test mode
  17085. * @returns a boolean specifying if an alpha test is needed.
  17086. */
  17087. needAlphaTesting(): boolean;
  17088. private _checkUniform;
  17089. /**
  17090. * Set a texture in the shader.
  17091. * @param name Define the name of the uniform samplers as defined in the shader
  17092. * @param texture Define the texture to bind to this sampler
  17093. * @return the material itself allowing "fluent" like uniform updates
  17094. */
  17095. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  17096. /**
  17097. * Set a texture array in the shader.
  17098. * @param name Define the name of the uniform sampler array as defined in the shader
  17099. * @param textures Define the list of textures to bind to this sampler
  17100. * @return the material itself allowing "fluent" like uniform updates
  17101. */
  17102. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  17103. /**
  17104. * Set a float in the shader.
  17105. * @param name Define the name of the uniform as defined in the shader
  17106. * @param value Define the value to give to the uniform
  17107. * @return the material itself allowing "fluent" like uniform updates
  17108. */
  17109. setFloat(name: string, value: number): ShaderMaterial;
  17110. /**
  17111. * Set a int in the shader.
  17112. * @param name Define the name of the uniform as defined in the shader
  17113. * @param value Define the value to give to the uniform
  17114. * @return the material itself allowing "fluent" like uniform updates
  17115. */
  17116. setInt(name: string, value: number): ShaderMaterial;
  17117. /**
  17118. * Set an array of floats in the shader.
  17119. * @param name Define the name of the uniform as defined in the shader
  17120. * @param value Define the value to give to the uniform
  17121. * @return the material itself allowing "fluent" like uniform updates
  17122. */
  17123. setFloats(name: string, value: number[]): ShaderMaterial;
  17124. /**
  17125. * Set a vec3 in the shader from a Color3.
  17126. * @param name Define the name of the uniform as defined in the shader
  17127. * @param value Define the value to give to the uniform
  17128. * @return the material itself allowing "fluent" like uniform updates
  17129. */
  17130. setColor3(name: string, value: Color3): ShaderMaterial;
  17131. /**
  17132. * Set a vec3 array in the shader from a Color3 array.
  17133. * @param name Define the name of the uniform as defined in the shader
  17134. * @param value Define the value to give to the uniform
  17135. * @return the material itself allowing "fluent" like uniform updates
  17136. */
  17137. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  17138. /**
  17139. * Set a vec4 in the shader from a Color4.
  17140. * @param name Define the name of the uniform as defined in the shader
  17141. * @param value Define the value to give to the uniform
  17142. * @return the material itself allowing "fluent" like uniform updates
  17143. */
  17144. setColor4(name: string, value: Color4): ShaderMaterial;
  17145. /**
  17146. * Set a vec4 array in the shader from a Color4 array.
  17147. * @param name Define the name of the uniform as defined in the shader
  17148. * @param value Define the value to give to the uniform
  17149. * @return the material itself allowing "fluent" like uniform updates
  17150. */
  17151. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  17152. /**
  17153. * Set a vec2 in the shader from a Vector2.
  17154. * @param name Define the name of the uniform as defined in the shader
  17155. * @param value Define the value to give to the uniform
  17156. * @return the material itself allowing "fluent" like uniform updates
  17157. */
  17158. setVector2(name: string, value: Vector2): ShaderMaterial;
  17159. /**
  17160. * Set a vec3 in the shader from a Vector3.
  17161. * @param name Define the name of the uniform as defined in the shader
  17162. * @param value Define the value to give to the uniform
  17163. * @return the material itself allowing "fluent" like uniform updates
  17164. */
  17165. setVector3(name: string, value: Vector3): ShaderMaterial;
  17166. /**
  17167. * Set a vec4 in the shader from a Vector4.
  17168. * @param name Define the name of the uniform as defined in the shader
  17169. * @param value Define the value to give to the uniform
  17170. * @return the material itself allowing "fluent" like uniform updates
  17171. */
  17172. setVector4(name: string, value: Vector4): ShaderMaterial;
  17173. /**
  17174. * Set a mat4 in the shader from a Matrix.
  17175. * @param name Define the name of the uniform as defined in the shader
  17176. * @param value Define the value to give to the uniform
  17177. * @return the material itself allowing "fluent" like uniform updates
  17178. */
  17179. setMatrix(name: string, value: Matrix): ShaderMaterial;
  17180. /**
  17181. * Set a float32Array in the shader from a matrix array.
  17182. * @param name Define the name of the uniform as defined in the shader
  17183. * @param value Define the value to give to the uniform
  17184. * @return the material itself allowing "fluent" like uniform updates
  17185. */
  17186. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  17187. /**
  17188. * Set a mat3 in the shader from a Float32Array.
  17189. * @param name Define the name of the uniform as defined in the shader
  17190. * @param value Define the value to give to the uniform
  17191. * @return the material itself allowing "fluent" like uniform updates
  17192. */
  17193. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  17194. /**
  17195. * Set a mat2 in the shader from a Float32Array.
  17196. * @param name Define the name of the uniform as defined in the shader
  17197. * @param value Define the value to give to the uniform
  17198. * @return the material itself allowing "fluent" like uniform updates
  17199. */
  17200. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  17201. /**
  17202. * Set a vec2 array in the shader from a number array.
  17203. * @param name Define the name of the uniform as defined in the shader
  17204. * @param value Define the value to give to the uniform
  17205. * @return the material itself allowing "fluent" like uniform updates
  17206. */
  17207. setArray2(name: string, value: number[]): ShaderMaterial;
  17208. /**
  17209. * Set a vec3 array in the shader from a number array.
  17210. * @param name Define the name of the uniform as defined in the shader
  17211. * @param value Define the value to give to the uniform
  17212. * @return the material itself allowing "fluent" like uniform updates
  17213. */
  17214. setArray3(name: string, value: number[]): ShaderMaterial;
  17215. /**
  17216. * Set a vec4 array in the shader from a number array.
  17217. * @param name Define the name of the uniform as defined in the shader
  17218. * @param value Define the value to give to the uniform
  17219. * @return the material itself allowing "fluent" like uniform updates
  17220. */
  17221. setArray4(name: string, value: number[]): ShaderMaterial;
  17222. private _checkCache;
  17223. /**
  17224. * Specifies that the submesh is ready to be used
  17225. * @param mesh defines the mesh to check
  17226. * @param subMesh defines which submesh to check
  17227. * @param useInstances specifies that instances should be used
  17228. * @returns a boolean indicating that the submesh is ready or not
  17229. */
  17230. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  17231. /**
  17232. * Checks if the material is ready to render the requested mesh
  17233. * @param mesh Define the mesh to render
  17234. * @param useInstances Define whether or not the material is used with instances
  17235. * @returns true if ready, otherwise false
  17236. */
  17237. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  17238. /**
  17239. * Binds the world matrix to the material
  17240. * @param world defines the world transformation matrix
  17241. * @param effectOverride - If provided, use this effect instead of internal effect
  17242. */
  17243. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  17244. /**
  17245. * Binds the submesh to this material by preparing the effect and shader to draw
  17246. * @param world defines the world transformation matrix
  17247. * @param mesh defines the mesh containing the submesh
  17248. * @param subMesh defines the submesh to bind the material to
  17249. */
  17250. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  17251. /**
  17252. * Binds the material to the mesh
  17253. * @param world defines the world transformation matrix
  17254. * @param mesh defines the mesh to bind the material to
  17255. * @param effectOverride - If provided, use this effect instead of internal effect
  17256. */
  17257. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  17258. protected _afterBind(mesh?: Mesh): void;
  17259. /**
  17260. * Gets the active textures from the material
  17261. * @returns an array of textures
  17262. */
  17263. getActiveTextures(): BaseTexture[];
  17264. /**
  17265. * Specifies if the material uses a texture
  17266. * @param texture defines the texture to check against the material
  17267. * @returns a boolean specifying if the material uses the texture
  17268. */
  17269. hasTexture(texture: BaseTexture): boolean;
  17270. /**
  17271. * Makes a duplicate of the material, and gives it a new name
  17272. * @param name defines the new name for the duplicated material
  17273. * @returns the cloned material
  17274. */
  17275. clone(name: string): ShaderMaterial;
  17276. /**
  17277. * Disposes the material
  17278. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  17279. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  17280. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  17281. */
  17282. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  17283. /**
  17284. * Serializes this material in a JSON representation
  17285. * @returns the serialized material object
  17286. */
  17287. serialize(): any;
  17288. /**
  17289. * Creates a shader material from parsed shader material data
  17290. * @param source defines the JSON represnetation of the material
  17291. * @param scene defines the hosting scene
  17292. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17293. * @returns a new material
  17294. */
  17295. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  17296. /**
  17297. * Creates a new ShaderMaterial from a snippet saved in a remote file
  17298. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  17299. * @param url defines the url to load from
  17300. * @param scene defines the hosting scene
  17301. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17302. * @returns a promise that will resolve to the new ShaderMaterial
  17303. */
  17304. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17305. /**
  17306. * Creates a ShaderMaterial from a snippet saved by the Inspector
  17307. * @param snippetId defines the snippet to load
  17308. * @param scene defines the hosting scene
  17309. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17310. * @returns a promise that will resolve to the new ShaderMaterial
  17311. */
  17312. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17313. }
  17314. }
  17315. declare module "babylonjs/Shaders/color.fragment" {
  17316. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  17317. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  17318. /** @hidden */
  17319. export var colorPixelShader: {
  17320. name: string;
  17321. shader: string;
  17322. };
  17323. }
  17324. declare module "babylonjs/Shaders/color.vertex" {
  17325. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  17326. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  17327. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17328. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17329. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  17330. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  17331. /** @hidden */
  17332. export var colorVertexShader: {
  17333. name: string;
  17334. shader: string;
  17335. };
  17336. }
  17337. declare module "babylonjs/Meshes/linesMesh" {
  17338. import { Nullable } from "babylonjs/types";
  17339. import { Scene } from "babylonjs/scene";
  17340. import { Color3 } from "babylonjs/Maths/math.color";
  17341. import { Node } from "babylonjs/node";
  17342. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17343. import { Mesh } from "babylonjs/Meshes/mesh";
  17344. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  17345. import { Effect } from "babylonjs/Materials/effect";
  17346. import { Material } from "babylonjs/Materials/material";
  17347. import "babylonjs/Shaders/color.fragment";
  17348. import "babylonjs/Shaders/color.vertex";
  17349. /**
  17350. * Line mesh
  17351. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  17352. */
  17353. export class LinesMesh extends Mesh {
  17354. /**
  17355. * If vertex color should be applied to the mesh
  17356. */
  17357. readonly useVertexColor?: boolean | undefined;
  17358. /**
  17359. * If vertex alpha should be applied to the mesh
  17360. */
  17361. readonly useVertexAlpha?: boolean | undefined;
  17362. /**
  17363. * Color of the line (Default: White)
  17364. */
  17365. color: Color3;
  17366. /**
  17367. * Alpha of the line (Default: 1)
  17368. */
  17369. alpha: number;
  17370. /**
  17371. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17372. * This margin is expressed in world space coordinates, so its value may vary.
  17373. * Default value is 0.1
  17374. */
  17375. intersectionThreshold: number;
  17376. private _colorShader;
  17377. private color4;
  17378. /**
  17379. * Creates a new LinesMesh
  17380. * @param name defines the name
  17381. * @param scene defines the hosting scene
  17382. * @param parent defines the parent mesh if any
  17383. * @param source defines the optional source LinesMesh used to clone data from
  17384. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  17385. * When false, achieved by calling a clone(), also passing False.
  17386. * This will make creation of children, recursive.
  17387. * @param useVertexColor defines if this LinesMesh supports vertex color
  17388. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  17389. */
  17390. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  17391. /**
  17392. * If vertex color should be applied to the mesh
  17393. */
  17394. useVertexColor?: boolean | undefined,
  17395. /**
  17396. * If vertex alpha should be applied to the mesh
  17397. */
  17398. useVertexAlpha?: boolean | undefined);
  17399. private _addClipPlaneDefine;
  17400. private _removeClipPlaneDefine;
  17401. isReady(): boolean;
  17402. /**
  17403. * Returns the string "LineMesh"
  17404. */
  17405. getClassName(): string;
  17406. /**
  17407. * @hidden
  17408. */
  17409. get material(): Material;
  17410. /**
  17411. * @hidden
  17412. */
  17413. set material(value: Material);
  17414. /**
  17415. * @hidden
  17416. */
  17417. get checkCollisions(): boolean;
  17418. /** @hidden */
  17419. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  17420. /** @hidden */
  17421. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  17422. /**
  17423. * Disposes of the line mesh
  17424. * @param doNotRecurse If children should be disposed
  17425. */
  17426. dispose(doNotRecurse?: boolean): void;
  17427. /**
  17428. * Returns a new LineMesh object cloned from the current one.
  17429. */
  17430. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  17431. /**
  17432. * Creates a new InstancedLinesMesh object from the mesh model.
  17433. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  17434. * @param name defines the name of the new instance
  17435. * @returns a new InstancedLinesMesh
  17436. */
  17437. createInstance(name: string): InstancedLinesMesh;
  17438. }
  17439. /**
  17440. * Creates an instance based on a source LinesMesh
  17441. */
  17442. export class InstancedLinesMesh extends InstancedMesh {
  17443. /**
  17444. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17445. * This margin is expressed in world space coordinates, so its value may vary.
  17446. * Initilized with the intersectionThreshold value of the source LinesMesh
  17447. */
  17448. intersectionThreshold: number;
  17449. constructor(name: string, source: LinesMesh);
  17450. /**
  17451. * Returns the string "InstancedLinesMesh".
  17452. */
  17453. getClassName(): string;
  17454. }
  17455. }
  17456. declare module "babylonjs/Shaders/line.fragment" {
  17457. /** @hidden */
  17458. export var linePixelShader: {
  17459. name: string;
  17460. shader: string;
  17461. };
  17462. }
  17463. declare module "babylonjs/Shaders/line.vertex" {
  17464. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17465. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17466. /** @hidden */
  17467. export var lineVertexShader: {
  17468. name: string;
  17469. shader: string;
  17470. };
  17471. }
  17472. declare module "babylonjs/Rendering/edgesRenderer" {
  17473. import { Nullable } from "babylonjs/types";
  17474. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  17475. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17476. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17477. import { IDisposable } from "babylonjs/scene";
  17478. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  17479. import "babylonjs/Shaders/line.fragment";
  17480. import "babylonjs/Shaders/line.vertex";
  17481. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  17482. import { SmartArray } from "babylonjs/Misc/smartArray";
  17483. module "babylonjs/scene" {
  17484. interface Scene {
  17485. /** @hidden */
  17486. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  17487. }
  17488. }
  17489. module "babylonjs/Meshes/abstractMesh" {
  17490. interface AbstractMesh {
  17491. /**
  17492. * Gets the edgesRenderer associated with the mesh
  17493. */
  17494. edgesRenderer: Nullable<EdgesRenderer>;
  17495. }
  17496. }
  17497. module "babylonjs/Meshes/linesMesh" {
  17498. interface LinesMesh {
  17499. /**
  17500. * Enables the edge rendering mode on the mesh.
  17501. * This mode makes the mesh edges visible
  17502. * @param epsilon defines the maximal distance between two angles to detect a face
  17503. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17504. * @returns the currentAbstractMesh
  17505. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17506. */
  17507. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  17508. }
  17509. }
  17510. module "babylonjs/Meshes/linesMesh" {
  17511. interface InstancedLinesMesh {
  17512. /**
  17513. * Enables the edge rendering mode on the mesh.
  17514. * This mode makes the mesh edges visible
  17515. * @param epsilon defines the maximal distance between two angles to detect a face
  17516. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17517. * @returns the current InstancedLinesMesh
  17518. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17519. */
  17520. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  17521. }
  17522. }
  17523. /**
  17524. * Defines the minimum contract an Edges renderer should follow.
  17525. */
  17526. export interface IEdgesRenderer extends IDisposable {
  17527. /**
  17528. * Gets or sets a boolean indicating if the edgesRenderer is active
  17529. */
  17530. isEnabled: boolean;
  17531. /**
  17532. * Renders the edges of the attached mesh,
  17533. */
  17534. render(): void;
  17535. /**
  17536. * Checks wether or not the edges renderer is ready to render.
  17537. * @return true if ready, otherwise false.
  17538. */
  17539. isReady(): boolean;
  17540. /**
  17541. * List of instances to render in case the source mesh has instances
  17542. */
  17543. customInstances: SmartArray<Matrix>;
  17544. }
  17545. /**
  17546. * Defines the additional options of the edges renderer
  17547. */
  17548. export interface IEdgesRendererOptions {
  17549. /**
  17550. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  17551. * If not defined, the default value is true
  17552. */
  17553. useAlternateEdgeFinder?: boolean;
  17554. /**
  17555. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  17556. * If not defined, the default value is true.
  17557. * 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)
  17558. * This option is used only if useAlternateEdgeFinder = true
  17559. */
  17560. useFastVertexMerger?: boolean;
  17561. /**
  17562. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  17563. * The default value is 1e-6
  17564. * This option is used only if useAlternateEdgeFinder = true
  17565. */
  17566. epsilonVertexMerge?: number;
  17567. /**
  17568. * 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
  17569. * 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.
  17570. * This option is used only if useAlternateEdgeFinder = true
  17571. */
  17572. applyTessellation?: boolean;
  17573. /**
  17574. * 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
  17575. * The default value is 1e-6
  17576. * This option is used only if useAlternateEdgeFinder = true
  17577. */
  17578. epsilonVertexAligned?: number;
  17579. }
  17580. /**
  17581. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  17582. */
  17583. export class EdgesRenderer implements IEdgesRenderer {
  17584. /**
  17585. * Define the size of the edges with an orthographic camera
  17586. */
  17587. edgesWidthScalerForOrthographic: number;
  17588. /**
  17589. * Define the size of the edges with a perspective camera
  17590. */
  17591. edgesWidthScalerForPerspective: number;
  17592. protected _source: AbstractMesh;
  17593. protected _linesPositions: number[];
  17594. protected _linesNormals: number[];
  17595. protected _linesIndices: number[];
  17596. protected _epsilon: number;
  17597. protected _indicesCount: number;
  17598. protected _lineShader: ShaderMaterial;
  17599. protected _ib: DataBuffer;
  17600. protected _buffers: {
  17601. [key: string]: Nullable<VertexBuffer>;
  17602. };
  17603. protected _buffersForInstances: {
  17604. [key: string]: Nullable<VertexBuffer>;
  17605. };
  17606. protected _checkVerticesInsteadOfIndices: boolean;
  17607. protected _options: Nullable<IEdgesRendererOptions>;
  17608. private _meshRebuildObserver;
  17609. private _meshDisposeObserver;
  17610. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  17611. isEnabled: boolean;
  17612. /**
  17613. * List of instances to render in case the source mesh has instances
  17614. */
  17615. customInstances: SmartArray<Matrix>;
  17616. private static GetShader;
  17617. /**
  17618. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  17619. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  17620. * @param source Mesh used to create edges
  17621. * @param epsilon sum of angles in adjacency to check for edge
  17622. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  17623. * @param generateEdgesLines - should generate Lines or only prepare resources.
  17624. * @param options The options to apply when generating the edges
  17625. */
  17626. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  17627. protected _prepareRessources(): void;
  17628. /** @hidden */
  17629. _rebuild(): void;
  17630. /**
  17631. * Releases the required resources for the edges renderer
  17632. */
  17633. dispose(): void;
  17634. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  17635. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  17636. /**
  17637. * Checks if the pair of p0 and p1 is en edge
  17638. * @param faceIndex
  17639. * @param edge
  17640. * @param faceNormals
  17641. * @param p0
  17642. * @param p1
  17643. * @private
  17644. */
  17645. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  17646. /**
  17647. * push line into the position, normal and index buffer
  17648. * @protected
  17649. */
  17650. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  17651. /**
  17652. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  17653. */
  17654. private _tessellateTriangle;
  17655. private _generateEdgesLinesAlternate;
  17656. /**
  17657. * Generates lines edges from adjacencjes
  17658. * @private
  17659. */
  17660. _generateEdgesLines(): void;
  17661. /**
  17662. * Checks wether or not the edges renderer is ready to render.
  17663. * @return true if ready, otherwise false.
  17664. */
  17665. isReady(): boolean;
  17666. /**
  17667. * Renders the edges of the attached mesh,
  17668. */
  17669. render(): void;
  17670. }
  17671. /**
  17672. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  17673. */
  17674. export class LineEdgesRenderer extends EdgesRenderer {
  17675. /**
  17676. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  17677. * @param source LineMesh used to generate edges
  17678. * @param epsilon not important (specified angle for edge detection)
  17679. * @param checkVerticesInsteadOfIndices not important for LineMesh
  17680. */
  17681. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  17682. /**
  17683. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  17684. */
  17685. _generateEdgesLines(): void;
  17686. }
  17687. }
  17688. declare module "babylonjs/Rendering/renderingGroup" {
  17689. import { SmartArray, SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  17690. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17691. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17692. import { Nullable } from "babylonjs/types";
  17693. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17694. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  17695. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17696. import { Material } from "babylonjs/Materials/material";
  17697. import { Scene } from "babylonjs/scene";
  17698. /**
  17699. * This represents the object necessary to create a rendering group.
  17700. * This is exclusively used and created by the rendering manager.
  17701. * To modify the behavior, you use the available helpers in your scene or meshes.
  17702. * @hidden
  17703. */
  17704. export class RenderingGroup {
  17705. index: number;
  17706. private static _zeroVector;
  17707. private _scene;
  17708. private _opaqueSubMeshes;
  17709. private _transparentSubMeshes;
  17710. private _alphaTestSubMeshes;
  17711. private _depthOnlySubMeshes;
  17712. private _particleSystems;
  17713. private _spriteManagers;
  17714. private _opaqueSortCompareFn;
  17715. private _alphaTestSortCompareFn;
  17716. private _transparentSortCompareFn;
  17717. private _renderOpaque;
  17718. private _renderAlphaTest;
  17719. private _renderTransparent;
  17720. /** @hidden */
  17721. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  17722. onBeforeTransparentRendering: () => void;
  17723. /**
  17724. * Set the opaque sort comparison function.
  17725. * If null the sub meshes will be render in the order they were created
  17726. */
  17727. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17728. /**
  17729. * Set the alpha test sort comparison function.
  17730. * If null the sub meshes will be render in the order they were created
  17731. */
  17732. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17733. /**
  17734. * Set the transparent sort comparison function.
  17735. * If null the sub meshes will be render in the order they were created
  17736. */
  17737. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17738. /**
  17739. * Creates a new rendering group.
  17740. * @param index The rendering group index
  17741. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  17742. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  17743. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  17744. */
  17745. 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>);
  17746. /**
  17747. * Render all the sub meshes contained in the group.
  17748. * @param customRenderFunction Used to override the default render behaviour of the group.
  17749. * @returns true if rendered some submeshes.
  17750. */
  17751. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  17752. /**
  17753. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  17754. * @param subMeshes The submeshes to render
  17755. */
  17756. private renderOpaqueSorted;
  17757. /**
  17758. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  17759. * @param subMeshes The submeshes to render
  17760. */
  17761. private renderAlphaTestSorted;
  17762. /**
  17763. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  17764. * @param subMeshes The submeshes to render
  17765. */
  17766. private renderTransparentSorted;
  17767. /**
  17768. * Renders the submeshes in a specified order.
  17769. * @param subMeshes The submeshes to sort before render
  17770. * @param sortCompareFn The comparison function use to sort
  17771. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  17772. * @param transparent Specifies to activate blending if true
  17773. */
  17774. private static renderSorted;
  17775. /**
  17776. * Renders the submeshes in the order they were dispatched (no sort applied).
  17777. * @param subMeshes The submeshes to render
  17778. */
  17779. private static renderUnsorted;
  17780. /**
  17781. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17782. * are rendered back to front if in the same alpha index.
  17783. *
  17784. * @param a The first submesh
  17785. * @param b The second submesh
  17786. * @returns The result of the comparison
  17787. */
  17788. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  17789. /**
  17790. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17791. * are rendered back to front.
  17792. *
  17793. * @param a The first submesh
  17794. * @param b The second submesh
  17795. * @returns The result of the comparison
  17796. */
  17797. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  17798. /**
  17799. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17800. * are rendered front to back (prevent overdraw).
  17801. *
  17802. * @param a The first submesh
  17803. * @param b The second submesh
  17804. * @returns The result of the comparison
  17805. */
  17806. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  17807. /**
  17808. * Resets the different lists of submeshes to prepare a new frame.
  17809. */
  17810. prepare(): void;
  17811. dispose(): void;
  17812. /**
  17813. * Inserts the submesh in its correct queue depending on its material.
  17814. * @param subMesh The submesh to dispatch
  17815. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17816. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17817. */
  17818. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17819. dispatchSprites(spriteManager: ISpriteManager): void;
  17820. dispatchParticles(particleSystem: IParticleSystem): void;
  17821. private _renderParticles;
  17822. private _renderSprites;
  17823. }
  17824. }
  17825. declare module "babylonjs/Rendering/renderingManager" {
  17826. import { Nullable } from "babylonjs/types";
  17827. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17828. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17829. import { SmartArray } from "babylonjs/Misc/smartArray";
  17830. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17831. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17832. import { Material } from "babylonjs/Materials/material";
  17833. import { Scene } from "babylonjs/scene";
  17834. import { Camera } from "babylonjs/Cameras/camera";
  17835. /**
  17836. * Interface describing the different options available in the rendering manager
  17837. * regarding Auto Clear between groups.
  17838. */
  17839. export interface IRenderingManagerAutoClearSetup {
  17840. /**
  17841. * Defines whether or not autoclear is enable.
  17842. */
  17843. autoClear: boolean;
  17844. /**
  17845. * Defines whether or not to autoclear the depth buffer.
  17846. */
  17847. depth: boolean;
  17848. /**
  17849. * Defines whether or not to autoclear the stencil buffer.
  17850. */
  17851. stencil: boolean;
  17852. }
  17853. /**
  17854. * This class is used by the onRenderingGroupObservable
  17855. */
  17856. export class RenderingGroupInfo {
  17857. /**
  17858. * The Scene that being rendered
  17859. */
  17860. scene: Scene;
  17861. /**
  17862. * The camera currently used for the rendering pass
  17863. */
  17864. camera: Nullable<Camera>;
  17865. /**
  17866. * The ID of the renderingGroup being processed
  17867. */
  17868. renderingGroupId: number;
  17869. }
  17870. /**
  17871. * This is the manager responsible of all the rendering for meshes sprites and particles.
  17872. * It is enable to manage the different groups as well as the different necessary sort functions.
  17873. * This should not be used directly aside of the few static configurations
  17874. */
  17875. export class RenderingManager {
  17876. /**
  17877. * The max id used for rendering groups (not included)
  17878. */
  17879. static MAX_RENDERINGGROUPS: number;
  17880. /**
  17881. * The min id used for rendering groups (included)
  17882. */
  17883. static MIN_RENDERINGGROUPS: number;
  17884. /**
  17885. * Used to globally prevent autoclearing scenes.
  17886. */
  17887. static AUTOCLEAR: boolean;
  17888. /**
  17889. * @hidden
  17890. */
  17891. _useSceneAutoClearSetup: boolean;
  17892. private _scene;
  17893. private _renderingGroups;
  17894. private _depthStencilBufferAlreadyCleaned;
  17895. private _autoClearDepthStencil;
  17896. private _customOpaqueSortCompareFn;
  17897. private _customAlphaTestSortCompareFn;
  17898. private _customTransparentSortCompareFn;
  17899. private _renderingGroupInfo;
  17900. /**
  17901. * Instantiates a new rendering group for a particular scene
  17902. * @param scene Defines the scene the groups belongs to
  17903. */
  17904. constructor(scene: Scene);
  17905. private _clearDepthStencilBuffer;
  17906. /**
  17907. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  17908. * @hidden
  17909. */
  17910. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  17911. /**
  17912. * Resets the different information of the group to prepare a new frame
  17913. * @hidden
  17914. */
  17915. reset(): void;
  17916. /**
  17917. * Dispose and release the group and its associated resources.
  17918. * @hidden
  17919. */
  17920. dispose(): void;
  17921. /**
  17922. * Clear the info related to rendering groups preventing retention points during dispose.
  17923. */
  17924. freeRenderingGroups(): void;
  17925. private _prepareRenderingGroup;
  17926. /**
  17927. * Add a sprite manager to the rendering manager in order to render it this frame.
  17928. * @param spriteManager Define the sprite manager to render
  17929. */
  17930. dispatchSprites(spriteManager: ISpriteManager): void;
  17931. /**
  17932. * Add a particle system to the rendering manager in order to render it this frame.
  17933. * @param particleSystem Define the particle system to render
  17934. */
  17935. dispatchParticles(particleSystem: IParticleSystem): void;
  17936. /**
  17937. * Add a submesh to the manager in order to render it this frame
  17938. * @param subMesh The submesh to dispatch
  17939. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17940. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17941. */
  17942. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17943. /**
  17944. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  17945. * This allowed control for front to back rendering or reversly depending of the special needs.
  17946. *
  17947. * @param renderingGroupId The rendering group id corresponding to its index
  17948. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  17949. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  17950. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  17951. */
  17952. 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;
  17953. /**
  17954. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  17955. *
  17956. * @param renderingGroupId The rendering group id corresponding to its index
  17957. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  17958. * @param depth Automatically clears depth between groups if true and autoClear is true.
  17959. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  17960. */
  17961. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  17962. /**
  17963. * Gets the current auto clear configuration for one rendering group of the rendering
  17964. * manager.
  17965. * @param index the rendering group index to get the information for
  17966. * @returns The auto clear setup for the requested rendering group
  17967. */
  17968. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  17969. }
  17970. }
  17971. declare module "babylonjs/Lights/Shadows/shadowGenerator" {
  17972. import { SmartArray } from "babylonjs/Misc/smartArray";
  17973. import { Nullable } from "babylonjs/types";
  17974. import { Scene } from "babylonjs/scene";
  17975. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  17976. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17977. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17978. import { Mesh } from "babylonjs/Meshes/mesh";
  17979. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  17980. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  17981. import { Effect } from "babylonjs/Materials/effect";
  17982. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  17983. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  17984. import "babylonjs/Shaders/shadowMap.fragment";
  17985. import "babylonjs/Shaders/shadowMap.vertex";
  17986. import "babylonjs/Shaders/depthBoxBlur.fragment";
  17987. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow";
  17988. import { Observable } from "babylonjs/Misc/observable";
  17989. /**
  17990. * Defines the options associated with the creation of a custom shader for a shadow generator.
  17991. */
  17992. export interface ICustomShaderOptions {
  17993. /**
  17994. * Gets or sets the custom shader name to use
  17995. */
  17996. shaderName: string;
  17997. /**
  17998. * The list of attribute names used in the shader
  17999. */
  18000. attributes?: string[];
  18001. /**
  18002. * The list of unifrom names used in the shader
  18003. */
  18004. uniforms?: string[];
  18005. /**
  18006. * The list of sampler names used in the shader
  18007. */
  18008. samplers?: string[];
  18009. /**
  18010. * The list of defines used in the shader
  18011. */
  18012. defines?: string[];
  18013. }
  18014. /**
  18015. * Interface to implement to create a shadow generator compatible with BJS.
  18016. */
  18017. export interface IShadowGenerator {
  18018. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  18019. id: string;
  18020. /**
  18021. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  18022. * @returns The render target texture if present otherwise, null
  18023. */
  18024. getShadowMap(): Nullable<RenderTargetTexture>;
  18025. /**
  18026. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  18027. * @param subMesh The submesh we want to render in the shadow map
  18028. * @param useInstances Defines wether will draw in the map using instances
  18029. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  18030. * @returns true if ready otherwise, false
  18031. */
  18032. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  18033. /**
  18034. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  18035. * @param defines Defines of the material we want to update
  18036. * @param lightIndex Index of the light in the enabled light list of the material
  18037. */
  18038. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  18039. /**
  18040. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  18041. * defined in the generator but impacting the effect).
  18042. * It implies the unifroms available on the materials are the standard BJS ones.
  18043. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  18044. * @param effect The effect we are binfing the information for
  18045. */
  18046. bindShadowLight(lightIndex: string, effect: Effect): void;
  18047. /**
  18048. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  18049. * (eq to shadow prjection matrix * light transform matrix)
  18050. * @returns The transform matrix used to create the shadow map
  18051. */
  18052. getTransformMatrix(): Matrix;
  18053. /**
  18054. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  18055. * Cube and 2D textures for instance.
  18056. */
  18057. recreateShadowMap(): void;
  18058. /**
  18059. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18060. * @param onCompiled Callback triggered at the and of the effects compilation
  18061. * @param options Sets of optional options forcing the compilation with different modes
  18062. */
  18063. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  18064. useInstances: boolean;
  18065. }>): void;
  18066. /**
  18067. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18068. * @param options Sets of optional options forcing the compilation with different modes
  18069. * @returns A promise that resolves when the compilation completes
  18070. */
  18071. forceCompilationAsync(options?: Partial<{
  18072. useInstances: boolean;
  18073. }>): Promise<void>;
  18074. /**
  18075. * Serializes the shadow generator setup to a json object.
  18076. * @returns The serialized JSON object
  18077. */
  18078. serialize(): any;
  18079. /**
  18080. * Disposes the Shadow map and related Textures and effects.
  18081. */
  18082. dispose(): void;
  18083. }
  18084. /**
  18085. * Default implementation IShadowGenerator.
  18086. * This is the main object responsible of generating shadows in the framework.
  18087. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  18088. */
  18089. export class ShadowGenerator implements IShadowGenerator {
  18090. /**
  18091. * Name of the shadow generator class
  18092. */
  18093. static CLASSNAME: string;
  18094. /**
  18095. * Shadow generator mode None: no filtering applied.
  18096. */
  18097. static readonly FILTER_NONE: number;
  18098. /**
  18099. * Shadow generator mode ESM: Exponential Shadow Mapping.
  18100. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18101. */
  18102. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  18103. /**
  18104. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  18105. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  18106. */
  18107. static readonly FILTER_POISSONSAMPLING: number;
  18108. /**
  18109. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  18110. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18111. */
  18112. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  18113. /**
  18114. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  18115. * edge artifacts on steep falloff.
  18116. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18117. */
  18118. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  18119. /**
  18120. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  18121. * edge artifacts on steep falloff.
  18122. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18123. */
  18124. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  18125. /**
  18126. * Shadow generator mode PCF: Percentage Closer Filtering
  18127. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  18128. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  18129. */
  18130. static readonly FILTER_PCF: number;
  18131. /**
  18132. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  18133. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  18134. * Contact Hardening
  18135. */
  18136. static readonly FILTER_PCSS: number;
  18137. /**
  18138. * Reserved for PCF and PCSS
  18139. * Highest Quality.
  18140. *
  18141. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  18142. *
  18143. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  18144. */
  18145. static readonly QUALITY_HIGH: number;
  18146. /**
  18147. * Reserved for PCF and PCSS
  18148. * Good tradeoff for quality/perf cross devices
  18149. *
  18150. * Execute PCF on a 3*3 kernel.
  18151. *
  18152. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  18153. */
  18154. static readonly QUALITY_MEDIUM: number;
  18155. /**
  18156. * Reserved for PCF and PCSS
  18157. * The lowest quality but the fastest.
  18158. *
  18159. * Execute PCF on a 1*1 kernel.
  18160. *
  18161. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  18162. */
  18163. static readonly QUALITY_LOW: number;
  18164. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  18165. id: string;
  18166. /** Gets or sets the custom shader name to use */
  18167. customShaderOptions: ICustomShaderOptions;
  18168. /**
  18169. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  18170. */
  18171. onBeforeShadowMapRenderObservable: Observable<Effect>;
  18172. /**
  18173. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  18174. */
  18175. onAfterShadowMapRenderObservable: Observable<Effect>;
  18176. /**
  18177. * Observable triggered before a mesh is rendered in the shadow map.
  18178. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  18179. */
  18180. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  18181. /**
  18182. * Observable triggered after a mesh is rendered in the shadow map.
  18183. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  18184. */
  18185. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  18186. protected _bias: number;
  18187. /**
  18188. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  18189. */
  18190. get bias(): number;
  18191. /**
  18192. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  18193. */
  18194. set bias(bias: number);
  18195. protected _normalBias: number;
  18196. /**
  18197. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  18198. */
  18199. get normalBias(): number;
  18200. /**
  18201. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  18202. */
  18203. set normalBias(normalBias: number);
  18204. protected _blurBoxOffset: number;
  18205. /**
  18206. * Gets the blur box offset: offset applied during the blur pass.
  18207. * Only useful if useKernelBlur = false
  18208. */
  18209. get blurBoxOffset(): number;
  18210. /**
  18211. * Sets the blur box offset: offset applied during the blur pass.
  18212. * Only useful if useKernelBlur = false
  18213. */
  18214. set blurBoxOffset(value: number);
  18215. protected _blurScale: number;
  18216. /**
  18217. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  18218. * 2 means half of the size.
  18219. */
  18220. get blurScale(): number;
  18221. /**
  18222. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  18223. * 2 means half of the size.
  18224. */
  18225. set blurScale(value: number);
  18226. protected _blurKernel: number;
  18227. /**
  18228. * Gets the blur kernel: kernel size of the blur pass.
  18229. * Only useful if useKernelBlur = true
  18230. */
  18231. get blurKernel(): number;
  18232. /**
  18233. * Sets the blur kernel: kernel size of the blur pass.
  18234. * Only useful if useKernelBlur = true
  18235. */
  18236. set blurKernel(value: number);
  18237. protected _useKernelBlur: boolean;
  18238. /**
  18239. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  18240. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18241. */
  18242. get useKernelBlur(): boolean;
  18243. /**
  18244. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  18245. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18246. */
  18247. set useKernelBlur(value: boolean);
  18248. protected _depthScale: number;
  18249. /**
  18250. * Gets the depth scale used in ESM mode.
  18251. */
  18252. get depthScale(): number;
  18253. /**
  18254. * Sets the depth scale used in ESM mode.
  18255. * This can override the scale stored on the light.
  18256. */
  18257. set depthScale(value: number);
  18258. protected _validateFilter(filter: number): number;
  18259. protected _filter: number;
  18260. /**
  18261. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  18262. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18263. */
  18264. get filter(): number;
  18265. /**
  18266. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  18267. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18268. */
  18269. set filter(value: number);
  18270. /**
  18271. * Gets if the current filter is set to Poisson Sampling.
  18272. */
  18273. get usePoissonSampling(): boolean;
  18274. /**
  18275. * Sets the current filter to Poisson Sampling.
  18276. */
  18277. set usePoissonSampling(value: boolean);
  18278. /**
  18279. * Gets if the current filter is set to ESM.
  18280. */
  18281. get useExponentialShadowMap(): boolean;
  18282. /**
  18283. * Sets the current filter is to ESM.
  18284. */
  18285. set useExponentialShadowMap(value: boolean);
  18286. /**
  18287. * Gets if the current filter is set to filtered ESM.
  18288. */
  18289. get useBlurExponentialShadowMap(): boolean;
  18290. /**
  18291. * Gets if the current filter is set to filtered ESM.
  18292. */
  18293. set useBlurExponentialShadowMap(value: boolean);
  18294. /**
  18295. * Gets if the current filter is set to "close ESM" (using the inverse of the
  18296. * exponential to prevent steep falloff artifacts).
  18297. */
  18298. get useCloseExponentialShadowMap(): boolean;
  18299. /**
  18300. * Sets the current filter to "close ESM" (using the inverse of the
  18301. * exponential to prevent steep falloff artifacts).
  18302. */
  18303. set useCloseExponentialShadowMap(value: boolean);
  18304. /**
  18305. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  18306. * exponential to prevent steep falloff artifacts).
  18307. */
  18308. get useBlurCloseExponentialShadowMap(): boolean;
  18309. /**
  18310. * Sets the current filter to filtered "close ESM" (using the inverse of the
  18311. * exponential to prevent steep falloff artifacts).
  18312. */
  18313. set useBlurCloseExponentialShadowMap(value: boolean);
  18314. /**
  18315. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  18316. */
  18317. get usePercentageCloserFiltering(): boolean;
  18318. /**
  18319. * Sets the current filter to "PCF" (percentage closer filtering).
  18320. */
  18321. set usePercentageCloserFiltering(value: boolean);
  18322. protected _filteringQuality: number;
  18323. /**
  18324. * Gets the PCF or PCSS Quality.
  18325. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18326. */
  18327. get filteringQuality(): number;
  18328. /**
  18329. * Sets the PCF or PCSS Quality.
  18330. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18331. */
  18332. set filteringQuality(filteringQuality: number);
  18333. /**
  18334. * Gets if the current filter is set to "PCSS" (contact hardening).
  18335. */
  18336. get useContactHardeningShadow(): boolean;
  18337. /**
  18338. * Sets the current filter to "PCSS" (contact hardening).
  18339. */
  18340. set useContactHardeningShadow(value: boolean);
  18341. protected _contactHardeningLightSizeUVRatio: number;
  18342. /**
  18343. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18344. * Using a ratio helps keeping shape stability independently of the map size.
  18345. *
  18346. * It does not account for the light projection as it was having too much
  18347. * instability during the light setup or during light position changes.
  18348. *
  18349. * Only valid if useContactHardeningShadow is true.
  18350. */
  18351. get contactHardeningLightSizeUVRatio(): number;
  18352. /**
  18353. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18354. * Using a ratio helps keeping shape stability independently of the map size.
  18355. *
  18356. * It does not account for the light projection as it was having too much
  18357. * instability during the light setup or during light position changes.
  18358. *
  18359. * Only valid if useContactHardeningShadow is true.
  18360. */
  18361. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  18362. protected _darkness: number;
  18363. /** Gets or sets the actual darkness of a shadow */
  18364. get darkness(): number;
  18365. set darkness(value: number);
  18366. /**
  18367. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  18368. * 0 means strongest and 1 would means no shadow.
  18369. * @returns the darkness.
  18370. */
  18371. getDarkness(): number;
  18372. /**
  18373. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  18374. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  18375. * @returns the shadow generator allowing fluent coding.
  18376. */
  18377. setDarkness(darkness: number): ShadowGenerator;
  18378. protected _transparencyShadow: boolean;
  18379. /** Gets or sets the ability to have transparent shadow */
  18380. get transparencyShadow(): boolean;
  18381. set transparencyShadow(value: boolean);
  18382. /**
  18383. * Sets the ability to have transparent shadow (boolean).
  18384. * @param transparent True if transparent else False
  18385. * @returns the shadow generator allowing fluent coding
  18386. */
  18387. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  18388. /**
  18389. * Enables or disables shadows with varying strength based on the transparency
  18390. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  18391. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  18392. * mesh.visibility * alphaTexture.a
  18393. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  18394. */
  18395. enableSoftTransparentShadow: boolean;
  18396. protected _shadowMap: Nullable<RenderTargetTexture>;
  18397. protected _shadowMap2: Nullable<RenderTargetTexture>;
  18398. /**
  18399. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  18400. * @returns The render target texture if present otherwise, null
  18401. */
  18402. getShadowMap(): Nullable<RenderTargetTexture>;
  18403. /**
  18404. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  18405. * @returns The render target texture if the shadow map is present otherwise, null
  18406. */
  18407. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  18408. /**
  18409. * Gets the class name of that object
  18410. * @returns "ShadowGenerator"
  18411. */
  18412. getClassName(): string;
  18413. /**
  18414. * Helper function to add a mesh and its descendants to the list of shadow casters.
  18415. * @param mesh Mesh to add
  18416. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  18417. * @returns the Shadow Generator itself
  18418. */
  18419. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18420. /**
  18421. * Helper function to remove a mesh and its descendants from the list of shadow casters
  18422. * @param mesh Mesh to remove
  18423. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  18424. * @returns the Shadow Generator itself
  18425. */
  18426. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18427. /**
  18428. * Controls the extent to which the shadows fade out at the edge of the frustum
  18429. */
  18430. frustumEdgeFalloff: number;
  18431. protected _light: IShadowLight;
  18432. /**
  18433. * Returns the associated light object.
  18434. * @returns the light generating the shadow
  18435. */
  18436. getLight(): IShadowLight;
  18437. /**
  18438. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  18439. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  18440. * It might on the other hand introduce peter panning.
  18441. */
  18442. forceBackFacesOnly: boolean;
  18443. protected _scene: Scene;
  18444. protected _lightDirection: Vector3;
  18445. protected _effect: Effect;
  18446. protected _viewMatrix: Matrix;
  18447. protected _projectionMatrix: Matrix;
  18448. protected _transformMatrix: Matrix;
  18449. protected _cachedPosition: Vector3;
  18450. protected _cachedDirection: Vector3;
  18451. protected _cachedDefines: string;
  18452. protected _currentRenderID: number;
  18453. protected _boxBlurPostprocess: Nullable<PostProcess>;
  18454. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  18455. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  18456. protected _blurPostProcesses: PostProcess[];
  18457. protected _mapSize: number;
  18458. protected _currentFaceIndex: number;
  18459. protected _currentFaceIndexCache: number;
  18460. protected _textureType: number;
  18461. protected _defaultTextureMatrix: Matrix;
  18462. protected _storedUniqueId: Nullable<number>;
  18463. /** @hidden */
  18464. static _SceneComponentInitialization: (scene: Scene) => void;
  18465. /**
  18466. * Creates a ShadowGenerator object.
  18467. * A ShadowGenerator is the required tool to use the shadows.
  18468. * Each light casting shadows needs to use its own ShadowGenerator.
  18469. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  18470. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  18471. * @param light The light object generating the shadows.
  18472. * @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.
  18473. */
  18474. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  18475. protected _initializeGenerator(): void;
  18476. protected _createTargetRenderTexture(): void;
  18477. protected _initializeShadowMap(): void;
  18478. protected _initializeBlurRTTAndPostProcesses(): void;
  18479. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  18480. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  18481. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  18482. protected _applyFilterValues(): void;
  18483. /**
  18484. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18485. * @param onCompiled Callback triggered at the and of the effects compilation
  18486. * @param options Sets of optional options forcing the compilation with different modes
  18487. */
  18488. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  18489. useInstances: boolean;
  18490. }>): void;
  18491. /**
  18492. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18493. * @param options Sets of optional options forcing the compilation with different modes
  18494. * @returns A promise that resolves when the compilation completes
  18495. */
  18496. forceCompilationAsync(options?: Partial<{
  18497. useInstances: boolean;
  18498. }>): Promise<void>;
  18499. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  18500. private _prepareShadowDefines;
  18501. /**
  18502. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  18503. * @param subMesh The submesh we want to render in the shadow map
  18504. * @param useInstances Defines wether will draw in the map using instances
  18505. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  18506. * @returns true if ready otherwise, false
  18507. */
  18508. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  18509. /**
  18510. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  18511. * @param defines Defines of the material we want to update
  18512. * @param lightIndex Index of the light in the enabled light list of the material
  18513. */
  18514. prepareDefines(defines: any, lightIndex: number): void;
  18515. /**
  18516. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  18517. * defined in the generator but impacting the effect).
  18518. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  18519. * @param effect The effect we are binfing the information for
  18520. */
  18521. bindShadowLight(lightIndex: string, effect: Effect): void;
  18522. /**
  18523. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  18524. * (eq to shadow prjection matrix * light transform matrix)
  18525. * @returns The transform matrix used to create the shadow map
  18526. */
  18527. getTransformMatrix(): Matrix;
  18528. /**
  18529. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  18530. * Cube and 2D textures for instance.
  18531. */
  18532. recreateShadowMap(): void;
  18533. protected _disposeBlurPostProcesses(): void;
  18534. protected _disposeRTTandPostProcesses(): void;
  18535. /**
  18536. * Disposes the ShadowGenerator.
  18537. * Returns nothing.
  18538. */
  18539. dispose(): void;
  18540. /**
  18541. * Serializes the shadow generator setup to a json object.
  18542. * @returns The serialized JSON object
  18543. */
  18544. serialize(): any;
  18545. /**
  18546. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  18547. * @param parsedShadowGenerator The JSON object to parse
  18548. * @param scene The scene to create the shadow map for
  18549. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  18550. * @returns The parsed shadow generator
  18551. */
  18552. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  18553. }
  18554. }
  18555. declare module "babylonjs/Lights/light" {
  18556. import { Nullable } from "babylonjs/types";
  18557. import { Scene } from "babylonjs/scene";
  18558. import { Vector3 } from "babylonjs/Maths/math.vector";
  18559. import { Color3 } from "babylonjs/Maths/math.color";
  18560. import { Node } from "babylonjs/node";
  18561. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  18562. import { Effect } from "babylonjs/Materials/effect";
  18563. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  18564. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  18565. /**
  18566. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  18567. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  18568. * 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.
  18569. */
  18570. export abstract class Light extends Node {
  18571. /**
  18572. * Falloff Default: light is falling off following the material specification:
  18573. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  18574. */
  18575. static readonly FALLOFF_DEFAULT: number;
  18576. /**
  18577. * Falloff Physical: light is falling off following the inverse squared distance law.
  18578. */
  18579. static readonly FALLOFF_PHYSICAL: number;
  18580. /**
  18581. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  18582. * to enhance interoperability with other engines.
  18583. */
  18584. static readonly FALLOFF_GLTF: number;
  18585. /**
  18586. * Falloff Standard: light is falling off like in the standard material
  18587. * to enhance interoperability with other materials.
  18588. */
  18589. static readonly FALLOFF_STANDARD: number;
  18590. /**
  18591. * If every light affecting the material is in this lightmapMode,
  18592. * material.lightmapTexture adds or multiplies
  18593. * (depends on material.useLightmapAsShadowmap)
  18594. * after every other light calculations.
  18595. */
  18596. static readonly LIGHTMAP_DEFAULT: number;
  18597. /**
  18598. * material.lightmapTexture as only diffuse lighting from this light
  18599. * adds only specular lighting from this light
  18600. * adds dynamic shadows
  18601. */
  18602. static readonly LIGHTMAP_SPECULAR: number;
  18603. /**
  18604. * material.lightmapTexture as only lighting
  18605. * no light calculation from this light
  18606. * only adds dynamic shadows from this light
  18607. */
  18608. static readonly LIGHTMAP_SHADOWSONLY: number;
  18609. /**
  18610. * Each light type uses the default quantity according to its type:
  18611. * point/spot lights use luminous intensity
  18612. * directional lights use illuminance
  18613. */
  18614. static readonly INTENSITYMODE_AUTOMATIC: number;
  18615. /**
  18616. * lumen (lm)
  18617. */
  18618. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  18619. /**
  18620. * candela (lm/sr)
  18621. */
  18622. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  18623. /**
  18624. * lux (lm/m^2)
  18625. */
  18626. static readonly INTENSITYMODE_ILLUMINANCE: number;
  18627. /**
  18628. * nit (cd/m^2)
  18629. */
  18630. static readonly INTENSITYMODE_LUMINANCE: number;
  18631. /**
  18632. * Light type const id of the point light.
  18633. */
  18634. static readonly LIGHTTYPEID_POINTLIGHT: number;
  18635. /**
  18636. * Light type const id of the directional light.
  18637. */
  18638. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  18639. /**
  18640. * Light type const id of the spot light.
  18641. */
  18642. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  18643. /**
  18644. * Light type const id of the hemispheric light.
  18645. */
  18646. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  18647. /**
  18648. * Diffuse gives the basic color to an object.
  18649. */
  18650. diffuse: Color3;
  18651. /**
  18652. * Specular produces a highlight color on an object.
  18653. * Note: This is note affecting PBR materials.
  18654. */
  18655. specular: Color3;
  18656. /**
  18657. * Defines the falloff type for this light. This lets overrriding how punctual light are
  18658. * falling off base on range or angle.
  18659. * This can be set to any values in Light.FALLOFF_x.
  18660. *
  18661. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  18662. * other types of materials.
  18663. */
  18664. falloffType: number;
  18665. /**
  18666. * Strength of the light.
  18667. * Note: By default it is define in the framework own unit.
  18668. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  18669. */
  18670. intensity: number;
  18671. private _range;
  18672. protected _inverseSquaredRange: number;
  18673. /**
  18674. * Defines how far from the source the light is impacting in scene units.
  18675. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18676. */
  18677. get range(): number;
  18678. /**
  18679. * Defines how far from the source the light is impacting in scene units.
  18680. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18681. */
  18682. set range(value: number);
  18683. /**
  18684. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  18685. * of light.
  18686. */
  18687. private _photometricScale;
  18688. private _intensityMode;
  18689. /**
  18690. * Gets the photometric scale used to interpret the intensity.
  18691. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18692. */
  18693. get intensityMode(): number;
  18694. /**
  18695. * Sets the photometric scale used to interpret the intensity.
  18696. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18697. */
  18698. set intensityMode(value: number);
  18699. private _radius;
  18700. /**
  18701. * Gets the light radius used by PBR Materials to simulate soft area lights.
  18702. */
  18703. get radius(): number;
  18704. /**
  18705. * sets the light radius used by PBR Materials to simulate soft area lights.
  18706. */
  18707. set radius(value: number);
  18708. private _renderPriority;
  18709. /**
  18710. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  18711. * exceeding the number allowed of the materials.
  18712. */
  18713. renderPriority: number;
  18714. private _shadowEnabled;
  18715. /**
  18716. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18717. * the current shadow generator.
  18718. */
  18719. get shadowEnabled(): boolean;
  18720. /**
  18721. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18722. * the current shadow generator.
  18723. */
  18724. set shadowEnabled(value: boolean);
  18725. private _includedOnlyMeshes;
  18726. /**
  18727. * Gets the only meshes impacted by this light.
  18728. */
  18729. get includedOnlyMeshes(): AbstractMesh[];
  18730. /**
  18731. * Sets the only meshes impacted by this light.
  18732. */
  18733. set includedOnlyMeshes(value: AbstractMesh[]);
  18734. private _excludedMeshes;
  18735. /**
  18736. * Gets the meshes not impacted by this light.
  18737. */
  18738. get excludedMeshes(): AbstractMesh[];
  18739. /**
  18740. * Sets the meshes not impacted by this light.
  18741. */
  18742. set excludedMeshes(value: AbstractMesh[]);
  18743. private _excludeWithLayerMask;
  18744. /**
  18745. * Gets the layer id use to find what meshes are not impacted by the light.
  18746. * Inactive if 0
  18747. */
  18748. get excludeWithLayerMask(): number;
  18749. /**
  18750. * Sets the layer id use to find what meshes are not impacted by the light.
  18751. * Inactive if 0
  18752. */
  18753. set excludeWithLayerMask(value: number);
  18754. private _includeOnlyWithLayerMask;
  18755. /**
  18756. * Gets the layer id use to find what meshes are impacted by the light.
  18757. * Inactive if 0
  18758. */
  18759. get includeOnlyWithLayerMask(): number;
  18760. /**
  18761. * Sets the layer id use to find what meshes are impacted by the light.
  18762. * Inactive if 0
  18763. */
  18764. set includeOnlyWithLayerMask(value: number);
  18765. private _lightmapMode;
  18766. /**
  18767. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18768. */
  18769. get lightmapMode(): number;
  18770. /**
  18771. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18772. */
  18773. set lightmapMode(value: number);
  18774. /**
  18775. * Shadow generator associted to the light.
  18776. * @hidden Internal use only.
  18777. */
  18778. _shadowGenerator: Nullable<IShadowGenerator>;
  18779. /**
  18780. * @hidden Internal use only.
  18781. */
  18782. _excludedMeshesIds: string[];
  18783. /**
  18784. * @hidden Internal use only.
  18785. */
  18786. _includedOnlyMeshesIds: string[];
  18787. /**
  18788. * The current light unifom buffer.
  18789. * @hidden Internal use only.
  18790. */
  18791. _uniformBuffer: UniformBuffer;
  18792. /** @hidden */
  18793. _renderId: number;
  18794. /**
  18795. * Creates a Light object in the scene.
  18796. * Documentation : https://doc.babylonjs.com/babylon101/lights
  18797. * @param name The firendly name of the light
  18798. * @param scene The scene the light belongs too
  18799. */
  18800. constructor(name: string, scene: Scene);
  18801. protected abstract _buildUniformLayout(): void;
  18802. /**
  18803. * Sets the passed Effect "effect" with the Light information.
  18804. * @param effect The effect to update
  18805. * @param lightIndex The index of the light in the effect to update
  18806. * @returns The light
  18807. */
  18808. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  18809. /**
  18810. * Sets the passed Effect "effect" with the Light textures.
  18811. * @param effect The effect to update
  18812. * @param lightIndex The index of the light in the effect to update
  18813. * @returns The light
  18814. */
  18815. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  18816. /**
  18817. * Binds the lights information from the scene to the effect for the given mesh.
  18818. * @param lightIndex Light index
  18819. * @param scene The scene where the light belongs to
  18820. * @param effect The effect we are binding the data to
  18821. * @param useSpecular Defines if specular is supported
  18822. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  18823. */
  18824. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  18825. /**
  18826. * Sets the passed Effect "effect" with the Light information.
  18827. * @param effect The effect to update
  18828. * @param lightDataUniformName The uniform used to store light data (position or direction)
  18829. * @returns The light
  18830. */
  18831. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  18832. /**
  18833. * Returns the string "Light".
  18834. * @returns the class name
  18835. */
  18836. getClassName(): string;
  18837. /** @hidden */
  18838. readonly _isLight: boolean;
  18839. /**
  18840. * Converts the light information to a readable string for debug purpose.
  18841. * @param fullDetails Supports for multiple levels of logging within scene loading
  18842. * @returns the human readable light info
  18843. */
  18844. toString(fullDetails?: boolean): string;
  18845. /** @hidden */
  18846. protected _syncParentEnabledState(): void;
  18847. /**
  18848. * Set the enabled state of this node.
  18849. * @param value - the new enabled state
  18850. */
  18851. setEnabled(value: boolean): void;
  18852. /**
  18853. * Returns the Light associated shadow generator if any.
  18854. * @return the associated shadow generator.
  18855. */
  18856. getShadowGenerator(): Nullable<IShadowGenerator>;
  18857. /**
  18858. * Returns a Vector3, the absolute light position in the World.
  18859. * @returns the world space position of the light
  18860. */
  18861. getAbsolutePosition(): Vector3;
  18862. /**
  18863. * Specifies if the light will affect the passed mesh.
  18864. * @param mesh The mesh to test against the light
  18865. * @return true the mesh is affected otherwise, false.
  18866. */
  18867. canAffectMesh(mesh: AbstractMesh): boolean;
  18868. /**
  18869. * Sort function to order lights for rendering.
  18870. * @param a First Light object to compare to second.
  18871. * @param b Second Light object to compare first.
  18872. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  18873. */
  18874. static CompareLightsPriority(a: Light, b: Light): number;
  18875. /**
  18876. * Releases resources associated with this node.
  18877. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  18878. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  18879. */
  18880. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  18881. /**
  18882. * Returns the light type ID (integer).
  18883. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  18884. */
  18885. getTypeID(): number;
  18886. /**
  18887. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  18888. * @returns the scaled intensity in intensity mode unit
  18889. */
  18890. getScaledIntensity(): number;
  18891. /**
  18892. * Returns a new Light object, named "name", from the current one.
  18893. * @param name The name of the cloned light
  18894. * @param newParent The parent of this light, if it has one
  18895. * @returns the new created light
  18896. */
  18897. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  18898. /**
  18899. * Serializes the current light into a Serialization object.
  18900. * @returns the serialized object.
  18901. */
  18902. serialize(): any;
  18903. /**
  18904. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  18905. * This new light is named "name" and added to the passed scene.
  18906. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  18907. * @param name The friendly name of the light
  18908. * @param scene The scene the new light will belong to
  18909. * @returns the constructor function
  18910. */
  18911. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  18912. /**
  18913. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  18914. * @param parsedLight The JSON representation of the light
  18915. * @param scene The scene to create the parsed light in
  18916. * @returns the created light after parsing
  18917. */
  18918. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  18919. private _hookArrayForExcluded;
  18920. private _hookArrayForIncludedOnly;
  18921. private _resyncMeshes;
  18922. /**
  18923. * Forces the meshes to update their light related information in their rendering used effects
  18924. * @hidden Internal Use Only
  18925. */
  18926. _markMeshesAsLightDirty(): void;
  18927. /**
  18928. * Recomputes the cached photometric scale if needed.
  18929. */
  18930. private _computePhotometricScale;
  18931. /**
  18932. * Returns the Photometric Scale according to the light type and intensity mode.
  18933. */
  18934. private _getPhotometricScale;
  18935. /**
  18936. * Reorder the light in the scene according to their defined priority.
  18937. * @hidden Internal Use Only
  18938. */
  18939. _reorderLightsInScene(): void;
  18940. /**
  18941. * Prepares the list of defines specific to the light type.
  18942. * @param defines the list of defines
  18943. * @param lightIndex defines the index of the light for the effect
  18944. */
  18945. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  18946. }
  18947. }
  18948. declare module "babylonjs/Cameras/targetCamera" {
  18949. import { Nullable } from "babylonjs/types";
  18950. import { Camera } from "babylonjs/Cameras/camera";
  18951. import { Scene } from "babylonjs/scene";
  18952. import { Quaternion, Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  18953. /**
  18954. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  18955. * This is the base of the follow, arc rotate cameras and Free camera
  18956. * @see https://doc.babylonjs.com/features/cameras
  18957. */
  18958. export class TargetCamera extends Camera {
  18959. private static _RigCamTransformMatrix;
  18960. private static _TargetTransformMatrix;
  18961. private static _TargetFocalPoint;
  18962. private _tmpUpVector;
  18963. private _tmpTargetVector;
  18964. /**
  18965. * Define the current direction the camera is moving to
  18966. */
  18967. cameraDirection: Vector3;
  18968. /**
  18969. * Define the current rotation the camera is rotating to
  18970. */
  18971. cameraRotation: Vector2;
  18972. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  18973. ignoreParentScaling: boolean;
  18974. /**
  18975. * When set, the up vector of the camera will be updated by the rotation of the camera
  18976. */
  18977. updateUpVectorFromRotation: boolean;
  18978. private _tmpQuaternion;
  18979. /**
  18980. * Define the current rotation of the camera
  18981. */
  18982. rotation: Vector3;
  18983. /**
  18984. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  18985. */
  18986. rotationQuaternion: Quaternion;
  18987. /**
  18988. * Define the current speed of the camera
  18989. */
  18990. speed: number;
  18991. /**
  18992. * Add constraint to the camera to prevent it to move freely in all directions and
  18993. * around all axis.
  18994. */
  18995. noRotationConstraint: boolean;
  18996. /**
  18997. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  18998. * panning
  18999. */
  19000. invertRotation: boolean;
  19001. /**
  19002. * Speed multiplier for inverse camera panning
  19003. */
  19004. inverseRotationSpeed: number;
  19005. /**
  19006. * Define the current target of the camera as an object or a position.
  19007. */
  19008. lockedTarget: any;
  19009. /** @hidden */
  19010. _currentTarget: Vector3;
  19011. /** @hidden */
  19012. _initialFocalDistance: number;
  19013. /** @hidden */
  19014. _viewMatrix: Matrix;
  19015. /** @hidden */
  19016. _camMatrix: Matrix;
  19017. /** @hidden */
  19018. _cameraTransformMatrix: Matrix;
  19019. /** @hidden */
  19020. _cameraRotationMatrix: Matrix;
  19021. /** @hidden */
  19022. _referencePoint: Vector3;
  19023. /** @hidden */
  19024. _transformedReferencePoint: Vector3;
  19025. /** @hidden */
  19026. _reset: () => void;
  19027. private _defaultUp;
  19028. /**
  19029. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  19030. * This is the base of the follow, arc rotate cameras and Free camera
  19031. * @see https://doc.babylonjs.com/features/cameras
  19032. * @param name Defines the name of the camera in the scene
  19033. * @param position Defines the start position of the camera in the scene
  19034. * @param scene Defines the scene the camera belongs to
  19035. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  19036. */
  19037. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  19038. /**
  19039. * Gets the position in front of the camera at a given distance.
  19040. * @param distance The distance from the camera we want the position to be
  19041. * @returns the position
  19042. */
  19043. getFrontPosition(distance: number): Vector3;
  19044. /** @hidden */
  19045. _getLockedTargetPosition(): Nullable<Vector3>;
  19046. private _storedPosition;
  19047. private _storedRotation;
  19048. private _storedRotationQuaternion;
  19049. /**
  19050. * Store current camera state of the camera (fov, position, rotation, etc..)
  19051. * @returns the camera
  19052. */
  19053. storeState(): Camera;
  19054. /**
  19055. * Restored camera state. You must call storeState() first
  19056. * @returns whether it was successful or not
  19057. * @hidden
  19058. */
  19059. _restoreStateValues(): boolean;
  19060. /** @hidden */
  19061. _initCache(): void;
  19062. /** @hidden */
  19063. _updateCache(ignoreParentClass?: boolean): void;
  19064. /** @hidden */
  19065. _isSynchronizedViewMatrix(): boolean;
  19066. /** @hidden */
  19067. _computeLocalCameraSpeed(): number;
  19068. /**
  19069. * Defines the target the camera should look at.
  19070. * @param target Defines the new target as a Vector or a mesh
  19071. */
  19072. setTarget(target: Vector3): void;
  19073. /**
  19074. * Defines the target point of the camera.
  19075. * The camera looks towards it form the radius distance.
  19076. */
  19077. get target(): Vector3;
  19078. set target(value: Vector3);
  19079. /**
  19080. * Return the current target position of the camera. This value is expressed in local space.
  19081. * @returns the target position
  19082. */
  19083. getTarget(): Vector3;
  19084. /** @hidden */
  19085. _decideIfNeedsToMove(): boolean;
  19086. /** @hidden */
  19087. _updatePosition(): void;
  19088. /** @hidden */
  19089. _checkInputs(): void;
  19090. protected _updateCameraRotationMatrix(): void;
  19091. /**
  19092. * 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)
  19093. * @returns the current camera
  19094. */
  19095. private _rotateUpVectorWithCameraRotationMatrix;
  19096. private _cachedRotationZ;
  19097. private _cachedQuaternionRotationZ;
  19098. /** @hidden */
  19099. _getViewMatrix(): Matrix;
  19100. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  19101. /**
  19102. * @hidden
  19103. */
  19104. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  19105. /**
  19106. * @hidden
  19107. */
  19108. _updateRigCameras(): void;
  19109. private _getRigCamPositionAndTarget;
  19110. /**
  19111. * Gets the current object class name.
  19112. * @return the class name
  19113. */
  19114. getClassName(): string;
  19115. }
  19116. }
  19117. declare module "babylonjs/Events/keyboardEvents" {
  19118. /**
  19119. * Gather the list of keyboard event types as constants.
  19120. */
  19121. export class KeyboardEventTypes {
  19122. /**
  19123. * The keydown event is fired when a key becomes active (pressed).
  19124. */
  19125. static readonly KEYDOWN: number;
  19126. /**
  19127. * The keyup event is fired when a key has been released.
  19128. */
  19129. static readonly KEYUP: number;
  19130. }
  19131. /**
  19132. * This class is used to store keyboard related info for the onKeyboardObservable event.
  19133. */
  19134. export class KeyboardInfo {
  19135. /**
  19136. * Defines the type of event (KeyboardEventTypes)
  19137. */
  19138. type: number;
  19139. /**
  19140. * Defines the related dom event
  19141. */
  19142. event: KeyboardEvent;
  19143. /**
  19144. * Instantiates a new keyboard info.
  19145. * This class is used to store keyboard related info for the onKeyboardObservable event.
  19146. * @param type Defines the type of event (KeyboardEventTypes)
  19147. * @param event Defines the related dom event
  19148. */
  19149. constructor(
  19150. /**
  19151. * Defines the type of event (KeyboardEventTypes)
  19152. */
  19153. type: number,
  19154. /**
  19155. * Defines the related dom event
  19156. */
  19157. event: KeyboardEvent);
  19158. }
  19159. /**
  19160. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  19161. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  19162. */
  19163. export class KeyboardInfoPre extends KeyboardInfo {
  19164. /**
  19165. * Defines the type of event (KeyboardEventTypes)
  19166. */
  19167. type: number;
  19168. /**
  19169. * Defines the related dom event
  19170. */
  19171. event: KeyboardEvent;
  19172. /**
  19173. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  19174. */
  19175. skipOnPointerObservable: boolean;
  19176. /**
  19177. * Instantiates a new keyboard pre info.
  19178. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  19179. * @param type Defines the type of event (KeyboardEventTypes)
  19180. * @param event Defines the related dom event
  19181. */
  19182. constructor(
  19183. /**
  19184. * Defines the type of event (KeyboardEventTypes)
  19185. */
  19186. type: number,
  19187. /**
  19188. * Defines the related dom event
  19189. */
  19190. event: KeyboardEvent);
  19191. }
  19192. }
  19193. declare module "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput" {
  19194. import { Nullable } from "babylonjs/types";
  19195. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19196. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19197. /**
  19198. * Manage the keyboard inputs to control the movement of a free camera.
  19199. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19200. */
  19201. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  19202. /**
  19203. * Defines the camera the input is attached to.
  19204. */
  19205. camera: FreeCamera;
  19206. /**
  19207. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19208. */
  19209. keysUp: number[];
  19210. /**
  19211. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19212. */
  19213. keysUpward: number[];
  19214. /**
  19215. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19216. */
  19217. keysDown: number[];
  19218. /**
  19219. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19220. */
  19221. keysDownward: number[];
  19222. /**
  19223. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19224. */
  19225. keysLeft: number[];
  19226. /**
  19227. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19228. */
  19229. keysRight: number[];
  19230. private _keys;
  19231. private _onCanvasBlurObserver;
  19232. private _onKeyboardObserver;
  19233. private _engine;
  19234. private _scene;
  19235. /**
  19236. * Attach the input controls to a specific dom element to get the input from.
  19237. * @param element Defines the element the controls should be listened from
  19238. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19239. */
  19240. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19241. /**
  19242. * Detach the current controls from the specified dom element.
  19243. * @param element Defines the element to stop listening the inputs from
  19244. */
  19245. detachControl(element: Nullable<HTMLElement>): void;
  19246. /**
  19247. * Update the current camera state depending on the inputs that have been used this frame.
  19248. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19249. */
  19250. checkInputs(): void;
  19251. /**
  19252. * Gets the class name of the current intput.
  19253. * @returns the class name
  19254. */
  19255. getClassName(): string;
  19256. /** @hidden */
  19257. _onLostFocus(): void;
  19258. /**
  19259. * Get the friendly name associated with the input class.
  19260. * @returns the input friendly name
  19261. */
  19262. getSimpleName(): string;
  19263. }
  19264. }
  19265. declare module "babylonjs/Events/pointerEvents" {
  19266. import { Nullable } from "babylonjs/types";
  19267. import { Vector2 } from "babylonjs/Maths/math.vector";
  19268. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  19269. import { Ray } from "babylonjs/Culling/ray";
  19270. /**
  19271. * Gather the list of pointer event types as constants.
  19272. */
  19273. export class PointerEventTypes {
  19274. /**
  19275. * 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.
  19276. */
  19277. static readonly POINTERDOWN: number;
  19278. /**
  19279. * The pointerup event is fired when a pointer is no longer active.
  19280. */
  19281. static readonly POINTERUP: number;
  19282. /**
  19283. * The pointermove event is fired when a pointer changes coordinates.
  19284. */
  19285. static readonly POINTERMOVE: number;
  19286. /**
  19287. * The pointerwheel event is fired when a mouse wheel has been rotated.
  19288. */
  19289. static readonly POINTERWHEEL: number;
  19290. /**
  19291. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  19292. */
  19293. static readonly POINTERPICK: number;
  19294. /**
  19295. * The pointertap event is fired when a the object has been touched and released without drag.
  19296. */
  19297. static readonly POINTERTAP: number;
  19298. /**
  19299. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  19300. */
  19301. static readonly POINTERDOUBLETAP: number;
  19302. }
  19303. /**
  19304. * Base class of pointer info types.
  19305. */
  19306. export class PointerInfoBase {
  19307. /**
  19308. * Defines the type of event (PointerEventTypes)
  19309. */
  19310. type: number;
  19311. /**
  19312. * Defines the related dom event
  19313. */
  19314. event: PointerEvent | MouseWheelEvent;
  19315. /**
  19316. * Instantiates the base class of pointers info.
  19317. * @param type Defines the type of event (PointerEventTypes)
  19318. * @param event Defines the related dom event
  19319. */
  19320. constructor(
  19321. /**
  19322. * Defines the type of event (PointerEventTypes)
  19323. */
  19324. type: number,
  19325. /**
  19326. * Defines the related dom event
  19327. */
  19328. event: PointerEvent | MouseWheelEvent);
  19329. }
  19330. /**
  19331. * This class is used to store pointer related info for the onPrePointerObservable event.
  19332. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  19333. */
  19334. export class PointerInfoPre extends PointerInfoBase {
  19335. /**
  19336. * Ray from a pointer if availible (eg. 6dof controller)
  19337. */
  19338. ray: Nullable<Ray>;
  19339. /**
  19340. * Defines the local position of the pointer on the canvas.
  19341. */
  19342. localPosition: Vector2;
  19343. /**
  19344. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  19345. */
  19346. skipOnPointerObservable: boolean;
  19347. /**
  19348. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  19349. * @param type Defines the type of event (PointerEventTypes)
  19350. * @param event Defines the related dom event
  19351. * @param localX Defines the local x coordinates of the pointer when the event occured
  19352. * @param localY Defines the local y coordinates of the pointer when the event occured
  19353. */
  19354. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  19355. }
  19356. /**
  19357. * This type contains all the data related to a pointer event in Babylon.js.
  19358. * 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.
  19359. */
  19360. export class PointerInfo extends PointerInfoBase {
  19361. /**
  19362. * Defines the picking info associated to the info (if any)\
  19363. */
  19364. pickInfo: Nullable<PickingInfo>;
  19365. /**
  19366. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  19367. * @param type Defines the type of event (PointerEventTypes)
  19368. * @param event Defines the related dom event
  19369. * @param pickInfo Defines the picking info associated to the info (if any)\
  19370. */
  19371. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  19372. /**
  19373. * Defines the picking info associated to the info (if any)\
  19374. */
  19375. pickInfo: Nullable<PickingInfo>);
  19376. }
  19377. /**
  19378. * Data relating to a touch event on the screen.
  19379. */
  19380. export interface PointerTouch {
  19381. /**
  19382. * X coordinate of touch.
  19383. */
  19384. x: number;
  19385. /**
  19386. * Y coordinate of touch.
  19387. */
  19388. y: number;
  19389. /**
  19390. * Id of touch. Unique for each finger.
  19391. */
  19392. pointerId: number;
  19393. /**
  19394. * Event type passed from DOM.
  19395. */
  19396. type: any;
  19397. }
  19398. }
  19399. declare module "babylonjs/Cameras/Inputs/freeCameraMouseInput" {
  19400. import { Observable } from "babylonjs/Misc/observable";
  19401. import { Nullable } from "babylonjs/types";
  19402. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19403. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19404. /**
  19405. * Manage the mouse inputs to control the movement of a free camera.
  19406. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19407. */
  19408. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  19409. /**
  19410. * Define if touch is enabled in the mouse input
  19411. */
  19412. touchEnabled: boolean;
  19413. /**
  19414. * Defines the camera the input is attached to.
  19415. */
  19416. camera: FreeCamera;
  19417. /**
  19418. * Defines the buttons associated with the input to handle camera move.
  19419. */
  19420. buttons: number[];
  19421. /**
  19422. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  19423. */
  19424. angularSensibility: number;
  19425. private _pointerInput;
  19426. private _onMouseMove;
  19427. private _observer;
  19428. private previousPosition;
  19429. /**
  19430. * Observable for when a pointer move event occurs containing the move offset
  19431. */
  19432. onPointerMovedObservable: Observable<{
  19433. offsetX: number;
  19434. offsetY: number;
  19435. }>;
  19436. /**
  19437. * @hidden
  19438. * If the camera should be rotated automatically based on pointer movement
  19439. */
  19440. _allowCameraRotation: boolean;
  19441. /**
  19442. * Manage the mouse inputs to control the movement of a free camera.
  19443. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19444. * @param touchEnabled Defines if touch is enabled or not
  19445. */
  19446. constructor(
  19447. /**
  19448. * Define if touch is enabled in the mouse input
  19449. */
  19450. touchEnabled?: boolean);
  19451. /**
  19452. * Attach the input controls to a specific dom element to get the input from.
  19453. * @param element Defines the element the controls should be listened from
  19454. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19455. */
  19456. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19457. /**
  19458. * Called on JS contextmenu event.
  19459. * Override this method to provide functionality.
  19460. */
  19461. protected onContextMenu(evt: PointerEvent): void;
  19462. /**
  19463. * Detach the current controls from the specified dom element.
  19464. * @param element Defines the element to stop listening the inputs from
  19465. */
  19466. detachControl(element: Nullable<HTMLElement>): void;
  19467. /**
  19468. * Gets the class name of the current intput.
  19469. * @returns the class name
  19470. */
  19471. getClassName(): string;
  19472. /**
  19473. * Get the friendly name associated with the input class.
  19474. * @returns the input friendly name
  19475. */
  19476. getSimpleName(): string;
  19477. }
  19478. }
  19479. declare module "babylonjs/Cameras/Inputs/freeCameraTouchInput" {
  19480. import { Nullable } from "babylonjs/types";
  19481. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19482. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19483. /**
  19484. * Manage the touch inputs to control the movement of a free camera.
  19485. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19486. */
  19487. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  19488. /**
  19489. * Define if mouse events can be treated as touch events
  19490. */
  19491. allowMouse: boolean;
  19492. /**
  19493. * Defines the camera the input is attached to.
  19494. */
  19495. camera: FreeCamera;
  19496. /**
  19497. * Defines the touch sensibility for rotation.
  19498. * The higher the faster.
  19499. */
  19500. touchAngularSensibility: number;
  19501. /**
  19502. * Defines the touch sensibility for move.
  19503. * The higher the faster.
  19504. */
  19505. touchMoveSensibility: number;
  19506. private _offsetX;
  19507. private _offsetY;
  19508. private _pointerPressed;
  19509. private _pointerInput;
  19510. private _observer;
  19511. private _onLostFocus;
  19512. /**
  19513. * Manage the touch inputs to control the movement of a free camera.
  19514. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19515. * @param allowMouse Defines if mouse events can be treated as touch events
  19516. */
  19517. constructor(
  19518. /**
  19519. * Define if mouse events can be treated as touch events
  19520. */
  19521. allowMouse?: boolean);
  19522. /**
  19523. * Attach the input controls to a specific dom element to get the input from.
  19524. * @param element Defines the element the controls should be listened from
  19525. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19526. */
  19527. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19528. /**
  19529. * Detach the current controls from the specified dom element.
  19530. * @param element Defines the element to stop listening the inputs from
  19531. */
  19532. detachControl(element: Nullable<HTMLElement>): void;
  19533. /**
  19534. * Update the current camera state depending on the inputs that have been used this frame.
  19535. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19536. */
  19537. checkInputs(): void;
  19538. /**
  19539. * Gets the class name of the current intput.
  19540. * @returns the class name
  19541. */
  19542. getClassName(): string;
  19543. /**
  19544. * Get the friendly name associated with the input class.
  19545. * @returns the input friendly name
  19546. */
  19547. getSimpleName(): string;
  19548. }
  19549. }
  19550. declare module "babylonjs/Cameras/freeCameraInputsManager" {
  19551. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19552. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  19553. import { FreeCameraMouseInput } from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  19554. import { Nullable } from "babylonjs/types";
  19555. /**
  19556. * Default Inputs manager for the FreeCamera.
  19557. * It groups all the default supported inputs for ease of use.
  19558. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19559. */
  19560. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  19561. /**
  19562. * @hidden
  19563. */
  19564. _mouseInput: Nullable<FreeCameraMouseInput>;
  19565. /**
  19566. * Instantiates a new FreeCameraInputsManager.
  19567. * @param camera Defines the camera the inputs belong to
  19568. */
  19569. constructor(camera: FreeCamera);
  19570. /**
  19571. * Add keyboard input support to the input manager.
  19572. * @returns the current input manager
  19573. */
  19574. addKeyboard(): FreeCameraInputsManager;
  19575. /**
  19576. * Add mouse input support to the input manager.
  19577. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  19578. * @returns the current input manager
  19579. */
  19580. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  19581. /**
  19582. * Removes the mouse input support from the manager
  19583. * @returns the current input manager
  19584. */
  19585. removeMouse(): FreeCameraInputsManager;
  19586. /**
  19587. * Add touch input support to the input manager.
  19588. * @returns the current input manager
  19589. */
  19590. addTouch(): FreeCameraInputsManager;
  19591. /**
  19592. * Remove all attached input methods from a camera
  19593. */
  19594. clear(): void;
  19595. }
  19596. }
  19597. declare module "babylonjs/Cameras/freeCamera" {
  19598. import { Vector3 } from "babylonjs/Maths/math.vector";
  19599. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19600. import { Scene } from "babylonjs/scene";
  19601. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19602. import { FreeCameraInputsManager } from "babylonjs/Cameras/freeCameraInputsManager";
  19603. /**
  19604. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19605. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  19606. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19607. */
  19608. export class FreeCamera extends TargetCamera {
  19609. /**
  19610. * Define the collision ellipsoid of the camera.
  19611. * This is helpful to simulate a camera body like the player body around the camera
  19612. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  19613. */
  19614. ellipsoid: Vector3;
  19615. /**
  19616. * Define an offset for the position of the ellipsoid around the camera.
  19617. * This can be helpful to determine the center of the body near the gravity center of the body
  19618. * instead of its head.
  19619. */
  19620. ellipsoidOffset: Vector3;
  19621. /**
  19622. * Enable or disable collisions of the camera with the rest of the scene objects.
  19623. */
  19624. checkCollisions: boolean;
  19625. /**
  19626. * Enable or disable gravity on the camera.
  19627. */
  19628. applyGravity: boolean;
  19629. /**
  19630. * Define the input manager associated to the camera.
  19631. */
  19632. inputs: FreeCameraInputsManager;
  19633. /**
  19634. * Gets the input sensibility for a mouse input. (default is 2000.0)
  19635. * Higher values reduce sensitivity.
  19636. */
  19637. get angularSensibility(): number;
  19638. /**
  19639. * Sets the input sensibility for a mouse input. (default is 2000.0)
  19640. * Higher values reduce sensitivity.
  19641. */
  19642. set angularSensibility(value: number);
  19643. /**
  19644. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19645. */
  19646. get keysUp(): number[];
  19647. set keysUp(value: number[]);
  19648. /**
  19649. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19650. */
  19651. get keysUpward(): number[];
  19652. set keysUpward(value: number[]);
  19653. /**
  19654. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19655. */
  19656. get keysDown(): number[];
  19657. set keysDown(value: number[]);
  19658. /**
  19659. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19660. */
  19661. get keysDownward(): number[];
  19662. set keysDownward(value: number[]);
  19663. /**
  19664. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19665. */
  19666. get keysLeft(): number[];
  19667. set keysLeft(value: number[]);
  19668. /**
  19669. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19670. */
  19671. get keysRight(): number[];
  19672. set keysRight(value: number[]);
  19673. /**
  19674. * Event raised when the camera collide with a mesh in the scene.
  19675. */
  19676. onCollide: (collidedMesh: AbstractMesh) => void;
  19677. private _collider;
  19678. private _needMoveForGravity;
  19679. private _oldPosition;
  19680. private _diffPosition;
  19681. private _newPosition;
  19682. /** @hidden */
  19683. _localDirection: Vector3;
  19684. /** @hidden */
  19685. _transformedDirection: Vector3;
  19686. /**
  19687. * Instantiates a Free Camera.
  19688. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19689. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  19690. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19691. * @param name Define the name of the camera in the scene
  19692. * @param position Define the start position of the camera in the scene
  19693. * @param scene Define the scene the camera belongs to
  19694. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  19695. */
  19696. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  19697. /**
  19698. * Attached controls to the current camera.
  19699. * @param element Defines the element the controls should be listened from
  19700. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19701. */
  19702. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19703. /**
  19704. * Detach the current controls from the camera.
  19705. * The camera will stop reacting to inputs.
  19706. * @param element Defines the element to stop listening the inputs from
  19707. */
  19708. detachControl(element: HTMLElement): void;
  19709. private _collisionMask;
  19710. /**
  19711. * Define a collision mask to limit the list of object the camera can collide with
  19712. */
  19713. get collisionMask(): number;
  19714. set collisionMask(mask: number);
  19715. /** @hidden */
  19716. _collideWithWorld(displacement: Vector3): void;
  19717. private _onCollisionPositionChange;
  19718. /** @hidden */
  19719. _checkInputs(): void;
  19720. /** @hidden */
  19721. _decideIfNeedsToMove(): boolean;
  19722. /** @hidden */
  19723. _updatePosition(): void;
  19724. /**
  19725. * Destroy the camera and release the current resources hold by it.
  19726. */
  19727. dispose(): void;
  19728. /**
  19729. * Gets the current object class name.
  19730. * @return the class name
  19731. */
  19732. getClassName(): string;
  19733. }
  19734. }
  19735. declare module "babylonjs/Gamepads/gamepad" {
  19736. import { Observable } from "babylonjs/Misc/observable";
  19737. /**
  19738. * Represents a gamepad control stick position
  19739. */
  19740. export class StickValues {
  19741. /**
  19742. * The x component of the control stick
  19743. */
  19744. x: number;
  19745. /**
  19746. * The y component of the control stick
  19747. */
  19748. y: number;
  19749. /**
  19750. * Initializes the gamepad x and y control stick values
  19751. * @param x The x component of the gamepad control stick value
  19752. * @param y The y component of the gamepad control stick value
  19753. */
  19754. constructor(
  19755. /**
  19756. * The x component of the control stick
  19757. */
  19758. x: number,
  19759. /**
  19760. * The y component of the control stick
  19761. */
  19762. y: number);
  19763. }
  19764. /**
  19765. * An interface which manages callbacks for gamepad button changes
  19766. */
  19767. export interface GamepadButtonChanges {
  19768. /**
  19769. * Called when a gamepad has been changed
  19770. */
  19771. changed: boolean;
  19772. /**
  19773. * Called when a gamepad press event has been triggered
  19774. */
  19775. pressChanged: boolean;
  19776. /**
  19777. * Called when a touch event has been triggered
  19778. */
  19779. touchChanged: boolean;
  19780. /**
  19781. * Called when a value has changed
  19782. */
  19783. valueChanged: boolean;
  19784. }
  19785. /**
  19786. * Represents a gamepad
  19787. */
  19788. export class Gamepad {
  19789. /**
  19790. * The id of the gamepad
  19791. */
  19792. id: string;
  19793. /**
  19794. * The index of the gamepad
  19795. */
  19796. index: number;
  19797. /**
  19798. * The browser gamepad
  19799. */
  19800. browserGamepad: any;
  19801. /**
  19802. * Specifies what type of gamepad this represents
  19803. */
  19804. type: number;
  19805. private _leftStick;
  19806. private _rightStick;
  19807. /** @hidden */
  19808. _isConnected: boolean;
  19809. private _leftStickAxisX;
  19810. private _leftStickAxisY;
  19811. private _rightStickAxisX;
  19812. private _rightStickAxisY;
  19813. /**
  19814. * Triggered when the left control stick has been changed
  19815. */
  19816. private _onleftstickchanged;
  19817. /**
  19818. * Triggered when the right control stick has been changed
  19819. */
  19820. private _onrightstickchanged;
  19821. /**
  19822. * Represents a gamepad controller
  19823. */
  19824. static GAMEPAD: number;
  19825. /**
  19826. * Represents a generic controller
  19827. */
  19828. static GENERIC: number;
  19829. /**
  19830. * Represents an XBox controller
  19831. */
  19832. static XBOX: number;
  19833. /**
  19834. * Represents a pose-enabled controller
  19835. */
  19836. static POSE_ENABLED: number;
  19837. /**
  19838. * Represents an Dual Shock controller
  19839. */
  19840. static DUALSHOCK: number;
  19841. /**
  19842. * Specifies whether the left control stick should be Y-inverted
  19843. */
  19844. protected _invertLeftStickY: boolean;
  19845. /**
  19846. * Specifies if the gamepad has been connected
  19847. */
  19848. get isConnected(): boolean;
  19849. /**
  19850. * Initializes the gamepad
  19851. * @param id The id of the gamepad
  19852. * @param index The index of the gamepad
  19853. * @param browserGamepad The browser gamepad
  19854. * @param leftStickX The x component of the left joystick
  19855. * @param leftStickY The y component of the left joystick
  19856. * @param rightStickX The x component of the right joystick
  19857. * @param rightStickY The y component of the right joystick
  19858. */
  19859. constructor(
  19860. /**
  19861. * The id of the gamepad
  19862. */
  19863. id: string,
  19864. /**
  19865. * The index of the gamepad
  19866. */
  19867. index: number,
  19868. /**
  19869. * The browser gamepad
  19870. */
  19871. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  19872. /**
  19873. * Callback triggered when the left joystick has changed
  19874. * @param callback
  19875. */
  19876. onleftstickchanged(callback: (values: StickValues) => void): void;
  19877. /**
  19878. * Callback triggered when the right joystick has changed
  19879. * @param callback
  19880. */
  19881. onrightstickchanged(callback: (values: StickValues) => void): void;
  19882. /**
  19883. * Gets the left joystick
  19884. */
  19885. get leftStick(): StickValues;
  19886. /**
  19887. * Sets the left joystick values
  19888. */
  19889. set leftStick(newValues: StickValues);
  19890. /**
  19891. * Gets the right joystick
  19892. */
  19893. get rightStick(): StickValues;
  19894. /**
  19895. * Sets the right joystick value
  19896. */
  19897. set rightStick(newValues: StickValues);
  19898. /**
  19899. * Updates the gamepad joystick positions
  19900. */
  19901. update(): void;
  19902. /**
  19903. * Disposes the gamepad
  19904. */
  19905. dispose(): void;
  19906. }
  19907. /**
  19908. * Represents a generic gamepad
  19909. */
  19910. export class GenericPad extends Gamepad {
  19911. private _buttons;
  19912. private _onbuttondown;
  19913. private _onbuttonup;
  19914. /**
  19915. * Observable triggered when a button has been pressed
  19916. */
  19917. onButtonDownObservable: Observable<number>;
  19918. /**
  19919. * Observable triggered when a button has been released
  19920. */
  19921. onButtonUpObservable: Observable<number>;
  19922. /**
  19923. * Callback triggered when a button has been pressed
  19924. * @param callback Called when a button has been pressed
  19925. */
  19926. onbuttondown(callback: (buttonPressed: number) => void): void;
  19927. /**
  19928. * Callback triggered when a button has been released
  19929. * @param callback Called when a button has been released
  19930. */
  19931. onbuttonup(callback: (buttonReleased: number) => void): void;
  19932. /**
  19933. * Initializes the generic gamepad
  19934. * @param id The id of the generic gamepad
  19935. * @param index The index of the generic gamepad
  19936. * @param browserGamepad The browser gamepad
  19937. */
  19938. constructor(id: string, index: number, browserGamepad: any);
  19939. private _setButtonValue;
  19940. /**
  19941. * Updates the generic gamepad
  19942. */
  19943. update(): void;
  19944. /**
  19945. * Disposes the generic gamepad
  19946. */
  19947. dispose(): void;
  19948. }
  19949. }
  19950. declare module "babylonjs/Gamepads/Controllers/poseEnabledController" {
  19951. import { Observable } from "babylonjs/Misc/observable";
  19952. import { Nullable } from "babylonjs/types";
  19953. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  19954. import { TransformNode } from "babylonjs/Meshes/transformNode";
  19955. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19956. import { Ray } from "babylonjs/Culling/ray";
  19957. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  19958. import { PoseControlled, DevicePose } from "babylonjs/Cameras/VR/webVRCamera";
  19959. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19960. /**
  19961. * Defines the types of pose enabled controllers that are supported
  19962. */
  19963. export enum PoseEnabledControllerType {
  19964. /**
  19965. * HTC Vive
  19966. */
  19967. VIVE = 0,
  19968. /**
  19969. * Oculus Rift
  19970. */
  19971. OCULUS = 1,
  19972. /**
  19973. * Windows mixed reality
  19974. */
  19975. WINDOWS = 2,
  19976. /**
  19977. * Samsung gear VR
  19978. */
  19979. GEAR_VR = 3,
  19980. /**
  19981. * Google Daydream
  19982. */
  19983. DAYDREAM = 4,
  19984. /**
  19985. * Generic
  19986. */
  19987. GENERIC = 5
  19988. }
  19989. /**
  19990. * Defines the MutableGamepadButton interface for the state of a gamepad button
  19991. */
  19992. export interface MutableGamepadButton {
  19993. /**
  19994. * Value of the button/trigger
  19995. */
  19996. value: number;
  19997. /**
  19998. * If the button/trigger is currently touched
  19999. */
  20000. touched: boolean;
  20001. /**
  20002. * If the button/trigger is currently pressed
  20003. */
  20004. pressed: boolean;
  20005. }
  20006. /**
  20007. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  20008. * @hidden
  20009. */
  20010. export interface ExtendedGamepadButton extends GamepadButton {
  20011. /**
  20012. * If the button/trigger is currently pressed
  20013. */
  20014. readonly pressed: boolean;
  20015. /**
  20016. * If the button/trigger is currently touched
  20017. */
  20018. readonly touched: boolean;
  20019. /**
  20020. * Value of the button/trigger
  20021. */
  20022. readonly value: number;
  20023. }
  20024. /** @hidden */
  20025. export interface _GamePadFactory {
  20026. /**
  20027. * Returns whether or not the current gamepad can be created for this type of controller.
  20028. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  20029. * @returns true if it can be created, otherwise false
  20030. */
  20031. canCreate(gamepadInfo: any): boolean;
  20032. /**
  20033. * Creates a new instance of the Gamepad.
  20034. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  20035. * @returns the new gamepad instance
  20036. */
  20037. create(gamepadInfo: any): Gamepad;
  20038. }
  20039. /**
  20040. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  20041. */
  20042. export class PoseEnabledControllerHelper {
  20043. /** @hidden */
  20044. static _ControllerFactories: _GamePadFactory[];
  20045. /** @hidden */
  20046. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  20047. /**
  20048. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  20049. * @param vrGamepad the gamepad to initialized
  20050. * @returns a vr controller of the type the gamepad identified as
  20051. */
  20052. static InitiateController(vrGamepad: any): Gamepad;
  20053. }
  20054. /**
  20055. * Defines the PoseEnabledController object that contains state of a vr capable controller
  20056. */
  20057. export class PoseEnabledController extends Gamepad implements PoseControlled {
  20058. /**
  20059. * If the controller is used in a webXR session
  20060. */
  20061. isXR: boolean;
  20062. private _deviceRoomPosition;
  20063. private _deviceRoomRotationQuaternion;
  20064. /**
  20065. * The device position in babylon space
  20066. */
  20067. devicePosition: Vector3;
  20068. /**
  20069. * The device rotation in babylon space
  20070. */
  20071. deviceRotationQuaternion: Quaternion;
  20072. /**
  20073. * The scale factor of the device in babylon space
  20074. */
  20075. deviceScaleFactor: number;
  20076. /**
  20077. * (Likely devicePosition should be used instead) The device position in its room space
  20078. */
  20079. position: Vector3;
  20080. /**
  20081. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  20082. */
  20083. rotationQuaternion: Quaternion;
  20084. /**
  20085. * The type of controller (Eg. Windows mixed reality)
  20086. */
  20087. controllerType: PoseEnabledControllerType;
  20088. protected _calculatedPosition: Vector3;
  20089. private _calculatedRotation;
  20090. /**
  20091. * The raw pose from the device
  20092. */
  20093. rawPose: DevicePose;
  20094. private _trackPosition;
  20095. private _maxRotationDistFromHeadset;
  20096. private _draggedRoomRotation;
  20097. /**
  20098. * @hidden
  20099. */
  20100. _disableTrackPosition(fixedPosition: Vector3): void;
  20101. /**
  20102. * Internal, the mesh attached to the controller
  20103. * @hidden
  20104. */
  20105. _mesh: Nullable<AbstractMesh>;
  20106. private _poseControlledCamera;
  20107. private _leftHandSystemQuaternion;
  20108. /**
  20109. * Internal, matrix used to convert room space to babylon space
  20110. * @hidden
  20111. */
  20112. _deviceToWorld: Matrix;
  20113. /**
  20114. * Node to be used when casting a ray from the controller
  20115. * @hidden
  20116. */
  20117. _pointingPoseNode: Nullable<TransformNode>;
  20118. /**
  20119. * Name of the child mesh that can be used to cast a ray from the controller
  20120. */
  20121. static readonly POINTING_POSE: string;
  20122. /**
  20123. * Creates a new PoseEnabledController from a gamepad
  20124. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  20125. */
  20126. constructor(browserGamepad: any);
  20127. private _workingMatrix;
  20128. /**
  20129. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  20130. */
  20131. update(): void;
  20132. /**
  20133. * Updates only the pose device and mesh without doing any button event checking
  20134. */
  20135. protected _updatePoseAndMesh(): void;
  20136. /**
  20137. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  20138. * @param poseData raw pose fromthe device
  20139. */
  20140. updateFromDevice(poseData: DevicePose): void;
  20141. /**
  20142. * @hidden
  20143. */
  20144. _meshAttachedObservable: Observable<AbstractMesh>;
  20145. /**
  20146. * Attaches a mesh to the controller
  20147. * @param mesh the mesh to be attached
  20148. */
  20149. attachToMesh(mesh: AbstractMesh): void;
  20150. /**
  20151. * Attaches the controllers mesh to a camera
  20152. * @param camera the camera the mesh should be attached to
  20153. */
  20154. attachToPoseControlledCamera(camera: TargetCamera): void;
  20155. /**
  20156. * Disposes of the controller
  20157. */
  20158. dispose(): void;
  20159. /**
  20160. * The mesh that is attached to the controller
  20161. */
  20162. get mesh(): Nullable<AbstractMesh>;
  20163. /**
  20164. * Gets the ray of the controller in the direction the controller is pointing
  20165. * @param length the length the resulting ray should be
  20166. * @returns a ray in the direction the controller is pointing
  20167. */
  20168. getForwardRay(length?: number): Ray;
  20169. }
  20170. }
  20171. declare module "babylonjs/Gamepads/Controllers/webVRController" {
  20172. import { Observable } from "babylonjs/Misc/observable";
  20173. import { Scene } from "babylonjs/scene";
  20174. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20175. import { PoseEnabledController, ExtendedGamepadButton, MutableGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  20176. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  20177. import { Nullable } from "babylonjs/types";
  20178. /**
  20179. * Defines the WebVRController object that represents controllers tracked in 3D space
  20180. */
  20181. export abstract class WebVRController extends PoseEnabledController {
  20182. /**
  20183. * Internal, the default controller model for the controller
  20184. */
  20185. protected _defaultModel: Nullable<AbstractMesh>;
  20186. /**
  20187. * Fired when the trigger state has changed
  20188. */
  20189. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  20190. /**
  20191. * Fired when the main button state has changed
  20192. */
  20193. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  20194. /**
  20195. * Fired when the secondary button state has changed
  20196. */
  20197. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  20198. /**
  20199. * Fired when the pad state has changed
  20200. */
  20201. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  20202. /**
  20203. * Fired when controllers stick values have changed
  20204. */
  20205. onPadValuesChangedObservable: Observable<StickValues>;
  20206. /**
  20207. * Array of button availible on the controller
  20208. */
  20209. protected _buttons: Array<MutableGamepadButton>;
  20210. private _onButtonStateChange;
  20211. /**
  20212. * Fired when a controller button's state has changed
  20213. * @param callback the callback containing the button that was modified
  20214. */
  20215. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  20216. /**
  20217. * X and Y axis corresponding to the controllers joystick
  20218. */
  20219. pad: StickValues;
  20220. /**
  20221. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  20222. */
  20223. hand: string;
  20224. /**
  20225. * The default controller model for the controller
  20226. */
  20227. get defaultModel(): Nullable<AbstractMesh>;
  20228. /**
  20229. * Creates a new WebVRController from a gamepad
  20230. * @param vrGamepad the gamepad that the WebVRController should be created from
  20231. */
  20232. constructor(vrGamepad: any);
  20233. /**
  20234. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  20235. */
  20236. update(): void;
  20237. /**
  20238. * Function to be called when a button is modified
  20239. */
  20240. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  20241. /**
  20242. * Loads a mesh and attaches it to the controller
  20243. * @param scene the scene the mesh should be added to
  20244. * @param meshLoaded callback for when the mesh has been loaded
  20245. */
  20246. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  20247. private _setButtonValue;
  20248. private _changes;
  20249. private _checkChanges;
  20250. /**
  20251. * Disposes of th webVRCOntroller
  20252. */
  20253. dispose(): void;
  20254. }
  20255. }
  20256. declare module "babylonjs/Lights/hemisphericLight" {
  20257. import { Nullable } from "babylonjs/types";
  20258. import { Scene } from "babylonjs/scene";
  20259. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20260. import { Color3 } from "babylonjs/Maths/math.color";
  20261. import { Effect } from "babylonjs/Materials/effect";
  20262. import { Light } from "babylonjs/Lights/light";
  20263. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  20264. /**
  20265. * The HemisphericLight simulates the ambient environment light,
  20266. * so the passed direction is the light reflection direction, not the incoming direction.
  20267. */
  20268. export class HemisphericLight extends Light {
  20269. /**
  20270. * The groundColor is the light in the opposite direction to the one specified during creation.
  20271. * 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.
  20272. */
  20273. groundColor: Color3;
  20274. /**
  20275. * The light reflection direction, not the incoming direction.
  20276. */
  20277. direction: Vector3;
  20278. /**
  20279. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  20280. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  20281. * The HemisphericLight can't cast shadows.
  20282. * Documentation : https://doc.babylonjs.com/babylon101/lights
  20283. * @param name The friendly name of the light
  20284. * @param direction The direction of the light reflection
  20285. * @param scene The scene the light belongs to
  20286. */
  20287. constructor(name: string, direction: Vector3, scene: Scene);
  20288. protected _buildUniformLayout(): void;
  20289. /**
  20290. * Returns the string "HemisphericLight".
  20291. * @return The class name
  20292. */
  20293. getClassName(): string;
  20294. /**
  20295. * Sets the HemisphericLight direction towards the passed target (Vector3).
  20296. * Returns the updated direction.
  20297. * @param target The target the direction should point to
  20298. * @return The computed direction
  20299. */
  20300. setDirectionToTarget(target: Vector3): Vector3;
  20301. /**
  20302. * Returns the shadow generator associated to the light.
  20303. * @returns Always null for hemispheric lights because it does not support shadows.
  20304. */
  20305. getShadowGenerator(): Nullable<IShadowGenerator>;
  20306. /**
  20307. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  20308. * @param effect The effect to update
  20309. * @param lightIndex The index of the light in the effect to update
  20310. * @returns The hemispheric light
  20311. */
  20312. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  20313. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  20314. /**
  20315. * Computes the world matrix of the node
  20316. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  20317. * @param useWasUpdatedFlag defines a reserved property
  20318. * @returns the world matrix
  20319. */
  20320. computeWorldMatrix(): Matrix;
  20321. /**
  20322. * Returns the integer 3.
  20323. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  20324. */
  20325. getTypeID(): number;
  20326. /**
  20327. * Prepares the list of defines specific to the light type.
  20328. * @param defines the list of defines
  20329. * @param lightIndex defines the index of the light for the effect
  20330. */
  20331. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  20332. }
  20333. }
  20334. declare module "babylonjs/Shaders/vrMultiviewToSingleview.fragment" {
  20335. /** @hidden */
  20336. export var vrMultiviewToSingleviewPixelShader: {
  20337. name: string;
  20338. shader: string;
  20339. };
  20340. }
  20341. declare module "babylonjs/Materials/Textures/MultiviewRenderTarget" {
  20342. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20343. import { Scene } from "babylonjs/scene";
  20344. /**
  20345. * Renders to multiple views with a single draw call
  20346. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  20347. */
  20348. export class MultiviewRenderTarget extends RenderTargetTexture {
  20349. /**
  20350. * Creates a multiview render target
  20351. * @param scene scene used with the render target
  20352. * @param size the size of the render target (used for each view)
  20353. */
  20354. constructor(scene: Scene, size?: number | {
  20355. width: number;
  20356. height: number;
  20357. } | {
  20358. ratio: number;
  20359. });
  20360. /**
  20361. * @hidden
  20362. * @param faceIndex the face index, if its a cube texture
  20363. */
  20364. _bindFrameBuffer(faceIndex?: number): void;
  20365. /**
  20366. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  20367. * @returns the view count
  20368. */
  20369. getViewCount(): number;
  20370. }
  20371. }
  20372. declare module "babylonjs/Engines/Extensions/engine.multiview" {
  20373. import { Camera } from "babylonjs/Cameras/camera";
  20374. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  20375. import { Nullable } from "babylonjs/types";
  20376. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20377. import { Matrix } from "babylonjs/Maths/math.vector";
  20378. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20379. module "babylonjs/Engines/engine" {
  20380. interface Engine {
  20381. /**
  20382. * Creates a new multiview render target
  20383. * @param width defines the width of the texture
  20384. * @param height defines the height of the texture
  20385. * @returns the created multiview texture
  20386. */
  20387. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  20388. /**
  20389. * Binds a multiview framebuffer to be drawn to
  20390. * @param multiviewTexture texture to bind
  20391. */
  20392. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  20393. }
  20394. }
  20395. module "babylonjs/Cameras/camera" {
  20396. interface Camera {
  20397. /**
  20398. * @hidden
  20399. * 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)
  20400. */
  20401. _useMultiviewToSingleView: boolean;
  20402. /**
  20403. * @hidden
  20404. * 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)
  20405. */
  20406. _multiviewTexture: Nullable<RenderTargetTexture>;
  20407. /**
  20408. * @hidden
  20409. * ensures the multiview texture of the camera exists and has the specified width/height
  20410. * @param width height to set on the multiview texture
  20411. * @param height width to set on the multiview texture
  20412. */
  20413. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  20414. }
  20415. }
  20416. module "babylonjs/scene" {
  20417. interface Scene {
  20418. /** @hidden */
  20419. _transformMatrixR: Matrix;
  20420. /** @hidden */
  20421. _multiviewSceneUbo: Nullable<UniformBuffer>;
  20422. /** @hidden */
  20423. _createMultiviewUbo(): void;
  20424. /** @hidden */
  20425. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  20426. /** @hidden */
  20427. _renderMultiviewToSingleView(camera: Camera): void;
  20428. }
  20429. }
  20430. }
  20431. declare module "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess" {
  20432. import { Camera } from "babylonjs/Cameras/camera";
  20433. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  20434. import "babylonjs/Shaders/vrMultiviewToSingleview.fragment";
  20435. import "babylonjs/Engines/Extensions/engine.multiview";
  20436. /**
  20437. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  20438. * This will not be used for webXR as it supports displaying texture arrays directly
  20439. */
  20440. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  20441. /**
  20442. * Gets a string identifying the name of the class
  20443. * @returns "VRMultiviewToSingleviewPostProcess" string
  20444. */
  20445. getClassName(): string;
  20446. /**
  20447. * Initializes a VRMultiviewToSingleview
  20448. * @param name name of the post process
  20449. * @param camera camera to be applied to
  20450. * @param scaleFactor scaling factor to the size of the output texture
  20451. */
  20452. constructor(name: string, camera: Camera, scaleFactor: number);
  20453. }
  20454. }
  20455. declare module "babylonjs/Cameras/RigModes/webVRRigMode" { }
  20456. declare module "babylonjs/Engines/Extensions/engine.webVR" {
  20457. import { Nullable } from "babylonjs/types";
  20458. import { Size } from "babylonjs/Maths/math.size";
  20459. import { Observable } from "babylonjs/Misc/observable";
  20460. import { WebVROptions } from "babylonjs/Cameras/VR/webVRCamera";
  20461. /**
  20462. * Interface used to define additional presentation attributes
  20463. */
  20464. export interface IVRPresentationAttributes {
  20465. /**
  20466. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  20467. */
  20468. highRefreshRate: boolean;
  20469. /**
  20470. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  20471. */
  20472. foveationLevel: number;
  20473. }
  20474. module "babylonjs/Engines/engine" {
  20475. interface Engine {
  20476. /** @hidden */
  20477. _vrDisplay: any;
  20478. /** @hidden */
  20479. _vrSupported: boolean;
  20480. /** @hidden */
  20481. _oldSize: Size;
  20482. /** @hidden */
  20483. _oldHardwareScaleFactor: number;
  20484. /** @hidden */
  20485. _vrExclusivePointerMode: boolean;
  20486. /** @hidden */
  20487. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  20488. /** @hidden */
  20489. _onVRDisplayPointerRestricted: () => void;
  20490. /** @hidden */
  20491. _onVRDisplayPointerUnrestricted: () => void;
  20492. /** @hidden */
  20493. _onVrDisplayConnect: Nullable<(display: any) => void>;
  20494. /** @hidden */
  20495. _onVrDisplayDisconnect: Nullable<() => void>;
  20496. /** @hidden */
  20497. _onVrDisplayPresentChange: Nullable<() => void>;
  20498. /**
  20499. * Observable signaled when VR display mode changes
  20500. */
  20501. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  20502. /**
  20503. * Observable signaled when VR request present is complete
  20504. */
  20505. onVRRequestPresentComplete: Observable<boolean>;
  20506. /**
  20507. * Observable signaled when VR request present starts
  20508. */
  20509. onVRRequestPresentStart: Observable<Engine>;
  20510. /**
  20511. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  20512. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  20513. */
  20514. isInVRExclusivePointerMode: boolean;
  20515. /**
  20516. * Gets a boolean indicating if a webVR device was detected
  20517. * @returns true if a webVR device was detected
  20518. */
  20519. isVRDevicePresent(): boolean;
  20520. /**
  20521. * Gets the current webVR device
  20522. * @returns the current webVR device (or null)
  20523. */
  20524. getVRDevice(): any;
  20525. /**
  20526. * Initializes a webVR display and starts listening to display change events
  20527. * The onVRDisplayChangedObservable will be notified upon these changes
  20528. * @returns A promise containing a VRDisplay and if vr is supported
  20529. */
  20530. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  20531. /** @hidden */
  20532. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  20533. /**
  20534. * Gets or sets the presentation attributes used to configure VR rendering
  20535. */
  20536. vrPresentationAttributes?: IVRPresentationAttributes;
  20537. /**
  20538. * Call this function to switch to webVR mode
  20539. * Will do nothing if webVR is not supported or if there is no webVR device
  20540. * @param options the webvr options provided to the camera. mainly used for multiview
  20541. * @see https://doc.babylonjs.com/how_to/webvr_camera
  20542. */
  20543. enableVR(options: WebVROptions): void;
  20544. /** @hidden */
  20545. _onVRFullScreenTriggered(): void;
  20546. }
  20547. }
  20548. }
  20549. declare module "babylonjs/Cameras/VR/webVRCamera" {
  20550. import { Nullable } from "babylonjs/types";
  20551. import { Observable } from "babylonjs/Misc/observable";
  20552. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  20553. import { Scene } from "babylonjs/scene";
  20554. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20555. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  20556. import { Node } from "babylonjs/node";
  20557. import { Ray } from "babylonjs/Culling/ray";
  20558. import "babylonjs/Cameras/RigModes/webVRRigMode";
  20559. import "babylonjs/Engines/Extensions/engine.webVR";
  20560. /**
  20561. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  20562. * IMPORTANT!! The data is right-hand data.
  20563. * @export
  20564. * @interface DevicePose
  20565. */
  20566. export interface DevicePose {
  20567. /**
  20568. * The position of the device, values in array are [x,y,z].
  20569. */
  20570. readonly position: Nullable<Float32Array>;
  20571. /**
  20572. * The linearVelocity of the device, values in array are [x,y,z].
  20573. */
  20574. readonly linearVelocity: Nullable<Float32Array>;
  20575. /**
  20576. * The linearAcceleration of the device, values in array are [x,y,z].
  20577. */
  20578. readonly linearAcceleration: Nullable<Float32Array>;
  20579. /**
  20580. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  20581. */
  20582. readonly orientation: Nullable<Float32Array>;
  20583. /**
  20584. * The angularVelocity of the device, values in array are [x,y,z].
  20585. */
  20586. readonly angularVelocity: Nullable<Float32Array>;
  20587. /**
  20588. * The angularAcceleration of the device, values in array are [x,y,z].
  20589. */
  20590. readonly angularAcceleration: Nullable<Float32Array>;
  20591. }
  20592. /**
  20593. * Interface representing a pose controlled object in Babylon.
  20594. * A pose controlled object has both regular pose values as well as pose values
  20595. * from an external device such as a VR head mounted display
  20596. */
  20597. export interface PoseControlled {
  20598. /**
  20599. * The position of the object in babylon space.
  20600. */
  20601. position: Vector3;
  20602. /**
  20603. * The rotation quaternion of the object in babylon space.
  20604. */
  20605. rotationQuaternion: Quaternion;
  20606. /**
  20607. * The position of the device in babylon space.
  20608. */
  20609. devicePosition?: Vector3;
  20610. /**
  20611. * The rotation quaternion of the device in babylon space.
  20612. */
  20613. deviceRotationQuaternion: Quaternion;
  20614. /**
  20615. * The raw pose coming from the device.
  20616. */
  20617. rawPose: Nullable<DevicePose>;
  20618. /**
  20619. * The scale of the device to be used when translating from device space to babylon space.
  20620. */
  20621. deviceScaleFactor: number;
  20622. /**
  20623. * Updates the poseControlled values based on the input device pose.
  20624. * @param poseData the pose data to update the object with
  20625. */
  20626. updateFromDevice(poseData: DevicePose): void;
  20627. }
  20628. /**
  20629. * Set of options to customize the webVRCamera
  20630. */
  20631. export interface WebVROptions {
  20632. /**
  20633. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  20634. */
  20635. trackPosition?: boolean;
  20636. /**
  20637. * Sets the scale of the vrDevice in babylon space. (default: 1)
  20638. */
  20639. positionScale?: number;
  20640. /**
  20641. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  20642. */
  20643. displayName?: string;
  20644. /**
  20645. * Should the native controller meshes be initialized. (default: true)
  20646. */
  20647. controllerMeshes?: boolean;
  20648. /**
  20649. * Creating a default HemiLight only on controllers. (default: true)
  20650. */
  20651. defaultLightingOnControllers?: boolean;
  20652. /**
  20653. * If you don't want to use the default VR button of the helper. (default: false)
  20654. */
  20655. useCustomVRButton?: boolean;
  20656. /**
  20657. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  20658. */
  20659. customVRButton?: HTMLButtonElement;
  20660. /**
  20661. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  20662. */
  20663. rayLength?: number;
  20664. /**
  20665. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  20666. */
  20667. defaultHeight?: number;
  20668. /**
  20669. * If multiview should be used if availible (default: false)
  20670. */
  20671. useMultiview?: boolean;
  20672. }
  20673. /**
  20674. * This represents a WebVR camera.
  20675. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  20676. * @example https://doc.babylonjs.com/how_to/webvr_camera
  20677. */
  20678. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  20679. private webVROptions;
  20680. /**
  20681. * @hidden
  20682. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  20683. */
  20684. _vrDevice: any;
  20685. /**
  20686. * The rawPose of the vrDevice.
  20687. */
  20688. rawPose: Nullable<DevicePose>;
  20689. private _onVREnabled;
  20690. private _specsVersion;
  20691. private _attached;
  20692. private _frameData;
  20693. protected _descendants: Array<Node>;
  20694. private _deviceRoomPosition;
  20695. /** @hidden */
  20696. _deviceRoomRotationQuaternion: Quaternion;
  20697. private _standingMatrix;
  20698. /**
  20699. * Represents device position in babylon space.
  20700. */
  20701. devicePosition: Vector3;
  20702. /**
  20703. * Represents device rotation in babylon space.
  20704. */
  20705. deviceRotationQuaternion: Quaternion;
  20706. /**
  20707. * The scale of the device to be used when translating from device space to babylon space.
  20708. */
  20709. deviceScaleFactor: number;
  20710. private _deviceToWorld;
  20711. private _worldToDevice;
  20712. /**
  20713. * References to the webVR controllers for the vrDevice.
  20714. */
  20715. controllers: Array<WebVRController>;
  20716. /**
  20717. * Emits an event when a controller is attached.
  20718. */
  20719. onControllersAttachedObservable: Observable<WebVRController[]>;
  20720. /**
  20721. * Emits an event when a controller's mesh has been loaded;
  20722. */
  20723. onControllerMeshLoadedObservable: Observable<WebVRController>;
  20724. /**
  20725. * Emits an event when the HMD's pose has been updated.
  20726. */
  20727. onPoseUpdatedFromDeviceObservable: Observable<any>;
  20728. private _poseSet;
  20729. /**
  20730. * If the rig cameras be used as parent instead of this camera.
  20731. */
  20732. rigParenting: boolean;
  20733. private _lightOnControllers;
  20734. private _defaultHeight?;
  20735. /**
  20736. * Instantiates a WebVRFreeCamera.
  20737. * @param name The name of the WebVRFreeCamera
  20738. * @param position The starting anchor position for the camera
  20739. * @param scene The scene the camera belongs to
  20740. * @param webVROptions a set of customizable options for the webVRCamera
  20741. */
  20742. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  20743. /**
  20744. * Gets the device distance from the ground in meters.
  20745. * @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.
  20746. */
  20747. deviceDistanceToRoomGround(): number;
  20748. /**
  20749. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20750. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  20751. */
  20752. useStandingMatrix(callback?: (bool: boolean) => void): void;
  20753. /**
  20754. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20755. * @returns A promise with a boolean set to if the standing matrix is supported.
  20756. */
  20757. useStandingMatrixAsync(): Promise<boolean>;
  20758. /**
  20759. * Disposes the camera
  20760. */
  20761. dispose(): void;
  20762. /**
  20763. * Gets a vrController by name.
  20764. * @param name The name of the controller to retreive
  20765. * @returns the controller matching the name specified or null if not found
  20766. */
  20767. getControllerByName(name: string): Nullable<WebVRController>;
  20768. private _leftController;
  20769. /**
  20770. * The controller corresponding to the users left hand.
  20771. */
  20772. get leftController(): Nullable<WebVRController>;
  20773. private _rightController;
  20774. /**
  20775. * The controller corresponding to the users right hand.
  20776. */
  20777. get rightController(): Nullable<WebVRController>;
  20778. /**
  20779. * Casts a ray forward from the vrCamera's gaze.
  20780. * @param length Length of the ray (default: 100)
  20781. * @returns the ray corresponding to the gaze
  20782. */
  20783. getForwardRay(length?: number): Ray;
  20784. /**
  20785. * @hidden
  20786. * Updates the camera based on device's frame data
  20787. */
  20788. _checkInputs(): void;
  20789. /**
  20790. * Updates the poseControlled values based on the input device pose.
  20791. * @param poseData Pose coming from the device
  20792. */
  20793. updateFromDevice(poseData: DevicePose): void;
  20794. private _htmlElementAttached;
  20795. private _detachIfAttached;
  20796. /**
  20797. * WebVR's attach control will start broadcasting frames to the device.
  20798. * Note that in certain browsers (chrome for example) this function must be called
  20799. * within a user-interaction callback. Example:
  20800. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  20801. *
  20802. * @param element html element to attach the vrDevice to
  20803. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  20804. */
  20805. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  20806. /**
  20807. * Detaches the camera from the html element and disables VR
  20808. *
  20809. * @param element html element to detach from
  20810. */
  20811. detachControl(element: HTMLElement): void;
  20812. /**
  20813. * @returns the name of this class
  20814. */
  20815. getClassName(): string;
  20816. /**
  20817. * Calls resetPose on the vrDisplay
  20818. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  20819. */
  20820. resetToCurrentRotation(): void;
  20821. /**
  20822. * @hidden
  20823. * Updates the rig cameras (left and right eye)
  20824. */
  20825. _updateRigCameras(): void;
  20826. private _workingVector;
  20827. private _oneVector;
  20828. private _workingMatrix;
  20829. private updateCacheCalled;
  20830. private _correctPositionIfNotTrackPosition;
  20831. /**
  20832. * @hidden
  20833. * Updates the cached values of the camera
  20834. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  20835. */
  20836. _updateCache(ignoreParentClass?: boolean): void;
  20837. /**
  20838. * @hidden
  20839. * Get current device position in babylon world
  20840. */
  20841. _computeDevicePosition(): void;
  20842. /**
  20843. * Updates the current device position and rotation in the babylon world
  20844. */
  20845. update(): void;
  20846. /**
  20847. * @hidden
  20848. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  20849. * @returns an identity matrix
  20850. */
  20851. _getViewMatrix(): Matrix;
  20852. private _tmpMatrix;
  20853. /**
  20854. * This function is called by the two RIG cameras.
  20855. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  20856. * @hidden
  20857. */
  20858. _getWebVRViewMatrix(): Matrix;
  20859. /** @hidden */
  20860. _getWebVRProjectionMatrix(): Matrix;
  20861. private _onGamepadConnectedObserver;
  20862. private _onGamepadDisconnectedObserver;
  20863. private _updateCacheWhenTrackingDisabledObserver;
  20864. /**
  20865. * Initializes the controllers and their meshes
  20866. */
  20867. initControllers(): void;
  20868. }
  20869. }
  20870. declare module "babylonjs/Materials/materialHelper" {
  20871. import { Nullable } from "babylonjs/types";
  20872. import { Scene } from "babylonjs/scene";
  20873. import { Engine } from "babylonjs/Engines/engine";
  20874. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20875. import { Light } from "babylonjs/Lights/light";
  20876. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20877. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  20878. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  20879. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  20880. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  20881. /**
  20882. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  20883. *
  20884. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  20885. *
  20886. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  20887. */
  20888. export class MaterialHelper {
  20889. /**
  20890. * Bind the current view position to an effect.
  20891. * @param effect The effect to be bound
  20892. * @param scene The scene the eyes position is used from
  20893. * @param variableName name of the shader variable that will hold the eye position
  20894. */
  20895. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  20896. /**
  20897. * Helps preparing the defines values about the UVs in used in the effect.
  20898. * UVs are shared as much as we can accross channels in the shaders.
  20899. * @param texture The texture we are preparing the UVs for
  20900. * @param defines The defines to update
  20901. * @param key The channel key "diffuse", "specular"... used in the shader
  20902. */
  20903. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  20904. /**
  20905. * Binds a texture matrix value to its corrsponding uniform
  20906. * @param texture The texture to bind the matrix for
  20907. * @param uniformBuffer The uniform buffer receivin the data
  20908. * @param key The channel key "diffuse", "specular"... used in the shader
  20909. */
  20910. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  20911. /**
  20912. * Gets the current status of the fog (should it be enabled?)
  20913. * @param mesh defines the mesh to evaluate for fog support
  20914. * @param scene defines the hosting scene
  20915. * @returns true if fog must be enabled
  20916. */
  20917. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  20918. /**
  20919. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  20920. * @param mesh defines the current mesh
  20921. * @param scene defines the current scene
  20922. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  20923. * @param pointsCloud defines if point cloud rendering has to be turned on
  20924. * @param fogEnabled defines if fog has to be turned on
  20925. * @param alphaTest defines if alpha testing has to be turned on
  20926. * @param defines defines the current list of defines
  20927. */
  20928. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  20929. /**
  20930. * Helper used to prepare the list of defines associated with frame values for shader compilation
  20931. * @param scene defines the current scene
  20932. * @param engine defines the current engine
  20933. * @param defines specifies the list of active defines
  20934. * @param useInstances defines if instances have to be turned on
  20935. * @param useClipPlane defines if clip plane have to be turned on
  20936. * @param useInstances defines if instances have to be turned on
  20937. * @param useThinInstances defines if thin instances have to be turned on
  20938. */
  20939. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  20940. /**
  20941. * Prepares the defines for bones
  20942. * @param mesh The mesh containing the geometry data we will draw
  20943. * @param defines The defines to update
  20944. */
  20945. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  20946. /**
  20947. * Prepares the defines for morph targets
  20948. * @param mesh The mesh containing the geometry data we will draw
  20949. * @param defines The defines to update
  20950. */
  20951. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  20952. /**
  20953. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  20954. * @param mesh The mesh containing the geometry data we will draw
  20955. * @param defines The defines to update
  20956. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  20957. * @param useBones Precise whether bones should be used or not (override mesh info)
  20958. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  20959. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  20960. * @returns false if defines are considered not dirty and have not been checked
  20961. */
  20962. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  20963. /**
  20964. * Prepares the defines related to multiview
  20965. * @param scene The scene we are intending to draw
  20966. * @param defines The defines to update
  20967. */
  20968. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  20969. /**
  20970. * Prepares the defines related to the prepass
  20971. * @param scene The scene we are intending to draw
  20972. * @param defines The defines to update
  20973. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  20974. */
  20975. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  20976. /**
  20977. * Prepares the defines related to the light information passed in parameter
  20978. * @param scene The scene we are intending to draw
  20979. * @param mesh The mesh the effect is compiling for
  20980. * @param light The light the effect is compiling for
  20981. * @param lightIndex The index of the light
  20982. * @param defines The defines to update
  20983. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20984. * @param state Defines the current state regarding what is needed (normals, etc...)
  20985. */
  20986. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  20987. needNormals: boolean;
  20988. needRebuild: boolean;
  20989. shadowEnabled: boolean;
  20990. specularEnabled: boolean;
  20991. lightmapMode: boolean;
  20992. }): void;
  20993. /**
  20994. * Prepares the defines related to the light information passed in parameter
  20995. * @param scene The scene we are intending to draw
  20996. * @param mesh The mesh the effect is compiling for
  20997. * @param defines The defines to update
  20998. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20999. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  21000. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  21001. * @returns true if normals will be required for the rest of the effect
  21002. */
  21003. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  21004. /**
  21005. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  21006. * @param lightIndex defines the light index
  21007. * @param uniformsList The uniform list
  21008. * @param samplersList The sampler list
  21009. * @param projectedLightTexture defines if projected texture must be used
  21010. * @param uniformBuffersList defines an optional list of uniform buffers
  21011. */
  21012. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  21013. /**
  21014. * Prepares the uniforms and samplers list to be used in the effect
  21015. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  21016. * @param samplersList The sampler list
  21017. * @param defines The defines helping in the list generation
  21018. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  21019. */
  21020. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  21021. /**
  21022. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  21023. * @param defines The defines to update while falling back
  21024. * @param fallbacks The authorized effect fallbacks
  21025. * @param maxSimultaneousLights The maximum number of lights allowed
  21026. * @param rank the current rank of the Effect
  21027. * @returns The newly affected rank
  21028. */
  21029. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  21030. private static _TmpMorphInfluencers;
  21031. /**
  21032. * Prepares the list of attributes required for morph targets according to the effect defines.
  21033. * @param attribs The current list of supported attribs
  21034. * @param mesh The mesh to prepare the morph targets attributes for
  21035. * @param influencers The number of influencers
  21036. */
  21037. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  21038. /**
  21039. * Prepares the list of attributes required for morph targets according to the effect defines.
  21040. * @param attribs The current list of supported attribs
  21041. * @param mesh The mesh to prepare the morph targets attributes for
  21042. * @param defines The current Defines of the effect
  21043. */
  21044. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  21045. /**
  21046. * Prepares the list of attributes required for bones according to the effect defines.
  21047. * @param attribs The current list of supported attribs
  21048. * @param mesh The mesh to prepare the bones attributes for
  21049. * @param defines The current Defines of the effect
  21050. * @param fallbacks The current efffect fallback strategy
  21051. */
  21052. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  21053. /**
  21054. * Check and prepare the list of attributes required for instances according to the effect defines.
  21055. * @param attribs The current list of supported attribs
  21056. * @param defines The current MaterialDefines of the effect
  21057. */
  21058. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  21059. /**
  21060. * Add the list of attributes required for instances to the attribs array.
  21061. * @param attribs The current list of supported attribs
  21062. */
  21063. static PushAttributesForInstances(attribs: string[]): void;
  21064. /**
  21065. * Binds the light information to the effect.
  21066. * @param light The light containing the generator
  21067. * @param effect The effect we are binding the data to
  21068. * @param lightIndex The light index in the effect used to render
  21069. */
  21070. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  21071. /**
  21072. * Binds the lights information from the scene to the effect for the given mesh.
  21073. * @param light Light to bind
  21074. * @param lightIndex Light index
  21075. * @param scene The scene where the light belongs to
  21076. * @param effect The effect we are binding the data to
  21077. * @param useSpecular Defines if specular is supported
  21078. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  21079. */
  21080. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  21081. /**
  21082. * Binds the lights information from the scene to the effect for the given mesh.
  21083. * @param scene The scene the lights belongs to
  21084. * @param mesh The mesh we are binding the information to render
  21085. * @param effect The effect we are binding the data to
  21086. * @param defines The generated defines for the effect
  21087. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  21088. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  21089. */
  21090. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  21091. private static _tempFogColor;
  21092. /**
  21093. * Binds the fog information from the scene to the effect for the given mesh.
  21094. * @param scene The scene the lights belongs to
  21095. * @param mesh The mesh we are binding the information to render
  21096. * @param effect The effect we are binding the data to
  21097. * @param linearSpace Defines if the fog effect is applied in linear space
  21098. */
  21099. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  21100. /**
  21101. * Binds the bones information from the mesh to the effect.
  21102. * @param mesh The mesh we are binding the information to render
  21103. * @param effect The effect we are binding the data to
  21104. */
  21105. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  21106. /**
  21107. * Binds the morph targets information from the mesh to the effect.
  21108. * @param abstractMesh The mesh we are binding the information to render
  21109. * @param effect The effect we are binding the data to
  21110. */
  21111. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  21112. /**
  21113. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  21114. * @param defines The generated defines used in the effect
  21115. * @param effect The effect we are binding the data to
  21116. * @param scene The scene we are willing to render with logarithmic scale for
  21117. */
  21118. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  21119. /**
  21120. * Binds the clip plane information from the scene to the effect.
  21121. * @param scene The scene the clip plane information are extracted from
  21122. * @param effect The effect we are binding the data to
  21123. */
  21124. static BindClipPlane(effect: Effect, scene: Scene): void;
  21125. }
  21126. }
  21127. declare module "babylonjs/Materials/Node/Blocks/Input/inputBlock" {
  21128. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21129. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21130. import { NodeMaterialSystemValues } from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  21131. import { Nullable } from "babylonjs/types";
  21132. import { Effect } from "babylonjs/Materials/effect";
  21133. import { Matrix } from "babylonjs/Maths/math.vector";
  21134. import { Scene } from "babylonjs/scene";
  21135. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21136. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21137. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21138. import { AnimatedInputBlockTypes } from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  21139. import { Observable } from "babylonjs/Misc/observable";
  21140. /**
  21141. * Block used to expose an input value
  21142. */
  21143. export class InputBlock extends NodeMaterialBlock {
  21144. private _mode;
  21145. private _associatedVariableName;
  21146. private _storedValue;
  21147. private _valueCallback;
  21148. private _type;
  21149. private _animationType;
  21150. /** Gets or set a value used to limit the range of float values */
  21151. min: number;
  21152. /** Gets or set a value used to limit the range of float values */
  21153. max: number;
  21154. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  21155. isBoolean: boolean;
  21156. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  21157. matrixMode: number;
  21158. /** @hidden */
  21159. _systemValue: Nullable<NodeMaterialSystemValues>;
  21160. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  21161. isConstant: boolean;
  21162. /** Gets or sets the group to use to display this block in the Inspector */
  21163. groupInInspector: string;
  21164. /** Gets an observable raised when the value is changed */
  21165. onValueChangedObservable: Observable<InputBlock>;
  21166. /**
  21167. * Gets or sets the connection point type (default is float)
  21168. */
  21169. get type(): NodeMaterialBlockConnectionPointTypes;
  21170. /**
  21171. * Creates a new InputBlock
  21172. * @param name defines the block name
  21173. * @param target defines the target of that block (Vertex by default)
  21174. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  21175. */
  21176. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  21177. /**
  21178. * Validates if a name is a reserve word.
  21179. * @param newName the new name to be given to the node.
  21180. * @returns false if the name is a reserve word, else true.
  21181. */
  21182. validateBlockName(newName: string): boolean;
  21183. /**
  21184. * Gets the output component
  21185. */
  21186. get output(): NodeMaterialConnectionPoint;
  21187. /**
  21188. * Set the source of this connection point to a vertex attribute
  21189. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  21190. * @returns the current connection point
  21191. */
  21192. setAsAttribute(attributeName?: string): InputBlock;
  21193. /**
  21194. * Set the source of this connection point to a system value
  21195. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  21196. * @returns the current connection point
  21197. */
  21198. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  21199. /**
  21200. * Gets or sets the value of that point.
  21201. * Please note that this value will be ignored if valueCallback is defined
  21202. */
  21203. get value(): any;
  21204. set value(value: any);
  21205. /**
  21206. * Gets or sets a callback used to get the value of that point.
  21207. * Please note that setting this value will force the connection point to ignore the value property
  21208. */
  21209. get valueCallback(): () => any;
  21210. set valueCallback(value: () => any);
  21211. /**
  21212. * Gets or sets the associated variable name in the shader
  21213. */
  21214. get associatedVariableName(): string;
  21215. set associatedVariableName(value: string);
  21216. /** Gets or sets the type of animation applied to the input */
  21217. get animationType(): AnimatedInputBlockTypes;
  21218. set animationType(value: AnimatedInputBlockTypes);
  21219. /**
  21220. * Gets a boolean indicating that this connection point not defined yet
  21221. */
  21222. get isUndefined(): boolean;
  21223. /**
  21224. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  21225. * In this case the connection point name must be the name of the uniform to use.
  21226. * Can only be set on inputs
  21227. */
  21228. get isUniform(): boolean;
  21229. set isUniform(value: boolean);
  21230. /**
  21231. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  21232. * In this case the connection point name must be the name of the attribute to use
  21233. * Can only be set on inputs
  21234. */
  21235. get isAttribute(): boolean;
  21236. set isAttribute(value: boolean);
  21237. /**
  21238. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  21239. * Can only be set on exit points
  21240. */
  21241. get isVarying(): boolean;
  21242. set isVarying(value: boolean);
  21243. /**
  21244. * Gets a boolean indicating that the current connection point is a system value
  21245. */
  21246. get isSystemValue(): boolean;
  21247. /**
  21248. * Gets or sets the current well known value or null if not defined as a system value
  21249. */
  21250. get systemValue(): Nullable<NodeMaterialSystemValues>;
  21251. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  21252. /**
  21253. * Gets the current class name
  21254. * @returns the class name
  21255. */
  21256. getClassName(): string;
  21257. /**
  21258. * Animate the input if animationType !== None
  21259. * @param scene defines the rendering scene
  21260. */
  21261. animate(scene: Scene): void;
  21262. private _emitDefine;
  21263. initialize(state: NodeMaterialBuildState): void;
  21264. /**
  21265. * Set the input block to its default value (based on its type)
  21266. */
  21267. setDefaultValue(): void;
  21268. private _emitConstant;
  21269. /** @hidden */
  21270. get _noContextSwitch(): boolean;
  21271. private _emit;
  21272. /** @hidden */
  21273. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  21274. /** @hidden */
  21275. _transmit(effect: Effect, scene: Scene): void;
  21276. protected _buildBlock(state: NodeMaterialBuildState): void;
  21277. protected _dumpPropertiesCode(): string;
  21278. dispose(): void;
  21279. serialize(): any;
  21280. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21281. }
  21282. }
  21283. declare module "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint" {
  21284. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21285. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21286. import { Nullable } from "babylonjs/types";
  21287. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  21288. import { Observable } from "babylonjs/Misc/observable";
  21289. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21290. /**
  21291. * Enum used to define the compatibility state between two connection points
  21292. */
  21293. export enum NodeMaterialConnectionPointCompatibilityStates {
  21294. /** Points are compatibles */
  21295. Compatible = 0,
  21296. /** Points are incompatible because of their types */
  21297. TypeIncompatible = 1,
  21298. /** Points are incompatible because of their targets (vertex vs fragment) */
  21299. TargetIncompatible = 2
  21300. }
  21301. /**
  21302. * Defines the direction of a connection point
  21303. */
  21304. export enum NodeMaterialConnectionPointDirection {
  21305. /** Input */
  21306. Input = 0,
  21307. /** Output */
  21308. Output = 1
  21309. }
  21310. /**
  21311. * Defines a connection point for a block
  21312. */
  21313. export class NodeMaterialConnectionPoint {
  21314. /** @hidden */
  21315. _ownerBlock: NodeMaterialBlock;
  21316. /** @hidden */
  21317. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  21318. private _endpoints;
  21319. private _associatedVariableName;
  21320. private _direction;
  21321. /** @hidden */
  21322. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21323. /** @hidden */
  21324. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21325. private _type;
  21326. /** @hidden */
  21327. _enforceAssociatedVariableName: boolean;
  21328. /** Gets the direction of the point */
  21329. get direction(): NodeMaterialConnectionPointDirection;
  21330. /** Indicates that this connection point needs dual validation before being connected to another point */
  21331. needDualDirectionValidation: boolean;
  21332. /**
  21333. * Gets or sets the additional types supported by this connection point
  21334. */
  21335. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21336. /**
  21337. * Gets or sets the additional types excluded by this connection point
  21338. */
  21339. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21340. /**
  21341. * Observable triggered when this point is connected
  21342. */
  21343. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  21344. /**
  21345. * Gets or sets the associated variable name in the shader
  21346. */
  21347. get associatedVariableName(): string;
  21348. set associatedVariableName(value: string);
  21349. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  21350. get innerType(): NodeMaterialBlockConnectionPointTypes;
  21351. /**
  21352. * Gets or sets the connection point type (default is float)
  21353. */
  21354. get type(): NodeMaterialBlockConnectionPointTypes;
  21355. set type(value: NodeMaterialBlockConnectionPointTypes);
  21356. /**
  21357. * Gets or sets the connection point name
  21358. */
  21359. name: string;
  21360. /**
  21361. * Gets or sets the connection point name
  21362. */
  21363. displayName: string;
  21364. /**
  21365. * Gets or sets a boolean indicating that this connection point can be omitted
  21366. */
  21367. isOptional: boolean;
  21368. /**
  21369. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  21370. */
  21371. isExposedOnFrame: boolean;
  21372. /**
  21373. * Gets or sets number indicating the position that the port is exposed to on a frame
  21374. */
  21375. exposedPortPosition: number;
  21376. /**
  21377. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  21378. */
  21379. define: string;
  21380. /** @hidden */
  21381. _prioritizeVertex: boolean;
  21382. private _target;
  21383. /** Gets or sets the target of that connection point */
  21384. get target(): NodeMaterialBlockTargets;
  21385. set target(value: NodeMaterialBlockTargets);
  21386. /**
  21387. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  21388. */
  21389. get isConnected(): boolean;
  21390. /**
  21391. * Gets a boolean indicating that the current point is connected to an input block
  21392. */
  21393. get isConnectedToInputBlock(): boolean;
  21394. /**
  21395. * Gets a the connected input block (if any)
  21396. */
  21397. get connectInputBlock(): Nullable<InputBlock>;
  21398. /** Get the other side of the connection (if any) */
  21399. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  21400. /** Get the block that owns this connection point */
  21401. get ownerBlock(): NodeMaterialBlock;
  21402. /** Get the block connected on the other side of this connection (if any) */
  21403. get sourceBlock(): Nullable<NodeMaterialBlock>;
  21404. /** Get the block connected on the endpoints of this connection (if any) */
  21405. get connectedBlocks(): Array<NodeMaterialBlock>;
  21406. /** Gets the list of connected endpoints */
  21407. get endpoints(): NodeMaterialConnectionPoint[];
  21408. /** Gets a boolean indicating if that output point is connected to at least one input */
  21409. get hasEndpoints(): boolean;
  21410. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  21411. get isConnectedInVertexShader(): boolean;
  21412. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  21413. get isConnectedInFragmentShader(): boolean;
  21414. /**
  21415. * Creates a block suitable to be used as an input for this input point.
  21416. * If null is returned, a block based on the point type will be created.
  21417. * @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
  21418. */
  21419. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21420. /**
  21421. * Creates a new connection point
  21422. * @param name defines the connection point name
  21423. * @param ownerBlock defines the block hosting this connection point
  21424. * @param direction defines the direction of the connection point
  21425. */
  21426. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  21427. /**
  21428. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  21429. * @returns the class name
  21430. */
  21431. getClassName(): string;
  21432. /**
  21433. * Gets a boolean indicating if the current point can be connected to another point
  21434. * @param connectionPoint defines the other connection point
  21435. * @returns a boolean
  21436. */
  21437. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  21438. /**
  21439. * Gets a number indicating if the current point can be connected to another point
  21440. * @param connectionPoint defines the other connection point
  21441. * @returns a number defining the compatibility state
  21442. */
  21443. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21444. /**
  21445. * Connect this point to another connection point
  21446. * @param connectionPoint defines the other connection point
  21447. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  21448. * @returns the current connection point
  21449. */
  21450. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  21451. /**
  21452. * Disconnect this point from one of his endpoint
  21453. * @param endpoint defines the other connection point
  21454. * @returns the current connection point
  21455. */
  21456. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  21457. /**
  21458. * Serializes this point in a JSON representation
  21459. * @param isInput defines if the connection point is an input (default is true)
  21460. * @returns the serialized point object
  21461. */
  21462. serialize(isInput?: boolean): any;
  21463. /**
  21464. * Release resources
  21465. */
  21466. dispose(): void;
  21467. }
  21468. }
  21469. declare module "babylonjs/Materials/Node/Enums/nodeMaterialModes" {
  21470. /**
  21471. * Enum used to define the material modes
  21472. */
  21473. export enum NodeMaterialModes {
  21474. /** Regular material */
  21475. Material = 0,
  21476. /** For post process */
  21477. PostProcess = 1,
  21478. /** For particle system */
  21479. Particle = 2,
  21480. /** For procedural texture */
  21481. ProceduralTexture = 3
  21482. }
  21483. }
  21484. declare module "babylonjs/Materials/Node/Blocks/Dual/textureBlock" {
  21485. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21486. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21487. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21488. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21489. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21490. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21491. import { Effect } from "babylonjs/Materials/effect";
  21492. import { Mesh } from "babylonjs/Meshes/mesh";
  21493. import { Nullable } from "babylonjs/types";
  21494. import { Texture } from "babylonjs/Materials/Textures/texture";
  21495. import { Scene } from "babylonjs/scene";
  21496. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  21497. /**
  21498. * Block used to read a texture from a sampler
  21499. */
  21500. export class TextureBlock extends NodeMaterialBlock {
  21501. private _defineName;
  21502. private _linearDefineName;
  21503. private _gammaDefineName;
  21504. private _tempTextureRead;
  21505. private _samplerName;
  21506. private _transformedUVName;
  21507. private _textureTransformName;
  21508. private _textureInfoName;
  21509. private _mainUVName;
  21510. private _mainUVDefineName;
  21511. private _fragmentOnly;
  21512. /**
  21513. * Gets or sets the texture associated with the node
  21514. */
  21515. texture: Nullable<Texture>;
  21516. /**
  21517. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21518. */
  21519. convertToGammaSpace: boolean;
  21520. /**
  21521. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21522. */
  21523. convertToLinearSpace: boolean;
  21524. /**
  21525. * Create a new TextureBlock
  21526. * @param name defines the block name
  21527. */
  21528. constructor(name: string, fragmentOnly?: boolean);
  21529. /**
  21530. * Gets the current class name
  21531. * @returns the class name
  21532. */
  21533. getClassName(): string;
  21534. /**
  21535. * Gets the uv input component
  21536. */
  21537. get uv(): NodeMaterialConnectionPoint;
  21538. /**
  21539. * Gets the rgba output component
  21540. */
  21541. get rgba(): NodeMaterialConnectionPoint;
  21542. /**
  21543. * Gets the rgb output component
  21544. */
  21545. get rgb(): NodeMaterialConnectionPoint;
  21546. /**
  21547. * Gets the r output component
  21548. */
  21549. get r(): NodeMaterialConnectionPoint;
  21550. /**
  21551. * Gets the g output component
  21552. */
  21553. get g(): NodeMaterialConnectionPoint;
  21554. /**
  21555. * Gets the b output component
  21556. */
  21557. get b(): NodeMaterialConnectionPoint;
  21558. /**
  21559. * Gets the a output component
  21560. */
  21561. get a(): NodeMaterialConnectionPoint;
  21562. get target(): NodeMaterialBlockTargets;
  21563. autoConfigure(material: NodeMaterial): void;
  21564. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  21565. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21566. isReady(): boolean;
  21567. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21568. private get _isMixed();
  21569. private _injectVertexCode;
  21570. private _writeTextureRead;
  21571. private _writeOutput;
  21572. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21573. protected _dumpPropertiesCode(): string;
  21574. serialize(): any;
  21575. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21576. }
  21577. }
  21578. declare module "babylonjs/Shaders/ShadersInclude/reflectionFunction" {
  21579. /** @hidden */
  21580. export var reflectionFunction: {
  21581. name: string;
  21582. shader: string;
  21583. };
  21584. }
  21585. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock" {
  21586. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21587. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21588. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21589. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  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 { Scene } from "babylonjs/scene";
  21596. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  21597. /**
  21598. * Base block used to read a reflection texture from a sampler
  21599. */
  21600. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  21601. /** @hidden */
  21602. _define3DName: string;
  21603. /** @hidden */
  21604. _defineCubicName: string;
  21605. /** @hidden */
  21606. _defineExplicitName: string;
  21607. /** @hidden */
  21608. _defineProjectionName: string;
  21609. /** @hidden */
  21610. _defineLocalCubicName: string;
  21611. /** @hidden */
  21612. _defineSphericalName: string;
  21613. /** @hidden */
  21614. _definePlanarName: string;
  21615. /** @hidden */
  21616. _defineEquirectangularName: string;
  21617. /** @hidden */
  21618. _defineMirroredEquirectangularFixedName: string;
  21619. /** @hidden */
  21620. _defineEquirectangularFixedName: string;
  21621. /** @hidden */
  21622. _defineSkyboxName: string;
  21623. /** @hidden */
  21624. _defineOppositeZ: string;
  21625. /** @hidden */
  21626. _cubeSamplerName: string;
  21627. /** @hidden */
  21628. _2DSamplerName: string;
  21629. protected _positionUVWName: string;
  21630. protected _directionWName: string;
  21631. protected _reflectionVectorName: string;
  21632. /** @hidden */
  21633. _reflectionCoordsName: string;
  21634. /** @hidden */
  21635. _reflectionMatrixName: string;
  21636. protected _reflectionColorName: string;
  21637. /**
  21638. * Gets or sets the texture associated with the node
  21639. */
  21640. texture: Nullable<BaseTexture>;
  21641. /**
  21642. * Create a new ReflectionTextureBaseBlock
  21643. * @param name defines the block name
  21644. */
  21645. constructor(name: string);
  21646. /**
  21647. * Gets the current class name
  21648. * @returns the class name
  21649. */
  21650. getClassName(): string;
  21651. /**
  21652. * Gets the world position input component
  21653. */
  21654. abstract get position(): NodeMaterialConnectionPoint;
  21655. /**
  21656. * Gets the world position input component
  21657. */
  21658. abstract get worldPosition(): NodeMaterialConnectionPoint;
  21659. /**
  21660. * Gets the world normal input component
  21661. */
  21662. abstract get worldNormal(): NodeMaterialConnectionPoint;
  21663. /**
  21664. * Gets the world input component
  21665. */
  21666. abstract get world(): NodeMaterialConnectionPoint;
  21667. /**
  21668. * Gets the camera (or eye) position component
  21669. */
  21670. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  21671. /**
  21672. * Gets the view input component
  21673. */
  21674. abstract get view(): NodeMaterialConnectionPoint;
  21675. protected _getTexture(): Nullable<BaseTexture>;
  21676. autoConfigure(material: NodeMaterial): void;
  21677. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21678. isReady(): boolean;
  21679. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21680. /**
  21681. * Gets the code to inject in the vertex shader
  21682. * @param state current state of the node material building
  21683. * @returns the shader code
  21684. */
  21685. handleVertexSide(state: NodeMaterialBuildState): string;
  21686. /**
  21687. * Handles the inits for the fragment code path
  21688. * @param state node material build state
  21689. */
  21690. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  21691. /**
  21692. * Generates the reflection coords code for the fragment code path
  21693. * @param worldNormalVarName name of the world normal variable
  21694. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  21695. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  21696. * @returns the shader code
  21697. */
  21698. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  21699. /**
  21700. * Generates the reflection color code for the fragment code path
  21701. * @param lodVarName name of the lod variable
  21702. * @param swizzleLookupTexture swizzle to use for the final color variable
  21703. * @returns the shader code
  21704. */
  21705. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  21706. /**
  21707. * Generates the code corresponding to the connected output points
  21708. * @param state node material build state
  21709. * @param varName name of the variable to output
  21710. * @returns the shader code
  21711. */
  21712. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  21713. protected _buildBlock(state: NodeMaterialBuildState): this;
  21714. protected _dumpPropertiesCode(): string;
  21715. serialize(): any;
  21716. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21717. }
  21718. }
  21719. declare module "babylonjs/Materials/Node/nodeMaterialConnectionPointCustomObject" {
  21720. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21721. import { NodeMaterialConnectionPoint, NodeMaterialConnectionPointDirection, NodeMaterialConnectionPointCompatibilityStates } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21722. import { Nullable } from "babylonjs/types";
  21723. /**
  21724. * Defines a connection point to be used for points with a custom object type
  21725. */
  21726. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  21727. private _blockType;
  21728. private _blockName;
  21729. private _nameForCheking?;
  21730. /**
  21731. * Creates a new connection point
  21732. * @param name defines the connection point name
  21733. * @param ownerBlock defines the block hosting this connection point
  21734. * @param direction defines the direction of the connection point
  21735. */
  21736. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  21737. /**
  21738. * Gets a number indicating if the current point can be connected to another point
  21739. * @param connectionPoint defines the other connection point
  21740. * @returns a number defining the compatibility state
  21741. */
  21742. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21743. /**
  21744. * Creates a block suitable to be used as an input for this input point.
  21745. * If null is returned, a block based on the point type will be created.
  21746. * @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
  21747. */
  21748. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21749. }
  21750. }
  21751. declare module "babylonjs/Materials/Node/nodeMaterialDecorator" {
  21752. /**
  21753. * Enum defining the type of properties that can be edited in the property pages in the NME
  21754. */
  21755. export enum PropertyTypeForEdition {
  21756. /** property is a boolean */
  21757. Boolean = 0,
  21758. /** property is a float */
  21759. Float = 1,
  21760. /** property is a Vector2 */
  21761. Vector2 = 2,
  21762. /** property is a list of values */
  21763. List = 3
  21764. }
  21765. /**
  21766. * Interface that defines an option in a variable of type list
  21767. */
  21768. export interface IEditablePropertyListOption {
  21769. /** label of the option */
  21770. "label": string;
  21771. /** value of the option */
  21772. "value": number;
  21773. }
  21774. /**
  21775. * Interface that defines the options available for an editable property
  21776. */
  21777. export interface IEditablePropertyOption {
  21778. /** min value */
  21779. "min"?: number;
  21780. /** max value */
  21781. "max"?: number;
  21782. /** notifiers: indicates which actions to take when the property is changed */
  21783. "notifiers"?: {
  21784. /** the material should be rebuilt */
  21785. "rebuild"?: boolean;
  21786. /** the preview should be updated */
  21787. "update"?: boolean;
  21788. };
  21789. /** list of the options for a variable of type list */
  21790. "options"?: IEditablePropertyListOption[];
  21791. }
  21792. /**
  21793. * Interface that describes an editable property
  21794. */
  21795. export interface IPropertyDescriptionForEdition {
  21796. /** name of the property */
  21797. "propertyName": string;
  21798. /** display name of the property */
  21799. "displayName": string;
  21800. /** type of the property */
  21801. "type": PropertyTypeForEdition;
  21802. /** group of the property - all properties with the same group value will be displayed in a specific section */
  21803. "groupName": string;
  21804. /** options for the property */
  21805. "options": IEditablePropertyOption;
  21806. }
  21807. /**
  21808. * Decorator that flags a property in a node material block as being editable
  21809. */
  21810. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  21811. }
  21812. declare module "babylonjs/Materials/Node/Blocks/PBR/refractionBlock" {
  21813. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21814. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21815. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21816. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21817. import { Nullable } from "babylonjs/types";
  21818. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21819. import { Mesh } from "babylonjs/Meshes/mesh";
  21820. import { SubMesh } from "babylonjs/Meshes/subMesh";
  21821. import { Effect } from "babylonjs/Materials/effect";
  21822. import { Scene } from "babylonjs/scene";
  21823. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21824. /**
  21825. * Block used to implement the refraction part of the sub surface module of the PBR material
  21826. */
  21827. export class RefractionBlock extends NodeMaterialBlock {
  21828. /** @hidden */
  21829. _define3DName: string;
  21830. /** @hidden */
  21831. _refractionMatrixName: string;
  21832. /** @hidden */
  21833. _defineLODRefractionAlpha: string;
  21834. /** @hidden */
  21835. _defineLinearSpecularRefraction: string;
  21836. /** @hidden */
  21837. _defineOppositeZ: string;
  21838. /** @hidden */
  21839. _cubeSamplerName: string;
  21840. /** @hidden */
  21841. _2DSamplerName: string;
  21842. /** @hidden */
  21843. _vRefractionMicrosurfaceInfosName: string;
  21844. /** @hidden */
  21845. _vRefractionInfosName: string;
  21846. private _scene;
  21847. /**
  21848. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  21849. * Materials half opaque for instance using refraction could benefit from this control.
  21850. */
  21851. linkRefractionWithTransparency: boolean;
  21852. /**
  21853. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  21854. */
  21855. invertRefractionY: boolean;
  21856. /**
  21857. * Gets or sets the texture associated with the node
  21858. */
  21859. texture: Nullable<BaseTexture>;
  21860. /**
  21861. * Create a new RefractionBlock
  21862. * @param name defines the block name
  21863. */
  21864. constructor(name: string);
  21865. /**
  21866. * Gets the current class name
  21867. * @returns the class name
  21868. */
  21869. getClassName(): string;
  21870. /**
  21871. * Gets the intensity input component
  21872. */
  21873. get intensity(): NodeMaterialConnectionPoint;
  21874. /**
  21875. * Gets the index of refraction input component
  21876. */
  21877. get indexOfRefraction(): NodeMaterialConnectionPoint;
  21878. /**
  21879. * Gets the tint at distance input component
  21880. */
  21881. get tintAtDistance(): NodeMaterialConnectionPoint;
  21882. /**
  21883. * Gets the view input component
  21884. */
  21885. get view(): NodeMaterialConnectionPoint;
  21886. /**
  21887. * Gets the refraction object output component
  21888. */
  21889. get refraction(): NodeMaterialConnectionPoint;
  21890. /**
  21891. * Returns true if the block has a texture
  21892. */
  21893. get hasTexture(): boolean;
  21894. protected _getTexture(): Nullable<BaseTexture>;
  21895. autoConfigure(material: NodeMaterial): void;
  21896. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21897. isReady(): boolean;
  21898. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  21899. /**
  21900. * Gets the main code of the block (fragment side)
  21901. * @param state current state of the node material building
  21902. * @returns the shader code
  21903. */
  21904. getCode(state: NodeMaterialBuildState): string;
  21905. protected _buildBlock(state: NodeMaterialBuildState): this;
  21906. protected _dumpPropertiesCode(): string;
  21907. serialize(): any;
  21908. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21909. }
  21910. }
  21911. declare module "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock" {
  21912. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21913. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21914. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21915. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21916. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21917. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21918. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21919. import { Nullable } from "babylonjs/types";
  21920. import { Scene } from "babylonjs/scene";
  21921. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21922. /**
  21923. * Base block used as input for post process
  21924. */
  21925. export class CurrentScreenBlock extends NodeMaterialBlock {
  21926. private _samplerName;
  21927. private _linearDefineName;
  21928. private _gammaDefineName;
  21929. private _mainUVName;
  21930. private _tempTextureRead;
  21931. /**
  21932. * Gets or sets the texture associated with the node
  21933. */
  21934. texture: Nullable<BaseTexture>;
  21935. /**
  21936. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21937. */
  21938. convertToGammaSpace: boolean;
  21939. /**
  21940. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21941. */
  21942. convertToLinearSpace: boolean;
  21943. /**
  21944. * Create a new CurrentScreenBlock
  21945. * @param name defines the block name
  21946. */
  21947. constructor(name: string);
  21948. /**
  21949. * Gets the current class name
  21950. * @returns the class name
  21951. */
  21952. getClassName(): string;
  21953. /**
  21954. * Gets the uv input component
  21955. */
  21956. get uv(): NodeMaterialConnectionPoint;
  21957. /**
  21958. * Gets the rgba output component
  21959. */
  21960. get rgba(): NodeMaterialConnectionPoint;
  21961. /**
  21962. * Gets the rgb output component
  21963. */
  21964. get rgb(): NodeMaterialConnectionPoint;
  21965. /**
  21966. * Gets the r output component
  21967. */
  21968. get r(): NodeMaterialConnectionPoint;
  21969. /**
  21970. * Gets the g output component
  21971. */
  21972. get g(): NodeMaterialConnectionPoint;
  21973. /**
  21974. * Gets the b output component
  21975. */
  21976. get b(): NodeMaterialConnectionPoint;
  21977. /**
  21978. * Gets the a output component
  21979. */
  21980. get a(): NodeMaterialConnectionPoint;
  21981. /**
  21982. * Initialize the block and prepare the context for build
  21983. * @param state defines the state that will be used for the build
  21984. */
  21985. initialize(state: NodeMaterialBuildState): void;
  21986. get target(): NodeMaterialBlockTargets;
  21987. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21988. isReady(): boolean;
  21989. private _injectVertexCode;
  21990. private _writeTextureRead;
  21991. private _writeOutput;
  21992. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21993. serialize(): any;
  21994. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21995. }
  21996. }
  21997. declare module "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock" {
  21998. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21999. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22000. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22001. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22002. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22003. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  22004. import { Nullable } from "babylonjs/types";
  22005. import { Scene } from "babylonjs/scene";
  22006. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  22007. /**
  22008. * Base block used for the particle texture
  22009. */
  22010. export class ParticleTextureBlock extends NodeMaterialBlock {
  22011. private _samplerName;
  22012. private _linearDefineName;
  22013. private _gammaDefineName;
  22014. private _tempTextureRead;
  22015. /**
  22016. * Gets or sets the texture associated with the node
  22017. */
  22018. texture: Nullable<BaseTexture>;
  22019. /**
  22020. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  22021. */
  22022. convertToGammaSpace: boolean;
  22023. /**
  22024. * Gets or sets a boolean indicating if content needs to be converted to linear space
  22025. */
  22026. convertToLinearSpace: boolean;
  22027. /**
  22028. * Create a new ParticleTextureBlock
  22029. * @param name defines the block name
  22030. */
  22031. constructor(name: string);
  22032. /**
  22033. * Gets the current class name
  22034. * @returns the class name
  22035. */
  22036. getClassName(): string;
  22037. /**
  22038. * Gets the uv input component
  22039. */
  22040. get uv(): NodeMaterialConnectionPoint;
  22041. /**
  22042. * Gets the rgba output component
  22043. */
  22044. get rgba(): NodeMaterialConnectionPoint;
  22045. /**
  22046. * Gets the rgb output component
  22047. */
  22048. get rgb(): NodeMaterialConnectionPoint;
  22049. /**
  22050. * Gets the r output component
  22051. */
  22052. get r(): NodeMaterialConnectionPoint;
  22053. /**
  22054. * Gets the g output component
  22055. */
  22056. get g(): NodeMaterialConnectionPoint;
  22057. /**
  22058. * Gets the b output component
  22059. */
  22060. get b(): NodeMaterialConnectionPoint;
  22061. /**
  22062. * Gets the a output component
  22063. */
  22064. get a(): NodeMaterialConnectionPoint;
  22065. /**
  22066. * Initialize the block and prepare the context for build
  22067. * @param state defines the state that will be used for the build
  22068. */
  22069. initialize(state: NodeMaterialBuildState): void;
  22070. autoConfigure(material: NodeMaterial): void;
  22071. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  22072. isReady(): boolean;
  22073. private _writeOutput;
  22074. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22075. serialize(): any;
  22076. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22077. }
  22078. }
  22079. declare module "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData" {
  22080. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22081. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22082. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  22083. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  22084. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  22085. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  22086. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  22087. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  22088. import { Scene } from "babylonjs/scene";
  22089. /**
  22090. * Class used to store shared data between 2 NodeMaterialBuildState
  22091. */
  22092. export class NodeMaterialBuildStateSharedData {
  22093. /**
  22094. * Gets the list of emitted varyings
  22095. */
  22096. temps: string[];
  22097. /**
  22098. * Gets the list of emitted varyings
  22099. */
  22100. varyings: string[];
  22101. /**
  22102. * Gets the varying declaration string
  22103. */
  22104. varyingDeclaration: string;
  22105. /**
  22106. * Input blocks
  22107. */
  22108. inputBlocks: InputBlock[];
  22109. /**
  22110. * Input blocks
  22111. */
  22112. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  22113. /**
  22114. * Bindable blocks (Blocks that need to set data to the effect)
  22115. */
  22116. bindableBlocks: NodeMaterialBlock[];
  22117. /**
  22118. * List of blocks that can provide a compilation fallback
  22119. */
  22120. blocksWithFallbacks: NodeMaterialBlock[];
  22121. /**
  22122. * List of blocks that can provide a define update
  22123. */
  22124. blocksWithDefines: NodeMaterialBlock[];
  22125. /**
  22126. * List of blocks that can provide a repeatable content
  22127. */
  22128. repeatableContentBlocks: NodeMaterialBlock[];
  22129. /**
  22130. * List of blocks that can provide a dynamic list of uniforms
  22131. */
  22132. dynamicUniformBlocks: NodeMaterialBlock[];
  22133. /**
  22134. * List of blocks that can block the isReady function for the material
  22135. */
  22136. blockingBlocks: NodeMaterialBlock[];
  22137. /**
  22138. * Gets the list of animated inputs
  22139. */
  22140. animatedInputs: InputBlock[];
  22141. /**
  22142. * Build Id used to avoid multiple recompilations
  22143. */
  22144. buildId: number;
  22145. /** List of emitted variables */
  22146. variableNames: {
  22147. [key: string]: number;
  22148. };
  22149. /** List of emitted defines */
  22150. defineNames: {
  22151. [key: string]: number;
  22152. };
  22153. /** Should emit comments? */
  22154. emitComments: boolean;
  22155. /** Emit build activity */
  22156. verbose: boolean;
  22157. /** Gets or sets the hosting scene */
  22158. scene: Scene;
  22159. /**
  22160. * Gets the compilation hints emitted at compilation time
  22161. */
  22162. hints: {
  22163. needWorldViewMatrix: boolean;
  22164. needWorldViewProjectionMatrix: boolean;
  22165. needAlphaBlending: boolean;
  22166. needAlphaTesting: boolean;
  22167. };
  22168. /**
  22169. * List of compilation checks
  22170. */
  22171. checks: {
  22172. emitVertex: boolean;
  22173. emitFragment: boolean;
  22174. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  22175. };
  22176. /**
  22177. * Is vertex program allowed to be empty?
  22178. */
  22179. allowEmptyVertexProgram: boolean;
  22180. /** Creates a new shared data */
  22181. constructor();
  22182. /**
  22183. * Emits console errors and exceptions if there is a failing check
  22184. */
  22185. emitErrors(): void;
  22186. }
  22187. }
  22188. declare module "babylonjs/Materials/Node/nodeMaterialBuildState" {
  22189. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22190. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22191. import { NodeMaterialBuildStateSharedData } from "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData";
  22192. /**
  22193. * Class used to store node based material build state
  22194. */
  22195. export class NodeMaterialBuildState {
  22196. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  22197. supportUniformBuffers: boolean;
  22198. /**
  22199. * Gets the list of emitted attributes
  22200. */
  22201. attributes: string[];
  22202. /**
  22203. * Gets the list of emitted uniforms
  22204. */
  22205. uniforms: string[];
  22206. /**
  22207. * Gets the list of emitted constants
  22208. */
  22209. constants: string[];
  22210. /**
  22211. * Gets the list of emitted samplers
  22212. */
  22213. samplers: string[];
  22214. /**
  22215. * Gets the list of emitted functions
  22216. */
  22217. functions: {
  22218. [key: string]: string;
  22219. };
  22220. /**
  22221. * Gets the list of emitted extensions
  22222. */
  22223. extensions: {
  22224. [key: string]: string;
  22225. };
  22226. /**
  22227. * Gets the target of the compilation state
  22228. */
  22229. target: NodeMaterialBlockTargets;
  22230. /**
  22231. * Gets the list of emitted counters
  22232. */
  22233. counters: {
  22234. [key: string]: number;
  22235. };
  22236. /**
  22237. * Shared data between multiple NodeMaterialBuildState instances
  22238. */
  22239. sharedData: NodeMaterialBuildStateSharedData;
  22240. /** @hidden */
  22241. _vertexState: NodeMaterialBuildState;
  22242. /** @hidden */
  22243. _attributeDeclaration: string;
  22244. /** @hidden */
  22245. _uniformDeclaration: string;
  22246. /** @hidden */
  22247. _constantDeclaration: string;
  22248. /** @hidden */
  22249. _samplerDeclaration: string;
  22250. /** @hidden */
  22251. _varyingTransfer: string;
  22252. /** @hidden */
  22253. _injectAtEnd: string;
  22254. private _repeatableContentAnchorIndex;
  22255. /** @hidden */
  22256. _builtCompilationString: string;
  22257. /**
  22258. * Gets the emitted compilation strings
  22259. */
  22260. compilationString: string;
  22261. /**
  22262. * Finalize the compilation strings
  22263. * @param state defines the current compilation state
  22264. */
  22265. finalize(state: NodeMaterialBuildState): void;
  22266. /** @hidden */
  22267. get _repeatableContentAnchor(): string;
  22268. /** @hidden */
  22269. _getFreeVariableName(prefix: string): string;
  22270. /** @hidden */
  22271. _getFreeDefineName(prefix: string): string;
  22272. /** @hidden */
  22273. _excludeVariableName(name: string): void;
  22274. /** @hidden */
  22275. _emit2DSampler(name: string): void;
  22276. /** @hidden */
  22277. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  22278. /** @hidden */
  22279. _emitExtension(name: string, extension: string, define?: string): void;
  22280. /** @hidden */
  22281. _emitFunction(name: string, code: string, comments: string): void;
  22282. /** @hidden */
  22283. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  22284. replaceStrings?: {
  22285. search: RegExp;
  22286. replace: string;
  22287. }[];
  22288. repeatKey?: string;
  22289. }): string;
  22290. /** @hidden */
  22291. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  22292. repeatKey?: string;
  22293. removeAttributes?: boolean;
  22294. removeUniforms?: boolean;
  22295. removeVaryings?: boolean;
  22296. removeIfDef?: boolean;
  22297. replaceStrings?: {
  22298. search: RegExp;
  22299. replace: string;
  22300. }[];
  22301. }, storeKey?: string): void;
  22302. /** @hidden */
  22303. _registerTempVariable(name: string): boolean;
  22304. /** @hidden */
  22305. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  22306. /** @hidden */
  22307. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  22308. /** @hidden */
  22309. _emitFloat(value: number): string;
  22310. }
  22311. }
  22312. declare module "babylonjs/Misc/uniqueIdGenerator" {
  22313. /**
  22314. * Helper class used to generate session unique ID
  22315. */
  22316. export class UniqueIdGenerator {
  22317. private static _UniqueIdCounter;
  22318. /**
  22319. * Gets an unique (relatively to the current scene) Id
  22320. */
  22321. static get UniqueId(): number;
  22322. }
  22323. }
  22324. declare module "babylonjs/Materials/Node/nodeMaterialBlock" {
  22325. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22326. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22327. import { Nullable } from "babylonjs/types";
  22328. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22329. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22330. import { Effect } from "babylonjs/Materials/effect";
  22331. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22332. import { Mesh } from "babylonjs/Meshes/mesh";
  22333. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22334. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22335. import { Scene } from "babylonjs/scene";
  22336. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  22337. /**
  22338. * Defines a block that can be used inside a node based material
  22339. */
  22340. export class NodeMaterialBlock {
  22341. private _buildId;
  22342. private _buildTarget;
  22343. private _target;
  22344. private _isFinalMerger;
  22345. private _isInput;
  22346. private _name;
  22347. protected _isUnique: boolean;
  22348. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  22349. inputsAreExclusive: boolean;
  22350. /** @hidden */
  22351. _codeVariableName: string;
  22352. /** @hidden */
  22353. _inputs: NodeMaterialConnectionPoint[];
  22354. /** @hidden */
  22355. _outputs: NodeMaterialConnectionPoint[];
  22356. /** @hidden */
  22357. _preparationId: number;
  22358. /**
  22359. * Gets the name of the block
  22360. */
  22361. get name(): string;
  22362. /**
  22363. * Sets the name of the block. Will check if the name is valid.
  22364. */
  22365. set name(newName: string);
  22366. /**
  22367. * Gets or sets the unique id of the node
  22368. */
  22369. uniqueId: number;
  22370. /**
  22371. * Gets or sets the comments associated with this block
  22372. */
  22373. comments: string;
  22374. /**
  22375. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  22376. */
  22377. get isUnique(): boolean;
  22378. /**
  22379. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  22380. */
  22381. get isFinalMerger(): boolean;
  22382. /**
  22383. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  22384. */
  22385. get isInput(): boolean;
  22386. /**
  22387. * Gets or sets the build Id
  22388. */
  22389. get buildId(): number;
  22390. set buildId(value: number);
  22391. /**
  22392. * Gets or sets the target of the block
  22393. */
  22394. get target(): NodeMaterialBlockTargets;
  22395. set target(value: NodeMaterialBlockTargets);
  22396. /**
  22397. * Gets the list of input points
  22398. */
  22399. get inputs(): NodeMaterialConnectionPoint[];
  22400. /** Gets the list of output points */
  22401. get outputs(): NodeMaterialConnectionPoint[];
  22402. /**
  22403. * Find an input by its name
  22404. * @param name defines the name of the input to look for
  22405. * @returns the input or null if not found
  22406. */
  22407. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22408. /**
  22409. * Find an output by its name
  22410. * @param name defines the name of the outputto look for
  22411. * @returns the output or null if not found
  22412. */
  22413. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22414. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  22415. visibleInInspector: boolean;
  22416. /**
  22417. * Creates a new NodeMaterialBlock
  22418. * @param name defines the block name
  22419. * @param target defines the target of that block (Vertex by default)
  22420. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  22421. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  22422. */
  22423. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  22424. /**
  22425. * Initialize the block and prepare the context for build
  22426. * @param state defines the state that will be used for the build
  22427. */
  22428. initialize(state: NodeMaterialBuildState): void;
  22429. /**
  22430. * Bind data to effect. Will only be called for blocks with isBindable === true
  22431. * @param effect defines the effect to bind data to
  22432. * @param nodeMaterial defines the hosting NodeMaterial
  22433. * @param mesh defines the mesh that will be rendered
  22434. * @param subMesh defines the submesh that will be rendered
  22435. */
  22436. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  22437. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  22438. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  22439. protected _writeFloat(value: number): string;
  22440. /**
  22441. * Gets the current class name e.g. "NodeMaterialBlock"
  22442. * @returns the class name
  22443. */
  22444. getClassName(): string;
  22445. /**
  22446. * Register a new input. Must be called inside a block constructor
  22447. * @param name defines the connection point name
  22448. * @param type defines the connection point type
  22449. * @param isOptional defines a boolean indicating that this input can be omitted
  22450. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22451. * @param point an already created connection point. If not provided, create a new one
  22452. * @returns the current block
  22453. */
  22454. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22455. /**
  22456. * Register a new output. Must be called inside a block constructor
  22457. * @param name defines the connection point name
  22458. * @param type defines the connection point type
  22459. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22460. * @param point an already created connection point. If not provided, create a new one
  22461. * @returns the current block
  22462. */
  22463. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22464. /**
  22465. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  22466. * @param forOutput defines an optional connection point to check compatibility with
  22467. * @returns the first available input or null
  22468. */
  22469. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  22470. /**
  22471. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  22472. * @param forBlock defines an optional block to check compatibility with
  22473. * @returns the first available input or null
  22474. */
  22475. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  22476. /**
  22477. * Gets the sibling of the given output
  22478. * @param current defines the current output
  22479. * @returns the next output in the list or null
  22480. */
  22481. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  22482. /**
  22483. * Connect current block with another block
  22484. * @param other defines the block to connect with
  22485. * @param options define the various options to help pick the right connections
  22486. * @returns the current block
  22487. */
  22488. connectTo(other: NodeMaterialBlock, options?: {
  22489. input?: string;
  22490. output?: string;
  22491. outputSwizzle?: string;
  22492. }): this | undefined;
  22493. protected _buildBlock(state: NodeMaterialBuildState): void;
  22494. /**
  22495. * Add uniforms, samplers and uniform buffers at compilation time
  22496. * @param state defines the state to update
  22497. * @param nodeMaterial defines the node material requesting the update
  22498. * @param defines defines the material defines to update
  22499. * @param uniformBuffers defines the list of uniform buffer names
  22500. */
  22501. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  22502. /**
  22503. * Add potential fallbacks if shader compilation fails
  22504. * @param mesh defines the mesh to be rendered
  22505. * @param fallbacks defines the current prioritized list of fallbacks
  22506. */
  22507. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  22508. /**
  22509. * Initialize defines for shader compilation
  22510. * @param mesh defines the mesh to be rendered
  22511. * @param nodeMaterial defines the node material requesting the update
  22512. * @param defines defines the material defines to update
  22513. * @param useInstances specifies that instances should be used
  22514. */
  22515. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  22516. /**
  22517. * Update defines for shader compilation
  22518. * @param mesh defines the mesh to be rendered
  22519. * @param nodeMaterial defines the node material requesting the update
  22520. * @param defines defines the material defines to update
  22521. * @param useInstances specifies that instances should be used
  22522. * @param subMesh defines which submesh to render
  22523. */
  22524. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22525. /**
  22526. * Lets the block try to connect some inputs automatically
  22527. * @param material defines the hosting NodeMaterial
  22528. */
  22529. autoConfigure(material: NodeMaterial): void;
  22530. /**
  22531. * Function called when a block is declared as repeatable content generator
  22532. * @param vertexShaderState defines the current compilation state for the vertex shader
  22533. * @param fragmentShaderState defines the current compilation state for the fragment shader
  22534. * @param mesh defines the mesh to be rendered
  22535. * @param defines defines the material defines to update
  22536. */
  22537. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  22538. /**
  22539. * Checks if the block is ready
  22540. * @param mesh defines the mesh to be rendered
  22541. * @param nodeMaterial defines the node material requesting the update
  22542. * @param defines defines the material defines to update
  22543. * @param useInstances specifies that instances should be used
  22544. * @returns true if the block is ready
  22545. */
  22546. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  22547. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  22548. private _processBuild;
  22549. /**
  22550. * Validates the new name for the block node.
  22551. * @param newName the new name to be given to the node.
  22552. * @returns false if the name is a reserve word, else true.
  22553. */
  22554. validateBlockName(newName: string): boolean;
  22555. /**
  22556. * Compile the current node and generate the shader code
  22557. * @param state defines the current compilation state (uniforms, samplers, current string)
  22558. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  22559. * @returns true if already built
  22560. */
  22561. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  22562. protected _inputRename(name: string): string;
  22563. protected _outputRename(name: string): string;
  22564. protected _dumpPropertiesCode(): string;
  22565. /** @hidden */
  22566. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  22567. /** @hidden */
  22568. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  22569. /**
  22570. * Clone the current block to a new identical block
  22571. * @param scene defines the hosting scene
  22572. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  22573. * @returns a copy of the current block
  22574. */
  22575. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  22576. /**
  22577. * Serializes this block in a JSON representation
  22578. * @returns the serialized block object
  22579. */
  22580. serialize(): any;
  22581. /** @hidden */
  22582. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22583. private _deserializePortDisplayNamesAndExposedOnFrame;
  22584. /**
  22585. * Release resources
  22586. */
  22587. dispose(): void;
  22588. }
  22589. }
  22590. declare module "babylonjs/Materials/pushMaterial" {
  22591. import { Nullable } from "babylonjs/types";
  22592. import { Scene } from "babylonjs/scene";
  22593. import { Matrix } from "babylonjs/Maths/math.vector";
  22594. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22595. import { Mesh } from "babylonjs/Meshes/mesh";
  22596. import { Material } from "babylonjs/Materials/material";
  22597. import { Effect } from "babylonjs/Materials/effect";
  22598. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22599. /**
  22600. * Base class of materials working in push mode in babylon JS
  22601. * @hidden
  22602. */
  22603. export class PushMaterial extends Material {
  22604. protected _activeEffect: Effect;
  22605. protected _normalMatrix: Matrix;
  22606. constructor(name: string, scene: Scene);
  22607. getEffect(): Effect;
  22608. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  22609. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  22610. /**
  22611. * Binds the given world matrix to the active effect
  22612. *
  22613. * @param world the matrix to bind
  22614. */
  22615. bindOnlyWorldMatrix(world: Matrix): void;
  22616. /**
  22617. * Binds the given normal matrix to the active effect
  22618. *
  22619. * @param normalMatrix the matrix to bind
  22620. */
  22621. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  22622. bind(world: Matrix, mesh?: Mesh): void;
  22623. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  22624. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  22625. }
  22626. }
  22627. declare module "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer" {
  22628. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22629. /**
  22630. * Root class for all node material optimizers
  22631. */
  22632. export class NodeMaterialOptimizer {
  22633. /**
  22634. * Function used to optimize a NodeMaterial graph
  22635. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  22636. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  22637. */
  22638. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  22639. }
  22640. }
  22641. declare module "babylonjs/Materials/Node/Blocks/transformBlock" {
  22642. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22643. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22644. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22645. import { Scene } from "babylonjs/scene";
  22646. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22647. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22648. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22649. /**
  22650. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  22651. */
  22652. export class TransformBlock extends NodeMaterialBlock {
  22653. /**
  22654. * Defines the value to use to complement W value to transform it to a Vector4
  22655. */
  22656. complementW: number;
  22657. /**
  22658. * Defines the value to use to complement z value to transform it to a Vector4
  22659. */
  22660. complementZ: number;
  22661. /**
  22662. * Creates a new TransformBlock
  22663. * @param name defines the block name
  22664. */
  22665. constructor(name: string);
  22666. /**
  22667. * Gets the current class name
  22668. * @returns the class name
  22669. */
  22670. getClassName(): string;
  22671. /**
  22672. * Gets the vector input
  22673. */
  22674. get vector(): NodeMaterialConnectionPoint;
  22675. /**
  22676. * Gets the output component
  22677. */
  22678. get output(): NodeMaterialConnectionPoint;
  22679. /**
  22680. * Gets the xyz output component
  22681. */
  22682. get xyz(): NodeMaterialConnectionPoint;
  22683. /**
  22684. * Gets the matrix transform input
  22685. */
  22686. get transform(): NodeMaterialConnectionPoint;
  22687. protected _buildBlock(state: NodeMaterialBuildState): this;
  22688. /**
  22689. * Update defines for shader compilation
  22690. * @param mesh defines the mesh to be rendered
  22691. * @param nodeMaterial defines the node material requesting the update
  22692. * @param defines defines the material defines to update
  22693. * @param useInstances specifies that instances should be used
  22694. * @param subMesh defines which submesh to render
  22695. */
  22696. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22697. serialize(): any;
  22698. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22699. protected _dumpPropertiesCode(): string;
  22700. }
  22701. }
  22702. declare module "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock" {
  22703. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22704. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22705. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22706. /**
  22707. * Block used to output the vertex position
  22708. */
  22709. export class VertexOutputBlock extends NodeMaterialBlock {
  22710. /**
  22711. * Creates a new VertexOutputBlock
  22712. * @param name defines the block name
  22713. */
  22714. constructor(name: string);
  22715. /**
  22716. * Gets the current class name
  22717. * @returns the class name
  22718. */
  22719. getClassName(): string;
  22720. /**
  22721. * Gets the vector input component
  22722. */
  22723. get vector(): NodeMaterialConnectionPoint;
  22724. protected _buildBlock(state: NodeMaterialBuildState): this;
  22725. }
  22726. }
  22727. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock" {
  22728. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22729. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22730. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22731. /**
  22732. * Block used to output the final color
  22733. */
  22734. export class FragmentOutputBlock extends NodeMaterialBlock {
  22735. /**
  22736. * Create a new FragmentOutputBlock
  22737. * @param name defines the block name
  22738. */
  22739. constructor(name: string);
  22740. /**
  22741. * Gets the current class name
  22742. * @returns the class name
  22743. */
  22744. getClassName(): string;
  22745. /**
  22746. * Gets the rgba input component
  22747. */
  22748. get rgba(): NodeMaterialConnectionPoint;
  22749. /**
  22750. * Gets the rgb input component
  22751. */
  22752. get rgb(): NodeMaterialConnectionPoint;
  22753. /**
  22754. * Gets the a input component
  22755. */
  22756. get a(): NodeMaterialConnectionPoint;
  22757. protected _buildBlock(state: NodeMaterialBuildState): this;
  22758. }
  22759. }
  22760. declare module "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock" {
  22761. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22762. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22763. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22764. /**
  22765. * Block used for the particle ramp gradient section
  22766. */
  22767. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  22768. /**
  22769. * Create a new ParticleRampGradientBlock
  22770. * @param name defines the block name
  22771. */
  22772. constructor(name: string);
  22773. /**
  22774. * Gets the current class name
  22775. * @returns the class name
  22776. */
  22777. getClassName(): string;
  22778. /**
  22779. * Gets the color input component
  22780. */
  22781. get color(): NodeMaterialConnectionPoint;
  22782. /**
  22783. * Gets the rampColor output component
  22784. */
  22785. get rampColor(): NodeMaterialConnectionPoint;
  22786. /**
  22787. * Initialize the block and prepare the context for build
  22788. * @param state defines the state that will be used for the build
  22789. */
  22790. initialize(state: NodeMaterialBuildState): void;
  22791. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22792. }
  22793. }
  22794. declare module "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock" {
  22795. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22796. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22797. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22798. /**
  22799. * Block used for the particle blend multiply section
  22800. */
  22801. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  22802. /**
  22803. * Create a new ParticleBlendMultiplyBlock
  22804. * @param name defines the block name
  22805. */
  22806. constructor(name: string);
  22807. /**
  22808. * Gets the current class name
  22809. * @returns the class name
  22810. */
  22811. getClassName(): string;
  22812. /**
  22813. * Gets the color input component
  22814. */
  22815. get color(): NodeMaterialConnectionPoint;
  22816. /**
  22817. * Gets the alphaTexture input component
  22818. */
  22819. get alphaTexture(): NodeMaterialConnectionPoint;
  22820. /**
  22821. * Gets the alphaColor input component
  22822. */
  22823. get alphaColor(): NodeMaterialConnectionPoint;
  22824. /**
  22825. * Gets the blendColor output component
  22826. */
  22827. get blendColor(): NodeMaterialConnectionPoint;
  22828. /**
  22829. * Initialize the block and prepare the context for build
  22830. * @param state defines the state that will be used for the build
  22831. */
  22832. initialize(state: NodeMaterialBuildState): void;
  22833. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22834. }
  22835. }
  22836. declare module "babylonjs/Materials/Node/Blocks/vectorMergerBlock" {
  22837. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22838. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22839. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22840. /**
  22841. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  22842. */
  22843. export class VectorMergerBlock extends NodeMaterialBlock {
  22844. /**
  22845. * Create a new VectorMergerBlock
  22846. * @param name defines the block name
  22847. */
  22848. constructor(name: string);
  22849. /**
  22850. * Gets the current class name
  22851. * @returns the class name
  22852. */
  22853. getClassName(): string;
  22854. /**
  22855. * Gets the xyz component (input)
  22856. */
  22857. get xyzIn(): NodeMaterialConnectionPoint;
  22858. /**
  22859. * Gets the xy component (input)
  22860. */
  22861. get xyIn(): NodeMaterialConnectionPoint;
  22862. /**
  22863. * Gets the x component (input)
  22864. */
  22865. get x(): NodeMaterialConnectionPoint;
  22866. /**
  22867. * Gets the y component (input)
  22868. */
  22869. get y(): NodeMaterialConnectionPoint;
  22870. /**
  22871. * Gets the z component (input)
  22872. */
  22873. get z(): NodeMaterialConnectionPoint;
  22874. /**
  22875. * Gets the w component (input)
  22876. */
  22877. get w(): NodeMaterialConnectionPoint;
  22878. /**
  22879. * Gets the xyzw component (output)
  22880. */
  22881. get xyzw(): NodeMaterialConnectionPoint;
  22882. /**
  22883. * Gets the xyz component (output)
  22884. */
  22885. get xyzOut(): NodeMaterialConnectionPoint;
  22886. /**
  22887. * Gets the xy component (output)
  22888. */
  22889. get xyOut(): NodeMaterialConnectionPoint;
  22890. /**
  22891. * Gets the xy component (output)
  22892. * @deprecated Please use xyOut instead.
  22893. */
  22894. get xy(): NodeMaterialConnectionPoint;
  22895. /**
  22896. * Gets the xyz component (output)
  22897. * @deprecated Please use xyzOut instead.
  22898. */
  22899. get xyz(): NodeMaterialConnectionPoint;
  22900. protected _buildBlock(state: NodeMaterialBuildState): this;
  22901. }
  22902. }
  22903. declare module "babylonjs/Materials/Node/Blocks/remapBlock" {
  22904. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22905. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22906. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22907. import { Vector2 } from "babylonjs/Maths/math.vector";
  22908. import { Scene } from "babylonjs/scene";
  22909. /**
  22910. * Block used to remap a float from a range to a new one
  22911. */
  22912. export class RemapBlock extends NodeMaterialBlock {
  22913. /**
  22914. * Gets or sets the source range
  22915. */
  22916. sourceRange: Vector2;
  22917. /**
  22918. * Gets or sets the target range
  22919. */
  22920. targetRange: Vector2;
  22921. /**
  22922. * Creates a new RemapBlock
  22923. * @param name defines the block name
  22924. */
  22925. constructor(name: string);
  22926. /**
  22927. * Gets the current class name
  22928. * @returns the class name
  22929. */
  22930. getClassName(): string;
  22931. /**
  22932. * Gets the input component
  22933. */
  22934. get input(): NodeMaterialConnectionPoint;
  22935. /**
  22936. * Gets the source min input component
  22937. */
  22938. get sourceMin(): NodeMaterialConnectionPoint;
  22939. /**
  22940. * Gets the source max input component
  22941. */
  22942. get sourceMax(): NodeMaterialConnectionPoint;
  22943. /**
  22944. * Gets the target min input component
  22945. */
  22946. get targetMin(): NodeMaterialConnectionPoint;
  22947. /**
  22948. * Gets the target max input component
  22949. */
  22950. get targetMax(): NodeMaterialConnectionPoint;
  22951. /**
  22952. * Gets the output component
  22953. */
  22954. get output(): NodeMaterialConnectionPoint;
  22955. protected _buildBlock(state: NodeMaterialBuildState): this;
  22956. protected _dumpPropertiesCode(): string;
  22957. serialize(): any;
  22958. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22959. }
  22960. }
  22961. declare module "babylonjs/Materials/Node/Blocks/multiplyBlock" {
  22962. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22963. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22964. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22965. /**
  22966. * Block used to multiply 2 values
  22967. */
  22968. export class MultiplyBlock extends NodeMaterialBlock {
  22969. /**
  22970. * Creates a new MultiplyBlock
  22971. * @param name defines the block name
  22972. */
  22973. constructor(name: string);
  22974. /**
  22975. * Gets the current class name
  22976. * @returns the class name
  22977. */
  22978. getClassName(): string;
  22979. /**
  22980. * Gets the left operand input component
  22981. */
  22982. get left(): NodeMaterialConnectionPoint;
  22983. /**
  22984. * Gets the right operand input component
  22985. */
  22986. get right(): NodeMaterialConnectionPoint;
  22987. /**
  22988. * Gets the output component
  22989. */
  22990. get output(): NodeMaterialConnectionPoint;
  22991. protected _buildBlock(state: NodeMaterialBuildState): this;
  22992. }
  22993. }
  22994. declare module "babylonjs/Materials/Node/Blocks/colorSplitterBlock" {
  22995. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22996. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22997. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22998. /**
  22999. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  23000. */
  23001. export class ColorSplitterBlock extends NodeMaterialBlock {
  23002. /**
  23003. * Create a new ColorSplitterBlock
  23004. * @param name defines the block name
  23005. */
  23006. constructor(name: string);
  23007. /**
  23008. * Gets the current class name
  23009. * @returns the class name
  23010. */
  23011. getClassName(): string;
  23012. /**
  23013. * Gets the rgba component (input)
  23014. */
  23015. get rgba(): NodeMaterialConnectionPoint;
  23016. /**
  23017. * Gets the rgb component (input)
  23018. */
  23019. get rgbIn(): NodeMaterialConnectionPoint;
  23020. /**
  23021. * Gets the rgb component (output)
  23022. */
  23023. get rgbOut(): NodeMaterialConnectionPoint;
  23024. /**
  23025. * Gets the r component (output)
  23026. */
  23027. get r(): NodeMaterialConnectionPoint;
  23028. /**
  23029. * Gets the g component (output)
  23030. */
  23031. get g(): NodeMaterialConnectionPoint;
  23032. /**
  23033. * Gets the b component (output)
  23034. */
  23035. get b(): NodeMaterialConnectionPoint;
  23036. /**
  23037. * Gets the a component (output)
  23038. */
  23039. get a(): NodeMaterialConnectionPoint;
  23040. protected _inputRename(name: string): string;
  23041. protected _outputRename(name: string): string;
  23042. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  23043. }
  23044. }
  23045. declare module "babylonjs/Materials/Node/Blocks/trigonometryBlock" {
  23046. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  23047. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  23048. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  23049. import { Scene } from "babylonjs/scene";
  23050. /**
  23051. * Operations supported by the Trigonometry block
  23052. */
  23053. export enum TrigonometryBlockOperations {
  23054. /** Cos */
  23055. Cos = 0,
  23056. /** Sin */
  23057. Sin = 1,
  23058. /** Abs */
  23059. Abs = 2,
  23060. /** Exp */
  23061. Exp = 3,
  23062. /** Exp2 */
  23063. Exp2 = 4,
  23064. /** Round */
  23065. Round = 5,
  23066. /** Floor */
  23067. Floor = 6,
  23068. /** Ceiling */
  23069. Ceiling = 7,
  23070. /** Square root */
  23071. Sqrt = 8,
  23072. /** Log */
  23073. Log = 9,
  23074. /** Tangent */
  23075. Tan = 10,
  23076. /** Arc tangent */
  23077. ArcTan = 11,
  23078. /** Arc cosinus */
  23079. ArcCos = 12,
  23080. /** Arc sinus */
  23081. ArcSin = 13,
  23082. /** Fraction */
  23083. Fract = 14,
  23084. /** Sign */
  23085. Sign = 15,
  23086. /** To radians (from degrees) */
  23087. Radians = 16,
  23088. /** To degrees (from radians) */
  23089. Degrees = 17
  23090. }
  23091. /**
  23092. * Block used to apply trigonometry operation to floats
  23093. */
  23094. export class TrigonometryBlock extends NodeMaterialBlock {
  23095. /**
  23096. * Gets or sets the operation applied by the block
  23097. */
  23098. operation: TrigonometryBlockOperations;
  23099. /**
  23100. * Creates a new TrigonometryBlock
  23101. * @param name defines the block name
  23102. */
  23103. constructor(name: string);
  23104. /**
  23105. * Gets the current class name
  23106. * @returns the class name
  23107. */
  23108. getClassName(): string;
  23109. /**
  23110. * Gets the input component
  23111. */
  23112. get input(): NodeMaterialConnectionPoint;
  23113. /**
  23114. * Gets the output component
  23115. */
  23116. get output(): NodeMaterialConnectionPoint;
  23117. protected _buildBlock(state: NodeMaterialBuildState): this;
  23118. serialize(): any;
  23119. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  23120. protected _dumpPropertiesCode(): string;
  23121. }
  23122. }
  23123. declare module "babylonjs/Materials/Node/nodeMaterial" {
  23124. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  23125. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  23126. import { Scene } from "babylonjs/scene";
  23127. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  23128. import { Matrix } from "babylonjs/Maths/math.vector";
  23129. import { Mesh } from "babylonjs/Meshes/mesh";
  23130. import { Engine } from "babylonjs/Engines/engine";
  23131. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  23132. import { Observable } from "babylonjs/Misc/observable";
  23133. import { SubMesh } from "babylonjs/Meshes/subMesh";
  23134. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  23135. import { NodeMaterialOptimizer } from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  23136. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  23137. import { Nullable } from "babylonjs/types";
  23138. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  23139. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  23140. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  23141. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  23142. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  23143. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  23144. import { Effect } from "babylonjs/Materials/effect";
  23145. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  23146. import { Camera } from "babylonjs/Cameras/camera";
  23147. import { NodeMaterialModes } from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  23148. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  23149. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  23150. /**
  23151. * Interface used to configure the node material editor
  23152. */
  23153. export interface INodeMaterialEditorOptions {
  23154. /** Define the URl to load node editor script */
  23155. editorURL?: string;
  23156. }
  23157. /** @hidden */
  23158. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  23159. NORMAL: boolean;
  23160. TANGENT: boolean;
  23161. UV1: boolean;
  23162. /** BONES */
  23163. NUM_BONE_INFLUENCERS: number;
  23164. BonesPerMesh: number;
  23165. BONETEXTURE: boolean;
  23166. /** MORPH TARGETS */
  23167. MORPHTARGETS: boolean;
  23168. MORPHTARGETS_NORMAL: boolean;
  23169. MORPHTARGETS_TANGENT: boolean;
  23170. MORPHTARGETS_UV: boolean;
  23171. NUM_MORPH_INFLUENCERS: number;
  23172. /** IMAGE PROCESSING */
  23173. IMAGEPROCESSING: boolean;
  23174. VIGNETTE: boolean;
  23175. VIGNETTEBLENDMODEMULTIPLY: boolean;
  23176. VIGNETTEBLENDMODEOPAQUE: boolean;
  23177. TONEMAPPING: boolean;
  23178. TONEMAPPING_ACES: boolean;
  23179. CONTRAST: boolean;
  23180. EXPOSURE: boolean;
  23181. COLORCURVES: boolean;
  23182. COLORGRADING: boolean;
  23183. COLORGRADING3D: boolean;
  23184. SAMPLER3DGREENDEPTH: boolean;
  23185. SAMPLER3DBGRMAP: boolean;
  23186. IMAGEPROCESSINGPOSTPROCESS: boolean;
  23187. /** MISC. */
  23188. BUMPDIRECTUV: number;
  23189. constructor();
  23190. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  23191. }
  23192. /**
  23193. * Class used to configure NodeMaterial
  23194. */
  23195. export interface INodeMaterialOptions {
  23196. /**
  23197. * Defines if blocks should emit comments
  23198. */
  23199. emitComments: boolean;
  23200. }
  23201. /**
  23202. * Class used to create a node based material built by assembling shader blocks
  23203. */
  23204. export class NodeMaterial extends PushMaterial {
  23205. private static _BuildIdGenerator;
  23206. private _options;
  23207. private _vertexCompilationState;
  23208. private _fragmentCompilationState;
  23209. private _sharedData;
  23210. private _buildId;
  23211. private _buildWasSuccessful;
  23212. private _cachedWorldViewMatrix;
  23213. private _cachedWorldViewProjectionMatrix;
  23214. private _optimizers;
  23215. private _animationFrame;
  23216. /** Define the Url to load node editor script */
  23217. static EditorURL: string;
  23218. /** Define the Url to load snippets */
  23219. static SnippetUrl: string;
  23220. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  23221. static IgnoreTexturesAtLoadTime: boolean;
  23222. private BJSNODEMATERIALEDITOR;
  23223. /** Get the inspector from bundle or global */
  23224. private _getGlobalNodeMaterialEditor;
  23225. /**
  23226. * Snippet ID if the material was created from the snippet server
  23227. */
  23228. snippetId: string;
  23229. /**
  23230. * Gets or sets data used by visual editor
  23231. * @see https://nme.babylonjs.com
  23232. */
  23233. editorData: any;
  23234. /**
  23235. * 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)
  23236. */
  23237. ignoreAlpha: boolean;
  23238. /**
  23239. * Defines the maximum number of lights that can be used in the material
  23240. */
  23241. maxSimultaneousLights: number;
  23242. /**
  23243. * Observable raised when the material is built
  23244. */
  23245. onBuildObservable: Observable<NodeMaterial>;
  23246. /**
  23247. * Gets or sets the root nodes of the material vertex shader
  23248. */
  23249. _vertexOutputNodes: NodeMaterialBlock[];
  23250. /**
  23251. * Gets or sets the root nodes of the material fragment (pixel) shader
  23252. */
  23253. _fragmentOutputNodes: NodeMaterialBlock[];
  23254. /** Gets or sets options to control the node material overall behavior */
  23255. get options(): INodeMaterialOptions;
  23256. set options(options: INodeMaterialOptions);
  23257. /**
  23258. * Default configuration related to image processing available in the standard Material.
  23259. */
  23260. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  23261. /**
  23262. * Gets the image processing configuration used either in this material.
  23263. */
  23264. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  23265. /**
  23266. * Sets the Default image processing configuration used either in the this material.
  23267. *
  23268. * If sets to null, the scene one is in use.
  23269. */
  23270. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  23271. /**
  23272. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  23273. */
  23274. attachedBlocks: NodeMaterialBlock[];
  23275. /**
  23276. * Specifies the mode of the node material
  23277. * @hidden
  23278. */
  23279. _mode: NodeMaterialModes;
  23280. /**
  23281. * Gets the mode property
  23282. */
  23283. get mode(): NodeMaterialModes;
  23284. /**
  23285. * Create a new node based material
  23286. * @param name defines the material name
  23287. * @param scene defines the hosting scene
  23288. * @param options defines creation option
  23289. */
  23290. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  23291. /**
  23292. * Gets the current class name of the material e.g. "NodeMaterial"
  23293. * @returns the class name
  23294. */
  23295. getClassName(): string;
  23296. /**
  23297. * Keep track of the image processing observer to allow dispose and replace.
  23298. */
  23299. private _imageProcessingObserver;
  23300. /**
  23301. * Attaches a new image processing configuration to the Standard Material.
  23302. * @param configuration
  23303. */
  23304. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  23305. /**
  23306. * Get a block by its name
  23307. * @param name defines the name of the block to retrieve
  23308. * @returns the required block or null if not found
  23309. */
  23310. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  23311. /**
  23312. * Get a block by its name
  23313. * @param predicate defines the predicate used to find the good candidate
  23314. * @returns the required block or null if not found
  23315. */
  23316. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  23317. /**
  23318. * Get an input block by its name
  23319. * @param predicate defines the predicate used to find the good candidate
  23320. * @returns the required input block or null if not found
  23321. */
  23322. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  23323. /**
  23324. * Gets the list of input blocks attached to this material
  23325. * @returns an array of InputBlocks
  23326. */
  23327. getInputBlocks(): InputBlock[];
  23328. /**
  23329. * Adds a new optimizer to the list of optimizers
  23330. * @param optimizer defines the optimizers to add
  23331. * @returns the current material
  23332. */
  23333. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  23334. /**
  23335. * Remove an optimizer from the list of optimizers
  23336. * @param optimizer defines the optimizers to remove
  23337. * @returns the current material
  23338. */
  23339. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  23340. /**
  23341. * Add a new block to the list of output nodes
  23342. * @param node defines the node to add
  23343. * @returns the current material
  23344. */
  23345. addOutputNode(node: NodeMaterialBlock): this;
  23346. /**
  23347. * Remove a block from the list of root nodes
  23348. * @param node defines the node to remove
  23349. * @returns the current material
  23350. */
  23351. removeOutputNode(node: NodeMaterialBlock): this;
  23352. private _addVertexOutputNode;
  23353. private _removeVertexOutputNode;
  23354. private _addFragmentOutputNode;
  23355. private _removeFragmentOutputNode;
  23356. /**
  23357. * Specifies if the material will require alpha blending
  23358. * @returns a boolean specifying if alpha blending is needed
  23359. */
  23360. needAlphaBlending(): boolean;
  23361. /**
  23362. * Specifies if this material should be rendered in alpha test mode
  23363. * @returns a boolean specifying if an alpha test is needed.
  23364. */
  23365. needAlphaTesting(): boolean;
  23366. private _initializeBlock;
  23367. private _resetDualBlocks;
  23368. /**
  23369. * Remove a block from the current node material
  23370. * @param block defines the block to remove
  23371. */
  23372. removeBlock(block: NodeMaterialBlock): void;
  23373. /**
  23374. * Build the material and generates the inner effect
  23375. * @param verbose defines if the build should log activity
  23376. */
  23377. build(verbose?: boolean): void;
  23378. /**
  23379. * Runs an otpimization phase to try to improve the shader code
  23380. */
  23381. optimize(): void;
  23382. private _prepareDefinesForAttributes;
  23383. /**
  23384. * Create a post process from the material
  23385. * @param camera The camera to apply the render pass to.
  23386. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23387. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23388. * @param engine The engine which the post process will be applied. (default: current engine)
  23389. * @param reusable If the post process can be reused on the same frame. (default: false)
  23390. * @param textureType Type of textures used when performing the post process. (default: 0)
  23391. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23392. * @returns the post process created
  23393. */
  23394. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): Nullable<PostProcess>;
  23395. /**
  23396. * Create the post process effect from the material
  23397. * @param postProcess The post process to create the effect for
  23398. */
  23399. createEffectForPostProcess(postProcess: PostProcess): void;
  23400. private _createEffectForPostProcess;
  23401. /**
  23402. * Create a new procedural texture based on this node material
  23403. * @param size defines the size of the texture
  23404. * @param scene defines the hosting scene
  23405. * @returns the new procedural texture attached to this node material
  23406. */
  23407. createProceduralTexture(size: number | {
  23408. width: number;
  23409. height: number;
  23410. layers?: number;
  23411. }, scene: Scene): Nullable<ProceduralTexture>;
  23412. private _createEffectForParticles;
  23413. private _checkInternals;
  23414. /**
  23415. * Create the effect to be used as the custom effect for a particle system
  23416. * @param particleSystem Particle system to create the effect for
  23417. * @param onCompiled defines a function to call when the effect creation is successful
  23418. * @param onError defines a function to call when the effect creation has failed
  23419. */
  23420. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23421. private _processDefines;
  23422. /**
  23423. * Get if the submesh is ready to be used and all its information available.
  23424. * Child classes can use it to update shaders
  23425. * @param mesh defines the mesh to check
  23426. * @param subMesh defines which submesh to check
  23427. * @param useInstances specifies that instances should be used
  23428. * @returns a boolean indicating that the submesh is ready or not
  23429. */
  23430. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  23431. /**
  23432. * Get a string representing the shaders built by the current node graph
  23433. */
  23434. get compiledShaders(): string;
  23435. /**
  23436. * Binds the world matrix to the material
  23437. * @param world defines the world transformation matrix
  23438. */
  23439. bindOnlyWorldMatrix(world: Matrix): void;
  23440. /**
  23441. * Binds the submesh to this material by preparing the effect and shader to draw
  23442. * @param world defines the world transformation matrix
  23443. * @param mesh defines the mesh containing the submesh
  23444. * @param subMesh defines the submesh to bind the material to
  23445. */
  23446. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  23447. /**
  23448. * Gets the active textures from the material
  23449. * @returns an array of textures
  23450. */
  23451. getActiveTextures(): BaseTexture[];
  23452. /**
  23453. * Gets the list of texture blocks
  23454. * @returns an array of texture blocks
  23455. */
  23456. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  23457. /**
  23458. * Specifies if the material uses a texture
  23459. * @param texture defines the texture to check against the material
  23460. * @returns a boolean specifying if the material uses the texture
  23461. */
  23462. hasTexture(texture: BaseTexture): boolean;
  23463. /**
  23464. * Disposes the material
  23465. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  23466. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  23467. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  23468. */
  23469. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  23470. /** Creates the node editor window. */
  23471. private _createNodeEditor;
  23472. /**
  23473. * Launch the node material editor
  23474. * @param config Define the configuration of the editor
  23475. * @return a promise fulfilled when the node editor is visible
  23476. */
  23477. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  23478. /**
  23479. * Clear the current material
  23480. */
  23481. clear(): void;
  23482. /**
  23483. * Clear the current material and set it to a default state
  23484. */
  23485. setToDefault(): void;
  23486. /**
  23487. * Clear the current material and set it to a default state for post process
  23488. */
  23489. setToDefaultPostProcess(): void;
  23490. /**
  23491. * Clear the current material and set it to a default state for procedural texture
  23492. */
  23493. setToDefaultProceduralTexture(): void;
  23494. /**
  23495. * Clear the current material and set it to a default state for particle
  23496. */
  23497. setToDefaultParticle(): void;
  23498. /**
  23499. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  23500. * @param url defines the url to load from
  23501. * @returns a promise that will fullfil when the material is fully loaded
  23502. */
  23503. loadAsync(url: string): Promise<void>;
  23504. private _gatherBlocks;
  23505. /**
  23506. * Generate a string containing the code declaration required to create an equivalent of this material
  23507. * @returns a string
  23508. */
  23509. generateCode(): string;
  23510. /**
  23511. * Serializes this material in a JSON representation
  23512. * @returns the serialized material object
  23513. */
  23514. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  23515. private _restoreConnections;
  23516. /**
  23517. * Clear the current graph and load a new one from a serialization object
  23518. * @param source defines the JSON representation of the material
  23519. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23520. * @param merge defines whether or not the source must be merged or replace the current content
  23521. */
  23522. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  23523. /**
  23524. * Makes a duplicate of the current material.
  23525. * @param name - name to use for the new material.
  23526. */
  23527. clone(name: string): NodeMaterial;
  23528. /**
  23529. * Creates a node material from parsed material data
  23530. * @param source defines the JSON representation of the material
  23531. * @param scene defines the hosting scene
  23532. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23533. * @returns a new node material
  23534. */
  23535. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  23536. /**
  23537. * Creates a node material from a snippet saved in a remote file
  23538. * @param name defines the name of the material to create
  23539. * @param url defines the url to load from
  23540. * @param scene defines the hosting scene
  23541. * @returns a promise that will resolve to the new node material
  23542. */
  23543. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  23544. /**
  23545. * Creates a node material from a snippet saved by the node material editor
  23546. * @param snippetId defines the snippet to load
  23547. * @param scene defines the hosting scene
  23548. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23549. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  23550. * @returns a promise that will resolve to the new node material
  23551. */
  23552. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  23553. /**
  23554. * Creates a new node material set to default basic configuration
  23555. * @param name defines the name of the material
  23556. * @param scene defines the hosting scene
  23557. * @returns a new NodeMaterial
  23558. */
  23559. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  23560. }
  23561. }
  23562. declare module "babylonjs/PostProcesses/postProcess" {
  23563. import { Nullable } from "babylonjs/types";
  23564. import { SmartArray } from "babylonjs/Misc/smartArray";
  23565. import { Observable } from "babylonjs/Misc/observable";
  23566. import { Vector2 } from "babylonjs/Maths/math.vector";
  23567. import { Camera } from "babylonjs/Cameras/camera";
  23568. import { Effect } from "babylonjs/Materials/effect";
  23569. import "babylonjs/Shaders/postprocess.vertex";
  23570. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23571. import { Engine } from "babylonjs/Engines/engine";
  23572. import { Color4 } from "babylonjs/Maths/math.color";
  23573. import "babylonjs/Engines/Extensions/engine.renderTarget";
  23574. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  23575. import { Scene } from "babylonjs/scene";
  23576. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  23577. /**
  23578. * Size options for a post process
  23579. */
  23580. export type PostProcessOptions = {
  23581. width: number;
  23582. height: number;
  23583. };
  23584. /**
  23585. * PostProcess can be used to apply a shader to a texture after it has been rendered
  23586. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  23587. */
  23588. export class PostProcess {
  23589. /**
  23590. * Gets or sets the unique id of the post process
  23591. */
  23592. uniqueId: number;
  23593. /** Name of the PostProcess. */
  23594. name: string;
  23595. /**
  23596. * Width of the texture to apply the post process on
  23597. */
  23598. width: number;
  23599. /**
  23600. * Height of the texture to apply the post process on
  23601. */
  23602. height: number;
  23603. /**
  23604. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  23605. */
  23606. nodeMaterialSource: Nullable<NodeMaterial>;
  23607. /**
  23608. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  23609. * @hidden
  23610. */
  23611. _outputTexture: Nullable<InternalTexture>;
  23612. /**
  23613. * Sampling mode used by the shader
  23614. * See https://doc.babylonjs.com/classes/3.1/texture
  23615. */
  23616. renderTargetSamplingMode: number;
  23617. /**
  23618. * Clear color to use when screen clearing
  23619. */
  23620. clearColor: Color4;
  23621. /**
  23622. * If the buffer needs to be cleared before applying the post process. (default: true)
  23623. * Should be set to false if shader will overwrite all previous pixels.
  23624. */
  23625. autoClear: boolean;
  23626. /**
  23627. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  23628. */
  23629. alphaMode: number;
  23630. /**
  23631. * Sets the setAlphaBlendConstants of the babylon engine
  23632. */
  23633. alphaConstants: Color4;
  23634. /**
  23635. * Animations to be used for the post processing
  23636. */
  23637. animations: import("babylonjs/Animations/animation").Animation[];
  23638. /**
  23639. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  23640. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  23641. */
  23642. enablePixelPerfectMode: boolean;
  23643. /**
  23644. * Force the postprocess to be applied without taking in account viewport
  23645. */
  23646. forceFullscreenViewport: boolean;
  23647. /**
  23648. * List of inspectable custom properties (used by the Inspector)
  23649. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  23650. */
  23651. inspectableCustomProperties: IInspectable[];
  23652. /**
  23653. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  23654. *
  23655. * | Value | Type | Description |
  23656. * | ----- | ----------------------------------- | ----------- |
  23657. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  23658. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  23659. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  23660. *
  23661. */
  23662. scaleMode: number;
  23663. /**
  23664. * Force textures to be a power of two (default: false)
  23665. */
  23666. alwaysForcePOT: boolean;
  23667. private _samples;
  23668. /**
  23669. * Number of sample textures (default: 1)
  23670. */
  23671. get samples(): number;
  23672. set samples(n: number);
  23673. /**
  23674. * Modify the scale of the post process to be the same as the viewport (default: false)
  23675. */
  23676. adaptScaleToCurrentViewport: boolean;
  23677. private _camera;
  23678. protected _scene: Scene;
  23679. private _engine;
  23680. private _options;
  23681. private _reusable;
  23682. private _textureType;
  23683. private _textureFormat;
  23684. /**
  23685. * Smart array of input and output textures for the post process.
  23686. * @hidden
  23687. */
  23688. _textures: SmartArray<import("babylonjs/Materials/Textures/internalTexture").InternalTexture>;
  23689. /**
  23690. * The index in _textures that corresponds to the output texture.
  23691. * @hidden
  23692. */
  23693. _currentRenderTextureInd: number;
  23694. private _effect;
  23695. private _samplers;
  23696. private _fragmentUrl;
  23697. private _vertexUrl;
  23698. private _parameters;
  23699. private _scaleRatio;
  23700. protected _indexParameters: any;
  23701. private _shareOutputWithPostProcess;
  23702. private _texelSize;
  23703. private _forcedOutputTexture;
  23704. /**
  23705. * Returns the fragment url or shader name used in the post process.
  23706. * @returns the fragment url or name in the shader store.
  23707. */
  23708. getEffectName(): string;
  23709. /**
  23710. * An event triggered when the postprocess is activated.
  23711. */
  23712. onActivateObservable: Observable<Camera>;
  23713. private _onActivateObserver;
  23714. /**
  23715. * A function that is added to the onActivateObservable
  23716. */
  23717. set onActivate(callback: Nullable<(camera: Camera) => void>);
  23718. /**
  23719. * An event triggered when the postprocess changes its size.
  23720. */
  23721. onSizeChangedObservable: Observable<PostProcess>;
  23722. private _onSizeChangedObserver;
  23723. /**
  23724. * A function that is added to the onSizeChangedObservable
  23725. */
  23726. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  23727. /**
  23728. * An event triggered when the postprocess applies its effect.
  23729. */
  23730. onApplyObservable: Observable<Effect>;
  23731. private _onApplyObserver;
  23732. /**
  23733. * A function that is added to the onApplyObservable
  23734. */
  23735. set onApply(callback: (effect: Effect) => void);
  23736. /**
  23737. * An event triggered before rendering the postprocess
  23738. */
  23739. onBeforeRenderObservable: Observable<Effect>;
  23740. private _onBeforeRenderObserver;
  23741. /**
  23742. * A function that is added to the onBeforeRenderObservable
  23743. */
  23744. set onBeforeRender(callback: (effect: Effect) => void);
  23745. /**
  23746. * An event triggered after rendering the postprocess
  23747. */
  23748. onAfterRenderObservable: Observable<Effect>;
  23749. private _onAfterRenderObserver;
  23750. /**
  23751. * A function that is added to the onAfterRenderObservable
  23752. */
  23753. set onAfterRender(callback: (efect: Effect) => void);
  23754. /**
  23755. * 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
  23756. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  23757. */
  23758. get inputTexture(): InternalTexture;
  23759. set inputTexture(value: InternalTexture);
  23760. /**
  23761. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  23762. * the only way to unset it is to use this function to restore its internal state
  23763. */
  23764. restoreDefaultInputTexture(): void;
  23765. /**
  23766. * Gets the camera which post process is applied to.
  23767. * @returns The camera the post process is applied to.
  23768. */
  23769. getCamera(): Camera;
  23770. /**
  23771. * Gets the texel size of the postprocess.
  23772. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  23773. */
  23774. get texelSize(): Vector2;
  23775. /**
  23776. * Creates a new instance PostProcess
  23777. * @param name The name of the PostProcess.
  23778. * @param fragmentUrl The url of the fragment shader to be used.
  23779. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  23780. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  23781. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23782. * @param camera The camera to apply the render pass to.
  23783. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23784. * @param engine The engine which the post process will be applied. (default: current engine)
  23785. * @param reusable If the post process can be reused on the same frame. (default: false)
  23786. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  23787. * @param textureType Type of textures used when performing the post process. (default: 0)
  23788. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  23789. * @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
  23790. * @param blockCompilation If the shader should not be compiled immediatly. (default: false)
  23791. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23792. */
  23793. 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);
  23794. /**
  23795. * Gets a string identifying the name of the class
  23796. * @returns "PostProcess" string
  23797. */
  23798. getClassName(): string;
  23799. /**
  23800. * Gets the engine which this post process belongs to.
  23801. * @returns The engine the post process was enabled with.
  23802. */
  23803. getEngine(): Engine;
  23804. /**
  23805. * The effect that is created when initializing the post process.
  23806. * @returns The created effect corresponding the the postprocess.
  23807. */
  23808. getEffect(): Effect;
  23809. /**
  23810. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  23811. * @param postProcess The post process to share the output with.
  23812. * @returns This post process.
  23813. */
  23814. shareOutputWith(postProcess: PostProcess): PostProcess;
  23815. /**
  23816. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  23817. * This should be called if the post process that shares output with this post process is disabled/disposed.
  23818. */
  23819. useOwnOutput(): void;
  23820. /**
  23821. * Updates the effect with the current post process compile time values and recompiles the shader.
  23822. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23823. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23824. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23825. * @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
  23826. * @param onCompiled Called when the shader has been compiled.
  23827. * @param onError Called if there is an error when compiling a shader.
  23828. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  23829. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  23830. */
  23831. 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;
  23832. /**
  23833. * The post process is reusable if it can be used multiple times within one frame.
  23834. * @returns If the post process is reusable
  23835. */
  23836. isReusable(): boolean;
  23837. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  23838. markTextureDirty(): void;
  23839. /**
  23840. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  23841. * 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.
  23842. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  23843. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  23844. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  23845. * @returns The target texture that was bound to be written to.
  23846. */
  23847. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  23848. /**
  23849. * If the post process is supported.
  23850. */
  23851. get isSupported(): boolean;
  23852. /**
  23853. * The aspect ratio of the output texture.
  23854. */
  23855. get aspectRatio(): number;
  23856. /**
  23857. * Get a value indicating if the post-process is ready to be used
  23858. * @returns true if the post-process is ready (shader is compiled)
  23859. */
  23860. isReady(): boolean;
  23861. /**
  23862. * Binds all textures and uniforms to the shader, this will be run on every pass.
  23863. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  23864. */
  23865. apply(): Nullable<Effect>;
  23866. private _disposeTextures;
  23867. /**
  23868. * Disposes the post process.
  23869. * @param camera The camera to dispose the post process on.
  23870. */
  23871. dispose(camera?: Camera): void;
  23872. /**
  23873. * Serializes the particle system to a JSON object
  23874. * @returns the JSON object
  23875. */
  23876. serialize(): any;
  23877. /**
  23878. * Creates a material from parsed material data
  23879. * @param parsedPostProcess defines parsed post process data
  23880. * @param scene defines the hosting scene
  23881. * @param rootUrl defines the root URL to use to load textures
  23882. * @returns a new post process
  23883. */
  23884. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  23885. }
  23886. }
  23887. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration" {
  23888. /** @hidden */
  23889. export var kernelBlurVaryingDeclaration: {
  23890. name: string;
  23891. shader: string;
  23892. };
  23893. }
  23894. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment" {
  23895. /** @hidden */
  23896. export var kernelBlurFragment: {
  23897. name: string;
  23898. shader: string;
  23899. };
  23900. }
  23901. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2" {
  23902. /** @hidden */
  23903. export var kernelBlurFragment2: {
  23904. name: string;
  23905. shader: string;
  23906. };
  23907. }
  23908. declare module "babylonjs/Shaders/kernelBlur.fragment" {
  23909. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23910. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  23911. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment";
  23912. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2";
  23913. /** @hidden */
  23914. export var kernelBlurPixelShader: {
  23915. name: string;
  23916. shader: string;
  23917. };
  23918. }
  23919. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVertex" {
  23920. /** @hidden */
  23921. export var kernelBlurVertex: {
  23922. name: string;
  23923. shader: string;
  23924. };
  23925. }
  23926. declare module "babylonjs/Shaders/kernelBlur.vertex" {
  23927. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23928. import "babylonjs/Shaders/ShadersInclude/kernelBlurVertex";
  23929. /** @hidden */
  23930. export var kernelBlurVertexShader: {
  23931. name: string;
  23932. shader: string;
  23933. };
  23934. }
  23935. declare module "babylonjs/PostProcesses/blurPostProcess" {
  23936. import { Vector2 } from "babylonjs/Maths/math.vector";
  23937. import { Nullable } from "babylonjs/types";
  23938. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  23939. import { Camera } from "babylonjs/Cameras/camera";
  23940. import { Effect } from "babylonjs/Materials/effect";
  23941. import { Engine } from "babylonjs/Engines/engine";
  23942. import "babylonjs/Shaders/kernelBlur.fragment";
  23943. import "babylonjs/Shaders/kernelBlur.vertex";
  23944. import { Scene } from "babylonjs/scene";
  23945. /**
  23946. * The Blur Post Process which blurs an image based on a kernel and direction.
  23947. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  23948. */
  23949. export class BlurPostProcess extends PostProcess {
  23950. private blockCompilation;
  23951. protected _kernel: number;
  23952. protected _idealKernel: number;
  23953. protected _packedFloat: boolean;
  23954. private _staticDefines;
  23955. /** The direction in which to blur the image. */
  23956. direction: Vector2;
  23957. /**
  23958. * Sets the length in pixels of the blur sample region
  23959. */
  23960. set kernel(v: number);
  23961. /**
  23962. * Gets the length in pixels of the blur sample region
  23963. */
  23964. get kernel(): number;
  23965. /**
  23966. * Sets wether or not the blur needs to unpack/repack floats
  23967. */
  23968. set packedFloat(v: boolean);
  23969. /**
  23970. * Gets wether or not the blur is unpacking/repacking floats
  23971. */
  23972. get packedFloat(): boolean;
  23973. /**
  23974. * Gets a string identifying the name of the class
  23975. * @returns "BlurPostProcess" string
  23976. */
  23977. getClassName(): string;
  23978. /**
  23979. * Creates a new instance BlurPostProcess
  23980. * @param name The name of the effect.
  23981. * @param direction The direction in which to blur the image.
  23982. * @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.
  23983. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23984. * @param camera The camera to apply the render pass to.
  23985. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23986. * @param engine The engine which the post process will be applied. (default: current engine)
  23987. * @param reusable If the post process can be reused on the same frame. (default: false)
  23988. * @param textureType Type of textures used when performing the post process. (default: 0)
  23989. * @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)
  23990. */
  23991. 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);
  23992. /**
  23993. * Updates the effect with the current post process compile time values and recompiles the shader.
  23994. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23995. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23996. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23997. * @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
  23998. * @param onCompiled Called when the shader has been compiled.
  23999. * @param onError Called if there is an error when compiling a shader.
  24000. */
  24001. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  24002. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  24003. /**
  24004. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  24005. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  24006. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  24007. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  24008. * The gaps between physical kernels are compensated for in the weighting of the samples
  24009. * @param idealKernel Ideal blur kernel.
  24010. * @return Nearest best kernel.
  24011. */
  24012. protected _nearestBestKernel(idealKernel: number): number;
  24013. /**
  24014. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  24015. * @param x The point on the Gaussian distribution to sample.
  24016. * @return the value of the Gaussian function at x.
  24017. */
  24018. protected _gaussianWeight(x: number): number;
  24019. /**
  24020. * Generates a string that can be used as a floating point number in GLSL.
  24021. * @param x Value to print.
  24022. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  24023. * @return GLSL float string.
  24024. */
  24025. protected _glslFloat(x: number, decimalFigures?: number): string;
  24026. /** @hidden */
  24027. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  24028. }
  24029. }
  24030. declare module "babylonjs/Materials/Textures/mirrorTexture" {
  24031. import { Scene } from "babylonjs/scene";
  24032. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  24033. import { Plane } from "babylonjs/Maths/math.plane";
  24034. /**
  24035. * Mirror texture can be used to simulate the view from a mirror in a scene.
  24036. * It will dynamically be rendered every frame to adapt to the camera point of view.
  24037. * You can then easily use it as a reflectionTexture on a flat surface.
  24038. * In case the surface is not a plane, please consider relying on reflection probes.
  24039. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  24040. */
  24041. export class MirrorTexture extends RenderTargetTexture {
  24042. private scene;
  24043. /**
  24044. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  24045. * 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.
  24046. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  24047. */
  24048. mirrorPlane: Plane;
  24049. /**
  24050. * Define the blur ratio used to blur the reflection if needed.
  24051. */
  24052. set blurRatio(value: number);
  24053. get blurRatio(): number;
  24054. /**
  24055. * Define the adaptive blur kernel used to blur the reflection if needed.
  24056. * This will autocompute the closest best match for the `blurKernel`
  24057. */
  24058. set adaptiveBlurKernel(value: number);
  24059. /**
  24060. * Define the blur kernel used to blur the reflection if needed.
  24061. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  24062. */
  24063. set blurKernel(value: number);
  24064. /**
  24065. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  24066. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  24067. */
  24068. set blurKernelX(value: number);
  24069. get blurKernelX(): number;
  24070. /**
  24071. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  24072. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  24073. */
  24074. set blurKernelY(value: number);
  24075. get blurKernelY(): number;
  24076. private _autoComputeBlurKernel;
  24077. protected _onRatioRescale(): void;
  24078. private _updateGammaSpace;
  24079. private _imageProcessingConfigChangeObserver;
  24080. private _transformMatrix;
  24081. private _mirrorMatrix;
  24082. private _savedViewMatrix;
  24083. private _blurX;
  24084. private _blurY;
  24085. private _adaptiveBlurKernel;
  24086. private _blurKernelX;
  24087. private _blurKernelY;
  24088. private _blurRatio;
  24089. /**
  24090. * Instantiates a Mirror Texture.
  24091. * Mirror texture can be used to simulate the view from a mirror in a scene.
  24092. * It will dynamically be rendered every frame to adapt to the camera point of view.
  24093. * You can then easily use it as a reflectionTexture on a flat surface.
  24094. * In case the surface is not a plane, please consider relying on reflection probes.
  24095. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  24096. * @param name
  24097. * @param size
  24098. * @param scene
  24099. * @param generateMipMaps
  24100. * @param type
  24101. * @param samplingMode
  24102. * @param generateDepthBuffer
  24103. */
  24104. constructor(name: string, size: number | {
  24105. width: number;
  24106. height: number;
  24107. } | {
  24108. ratio: number;
  24109. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  24110. private _preparePostProcesses;
  24111. /**
  24112. * Clone the mirror texture.
  24113. * @returns the cloned texture
  24114. */
  24115. clone(): MirrorTexture;
  24116. /**
  24117. * Serialize the texture to a JSON representation you could use in Parse later on
  24118. * @returns the serialized JSON representation
  24119. */
  24120. serialize(): any;
  24121. /**
  24122. * Dispose the texture and release its associated resources.
  24123. */
  24124. dispose(): void;
  24125. }
  24126. }
  24127. declare module "babylonjs/Materials/Textures/texture" {
  24128. import { Observable } from "babylonjs/Misc/observable";
  24129. import { Nullable } from "babylonjs/types";
  24130. import { Matrix } from "babylonjs/Maths/math.vector";
  24131. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  24132. import { IInspectable } from "babylonjs/Misc/iInspectable";
  24133. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  24134. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  24135. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  24136. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  24137. import { Scene } from "babylonjs/scene";
  24138. /**
  24139. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  24140. * @see https://doc.babylonjs.com/babylon101/materials#texture
  24141. */
  24142. export class Texture extends BaseTexture {
  24143. /**
  24144. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  24145. */
  24146. static SerializeBuffers: boolean;
  24147. /** @hidden */
  24148. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  24149. /** @hidden */
  24150. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  24151. /** @hidden */
  24152. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  24153. /** nearest is mag = nearest and min = nearest and mip = linear */
  24154. static readonly NEAREST_SAMPLINGMODE: number;
  24155. /** nearest is mag = nearest and min = nearest and mip = linear */
  24156. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  24157. /** Bilinear is mag = linear and min = linear and mip = nearest */
  24158. static readonly BILINEAR_SAMPLINGMODE: number;
  24159. /** Bilinear is mag = linear and min = linear and mip = nearest */
  24160. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  24161. /** Trilinear is mag = linear and min = linear and mip = linear */
  24162. static readonly TRILINEAR_SAMPLINGMODE: number;
  24163. /** Trilinear is mag = linear and min = linear and mip = linear */
  24164. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  24165. /** mag = nearest and min = nearest and mip = nearest */
  24166. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  24167. /** mag = nearest and min = linear and mip = nearest */
  24168. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  24169. /** mag = nearest and min = linear and mip = linear */
  24170. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  24171. /** mag = nearest and min = linear and mip = none */
  24172. static readonly NEAREST_LINEAR: number;
  24173. /** mag = nearest and min = nearest and mip = none */
  24174. static readonly NEAREST_NEAREST: number;
  24175. /** mag = linear and min = nearest and mip = nearest */
  24176. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  24177. /** mag = linear and min = nearest and mip = linear */
  24178. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  24179. /** mag = linear and min = linear and mip = none */
  24180. static readonly LINEAR_LINEAR: number;
  24181. /** mag = linear and min = nearest and mip = none */
  24182. static readonly LINEAR_NEAREST: number;
  24183. /** Explicit coordinates mode */
  24184. static readonly EXPLICIT_MODE: number;
  24185. /** Spherical coordinates mode */
  24186. static readonly SPHERICAL_MODE: number;
  24187. /** Planar coordinates mode */
  24188. static readonly PLANAR_MODE: number;
  24189. /** Cubic coordinates mode */
  24190. static readonly CUBIC_MODE: number;
  24191. /** Projection coordinates mode */
  24192. static readonly PROJECTION_MODE: number;
  24193. /** Inverse Cubic coordinates mode */
  24194. static readonly SKYBOX_MODE: number;
  24195. /** Inverse Cubic coordinates mode */
  24196. static readonly INVCUBIC_MODE: number;
  24197. /** Equirectangular coordinates mode */
  24198. static readonly EQUIRECTANGULAR_MODE: number;
  24199. /** Equirectangular Fixed coordinates mode */
  24200. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  24201. /** Equirectangular Fixed Mirrored coordinates mode */
  24202. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  24203. /** Texture is not repeating outside of 0..1 UVs */
  24204. static readonly CLAMP_ADDRESSMODE: number;
  24205. /** Texture is repeating outside of 0..1 UVs */
  24206. static readonly WRAP_ADDRESSMODE: number;
  24207. /** Texture is repeating and mirrored */
  24208. static readonly MIRROR_ADDRESSMODE: number;
  24209. /**
  24210. * 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
  24211. */
  24212. static UseSerializedUrlIfAny: boolean;
  24213. /**
  24214. * Define the url of the texture.
  24215. */
  24216. url: Nullable<string>;
  24217. /**
  24218. * Define an offset on the texture to offset the u coordinates of the UVs
  24219. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  24220. */
  24221. uOffset: number;
  24222. /**
  24223. * Define an offset on the texture to offset the v coordinates of the UVs
  24224. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  24225. */
  24226. vOffset: number;
  24227. /**
  24228. * Define an offset on the texture to scale the u coordinates of the UVs
  24229. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  24230. */
  24231. uScale: number;
  24232. /**
  24233. * Define an offset on the texture to scale the v coordinates of the UVs
  24234. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  24235. */
  24236. vScale: number;
  24237. /**
  24238. * Define an offset on the texture to rotate around the u coordinates of the UVs
  24239. * @see https://doc.babylonjs.com/how_to/more_materials
  24240. */
  24241. uAng: number;
  24242. /**
  24243. * Define an offset on the texture to rotate around the v coordinates of the UVs
  24244. * @see https://doc.babylonjs.com/how_to/more_materials
  24245. */
  24246. vAng: number;
  24247. /**
  24248. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  24249. * @see https://doc.babylonjs.com/how_to/more_materials
  24250. */
  24251. wAng: number;
  24252. /**
  24253. * Defines the center of rotation (U)
  24254. */
  24255. uRotationCenter: number;
  24256. /**
  24257. * Defines the center of rotation (V)
  24258. */
  24259. vRotationCenter: number;
  24260. /**
  24261. * Defines the center of rotation (W)
  24262. */
  24263. wRotationCenter: number;
  24264. /**
  24265. * Are mip maps generated for this texture or not.
  24266. */
  24267. get noMipmap(): boolean;
  24268. /**
  24269. * List of inspectable custom properties (used by the Inspector)
  24270. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  24271. */
  24272. inspectableCustomProperties: Nullable<IInspectable[]>;
  24273. private _noMipmap;
  24274. /** @hidden */
  24275. _invertY: boolean;
  24276. private _rowGenerationMatrix;
  24277. private _cachedTextureMatrix;
  24278. private _projectionModeMatrix;
  24279. private _t0;
  24280. private _t1;
  24281. private _t2;
  24282. private _cachedUOffset;
  24283. private _cachedVOffset;
  24284. private _cachedUScale;
  24285. private _cachedVScale;
  24286. private _cachedUAng;
  24287. private _cachedVAng;
  24288. private _cachedWAng;
  24289. private _cachedProjectionMatrixId;
  24290. private _cachedCoordinatesMode;
  24291. /** @hidden */
  24292. protected _initialSamplingMode: number;
  24293. /** @hidden */
  24294. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  24295. private _deleteBuffer;
  24296. protected _format: Nullable<number>;
  24297. private _delayedOnLoad;
  24298. private _delayedOnError;
  24299. private _mimeType?;
  24300. /** Returns the texture mime type if it was defined by a loader (undefined else) */
  24301. get mimeType(): string | undefined;
  24302. /**
  24303. * Observable triggered once the texture has been loaded.
  24304. */
  24305. onLoadObservable: Observable<Texture>;
  24306. protected _isBlocking: boolean;
  24307. /**
  24308. * Is the texture preventing material to render while loading.
  24309. * If false, a default texture will be used instead of the loading one during the preparation step.
  24310. */
  24311. set isBlocking(value: boolean);
  24312. get isBlocking(): boolean;
  24313. /**
  24314. * Get the current sampling mode associated with the texture.
  24315. */
  24316. get samplingMode(): number;
  24317. /**
  24318. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  24319. */
  24320. get invertY(): boolean;
  24321. /**
  24322. * Instantiates a new texture.
  24323. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  24324. * @see https://doc.babylonjs.com/babylon101/materials#texture
  24325. * @param url defines the url of the picture to load as a texture
  24326. * @param sceneOrEngine defines the scene or engine the texture will belong to
  24327. * @param noMipmap defines if the texture will require mip maps or not
  24328. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  24329. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24330. * @param onLoad defines a callback triggered when the texture has been loaded
  24331. * @param onError defines a callback triggered when an error occurred during the loading session
  24332. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  24333. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  24334. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24335. * @param mimeType defines an optional mime type information
  24336. */
  24337. 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);
  24338. /**
  24339. * Update the url (and optional buffer) of this texture if url was null during construction.
  24340. * @param url the url of the texture
  24341. * @param buffer the buffer of the texture (defaults to null)
  24342. * @param onLoad callback called when the texture is loaded (defaults to null)
  24343. */
  24344. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  24345. /**
  24346. * Finish the loading sequence of a texture flagged as delayed load.
  24347. * @hidden
  24348. */
  24349. delayLoad(): void;
  24350. private _prepareRowForTextureGeneration;
  24351. /**
  24352. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  24353. * @returns the transform matrix of the texture.
  24354. */
  24355. getTextureMatrix(uBase?: number): Matrix;
  24356. /**
  24357. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  24358. * @returns The reflection texture transform
  24359. */
  24360. getReflectionTextureMatrix(): Matrix;
  24361. /**
  24362. * Clones the texture.
  24363. * @returns the cloned texture
  24364. */
  24365. clone(): Texture;
  24366. /**
  24367. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  24368. * @returns The JSON representation of the texture
  24369. */
  24370. serialize(): any;
  24371. /**
  24372. * Get the current class name of the texture useful for serialization or dynamic coding.
  24373. * @returns "Texture"
  24374. */
  24375. getClassName(): string;
  24376. /**
  24377. * Dispose the texture and release its associated resources.
  24378. */
  24379. dispose(): void;
  24380. /**
  24381. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  24382. * @param parsedTexture Define the JSON representation of the texture
  24383. * @param scene Define the scene the parsed texture should be instantiated in
  24384. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  24385. * @returns The parsed texture if successful
  24386. */
  24387. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  24388. /**
  24389. * Creates a texture from its base 64 representation.
  24390. * @param data Define the base64 payload without the data: prefix
  24391. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  24392. * @param scene Define the scene the texture should belong to
  24393. * @param noMipmap Forces the texture to not create mip map information if true
  24394. * @param invertY define if the texture needs to be inverted on the y axis during loading
  24395. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24396. * @param onLoad define a callback triggered when the texture has been loaded
  24397. * @param onError define a callback triggered when an error occurred during the loading session
  24398. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24399. * @returns the created texture
  24400. */
  24401. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  24402. /**
  24403. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  24404. * @param data Define the base64 payload without the data: prefix
  24405. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  24406. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  24407. * @param scene Define the scene the texture should belong to
  24408. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  24409. * @param noMipmap Forces the texture to not create mip map information if true
  24410. * @param invertY define if the texture needs to be inverted on the y axis during loading
  24411. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24412. * @param onLoad define a callback triggered when the texture has been loaded
  24413. * @param onError define a callback triggered when an error occurred during the loading session
  24414. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24415. * @returns the created texture
  24416. */
  24417. 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;
  24418. }
  24419. }
  24420. declare module "babylonjs/PostProcesses/postProcessManager" {
  24421. import { Nullable } from "babylonjs/types";
  24422. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24423. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24424. import { Scene } from "babylonjs/scene";
  24425. /**
  24426. * PostProcessManager is used to manage one or more post processes or post process pipelines
  24427. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  24428. */
  24429. export class PostProcessManager {
  24430. private _scene;
  24431. private _indexBuffer;
  24432. private _vertexBuffers;
  24433. /**
  24434. * Creates a new instance PostProcess
  24435. * @param scene The scene that the post process is associated with.
  24436. */
  24437. constructor(scene: Scene);
  24438. private _prepareBuffers;
  24439. private _buildIndexBuffer;
  24440. /**
  24441. * Rebuilds the vertex buffers of the manager.
  24442. * @hidden
  24443. */
  24444. _rebuild(): void;
  24445. /**
  24446. * Prepares a frame to be run through a post process.
  24447. * @param sourceTexture The input texture to the post procesess. (default: null)
  24448. * @param postProcesses An array of post processes to be run. (default: null)
  24449. * @returns True if the post processes were able to be run.
  24450. * @hidden
  24451. */
  24452. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  24453. /**
  24454. * Manually render a set of post processes to a texture.
  24455. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  24456. * @param postProcesses An array of post processes to be run.
  24457. * @param targetTexture The target texture to render to.
  24458. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  24459. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  24460. * @param lodLevel defines which lod of the texture to render to
  24461. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  24462. */
  24463. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  24464. /**
  24465. * Finalize the result of the output of the postprocesses.
  24466. * @param doNotPresent If true the result will not be displayed to the screen.
  24467. * @param targetTexture The target texture to render to.
  24468. * @param faceIndex The index of the face to bind the target texture to.
  24469. * @param postProcesses The array of post processes to render.
  24470. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  24471. * @hidden
  24472. */
  24473. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  24474. /**
  24475. * Disposes of the post process manager.
  24476. */
  24477. dispose(): void;
  24478. }
  24479. }
  24480. declare module "babylonjs/Materials/Textures/renderTargetTexture" {
  24481. import { Observable } from "babylonjs/Misc/observable";
  24482. import { SmartArray } from "babylonjs/Misc/smartArray";
  24483. import { Nullable, Immutable } from "babylonjs/types";
  24484. import { Camera } from "babylonjs/Cameras/camera";
  24485. import { Scene } from "babylonjs/scene";
  24486. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  24487. import { Color4 } from "babylonjs/Maths/math.color";
  24488. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  24489. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  24490. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24491. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24492. import { Texture } from "babylonjs/Materials/Textures/texture";
  24493. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24494. import { RenderingManager } from "babylonjs/Rendering/renderingManager";
  24495. import "babylonjs/Engines/Extensions/engine.renderTarget";
  24496. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  24497. import { Engine } from "babylonjs/Engines/engine";
  24498. /**
  24499. * This Helps creating a texture that will be created from a camera in your scene.
  24500. * It is basically a dynamic texture that could be used to create special effects for instance.
  24501. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  24502. */
  24503. export class RenderTargetTexture extends Texture {
  24504. /**
  24505. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  24506. */
  24507. static readonly REFRESHRATE_RENDER_ONCE: number;
  24508. /**
  24509. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  24510. */
  24511. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  24512. /**
  24513. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  24514. * the central point of your effect and can save a lot of performances.
  24515. */
  24516. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  24517. /**
  24518. * Use this predicate to dynamically define the list of mesh you want to render.
  24519. * If set, the renderList property will be overwritten.
  24520. */
  24521. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  24522. private _renderList;
  24523. /**
  24524. * Use this list to define the list of mesh you want to render.
  24525. */
  24526. get renderList(): Nullable<Array<AbstractMesh>>;
  24527. set renderList(value: Nullable<Array<AbstractMesh>>);
  24528. /**
  24529. * Use this function to overload the renderList array at rendering time.
  24530. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  24531. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  24532. * the cube (if the RTT is a cube, else layerOrFace=0).
  24533. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  24534. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  24535. * hold dummy elements!
  24536. */
  24537. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  24538. private _hookArray;
  24539. /**
  24540. * Define if particles should be rendered in your texture.
  24541. */
  24542. renderParticles: boolean;
  24543. /**
  24544. * Define if sprites should be rendered in your texture.
  24545. */
  24546. renderSprites: boolean;
  24547. /**
  24548. * Define the camera used to render the texture.
  24549. */
  24550. activeCamera: Nullable<Camera>;
  24551. /**
  24552. * Override the mesh isReady function with your own one.
  24553. */
  24554. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  24555. /**
  24556. * Override the render function of the texture with your own one.
  24557. */
  24558. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  24559. /**
  24560. * Define if camera post processes should be use while rendering the texture.
  24561. */
  24562. useCameraPostProcesses: boolean;
  24563. /**
  24564. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  24565. */
  24566. ignoreCameraViewport: boolean;
  24567. private _postProcessManager;
  24568. private _postProcesses;
  24569. private _resizeObserver;
  24570. /**
  24571. * An event triggered when the texture is unbind.
  24572. */
  24573. onBeforeBindObservable: Observable<RenderTargetTexture>;
  24574. /**
  24575. * An event triggered when the texture is unbind.
  24576. */
  24577. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  24578. private _onAfterUnbindObserver;
  24579. /**
  24580. * Set a after unbind callback in the texture.
  24581. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  24582. */
  24583. set onAfterUnbind(callback: () => void);
  24584. /**
  24585. * An event triggered before rendering the texture
  24586. */
  24587. onBeforeRenderObservable: Observable<number>;
  24588. private _onBeforeRenderObserver;
  24589. /**
  24590. * Set a before render callback in the texture.
  24591. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  24592. */
  24593. set onBeforeRender(callback: (faceIndex: number) => void);
  24594. /**
  24595. * An event triggered after rendering the texture
  24596. */
  24597. onAfterRenderObservable: Observable<number>;
  24598. private _onAfterRenderObserver;
  24599. /**
  24600. * Set a after render callback in the texture.
  24601. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  24602. */
  24603. set onAfterRender(callback: (faceIndex: number) => void);
  24604. /**
  24605. * An event triggered after the texture clear
  24606. */
  24607. onClearObservable: Observable<Engine>;
  24608. private _onClearObserver;
  24609. /**
  24610. * Set a clear callback in the texture.
  24611. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  24612. */
  24613. set onClear(callback: (Engine: Engine) => void);
  24614. /**
  24615. * An event triggered when the texture is resized.
  24616. */
  24617. onResizeObservable: Observable<RenderTargetTexture>;
  24618. /**
  24619. * Define the clear color of the Render Target if it should be different from the scene.
  24620. */
  24621. clearColor: Color4;
  24622. protected _size: number | {
  24623. width: number;
  24624. height: number;
  24625. layers?: number;
  24626. };
  24627. protected _initialSizeParameter: number | {
  24628. width: number;
  24629. height: number;
  24630. } | {
  24631. ratio: number;
  24632. };
  24633. protected _sizeRatio: Nullable<number>;
  24634. /** @hidden */
  24635. _generateMipMaps: boolean;
  24636. protected _renderingManager: RenderingManager;
  24637. /** @hidden */
  24638. _waitingRenderList?: string[];
  24639. protected _doNotChangeAspectRatio: boolean;
  24640. protected _currentRefreshId: number;
  24641. protected _refreshRate: number;
  24642. protected _textureMatrix: Matrix;
  24643. protected _samples: number;
  24644. protected _renderTargetOptions: RenderTargetCreationOptions;
  24645. /**
  24646. * Gets render target creation options that were used.
  24647. */
  24648. get renderTargetOptions(): RenderTargetCreationOptions;
  24649. protected _onRatioRescale(): void;
  24650. /**
  24651. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  24652. * It must define where the camera used to render the texture is set
  24653. */
  24654. boundingBoxPosition: Vector3;
  24655. private _boundingBoxSize;
  24656. /**
  24657. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  24658. * When defined, the cubemap will switch to local mode
  24659. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  24660. * @example https://www.babylonjs-playground.com/#RNASML
  24661. */
  24662. set boundingBoxSize(value: Vector3);
  24663. get boundingBoxSize(): Vector3;
  24664. /**
  24665. * In case the RTT has been created with a depth texture, get the associated
  24666. * depth texture.
  24667. * Otherwise, return null.
  24668. */
  24669. get depthStencilTexture(): Nullable<InternalTexture>;
  24670. /**
  24671. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  24672. * or used a shadow, depth texture...
  24673. * @param name The friendly name of the texture
  24674. * @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)
  24675. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  24676. * @param generateMipMaps True if mip maps need to be generated after render.
  24677. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  24678. * @param type The type of the buffer in the RTT (int, half float, float...)
  24679. * @param isCube True if a cube texture needs to be created
  24680. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  24681. * @param generateDepthBuffer True to generate a depth buffer
  24682. * @param generateStencilBuffer True to generate a stencil buffer
  24683. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  24684. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  24685. * @param delayAllocation if the texture allocation should be delayed (default: false)
  24686. */
  24687. constructor(name: string, size: number | {
  24688. width: number;
  24689. height: number;
  24690. layers?: number;
  24691. } | {
  24692. ratio: number;
  24693. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  24694. /**
  24695. * Creates a depth stencil texture.
  24696. * This is only available in WebGL 2 or with the depth texture extension available.
  24697. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  24698. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  24699. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  24700. */
  24701. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  24702. private _processSizeParameter;
  24703. /**
  24704. * Define the number of samples to use in case of MSAA.
  24705. * It defaults to one meaning no MSAA has been enabled.
  24706. */
  24707. get samples(): number;
  24708. set samples(value: number);
  24709. /**
  24710. * Resets the refresh counter of the texture and start bak from scratch.
  24711. * Could be useful to regenerate the texture if it is setup to render only once.
  24712. */
  24713. resetRefreshCounter(): void;
  24714. /**
  24715. * Define the refresh rate of the texture or the rendering frequency.
  24716. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  24717. */
  24718. get refreshRate(): number;
  24719. set refreshRate(value: number);
  24720. /**
  24721. * Adds a post process to the render target rendering passes.
  24722. * @param postProcess define the post process to add
  24723. */
  24724. addPostProcess(postProcess: PostProcess): void;
  24725. /**
  24726. * Clear all the post processes attached to the render target
  24727. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  24728. */
  24729. clearPostProcesses(dispose?: boolean): void;
  24730. /**
  24731. * Remove one of the post process from the list of attached post processes to the texture
  24732. * @param postProcess define the post process to remove from the list
  24733. */
  24734. removePostProcess(postProcess: PostProcess): void;
  24735. /** @hidden */
  24736. _shouldRender(): boolean;
  24737. /**
  24738. * Gets the actual render size of the texture.
  24739. * @returns the width of the render size
  24740. */
  24741. getRenderSize(): number;
  24742. /**
  24743. * Gets the actual render width of the texture.
  24744. * @returns the width of the render size
  24745. */
  24746. getRenderWidth(): number;
  24747. /**
  24748. * Gets the actual render height of the texture.
  24749. * @returns the height of the render size
  24750. */
  24751. getRenderHeight(): number;
  24752. /**
  24753. * Gets the actual number of layers of the texture.
  24754. * @returns the number of layers
  24755. */
  24756. getRenderLayers(): number;
  24757. /**
  24758. * Get if the texture can be rescaled or not.
  24759. */
  24760. get canRescale(): boolean;
  24761. /**
  24762. * Resize the texture using a ratio.
  24763. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  24764. */
  24765. scale(ratio: number): void;
  24766. /**
  24767. * Get the texture reflection matrix used to rotate/transform the reflection.
  24768. * @returns the reflection matrix
  24769. */
  24770. getReflectionTextureMatrix(): Matrix;
  24771. /**
  24772. * Resize the texture to a new desired size.
  24773. * Be carrefull as it will recreate all the data in the new texture.
  24774. * @param size Define the new size. It can be:
  24775. * - a number for squared texture,
  24776. * - an object containing { width: number, height: number }
  24777. * - or an object containing a ratio { ratio: number }
  24778. */
  24779. resize(size: number | {
  24780. width: number;
  24781. height: number;
  24782. } | {
  24783. ratio: number;
  24784. }): void;
  24785. private _defaultRenderListPrepared;
  24786. /**
  24787. * Renders all the objects from the render list into the texture.
  24788. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  24789. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  24790. */
  24791. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  24792. private _bestReflectionRenderTargetDimension;
  24793. private _prepareRenderingManager;
  24794. /**
  24795. * @hidden
  24796. * @param faceIndex face index to bind to if this is a cubetexture
  24797. * @param layer defines the index of the texture to bind in the array
  24798. */
  24799. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  24800. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  24801. private renderToTarget;
  24802. /**
  24803. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  24804. * This allowed control for front to back rendering or reversly depending of the special needs.
  24805. *
  24806. * @param renderingGroupId The rendering group id corresponding to its index
  24807. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  24808. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  24809. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  24810. */
  24811. 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;
  24812. /**
  24813. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  24814. *
  24815. * @param renderingGroupId The rendering group id corresponding to its index
  24816. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  24817. */
  24818. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  24819. /**
  24820. * Clones the texture.
  24821. * @returns the cloned texture
  24822. */
  24823. clone(): RenderTargetTexture;
  24824. /**
  24825. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  24826. * @returns The JSON representation of the texture
  24827. */
  24828. serialize(): any;
  24829. /**
  24830. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  24831. */
  24832. disposeFramebufferObjects(): void;
  24833. /**
  24834. * Dispose the texture and release its associated resources.
  24835. */
  24836. dispose(): void;
  24837. /** @hidden */
  24838. _rebuild(): void;
  24839. /**
  24840. * Clear the info related to rendering groups preventing retention point in material dispose.
  24841. */
  24842. freeRenderingGroups(): void;
  24843. /**
  24844. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  24845. * @returns the view count
  24846. */
  24847. getViewCount(): number;
  24848. }
  24849. }
  24850. declare module "babylonjs/Misc/guid" {
  24851. /**
  24852. * Class used to manipulate GUIDs
  24853. */
  24854. export class GUID {
  24855. /**
  24856. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  24857. * Be aware Math.random() could cause collisions, but:
  24858. * "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"
  24859. * @returns a pseudo random id
  24860. */
  24861. static RandomId(): string;
  24862. }
  24863. }
  24864. declare module "babylonjs/Materials/shadowDepthWrapper" {
  24865. import { Nullable } from "babylonjs/types";
  24866. import { Scene } from "babylonjs/scene";
  24867. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24868. import { Material } from "babylonjs/Materials/material";
  24869. import { Effect } from "babylonjs/Materials/effect";
  24870. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  24871. /**
  24872. * Options to be used when creating a shadow depth material
  24873. */
  24874. export interface IIOptionShadowDepthMaterial {
  24875. /** Variables in the vertex shader code that need to have their names remapped.
  24876. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  24877. * "var_name" should be either: worldPos or vNormalW
  24878. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  24879. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  24880. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  24881. */
  24882. remappedVariables?: string[];
  24883. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  24884. standalone?: boolean;
  24885. }
  24886. /**
  24887. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  24888. */
  24889. export class ShadowDepthWrapper {
  24890. private _scene;
  24891. private _options?;
  24892. private _baseMaterial;
  24893. private _onEffectCreatedObserver;
  24894. private _subMeshToEffect;
  24895. private _subMeshToDepthEffect;
  24896. private _meshes;
  24897. /** @hidden */
  24898. _matriceNames: any;
  24899. /** Gets the standalone status of the wrapper */
  24900. get standalone(): boolean;
  24901. /** Gets the base material the wrapper is built upon */
  24902. get baseMaterial(): Material;
  24903. /**
  24904. * Instantiate a new shadow depth wrapper.
  24905. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  24906. * generate the shadow depth map. For more information, please refer to the documentation:
  24907. * https://doc.babylonjs.com/babylon101/shadows
  24908. * @param baseMaterial Material to wrap
  24909. * @param scene Define the scene the material belongs to
  24910. * @param options Options used to create the wrapper
  24911. */
  24912. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  24913. /**
  24914. * Gets the effect to use to generate the depth map
  24915. * @param subMesh subMesh to get the effect for
  24916. * @param shadowGenerator shadow generator to get the effect for
  24917. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  24918. */
  24919. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  24920. /**
  24921. * Specifies that the submesh is ready to be used for depth rendering
  24922. * @param subMesh submesh to check
  24923. * @param defines the list of defines to take into account when checking the effect
  24924. * @param shadowGenerator combined with subMesh, it defines the effect to check
  24925. * @param useInstances specifies that instances should be used
  24926. * @returns a boolean indicating that the submesh is ready or not
  24927. */
  24928. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  24929. /**
  24930. * Disposes the resources
  24931. */
  24932. dispose(): void;
  24933. private _makeEffect;
  24934. }
  24935. }
  24936. declare module "babylonjs/Engines/Extensions/engine.multiRender" {
  24937. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24938. import { IMultiRenderTargetOptions } from "babylonjs/Materials/Textures/multiRenderTarget";
  24939. import { Nullable } from "babylonjs/types";
  24940. module "babylonjs/Engines/thinEngine" {
  24941. interface ThinEngine {
  24942. /**
  24943. * Unbind a list of render target textures from the webGL context
  24944. * This is used only when drawBuffer extension or webGL2 are active
  24945. * @param textures defines the render target textures to unbind
  24946. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  24947. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  24948. */
  24949. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  24950. /**
  24951. * Create a multi render target texture
  24952. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  24953. * @param size defines the size of the texture
  24954. * @param options defines the creation options
  24955. * @returns the cube texture as an InternalTexture
  24956. */
  24957. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  24958. /**
  24959. * Update the sample count for a given multiple render target texture
  24960. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  24961. * @param textures defines the textures to update
  24962. * @param samples defines the sample count to set
  24963. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  24964. */
  24965. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  24966. /**
  24967. * Select a subsets of attachments to draw to.
  24968. * @param attachments gl attachments
  24969. */
  24970. bindAttachments(attachments: number[]): void;
  24971. }
  24972. }
  24973. }
  24974. declare module "babylonjs/Materials/Textures/multiRenderTarget" {
  24975. import { Scene } from "babylonjs/scene";
  24976. import { Engine } from "babylonjs/Engines/engine";
  24977. import { Texture } from "babylonjs/Materials/Textures/texture";
  24978. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  24979. import "babylonjs/Engines/Extensions/engine.multiRender";
  24980. /**
  24981. * Creation options of the multi render target texture.
  24982. */
  24983. export interface IMultiRenderTargetOptions {
  24984. /**
  24985. * Define if the texture needs to create mip maps after render.
  24986. */
  24987. generateMipMaps?: boolean;
  24988. /**
  24989. * Define the types of all the draw buffers we want to create
  24990. */
  24991. types?: number[];
  24992. /**
  24993. * Define the sampling modes of all the draw buffers we want to create
  24994. */
  24995. samplingModes?: number[];
  24996. /**
  24997. * Define if a depth buffer is required
  24998. */
  24999. generateDepthBuffer?: boolean;
  25000. /**
  25001. * Define if a stencil buffer is required
  25002. */
  25003. generateStencilBuffer?: boolean;
  25004. /**
  25005. * Define if a depth texture is required instead of a depth buffer
  25006. */
  25007. generateDepthTexture?: boolean;
  25008. /**
  25009. * Define the number of desired draw buffers
  25010. */
  25011. textureCount?: number;
  25012. /**
  25013. * Define if aspect ratio should be adapted to the texture or stay the scene one
  25014. */
  25015. doNotChangeAspectRatio?: boolean;
  25016. /**
  25017. * Define the default type of the buffers we are creating
  25018. */
  25019. defaultType?: number;
  25020. }
  25021. /**
  25022. * A multi render target, like a render target provides the ability to render to a texture.
  25023. * Unlike the render target, it can render to several draw buffers in one draw.
  25024. * This is specially interesting in deferred rendering or for any effects requiring more than
  25025. * just one color from a single pass.
  25026. */
  25027. export class MultiRenderTarget extends RenderTargetTexture {
  25028. private _internalTextures;
  25029. private _textures;
  25030. private _multiRenderTargetOptions;
  25031. private _count;
  25032. /**
  25033. * Get if draw buffers are currently supported by the used hardware and browser.
  25034. */
  25035. get isSupported(): boolean;
  25036. /**
  25037. * Get the list of textures generated by the multi render target.
  25038. */
  25039. get textures(): Texture[];
  25040. /**
  25041. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  25042. */
  25043. get count(): number;
  25044. /**
  25045. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  25046. */
  25047. get depthTexture(): Texture;
  25048. /**
  25049. * Set the wrapping mode on U of all the textures we are rendering to.
  25050. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  25051. */
  25052. set wrapU(wrap: number);
  25053. /**
  25054. * Set the wrapping mode on V of all the textures we are rendering to.
  25055. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  25056. */
  25057. set wrapV(wrap: number);
  25058. /**
  25059. * Instantiate a new multi render target texture.
  25060. * A multi render target, like a render target provides the ability to render to a texture.
  25061. * Unlike the render target, it can render to several draw buffers in one draw.
  25062. * This is specially interesting in deferred rendering or for any effects requiring more than
  25063. * just one color from a single pass.
  25064. * @param name Define the name of the texture
  25065. * @param size Define the size of the buffers to render to
  25066. * @param count Define the number of target we are rendering into
  25067. * @param scene Define the scene the texture belongs to
  25068. * @param options Define the options used to create the multi render target
  25069. */
  25070. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  25071. private _initTypes;
  25072. /** @hidden */
  25073. _rebuild(forceFullRebuild?: boolean): void;
  25074. private _createInternalTextures;
  25075. private _createTextures;
  25076. /**
  25077. * Define the number of samples used if MSAA is enabled.
  25078. */
  25079. get samples(): number;
  25080. set samples(value: number);
  25081. /**
  25082. * Resize all the textures in the multi render target.
  25083. * Be careful as it will recreate all the data in the new texture.
  25084. * @param size Define the new size
  25085. */
  25086. resize(size: any): void;
  25087. /**
  25088. * Changes the number of render targets in this MRT
  25089. * Be careful as it will recreate all the data in the new texture.
  25090. * @param count new texture count
  25091. * @param options Specifies texture types and sampling modes for new textures
  25092. */
  25093. updateCount(count: number, options?: IMultiRenderTargetOptions): void;
  25094. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  25095. /**
  25096. * Dispose the render targets and their associated resources
  25097. */
  25098. dispose(): void;
  25099. /**
  25100. * Release all the underlying texture used as draw buffers.
  25101. */
  25102. releaseInternalTextures(): void;
  25103. }
  25104. }
  25105. declare module "babylonjs/Shaders/imageProcessing.fragment" {
  25106. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  25107. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  25108. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  25109. /** @hidden */
  25110. export var imageProcessingPixelShader: {
  25111. name: string;
  25112. shader: string;
  25113. };
  25114. }
  25115. declare module "babylonjs/PostProcesses/imageProcessingPostProcess" {
  25116. import { Nullable } from "babylonjs/types";
  25117. import { Color4 } from "babylonjs/Maths/math.color";
  25118. import { Camera } from "babylonjs/Cameras/camera";
  25119. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  25120. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  25121. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  25122. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  25123. import { Engine } from "babylonjs/Engines/engine";
  25124. import "babylonjs/Shaders/imageProcessing.fragment";
  25125. import "babylonjs/Shaders/postprocess.vertex";
  25126. /**
  25127. * ImageProcessingPostProcess
  25128. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  25129. */
  25130. export class ImageProcessingPostProcess extends PostProcess {
  25131. /**
  25132. * Default configuration related to image processing available in the PBR Material.
  25133. */
  25134. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  25135. /**
  25136. * Gets the image processing configuration used either in this material.
  25137. */
  25138. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  25139. /**
  25140. * Sets the Default image processing configuration used either in the this material.
  25141. *
  25142. * If sets to null, the scene one is in use.
  25143. */
  25144. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  25145. /**
  25146. * Keep track of the image processing observer to allow dispose and replace.
  25147. */
  25148. private _imageProcessingObserver;
  25149. /**
  25150. * Attaches a new image processing configuration to the PBR Material.
  25151. * @param configuration
  25152. */
  25153. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  25154. /**
  25155. * If the post process is supported.
  25156. */
  25157. get isSupported(): boolean;
  25158. /**
  25159. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  25160. */
  25161. get colorCurves(): Nullable<ColorCurves>;
  25162. /**
  25163. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  25164. */
  25165. set colorCurves(value: Nullable<ColorCurves>);
  25166. /**
  25167. * Gets wether the color curves effect is enabled.
  25168. */
  25169. get colorCurvesEnabled(): boolean;
  25170. /**
  25171. * Sets wether the color curves effect is enabled.
  25172. */
  25173. set colorCurvesEnabled(value: boolean);
  25174. /**
  25175. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  25176. */
  25177. get colorGradingTexture(): Nullable<BaseTexture>;
  25178. /**
  25179. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  25180. */
  25181. set colorGradingTexture(value: Nullable<BaseTexture>);
  25182. /**
  25183. * Gets wether the color grading effect is enabled.
  25184. */
  25185. get colorGradingEnabled(): boolean;
  25186. /**
  25187. * Gets wether the color grading effect is enabled.
  25188. */
  25189. set colorGradingEnabled(value: boolean);
  25190. /**
  25191. * Gets exposure used in the effect.
  25192. */
  25193. get exposure(): number;
  25194. /**
  25195. * Sets exposure used in the effect.
  25196. */
  25197. set exposure(value: number);
  25198. /**
  25199. * Gets wether tonemapping is enabled or not.
  25200. */
  25201. get toneMappingEnabled(): boolean;
  25202. /**
  25203. * Sets wether tonemapping is enabled or not
  25204. */
  25205. set toneMappingEnabled(value: boolean);
  25206. /**
  25207. * Gets the type of tone mapping effect.
  25208. */
  25209. get toneMappingType(): number;
  25210. /**
  25211. * Sets the type of tone mapping effect.
  25212. */
  25213. set toneMappingType(value: number);
  25214. /**
  25215. * Gets contrast used in the effect.
  25216. */
  25217. get contrast(): number;
  25218. /**
  25219. * Sets contrast used in the effect.
  25220. */
  25221. set contrast(value: number);
  25222. /**
  25223. * Gets Vignette stretch size.
  25224. */
  25225. get vignetteStretch(): number;
  25226. /**
  25227. * Sets Vignette stretch size.
  25228. */
  25229. set vignetteStretch(value: number);
  25230. /**
  25231. * Gets Vignette centre X Offset.
  25232. */
  25233. get vignetteCentreX(): number;
  25234. /**
  25235. * Sets Vignette centre X Offset.
  25236. */
  25237. set vignetteCentreX(value: number);
  25238. /**
  25239. * Gets Vignette centre Y Offset.
  25240. */
  25241. get vignetteCentreY(): number;
  25242. /**
  25243. * Sets Vignette centre Y Offset.
  25244. */
  25245. set vignetteCentreY(value: number);
  25246. /**
  25247. * Gets Vignette weight or intensity of the vignette effect.
  25248. */
  25249. get vignetteWeight(): number;
  25250. /**
  25251. * Sets Vignette weight or intensity of the vignette effect.
  25252. */
  25253. set vignetteWeight(value: number);
  25254. /**
  25255. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  25256. * if vignetteEnabled is set to true.
  25257. */
  25258. get vignetteColor(): Color4;
  25259. /**
  25260. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  25261. * if vignetteEnabled is set to true.
  25262. */
  25263. set vignetteColor(value: Color4);
  25264. /**
  25265. * Gets Camera field of view used by the Vignette effect.
  25266. */
  25267. get vignetteCameraFov(): number;
  25268. /**
  25269. * Sets Camera field of view used by the Vignette effect.
  25270. */
  25271. set vignetteCameraFov(value: number);
  25272. /**
  25273. * Gets the vignette blend mode allowing different kind of effect.
  25274. */
  25275. get vignetteBlendMode(): number;
  25276. /**
  25277. * Sets the vignette blend mode allowing different kind of effect.
  25278. */
  25279. set vignetteBlendMode(value: number);
  25280. /**
  25281. * Gets wether the vignette effect is enabled.
  25282. */
  25283. get vignetteEnabled(): boolean;
  25284. /**
  25285. * Sets wether the vignette effect is enabled.
  25286. */
  25287. set vignetteEnabled(value: boolean);
  25288. private _fromLinearSpace;
  25289. /**
  25290. * Gets wether the input of the processing is in Gamma or Linear Space.
  25291. */
  25292. get fromLinearSpace(): boolean;
  25293. /**
  25294. * Sets wether the input of the processing is in Gamma or Linear Space.
  25295. */
  25296. set fromLinearSpace(value: boolean);
  25297. /**
  25298. * Defines cache preventing GC.
  25299. */
  25300. private _defines;
  25301. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  25302. /**
  25303. * "ImageProcessingPostProcess"
  25304. * @returns "ImageProcessingPostProcess"
  25305. */
  25306. getClassName(): string;
  25307. /**
  25308. * @hidden
  25309. */
  25310. _updateParameters(): void;
  25311. dispose(camera?: Camera): void;
  25312. }
  25313. }
  25314. declare module "babylonjs/Rendering/prePassEffectConfiguration" {
  25315. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  25316. /**
  25317. * Interface for defining prepass effects in the prepass post-process pipeline
  25318. */
  25319. export interface PrePassEffectConfiguration {
  25320. /**
  25321. * Name of the effect
  25322. */
  25323. name: string;
  25324. /**
  25325. * Post process to attach for this effect
  25326. */
  25327. postProcess?: PostProcess;
  25328. /**
  25329. * Textures required in the MRT
  25330. */
  25331. texturesRequired: number[];
  25332. /**
  25333. * Is the effect enabled
  25334. */
  25335. enabled: boolean;
  25336. /**
  25337. * Disposes the effect configuration
  25338. */
  25339. dispose(): void;
  25340. /**
  25341. * Creates the associated post process
  25342. */
  25343. createPostProcess?: () => PostProcess;
  25344. }
  25345. }
  25346. declare module "babylonjs/Rendering/prePassRenderer" {
  25347. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  25348. import { Scene } from "babylonjs/scene";
  25349. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  25350. import { Effect } from "babylonjs/Materials/effect";
  25351. import { PrePassEffectConfiguration } from "babylonjs/Rendering/prePassEffectConfiguration";
  25352. /**
  25353. * Renders a pre pass of the scene
  25354. * This means every mesh in the scene will be rendered to a render target texture
  25355. * And then this texture will be composited to the rendering canvas with post processes
  25356. * It is necessary for effects like subsurface scattering or deferred shading
  25357. */
  25358. export class PrePassRenderer {
  25359. /** @hidden */
  25360. static _SceneComponentInitialization: (scene: Scene) => void;
  25361. private _textureFormats;
  25362. private _textureIndices;
  25363. private _scene;
  25364. private _engine;
  25365. private _isDirty;
  25366. /**
  25367. * Number of textures in the multi render target texture where the scene is directly rendered
  25368. */
  25369. mrtCount: number;
  25370. /**
  25371. * The render target where the scene is directly rendered
  25372. */
  25373. prePassRT: MultiRenderTarget;
  25374. private _multiRenderAttachments;
  25375. private _defaultAttachments;
  25376. private _clearAttachments;
  25377. private _postProcesses;
  25378. private readonly _clearColor;
  25379. /**
  25380. * Image processing post process for composition
  25381. */
  25382. imageProcessingPostProcess: ImageProcessingPostProcess;
  25383. /**
  25384. * Configuration for prepass effects
  25385. */
  25386. private _effectConfigurations;
  25387. /**
  25388. * Should materials render their geometry on the MRT
  25389. */
  25390. materialsShouldRenderGeometry: boolean;
  25391. /**
  25392. * Should materials render the irradiance information on the MRT
  25393. */
  25394. materialsShouldRenderIrradiance: boolean;
  25395. private _mrtFormats;
  25396. private _mrtLayout;
  25397. private _enabled;
  25398. /**
  25399. * Indicates if the prepass is enabled
  25400. */
  25401. get enabled(): boolean;
  25402. /**
  25403. * How many samples are used for MSAA of the scene render target
  25404. */
  25405. get samples(): number;
  25406. set samples(n: number);
  25407. /**
  25408. * Instanciates a prepass renderer
  25409. * @param scene The scene
  25410. */
  25411. constructor(scene: Scene);
  25412. private _initializeAttachments;
  25413. private _createCompositionEffect;
  25414. /**
  25415. * Indicates if rendering a prepass is supported
  25416. */
  25417. get isSupported(): boolean;
  25418. /**
  25419. * Sets the proper output textures to draw in the engine.
  25420. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  25421. */
  25422. bindAttachmentsForEffect(effect: Effect): void;
  25423. /**
  25424. * @hidden
  25425. */
  25426. _beforeCameraDraw(): void;
  25427. /**
  25428. * @hidden
  25429. */
  25430. _afterCameraDraw(): void;
  25431. private _checkRTSize;
  25432. private _bindFrameBuffer;
  25433. /**
  25434. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  25435. */
  25436. clear(): void;
  25437. private _setState;
  25438. private _checkTextureType;
  25439. /**
  25440. * Adds an effect configuration to the prepass.
  25441. * If an effect has already been added, it won't add it twice and will return the configuration
  25442. * already present.
  25443. * @param cfg the effect configuration
  25444. * @return the effect configuration now used by the prepass
  25445. */
  25446. addEffectConfiguration(cfg: PrePassEffectConfiguration): PrePassEffectConfiguration;
  25447. /**
  25448. * Returns the index of a texture in the multi render target texture array.
  25449. * @param type Texture type
  25450. * @return The index
  25451. */
  25452. getIndex(type: number): number;
  25453. private _enable;
  25454. private _disable;
  25455. private _resetLayout;
  25456. private _resetPostProcessChain;
  25457. private _bindPostProcessChain;
  25458. /**
  25459. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  25460. */
  25461. markAsDirty(): void;
  25462. /**
  25463. * Enables a texture on the MultiRenderTarget for prepass
  25464. */
  25465. private _enableTextures;
  25466. private _update;
  25467. /**
  25468. * Disposes the prepass renderer.
  25469. */
  25470. dispose(): void;
  25471. }
  25472. }
  25473. declare module "babylonjs/Materials/material" {
  25474. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  25475. import { SmartArray } from "babylonjs/Misc/smartArray";
  25476. import { Observable } from "babylonjs/Misc/observable";
  25477. import { Nullable } from "babylonjs/types";
  25478. import { Scene } from "babylonjs/scene";
  25479. import { Matrix } from "babylonjs/Maths/math.vector";
  25480. import { SubMesh } from "babylonjs/Meshes/subMesh";
  25481. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25482. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  25483. import { Effect } from "babylonjs/Materials/effect";
  25484. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  25485. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  25486. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  25487. import { IInspectable } from "babylonjs/Misc/iInspectable";
  25488. import { ShadowDepthWrapper } from "babylonjs/Materials/shadowDepthWrapper";
  25489. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  25490. import { Mesh } from "babylonjs/Meshes/mesh";
  25491. import { Animation } from "babylonjs/Animations/animation";
  25492. /**
  25493. * Options for compiling materials.
  25494. */
  25495. export interface IMaterialCompilationOptions {
  25496. /**
  25497. * Defines whether clip planes are enabled.
  25498. */
  25499. clipPlane: boolean;
  25500. /**
  25501. * Defines whether instances are enabled.
  25502. */
  25503. useInstances: boolean;
  25504. }
  25505. /**
  25506. * Options passed when calling customShaderNameResolve
  25507. */
  25508. export interface ICustomShaderNameResolveOptions {
  25509. /**
  25510. * 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
  25511. */
  25512. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  25513. }
  25514. /**
  25515. * Base class for the main features of a material in Babylon.js
  25516. */
  25517. export class Material implements IAnimatable {
  25518. /**
  25519. * Returns the triangle fill mode
  25520. */
  25521. static readonly TriangleFillMode: number;
  25522. /**
  25523. * Returns the wireframe mode
  25524. */
  25525. static readonly WireFrameFillMode: number;
  25526. /**
  25527. * Returns the point fill mode
  25528. */
  25529. static readonly PointFillMode: number;
  25530. /**
  25531. * Returns the point list draw mode
  25532. */
  25533. static readonly PointListDrawMode: number;
  25534. /**
  25535. * Returns the line list draw mode
  25536. */
  25537. static readonly LineListDrawMode: number;
  25538. /**
  25539. * Returns the line loop draw mode
  25540. */
  25541. static readonly LineLoopDrawMode: number;
  25542. /**
  25543. * Returns the line strip draw mode
  25544. */
  25545. static readonly LineStripDrawMode: number;
  25546. /**
  25547. * Returns the triangle strip draw mode
  25548. */
  25549. static readonly TriangleStripDrawMode: number;
  25550. /**
  25551. * Returns the triangle fan draw mode
  25552. */
  25553. static readonly TriangleFanDrawMode: number;
  25554. /**
  25555. * Stores the clock-wise side orientation
  25556. */
  25557. static readonly ClockWiseSideOrientation: number;
  25558. /**
  25559. * Stores the counter clock-wise side orientation
  25560. */
  25561. static readonly CounterClockWiseSideOrientation: number;
  25562. /**
  25563. * The dirty texture flag value
  25564. */
  25565. static readonly TextureDirtyFlag: number;
  25566. /**
  25567. * The dirty light flag value
  25568. */
  25569. static readonly LightDirtyFlag: number;
  25570. /**
  25571. * The dirty fresnel flag value
  25572. */
  25573. static readonly FresnelDirtyFlag: number;
  25574. /**
  25575. * The dirty attribute flag value
  25576. */
  25577. static readonly AttributesDirtyFlag: number;
  25578. /**
  25579. * The dirty misc flag value
  25580. */
  25581. static readonly MiscDirtyFlag: number;
  25582. /**
  25583. * The all dirty flag value
  25584. */
  25585. static readonly AllDirtyFlag: number;
  25586. /**
  25587. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  25588. */
  25589. static readonly MATERIAL_OPAQUE: number;
  25590. /**
  25591. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  25592. */
  25593. static readonly MATERIAL_ALPHATEST: number;
  25594. /**
  25595. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  25596. */
  25597. static readonly MATERIAL_ALPHABLEND: number;
  25598. /**
  25599. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  25600. * They are also discarded below the alpha cutoff threshold to improve performances.
  25601. */
  25602. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  25603. /**
  25604. * The Whiteout method is used to blend normals.
  25605. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  25606. */
  25607. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  25608. /**
  25609. * The Reoriented Normal Mapping method is used to blend normals.
  25610. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  25611. */
  25612. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  25613. /**
  25614. * Custom callback helping to override the default shader used in the material.
  25615. */
  25616. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  25617. /**
  25618. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  25619. */
  25620. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  25621. /**
  25622. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  25623. * This means that the material can keep using a previous shader while a new one is being compiled.
  25624. * This is mostly used when shader parallel compilation is supported (true by default)
  25625. */
  25626. allowShaderHotSwapping: boolean;
  25627. /**
  25628. * The ID of the material
  25629. */
  25630. id: string;
  25631. /**
  25632. * Gets or sets the unique id of the material
  25633. */
  25634. uniqueId: number;
  25635. /**
  25636. * The name of the material
  25637. */
  25638. name: string;
  25639. /**
  25640. * Gets or sets user defined metadata
  25641. */
  25642. metadata: any;
  25643. /**
  25644. * For internal use only. Please do not use.
  25645. */
  25646. reservedDataStore: any;
  25647. /**
  25648. * Specifies if the ready state should be checked on each call
  25649. */
  25650. checkReadyOnEveryCall: boolean;
  25651. /**
  25652. * Specifies if the ready state should be checked once
  25653. */
  25654. checkReadyOnlyOnce: boolean;
  25655. /**
  25656. * The state of the material
  25657. */
  25658. state: string;
  25659. /**
  25660. * If the material can be rendered to several textures with MRT extension
  25661. */
  25662. get canRenderToMRT(): boolean;
  25663. /**
  25664. * The alpha value of the material
  25665. */
  25666. protected _alpha: number;
  25667. /**
  25668. * List of inspectable custom properties (used by the Inspector)
  25669. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  25670. */
  25671. inspectableCustomProperties: IInspectable[];
  25672. /**
  25673. * Sets the alpha value of the material
  25674. */
  25675. set alpha(value: number);
  25676. /**
  25677. * Gets the alpha value of the material
  25678. */
  25679. get alpha(): number;
  25680. /**
  25681. * Specifies if back face culling is enabled
  25682. */
  25683. protected _backFaceCulling: boolean;
  25684. /**
  25685. * Sets the back-face culling state
  25686. */
  25687. set backFaceCulling(value: boolean);
  25688. /**
  25689. * Gets the back-face culling state
  25690. */
  25691. get backFaceCulling(): boolean;
  25692. /**
  25693. * Stores the value for side orientation
  25694. */
  25695. sideOrientation: number;
  25696. /**
  25697. * Callback triggered when the material is compiled
  25698. */
  25699. onCompiled: Nullable<(effect: Effect) => void>;
  25700. /**
  25701. * Callback triggered when an error occurs
  25702. */
  25703. onError: Nullable<(effect: Effect, errors: string) => void>;
  25704. /**
  25705. * Callback triggered to get the render target textures
  25706. */
  25707. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  25708. /**
  25709. * Gets a boolean indicating that current material needs to register RTT
  25710. */
  25711. get hasRenderTargetTextures(): boolean;
  25712. /**
  25713. * Specifies if the material should be serialized
  25714. */
  25715. doNotSerialize: boolean;
  25716. /**
  25717. * @hidden
  25718. */
  25719. _storeEffectOnSubMeshes: boolean;
  25720. /**
  25721. * Stores the animations for the material
  25722. */
  25723. animations: Nullable<Array<Animation>>;
  25724. /**
  25725. * An event triggered when the material is disposed
  25726. */
  25727. onDisposeObservable: Observable<Material>;
  25728. /**
  25729. * An observer which watches for dispose events
  25730. */
  25731. private _onDisposeObserver;
  25732. private _onUnBindObservable;
  25733. /**
  25734. * Called during a dispose event
  25735. */
  25736. set onDispose(callback: () => void);
  25737. private _onBindObservable;
  25738. /**
  25739. * An event triggered when the material is bound
  25740. */
  25741. get onBindObservable(): Observable<AbstractMesh>;
  25742. /**
  25743. * An observer which watches for bind events
  25744. */
  25745. private _onBindObserver;
  25746. /**
  25747. * Called during a bind event
  25748. */
  25749. set onBind(callback: (Mesh: AbstractMesh) => void);
  25750. /**
  25751. * An event triggered when the material is unbound
  25752. */
  25753. get onUnBindObservable(): Observable<Material>;
  25754. protected _onEffectCreatedObservable: Nullable<Observable<{
  25755. effect: Effect;
  25756. subMesh: Nullable<SubMesh>;
  25757. }>>;
  25758. /**
  25759. * An event triggered when the effect is (re)created
  25760. */
  25761. get onEffectCreatedObservable(): Observable<{
  25762. effect: Effect;
  25763. subMesh: Nullable<SubMesh>;
  25764. }>;
  25765. /**
  25766. * Stores the value of the alpha mode
  25767. */
  25768. private _alphaMode;
  25769. /**
  25770. * Sets the value of the alpha mode.
  25771. *
  25772. * | Value | Type | Description |
  25773. * | --- | --- | --- |
  25774. * | 0 | ALPHA_DISABLE | |
  25775. * | 1 | ALPHA_ADD | |
  25776. * | 2 | ALPHA_COMBINE | |
  25777. * | 3 | ALPHA_SUBTRACT | |
  25778. * | 4 | ALPHA_MULTIPLY | |
  25779. * | 5 | ALPHA_MAXIMIZED | |
  25780. * | 6 | ALPHA_ONEONE | |
  25781. * | 7 | ALPHA_PREMULTIPLIED | |
  25782. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  25783. * | 9 | ALPHA_INTERPOLATE | |
  25784. * | 10 | ALPHA_SCREENMODE | |
  25785. *
  25786. */
  25787. set alphaMode(value: number);
  25788. /**
  25789. * Gets the value of the alpha mode
  25790. */
  25791. get alphaMode(): number;
  25792. /**
  25793. * Stores the state of the need depth pre-pass value
  25794. */
  25795. private _needDepthPrePass;
  25796. /**
  25797. * Sets the need depth pre-pass value
  25798. */
  25799. set needDepthPrePass(value: boolean);
  25800. /**
  25801. * Gets the depth pre-pass value
  25802. */
  25803. get needDepthPrePass(): boolean;
  25804. /**
  25805. * Specifies if depth writing should be disabled
  25806. */
  25807. disableDepthWrite: boolean;
  25808. /**
  25809. * Specifies if color writing should be disabled
  25810. */
  25811. disableColorWrite: boolean;
  25812. /**
  25813. * Specifies if depth writing should be forced
  25814. */
  25815. forceDepthWrite: boolean;
  25816. /**
  25817. * Specifies the depth function that should be used. 0 means the default engine function
  25818. */
  25819. depthFunction: number;
  25820. /**
  25821. * Specifies if there should be a separate pass for culling
  25822. */
  25823. separateCullingPass: boolean;
  25824. /**
  25825. * Stores the state specifing if fog should be enabled
  25826. */
  25827. private _fogEnabled;
  25828. /**
  25829. * Sets the state for enabling fog
  25830. */
  25831. set fogEnabled(value: boolean);
  25832. /**
  25833. * Gets the value of the fog enabled state
  25834. */
  25835. get fogEnabled(): boolean;
  25836. /**
  25837. * Stores the size of points
  25838. */
  25839. pointSize: number;
  25840. /**
  25841. * Stores the z offset value
  25842. */
  25843. zOffset: number;
  25844. get wireframe(): boolean;
  25845. /**
  25846. * Sets the state of wireframe mode
  25847. */
  25848. set wireframe(value: boolean);
  25849. /**
  25850. * Gets the value specifying if point clouds are enabled
  25851. */
  25852. get pointsCloud(): boolean;
  25853. /**
  25854. * Sets the state of point cloud mode
  25855. */
  25856. set pointsCloud(value: boolean);
  25857. /**
  25858. * Gets the material fill mode
  25859. */
  25860. get fillMode(): number;
  25861. /**
  25862. * Sets the material fill mode
  25863. */
  25864. set fillMode(value: number);
  25865. /**
  25866. * @hidden
  25867. * Stores the effects for the material
  25868. */
  25869. _effect: Nullable<Effect>;
  25870. /**
  25871. * Specifies if uniform buffers should be used
  25872. */
  25873. private _useUBO;
  25874. /**
  25875. * Stores a reference to the scene
  25876. */
  25877. private _scene;
  25878. /**
  25879. * Stores the fill mode state
  25880. */
  25881. private _fillMode;
  25882. /**
  25883. * Specifies if the depth write state should be cached
  25884. */
  25885. private _cachedDepthWriteState;
  25886. /**
  25887. * Specifies if the color write state should be cached
  25888. */
  25889. private _cachedColorWriteState;
  25890. /**
  25891. * Specifies if the depth function state should be cached
  25892. */
  25893. private _cachedDepthFunctionState;
  25894. /**
  25895. * Stores the uniform buffer
  25896. */
  25897. protected _uniformBuffer: UniformBuffer;
  25898. /** @hidden */
  25899. _indexInSceneMaterialArray: number;
  25900. /** @hidden */
  25901. meshMap: Nullable<{
  25902. [id: string]: AbstractMesh | undefined;
  25903. }>;
  25904. /**
  25905. * Creates a material instance
  25906. * @param name defines the name of the material
  25907. * @param scene defines the scene to reference
  25908. * @param doNotAdd specifies if the material should be added to the scene
  25909. */
  25910. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  25911. /**
  25912. * Returns a string representation of the current material
  25913. * @param fullDetails defines a boolean indicating which levels of logging is desired
  25914. * @returns a string with material information
  25915. */
  25916. toString(fullDetails?: boolean): string;
  25917. /**
  25918. * Gets the class name of the material
  25919. * @returns a string with the class name of the material
  25920. */
  25921. getClassName(): string;
  25922. /**
  25923. * Specifies if updates for the material been locked
  25924. */
  25925. get isFrozen(): boolean;
  25926. /**
  25927. * Locks updates for the material
  25928. */
  25929. freeze(): void;
  25930. /**
  25931. * Unlocks updates for the material
  25932. */
  25933. unfreeze(): void;
  25934. /**
  25935. * Specifies if the material is ready to be used
  25936. * @param mesh defines the mesh to check
  25937. * @param useInstances specifies if instances should be used
  25938. * @returns a boolean indicating if the material is ready to be used
  25939. */
  25940. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  25941. /**
  25942. * Specifies that the submesh is ready to be used
  25943. * @param mesh defines the mesh to check
  25944. * @param subMesh defines which submesh to check
  25945. * @param useInstances specifies that instances should be used
  25946. * @returns a boolean indicating that the submesh is ready or not
  25947. */
  25948. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  25949. /**
  25950. * Returns the material effect
  25951. * @returns the effect associated with the material
  25952. */
  25953. getEffect(): Nullable<Effect>;
  25954. /**
  25955. * Returns the current scene
  25956. * @returns a Scene
  25957. */
  25958. getScene(): Scene;
  25959. /**
  25960. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  25961. */
  25962. protected _forceAlphaTest: boolean;
  25963. /**
  25964. * The transparency mode of the material.
  25965. */
  25966. protected _transparencyMode: Nullable<number>;
  25967. /**
  25968. * Gets the current transparency mode.
  25969. */
  25970. get transparencyMode(): Nullable<number>;
  25971. /**
  25972. * Sets the transparency mode of the material.
  25973. *
  25974. * | Value | Type | Description |
  25975. * | ----- | ----------------------------------- | ----------- |
  25976. * | 0 | OPAQUE | |
  25977. * | 1 | ALPHATEST | |
  25978. * | 2 | ALPHABLEND | |
  25979. * | 3 | ALPHATESTANDBLEND | |
  25980. *
  25981. */
  25982. set transparencyMode(value: Nullable<number>);
  25983. /**
  25984. * Returns true if alpha blending should be disabled.
  25985. */
  25986. protected get _disableAlphaBlending(): boolean;
  25987. /**
  25988. * Specifies whether or not this material should be rendered in alpha blend mode.
  25989. * @returns a boolean specifying if alpha blending is needed
  25990. */
  25991. needAlphaBlending(): boolean;
  25992. /**
  25993. * Specifies if the mesh will require alpha blending
  25994. * @param mesh defines the mesh to check
  25995. * @returns a boolean specifying if alpha blending is needed for the mesh
  25996. */
  25997. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  25998. /**
  25999. * Specifies whether or not this material should be rendered in alpha test mode.
  26000. * @returns a boolean specifying if an alpha test is needed.
  26001. */
  26002. needAlphaTesting(): boolean;
  26003. /**
  26004. * Specifies if material alpha testing should be turned on for the mesh
  26005. * @param mesh defines the mesh to check
  26006. */
  26007. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  26008. /**
  26009. * Gets the texture used for the alpha test
  26010. * @returns the texture to use for alpha testing
  26011. */
  26012. getAlphaTestTexture(): Nullable<BaseTexture>;
  26013. /**
  26014. * Marks the material to indicate that it needs to be re-calculated
  26015. */
  26016. markDirty(): void;
  26017. /** @hidden */
  26018. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  26019. /**
  26020. * Binds the material to the mesh
  26021. * @param world defines the world transformation matrix
  26022. * @param mesh defines the mesh to bind the material to
  26023. */
  26024. bind(world: Matrix, mesh?: Mesh): void;
  26025. /**
  26026. * Binds the submesh to the material
  26027. * @param world defines the world transformation matrix
  26028. * @param mesh defines the mesh containing the submesh
  26029. * @param subMesh defines the submesh to bind the material to
  26030. */
  26031. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  26032. /**
  26033. * Binds the world matrix to the material
  26034. * @param world defines the world transformation matrix
  26035. */
  26036. bindOnlyWorldMatrix(world: Matrix): void;
  26037. /**
  26038. * Binds the scene's uniform buffer to the effect.
  26039. * @param effect defines the effect to bind to the scene uniform buffer
  26040. * @param sceneUbo defines the uniform buffer storing scene data
  26041. */
  26042. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  26043. /**
  26044. * Binds the view matrix to the effect
  26045. * @param effect defines the effect to bind the view matrix to
  26046. */
  26047. bindView(effect: Effect): void;
  26048. /**
  26049. * Binds the view projection matrix to the effect
  26050. * @param effect defines the effect to bind the view projection matrix to
  26051. */
  26052. bindViewProjection(effect: Effect): void;
  26053. /**
  26054. * Processes to execute after binding the material to a mesh
  26055. * @param mesh defines the rendered mesh
  26056. */
  26057. protected _afterBind(mesh?: Mesh): void;
  26058. /**
  26059. * Unbinds the material from the mesh
  26060. */
  26061. unbind(): void;
  26062. /**
  26063. * Gets the active textures from the material
  26064. * @returns an array of textures
  26065. */
  26066. getActiveTextures(): BaseTexture[];
  26067. /**
  26068. * Specifies if the material uses a texture
  26069. * @param texture defines the texture to check against the material
  26070. * @returns a boolean specifying if the material uses the texture
  26071. */
  26072. hasTexture(texture: BaseTexture): boolean;
  26073. /**
  26074. * Makes a duplicate of the material, and gives it a new name
  26075. * @param name defines the new name for the duplicated material
  26076. * @returns the cloned material
  26077. */
  26078. clone(name: string): Nullable<Material>;
  26079. /**
  26080. * Gets the meshes bound to the material
  26081. * @returns an array of meshes bound to the material
  26082. */
  26083. getBindedMeshes(): AbstractMesh[];
  26084. /**
  26085. * Force shader compilation
  26086. * @param mesh defines the mesh associated with this material
  26087. * @param onCompiled defines a function to execute once the material is compiled
  26088. * @param options defines the options to configure the compilation
  26089. * @param onError defines a function to execute if the material fails compiling
  26090. */
  26091. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  26092. /**
  26093. * Force shader compilation
  26094. * @param mesh defines the mesh that will use this material
  26095. * @param options defines additional options for compiling the shaders
  26096. * @returns a promise that resolves when the compilation completes
  26097. */
  26098. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  26099. private static readonly _AllDirtyCallBack;
  26100. private static readonly _ImageProcessingDirtyCallBack;
  26101. private static readonly _TextureDirtyCallBack;
  26102. private static readonly _FresnelDirtyCallBack;
  26103. private static readonly _MiscDirtyCallBack;
  26104. private static readonly _LightsDirtyCallBack;
  26105. private static readonly _AttributeDirtyCallBack;
  26106. private static _FresnelAndMiscDirtyCallBack;
  26107. private static _TextureAndMiscDirtyCallBack;
  26108. private static readonly _DirtyCallbackArray;
  26109. private static readonly _RunDirtyCallBacks;
  26110. /**
  26111. * Marks a define in the material to indicate that it needs to be re-computed
  26112. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  26113. */
  26114. markAsDirty(flag: number): void;
  26115. /**
  26116. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  26117. * @param func defines a function which checks material defines against the submeshes
  26118. */
  26119. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  26120. /**
  26121. * Indicates that the scene should check if the rendering now needs a prepass
  26122. */
  26123. protected _markScenePrePassDirty(): void;
  26124. /**
  26125. * Indicates that we need to re-calculated for all submeshes
  26126. */
  26127. protected _markAllSubMeshesAsAllDirty(): void;
  26128. /**
  26129. * Indicates that image processing needs to be re-calculated for all submeshes
  26130. */
  26131. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  26132. /**
  26133. * Indicates that textures need to be re-calculated for all submeshes
  26134. */
  26135. protected _markAllSubMeshesAsTexturesDirty(): void;
  26136. /**
  26137. * Indicates that fresnel needs to be re-calculated for all submeshes
  26138. */
  26139. protected _markAllSubMeshesAsFresnelDirty(): void;
  26140. /**
  26141. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  26142. */
  26143. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  26144. /**
  26145. * Indicates that lights need to be re-calculated for all submeshes
  26146. */
  26147. protected _markAllSubMeshesAsLightsDirty(): void;
  26148. /**
  26149. * Indicates that attributes need to be re-calculated for all submeshes
  26150. */
  26151. protected _markAllSubMeshesAsAttributesDirty(): void;
  26152. /**
  26153. * Indicates that misc needs to be re-calculated for all submeshes
  26154. */
  26155. protected _markAllSubMeshesAsMiscDirty(): void;
  26156. /**
  26157. * Indicates that textures and misc need to be re-calculated for all submeshes
  26158. */
  26159. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  26160. /**
  26161. * Sets the required values to the prepass renderer.
  26162. * @param prePassRenderer defines the prepass renderer to setup.
  26163. * @returns true if the pre pass is needed.
  26164. */
  26165. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  26166. /**
  26167. * Disposes the material
  26168. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  26169. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  26170. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  26171. */
  26172. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  26173. /** @hidden */
  26174. private releaseVertexArrayObject;
  26175. /**
  26176. * Serializes this material
  26177. * @returns the serialized material object
  26178. */
  26179. serialize(): any;
  26180. /**
  26181. * Creates a material from parsed material data
  26182. * @param parsedMaterial defines parsed material data
  26183. * @param scene defines the hosting scene
  26184. * @param rootUrl defines the root URL to use to load textures
  26185. * @returns a new material
  26186. */
  26187. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  26188. }
  26189. }
  26190. declare module "babylonjs/Materials/multiMaterial" {
  26191. import { Nullable } from "babylonjs/types";
  26192. import { Scene } from "babylonjs/scene";
  26193. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26194. import { SubMesh } from "babylonjs/Meshes/subMesh";
  26195. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  26196. import { Material } from "babylonjs/Materials/material";
  26197. /**
  26198. * A multi-material is used to apply different materials to different parts of the same object without the need of
  26199. * separate meshes. This can be use to improve performances.
  26200. * @see https://doc.babylonjs.com/how_to/multi_materials
  26201. */
  26202. export class MultiMaterial extends Material {
  26203. private _subMaterials;
  26204. /**
  26205. * Gets or Sets the list of Materials used within the multi material.
  26206. * They need to be ordered according to the submeshes order in the associated mesh
  26207. */
  26208. get subMaterials(): Nullable<Material>[];
  26209. set subMaterials(value: Nullable<Material>[]);
  26210. /**
  26211. * Function used to align with Node.getChildren()
  26212. * @returns the list of Materials used within the multi material
  26213. */
  26214. getChildren(): Nullable<Material>[];
  26215. /**
  26216. * Instantiates a new Multi Material
  26217. * A multi-material is used to apply different materials to different parts of the same object without the need of
  26218. * separate meshes. This can be use to improve performances.
  26219. * @see https://doc.babylonjs.com/how_to/multi_materials
  26220. * @param name Define the name in the scene
  26221. * @param scene Define the scene the material belongs to
  26222. */
  26223. constructor(name: string, scene: Scene);
  26224. private _hookArray;
  26225. /**
  26226. * Get one of the submaterial by its index in the submaterials array
  26227. * @param index The index to look the sub material at
  26228. * @returns The Material if the index has been defined
  26229. */
  26230. getSubMaterial(index: number): Nullable<Material>;
  26231. /**
  26232. * Get the list of active textures for the whole sub materials list.
  26233. * @returns All the textures that will be used during the rendering
  26234. */
  26235. getActiveTextures(): BaseTexture[];
  26236. /**
  26237. * Gets the current class name of the material e.g. "MultiMaterial"
  26238. * Mainly use in serialization.
  26239. * @returns the class name
  26240. */
  26241. getClassName(): string;
  26242. /**
  26243. * Checks if the material is ready to render the requested sub mesh
  26244. * @param mesh Define the mesh the submesh belongs to
  26245. * @param subMesh Define the sub mesh to look readyness for
  26246. * @param useInstances Define whether or not the material is used with instances
  26247. * @returns true if ready, otherwise false
  26248. */
  26249. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  26250. /**
  26251. * Clones the current material and its related sub materials
  26252. * @param name Define the name of the newly cloned material
  26253. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  26254. * @returns the cloned material
  26255. */
  26256. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  26257. /**
  26258. * Serializes the materials into a JSON representation.
  26259. * @returns the JSON representation
  26260. */
  26261. serialize(): any;
  26262. /**
  26263. * Dispose the material and release its associated resources
  26264. * @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)
  26265. * @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)
  26266. * @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)
  26267. */
  26268. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  26269. /**
  26270. * Creates a MultiMaterial from parsed MultiMaterial data.
  26271. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  26272. * @param scene defines the hosting scene
  26273. * @returns a new MultiMaterial
  26274. */
  26275. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  26276. }
  26277. }
  26278. declare module "babylonjs/Meshes/subMesh" {
  26279. import { Nullable, IndicesArray, DeepImmutable, FloatArray } from "babylonjs/types";
  26280. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  26281. import { Engine } from "babylonjs/Engines/engine";
  26282. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  26283. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26284. import { Effect } from "babylonjs/Materials/effect";
  26285. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  26286. import { Plane } from "babylonjs/Maths/math.plane";
  26287. import { Collider } from "babylonjs/Collisions/collider";
  26288. import { Material } from "babylonjs/Materials/material";
  26289. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  26290. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26291. import { Mesh } from "babylonjs/Meshes/mesh";
  26292. import { Ray } from "babylonjs/Culling/ray";
  26293. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  26294. /**
  26295. * Defines a subdivision inside a mesh
  26296. */
  26297. export class SubMesh implements ICullable {
  26298. /** the material index to use */
  26299. materialIndex: number;
  26300. /** vertex index start */
  26301. verticesStart: number;
  26302. /** vertices count */
  26303. verticesCount: number;
  26304. /** index start */
  26305. indexStart: number;
  26306. /** indices count */
  26307. indexCount: number;
  26308. /** @hidden */
  26309. _materialDefines: Nullable<MaterialDefines>;
  26310. /** @hidden */
  26311. _materialEffect: Nullable<Effect>;
  26312. /** @hidden */
  26313. _effectOverride: Nullable<Effect>;
  26314. /**
  26315. * Gets material defines used by the effect associated to the sub mesh
  26316. */
  26317. get materialDefines(): Nullable<MaterialDefines>;
  26318. /**
  26319. * Sets material defines used by the effect associated to the sub mesh
  26320. */
  26321. set materialDefines(defines: Nullable<MaterialDefines>);
  26322. /**
  26323. * Gets associated effect
  26324. */
  26325. get effect(): Nullable<Effect>;
  26326. /**
  26327. * Sets associated effect (effect used to render this submesh)
  26328. * @param effect defines the effect to associate with
  26329. * @param defines defines the set of defines used to compile this effect
  26330. */
  26331. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  26332. /** @hidden */
  26333. _linesIndexCount: number;
  26334. private _mesh;
  26335. private _renderingMesh;
  26336. private _boundingInfo;
  26337. private _linesIndexBuffer;
  26338. /** @hidden */
  26339. _lastColliderWorldVertices: Nullable<Vector3[]>;
  26340. /** @hidden */
  26341. _trianglePlanes: Plane[];
  26342. /** @hidden */
  26343. _lastColliderTransformMatrix: Nullable<Matrix>;
  26344. /** @hidden */
  26345. _renderId: number;
  26346. /** @hidden */
  26347. _alphaIndex: number;
  26348. /** @hidden */
  26349. _distanceToCamera: number;
  26350. /** @hidden */
  26351. _id: number;
  26352. private _currentMaterial;
  26353. /**
  26354. * Add a new submesh to a mesh
  26355. * @param materialIndex defines the material index to use
  26356. * @param verticesStart defines vertex index start
  26357. * @param verticesCount defines vertices count
  26358. * @param indexStart defines index start
  26359. * @param indexCount defines indices count
  26360. * @param mesh defines the parent mesh
  26361. * @param renderingMesh defines an optional rendering mesh
  26362. * @param createBoundingBox defines if bounding box should be created for this submesh
  26363. * @returns the new submesh
  26364. */
  26365. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  26366. /**
  26367. * Creates a new submesh
  26368. * @param materialIndex defines the material index to use
  26369. * @param verticesStart defines vertex index start
  26370. * @param verticesCount defines vertices count
  26371. * @param indexStart defines index start
  26372. * @param indexCount defines indices count
  26373. * @param mesh defines the parent mesh
  26374. * @param renderingMesh defines an optional rendering mesh
  26375. * @param createBoundingBox defines if bounding box should be created for this submesh
  26376. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  26377. */
  26378. constructor(
  26379. /** the material index to use */
  26380. materialIndex: number,
  26381. /** vertex index start */
  26382. verticesStart: number,
  26383. /** vertices count */
  26384. verticesCount: number,
  26385. /** index start */
  26386. indexStart: number,
  26387. /** indices count */
  26388. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  26389. /**
  26390. * Returns true if this submesh covers the entire parent mesh
  26391. * @ignorenaming
  26392. */
  26393. get IsGlobal(): boolean;
  26394. /**
  26395. * Returns the submesh BoudingInfo object
  26396. * @returns current bounding info (or mesh's one if the submesh is global)
  26397. */
  26398. getBoundingInfo(): BoundingInfo;
  26399. /**
  26400. * Sets the submesh BoundingInfo
  26401. * @param boundingInfo defines the new bounding info to use
  26402. * @returns the SubMesh
  26403. */
  26404. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  26405. /**
  26406. * Returns the mesh of the current submesh
  26407. * @return the parent mesh
  26408. */
  26409. getMesh(): AbstractMesh;
  26410. /**
  26411. * Returns the rendering mesh of the submesh
  26412. * @returns the rendering mesh (could be different from parent mesh)
  26413. */
  26414. getRenderingMesh(): Mesh;
  26415. /**
  26416. * Returns the replacement mesh of the submesh
  26417. * @returns the replacement mesh (could be different from parent mesh)
  26418. */
  26419. getReplacementMesh(): Nullable<AbstractMesh>;
  26420. /**
  26421. * Returns the effective mesh of the submesh
  26422. * @returns the effective mesh (could be different from parent mesh)
  26423. */
  26424. getEffectiveMesh(): AbstractMesh;
  26425. /**
  26426. * Returns the submesh material
  26427. * @returns null or the current material
  26428. */
  26429. getMaterial(): Nullable<Material>;
  26430. private _IsMultiMaterial;
  26431. /**
  26432. * Sets a new updated BoundingInfo object to the submesh
  26433. * @param data defines an optional position array to use to determine the bounding info
  26434. * @returns the SubMesh
  26435. */
  26436. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  26437. /** @hidden */
  26438. _checkCollision(collider: Collider): boolean;
  26439. /**
  26440. * Updates the submesh BoundingInfo
  26441. * @param world defines the world matrix to use to update the bounding info
  26442. * @returns the submesh
  26443. */
  26444. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  26445. /**
  26446. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  26447. * @param frustumPlanes defines the frustum planes
  26448. * @returns true if the submesh is intersecting with the frustum
  26449. */
  26450. isInFrustum(frustumPlanes: Plane[]): boolean;
  26451. /**
  26452. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  26453. * @param frustumPlanes defines the frustum planes
  26454. * @returns true if the submesh is inside the frustum
  26455. */
  26456. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  26457. /**
  26458. * Renders the submesh
  26459. * @param enableAlphaMode defines if alpha needs to be used
  26460. * @returns the submesh
  26461. */
  26462. render(enableAlphaMode: boolean): SubMesh;
  26463. /**
  26464. * @hidden
  26465. */
  26466. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  26467. /**
  26468. * Checks if the submesh intersects with a ray
  26469. * @param ray defines the ray to test
  26470. * @returns true is the passed ray intersects the submesh bounding box
  26471. */
  26472. canIntersects(ray: Ray): boolean;
  26473. /**
  26474. * Intersects current submesh with a ray
  26475. * @param ray defines the ray to test
  26476. * @param positions defines mesh's positions array
  26477. * @param indices defines mesh's indices array
  26478. * @param fastCheck defines if the first intersection will be used (and not the closest)
  26479. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  26480. * @returns intersection info or null if no intersection
  26481. */
  26482. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  26483. /** @hidden */
  26484. private _intersectLines;
  26485. /** @hidden */
  26486. private _intersectUnIndexedLines;
  26487. /** @hidden */
  26488. private _intersectTriangles;
  26489. /** @hidden */
  26490. private _intersectUnIndexedTriangles;
  26491. /** @hidden */
  26492. _rebuild(): void;
  26493. /**
  26494. * Creates a new submesh from the passed mesh
  26495. * @param newMesh defines the new hosting mesh
  26496. * @param newRenderingMesh defines an optional rendering mesh
  26497. * @returns the new submesh
  26498. */
  26499. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  26500. /**
  26501. * Release associated resources
  26502. */
  26503. dispose(): void;
  26504. /**
  26505. * Gets the class name
  26506. * @returns the string "SubMesh".
  26507. */
  26508. getClassName(): string;
  26509. /**
  26510. * Creates a new submesh from indices data
  26511. * @param materialIndex the index of the main mesh material
  26512. * @param startIndex the index where to start the copy in the mesh indices array
  26513. * @param indexCount the number of indices to copy then from the startIndex
  26514. * @param mesh the main mesh to create the submesh from
  26515. * @param renderingMesh the optional rendering mesh
  26516. * @returns a new submesh
  26517. */
  26518. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  26519. }
  26520. }
  26521. declare module "babylonjs/Loading/sceneLoaderFlags" {
  26522. /**
  26523. * Class used to represent data loading progression
  26524. */
  26525. export class SceneLoaderFlags {
  26526. private static _ForceFullSceneLoadingForIncremental;
  26527. private static _ShowLoadingScreen;
  26528. private static _CleanBoneMatrixWeights;
  26529. private static _loggingLevel;
  26530. /**
  26531. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  26532. */
  26533. static get ForceFullSceneLoadingForIncremental(): boolean;
  26534. static set ForceFullSceneLoadingForIncremental(value: boolean);
  26535. /**
  26536. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  26537. */
  26538. static get ShowLoadingScreen(): boolean;
  26539. static set ShowLoadingScreen(value: boolean);
  26540. /**
  26541. * Defines the current logging level (while loading the scene)
  26542. * @ignorenaming
  26543. */
  26544. static get loggingLevel(): number;
  26545. static set loggingLevel(value: number);
  26546. /**
  26547. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  26548. */
  26549. static get CleanBoneMatrixWeights(): boolean;
  26550. static set CleanBoneMatrixWeights(value: boolean);
  26551. }
  26552. }
  26553. declare module "babylonjs/Meshes/geometry" {
  26554. import { Nullable, FloatArray, DataArray, IndicesArray } from "babylonjs/types";
  26555. import { Scene } from "babylonjs/scene";
  26556. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  26557. import { Engine } from "babylonjs/Engines/engine";
  26558. import { IGetSetVerticesData, VertexData } from "babylonjs/Meshes/mesh.vertexData";
  26559. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  26560. import { Effect } from "babylonjs/Materials/effect";
  26561. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26562. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  26563. import { Mesh } from "babylonjs/Meshes/mesh";
  26564. /**
  26565. * Class used to store geometry data (vertex buffers + index buffer)
  26566. */
  26567. export class Geometry implements IGetSetVerticesData {
  26568. /**
  26569. * Gets or sets the ID of the geometry
  26570. */
  26571. id: string;
  26572. /**
  26573. * Gets or sets the unique ID of the geometry
  26574. */
  26575. uniqueId: number;
  26576. /**
  26577. * Gets the delay loading state of the geometry (none by default which means not delayed)
  26578. */
  26579. delayLoadState: number;
  26580. /**
  26581. * Gets the file containing the data to load when running in delay load state
  26582. */
  26583. delayLoadingFile: Nullable<string>;
  26584. /**
  26585. * Callback called when the geometry is updated
  26586. */
  26587. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  26588. private _scene;
  26589. private _engine;
  26590. private _meshes;
  26591. private _totalVertices;
  26592. /** @hidden */
  26593. _indices: IndicesArray;
  26594. /** @hidden */
  26595. _vertexBuffers: {
  26596. [key: string]: VertexBuffer;
  26597. };
  26598. private _isDisposed;
  26599. private _extend;
  26600. private _boundingBias;
  26601. /** @hidden */
  26602. _delayInfo: Array<string>;
  26603. private _indexBuffer;
  26604. private _indexBufferIsUpdatable;
  26605. /** @hidden */
  26606. _boundingInfo: Nullable<BoundingInfo>;
  26607. /** @hidden */
  26608. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  26609. /** @hidden */
  26610. _softwareSkinningFrameId: number;
  26611. private _vertexArrayObjects;
  26612. private _updatable;
  26613. /** @hidden */
  26614. _positions: Nullable<Vector3[]>;
  26615. /**
  26616. * 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
  26617. */
  26618. get boundingBias(): Vector2;
  26619. /**
  26620. * 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
  26621. */
  26622. set boundingBias(value: Vector2);
  26623. /**
  26624. * Static function used to attach a new empty geometry to a mesh
  26625. * @param mesh defines the mesh to attach the geometry to
  26626. * @returns the new Geometry
  26627. */
  26628. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  26629. /** Get the list of meshes using this geometry */
  26630. get meshes(): Mesh[];
  26631. /**
  26632. * 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
  26633. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  26634. */
  26635. useBoundingInfoFromGeometry: boolean;
  26636. /**
  26637. * Creates a new geometry
  26638. * @param id defines the unique ID
  26639. * @param scene defines the hosting scene
  26640. * @param vertexData defines the VertexData used to get geometry data
  26641. * @param updatable defines if geometry must be updatable (false by default)
  26642. * @param mesh defines the mesh that will be associated with the geometry
  26643. */
  26644. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  26645. /**
  26646. * Gets the current extend of the geometry
  26647. */
  26648. get extend(): {
  26649. minimum: Vector3;
  26650. maximum: Vector3;
  26651. };
  26652. /**
  26653. * Gets the hosting scene
  26654. * @returns the hosting Scene
  26655. */
  26656. getScene(): Scene;
  26657. /**
  26658. * Gets the hosting engine
  26659. * @returns the hosting Engine
  26660. */
  26661. getEngine(): Engine;
  26662. /**
  26663. * Defines if the geometry is ready to use
  26664. * @returns true if the geometry is ready to be used
  26665. */
  26666. isReady(): boolean;
  26667. /**
  26668. * Gets a value indicating that the geometry should not be serialized
  26669. */
  26670. get doNotSerialize(): boolean;
  26671. /** @hidden */
  26672. _rebuild(): void;
  26673. /**
  26674. * Affects all geometry data in one call
  26675. * @param vertexData defines the geometry data
  26676. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  26677. */
  26678. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  26679. /**
  26680. * Set specific vertex data
  26681. * @param kind defines the data kind (Position, normal, etc...)
  26682. * @param data defines the vertex data to use
  26683. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  26684. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  26685. */
  26686. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  26687. /**
  26688. * Removes a specific vertex data
  26689. * @param kind defines the data kind (Position, normal, etc...)
  26690. */
  26691. removeVerticesData(kind: string): void;
  26692. /**
  26693. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  26694. * @param buffer defines the vertex buffer to use
  26695. * @param totalVertices defines the total number of vertices for position kind (could be null)
  26696. */
  26697. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  26698. /**
  26699. * Update a specific vertex buffer
  26700. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  26701. * It will do nothing if the buffer is not updatable
  26702. * @param kind defines the data kind (Position, normal, etc...)
  26703. * @param data defines the data to use
  26704. * @param offset defines the offset in the target buffer where to store the data
  26705. * @param useBytes set to true if the offset is in bytes
  26706. */
  26707. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  26708. /**
  26709. * Update a specific vertex buffer
  26710. * This function will create a new buffer if the current one is not updatable
  26711. * @param kind defines the data kind (Position, normal, etc...)
  26712. * @param data defines the data to use
  26713. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  26714. */
  26715. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  26716. private _updateBoundingInfo;
  26717. /** @hidden */
  26718. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  26719. /**
  26720. * Gets total number of vertices
  26721. * @returns the total number of vertices
  26722. */
  26723. getTotalVertices(): number;
  26724. /**
  26725. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  26726. * @param kind defines the data kind (Position, normal, etc...)
  26727. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26728. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26729. * @returns a float array containing vertex data
  26730. */
  26731. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  26732. /**
  26733. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  26734. * @param kind defines the data kind (Position, normal, etc...)
  26735. * @returns true if the vertex buffer with the specified kind is updatable
  26736. */
  26737. isVertexBufferUpdatable(kind: string): boolean;
  26738. /**
  26739. * Gets a specific vertex buffer
  26740. * @param kind defines the data kind (Position, normal, etc...)
  26741. * @returns a VertexBuffer
  26742. */
  26743. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  26744. /**
  26745. * Returns all vertex buffers
  26746. * @return an object holding all vertex buffers indexed by kind
  26747. */
  26748. getVertexBuffers(): Nullable<{
  26749. [key: string]: VertexBuffer;
  26750. }>;
  26751. /**
  26752. * Gets a boolean indicating if specific vertex buffer is present
  26753. * @param kind defines the data kind (Position, normal, etc...)
  26754. * @returns true if data is present
  26755. */
  26756. isVerticesDataPresent(kind: string): boolean;
  26757. /**
  26758. * Gets a list of all attached data kinds (Position, normal, etc...)
  26759. * @returns a list of string containing all kinds
  26760. */
  26761. getVerticesDataKinds(): string[];
  26762. /**
  26763. * Update index buffer
  26764. * @param indices defines the indices to store in the index buffer
  26765. * @param offset defines the offset in the target buffer where to store the data
  26766. * @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)
  26767. */
  26768. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  26769. /**
  26770. * Creates a new index buffer
  26771. * @param indices defines the indices to store in the index buffer
  26772. * @param totalVertices defines the total number of vertices (could be null)
  26773. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  26774. */
  26775. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  26776. /**
  26777. * Return the total number of indices
  26778. * @returns the total number of indices
  26779. */
  26780. getTotalIndices(): number;
  26781. /**
  26782. * Gets the index buffer array
  26783. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26784. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26785. * @returns the index buffer array
  26786. */
  26787. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  26788. /**
  26789. * Gets the index buffer
  26790. * @return the index buffer
  26791. */
  26792. getIndexBuffer(): Nullable<DataBuffer>;
  26793. /** @hidden */
  26794. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  26795. /**
  26796. * Release the associated resources for a specific mesh
  26797. * @param mesh defines the source mesh
  26798. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  26799. */
  26800. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  26801. /**
  26802. * Apply current geometry to a given mesh
  26803. * @param mesh defines the mesh to apply geometry to
  26804. */
  26805. applyToMesh(mesh: Mesh): void;
  26806. private _updateExtend;
  26807. private _applyToMesh;
  26808. private notifyUpdate;
  26809. /**
  26810. * Load the geometry if it was flagged as delay loaded
  26811. * @param scene defines the hosting scene
  26812. * @param onLoaded defines a callback called when the geometry is loaded
  26813. */
  26814. load(scene: Scene, onLoaded?: () => void): void;
  26815. private _queueLoad;
  26816. /**
  26817. * Invert the geometry to move from a right handed system to a left handed one.
  26818. */
  26819. toLeftHanded(): void;
  26820. /** @hidden */
  26821. _resetPointsArrayCache(): void;
  26822. /** @hidden */
  26823. _generatePointsArray(): boolean;
  26824. /**
  26825. * Gets a value indicating if the geometry is disposed
  26826. * @returns true if the geometry was disposed
  26827. */
  26828. isDisposed(): boolean;
  26829. private _disposeVertexArrayObjects;
  26830. /**
  26831. * Free all associated resources
  26832. */
  26833. dispose(): void;
  26834. /**
  26835. * Clone the current geometry into a new geometry
  26836. * @param id defines the unique ID of the new geometry
  26837. * @returns a new geometry object
  26838. */
  26839. copy(id: string): Geometry;
  26840. /**
  26841. * Serialize the current geometry info (and not the vertices data) into a JSON object
  26842. * @return a JSON representation of the current geometry data (without the vertices data)
  26843. */
  26844. serialize(): any;
  26845. private toNumberArray;
  26846. /**
  26847. * Serialize all vertices data into a JSON oject
  26848. * @returns a JSON representation of the current geometry data
  26849. */
  26850. serializeVerticeData(): any;
  26851. /**
  26852. * Extracts a clone of a mesh geometry
  26853. * @param mesh defines the source mesh
  26854. * @param id defines the unique ID of the new geometry object
  26855. * @returns the new geometry object
  26856. */
  26857. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  26858. /**
  26859. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  26860. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  26861. * Be aware Math.random() could cause collisions, but:
  26862. * "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"
  26863. * @returns a string containing a new GUID
  26864. */
  26865. static RandomId(): string;
  26866. /** @hidden */
  26867. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  26868. private static _CleanMatricesWeights;
  26869. /**
  26870. * Create a new geometry from persisted data (Using .babylon file format)
  26871. * @param parsedVertexData defines the persisted data
  26872. * @param scene defines the hosting scene
  26873. * @param rootUrl defines the root url to use to load assets (like delayed data)
  26874. * @returns the new geometry object
  26875. */
  26876. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  26877. }
  26878. }
  26879. declare module "babylonjs/Meshes/mesh.vertexData" {
  26880. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  26881. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  26882. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  26883. import { Geometry } from "babylonjs/Meshes/geometry";
  26884. import { Mesh } from "babylonjs/Meshes/mesh";
  26885. import { ICreateCapsuleOptions } from "babylonjs/Meshes/Builders/capsuleBuilder";
  26886. /**
  26887. * Define an interface for all classes that will get and set the data on vertices
  26888. */
  26889. export interface IGetSetVerticesData {
  26890. /**
  26891. * Gets a boolean indicating if specific vertex data is present
  26892. * @param kind defines the vertex data kind to use
  26893. * @returns true is data kind is present
  26894. */
  26895. isVerticesDataPresent(kind: string): boolean;
  26896. /**
  26897. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  26898. * @param kind defines the data kind (Position, normal, etc...)
  26899. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26900. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26901. * @returns a float array containing vertex data
  26902. */
  26903. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  26904. /**
  26905. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  26906. * @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.
  26907. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26908. * @returns the indices array or an empty array if the mesh has no geometry
  26909. */
  26910. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  26911. /**
  26912. * Set specific vertex data
  26913. * @param kind defines the data kind (Position, normal, etc...)
  26914. * @param data defines the vertex data to use
  26915. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  26916. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  26917. */
  26918. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  26919. /**
  26920. * Update a specific associated vertex buffer
  26921. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  26922. * - VertexBuffer.PositionKind
  26923. * - VertexBuffer.UVKind
  26924. * - VertexBuffer.UV2Kind
  26925. * - VertexBuffer.UV3Kind
  26926. * - VertexBuffer.UV4Kind
  26927. * - VertexBuffer.UV5Kind
  26928. * - VertexBuffer.UV6Kind
  26929. * - VertexBuffer.ColorKind
  26930. * - VertexBuffer.MatricesIndicesKind
  26931. * - VertexBuffer.MatricesIndicesExtraKind
  26932. * - VertexBuffer.MatricesWeightsKind
  26933. * - VertexBuffer.MatricesWeightsExtraKind
  26934. * @param data defines the data source
  26935. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  26936. * @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)
  26937. */
  26938. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  26939. /**
  26940. * Creates a new index buffer
  26941. * @param indices defines the indices to store in the index buffer
  26942. * @param totalVertices defines the total number of vertices (could be null)
  26943. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  26944. */
  26945. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  26946. }
  26947. /**
  26948. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  26949. */
  26950. export class VertexData {
  26951. /**
  26952. * Mesh side orientation : usually the external or front surface
  26953. */
  26954. static readonly FRONTSIDE: number;
  26955. /**
  26956. * Mesh side orientation : usually the internal or back surface
  26957. */
  26958. static readonly BACKSIDE: number;
  26959. /**
  26960. * Mesh side orientation : both internal and external or front and back surfaces
  26961. */
  26962. static readonly DOUBLESIDE: number;
  26963. /**
  26964. * Mesh side orientation : by default, `FRONTSIDE`
  26965. */
  26966. static readonly DEFAULTSIDE: number;
  26967. /**
  26968. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  26969. */
  26970. positions: Nullable<FloatArray>;
  26971. /**
  26972. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  26973. */
  26974. normals: Nullable<FloatArray>;
  26975. /**
  26976. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  26977. */
  26978. tangents: Nullable<FloatArray>;
  26979. /**
  26980. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26981. */
  26982. uvs: Nullable<FloatArray>;
  26983. /**
  26984. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26985. */
  26986. uvs2: Nullable<FloatArray>;
  26987. /**
  26988. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26989. */
  26990. uvs3: Nullable<FloatArray>;
  26991. /**
  26992. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26993. */
  26994. uvs4: Nullable<FloatArray>;
  26995. /**
  26996. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26997. */
  26998. uvs5: Nullable<FloatArray>;
  26999. /**
  27000. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  27001. */
  27002. uvs6: Nullable<FloatArray>;
  27003. /**
  27004. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  27005. */
  27006. colors: Nullable<FloatArray>;
  27007. /**
  27008. * 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).
  27009. */
  27010. matricesIndices: Nullable<FloatArray>;
  27011. /**
  27012. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  27013. */
  27014. matricesWeights: Nullable<FloatArray>;
  27015. /**
  27016. * An array extending the number of possible indices
  27017. */
  27018. matricesIndicesExtra: Nullable<FloatArray>;
  27019. /**
  27020. * An array extending the number of possible weights when the number of indices is extended
  27021. */
  27022. matricesWeightsExtra: Nullable<FloatArray>;
  27023. /**
  27024. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  27025. */
  27026. indices: Nullable<IndicesArray>;
  27027. /**
  27028. * Uses the passed data array to set the set the values for the specified kind of data
  27029. * @param data a linear array of floating numbers
  27030. * @param kind the type of data that is being set, eg positions, colors etc
  27031. */
  27032. set(data: FloatArray, kind: string): void;
  27033. /**
  27034. * Associates the vertexData to the passed Mesh.
  27035. * Sets it as updatable or not (default `false`)
  27036. * @param mesh the mesh the vertexData is applied to
  27037. * @param updatable when used and having the value true allows new data to update the vertexData
  27038. * @returns the VertexData
  27039. */
  27040. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  27041. /**
  27042. * Associates the vertexData to the passed Geometry.
  27043. * Sets it as updatable or not (default `false`)
  27044. * @param geometry the geometry the vertexData is applied to
  27045. * @param updatable when used and having the value true allows new data to update the vertexData
  27046. * @returns VertexData
  27047. */
  27048. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  27049. /**
  27050. * Updates the associated mesh
  27051. * @param mesh the mesh to be updated
  27052. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  27053. * @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
  27054. * @returns VertexData
  27055. */
  27056. updateMesh(mesh: Mesh): VertexData;
  27057. /**
  27058. * Updates the associated geometry
  27059. * @param geometry the geometry to be updated
  27060. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  27061. * @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
  27062. * @returns VertexData.
  27063. */
  27064. updateGeometry(geometry: Geometry): VertexData;
  27065. private _applyTo;
  27066. private _update;
  27067. /**
  27068. * Transforms each position and each normal of the vertexData according to the passed Matrix
  27069. * @param matrix the transforming matrix
  27070. * @returns the VertexData
  27071. */
  27072. transform(matrix: Matrix): VertexData;
  27073. /**
  27074. * Merges the passed VertexData into the current one
  27075. * @param other the VertexData to be merged into the current one
  27076. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  27077. * @returns the modified VertexData
  27078. */
  27079. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  27080. private _mergeElement;
  27081. private _validate;
  27082. /**
  27083. * Serializes the VertexData
  27084. * @returns a serialized object
  27085. */
  27086. serialize(): any;
  27087. /**
  27088. * Extracts the vertexData from a mesh
  27089. * @param mesh the mesh from which to extract the VertexData
  27090. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  27091. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  27092. * @returns the object VertexData associated to the passed mesh
  27093. */
  27094. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  27095. /**
  27096. * Extracts the vertexData from the geometry
  27097. * @param geometry the geometry from which to extract the VertexData
  27098. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  27099. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  27100. * @returns the object VertexData associated to the passed mesh
  27101. */
  27102. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  27103. private static _ExtractFrom;
  27104. /**
  27105. * Creates the VertexData for a Ribbon
  27106. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  27107. * * pathArray array of paths, each of which an array of successive Vector3
  27108. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  27109. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  27110. * * 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
  27111. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27112. * * 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)
  27113. * * 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)
  27114. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  27115. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  27116. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  27117. * @returns the VertexData of the ribbon
  27118. */
  27119. static CreateRibbon(options: {
  27120. pathArray: Vector3[][];
  27121. closeArray?: boolean;
  27122. closePath?: boolean;
  27123. offset?: number;
  27124. sideOrientation?: number;
  27125. frontUVs?: Vector4;
  27126. backUVs?: Vector4;
  27127. invertUV?: boolean;
  27128. uvs?: Vector2[];
  27129. colors?: Color4[];
  27130. }): VertexData;
  27131. /**
  27132. * Creates the VertexData for a box
  27133. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27134. * * size sets the width, height and depth of the box to the value of size, optional default 1
  27135. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  27136. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  27137. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  27138. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  27139. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  27140. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27141. * * 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)
  27142. * * 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)
  27143. * @returns the VertexData of the box
  27144. */
  27145. static CreateBox(options: {
  27146. size?: number;
  27147. width?: number;
  27148. height?: number;
  27149. depth?: number;
  27150. faceUV?: Vector4[];
  27151. faceColors?: Color4[];
  27152. sideOrientation?: number;
  27153. frontUVs?: Vector4;
  27154. backUVs?: Vector4;
  27155. }): VertexData;
  27156. /**
  27157. * Creates the VertexData for a tiled box
  27158. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27159. * * faceTiles sets the pattern, tile size and number of tiles for a face
  27160. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  27161. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  27162. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27163. * @returns the VertexData of the box
  27164. */
  27165. static CreateTiledBox(options: {
  27166. pattern?: number;
  27167. width?: number;
  27168. height?: number;
  27169. depth?: number;
  27170. tileSize?: number;
  27171. tileWidth?: number;
  27172. tileHeight?: number;
  27173. alignHorizontal?: number;
  27174. alignVertical?: number;
  27175. faceUV?: Vector4[];
  27176. faceColors?: Color4[];
  27177. sideOrientation?: number;
  27178. }): VertexData;
  27179. /**
  27180. * Creates the VertexData for a tiled plane
  27181. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27182. * * pattern a limited pattern arrangement depending on the number
  27183. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  27184. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  27185. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  27186. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27187. * * 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)
  27188. * * 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)
  27189. * @returns the VertexData of the tiled plane
  27190. */
  27191. static CreateTiledPlane(options: {
  27192. pattern?: number;
  27193. tileSize?: number;
  27194. tileWidth?: number;
  27195. tileHeight?: number;
  27196. size?: number;
  27197. width?: number;
  27198. height?: number;
  27199. alignHorizontal?: number;
  27200. alignVertical?: number;
  27201. sideOrientation?: number;
  27202. frontUVs?: Vector4;
  27203. backUVs?: Vector4;
  27204. }): VertexData;
  27205. /**
  27206. * Creates the VertexData for an ellipsoid, defaults to a sphere
  27207. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27208. * * segments sets the number of horizontal strips optional, default 32
  27209. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  27210. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  27211. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  27212. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  27213. * * 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
  27214. * * 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
  27215. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27216. * * 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)
  27217. * * 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)
  27218. * @returns the VertexData of the ellipsoid
  27219. */
  27220. static CreateSphere(options: {
  27221. segments?: number;
  27222. diameter?: number;
  27223. diameterX?: number;
  27224. diameterY?: number;
  27225. diameterZ?: number;
  27226. arc?: number;
  27227. slice?: number;
  27228. sideOrientation?: number;
  27229. frontUVs?: Vector4;
  27230. backUVs?: Vector4;
  27231. }): VertexData;
  27232. /**
  27233. * Creates the VertexData for a cylinder, cone or prism
  27234. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27235. * * height sets the height (y direction) of the cylinder, optional, default 2
  27236. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  27237. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  27238. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  27239. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  27240. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  27241. * * 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
  27242. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27243. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27244. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  27245. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  27246. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27247. * * 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)
  27248. * * 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)
  27249. * @returns the VertexData of the cylinder, cone or prism
  27250. */
  27251. static CreateCylinder(options: {
  27252. height?: number;
  27253. diameterTop?: number;
  27254. diameterBottom?: number;
  27255. diameter?: number;
  27256. tessellation?: number;
  27257. subdivisions?: number;
  27258. arc?: number;
  27259. faceColors?: Color4[];
  27260. faceUV?: Vector4[];
  27261. hasRings?: boolean;
  27262. enclose?: boolean;
  27263. sideOrientation?: number;
  27264. frontUVs?: Vector4;
  27265. backUVs?: Vector4;
  27266. }): VertexData;
  27267. /**
  27268. * Creates the VertexData for a torus
  27269. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27270. * * diameter the diameter of the torus, optional default 1
  27271. * * thickness the diameter of the tube forming the torus, optional default 0.5
  27272. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  27273. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27274. * * 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)
  27275. * * 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)
  27276. * @returns the VertexData of the torus
  27277. */
  27278. static CreateTorus(options: {
  27279. diameter?: number;
  27280. thickness?: number;
  27281. tessellation?: number;
  27282. sideOrientation?: number;
  27283. frontUVs?: Vector4;
  27284. backUVs?: Vector4;
  27285. }): VertexData;
  27286. /**
  27287. * Creates the VertexData of the LineSystem
  27288. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  27289. * - lines an array of lines, each line being an array of successive Vector3
  27290. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  27291. * @returns the VertexData of the LineSystem
  27292. */
  27293. static CreateLineSystem(options: {
  27294. lines: Vector3[][];
  27295. colors?: Nullable<Color4[][]>;
  27296. }): VertexData;
  27297. /**
  27298. * Create the VertexData for a DashedLines
  27299. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  27300. * - points an array successive Vector3
  27301. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  27302. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  27303. * - dashNb the intended total number of dashes, optional, default 200
  27304. * @returns the VertexData for the DashedLines
  27305. */
  27306. static CreateDashedLines(options: {
  27307. points: Vector3[];
  27308. dashSize?: number;
  27309. gapSize?: number;
  27310. dashNb?: number;
  27311. }): VertexData;
  27312. /**
  27313. * Creates the VertexData for a Ground
  27314. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  27315. * - width the width (x direction) of the ground, optional, default 1
  27316. * - height the height (z direction) of the ground, optional, default 1
  27317. * - subdivisions the number of subdivisions per side, optional, default 1
  27318. * @returns the VertexData of the Ground
  27319. */
  27320. static CreateGround(options: {
  27321. width?: number;
  27322. height?: number;
  27323. subdivisions?: number;
  27324. subdivisionsX?: number;
  27325. subdivisionsY?: number;
  27326. }): VertexData;
  27327. /**
  27328. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  27329. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  27330. * * xmin the ground minimum X coordinate, optional, default -1
  27331. * * zmin the ground minimum Z coordinate, optional, default -1
  27332. * * xmax the ground maximum X coordinate, optional, default 1
  27333. * * zmax the ground maximum Z coordinate, optional, default 1
  27334. * * 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}
  27335. * * 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}
  27336. * @returns the VertexData of the TiledGround
  27337. */
  27338. static CreateTiledGround(options: {
  27339. xmin: number;
  27340. zmin: number;
  27341. xmax: number;
  27342. zmax: number;
  27343. subdivisions?: {
  27344. w: number;
  27345. h: number;
  27346. };
  27347. precision?: {
  27348. w: number;
  27349. h: number;
  27350. };
  27351. }): VertexData;
  27352. /**
  27353. * Creates the VertexData of the Ground designed from a heightmap
  27354. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  27355. * * width the width (x direction) of the ground
  27356. * * height the height (z direction) of the ground
  27357. * * subdivisions the number of subdivisions per side
  27358. * * minHeight the minimum altitude on the ground, optional, default 0
  27359. * * maxHeight the maximum altitude on the ground, optional default 1
  27360. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  27361. * * buffer the array holding the image color data
  27362. * * bufferWidth the width of image
  27363. * * bufferHeight the height of image
  27364. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  27365. * @returns the VertexData of the Ground designed from a heightmap
  27366. */
  27367. static CreateGroundFromHeightMap(options: {
  27368. width: number;
  27369. height: number;
  27370. subdivisions: number;
  27371. minHeight: number;
  27372. maxHeight: number;
  27373. colorFilter: Color3;
  27374. buffer: Uint8Array;
  27375. bufferWidth: number;
  27376. bufferHeight: number;
  27377. alphaFilter: number;
  27378. }): VertexData;
  27379. /**
  27380. * Creates the VertexData for a Plane
  27381. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  27382. * * size sets the width and height of the plane to the value of size, optional default 1
  27383. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  27384. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  27385. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27386. * * 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)
  27387. * * 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)
  27388. * @returns the VertexData of the box
  27389. */
  27390. static CreatePlane(options: {
  27391. size?: number;
  27392. width?: number;
  27393. height?: number;
  27394. sideOrientation?: number;
  27395. frontUVs?: Vector4;
  27396. backUVs?: Vector4;
  27397. }): VertexData;
  27398. /**
  27399. * Creates the VertexData of the Disc or regular Polygon
  27400. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  27401. * * radius the radius of the disc, optional default 0.5
  27402. * * tessellation the number of polygon sides, optional, default 64
  27403. * * 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
  27404. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27405. * * 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)
  27406. * * 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)
  27407. * @returns the VertexData of the box
  27408. */
  27409. static CreateDisc(options: {
  27410. radius?: number;
  27411. tessellation?: number;
  27412. arc?: number;
  27413. sideOrientation?: number;
  27414. frontUVs?: Vector4;
  27415. backUVs?: Vector4;
  27416. }): VertexData;
  27417. /**
  27418. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  27419. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  27420. * @param polygon a mesh built from polygonTriangulation.build()
  27421. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27422. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27423. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27424. * @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)
  27425. * @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)
  27426. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  27427. * @returns the VertexData of the Polygon
  27428. */
  27429. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  27430. /**
  27431. * Creates the VertexData of the IcoSphere
  27432. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  27433. * * radius the radius of the IcoSphere, optional default 1
  27434. * * radiusX allows stretching in the x direction, optional, default radius
  27435. * * radiusY allows stretching in the y direction, optional, default radius
  27436. * * radiusZ allows stretching in the z direction, optional, default radius
  27437. * * flat when true creates a flat shaded mesh, optional, default true
  27438. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  27439. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27440. * * 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)
  27441. * * 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)
  27442. * @returns the VertexData of the IcoSphere
  27443. */
  27444. static CreateIcoSphere(options: {
  27445. radius?: number;
  27446. radiusX?: number;
  27447. radiusY?: number;
  27448. radiusZ?: number;
  27449. flat?: boolean;
  27450. subdivisions?: number;
  27451. sideOrientation?: number;
  27452. frontUVs?: Vector4;
  27453. backUVs?: Vector4;
  27454. }): VertexData;
  27455. /**
  27456. * Creates the VertexData for a Polyhedron
  27457. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  27458. * * type provided types are:
  27459. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  27460. * * 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)
  27461. * * size the size of the IcoSphere, optional default 1
  27462. * * sizeX allows stretching in the x direction, optional, default size
  27463. * * sizeY allows stretching in the y direction, optional, default size
  27464. * * sizeZ allows stretching in the z direction, optional, default size
  27465. * * 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
  27466. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27467. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27468. * * flat when true creates a flat shaded mesh, optional, default true
  27469. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  27470. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27471. * * 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)
  27472. * * 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)
  27473. * @returns the VertexData of the Polyhedron
  27474. */
  27475. static CreatePolyhedron(options: {
  27476. type?: number;
  27477. size?: number;
  27478. sizeX?: number;
  27479. sizeY?: number;
  27480. sizeZ?: number;
  27481. custom?: any;
  27482. faceUV?: Vector4[];
  27483. faceColors?: Color4[];
  27484. flat?: boolean;
  27485. sideOrientation?: number;
  27486. frontUVs?: Vector4;
  27487. backUVs?: Vector4;
  27488. }): VertexData;
  27489. /**
  27490. * Creates the VertexData for a Capsule, inspired from https://github.com/maximeq/three-js-capsule-geometry/blob/master/src/CapsuleBufferGeometry.js
  27491. * @param options an object used to set the following optional parameters for the capsule, required but can be empty
  27492. * @returns the VertexData of the Capsule
  27493. */
  27494. static CreateCapsule(options?: ICreateCapsuleOptions): VertexData;
  27495. /**
  27496. * Creates the VertexData for a TorusKnot
  27497. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  27498. * * radius the radius of the torus knot, optional, default 2
  27499. * * tube the thickness of the tube, optional, default 0.5
  27500. * * radialSegments the number of sides on each tube segments, optional, default 32
  27501. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  27502. * * p the number of windings around the z axis, optional, default 2
  27503. * * q the number of windings around the x axis, optional, default 3
  27504. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27505. * * 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)
  27506. * * 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)
  27507. * @returns the VertexData of the Torus Knot
  27508. */
  27509. static CreateTorusKnot(options: {
  27510. radius?: number;
  27511. tube?: number;
  27512. radialSegments?: number;
  27513. tubularSegments?: number;
  27514. p?: number;
  27515. q?: number;
  27516. sideOrientation?: number;
  27517. frontUVs?: Vector4;
  27518. backUVs?: Vector4;
  27519. }): VertexData;
  27520. /**
  27521. * Compute normals for given positions and indices
  27522. * @param positions an array of vertex positions, [...., x, y, z, ......]
  27523. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  27524. * @param normals an array of vertex normals, [...., x, y, z, ......]
  27525. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  27526. * * facetNormals : optional array of facet normals (vector3)
  27527. * * facetPositions : optional array of facet positions (vector3)
  27528. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  27529. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  27530. * * bInfo : optional bounding info, required for facetPartitioning computation
  27531. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  27532. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  27533. * * useRightHandedSystem: optional boolean to for right handed system computation
  27534. * * depthSort : optional boolean to enable the facet depth sort computation
  27535. * * distanceTo : optional Vector3 to compute the facet depth from this location
  27536. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  27537. */
  27538. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  27539. facetNormals?: any;
  27540. facetPositions?: any;
  27541. facetPartitioning?: any;
  27542. ratio?: number;
  27543. bInfo?: any;
  27544. bbSize?: Vector3;
  27545. subDiv?: any;
  27546. useRightHandedSystem?: boolean;
  27547. depthSort?: boolean;
  27548. distanceTo?: Vector3;
  27549. depthSortedFacets?: any;
  27550. }): void;
  27551. /** @hidden */
  27552. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  27553. /**
  27554. * Applies VertexData created from the imported parameters to the geometry
  27555. * @param parsedVertexData the parsed data from an imported file
  27556. * @param geometry the geometry to apply the VertexData to
  27557. */
  27558. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  27559. }
  27560. }
  27561. declare module "babylonjs/Morph/morphTarget" {
  27562. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  27563. import { Observable } from "babylonjs/Misc/observable";
  27564. import { Nullable, FloatArray } from "babylonjs/types";
  27565. import { Scene } from "babylonjs/scene";
  27566. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27567. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  27568. /**
  27569. * Defines a target to use with MorphTargetManager
  27570. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  27571. */
  27572. export class MorphTarget implements IAnimatable {
  27573. /** defines the name of the target */
  27574. name: string;
  27575. /**
  27576. * Gets or sets the list of animations
  27577. */
  27578. animations: import("babylonjs/Animations/animation").Animation[];
  27579. private _scene;
  27580. private _positions;
  27581. private _normals;
  27582. private _tangents;
  27583. private _uvs;
  27584. private _influence;
  27585. private _uniqueId;
  27586. /**
  27587. * Observable raised when the influence changes
  27588. */
  27589. onInfluenceChanged: Observable<boolean>;
  27590. /** @hidden */
  27591. _onDataLayoutChanged: Observable<void>;
  27592. /**
  27593. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  27594. */
  27595. get influence(): number;
  27596. set influence(influence: number);
  27597. /**
  27598. * Gets or sets the id of the morph Target
  27599. */
  27600. id: string;
  27601. private _animationPropertiesOverride;
  27602. /**
  27603. * Gets or sets the animation properties override
  27604. */
  27605. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  27606. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  27607. /**
  27608. * Creates a new MorphTarget
  27609. * @param name defines the name of the target
  27610. * @param influence defines the influence to use
  27611. * @param scene defines the scene the morphtarget belongs to
  27612. */
  27613. constructor(
  27614. /** defines the name of the target */
  27615. name: string, influence?: number, scene?: Nullable<Scene>);
  27616. /**
  27617. * Gets the unique ID of this manager
  27618. */
  27619. get uniqueId(): number;
  27620. /**
  27621. * Gets a boolean defining if the target contains position data
  27622. */
  27623. get hasPositions(): boolean;
  27624. /**
  27625. * Gets a boolean defining if the target contains normal data
  27626. */
  27627. get hasNormals(): boolean;
  27628. /**
  27629. * Gets a boolean defining if the target contains tangent data
  27630. */
  27631. get hasTangents(): boolean;
  27632. /**
  27633. * Gets a boolean defining if the target contains texture coordinates data
  27634. */
  27635. get hasUVs(): boolean;
  27636. /**
  27637. * Affects position data to this target
  27638. * @param data defines the position data to use
  27639. */
  27640. setPositions(data: Nullable<FloatArray>): void;
  27641. /**
  27642. * Gets the position data stored in this target
  27643. * @returns a FloatArray containing the position data (or null if not present)
  27644. */
  27645. getPositions(): Nullable<FloatArray>;
  27646. /**
  27647. * Affects normal data to this target
  27648. * @param data defines the normal data to use
  27649. */
  27650. setNormals(data: Nullable<FloatArray>): void;
  27651. /**
  27652. * Gets the normal data stored in this target
  27653. * @returns a FloatArray containing the normal data (or null if not present)
  27654. */
  27655. getNormals(): Nullable<FloatArray>;
  27656. /**
  27657. * Affects tangent data to this target
  27658. * @param data defines the tangent data to use
  27659. */
  27660. setTangents(data: Nullable<FloatArray>): void;
  27661. /**
  27662. * Gets the tangent data stored in this target
  27663. * @returns a FloatArray containing the tangent data (or null if not present)
  27664. */
  27665. getTangents(): Nullable<FloatArray>;
  27666. /**
  27667. * Affects texture coordinates data to this target
  27668. * @param data defines the texture coordinates data to use
  27669. */
  27670. setUVs(data: Nullable<FloatArray>): void;
  27671. /**
  27672. * Gets the texture coordinates data stored in this target
  27673. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  27674. */
  27675. getUVs(): Nullable<FloatArray>;
  27676. /**
  27677. * Clone the current target
  27678. * @returns a new MorphTarget
  27679. */
  27680. clone(): MorphTarget;
  27681. /**
  27682. * Serializes the current target into a Serialization object
  27683. * @returns the serialized object
  27684. */
  27685. serialize(): any;
  27686. /**
  27687. * Returns the string "MorphTarget"
  27688. * @returns "MorphTarget"
  27689. */
  27690. getClassName(): string;
  27691. /**
  27692. * Creates a new target from serialized data
  27693. * @param serializationObject defines the serialized data to use
  27694. * @returns a new MorphTarget
  27695. */
  27696. static Parse(serializationObject: any): MorphTarget;
  27697. /**
  27698. * Creates a MorphTarget from mesh data
  27699. * @param mesh defines the source mesh
  27700. * @param name defines the name to use for the new target
  27701. * @param influence defines the influence to attach to the target
  27702. * @returns a new MorphTarget
  27703. */
  27704. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  27705. }
  27706. }
  27707. declare module "babylonjs/Morph/morphTargetManager" {
  27708. import { Nullable } from "babylonjs/types";
  27709. import { Scene } from "babylonjs/scene";
  27710. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  27711. /**
  27712. * This class is used to deform meshes using morphing between different targets
  27713. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  27714. */
  27715. export class MorphTargetManager {
  27716. private _targets;
  27717. private _targetInfluenceChangedObservers;
  27718. private _targetDataLayoutChangedObservers;
  27719. private _activeTargets;
  27720. private _scene;
  27721. private _influences;
  27722. private _supportsNormals;
  27723. private _supportsTangents;
  27724. private _supportsUVs;
  27725. private _vertexCount;
  27726. private _uniqueId;
  27727. private _tempInfluences;
  27728. /**
  27729. * Gets or sets a boolean indicating if normals must be morphed
  27730. */
  27731. enableNormalMorphing: boolean;
  27732. /**
  27733. * Gets or sets a boolean indicating if tangents must be morphed
  27734. */
  27735. enableTangentMorphing: boolean;
  27736. /**
  27737. * Gets or sets a boolean indicating if UV must be morphed
  27738. */
  27739. enableUVMorphing: boolean;
  27740. /**
  27741. * Creates a new MorphTargetManager
  27742. * @param scene defines the current scene
  27743. */
  27744. constructor(scene?: Nullable<Scene>);
  27745. /**
  27746. * Gets the unique ID of this manager
  27747. */
  27748. get uniqueId(): number;
  27749. /**
  27750. * Gets the number of vertices handled by this manager
  27751. */
  27752. get vertexCount(): number;
  27753. /**
  27754. * Gets a boolean indicating if this manager supports morphing of normals
  27755. */
  27756. get supportsNormals(): boolean;
  27757. /**
  27758. * Gets a boolean indicating if this manager supports morphing of tangents
  27759. */
  27760. get supportsTangents(): boolean;
  27761. /**
  27762. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  27763. */
  27764. get supportsUVs(): boolean;
  27765. /**
  27766. * Gets the number of targets stored in this manager
  27767. */
  27768. get numTargets(): number;
  27769. /**
  27770. * Gets the number of influencers (ie. the number of targets with influences > 0)
  27771. */
  27772. get numInfluencers(): number;
  27773. /**
  27774. * Gets the list of influences (one per target)
  27775. */
  27776. get influences(): Float32Array;
  27777. /**
  27778. * Gets the active target at specified index. An active target is a target with an influence > 0
  27779. * @param index defines the index to check
  27780. * @returns the requested target
  27781. */
  27782. getActiveTarget(index: number): MorphTarget;
  27783. /**
  27784. * Gets the target at specified index
  27785. * @param index defines the index to check
  27786. * @returns the requested target
  27787. */
  27788. getTarget(index: number): MorphTarget;
  27789. /**
  27790. * Add a new target to this manager
  27791. * @param target defines the target to add
  27792. */
  27793. addTarget(target: MorphTarget): void;
  27794. /**
  27795. * Removes a target from the manager
  27796. * @param target defines the target to remove
  27797. */
  27798. removeTarget(target: MorphTarget): void;
  27799. /**
  27800. * Clone the current manager
  27801. * @returns a new MorphTargetManager
  27802. */
  27803. clone(): MorphTargetManager;
  27804. /**
  27805. * Serializes the current manager into a Serialization object
  27806. * @returns the serialized object
  27807. */
  27808. serialize(): any;
  27809. private _syncActiveTargets;
  27810. /**
  27811. * Syncrhonize the targets with all the meshes using this morph target manager
  27812. */
  27813. synchronize(): void;
  27814. /**
  27815. * Creates a new MorphTargetManager from serialized data
  27816. * @param serializationObject defines the serialized data
  27817. * @param scene defines the hosting scene
  27818. * @returns the new MorphTargetManager
  27819. */
  27820. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  27821. }
  27822. }
  27823. declare module "babylonjs/Meshes/meshLODLevel" {
  27824. import { Mesh } from "babylonjs/Meshes/mesh";
  27825. import { Nullable } from "babylonjs/types";
  27826. /**
  27827. * Class used to represent a specific level of detail of a mesh
  27828. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  27829. */
  27830. export class MeshLODLevel {
  27831. /** Defines the distance where this level should start being displayed */
  27832. distance: number;
  27833. /** Defines the mesh to use to render this level */
  27834. mesh: Nullable<Mesh>;
  27835. /**
  27836. * Creates a new LOD level
  27837. * @param distance defines the distance where this level should star being displayed
  27838. * @param mesh defines the mesh to use to render this level
  27839. */
  27840. constructor(
  27841. /** Defines the distance where this level should start being displayed */
  27842. distance: number,
  27843. /** Defines the mesh to use to render this level */
  27844. mesh: Nullable<Mesh>);
  27845. }
  27846. }
  27847. declare module "babylonjs/Misc/canvasGenerator" {
  27848. /**
  27849. * Helper class used to generate a canvas to manipulate images
  27850. */
  27851. export class CanvasGenerator {
  27852. /**
  27853. * Create a new canvas (or offscreen canvas depending on the context)
  27854. * @param width defines the expected width
  27855. * @param height defines the expected height
  27856. * @return a new canvas or offscreen canvas
  27857. */
  27858. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  27859. }
  27860. }
  27861. declare module "babylonjs/Meshes/groundMesh" {
  27862. import { Scene } from "babylonjs/scene";
  27863. import { Vector3 } from "babylonjs/Maths/math.vector";
  27864. import { Mesh } from "babylonjs/Meshes/mesh";
  27865. /**
  27866. * Mesh representing the gorund
  27867. */
  27868. export class GroundMesh extends Mesh {
  27869. /** If octree should be generated */
  27870. generateOctree: boolean;
  27871. private _heightQuads;
  27872. /** @hidden */
  27873. _subdivisionsX: number;
  27874. /** @hidden */
  27875. _subdivisionsY: number;
  27876. /** @hidden */
  27877. _width: number;
  27878. /** @hidden */
  27879. _height: number;
  27880. /** @hidden */
  27881. _minX: number;
  27882. /** @hidden */
  27883. _maxX: number;
  27884. /** @hidden */
  27885. _minZ: number;
  27886. /** @hidden */
  27887. _maxZ: number;
  27888. constructor(name: string, scene: Scene);
  27889. /**
  27890. * "GroundMesh"
  27891. * @returns "GroundMesh"
  27892. */
  27893. getClassName(): string;
  27894. /**
  27895. * The minimum of x and y subdivisions
  27896. */
  27897. get subdivisions(): number;
  27898. /**
  27899. * X subdivisions
  27900. */
  27901. get subdivisionsX(): number;
  27902. /**
  27903. * Y subdivisions
  27904. */
  27905. get subdivisionsY(): number;
  27906. /**
  27907. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  27908. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  27909. * @param chunksCount the number of subdivisions for x and y
  27910. * @param octreeBlocksSize (Default: 32)
  27911. */
  27912. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  27913. /**
  27914. * Returns a height (y) value in the Worl system :
  27915. * the ground altitude at the coordinates (x, z) expressed in the World system.
  27916. * @param x x coordinate
  27917. * @param z z coordinate
  27918. * @returns the ground y position if (x, z) are outside the ground surface.
  27919. */
  27920. getHeightAtCoordinates(x: number, z: number): number;
  27921. /**
  27922. * Returns a normalized vector (Vector3) orthogonal to the ground
  27923. * at the ground coordinates (x, z) expressed in the World system.
  27924. * @param x x coordinate
  27925. * @param z z coordinate
  27926. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  27927. */
  27928. getNormalAtCoordinates(x: number, z: number): Vector3;
  27929. /**
  27930. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  27931. * at the ground coordinates (x, z) expressed in the World system.
  27932. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  27933. * @param x x coordinate
  27934. * @param z z coordinate
  27935. * @param ref vector to store the result
  27936. * @returns the GroundMesh.
  27937. */
  27938. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  27939. /**
  27940. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  27941. * if the ground has been updated.
  27942. * This can be used in the render loop.
  27943. * @returns the GroundMesh.
  27944. */
  27945. updateCoordinateHeights(): GroundMesh;
  27946. private _getFacetAt;
  27947. private _initHeightQuads;
  27948. private _computeHeightQuads;
  27949. /**
  27950. * Serializes this ground mesh
  27951. * @param serializationObject object to write serialization to
  27952. */
  27953. serialize(serializationObject: any): void;
  27954. /**
  27955. * Parses a serialized ground mesh
  27956. * @param parsedMesh the serialized mesh
  27957. * @param scene the scene to create the ground mesh in
  27958. * @returns the created ground mesh
  27959. */
  27960. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  27961. }
  27962. }
  27963. declare module "babylonjs/Physics/physicsJoint" {
  27964. import { Vector3 } from "babylonjs/Maths/math.vector";
  27965. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  27966. /**
  27967. * Interface for Physics-Joint data
  27968. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27969. */
  27970. export interface PhysicsJointData {
  27971. /**
  27972. * The main pivot of the joint
  27973. */
  27974. mainPivot?: Vector3;
  27975. /**
  27976. * The connected pivot of the joint
  27977. */
  27978. connectedPivot?: Vector3;
  27979. /**
  27980. * The main axis of the joint
  27981. */
  27982. mainAxis?: Vector3;
  27983. /**
  27984. * The connected axis of the joint
  27985. */
  27986. connectedAxis?: Vector3;
  27987. /**
  27988. * The collision of the joint
  27989. */
  27990. collision?: boolean;
  27991. /**
  27992. * Native Oimo/Cannon/Energy data
  27993. */
  27994. nativeParams?: any;
  27995. }
  27996. /**
  27997. * This is a holder class for the physics joint created by the physics plugin
  27998. * It holds a set of functions to control the underlying joint
  27999. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28000. */
  28001. export class PhysicsJoint {
  28002. /**
  28003. * The type of the physics joint
  28004. */
  28005. type: number;
  28006. /**
  28007. * The data for the physics joint
  28008. */
  28009. jointData: PhysicsJointData;
  28010. private _physicsJoint;
  28011. protected _physicsPlugin: IPhysicsEnginePlugin;
  28012. /**
  28013. * Initializes the physics joint
  28014. * @param type The type of the physics joint
  28015. * @param jointData The data for the physics joint
  28016. */
  28017. constructor(
  28018. /**
  28019. * The type of the physics joint
  28020. */
  28021. type: number,
  28022. /**
  28023. * The data for the physics joint
  28024. */
  28025. jointData: PhysicsJointData);
  28026. /**
  28027. * Gets the physics joint
  28028. */
  28029. get physicsJoint(): any;
  28030. /**
  28031. * Sets the physics joint
  28032. */
  28033. set physicsJoint(newJoint: any);
  28034. /**
  28035. * Sets the physics plugin
  28036. */
  28037. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  28038. /**
  28039. * Execute a function that is physics-plugin specific.
  28040. * @param {Function} func the function that will be executed.
  28041. * It accepts two parameters: the physics world and the physics joint
  28042. */
  28043. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  28044. /**
  28045. * Distance-Joint type
  28046. */
  28047. static DistanceJoint: number;
  28048. /**
  28049. * Hinge-Joint type
  28050. */
  28051. static HingeJoint: number;
  28052. /**
  28053. * Ball-and-Socket joint type
  28054. */
  28055. static BallAndSocketJoint: number;
  28056. /**
  28057. * Wheel-Joint type
  28058. */
  28059. static WheelJoint: number;
  28060. /**
  28061. * Slider-Joint type
  28062. */
  28063. static SliderJoint: number;
  28064. /**
  28065. * Prismatic-Joint type
  28066. */
  28067. static PrismaticJoint: number;
  28068. /**
  28069. * Universal-Joint type
  28070. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  28071. */
  28072. static UniversalJoint: number;
  28073. /**
  28074. * Hinge-Joint 2 type
  28075. */
  28076. static Hinge2Joint: number;
  28077. /**
  28078. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  28079. */
  28080. static PointToPointJoint: number;
  28081. /**
  28082. * Spring-Joint type
  28083. */
  28084. static SpringJoint: number;
  28085. /**
  28086. * Lock-Joint type
  28087. */
  28088. static LockJoint: number;
  28089. }
  28090. /**
  28091. * A class representing a physics distance joint
  28092. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28093. */
  28094. export class DistanceJoint extends PhysicsJoint {
  28095. /**
  28096. *
  28097. * @param jointData The data for the Distance-Joint
  28098. */
  28099. constructor(jointData: DistanceJointData);
  28100. /**
  28101. * Update the predefined distance.
  28102. * @param maxDistance The maximum preferred distance
  28103. * @param minDistance The minimum preferred distance
  28104. */
  28105. updateDistance(maxDistance: number, minDistance?: number): void;
  28106. }
  28107. /**
  28108. * Represents a Motor-Enabled Joint
  28109. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28110. */
  28111. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  28112. /**
  28113. * Initializes the Motor-Enabled Joint
  28114. * @param type The type of the joint
  28115. * @param jointData The physica joint data for the joint
  28116. */
  28117. constructor(type: number, jointData: PhysicsJointData);
  28118. /**
  28119. * Set the motor values.
  28120. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28121. * @param force the force to apply
  28122. * @param maxForce max force for this motor.
  28123. */
  28124. setMotor(force?: number, maxForce?: number): void;
  28125. /**
  28126. * Set the motor's limits.
  28127. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28128. * @param upperLimit The upper limit of the motor
  28129. * @param lowerLimit The lower limit of the motor
  28130. */
  28131. setLimit(upperLimit: number, lowerLimit?: number): void;
  28132. }
  28133. /**
  28134. * This class represents a single physics Hinge-Joint
  28135. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28136. */
  28137. export class HingeJoint extends MotorEnabledJoint {
  28138. /**
  28139. * Initializes the Hinge-Joint
  28140. * @param jointData The joint data for the Hinge-Joint
  28141. */
  28142. constructor(jointData: PhysicsJointData);
  28143. /**
  28144. * Set the motor values.
  28145. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28146. * @param {number} force the force to apply
  28147. * @param {number} maxForce max force for this motor.
  28148. */
  28149. setMotor(force?: number, maxForce?: number): void;
  28150. /**
  28151. * Set the motor's limits.
  28152. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28153. * @param upperLimit The upper limit of the motor
  28154. * @param lowerLimit The lower limit of the motor
  28155. */
  28156. setLimit(upperLimit: number, lowerLimit?: number): void;
  28157. }
  28158. /**
  28159. * This class represents a dual hinge physics joint (same as wheel joint)
  28160. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28161. */
  28162. export class Hinge2Joint extends MotorEnabledJoint {
  28163. /**
  28164. * Initializes the Hinge2-Joint
  28165. * @param jointData The joint data for the Hinge2-Joint
  28166. */
  28167. constructor(jointData: PhysicsJointData);
  28168. /**
  28169. * Set the motor values.
  28170. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28171. * @param {number} targetSpeed the speed the motor is to reach
  28172. * @param {number} maxForce max force for this motor.
  28173. * @param {motorIndex} the motor's index, 0 or 1.
  28174. */
  28175. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  28176. /**
  28177. * Set the motor limits.
  28178. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28179. * @param {number} upperLimit the upper limit
  28180. * @param {number} lowerLimit lower limit
  28181. * @param {motorIndex} the motor's index, 0 or 1.
  28182. */
  28183. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28184. }
  28185. /**
  28186. * Interface for a motor enabled joint
  28187. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28188. */
  28189. export interface IMotorEnabledJoint {
  28190. /**
  28191. * Physics joint
  28192. */
  28193. physicsJoint: any;
  28194. /**
  28195. * Sets the motor of the motor-enabled joint
  28196. * @param force The force of the motor
  28197. * @param maxForce The maximum force of the motor
  28198. * @param motorIndex The index of the motor
  28199. */
  28200. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  28201. /**
  28202. * Sets the limit of the motor
  28203. * @param upperLimit The upper limit of the motor
  28204. * @param lowerLimit The lower limit of the motor
  28205. * @param motorIndex The index of the motor
  28206. */
  28207. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28208. }
  28209. /**
  28210. * Joint data for a Distance-Joint
  28211. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28212. */
  28213. export interface DistanceJointData extends PhysicsJointData {
  28214. /**
  28215. * Max distance the 2 joint objects can be apart
  28216. */
  28217. maxDistance: number;
  28218. }
  28219. /**
  28220. * Joint data from a spring joint
  28221. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28222. */
  28223. export interface SpringJointData extends PhysicsJointData {
  28224. /**
  28225. * Length of the spring
  28226. */
  28227. length: number;
  28228. /**
  28229. * Stiffness of the spring
  28230. */
  28231. stiffness: number;
  28232. /**
  28233. * Damping of the spring
  28234. */
  28235. damping: number;
  28236. /** this callback will be called when applying the force to the impostors. */
  28237. forceApplicationCallback: () => void;
  28238. }
  28239. }
  28240. declare module "babylonjs/Physics/physicsRaycastResult" {
  28241. import { Vector3 } from "babylonjs/Maths/math.vector";
  28242. /**
  28243. * Holds the data for the raycast result
  28244. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28245. */
  28246. export class PhysicsRaycastResult {
  28247. private _hasHit;
  28248. private _hitDistance;
  28249. private _hitNormalWorld;
  28250. private _hitPointWorld;
  28251. private _rayFromWorld;
  28252. private _rayToWorld;
  28253. /**
  28254. * Gets if there was a hit
  28255. */
  28256. get hasHit(): boolean;
  28257. /**
  28258. * Gets the distance from the hit
  28259. */
  28260. get hitDistance(): number;
  28261. /**
  28262. * Gets the hit normal/direction in the world
  28263. */
  28264. get hitNormalWorld(): Vector3;
  28265. /**
  28266. * Gets the hit point in the world
  28267. */
  28268. get hitPointWorld(): Vector3;
  28269. /**
  28270. * Gets the ray "start point" of the ray in the world
  28271. */
  28272. get rayFromWorld(): Vector3;
  28273. /**
  28274. * Gets the ray "end point" of the ray in the world
  28275. */
  28276. get rayToWorld(): Vector3;
  28277. /**
  28278. * Sets the hit data (normal & point in world space)
  28279. * @param hitNormalWorld defines the normal in world space
  28280. * @param hitPointWorld defines the point in world space
  28281. */
  28282. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  28283. /**
  28284. * Sets the distance from the start point to the hit point
  28285. * @param distance
  28286. */
  28287. setHitDistance(distance: number): void;
  28288. /**
  28289. * Calculates the distance manually
  28290. */
  28291. calculateHitDistance(): void;
  28292. /**
  28293. * Resets all the values to default
  28294. * @param from The from point on world space
  28295. * @param to The to point on world space
  28296. */
  28297. reset(from?: Vector3, to?: Vector3): void;
  28298. }
  28299. /**
  28300. * Interface for the size containing width and height
  28301. */
  28302. interface IXYZ {
  28303. /**
  28304. * X
  28305. */
  28306. x: number;
  28307. /**
  28308. * Y
  28309. */
  28310. y: number;
  28311. /**
  28312. * Z
  28313. */
  28314. z: number;
  28315. }
  28316. }
  28317. declare module "babylonjs/Physics/IPhysicsEngine" {
  28318. import { Nullable } from "babylonjs/types";
  28319. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  28320. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28321. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  28322. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  28323. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  28324. /**
  28325. * Interface used to describe a physics joint
  28326. */
  28327. export interface PhysicsImpostorJoint {
  28328. /** Defines the main impostor to which the joint is linked */
  28329. mainImpostor: PhysicsImpostor;
  28330. /** Defines the impostor that is connected to the main impostor using this joint */
  28331. connectedImpostor: PhysicsImpostor;
  28332. /** Defines the joint itself */
  28333. joint: PhysicsJoint;
  28334. }
  28335. /** @hidden */
  28336. export interface IPhysicsEnginePlugin {
  28337. world: any;
  28338. name: string;
  28339. setGravity(gravity: Vector3): void;
  28340. setTimeStep(timeStep: number): void;
  28341. getTimeStep(): number;
  28342. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  28343. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  28344. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  28345. generatePhysicsBody(impostor: PhysicsImpostor): void;
  28346. removePhysicsBody(impostor: PhysicsImpostor): void;
  28347. generateJoint(joint: PhysicsImpostorJoint): void;
  28348. removeJoint(joint: PhysicsImpostorJoint): void;
  28349. isSupported(): boolean;
  28350. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  28351. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  28352. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  28353. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  28354. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  28355. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  28356. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  28357. getBodyMass(impostor: PhysicsImpostor): number;
  28358. getBodyFriction(impostor: PhysicsImpostor): number;
  28359. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  28360. getBodyRestitution(impostor: PhysicsImpostor): number;
  28361. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  28362. getBodyPressure?(impostor: PhysicsImpostor): number;
  28363. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  28364. getBodyStiffness?(impostor: PhysicsImpostor): number;
  28365. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  28366. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  28367. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  28368. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  28369. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  28370. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  28371. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  28372. sleepBody(impostor: PhysicsImpostor): void;
  28373. wakeUpBody(impostor: PhysicsImpostor): void;
  28374. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  28375. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  28376. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  28377. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28378. getRadius(impostor: PhysicsImpostor): number;
  28379. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  28380. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  28381. dispose(): void;
  28382. }
  28383. /**
  28384. * Interface used to define a physics engine
  28385. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28386. */
  28387. export interface IPhysicsEngine {
  28388. /**
  28389. * Gets the gravity vector used by the simulation
  28390. */
  28391. gravity: Vector3;
  28392. /**
  28393. * Sets the gravity vector used by the simulation
  28394. * @param gravity defines the gravity vector to use
  28395. */
  28396. setGravity(gravity: Vector3): void;
  28397. /**
  28398. * Set the time step of the physics engine.
  28399. * Default is 1/60.
  28400. * To slow it down, enter 1/600 for example.
  28401. * To speed it up, 1/30
  28402. * @param newTimeStep the new timestep to apply to this world.
  28403. */
  28404. setTimeStep(newTimeStep: number): void;
  28405. /**
  28406. * Get the time step of the physics engine.
  28407. * @returns the current time step
  28408. */
  28409. getTimeStep(): number;
  28410. /**
  28411. * Set the sub time step of the physics engine.
  28412. * Default is 0 meaning there is no sub steps
  28413. * To increase physics resolution precision, set a small value (like 1 ms)
  28414. * @param subTimeStep defines the new sub timestep used for physics resolution.
  28415. */
  28416. setSubTimeStep(subTimeStep: number): void;
  28417. /**
  28418. * Get the sub time step of the physics engine.
  28419. * @returns the current sub time step
  28420. */
  28421. getSubTimeStep(): number;
  28422. /**
  28423. * Release all resources
  28424. */
  28425. dispose(): void;
  28426. /**
  28427. * Gets the name of the current physics plugin
  28428. * @returns the name of the plugin
  28429. */
  28430. getPhysicsPluginName(): string;
  28431. /**
  28432. * Adding a new impostor for the impostor tracking.
  28433. * This will be done by the impostor itself.
  28434. * @param impostor the impostor to add
  28435. */
  28436. addImpostor(impostor: PhysicsImpostor): void;
  28437. /**
  28438. * Remove an impostor from the engine.
  28439. * This impostor and its mesh will not longer be updated by the physics engine.
  28440. * @param impostor the impostor to remove
  28441. */
  28442. removeImpostor(impostor: PhysicsImpostor): void;
  28443. /**
  28444. * Add a joint to the physics engine
  28445. * @param mainImpostor defines the main impostor to which the joint is added.
  28446. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  28447. * @param joint defines the joint that will connect both impostors.
  28448. */
  28449. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  28450. /**
  28451. * Removes a joint from the simulation
  28452. * @param mainImpostor defines the impostor used with the joint
  28453. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  28454. * @param joint defines the joint to remove
  28455. */
  28456. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  28457. /**
  28458. * Gets the current plugin used to run the simulation
  28459. * @returns current plugin
  28460. */
  28461. getPhysicsPlugin(): IPhysicsEnginePlugin;
  28462. /**
  28463. * Gets the list of physic impostors
  28464. * @returns an array of PhysicsImpostor
  28465. */
  28466. getImpostors(): Array<PhysicsImpostor>;
  28467. /**
  28468. * Gets the impostor for a physics enabled object
  28469. * @param object defines the object impersonated by the impostor
  28470. * @returns the PhysicsImpostor or null if not found
  28471. */
  28472. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  28473. /**
  28474. * Gets the impostor for a physics body object
  28475. * @param body defines physics body used by the impostor
  28476. * @returns the PhysicsImpostor or null if not found
  28477. */
  28478. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  28479. /**
  28480. * Does a raycast in the physics world
  28481. * @param from when should the ray start?
  28482. * @param to when should the ray end?
  28483. * @returns PhysicsRaycastResult
  28484. */
  28485. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  28486. /**
  28487. * Called by the scene. No need to call it.
  28488. * @param delta defines the timespam between frames
  28489. */
  28490. _step(delta: number): void;
  28491. }
  28492. }
  28493. declare module "babylonjs/Physics/physicsImpostor" {
  28494. import { Nullable, IndicesArray } from "babylonjs/types";
  28495. import { Vector3, Matrix, Quaternion } from "babylonjs/Maths/math.vector";
  28496. import { TransformNode } from "babylonjs/Meshes/transformNode";
  28497. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28498. import { Scene } from "babylonjs/scene";
  28499. import { Bone } from "babylonjs/Bones/bone";
  28500. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  28501. import { PhysicsJoint, PhysicsJointData } from "babylonjs/Physics/physicsJoint";
  28502. import { Space } from "babylonjs/Maths/math.axis";
  28503. /**
  28504. * The interface for the physics imposter parameters
  28505. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28506. */
  28507. export interface PhysicsImpostorParameters {
  28508. /**
  28509. * The mass of the physics imposter
  28510. */
  28511. mass: number;
  28512. /**
  28513. * The friction of the physics imposter
  28514. */
  28515. friction?: number;
  28516. /**
  28517. * The coefficient of restitution of the physics imposter
  28518. */
  28519. restitution?: number;
  28520. /**
  28521. * The native options of the physics imposter
  28522. */
  28523. nativeOptions?: any;
  28524. /**
  28525. * Specifies if the parent should be ignored
  28526. */
  28527. ignoreParent?: boolean;
  28528. /**
  28529. * Specifies if bi-directional transformations should be disabled
  28530. */
  28531. disableBidirectionalTransformation?: boolean;
  28532. /**
  28533. * The pressure inside the physics imposter, soft object only
  28534. */
  28535. pressure?: number;
  28536. /**
  28537. * The stiffness the physics imposter, soft object only
  28538. */
  28539. stiffness?: number;
  28540. /**
  28541. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  28542. */
  28543. velocityIterations?: number;
  28544. /**
  28545. * The number of iterations used in maintaining consistent vertex positions, soft object only
  28546. */
  28547. positionIterations?: number;
  28548. /**
  28549. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  28550. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  28551. * Add to fix multiple points
  28552. */
  28553. fixedPoints?: number;
  28554. /**
  28555. * The collision margin around a soft object
  28556. */
  28557. margin?: number;
  28558. /**
  28559. * The collision margin around a soft object
  28560. */
  28561. damping?: number;
  28562. /**
  28563. * The path for a rope based on an extrusion
  28564. */
  28565. path?: any;
  28566. /**
  28567. * The shape of an extrusion used for a rope based on an extrusion
  28568. */
  28569. shape?: any;
  28570. }
  28571. /**
  28572. * Interface for a physics-enabled object
  28573. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28574. */
  28575. export interface IPhysicsEnabledObject {
  28576. /**
  28577. * The position of the physics-enabled object
  28578. */
  28579. position: Vector3;
  28580. /**
  28581. * The rotation of the physics-enabled object
  28582. */
  28583. rotationQuaternion: Nullable<Quaternion>;
  28584. /**
  28585. * The scale of the physics-enabled object
  28586. */
  28587. scaling: Vector3;
  28588. /**
  28589. * The rotation of the physics-enabled object
  28590. */
  28591. rotation?: Vector3;
  28592. /**
  28593. * The parent of the physics-enabled object
  28594. */
  28595. parent?: any;
  28596. /**
  28597. * The bounding info of the physics-enabled object
  28598. * @returns The bounding info of the physics-enabled object
  28599. */
  28600. getBoundingInfo(): BoundingInfo;
  28601. /**
  28602. * Computes the world matrix
  28603. * @param force Specifies if the world matrix should be computed by force
  28604. * @returns A world matrix
  28605. */
  28606. computeWorldMatrix(force: boolean): Matrix;
  28607. /**
  28608. * Gets the world matrix
  28609. * @returns A world matrix
  28610. */
  28611. getWorldMatrix?(): Matrix;
  28612. /**
  28613. * Gets the child meshes
  28614. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  28615. * @returns An array of abstract meshes
  28616. */
  28617. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  28618. /**
  28619. * Gets the vertex data
  28620. * @param kind The type of vertex data
  28621. * @returns A nullable array of numbers, or a float32 array
  28622. */
  28623. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  28624. /**
  28625. * Gets the indices from the mesh
  28626. * @returns A nullable array of index arrays
  28627. */
  28628. getIndices?(): Nullable<IndicesArray>;
  28629. /**
  28630. * Gets the scene from the mesh
  28631. * @returns the indices array or null
  28632. */
  28633. getScene?(): Scene;
  28634. /**
  28635. * Gets the absolute position from the mesh
  28636. * @returns the absolute position
  28637. */
  28638. getAbsolutePosition(): Vector3;
  28639. /**
  28640. * Gets the absolute pivot point from the mesh
  28641. * @returns the absolute pivot point
  28642. */
  28643. getAbsolutePivotPoint(): Vector3;
  28644. /**
  28645. * Rotates the mesh
  28646. * @param axis The axis of rotation
  28647. * @param amount The amount of rotation
  28648. * @param space The space of the rotation
  28649. * @returns The rotation transform node
  28650. */
  28651. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  28652. /**
  28653. * Translates the mesh
  28654. * @param axis The axis of translation
  28655. * @param distance The distance of translation
  28656. * @param space The space of the translation
  28657. * @returns The transform node
  28658. */
  28659. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  28660. /**
  28661. * Sets the absolute position of the mesh
  28662. * @param absolutePosition The absolute position of the mesh
  28663. * @returns The transform node
  28664. */
  28665. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  28666. /**
  28667. * Gets the class name of the mesh
  28668. * @returns The class name
  28669. */
  28670. getClassName(): string;
  28671. }
  28672. /**
  28673. * Represents a physics imposter
  28674. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28675. */
  28676. export class PhysicsImpostor {
  28677. /**
  28678. * The physics-enabled object used as the physics imposter
  28679. */
  28680. object: IPhysicsEnabledObject;
  28681. /**
  28682. * The type of the physics imposter
  28683. */
  28684. type: number;
  28685. private _options;
  28686. private _scene?;
  28687. /**
  28688. * The default object size of the imposter
  28689. */
  28690. static DEFAULT_OBJECT_SIZE: Vector3;
  28691. /**
  28692. * The identity quaternion of the imposter
  28693. */
  28694. static IDENTITY_QUATERNION: Quaternion;
  28695. /** @hidden */
  28696. _pluginData: any;
  28697. private _physicsEngine;
  28698. private _physicsBody;
  28699. private _bodyUpdateRequired;
  28700. private _onBeforePhysicsStepCallbacks;
  28701. private _onAfterPhysicsStepCallbacks;
  28702. /** @hidden */
  28703. _onPhysicsCollideCallbacks: Array<{
  28704. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  28705. otherImpostors: Array<PhysicsImpostor>;
  28706. }>;
  28707. private _deltaPosition;
  28708. private _deltaRotation;
  28709. private _deltaRotationConjugated;
  28710. /** @hidden */
  28711. _isFromLine: boolean;
  28712. private _parent;
  28713. private _isDisposed;
  28714. private static _tmpVecs;
  28715. private static _tmpQuat;
  28716. /**
  28717. * Specifies if the physics imposter is disposed
  28718. */
  28719. get isDisposed(): boolean;
  28720. /**
  28721. * Gets the mass of the physics imposter
  28722. */
  28723. get mass(): number;
  28724. set mass(value: number);
  28725. /**
  28726. * Gets the coefficient of friction
  28727. */
  28728. get friction(): number;
  28729. /**
  28730. * Sets the coefficient of friction
  28731. */
  28732. set friction(value: number);
  28733. /**
  28734. * Gets the coefficient of restitution
  28735. */
  28736. get restitution(): number;
  28737. /**
  28738. * Sets the coefficient of restitution
  28739. */
  28740. set restitution(value: number);
  28741. /**
  28742. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  28743. */
  28744. get pressure(): number;
  28745. /**
  28746. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  28747. */
  28748. set pressure(value: number);
  28749. /**
  28750. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  28751. */
  28752. get stiffness(): number;
  28753. /**
  28754. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  28755. */
  28756. set stiffness(value: number);
  28757. /**
  28758. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  28759. */
  28760. get velocityIterations(): number;
  28761. /**
  28762. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  28763. */
  28764. set velocityIterations(value: number);
  28765. /**
  28766. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  28767. */
  28768. get positionIterations(): number;
  28769. /**
  28770. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  28771. */
  28772. set positionIterations(value: number);
  28773. /**
  28774. * The unique id of the physics imposter
  28775. * set by the physics engine when adding this impostor to the array
  28776. */
  28777. uniqueId: number;
  28778. /**
  28779. * @hidden
  28780. */
  28781. soft: boolean;
  28782. /**
  28783. * @hidden
  28784. */
  28785. segments: number;
  28786. private _joints;
  28787. /**
  28788. * Initializes the physics imposter
  28789. * @param object The physics-enabled object used as the physics imposter
  28790. * @param type The type of the physics imposter
  28791. * @param _options The options for the physics imposter
  28792. * @param _scene The Babylon scene
  28793. */
  28794. constructor(
  28795. /**
  28796. * The physics-enabled object used as the physics imposter
  28797. */
  28798. object: IPhysicsEnabledObject,
  28799. /**
  28800. * The type of the physics imposter
  28801. */
  28802. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  28803. /**
  28804. * This function will completly initialize this impostor.
  28805. * It will create a new body - but only if this mesh has no parent.
  28806. * If it has, this impostor will not be used other than to define the impostor
  28807. * of the child mesh.
  28808. * @hidden
  28809. */
  28810. _init(): void;
  28811. private _getPhysicsParent;
  28812. /**
  28813. * Should a new body be generated.
  28814. * @returns boolean specifying if body initialization is required
  28815. */
  28816. isBodyInitRequired(): boolean;
  28817. /**
  28818. * Sets the updated scaling
  28819. * @param updated Specifies if the scaling is updated
  28820. */
  28821. setScalingUpdated(): void;
  28822. /**
  28823. * Force a regeneration of this or the parent's impostor's body.
  28824. * Use under cautious - This will remove all joints already implemented.
  28825. */
  28826. forceUpdate(): void;
  28827. /**
  28828. * Gets the body that holds this impostor. Either its own, or its parent.
  28829. */
  28830. get physicsBody(): any;
  28831. /**
  28832. * Get the parent of the physics imposter
  28833. * @returns Physics imposter or null
  28834. */
  28835. get parent(): Nullable<PhysicsImpostor>;
  28836. /**
  28837. * Sets the parent of the physics imposter
  28838. */
  28839. set parent(value: Nullable<PhysicsImpostor>);
  28840. /**
  28841. * Set the physics body. Used mainly by the physics engine/plugin
  28842. */
  28843. set physicsBody(physicsBody: any);
  28844. /**
  28845. * Resets the update flags
  28846. */
  28847. resetUpdateFlags(): void;
  28848. /**
  28849. * Gets the object extend size
  28850. * @returns the object extend size
  28851. */
  28852. getObjectExtendSize(): Vector3;
  28853. /**
  28854. * Gets the object center
  28855. * @returns The object center
  28856. */
  28857. getObjectCenter(): Vector3;
  28858. /**
  28859. * Get a specific parameter from the options parameters
  28860. * @param paramName The object parameter name
  28861. * @returns The object parameter
  28862. */
  28863. getParam(paramName: string): any;
  28864. /**
  28865. * Sets a specific parameter in the options given to the physics plugin
  28866. * @param paramName The parameter name
  28867. * @param value The value of the parameter
  28868. */
  28869. setParam(paramName: string, value: number): void;
  28870. /**
  28871. * Specifically change the body's mass option. Won't recreate the physics body object
  28872. * @param mass The mass of the physics imposter
  28873. */
  28874. setMass(mass: number): void;
  28875. /**
  28876. * Gets the linear velocity
  28877. * @returns linear velocity or null
  28878. */
  28879. getLinearVelocity(): Nullable<Vector3>;
  28880. /**
  28881. * Sets the linear velocity
  28882. * @param velocity linear velocity or null
  28883. */
  28884. setLinearVelocity(velocity: Nullable<Vector3>): void;
  28885. /**
  28886. * Gets the angular velocity
  28887. * @returns angular velocity or null
  28888. */
  28889. getAngularVelocity(): Nullable<Vector3>;
  28890. /**
  28891. * Sets the angular velocity
  28892. * @param velocity The velocity or null
  28893. */
  28894. setAngularVelocity(velocity: Nullable<Vector3>): void;
  28895. /**
  28896. * Execute a function with the physics plugin native code
  28897. * Provide a function the will have two variables - the world object and the physics body object
  28898. * @param func The function to execute with the physics plugin native code
  28899. */
  28900. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  28901. /**
  28902. * Register a function that will be executed before the physics world is stepping forward
  28903. * @param func The function to execute before the physics world is stepped forward
  28904. */
  28905. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28906. /**
  28907. * Unregister a function that will be executed before the physics world is stepping forward
  28908. * @param func The function to execute before the physics world is stepped forward
  28909. */
  28910. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28911. /**
  28912. * Register a function that will be executed after the physics step
  28913. * @param func The function to execute after physics step
  28914. */
  28915. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28916. /**
  28917. * Unregisters a function that will be executed after the physics step
  28918. * @param func The function to execute after physics step
  28919. */
  28920. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28921. /**
  28922. * register a function that will be executed when this impostor collides against a different body
  28923. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  28924. * @param func Callback that is executed on collision
  28925. */
  28926. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  28927. /**
  28928. * Unregisters the physics imposter on contact
  28929. * @param collideAgainst The physics object to collide against
  28930. * @param func Callback to execute on collision
  28931. */
  28932. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  28933. private _tmpQuat;
  28934. private _tmpQuat2;
  28935. /**
  28936. * Get the parent rotation
  28937. * @returns The parent rotation
  28938. */
  28939. getParentsRotation(): Quaternion;
  28940. /**
  28941. * this function is executed by the physics engine.
  28942. */
  28943. beforeStep: () => void;
  28944. /**
  28945. * this function is executed by the physics engine
  28946. */
  28947. afterStep: () => void;
  28948. /**
  28949. * Legacy collision detection event support
  28950. */
  28951. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  28952. /**
  28953. * event and body object due to cannon's event-based architecture.
  28954. */
  28955. onCollide: (e: {
  28956. body: any;
  28957. }) => void;
  28958. /**
  28959. * Apply a force
  28960. * @param force The force to apply
  28961. * @param contactPoint The contact point for the force
  28962. * @returns The physics imposter
  28963. */
  28964. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  28965. /**
  28966. * Apply an impulse
  28967. * @param force The impulse force
  28968. * @param contactPoint The contact point for the impulse force
  28969. * @returns The physics imposter
  28970. */
  28971. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  28972. /**
  28973. * A help function to create a joint
  28974. * @param otherImpostor A physics imposter used to create a joint
  28975. * @param jointType The type of joint
  28976. * @param jointData The data for the joint
  28977. * @returns The physics imposter
  28978. */
  28979. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  28980. /**
  28981. * Add a joint to this impostor with a different impostor
  28982. * @param otherImpostor A physics imposter used to add a joint
  28983. * @param joint The joint to add
  28984. * @returns The physics imposter
  28985. */
  28986. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  28987. /**
  28988. * Add an anchor to a cloth impostor
  28989. * @param otherImpostor rigid impostor to anchor to
  28990. * @param width ratio across width from 0 to 1
  28991. * @param height ratio up height from 0 to 1
  28992. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  28993. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  28994. * @returns impostor the soft imposter
  28995. */
  28996. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  28997. /**
  28998. * Add a hook to a rope impostor
  28999. * @param otherImpostor rigid impostor to anchor to
  29000. * @param length ratio across rope from 0 to 1
  29001. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  29002. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  29003. * @returns impostor the rope imposter
  29004. */
  29005. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  29006. /**
  29007. * Will keep this body still, in a sleep mode.
  29008. * @returns the physics imposter
  29009. */
  29010. sleep(): PhysicsImpostor;
  29011. /**
  29012. * Wake the body up.
  29013. * @returns The physics imposter
  29014. */
  29015. wakeUp(): PhysicsImpostor;
  29016. /**
  29017. * Clones the physics imposter
  29018. * @param newObject The physics imposter clones to this physics-enabled object
  29019. * @returns A nullable physics imposter
  29020. */
  29021. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  29022. /**
  29023. * Disposes the physics imposter
  29024. */
  29025. dispose(): void;
  29026. /**
  29027. * Sets the delta position
  29028. * @param position The delta position amount
  29029. */
  29030. setDeltaPosition(position: Vector3): void;
  29031. /**
  29032. * Sets the delta rotation
  29033. * @param rotation The delta rotation amount
  29034. */
  29035. setDeltaRotation(rotation: Quaternion): void;
  29036. /**
  29037. * Gets the box size of the physics imposter and stores the result in the input parameter
  29038. * @param result Stores the box size
  29039. * @returns The physics imposter
  29040. */
  29041. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  29042. /**
  29043. * Gets the radius of the physics imposter
  29044. * @returns Radius of the physics imposter
  29045. */
  29046. getRadius(): number;
  29047. /**
  29048. * Sync a bone with this impostor
  29049. * @param bone The bone to sync to the impostor.
  29050. * @param boneMesh The mesh that the bone is influencing.
  29051. * @param jointPivot The pivot of the joint / bone in local space.
  29052. * @param distToJoint Optional distance from the impostor to the joint.
  29053. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  29054. */
  29055. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  29056. /**
  29057. * Sync impostor to a bone
  29058. * @param bone The bone that the impostor will be synced to.
  29059. * @param boneMesh The mesh that the bone is influencing.
  29060. * @param jointPivot The pivot of the joint / bone in local space.
  29061. * @param distToJoint Optional distance from the impostor to the joint.
  29062. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  29063. * @param boneAxis Optional vector3 axis the bone is aligned with
  29064. */
  29065. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  29066. /**
  29067. * No-Imposter type
  29068. */
  29069. static NoImpostor: number;
  29070. /**
  29071. * Sphere-Imposter type
  29072. */
  29073. static SphereImpostor: number;
  29074. /**
  29075. * Box-Imposter type
  29076. */
  29077. static BoxImpostor: number;
  29078. /**
  29079. * Plane-Imposter type
  29080. */
  29081. static PlaneImpostor: number;
  29082. /**
  29083. * Mesh-imposter type
  29084. */
  29085. static MeshImpostor: number;
  29086. /**
  29087. * Capsule-Impostor type (Ammo.js plugin only)
  29088. */
  29089. static CapsuleImpostor: number;
  29090. /**
  29091. * Cylinder-Imposter type
  29092. */
  29093. static CylinderImpostor: number;
  29094. /**
  29095. * Particle-Imposter type
  29096. */
  29097. static ParticleImpostor: number;
  29098. /**
  29099. * Heightmap-Imposter type
  29100. */
  29101. static HeightmapImpostor: number;
  29102. /**
  29103. * ConvexHull-Impostor type (Ammo.js plugin only)
  29104. */
  29105. static ConvexHullImpostor: number;
  29106. /**
  29107. * Custom-Imposter type (Ammo.js plugin only)
  29108. */
  29109. static CustomImpostor: number;
  29110. /**
  29111. * Rope-Imposter type
  29112. */
  29113. static RopeImpostor: number;
  29114. /**
  29115. * Cloth-Imposter type
  29116. */
  29117. static ClothImpostor: number;
  29118. /**
  29119. * Softbody-Imposter type
  29120. */
  29121. static SoftbodyImpostor: number;
  29122. }
  29123. }
  29124. declare module "babylonjs/Meshes/mesh" {
  29125. import { Observable } from "babylonjs/Misc/observable";
  29126. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  29127. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  29128. import { Camera } from "babylonjs/Cameras/camera";
  29129. import { Scene } from "babylonjs/scene";
  29130. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  29131. import { Color4 } from "babylonjs/Maths/math.color";
  29132. import { Engine } from "babylonjs/Engines/engine";
  29133. import { Node } from "babylonjs/node";
  29134. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  29135. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  29136. import { Buffer } from "babylonjs/Meshes/buffer";
  29137. import { Geometry } from "babylonjs/Meshes/geometry";
  29138. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  29139. import { SubMesh } from "babylonjs/Meshes/subMesh";
  29140. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  29141. import { Effect } from "babylonjs/Materials/effect";
  29142. import { Material } from "babylonjs/Materials/material";
  29143. import { Skeleton } from "babylonjs/Bones/skeleton";
  29144. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  29145. import { MeshLODLevel } from "babylonjs/Meshes/meshLODLevel";
  29146. import { Path3D } from "babylonjs/Maths/math.path";
  29147. import { Plane } from "babylonjs/Maths/math.plane";
  29148. import { TransformNode } from "babylonjs/Meshes/transformNode";
  29149. import { ICreateCapsuleOptions } from "babylonjs/Meshes/Builders/capsuleBuilder";
  29150. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  29151. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  29152. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  29153. import { IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  29154. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  29155. /**
  29156. * @hidden
  29157. **/
  29158. export class _CreationDataStorage {
  29159. closePath?: boolean;
  29160. closeArray?: boolean;
  29161. idx: number[];
  29162. dashSize: number;
  29163. gapSize: number;
  29164. path3D: Path3D;
  29165. pathArray: Vector3[][];
  29166. arc: number;
  29167. radius: number;
  29168. cap: number;
  29169. tessellation: number;
  29170. }
  29171. /**
  29172. * @hidden
  29173. **/
  29174. class _InstanceDataStorage {
  29175. visibleInstances: any;
  29176. batchCache: _InstancesBatch;
  29177. instancesBufferSize: number;
  29178. instancesBuffer: Nullable<Buffer>;
  29179. instancesData: Float32Array;
  29180. overridenInstanceCount: number;
  29181. isFrozen: boolean;
  29182. previousBatch: Nullable<_InstancesBatch>;
  29183. hardwareInstancedRendering: boolean;
  29184. sideOrientation: number;
  29185. manualUpdate: boolean;
  29186. previousRenderId: number;
  29187. }
  29188. /**
  29189. * @hidden
  29190. **/
  29191. export class _InstancesBatch {
  29192. mustReturn: boolean;
  29193. visibleInstances: Nullable<import("babylonjs/Meshes/instancedMesh").InstancedMesh[]>[];
  29194. renderSelf: boolean[];
  29195. hardwareInstancedRendering: boolean[];
  29196. }
  29197. /**
  29198. * @hidden
  29199. **/
  29200. class _ThinInstanceDataStorage {
  29201. instancesCount: number;
  29202. matrixBuffer: Nullable<Buffer>;
  29203. matrixBufferSize: number;
  29204. matrixData: Nullable<Float32Array>;
  29205. boundingVectors: Array<Vector3>;
  29206. worldMatrices: Nullable<Matrix[]>;
  29207. }
  29208. /**
  29209. * Class used to represent renderable models
  29210. */
  29211. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  29212. /**
  29213. * Mesh side orientation : usually the external or front surface
  29214. */
  29215. static readonly FRONTSIDE: number;
  29216. /**
  29217. * Mesh side orientation : usually the internal or back surface
  29218. */
  29219. static readonly BACKSIDE: number;
  29220. /**
  29221. * Mesh side orientation : both internal and external or front and back surfaces
  29222. */
  29223. static readonly DOUBLESIDE: number;
  29224. /**
  29225. * Mesh side orientation : by default, `FRONTSIDE`
  29226. */
  29227. static readonly DEFAULTSIDE: number;
  29228. /**
  29229. * Mesh cap setting : no cap
  29230. */
  29231. static readonly NO_CAP: number;
  29232. /**
  29233. * Mesh cap setting : one cap at the beginning of the mesh
  29234. */
  29235. static readonly CAP_START: number;
  29236. /**
  29237. * Mesh cap setting : one cap at the end of the mesh
  29238. */
  29239. static readonly CAP_END: number;
  29240. /**
  29241. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  29242. */
  29243. static readonly CAP_ALL: number;
  29244. /**
  29245. * Mesh pattern setting : no flip or rotate
  29246. */
  29247. static readonly NO_FLIP: number;
  29248. /**
  29249. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  29250. */
  29251. static readonly FLIP_TILE: number;
  29252. /**
  29253. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  29254. */
  29255. static readonly ROTATE_TILE: number;
  29256. /**
  29257. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  29258. */
  29259. static readonly FLIP_ROW: number;
  29260. /**
  29261. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  29262. */
  29263. static readonly ROTATE_ROW: number;
  29264. /**
  29265. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  29266. */
  29267. static readonly FLIP_N_ROTATE_TILE: number;
  29268. /**
  29269. * Mesh pattern setting : rotate pattern and rotate
  29270. */
  29271. static readonly FLIP_N_ROTATE_ROW: number;
  29272. /**
  29273. * Mesh tile positioning : part tiles same on left/right or top/bottom
  29274. */
  29275. static readonly CENTER: number;
  29276. /**
  29277. * Mesh tile positioning : part tiles on left
  29278. */
  29279. static readonly LEFT: number;
  29280. /**
  29281. * Mesh tile positioning : part tiles on right
  29282. */
  29283. static readonly RIGHT: number;
  29284. /**
  29285. * Mesh tile positioning : part tiles on top
  29286. */
  29287. static readonly TOP: number;
  29288. /**
  29289. * Mesh tile positioning : part tiles on bottom
  29290. */
  29291. static readonly BOTTOM: number;
  29292. /**
  29293. * Gets the default side orientation.
  29294. * @param orientation the orientation to value to attempt to get
  29295. * @returns the default orientation
  29296. * @hidden
  29297. */
  29298. static _GetDefaultSideOrientation(orientation?: number): number;
  29299. private _internalMeshDataInfo;
  29300. get computeBonesUsingShaders(): boolean;
  29301. set computeBonesUsingShaders(value: boolean);
  29302. /**
  29303. * An event triggered before rendering the mesh
  29304. */
  29305. get onBeforeRenderObservable(): Observable<Mesh>;
  29306. /**
  29307. * An event triggered before binding the mesh
  29308. */
  29309. get onBeforeBindObservable(): Observable<Mesh>;
  29310. /**
  29311. * An event triggered after rendering the mesh
  29312. */
  29313. get onAfterRenderObservable(): Observable<Mesh>;
  29314. /**
  29315. * An event triggered before drawing the mesh
  29316. */
  29317. get onBeforeDrawObservable(): Observable<Mesh>;
  29318. private _onBeforeDrawObserver;
  29319. /**
  29320. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  29321. */
  29322. set onBeforeDraw(callback: () => void);
  29323. get hasInstances(): boolean;
  29324. get hasThinInstances(): boolean;
  29325. /**
  29326. * Gets the delay loading state of the mesh (when delay loading is turned on)
  29327. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  29328. */
  29329. delayLoadState: number;
  29330. /**
  29331. * Gets the list of instances created from this mesh
  29332. * it is not supposed to be modified manually.
  29333. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  29334. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29335. */
  29336. instances: import("babylonjs/Meshes/instancedMesh").InstancedMesh[];
  29337. /**
  29338. * Gets the file containing delay loading data for this mesh
  29339. */
  29340. delayLoadingFile: string;
  29341. /** @hidden */
  29342. _binaryInfo: any;
  29343. /**
  29344. * User defined function used to change how LOD level selection is done
  29345. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29346. */
  29347. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  29348. /**
  29349. * Gets or sets the morph target manager
  29350. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  29351. */
  29352. get morphTargetManager(): Nullable<MorphTargetManager>;
  29353. set morphTargetManager(value: Nullable<MorphTargetManager>);
  29354. /** @hidden */
  29355. _creationDataStorage: Nullable<_CreationDataStorage>;
  29356. /** @hidden */
  29357. _geometry: Nullable<Geometry>;
  29358. /** @hidden */
  29359. _delayInfo: Array<string>;
  29360. /** @hidden */
  29361. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  29362. /** @hidden */
  29363. _instanceDataStorage: _InstanceDataStorage;
  29364. /** @hidden */
  29365. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  29366. private _effectiveMaterial;
  29367. /** @hidden */
  29368. _shouldGenerateFlatShading: boolean;
  29369. /** @hidden */
  29370. _originalBuilderSideOrientation: number;
  29371. /**
  29372. * Use this property to change the original side orientation defined at construction time
  29373. */
  29374. overrideMaterialSideOrientation: Nullable<number>;
  29375. /**
  29376. * Gets the source mesh (the one used to clone this one from)
  29377. */
  29378. get source(): Nullable<Mesh>;
  29379. /**
  29380. * Gets the list of clones of this mesh
  29381. * The scene must have been constructed with useClonedMeshMap=true for this to work!
  29382. * Note that useClonedMeshMap=true is the default setting
  29383. */
  29384. get cloneMeshMap(): Nullable<{
  29385. [id: string]: Mesh | undefined;
  29386. }>;
  29387. /**
  29388. * Gets or sets a boolean indicating that this mesh does not use index buffer
  29389. */
  29390. get isUnIndexed(): boolean;
  29391. set isUnIndexed(value: boolean);
  29392. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  29393. get worldMatrixInstancedBuffer(): Float32Array;
  29394. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  29395. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  29396. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  29397. /**
  29398. * @constructor
  29399. * @param name The value used by scene.getMeshByName() to do a lookup.
  29400. * @param scene The scene to add this mesh to.
  29401. * @param parent The parent of this mesh, if it has one
  29402. * @param source An optional Mesh from which geometry is shared, cloned.
  29403. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  29404. * When false, achieved by calling a clone(), also passing False.
  29405. * This will make creation of children, recursive.
  29406. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  29407. */
  29408. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  29409. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  29410. doNotInstantiate: boolean;
  29411. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  29412. /**
  29413. * Gets the class name
  29414. * @returns the string "Mesh".
  29415. */
  29416. getClassName(): string;
  29417. /** @hidden */
  29418. get _isMesh(): boolean;
  29419. /**
  29420. * Returns a description of this mesh
  29421. * @param fullDetails define if full details about this mesh must be used
  29422. * @returns a descriptive string representing this mesh
  29423. */
  29424. toString(fullDetails?: boolean): string;
  29425. /** @hidden */
  29426. _unBindEffect(): void;
  29427. /**
  29428. * Gets a boolean indicating if this mesh has LOD
  29429. */
  29430. get hasLODLevels(): boolean;
  29431. /**
  29432. * Gets the list of MeshLODLevel associated with the current mesh
  29433. * @returns an array of MeshLODLevel
  29434. */
  29435. getLODLevels(): MeshLODLevel[];
  29436. private _sortLODLevels;
  29437. /**
  29438. * Add a mesh as LOD level triggered at the given distance.
  29439. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29440. * @param distance The distance from the center of the object to show this level
  29441. * @param mesh The mesh to be added as LOD level (can be null)
  29442. * @return This mesh (for chaining)
  29443. */
  29444. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  29445. /**
  29446. * Returns the LOD level mesh at the passed distance or null if not found.
  29447. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29448. * @param distance The distance from the center of the object to show this level
  29449. * @returns a Mesh or `null`
  29450. */
  29451. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  29452. /**
  29453. * Remove a mesh from the LOD array
  29454. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29455. * @param mesh defines the mesh to be removed
  29456. * @return This mesh (for chaining)
  29457. */
  29458. removeLODLevel(mesh: Mesh): Mesh;
  29459. /**
  29460. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  29461. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29462. * @param camera defines the camera to use to compute distance
  29463. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  29464. * @return This mesh (for chaining)
  29465. */
  29466. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  29467. /**
  29468. * Gets the mesh internal Geometry object
  29469. */
  29470. get geometry(): Nullable<Geometry>;
  29471. /**
  29472. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  29473. * @returns the total number of vertices
  29474. */
  29475. getTotalVertices(): number;
  29476. /**
  29477. * Returns the content of an associated vertex buffer
  29478. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29479. * - VertexBuffer.PositionKind
  29480. * - VertexBuffer.UVKind
  29481. * - VertexBuffer.UV2Kind
  29482. * - VertexBuffer.UV3Kind
  29483. * - VertexBuffer.UV4Kind
  29484. * - VertexBuffer.UV5Kind
  29485. * - VertexBuffer.UV6Kind
  29486. * - VertexBuffer.ColorKind
  29487. * - VertexBuffer.MatricesIndicesKind
  29488. * - VertexBuffer.MatricesIndicesExtraKind
  29489. * - VertexBuffer.MatricesWeightsKind
  29490. * - VertexBuffer.MatricesWeightsExtraKind
  29491. * @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
  29492. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  29493. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  29494. */
  29495. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  29496. /**
  29497. * Returns the mesh VertexBuffer object from the requested `kind`
  29498. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29499. * - VertexBuffer.PositionKind
  29500. * - VertexBuffer.NormalKind
  29501. * - VertexBuffer.UVKind
  29502. * - VertexBuffer.UV2Kind
  29503. * - VertexBuffer.UV3Kind
  29504. * - VertexBuffer.UV4Kind
  29505. * - VertexBuffer.UV5Kind
  29506. * - VertexBuffer.UV6Kind
  29507. * - VertexBuffer.ColorKind
  29508. * - VertexBuffer.MatricesIndicesKind
  29509. * - VertexBuffer.MatricesIndicesExtraKind
  29510. * - VertexBuffer.MatricesWeightsKind
  29511. * - VertexBuffer.MatricesWeightsExtraKind
  29512. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  29513. */
  29514. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  29515. /**
  29516. * Tests if a specific vertex buffer is associated with this mesh
  29517. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29518. * - VertexBuffer.PositionKind
  29519. * - VertexBuffer.NormalKind
  29520. * - VertexBuffer.UVKind
  29521. * - VertexBuffer.UV2Kind
  29522. * - VertexBuffer.UV3Kind
  29523. * - VertexBuffer.UV4Kind
  29524. * - VertexBuffer.UV5Kind
  29525. * - VertexBuffer.UV6Kind
  29526. * - VertexBuffer.ColorKind
  29527. * - VertexBuffer.MatricesIndicesKind
  29528. * - VertexBuffer.MatricesIndicesExtraKind
  29529. * - VertexBuffer.MatricesWeightsKind
  29530. * - VertexBuffer.MatricesWeightsExtraKind
  29531. * @returns a boolean
  29532. */
  29533. isVerticesDataPresent(kind: string): boolean;
  29534. /**
  29535. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  29536. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29537. * - VertexBuffer.PositionKind
  29538. * - VertexBuffer.UVKind
  29539. * - VertexBuffer.UV2Kind
  29540. * - VertexBuffer.UV3Kind
  29541. * - VertexBuffer.UV4Kind
  29542. * - VertexBuffer.UV5Kind
  29543. * - VertexBuffer.UV6Kind
  29544. * - VertexBuffer.ColorKind
  29545. * - VertexBuffer.MatricesIndicesKind
  29546. * - VertexBuffer.MatricesIndicesExtraKind
  29547. * - VertexBuffer.MatricesWeightsKind
  29548. * - VertexBuffer.MatricesWeightsExtraKind
  29549. * @returns a boolean
  29550. */
  29551. isVertexBufferUpdatable(kind: string): boolean;
  29552. /**
  29553. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  29554. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29555. * - VertexBuffer.PositionKind
  29556. * - VertexBuffer.NormalKind
  29557. * - VertexBuffer.UVKind
  29558. * - VertexBuffer.UV2Kind
  29559. * - VertexBuffer.UV3Kind
  29560. * - VertexBuffer.UV4Kind
  29561. * - VertexBuffer.UV5Kind
  29562. * - VertexBuffer.UV6Kind
  29563. * - VertexBuffer.ColorKind
  29564. * - VertexBuffer.MatricesIndicesKind
  29565. * - VertexBuffer.MatricesIndicesExtraKind
  29566. * - VertexBuffer.MatricesWeightsKind
  29567. * - VertexBuffer.MatricesWeightsExtraKind
  29568. * @returns an array of strings
  29569. */
  29570. getVerticesDataKinds(): string[];
  29571. /**
  29572. * Returns a positive integer : the total number of indices in this mesh geometry.
  29573. * @returns the numner of indices or zero if the mesh has no geometry.
  29574. */
  29575. getTotalIndices(): number;
  29576. /**
  29577. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  29578. * @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.
  29579. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  29580. * @returns the indices array or an empty array if the mesh has no geometry
  29581. */
  29582. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  29583. get isBlocked(): boolean;
  29584. /**
  29585. * Determine if the current mesh is ready to be rendered
  29586. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  29587. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  29588. * @returns true if all associated assets are ready (material, textures, shaders)
  29589. */
  29590. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  29591. /**
  29592. * 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.
  29593. */
  29594. get areNormalsFrozen(): boolean;
  29595. /**
  29596. * 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.
  29597. * @returns the current mesh
  29598. */
  29599. freezeNormals(): Mesh;
  29600. /**
  29601. * 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
  29602. * @returns the current mesh
  29603. */
  29604. unfreezeNormals(): Mesh;
  29605. /**
  29606. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  29607. */
  29608. set overridenInstanceCount(count: number);
  29609. /** @hidden */
  29610. _preActivate(): Mesh;
  29611. /** @hidden */
  29612. _preActivateForIntermediateRendering(renderId: number): Mesh;
  29613. /** @hidden */
  29614. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  29615. protected _afterComputeWorldMatrix(): void;
  29616. /** @hidden */
  29617. _postActivate(): void;
  29618. /**
  29619. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  29620. * This means the mesh underlying bounding box and sphere are recomputed.
  29621. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  29622. * @returns the current mesh
  29623. */
  29624. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  29625. /** @hidden */
  29626. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  29627. /**
  29628. * This function will subdivide the mesh into multiple submeshes
  29629. * @param count defines the expected number of submeshes
  29630. */
  29631. subdivide(count: number): void;
  29632. /**
  29633. * Copy a FloatArray into a specific associated vertex buffer
  29634. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29635. * - VertexBuffer.PositionKind
  29636. * - VertexBuffer.UVKind
  29637. * - VertexBuffer.UV2Kind
  29638. * - VertexBuffer.UV3Kind
  29639. * - VertexBuffer.UV4Kind
  29640. * - VertexBuffer.UV5Kind
  29641. * - VertexBuffer.UV6Kind
  29642. * - VertexBuffer.ColorKind
  29643. * - VertexBuffer.MatricesIndicesKind
  29644. * - VertexBuffer.MatricesIndicesExtraKind
  29645. * - VertexBuffer.MatricesWeightsKind
  29646. * - VertexBuffer.MatricesWeightsExtraKind
  29647. * @param data defines the data source
  29648. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29649. * @param stride defines the data stride size (can be null)
  29650. * @returns the current mesh
  29651. */
  29652. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  29653. /**
  29654. * Delete a vertex buffer associated with this mesh
  29655. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  29656. * - VertexBuffer.PositionKind
  29657. * - VertexBuffer.UVKind
  29658. * - VertexBuffer.UV2Kind
  29659. * - VertexBuffer.UV3Kind
  29660. * - VertexBuffer.UV4Kind
  29661. * - VertexBuffer.UV5Kind
  29662. * - VertexBuffer.UV6Kind
  29663. * - VertexBuffer.ColorKind
  29664. * - VertexBuffer.MatricesIndicesKind
  29665. * - VertexBuffer.MatricesIndicesExtraKind
  29666. * - VertexBuffer.MatricesWeightsKind
  29667. * - VertexBuffer.MatricesWeightsExtraKind
  29668. */
  29669. removeVerticesData(kind: string): void;
  29670. /**
  29671. * Flags an associated vertex buffer as updatable
  29672. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  29673. * - VertexBuffer.PositionKind
  29674. * - VertexBuffer.UVKind
  29675. * - VertexBuffer.UV2Kind
  29676. * - VertexBuffer.UV3Kind
  29677. * - VertexBuffer.UV4Kind
  29678. * - VertexBuffer.UV5Kind
  29679. * - VertexBuffer.UV6Kind
  29680. * - VertexBuffer.ColorKind
  29681. * - VertexBuffer.MatricesIndicesKind
  29682. * - VertexBuffer.MatricesIndicesExtraKind
  29683. * - VertexBuffer.MatricesWeightsKind
  29684. * - VertexBuffer.MatricesWeightsExtraKind
  29685. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29686. */
  29687. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  29688. /**
  29689. * Sets the mesh global Vertex Buffer
  29690. * @param buffer defines the buffer to use
  29691. * @returns the current mesh
  29692. */
  29693. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  29694. /**
  29695. * Update a specific associated vertex buffer
  29696. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29697. * - VertexBuffer.PositionKind
  29698. * - VertexBuffer.UVKind
  29699. * - VertexBuffer.UV2Kind
  29700. * - VertexBuffer.UV3Kind
  29701. * - VertexBuffer.UV4Kind
  29702. * - VertexBuffer.UV5Kind
  29703. * - VertexBuffer.UV6Kind
  29704. * - VertexBuffer.ColorKind
  29705. * - VertexBuffer.MatricesIndicesKind
  29706. * - VertexBuffer.MatricesIndicesExtraKind
  29707. * - VertexBuffer.MatricesWeightsKind
  29708. * - VertexBuffer.MatricesWeightsExtraKind
  29709. * @param data defines the data source
  29710. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  29711. * @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)
  29712. * @returns the current mesh
  29713. */
  29714. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  29715. /**
  29716. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  29717. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  29718. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  29719. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  29720. * @returns the current mesh
  29721. */
  29722. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  29723. /**
  29724. * Creates a un-shared specific occurence of the geometry for the mesh.
  29725. * @returns the current mesh
  29726. */
  29727. makeGeometryUnique(): Mesh;
  29728. /**
  29729. * Set the index buffer of this mesh
  29730. * @param indices defines the source data
  29731. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  29732. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  29733. * @returns the current mesh
  29734. */
  29735. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  29736. /**
  29737. * Update the current index buffer
  29738. * @param indices defines the source data
  29739. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  29740. * @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)
  29741. * @returns the current mesh
  29742. */
  29743. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  29744. /**
  29745. * Invert the geometry to move from a right handed system to a left handed one.
  29746. * @returns the current mesh
  29747. */
  29748. toLeftHanded(): Mesh;
  29749. /** @hidden */
  29750. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  29751. /** @hidden */
  29752. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  29753. /**
  29754. * Registers for this mesh a javascript function called just before the rendering process
  29755. * @param func defines the function to call before rendering this mesh
  29756. * @returns the current mesh
  29757. */
  29758. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29759. /**
  29760. * Disposes a previously registered javascript function called before the rendering
  29761. * @param func defines the function to remove
  29762. * @returns the current mesh
  29763. */
  29764. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29765. /**
  29766. * Registers for this mesh a javascript function called just after the rendering is complete
  29767. * @param func defines the function to call after rendering this mesh
  29768. * @returns the current mesh
  29769. */
  29770. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29771. /**
  29772. * Disposes a previously registered javascript function called after the rendering.
  29773. * @param func defines the function to remove
  29774. * @returns the current mesh
  29775. */
  29776. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29777. /** @hidden */
  29778. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  29779. /** @hidden */
  29780. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  29781. /** @hidden */
  29782. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  29783. /** @hidden */
  29784. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  29785. /** @hidden */
  29786. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  29787. /** @hidden */
  29788. _rebuild(): void;
  29789. /** @hidden */
  29790. _freeze(): void;
  29791. /** @hidden */
  29792. _unFreeze(): void;
  29793. /**
  29794. * 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
  29795. * @param subMesh defines the subMesh to render
  29796. * @param enableAlphaMode defines if alpha mode can be changed
  29797. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  29798. * @returns the current mesh
  29799. */
  29800. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  29801. private _onBeforeDraw;
  29802. /**
  29803. * Renormalize the mesh and patch it up if there are no weights
  29804. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  29805. * However in the case of zero weights then we set just a single influence to 1.
  29806. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  29807. */
  29808. cleanMatrixWeights(): void;
  29809. private normalizeSkinFourWeights;
  29810. private normalizeSkinWeightsAndExtra;
  29811. /**
  29812. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  29813. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  29814. * the user know there was an issue with importing the mesh
  29815. * @returns a validation object with skinned, valid and report string
  29816. */
  29817. validateSkinning(): {
  29818. skinned: boolean;
  29819. valid: boolean;
  29820. report: string;
  29821. };
  29822. /** @hidden */
  29823. _checkDelayState(): Mesh;
  29824. private _queueLoad;
  29825. /**
  29826. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  29827. * A mesh is in the frustum if its bounding box intersects the frustum
  29828. * @param frustumPlanes defines the frustum to test
  29829. * @returns true if the mesh is in the frustum planes
  29830. */
  29831. isInFrustum(frustumPlanes: Plane[]): boolean;
  29832. /**
  29833. * Sets the mesh material by the material or multiMaterial `id` property
  29834. * @param id is a string identifying the material or the multiMaterial
  29835. * @returns the current mesh
  29836. */
  29837. setMaterialByID(id: string): Mesh;
  29838. /**
  29839. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  29840. * @returns an array of IAnimatable
  29841. */
  29842. getAnimatables(): IAnimatable[];
  29843. /**
  29844. * Modifies the mesh geometry according to the passed transformation matrix.
  29845. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  29846. * The mesh normals are modified using the same transformation.
  29847. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29848. * @param transform defines the transform matrix to use
  29849. * @see https://doc.babylonjs.com/resources/baking_transformations
  29850. * @returns the current mesh
  29851. */
  29852. bakeTransformIntoVertices(transform: Matrix): Mesh;
  29853. /**
  29854. * Modifies the mesh geometry according to its own current World Matrix.
  29855. * The mesh World Matrix is then reset.
  29856. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  29857. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29858. * @see https://doc.babylonjs.com/resources/baking_transformations
  29859. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  29860. * @returns the current mesh
  29861. */
  29862. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  29863. /** @hidden */
  29864. get _positions(): Nullable<Vector3[]>;
  29865. /** @hidden */
  29866. _resetPointsArrayCache(): Mesh;
  29867. /** @hidden */
  29868. _generatePointsArray(): boolean;
  29869. /**
  29870. * Returns a new Mesh object generated from the current mesh properties.
  29871. * This method must not get confused with createInstance()
  29872. * @param name is a string, the name given to the new mesh
  29873. * @param newParent can be any Node object (default `null`)
  29874. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  29875. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  29876. * @returns a new mesh
  29877. */
  29878. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  29879. /**
  29880. * Releases resources associated with this mesh.
  29881. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  29882. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  29883. */
  29884. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  29885. /** @hidden */
  29886. _disposeInstanceSpecificData(): void;
  29887. /** @hidden */
  29888. _disposeThinInstanceSpecificData(): void;
  29889. /**
  29890. * Modifies the mesh geometry according to a displacement map.
  29891. * 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.
  29892. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29893. * @param url is a string, the URL from the image file is to be downloaded.
  29894. * @param minHeight is the lower limit of the displacement.
  29895. * @param maxHeight is the upper limit of the displacement.
  29896. * @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.
  29897. * @param uvOffset is an optional vector2 used to offset UV.
  29898. * @param uvScale is an optional vector2 used to scale UV.
  29899. * @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.
  29900. * @returns the Mesh.
  29901. */
  29902. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29903. /**
  29904. * Modifies the mesh geometry according to a displacementMap buffer.
  29905. * 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.
  29906. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29907. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  29908. * @param heightMapWidth is the width of the buffer image.
  29909. * @param heightMapHeight is the height of the buffer image.
  29910. * @param minHeight is the lower limit of the displacement.
  29911. * @param maxHeight is the upper limit of the displacement.
  29912. * @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.
  29913. * @param uvOffset is an optional vector2 used to offset UV.
  29914. * @param uvScale is an optional vector2 used to scale UV.
  29915. * @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.
  29916. * @returns the Mesh.
  29917. */
  29918. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29919. /**
  29920. * Modify the mesh to get a flat shading rendering.
  29921. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  29922. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  29923. * @returns current mesh
  29924. */
  29925. convertToFlatShadedMesh(): Mesh;
  29926. /**
  29927. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  29928. * In other words, more vertices, no more indices and a single bigger VBO.
  29929. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  29930. * @returns current mesh
  29931. */
  29932. convertToUnIndexedMesh(): Mesh;
  29933. /**
  29934. * Inverses facet orientations.
  29935. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29936. * @param flipNormals will also inverts the normals
  29937. * @returns current mesh
  29938. */
  29939. flipFaces(flipNormals?: boolean): Mesh;
  29940. /**
  29941. * Increase the number of facets and hence vertices in a mesh
  29942. * Vertex normals are interpolated from existing vertex normals
  29943. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29944. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  29945. */
  29946. increaseVertices(numberPerEdge: number): void;
  29947. /**
  29948. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  29949. * This will undo any application of covertToFlatShadedMesh
  29950. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29951. */
  29952. forceSharedVertices(): void;
  29953. /** @hidden */
  29954. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  29955. /** @hidden */
  29956. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  29957. /**
  29958. * Creates a new InstancedMesh object from the mesh model.
  29959. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29960. * @param name defines the name of the new instance
  29961. * @returns a new InstancedMesh
  29962. */
  29963. createInstance(name: string): InstancedMesh;
  29964. /**
  29965. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  29966. * After this call, all the mesh instances have the same submeshes than the current mesh.
  29967. * @returns the current mesh
  29968. */
  29969. synchronizeInstances(): Mesh;
  29970. /**
  29971. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  29972. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  29973. * This should be used together with the simplification to avoid disappearing triangles.
  29974. * @param successCallback an optional success callback to be called after the optimization finished.
  29975. * @returns the current mesh
  29976. */
  29977. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  29978. /**
  29979. * Serialize current mesh
  29980. * @param serializationObject defines the object which will receive the serialization data
  29981. */
  29982. serialize(serializationObject: any): void;
  29983. /** @hidden */
  29984. _syncGeometryWithMorphTargetManager(): void;
  29985. /** @hidden */
  29986. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  29987. /**
  29988. * Returns a new Mesh object parsed from the source provided.
  29989. * @param parsedMesh is the source
  29990. * @param scene defines the hosting scene
  29991. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  29992. * @returns a new Mesh
  29993. */
  29994. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  29995. /**
  29996. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  29997. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  29998. * @param name defines the name of the mesh to create
  29999. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  30000. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  30001. * @param closePath creates a seam between the first and the last points of each path of the path array
  30002. * @param offset is taken in account only if the `pathArray` is containing a single path
  30003. * @param scene defines the hosting scene
  30004. * @param updatable defines if the mesh must be flagged as updatable
  30005. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30006. * @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)
  30007. * @returns a new Mesh
  30008. */
  30009. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30010. /**
  30011. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  30012. * @param name defines the name of the mesh to create
  30013. * @param radius sets the radius size (float) of the polygon (default 0.5)
  30014. * @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
  30015. * @param scene defines the hosting scene
  30016. * @param updatable defines if the mesh must be flagged as updatable
  30017. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30018. * @returns a new Mesh
  30019. */
  30020. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  30021. /**
  30022. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  30023. * @param name defines the name of the mesh to create
  30024. * @param size sets the size (float) of each box side (default 1)
  30025. * @param scene defines the hosting scene
  30026. * @param updatable defines if the mesh must be flagged as updatable
  30027. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30028. * @returns a new Mesh
  30029. */
  30030. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  30031. /**
  30032. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  30033. * @param name defines the name of the mesh to create
  30034. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  30035. * @param diameter sets the diameter size (float) of the sphere (default 1)
  30036. * @param scene defines the hosting scene
  30037. * @param updatable defines if the mesh must be flagged as updatable
  30038. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30039. * @returns a new Mesh
  30040. */
  30041. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30042. /**
  30043. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  30044. * @param name defines the name of the mesh to create
  30045. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  30046. * @param diameter sets the diameter size (float) of the sphere (default 1)
  30047. * @param scene defines the hosting scene
  30048. * @returns a new Mesh
  30049. */
  30050. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  30051. /**
  30052. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  30053. * @param name defines the name of the mesh to create
  30054. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  30055. * @param diameterTop set the top cap diameter (floats, default 1)
  30056. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  30057. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  30058. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  30059. * @param scene defines the hosting scene
  30060. * @param updatable defines if the mesh must be flagged as updatable
  30061. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30062. * @returns a new Mesh
  30063. */
  30064. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  30065. /**
  30066. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  30067. * @param name defines the name of the mesh to create
  30068. * @param diameter sets the diameter size (float) of the torus (default 1)
  30069. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  30070. * @param tessellation sets the number of torus sides (postive integer, default 16)
  30071. * @param scene defines the hosting scene
  30072. * @param updatable defines if the mesh must be flagged as updatable
  30073. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30074. * @returns a new Mesh
  30075. */
  30076. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30077. /**
  30078. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  30079. * @param name defines the name of the mesh to create
  30080. * @param radius sets the global radius size (float) of the torus knot (default 2)
  30081. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  30082. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  30083. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  30084. * @param p the number of windings on X axis (positive integers, default 2)
  30085. * @param q the number of windings on Y axis (positive integers, default 3)
  30086. * @param scene defines the hosting scene
  30087. * @param updatable defines if the mesh must be flagged as updatable
  30088. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30089. * @returns a new Mesh
  30090. */
  30091. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30092. /**
  30093. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  30094. * @param name defines the name of the mesh to create
  30095. * @param points is an array successive Vector3
  30096. * @param scene defines the hosting scene
  30097. * @param updatable defines if the mesh must be flagged as updatable
  30098. * @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).
  30099. * @returns a new Mesh
  30100. */
  30101. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  30102. /**
  30103. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  30104. * @param name defines the name of the mesh to create
  30105. * @param points is an array successive Vector3
  30106. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  30107. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  30108. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  30109. * @param scene defines the hosting scene
  30110. * @param updatable defines if the mesh must be flagged as updatable
  30111. * @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)
  30112. * @returns a new Mesh
  30113. */
  30114. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  30115. /**
  30116. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  30117. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  30118. * 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.
  30119. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30120. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  30121. * Remember you can only change the shape positions, not their number when updating a polygon.
  30122. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  30123. * @param name defines the name of the mesh to create
  30124. * @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
  30125. * @param scene defines the hosting scene
  30126. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  30127. * @param updatable defines if the mesh must be flagged as updatable
  30128. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30129. * @param earcutInjection can be used to inject your own earcut reference
  30130. * @returns a new Mesh
  30131. */
  30132. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  30133. /**
  30134. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  30135. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  30136. * @param name defines the name of the mesh to create
  30137. * @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
  30138. * @param depth defines the height of extrusion
  30139. * @param scene defines the hosting scene
  30140. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  30141. * @param updatable defines if the mesh must be flagged as updatable
  30142. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30143. * @param earcutInjection can be used to inject your own earcut reference
  30144. * @returns a new Mesh
  30145. */
  30146. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  30147. /**
  30148. * Creates an extruded shape mesh.
  30149. * 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
  30150. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  30151. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  30152. * @param name defines the name of the mesh to create
  30153. * @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
  30154. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  30155. * @param scale is the value to scale the shape
  30156. * @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
  30157. * @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
  30158. * @param scene defines the hosting scene
  30159. * @param updatable defines if the mesh must be flagged as updatable
  30160. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30161. * @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)
  30162. * @returns a new Mesh
  30163. */
  30164. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30165. /**
  30166. * Creates an custom extruded shape mesh.
  30167. * The custom extrusion is a parametric shape.
  30168. * It has no predefined shape. Its final shape will depend on the input parameters.
  30169. * Please consider using the same method from the MeshBuilder class instead
  30170. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  30171. * @param name defines the name of the mesh to create
  30172. * @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
  30173. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  30174. * @param scaleFunction is a custom Javascript function called on each path point
  30175. * @param rotationFunction is a custom Javascript function called on each path point
  30176. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  30177. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  30178. * @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
  30179. * @param scene defines the hosting scene
  30180. * @param updatable defines if the mesh must be flagged as updatable
  30181. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30182. * @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)
  30183. * @returns a new Mesh
  30184. */
  30185. 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;
  30186. /**
  30187. * Creates lathe mesh.
  30188. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  30189. * Please consider using the same method from the MeshBuilder class instead
  30190. * @param name defines the name of the mesh to create
  30191. * @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
  30192. * @param radius is the radius value of the lathe
  30193. * @param tessellation is the side number of the lathe.
  30194. * @param scene defines the hosting scene
  30195. * @param updatable defines if the mesh must be flagged as updatable
  30196. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30197. * @returns a new Mesh
  30198. */
  30199. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30200. /**
  30201. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  30202. * @param name defines the name of the mesh to create
  30203. * @param size sets the size (float) of both sides of the plane at once (default 1)
  30204. * @param scene defines the hosting scene
  30205. * @param updatable defines if the mesh must be flagged as updatable
  30206. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30207. * @returns a new Mesh
  30208. */
  30209. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30210. /**
  30211. * Creates a ground mesh.
  30212. * Please consider using the same method from the MeshBuilder class instead
  30213. * @param name defines the name of the mesh to create
  30214. * @param width set the width of the ground
  30215. * @param height set the height of the ground
  30216. * @param subdivisions sets the number of subdivisions per side
  30217. * @param scene defines the hosting scene
  30218. * @param updatable defines if the mesh must be flagged as updatable
  30219. * @returns a new Mesh
  30220. */
  30221. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  30222. /**
  30223. * Creates a tiled ground mesh.
  30224. * Please consider using the same method from the MeshBuilder class instead
  30225. * @param name defines the name of the mesh to create
  30226. * @param xmin set the ground minimum X coordinate
  30227. * @param zmin set the ground minimum Y coordinate
  30228. * @param xmax set the ground maximum X coordinate
  30229. * @param zmax set the ground maximum Z coordinate
  30230. * @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
  30231. * @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
  30232. * @param scene defines the hosting scene
  30233. * @param updatable defines if the mesh must be flagged as updatable
  30234. * @returns a new Mesh
  30235. */
  30236. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  30237. w: number;
  30238. h: number;
  30239. }, precision: {
  30240. w: number;
  30241. h: number;
  30242. }, scene: Scene, updatable?: boolean): Mesh;
  30243. /**
  30244. * Creates a ground mesh from a height map.
  30245. * Please consider using the same method from the MeshBuilder class instead
  30246. * @see https://doc.babylonjs.com/babylon101/height_map
  30247. * @param name defines the name of the mesh to create
  30248. * @param url sets the URL of the height map image resource
  30249. * @param width set the ground width size
  30250. * @param height set the ground height size
  30251. * @param subdivisions sets the number of subdivision per side
  30252. * @param minHeight is the minimum altitude on the ground
  30253. * @param maxHeight is the maximum altitude on the ground
  30254. * @param scene defines the hosting scene
  30255. * @param updatable defines if the mesh must be flagged as updatable
  30256. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  30257. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  30258. * @returns a new Mesh
  30259. */
  30260. 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;
  30261. /**
  30262. * Creates a tube mesh.
  30263. * The tube is a parametric shape.
  30264. * It has no predefined shape. Its final shape will depend on the input parameters.
  30265. * Please consider using the same method from the MeshBuilder class instead
  30266. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  30267. * @param name defines the name of the mesh to create
  30268. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  30269. * @param radius sets the tube radius size
  30270. * @param tessellation is the number of sides on the tubular surface
  30271. * @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
  30272. * @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
  30273. * @param scene defines the hosting scene
  30274. * @param updatable defines if the mesh must be flagged as updatable
  30275. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30276. * @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)
  30277. * @returns a new Mesh
  30278. */
  30279. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  30280. (i: number, distance: number): number;
  30281. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30282. /**
  30283. * Creates a polyhedron mesh.
  30284. * Please consider using the same method from the MeshBuilder class instead.
  30285. * * 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
  30286. * * The parameter `size` (positive float, default 1) sets the polygon size
  30287. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  30288. * * 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`
  30289. * * 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
  30290. * * 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)`)
  30291. * * 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
  30292. * * 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
  30293. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30294. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30295. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30296. * @param name defines the name of the mesh to create
  30297. * @param options defines the options used to create the mesh
  30298. * @param scene defines the hosting scene
  30299. * @returns a new Mesh
  30300. */
  30301. static CreatePolyhedron(name: string, options: {
  30302. type?: number;
  30303. size?: number;
  30304. sizeX?: number;
  30305. sizeY?: number;
  30306. sizeZ?: number;
  30307. custom?: any;
  30308. faceUV?: Vector4[];
  30309. faceColors?: Color4[];
  30310. updatable?: boolean;
  30311. sideOrientation?: number;
  30312. }, scene: Scene): Mesh;
  30313. /**
  30314. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  30315. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  30316. * * 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`)
  30317. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  30318. * * 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
  30319. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30320. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30321. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30322. * @param name defines the name of the mesh
  30323. * @param options defines the options used to create the mesh
  30324. * @param scene defines the hosting scene
  30325. * @returns a new Mesh
  30326. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  30327. */
  30328. static CreateIcoSphere(name: string, options: {
  30329. radius?: number;
  30330. flat?: boolean;
  30331. subdivisions?: number;
  30332. sideOrientation?: number;
  30333. updatable?: boolean;
  30334. }, scene: Scene): Mesh;
  30335. /**
  30336. * Creates a decal mesh.
  30337. * Please consider using the same method from the MeshBuilder class instead.
  30338. * A decal is a mesh usually applied as a model onto the surface of another mesh
  30339. * @param name defines the name of the mesh
  30340. * @param sourceMesh defines the mesh receiving the decal
  30341. * @param position sets the position of the decal in world coordinates
  30342. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  30343. * @param size sets the decal scaling
  30344. * @param angle sets the angle to rotate the decal
  30345. * @returns a new Mesh
  30346. */
  30347. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  30348. /** Creates a Capsule Mesh
  30349. * @param name defines the name of the mesh.
  30350. * @param options the constructors options used to shape the mesh.
  30351. * @param scene defines the scene the mesh is scoped to.
  30352. * @returns the capsule mesh
  30353. * @see https://doc.babylonjs.com/how_to/capsule_shape
  30354. */
  30355. static CreateCapsule(name: string, options: ICreateCapsuleOptions, scene: Scene): Mesh;
  30356. /**
  30357. * Prepare internal position array for software CPU skinning
  30358. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  30359. */
  30360. setPositionsForCPUSkinning(): Float32Array;
  30361. /**
  30362. * Prepare internal normal array for software CPU skinning
  30363. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  30364. */
  30365. setNormalsForCPUSkinning(): Float32Array;
  30366. /**
  30367. * Updates the vertex buffer by applying transformation from the bones
  30368. * @param skeleton defines the skeleton to apply to current mesh
  30369. * @returns the current mesh
  30370. */
  30371. applySkeleton(skeleton: Skeleton): Mesh;
  30372. /**
  30373. * 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
  30374. * @param meshes defines the list of meshes to scan
  30375. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  30376. */
  30377. static MinMax(meshes: AbstractMesh[]): {
  30378. min: Vector3;
  30379. max: Vector3;
  30380. };
  30381. /**
  30382. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  30383. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  30384. * @returns a vector3
  30385. */
  30386. static Center(meshesOrMinMaxVector: {
  30387. min: Vector3;
  30388. max: Vector3;
  30389. } | AbstractMesh[]): Vector3;
  30390. /**
  30391. * Merge the array of meshes into a single mesh for performance reasons.
  30392. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  30393. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  30394. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  30395. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  30396. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  30397. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  30398. * @returns a new mesh
  30399. */
  30400. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  30401. /** @hidden */
  30402. addInstance(instance: InstancedMesh): void;
  30403. /** @hidden */
  30404. removeInstance(instance: InstancedMesh): void;
  30405. }
  30406. }
  30407. declare module "babylonjs/Cameras/camera" {
  30408. import { SmartArray } from "babylonjs/Misc/smartArray";
  30409. import { Observable } from "babylonjs/Misc/observable";
  30410. import { Nullable } from "babylonjs/types";
  30411. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  30412. import { Scene } from "babylonjs/scene";
  30413. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  30414. import { Node } from "babylonjs/node";
  30415. import { Mesh } from "babylonjs/Meshes/mesh";
  30416. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  30417. import { ICullable } from "babylonjs/Culling/boundingInfo";
  30418. import { Viewport } from "babylonjs/Maths/math.viewport";
  30419. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  30420. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  30421. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  30422. import { Ray } from "babylonjs/Culling/ray";
  30423. /**
  30424. * This is the base class of all the camera used in the application.
  30425. * @see https://doc.babylonjs.com/features/cameras
  30426. */
  30427. export class Camera extends Node {
  30428. /** @hidden */
  30429. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  30430. /**
  30431. * This is the default projection mode used by the cameras.
  30432. * It helps recreating a feeling of perspective and better appreciate depth.
  30433. * This is the best way to simulate real life cameras.
  30434. */
  30435. static readonly PERSPECTIVE_CAMERA: number;
  30436. /**
  30437. * This helps creating camera with an orthographic mode.
  30438. * 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.
  30439. */
  30440. static readonly ORTHOGRAPHIC_CAMERA: number;
  30441. /**
  30442. * This is the default FOV mode for perspective cameras.
  30443. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  30444. */
  30445. static readonly FOVMODE_VERTICAL_FIXED: number;
  30446. /**
  30447. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  30448. */
  30449. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  30450. /**
  30451. * This specifies ther is no need for a camera rig.
  30452. * Basically only one eye is rendered corresponding to the camera.
  30453. */
  30454. static readonly RIG_MODE_NONE: number;
  30455. /**
  30456. * Simulates a camera Rig with one blue eye and one red eye.
  30457. * This can be use with 3d blue and red glasses.
  30458. */
  30459. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  30460. /**
  30461. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  30462. */
  30463. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  30464. /**
  30465. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  30466. */
  30467. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  30468. /**
  30469. * Defines that both eyes of the camera will be rendered over under each other.
  30470. */
  30471. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  30472. /**
  30473. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  30474. */
  30475. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  30476. /**
  30477. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  30478. */
  30479. static readonly RIG_MODE_VR: number;
  30480. /**
  30481. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  30482. */
  30483. static readonly RIG_MODE_WEBVR: number;
  30484. /**
  30485. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  30486. */
  30487. static readonly RIG_MODE_CUSTOM: number;
  30488. /**
  30489. * Defines if by default attaching controls should prevent the default javascript event to continue.
  30490. */
  30491. static ForceAttachControlToAlwaysPreventDefault: boolean;
  30492. /**
  30493. * Define the input manager associated with the camera.
  30494. */
  30495. inputs: CameraInputsManager<Camera>;
  30496. /** @hidden */
  30497. _position: Vector3;
  30498. /**
  30499. * Define the current local position of the camera in the scene
  30500. */
  30501. get position(): Vector3;
  30502. set position(newPosition: Vector3);
  30503. protected _upVector: Vector3;
  30504. /**
  30505. * The vector the camera should consider as up.
  30506. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  30507. */
  30508. set upVector(vec: Vector3);
  30509. get upVector(): Vector3;
  30510. /**
  30511. * Define the current limit on the left side for an orthographic camera
  30512. * In scene unit
  30513. */
  30514. orthoLeft: Nullable<number>;
  30515. /**
  30516. * Define the current limit on the right side for an orthographic camera
  30517. * In scene unit
  30518. */
  30519. orthoRight: Nullable<number>;
  30520. /**
  30521. * Define the current limit on the bottom side for an orthographic camera
  30522. * In scene unit
  30523. */
  30524. orthoBottom: Nullable<number>;
  30525. /**
  30526. * Define the current limit on the top side for an orthographic camera
  30527. * In scene unit
  30528. */
  30529. orthoTop: Nullable<number>;
  30530. /**
  30531. * Field Of View is set in Radians. (default is 0.8)
  30532. */
  30533. fov: number;
  30534. /**
  30535. * Define the minimum distance the camera can see from.
  30536. * This is important to note that the depth buffer are not infinite and the closer it starts
  30537. * the more your scene might encounter depth fighting issue.
  30538. */
  30539. minZ: number;
  30540. /**
  30541. * Define the maximum distance the camera can see to.
  30542. * This is important to note that the depth buffer are not infinite and the further it end
  30543. * the more your scene might encounter depth fighting issue.
  30544. */
  30545. maxZ: number;
  30546. /**
  30547. * Define the default inertia of the camera.
  30548. * This helps giving a smooth feeling to the camera movement.
  30549. */
  30550. inertia: number;
  30551. /**
  30552. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  30553. */
  30554. mode: number;
  30555. /**
  30556. * Define whether the camera is intermediate.
  30557. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  30558. */
  30559. isIntermediate: boolean;
  30560. /**
  30561. * Define the viewport of the camera.
  30562. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  30563. */
  30564. viewport: Viewport;
  30565. /**
  30566. * Restricts the camera to viewing objects with the same layerMask.
  30567. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  30568. */
  30569. layerMask: number;
  30570. /**
  30571. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  30572. */
  30573. fovMode: number;
  30574. /**
  30575. * Rig mode of the camera.
  30576. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  30577. * This is normally controlled byt the camera themselves as internal use.
  30578. */
  30579. cameraRigMode: number;
  30580. /**
  30581. * Defines the distance between both "eyes" in case of a RIG
  30582. */
  30583. interaxialDistance: number;
  30584. /**
  30585. * Defines if stereoscopic rendering is done side by side or over under.
  30586. */
  30587. isStereoscopicSideBySide: boolean;
  30588. /**
  30589. * 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
  30590. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  30591. * else in the scene. (Eg. security camera)
  30592. *
  30593. * 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)
  30594. */
  30595. customRenderTargets: import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture[];
  30596. /**
  30597. * When set, the camera will render to this render target instead of the default canvas
  30598. *
  30599. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  30600. */
  30601. outputRenderTarget: Nullable<RenderTargetTexture>;
  30602. /**
  30603. * Observable triggered when the camera view matrix has changed.
  30604. */
  30605. onViewMatrixChangedObservable: Observable<Camera>;
  30606. /**
  30607. * Observable triggered when the camera Projection matrix has changed.
  30608. */
  30609. onProjectionMatrixChangedObservable: Observable<Camera>;
  30610. /**
  30611. * Observable triggered when the inputs have been processed.
  30612. */
  30613. onAfterCheckInputsObservable: Observable<Camera>;
  30614. /**
  30615. * Observable triggered when reset has been called and applied to the camera.
  30616. */
  30617. onRestoreStateObservable: Observable<Camera>;
  30618. /**
  30619. * Is this camera a part of a rig system?
  30620. */
  30621. isRigCamera: boolean;
  30622. /**
  30623. * If isRigCamera set to true this will be set with the parent camera.
  30624. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  30625. */
  30626. rigParent?: Camera;
  30627. /** @hidden */
  30628. _cameraRigParams: any;
  30629. /** @hidden */
  30630. _rigCameras: Camera[];
  30631. /** @hidden */
  30632. _rigPostProcess: Nullable<PostProcess>;
  30633. protected _webvrViewMatrix: Matrix;
  30634. /** @hidden */
  30635. _skipRendering: boolean;
  30636. /** @hidden */
  30637. _projectionMatrix: Matrix;
  30638. /** @hidden */
  30639. _postProcesses: Nullable<import("babylonjs/PostProcesses/postProcess").PostProcess>[];
  30640. /** @hidden */
  30641. _activeMeshes: SmartArray<AbstractMesh>;
  30642. protected _globalPosition: Vector3;
  30643. /** @hidden */
  30644. _computedViewMatrix: Matrix;
  30645. private _doNotComputeProjectionMatrix;
  30646. private _transformMatrix;
  30647. private _frustumPlanes;
  30648. private _refreshFrustumPlanes;
  30649. private _storedFov;
  30650. private _stateStored;
  30651. /**
  30652. * Instantiates a new camera object.
  30653. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  30654. * @see https://doc.babylonjs.com/features/cameras
  30655. * @param name Defines the name of the camera in the scene
  30656. * @param position Defines the position of the camera
  30657. * @param scene Defines the scene the camera belongs too
  30658. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  30659. */
  30660. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  30661. /**
  30662. * Store current camera state (fov, position, etc..)
  30663. * @returns the camera
  30664. */
  30665. storeState(): Camera;
  30666. /**
  30667. * Restores the camera state values if it has been stored. You must call storeState() first
  30668. */
  30669. protected _restoreStateValues(): boolean;
  30670. /**
  30671. * Restored camera state. You must call storeState() first.
  30672. * @returns true if restored and false otherwise
  30673. */
  30674. restoreState(): boolean;
  30675. /**
  30676. * Gets the class name of the camera.
  30677. * @returns the class name
  30678. */
  30679. getClassName(): string;
  30680. /** @hidden */
  30681. readonly _isCamera: boolean;
  30682. /**
  30683. * Gets a string representation of the camera useful for debug purpose.
  30684. * @param fullDetails Defines that a more verboe level of logging is required
  30685. * @returns the string representation
  30686. */
  30687. toString(fullDetails?: boolean): string;
  30688. /**
  30689. * Gets the current world space position of the camera.
  30690. */
  30691. get globalPosition(): Vector3;
  30692. /**
  30693. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  30694. * @returns the active meshe list
  30695. */
  30696. getActiveMeshes(): SmartArray<AbstractMesh>;
  30697. /**
  30698. * Check whether a mesh is part of the current active mesh list of the camera
  30699. * @param mesh Defines the mesh to check
  30700. * @returns true if active, false otherwise
  30701. */
  30702. isActiveMesh(mesh: Mesh): boolean;
  30703. /**
  30704. * Is this camera ready to be used/rendered
  30705. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  30706. * @return true if the camera is ready
  30707. */
  30708. isReady(completeCheck?: boolean): boolean;
  30709. /** @hidden */
  30710. _initCache(): void;
  30711. /** @hidden */
  30712. _updateCache(ignoreParentClass?: boolean): void;
  30713. /** @hidden */
  30714. _isSynchronized(): boolean;
  30715. /** @hidden */
  30716. _isSynchronizedViewMatrix(): boolean;
  30717. /** @hidden */
  30718. _isSynchronizedProjectionMatrix(): boolean;
  30719. /**
  30720. * Attach the input controls to a specific dom element to get the input from.
  30721. * @param element Defines the element the controls should be listened from
  30722. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  30723. */
  30724. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  30725. /**
  30726. * Detach the current controls from the specified dom element.
  30727. * @param element Defines the element to stop listening the inputs from
  30728. */
  30729. detachControl(element: HTMLElement): void;
  30730. /**
  30731. * Update the camera state according to the different inputs gathered during the frame.
  30732. */
  30733. update(): void;
  30734. /** @hidden */
  30735. _checkInputs(): void;
  30736. /** @hidden */
  30737. get rigCameras(): Camera[];
  30738. /**
  30739. * Gets the post process used by the rig cameras
  30740. */
  30741. get rigPostProcess(): Nullable<PostProcess>;
  30742. /**
  30743. * Internal, gets the first post proces.
  30744. * @returns the first post process to be run on this camera.
  30745. */
  30746. _getFirstPostProcess(): Nullable<PostProcess>;
  30747. private _cascadePostProcessesToRigCams;
  30748. /**
  30749. * Attach a post process to the camera.
  30750. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30751. * @param postProcess The post process to attach to the camera
  30752. * @param insertAt The position of the post process in case several of them are in use in the scene
  30753. * @returns the position the post process has been inserted at
  30754. */
  30755. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  30756. /**
  30757. * Detach a post process to the camera.
  30758. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30759. * @param postProcess The post process to detach from the camera
  30760. */
  30761. detachPostProcess(postProcess: PostProcess): void;
  30762. /**
  30763. * Gets the current world matrix of the camera
  30764. */
  30765. getWorldMatrix(): Matrix;
  30766. /** @hidden */
  30767. _getViewMatrix(): Matrix;
  30768. /**
  30769. * Gets the current view matrix of the camera.
  30770. * @param force forces the camera to recompute the matrix without looking at the cached state
  30771. * @returns the view matrix
  30772. */
  30773. getViewMatrix(force?: boolean): Matrix;
  30774. /**
  30775. * Freeze the projection matrix.
  30776. * It will prevent the cache check of the camera projection compute and can speed up perf
  30777. * if no parameter of the camera are meant to change
  30778. * @param projection Defines manually a projection if necessary
  30779. */
  30780. freezeProjectionMatrix(projection?: Matrix): void;
  30781. /**
  30782. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  30783. */
  30784. unfreezeProjectionMatrix(): void;
  30785. /**
  30786. * Gets the current projection matrix of the camera.
  30787. * @param force forces the camera to recompute the matrix without looking at the cached state
  30788. * @returns the projection matrix
  30789. */
  30790. getProjectionMatrix(force?: boolean): Matrix;
  30791. /**
  30792. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  30793. * @returns a Matrix
  30794. */
  30795. getTransformationMatrix(): Matrix;
  30796. private _updateFrustumPlanes;
  30797. /**
  30798. * Checks if a cullable object (mesh...) is in the camera frustum
  30799. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  30800. * @param target The object to check
  30801. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  30802. * @returns true if the object is in frustum otherwise false
  30803. */
  30804. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  30805. /**
  30806. * Checks if a cullable object (mesh...) is in the camera frustum
  30807. * Unlike isInFrustum this cheks the full bounding box
  30808. * @param target The object to check
  30809. * @returns true if the object is in frustum otherwise false
  30810. */
  30811. isCompletelyInFrustum(target: ICullable): boolean;
  30812. /**
  30813. * Gets a ray in the forward direction from the camera.
  30814. * @param length Defines the length of the ray to create
  30815. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30816. * @param origin Defines the start point of the ray which defaults to the camera position
  30817. * @returns the forward ray
  30818. */
  30819. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30820. /**
  30821. * Gets a ray in the forward direction from the camera.
  30822. * @param refRay the ray to (re)use when setting the values
  30823. * @param length Defines the length of the ray to create
  30824. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30825. * @param origin Defines the start point of the ray which defaults to the camera position
  30826. * @returns the forward ray
  30827. */
  30828. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30829. /**
  30830. * Releases resources associated with this node.
  30831. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  30832. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  30833. */
  30834. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  30835. /** @hidden */
  30836. _isLeftCamera: boolean;
  30837. /**
  30838. * Gets the left camera of a rig setup in case of Rigged Camera
  30839. */
  30840. get isLeftCamera(): boolean;
  30841. /** @hidden */
  30842. _isRightCamera: boolean;
  30843. /**
  30844. * Gets the right camera of a rig setup in case of Rigged Camera
  30845. */
  30846. get isRightCamera(): boolean;
  30847. /**
  30848. * Gets the left camera of a rig setup in case of Rigged Camera
  30849. */
  30850. get leftCamera(): Nullable<FreeCamera>;
  30851. /**
  30852. * Gets the right camera of a rig setup in case of Rigged Camera
  30853. */
  30854. get rightCamera(): Nullable<FreeCamera>;
  30855. /**
  30856. * Gets the left camera target of a rig setup in case of Rigged Camera
  30857. * @returns the target position
  30858. */
  30859. getLeftTarget(): Nullable<Vector3>;
  30860. /**
  30861. * Gets the right camera target of a rig setup in case of Rigged Camera
  30862. * @returns the target position
  30863. */
  30864. getRightTarget(): Nullable<Vector3>;
  30865. /**
  30866. * @hidden
  30867. */
  30868. setCameraRigMode(mode: number, rigParams: any): void;
  30869. /** @hidden */
  30870. static _setStereoscopicRigMode(camera: Camera): void;
  30871. /** @hidden */
  30872. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  30873. /** @hidden */
  30874. static _setVRRigMode(camera: Camera, rigParams: any): void;
  30875. /** @hidden */
  30876. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  30877. /** @hidden */
  30878. _getVRProjectionMatrix(): Matrix;
  30879. protected _updateCameraRotationMatrix(): void;
  30880. protected _updateWebVRCameraRotationMatrix(): void;
  30881. /**
  30882. * This function MUST be overwritten by the different WebVR cameras available.
  30883. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30884. * @hidden
  30885. */
  30886. _getWebVRProjectionMatrix(): Matrix;
  30887. /**
  30888. * This function MUST be overwritten by the different WebVR cameras available.
  30889. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30890. * @hidden
  30891. */
  30892. _getWebVRViewMatrix(): Matrix;
  30893. /** @hidden */
  30894. setCameraRigParameter(name: string, value: any): void;
  30895. /**
  30896. * needs to be overridden by children so sub has required properties to be copied
  30897. * @hidden
  30898. */
  30899. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  30900. /**
  30901. * May need to be overridden by children
  30902. * @hidden
  30903. */
  30904. _updateRigCameras(): void;
  30905. /** @hidden */
  30906. _setupInputs(): void;
  30907. /**
  30908. * Serialiaze the camera setup to a json represention
  30909. * @returns the JSON representation
  30910. */
  30911. serialize(): any;
  30912. /**
  30913. * Clones the current camera.
  30914. * @param name The cloned camera name
  30915. * @returns the cloned camera
  30916. */
  30917. clone(name: string): Camera;
  30918. /**
  30919. * Gets the direction of the camera relative to a given local axis.
  30920. * @param localAxis Defines the reference axis to provide a relative direction.
  30921. * @return the direction
  30922. */
  30923. getDirection(localAxis: Vector3): Vector3;
  30924. /**
  30925. * Returns the current camera absolute rotation
  30926. */
  30927. get absoluteRotation(): Quaternion;
  30928. /**
  30929. * Gets the direction of the camera relative to a given local axis into a passed vector.
  30930. * @param localAxis Defines the reference axis to provide a relative direction.
  30931. * @param result Defines the vector to store the result in
  30932. */
  30933. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  30934. /**
  30935. * Gets a camera constructor for a given camera type
  30936. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  30937. * @param name The name of the camera the result will be able to instantiate
  30938. * @param scene The scene the result will construct the camera in
  30939. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  30940. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  30941. * @returns a factory method to construc the camera
  30942. */
  30943. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  30944. /**
  30945. * Compute the world matrix of the camera.
  30946. * @returns the camera world matrix
  30947. */
  30948. computeWorldMatrix(): Matrix;
  30949. /**
  30950. * Parse a JSON and creates the camera from the parsed information
  30951. * @param parsedCamera The JSON to parse
  30952. * @param scene The scene to instantiate the camera in
  30953. * @returns the newly constructed camera
  30954. */
  30955. static Parse(parsedCamera: any, scene: Scene): Camera;
  30956. }
  30957. }
  30958. declare module "babylonjs/Meshes/Builders/discBuilder" {
  30959. import { Nullable } from "babylonjs/types";
  30960. import { Scene } from "babylonjs/scene";
  30961. import { Vector4 } from "babylonjs/Maths/math.vector";
  30962. import { Mesh } from "babylonjs/Meshes/mesh";
  30963. /**
  30964. * Class containing static functions to help procedurally build meshes
  30965. */
  30966. export class DiscBuilder {
  30967. /**
  30968. * Creates a plane polygonal mesh. By default, this is a disc
  30969. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  30970. * * 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
  30971. * * 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
  30972. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  30973. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30974. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30975. * @param name defines the name of the mesh
  30976. * @param options defines the options used to create the mesh
  30977. * @param scene defines the hosting scene
  30978. * @returns the plane polygonal mesh
  30979. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  30980. */
  30981. static CreateDisc(name: string, options: {
  30982. radius?: number;
  30983. tessellation?: number;
  30984. arc?: number;
  30985. updatable?: boolean;
  30986. sideOrientation?: number;
  30987. frontUVs?: Vector4;
  30988. backUVs?: Vector4;
  30989. }, scene?: Nullable<Scene>): Mesh;
  30990. }
  30991. }
  30992. declare module "babylonjs/Materials/fresnelParameters" {
  30993. import { DeepImmutable } from "babylonjs/types";
  30994. import { Color3 } from "babylonjs/Maths/math.color";
  30995. /**
  30996. * Options to be used when creating a FresnelParameters.
  30997. */
  30998. export type IFresnelParametersCreationOptions = {
  30999. /**
  31000. * Define the color used on edges (grazing angle)
  31001. */
  31002. leftColor?: Color3;
  31003. /**
  31004. * Define the color used on center
  31005. */
  31006. rightColor?: Color3;
  31007. /**
  31008. * Define bias applied to computed fresnel term
  31009. */
  31010. bias?: number;
  31011. /**
  31012. * Defined the power exponent applied to fresnel term
  31013. */
  31014. power?: number;
  31015. /**
  31016. * Define if the fresnel effect is enable or not.
  31017. */
  31018. isEnabled?: boolean;
  31019. };
  31020. /**
  31021. * Serialized format for FresnelParameters.
  31022. */
  31023. export type IFresnelParametersSerialized = {
  31024. /**
  31025. * Define the color used on edges (grazing angle) [as an array]
  31026. */
  31027. leftColor: number[];
  31028. /**
  31029. * Define the color used on center [as an array]
  31030. */
  31031. rightColor: number[];
  31032. /**
  31033. * Define bias applied to computed fresnel term
  31034. */
  31035. bias: number;
  31036. /**
  31037. * Defined the power exponent applied to fresnel term
  31038. */
  31039. power?: number;
  31040. /**
  31041. * Define if the fresnel effect is enable or not.
  31042. */
  31043. isEnabled: boolean;
  31044. };
  31045. /**
  31046. * This represents all the required information to add a fresnel effect on a material:
  31047. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31048. */
  31049. export class FresnelParameters {
  31050. private _isEnabled;
  31051. /**
  31052. * Define if the fresnel effect is enable or not.
  31053. */
  31054. get isEnabled(): boolean;
  31055. set isEnabled(value: boolean);
  31056. /**
  31057. * Define the color used on edges (grazing angle)
  31058. */
  31059. leftColor: Color3;
  31060. /**
  31061. * Define the color used on center
  31062. */
  31063. rightColor: Color3;
  31064. /**
  31065. * Define bias applied to computed fresnel term
  31066. */
  31067. bias: number;
  31068. /**
  31069. * Defined the power exponent applied to fresnel term
  31070. */
  31071. power: number;
  31072. /**
  31073. * Creates a new FresnelParameters object.
  31074. *
  31075. * @param options provide your own settings to optionally to override defaults
  31076. */
  31077. constructor(options?: IFresnelParametersCreationOptions);
  31078. /**
  31079. * Clones the current fresnel and its valuues
  31080. * @returns a clone fresnel configuration
  31081. */
  31082. clone(): FresnelParameters;
  31083. /**
  31084. * Determines equality between FresnelParameters objects
  31085. * @param otherFresnelParameters defines the second operand
  31086. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  31087. */
  31088. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  31089. /**
  31090. * Serializes the current fresnel parameters to a JSON representation.
  31091. * @return the JSON serialization
  31092. */
  31093. serialize(): IFresnelParametersSerialized;
  31094. /**
  31095. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  31096. * @param parsedFresnelParameters Define the JSON representation
  31097. * @returns the parsed parameters
  31098. */
  31099. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  31100. }
  31101. }
  31102. declare module "babylonjs/Materials/materialFlags" {
  31103. /**
  31104. * This groups all the flags used to control the materials channel.
  31105. */
  31106. export class MaterialFlags {
  31107. private static _DiffuseTextureEnabled;
  31108. /**
  31109. * Are diffuse textures enabled in the application.
  31110. */
  31111. static get DiffuseTextureEnabled(): boolean;
  31112. static set DiffuseTextureEnabled(value: boolean);
  31113. private static _DetailTextureEnabled;
  31114. /**
  31115. * Are detail textures enabled in the application.
  31116. */
  31117. static get DetailTextureEnabled(): boolean;
  31118. static set DetailTextureEnabled(value: boolean);
  31119. private static _AmbientTextureEnabled;
  31120. /**
  31121. * Are ambient textures enabled in the application.
  31122. */
  31123. static get AmbientTextureEnabled(): boolean;
  31124. static set AmbientTextureEnabled(value: boolean);
  31125. private static _OpacityTextureEnabled;
  31126. /**
  31127. * Are opacity textures enabled in the application.
  31128. */
  31129. static get OpacityTextureEnabled(): boolean;
  31130. static set OpacityTextureEnabled(value: boolean);
  31131. private static _ReflectionTextureEnabled;
  31132. /**
  31133. * Are reflection textures enabled in the application.
  31134. */
  31135. static get ReflectionTextureEnabled(): boolean;
  31136. static set ReflectionTextureEnabled(value: boolean);
  31137. private static _EmissiveTextureEnabled;
  31138. /**
  31139. * Are emissive textures enabled in the application.
  31140. */
  31141. static get EmissiveTextureEnabled(): boolean;
  31142. static set EmissiveTextureEnabled(value: boolean);
  31143. private static _SpecularTextureEnabled;
  31144. /**
  31145. * Are specular textures enabled in the application.
  31146. */
  31147. static get SpecularTextureEnabled(): boolean;
  31148. static set SpecularTextureEnabled(value: boolean);
  31149. private static _BumpTextureEnabled;
  31150. /**
  31151. * Are bump textures enabled in the application.
  31152. */
  31153. static get BumpTextureEnabled(): boolean;
  31154. static set BumpTextureEnabled(value: boolean);
  31155. private static _LightmapTextureEnabled;
  31156. /**
  31157. * Are lightmap textures enabled in the application.
  31158. */
  31159. static get LightmapTextureEnabled(): boolean;
  31160. static set LightmapTextureEnabled(value: boolean);
  31161. private static _RefractionTextureEnabled;
  31162. /**
  31163. * Are refraction textures enabled in the application.
  31164. */
  31165. static get RefractionTextureEnabled(): boolean;
  31166. static set RefractionTextureEnabled(value: boolean);
  31167. private static _ColorGradingTextureEnabled;
  31168. /**
  31169. * Are color grading textures enabled in the application.
  31170. */
  31171. static get ColorGradingTextureEnabled(): boolean;
  31172. static set ColorGradingTextureEnabled(value: boolean);
  31173. private static _FresnelEnabled;
  31174. /**
  31175. * Are fresnels enabled in the application.
  31176. */
  31177. static get FresnelEnabled(): boolean;
  31178. static set FresnelEnabled(value: boolean);
  31179. private static _ClearCoatTextureEnabled;
  31180. /**
  31181. * Are clear coat textures enabled in the application.
  31182. */
  31183. static get ClearCoatTextureEnabled(): boolean;
  31184. static set ClearCoatTextureEnabled(value: boolean);
  31185. private static _ClearCoatBumpTextureEnabled;
  31186. /**
  31187. * Are clear coat bump textures enabled in the application.
  31188. */
  31189. static get ClearCoatBumpTextureEnabled(): boolean;
  31190. static set ClearCoatBumpTextureEnabled(value: boolean);
  31191. private static _ClearCoatTintTextureEnabled;
  31192. /**
  31193. * Are clear coat tint textures enabled in the application.
  31194. */
  31195. static get ClearCoatTintTextureEnabled(): boolean;
  31196. static set ClearCoatTintTextureEnabled(value: boolean);
  31197. private static _SheenTextureEnabled;
  31198. /**
  31199. * Are sheen textures enabled in the application.
  31200. */
  31201. static get SheenTextureEnabled(): boolean;
  31202. static set SheenTextureEnabled(value: boolean);
  31203. private static _AnisotropicTextureEnabled;
  31204. /**
  31205. * Are anisotropic textures enabled in the application.
  31206. */
  31207. static get AnisotropicTextureEnabled(): boolean;
  31208. static set AnisotropicTextureEnabled(value: boolean);
  31209. private static _ThicknessTextureEnabled;
  31210. /**
  31211. * Are thickness textures enabled in the application.
  31212. */
  31213. static get ThicknessTextureEnabled(): boolean;
  31214. static set ThicknessTextureEnabled(value: boolean);
  31215. }
  31216. }
  31217. declare module "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration" {
  31218. /** @hidden */
  31219. export var defaultFragmentDeclaration: {
  31220. name: string;
  31221. shader: string;
  31222. };
  31223. }
  31224. declare module "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration" {
  31225. /** @hidden */
  31226. export var defaultUboDeclaration: {
  31227. name: string;
  31228. shader: string;
  31229. };
  31230. }
  31231. declare module "babylonjs/Shaders/ShadersInclude/prePassDeclaration" {
  31232. /** @hidden */
  31233. export var prePassDeclaration: {
  31234. name: string;
  31235. shader: string;
  31236. };
  31237. }
  31238. declare module "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration" {
  31239. /** @hidden */
  31240. export var lightFragmentDeclaration: {
  31241. name: string;
  31242. shader: string;
  31243. };
  31244. }
  31245. declare module "babylonjs/Shaders/ShadersInclude/lightUboDeclaration" {
  31246. /** @hidden */
  31247. export var lightUboDeclaration: {
  31248. name: string;
  31249. shader: string;
  31250. };
  31251. }
  31252. declare module "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions" {
  31253. /** @hidden */
  31254. export var lightsFragmentFunctions: {
  31255. name: string;
  31256. shader: string;
  31257. };
  31258. }
  31259. declare module "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions" {
  31260. /** @hidden */
  31261. export var shadowsFragmentFunctions: {
  31262. name: string;
  31263. shader: string;
  31264. };
  31265. }
  31266. declare module "babylonjs/Shaders/ShadersInclude/fresnelFunction" {
  31267. /** @hidden */
  31268. export var fresnelFunction: {
  31269. name: string;
  31270. shader: string;
  31271. };
  31272. }
  31273. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions" {
  31274. /** @hidden */
  31275. export var bumpFragmentMainFunctions: {
  31276. name: string;
  31277. shader: string;
  31278. };
  31279. }
  31280. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions" {
  31281. /** @hidden */
  31282. export var bumpFragmentFunctions: {
  31283. name: string;
  31284. shader: string;
  31285. };
  31286. }
  31287. declare module "babylonjs/Shaders/ShadersInclude/logDepthDeclaration" {
  31288. /** @hidden */
  31289. export var logDepthDeclaration: {
  31290. name: string;
  31291. shader: string;
  31292. };
  31293. }
  31294. declare module "babylonjs/Shaders/ShadersInclude/bumpFragment" {
  31295. /** @hidden */
  31296. export var bumpFragment: {
  31297. name: string;
  31298. shader: string;
  31299. };
  31300. }
  31301. declare module "babylonjs/Shaders/ShadersInclude/depthPrePass" {
  31302. /** @hidden */
  31303. export var depthPrePass: {
  31304. name: string;
  31305. shader: string;
  31306. };
  31307. }
  31308. declare module "babylonjs/Shaders/ShadersInclude/lightFragment" {
  31309. /** @hidden */
  31310. export var lightFragment: {
  31311. name: string;
  31312. shader: string;
  31313. };
  31314. }
  31315. declare module "babylonjs/Shaders/ShadersInclude/logDepthFragment" {
  31316. /** @hidden */
  31317. export var logDepthFragment: {
  31318. name: string;
  31319. shader: string;
  31320. };
  31321. }
  31322. declare module "babylonjs/Shaders/default.fragment" {
  31323. import "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration";
  31324. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31325. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  31326. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31327. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31328. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31329. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  31330. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  31331. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  31332. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  31333. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  31334. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  31335. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  31336. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  31337. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  31338. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31339. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  31340. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  31341. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  31342. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  31343. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  31344. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  31345. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  31346. /** @hidden */
  31347. export var defaultPixelShader: {
  31348. name: string;
  31349. shader: string;
  31350. };
  31351. }
  31352. declare module "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration" {
  31353. /** @hidden */
  31354. export var defaultVertexDeclaration: {
  31355. name: string;
  31356. shader: string;
  31357. };
  31358. }
  31359. declare module "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration" {
  31360. /** @hidden */
  31361. export var bumpVertexDeclaration: {
  31362. name: string;
  31363. shader: string;
  31364. };
  31365. }
  31366. declare module "babylonjs/Shaders/ShadersInclude/bumpVertex" {
  31367. /** @hidden */
  31368. export var bumpVertex: {
  31369. name: string;
  31370. shader: string;
  31371. };
  31372. }
  31373. declare module "babylonjs/Shaders/ShadersInclude/fogVertex" {
  31374. /** @hidden */
  31375. export var fogVertex: {
  31376. name: string;
  31377. shader: string;
  31378. };
  31379. }
  31380. declare module "babylonjs/Shaders/ShadersInclude/shadowsVertex" {
  31381. /** @hidden */
  31382. export var shadowsVertex: {
  31383. name: string;
  31384. shader: string;
  31385. };
  31386. }
  31387. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertex" {
  31388. /** @hidden */
  31389. export var pointCloudVertex: {
  31390. name: string;
  31391. shader: string;
  31392. };
  31393. }
  31394. declare module "babylonjs/Shaders/ShadersInclude/logDepthVertex" {
  31395. /** @hidden */
  31396. export var logDepthVertex: {
  31397. name: string;
  31398. shader: string;
  31399. };
  31400. }
  31401. declare module "babylonjs/Shaders/default.vertex" {
  31402. import "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration";
  31403. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31404. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31405. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  31406. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  31407. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  31408. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  31409. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  31410. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31411. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31412. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  31413. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  31414. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31415. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  31416. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  31417. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  31418. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  31419. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  31420. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  31421. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  31422. import "babylonjs/Shaders/ShadersInclude/pointCloudVertex";
  31423. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  31424. /** @hidden */
  31425. export var defaultVertexShader: {
  31426. name: string;
  31427. shader: string;
  31428. };
  31429. }
  31430. declare module "babylonjs/Materials/material.detailMapConfiguration" {
  31431. import { Nullable } from "babylonjs/types";
  31432. import { Scene } from "babylonjs/scene";
  31433. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31434. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  31435. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31436. /**
  31437. * @hidden
  31438. */
  31439. export interface IMaterialDetailMapDefines {
  31440. DETAIL: boolean;
  31441. DETAILDIRECTUV: number;
  31442. DETAIL_NORMALBLENDMETHOD: number;
  31443. /** @hidden */
  31444. _areTexturesDirty: boolean;
  31445. }
  31446. /**
  31447. * Define the code related to the detail map parameters of a material
  31448. *
  31449. * Inspired from:
  31450. * 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
  31451. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  31452. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  31453. */
  31454. export class DetailMapConfiguration {
  31455. private _texture;
  31456. /**
  31457. * The detail texture of the material.
  31458. */
  31459. texture: Nullable<BaseTexture>;
  31460. /**
  31461. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  31462. * Bigger values mean stronger blending
  31463. */
  31464. diffuseBlendLevel: number;
  31465. /**
  31466. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  31467. * Bigger values mean stronger blending. Only used with PBR materials
  31468. */
  31469. roughnessBlendLevel: number;
  31470. /**
  31471. * Defines how strong the bump effect from the detail map is
  31472. * Bigger values mean stronger effect
  31473. */
  31474. bumpLevel: number;
  31475. private _normalBlendMethod;
  31476. /**
  31477. * The method used to blend the bump and detail normals together
  31478. */
  31479. normalBlendMethod: number;
  31480. private _isEnabled;
  31481. /**
  31482. * Enable or disable the detail map on this material
  31483. */
  31484. isEnabled: boolean;
  31485. /** @hidden */
  31486. private _internalMarkAllSubMeshesAsTexturesDirty;
  31487. /** @hidden */
  31488. _markAllSubMeshesAsTexturesDirty(): void;
  31489. /**
  31490. * Instantiate a new detail map
  31491. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  31492. */
  31493. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  31494. /**
  31495. * Gets whether the submesh is ready to be used or not.
  31496. * @param defines the list of "defines" to update.
  31497. * @param scene defines the scene the material belongs to.
  31498. * @returns - boolean indicating that the submesh is ready or not.
  31499. */
  31500. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  31501. /**
  31502. * Update the defines for detail map usage
  31503. * @param defines the list of "defines" to update.
  31504. * @param scene defines the scene the material belongs to.
  31505. */
  31506. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  31507. /**
  31508. * Binds the material data.
  31509. * @param uniformBuffer defines the Uniform buffer to fill in.
  31510. * @param scene defines the scene the material belongs to.
  31511. * @param isFrozen defines whether the material is frozen or not.
  31512. */
  31513. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  31514. /**
  31515. * Checks to see if a texture is used in the material.
  31516. * @param texture - Base texture to use.
  31517. * @returns - Boolean specifying if a texture is used in the material.
  31518. */
  31519. hasTexture(texture: BaseTexture): boolean;
  31520. /**
  31521. * Returns an array of the actively used textures.
  31522. * @param activeTextures Array of BaseTextures
  31523. */
  31524. getActiveTextures(activeTextures: BaseTexture[]): void;
  31525. /**
  31526. * Returns the animatable textures.
  31527. * @param animatables Array of animatable textures.
  31528. */
  31529. getAnimatables(animatables: IAnimatable[]): void;
  31530. /**
  31531. * Disposes the resources of the material.
  31532. * @param forceDisposeTextures - Forces the disposal of all textures.
  31533. */
  31534. dispose(forceDisposeTextures?: boolean): void;
  31535. /**
  31536. * Get the current class name useful for serialization or dynamic coding.
  31537. * @returns "DetailMap"
  31538. */
  31539. getClassName(): string;
  31540. /**
  31541. * Add the required uniforms to the current list.
  31542. * @param uniforms defines the current uniform list.
  31543. */
  31544. static AddUniforms(uniforms: string[]): void;
  31545. /**
  31546. * Add the required samplers to the current list.
  31547. * @param samplers defines the current sampler list.
  31548. */
  31549. static AddSamplers(samplers: string[]): void;
  31550. /**
  31551. * Add the required uniforms to the current buffer.
  31552. * @param uniformBuffer defines the current uniform buffer.
  31553. */
  31554. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  31555. /**
  31556. * Makes a duplicate of the current instance into another one.
  31557. * @param detailMap define the instance where to copy the info
  31558. */
  31559. copyTo(detailMap: DetailMapConfiguration): void;
  31560. /**
  31561. * Serializes this detail map instance
  31562. * @returns - An object with the serialized instance.
  31563. */
  31564. serialize(): any;
  31565. /**
  31566. * Parses a detail map setting from a serialized object.
  31567. * @param source - Serialized object.
  31568. * @param scene Defines the scene we are parsing for
  31569. * @param rootUrl Defines the rootUrl to load from
  31570. */
  31571. parse(source: any, scene: Scene, rootUrl: string): void;
  31572. }
  31573. }
  31574. declare module "babylonjs/Materials/standardMaterial" {
  31575. import { SmartArray } from "babylonjs/Misc/smartArray";
  31576. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31577. import { Nullable } from "babylonjs/types";
  31578. import { Scene } from "babylonjs/scene";
  31579. import { Matrix } from "babylonjs/Maths/math.vector";
  31580. import { Color3 } from "babylonjs/Maths/math.color";
  31581. import { SubMesh } from "babylonjs/Meshes/subMesh";
  31582. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  31583. import { Mesh } from "babylonjs/Meshes/mesh";
  31584. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  31585. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  31586. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  31587. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  31588. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  31589. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31590. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  31591. import "babylonjs/Shaders/default.fragment";
  31592. import "babylonjs/Shaders/default.vertex";
  31593. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  31594. /** @hidden */
  31595. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  31596. MAINUV1: boolean;
  31597. MAINUV2: boolean;
  31598. DIFFUSE: boolean;
  31599. DIFFUSEDIRECTUV: number;
  31600. DETAIL: boolean;
  31601. DETAILDIRECTUV: number;
  31602. DETAIL_NORMALBLENDMETHOD: number;
  31603. AMBIENT: boolean;
  31604. AMBIENTDIRECTUV: number;
  31605. OPACITY: boolean;
  31606. OPACITYDIRECTUV: number;
  31607. OPACITYRGB: boolean;
  31608. REFLECTION: boolean;
  31609. EMISSIVE: boolean;
  31610. EMISSIVEDIRECTUV: number;
  31611. SPECULAR: boolean;
  31612. SPECULARDIRECTUV: number;
  31613. BUMP: boolean;
  31614. BUMPDIRECTUV: number;
  31615. PARALLAX: boolean;
  31616. PARALLAXOCCLUSION: boolean;
  31617. SPECULAROVERALPHA: boolean;
  31618. CLIPPLANE: boolean;
  31619. CLIPPLANE2: boolean;
  31620. CLIPPLANE3: boolean;
  31621. CLIPPLANE4: boolean;
  31622. CLIPPLANE5: boolean;
  31623. CLIPPLANE6: boolean;
  31624. ALPHATEST: boolean;
  31625. DEPTHPREPASS: boolean;
  31626. ALPHAFROMDIFFUSE: boolean;
  31627. POINTSIZE: boolean;
  31628. FOG: boolean;
  31629. SPECULARTERM: boolean;
  31630. DIFFUSEFRESNEL: boolean;
  31631. OPACITYFRESNEL: boolean;
  31632. REFLECTIONFRESNEL: boolean;
  31633. REFRACTIONFRESNEL: boolean;
  31634. EMISSIVEFRESNEL: boolean;
  31635. FRESNEL: boolean;
  31636. NORMAL: boolean;
  31637. UV1: boolean;
  31638. UV2: boolean;
  31639. VERTEXCOLOR: boolean;
  31640. VERTEXALPHA: boolean;
  31641. NUM_BONE_INFLUENCERS: number;
  31642. BonesPerMesh: number;
  31643. BONETEXTURE: boolean;
  31644. INSTANCES: boolean;
  31645. THIN_INSTANCES: boolean;
  31646. GLOSSINESS: boolean;
  31647. ROUGHNESS: boolean;
  31648. EMISSIVEASILLUMINATION: boolean;
  31649. LINKEMISSIVEWITHDIFFUSE: boolean;
  31650. REFLECTIONFRESNELFROMSPECULAR: boolean;
  31651. LIGHTMAP: boolean;
  31652. LIGHTMAPDIRECTUV: number;
  31653. OBJECTSPACE_NORMALMAP: boolean;
  31654. USELIGHTMAPASSHADOWMAP: boolean;
  31655. REFLECTIONMAP_3D: boolean;
  31656. REFLECTIONMAP_SPHERICAL: boolean;
  31657. REFLECTIONMAP_PLANAR: boolean;
  31658. REFLECTIONMAP_CUBIC: boolean;
  31659. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  31660. REFLECTIONMAP_PROJECTION: boolean;
  31661. REFLECTIONMAP_SKYBOX: boolean;
  31662. REFLECTIONMAP_EXPLICIT: boolean;
  31663. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  31664. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  31665. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  31666. INVERTCUBICMAP: boolean;
  31667. LOGARITHMICDEPTH: boolean;
  31668. REFRACTION: boolean;
  31669. REFRACTIONMAP_3D: boolean;
  31670. REFLECTIONOVERALPHA: boolean;
  31671. TWOSIDEDLIGHTING: boolean;
  31672. SHADOWFLOAT: boolean;
  31673. MORPHTARGETS: boolean;
  31674. MORPHTARGETS_NORMAL: boolean;
  31675. MORPHTARGETS_TANGENT: boolean;
  31676. MORPHTARGETS_UV: boolean;
  31677. NUM_MORPH_INFLUENCERS: number;
  31678. NONUNIFORMSCALING: boolean;
  31679. PREMULTIPLYALPHA: boolean;
  31680. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  31681. ALPHABLEND: boolean;
  31682. PREPASS: boolean;
  31683. PREPASS_IRRADIANCE: boolean;
  31684. PREPASS_IRRADIANCE_INDEX: number;
  31685. PREPASS_ALBEDO: boolean;
  31686. PREPASS_ALBEDO_INDEX: number;
  31687. PREPASS_DEPTHNORMAL: boolean;
  31688. PREPASS_DEPTHNORMAL_INDEX: number;
  31689. SCENE_MRT_COUNT: number;
  31690. RGBDLIGHTMAP: boolean;
  31691. RGBDREFLECTION: boolean;
  31692. RGBDREFRACTION: boolean;
  31693. IMAGEPROCESSING: boolean;
  31694. VIGNETTE: boolean;
  31695. VIGNETTEBLENDMODEMULTIPLY: boolean;
  31696. VIGNETTEBLENDMODEOPAQUE: boolean;
  31697. TONEMAPPING: boolean;
  31698. TONEMAPPING_ACES: boolean;
  31699. CONTRAST: boolean;
  31700. COLORCURVES: boolean;
  31701. COLORGRADING: boolean;
  31702. COLORGRADING3D: boolean;
  31703. SAMPLER3DGREENDEPTH: boolean;
  31704. SAMPLER3DBGRMAP: boolean;
  31705. IMAGEPROCESSINGPOSTPROCESS: boolean;
  31706. MULTIVIEW: boolean;
  31707. /**
  31708. * If the reflection texture on this material is in linear color space
  31709. * @hidden
  31710. */
  31711. IS_REFLECTION_LINEAR: boolean;
  31712. /**
  31713. * If the refraction texture on this material is in linear color space
  31714. * @hidden
  31715. */
  31716. IS_REFRACTION_LINEAR: boolean;
  31717. EXPOSURE: boolean;
  31718. constructor();
  31719. setReflectionMode(modeToEnable: string): void;
  31720. }
  31721. /**
  31722. * This is the default material used in Babylon. It is the best trade off between quality
  31723. * and performances.
  31724. * @see https://doc.babylonjs.com/babylon101/materials
  31725. */
  31726. export class StandardMaterial extends PushMaterial {
  31727. private _diffuseTexture;
  31728. /**
  31729. * The basic texture of the material as viewed under a light.
  31730. */
  31731. diffuseTexture: Nullable<BaseTexture>;
  31732. private _ambientTexture;
  31733. /**
  31734. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  31735. */
  31736. ambientTexture: Nullable<BaseTexture>;
  31737. private _opacityTexture;
  31738. /**
  31739. * Define the transparency of the material from a texture.
  31740. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  31741. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  31742. */
  31743. opacityTexture: Nullable<BaseTexture>;
  31744. private _reflectionTexture;
  31745. /**
  31746. * Define the texture used to display the reflection.
  31747. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31748. */
  31749. reflectionTexture: Nullable<BaseTexture>;
  31750. private _emissiveTexture;
  31751. /**
  31752. * Define texture of the material as if self lit.
  31753. * This will be mixed in the final result even in the absence of light.
  31754. */
  31755. emissiveTexture: Nullable<BaseTexture>;
  31756. private _specularTexture;
  31757. /**
  31758. * Define how the color and intensity of the highlight given by the light in the material.
  31759. */
  31760. specularTexture: Nullable<BaseTexture>;
  31761. private _bumpTexture;
  31762. /**
  31763. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  31764. * 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.
  31765. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  31766. */
  31767. bumpTexture: Nullable<BaseTexture>;
  31768. private _lightmapTexture;
  31769. /**
  31770. * Complex lighting can be computationally expensive to compute at runtime.
  31771. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  31772. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  31773. */
  31774. lightmapTexture: Nullable<BaseTexture>;
  31775. private _refractionTexture;
  31776. /**
  31777. * Define the texture used to display the refraction.
  31778. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31779. */
  31780. refractionTexture: Nullable<BaseTexture>;
  31781. /**
  31782. * The color of the material lit by the environmental background lighting.
  31783. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  31784. */
  31785. ambientColor: Color3;
  31786. /**
  31787. * The basic color of the material as viewed under a light.
  31788. */
  31789. diffuseColor: Color3;
  31790. /**
  31791. * Define how the color and intensity of the highlight given by the light in the material.
  31792. */
  31793. specularColor: Color3;
  31794. /**
  31795. * Define the color of the material as if self lit.
  31796. * This will be mixed in the final result even in the absence of light.
  31797. */
  31798. emissiveColor: Color3;
  31799. /**
  31800. * Defines how sharp are the highlights in the material.
  31801. * The bigger the value the sharper giving a more glossy feeling to the result.
  31802. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  31803. */
  31804. specularPower: number;
  31805. private _useAlphaFromDiffuseTexture;
  31806. /**
  31807. * Does the transparency come from the diffuse texture alpha channel.
  31808. */
  31809. useAlphaFromDiffuseTexture: boolean;
  31810. private _useEmissiveAsIllumination;
  31811. /**
  31812. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  31813. */
  31814. useEmissiveAsIllumination: boolean;
  31815. private _linkEmissiveWithDiffuse;
  31816. /**
  31817. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  31818. * the emissive level when the final color is close to one.
  31819. */
  31820. linkEmissiveWithDiffuse: boolean;
  31821. private _useSpecularOverAlpha;
  31822. /**
  31823. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  31824. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  31825. */
  31826. useSpecularOverAlpha: boolean;
  31827. private _useReflectionOverAlpha;
  31828. /**
  31829. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  31830. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  31831. */
  31832. useReflectionOverAlpha: boolean;
  31833. private _disableLighting;
  31834. /**
  31835. * Does lights from the scene impacts this material.
  31836. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  31837. */
  31838. disableLighting: boolean;
  31839. private _useObjectSpaceNormalMap;
  31840. /**
  31841. * Allows using an object space normal map (instead of tangent space).
  31842. */
  31843. useObjectSpaceNormalMap: boolean;
  31844. private _useParallax;
  31845. /**
  31846. * Is parallax enabled or not.
  31847. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31848. */
  31849. useParallax: boolean;
  31850. private _useParallaxOcclusion;
  31851. /**
  31852. * Is parallax occlusion enabled or not.
  31853. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  31854. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31855. */
  31856. useParallaxOcclusion: boolean;
  31857. /**
  31858. * 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.
  31859. */
  31860. parallaxScaleBias: number;
  31861. private _roughness;
  31862. /**
  31863. * Helps to define how blurry the reflections should appears in the material.
  31864. */
  31865. roughness: number;
  31866. /**
  31867. * In case of refraction, define the value of the index of refraction.
  31868. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31869. */
  31870. indexOfRefraction: number;
  31871. /**
  31872. * Invert the refraction texture alongside the y axis.
  31873. * It can be useful with procedural textures or probe for instance.
  31874. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31875. */
  31876. invertRefractionY: boolean;
  31877. /**
  31878. * Defines the alpha limits in alpha test mode.
  31879. */
  31880. alphaCutOff: number;
  31881. private _useLightmapAsShadowmap;
  31882. /**
  31883. * In case of light mapping, define whether the map contains light or shadow informations.
  31884. */
  31885. useLightmapAsShadowmap: boolean;
  31886. private _diffuseFresnelParameters;
  31887. /**
  31888. * Define the diffuse fresnel parameters of the material.
  31889. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31890. */
  31891. diffuseFresnelParameters: FresnelParameters;
  31892. private _opacityFresnelParameters;
  31893. /**
  31894. * Define the opacity fresnel parameters of the material.
  31895. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31896. */
  31897. opacityFresnelParameters: FresnelParameters;
  31898. private _reflectionFresnelParameters;
  31899. /**
  31900. * Define the reflection fresnel parameters of the material.
  31901. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31902. */
  31903. reflectionFresnelParameters: FresnelParameters;
  31904. private _refractionFresnelParameters;
  31905. /**
  31906. * Define the refraction fresnel parameters of the material.
  31907. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31908. */
  31909. refractionFresnelParameters: FresnelParameters;
  31910. private _emissiveFresnelParameters;
  31911. /**
  31912. * Define the emissive fresnel parameters of the material.
  31913. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31914. */
  31915. emissiveFresnelParameters: FresnelParameters;
  31916. private _useReflectionFresnelFromSpecular;
  31917. /**
  31918. * If true automatically deducts the fresnels values from the material specularity.
  31919. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31920. */
  31921. useReflectionFresnelFromSpecular: boolean;
  31922. private _useGlossinessFromSpecularMapAlpha;
  31923. /**
  31924. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  31925. */
  31926. useGlossinessFromSpecularMapAlpha: boolean;
  31927. private _maxSimultaneousLights;
  31928. /**
  31929. * Defines the maximum number of lights that can be used in the material
  31930. */
  31931. maxSimultaneousLights: number;
  31932. private _invertNormalMapX;
  31933. /**
  31934. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  31935. */
  31936. invertNormalMapX: boolean;
  31937. private _invertNormalMapY;
  31938. /**
  31939. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  31940. */
  31941. invertNormalMapY: boolean;
  31942. private _twoSidedLighting;
  31943. /**
  31944. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  31945. */
  31946. twoSidedLighting: boolean;
  31947. /**
  31948. * Default configuration related to image processing available in the standard Material.
  31949. */
  31950. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  31951. /**
  31952. * Gets the image processing configuration used either in this material.
  31953. */
  31954. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  31955. /**
  31956. * Sets the Default image processing configuration used either in the this material.
  31957. *
  31958. * If sets to null, the scene one is in use.
  31959. */
  31960. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  31961. /**
  31962. * Keep track of the image processing observer to allow dispose and replace.
  31963. */
  31964. private _imageProcessingObserver;
  31965. /**
  31966. * Attaches a new image processing configuration to the Standard Material.
  31967. * @param configuration
  31968. */
  31969. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  31970. /**
  31971. * Gets wether the color curves effect is enabled.
  31972. */
  31973. get cameraColorCurvesEnabled(): boolean;
  31974. /**
  31975. * Sets wether the color curves effect is enabled.
  31976. */
  31977. set cameraColorCurvesEnabled(value: boolean);
  31978. /**
  31979. * Gets wether the color grading effect is enabled.
  31980. */
  31981. get cameraColorGradingEnabled(): boolean;
  31982. /**
  31983. * Gets wether the color grading effect is enabled.
  31984. */
  31985. set cameraColorGradingEnabled(value: boolean);
  31986. /**
  31987. * Gets wether tonemapping is enabled or not.
  31988. */
  31989. get cameraToneMappingEnabled(): boolean;
  31990. /**
  31991. * Sets wether tonemapping is enabled or not
  31992. */
  31993. set cameraToneMappingEnabled(value: boolean);
  31994. /**
  31995. * The camera exposure used on this material.
  31996. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31997. * This corresponds to a photographic exposure.
  31998. */
  31999. get cameraExposure(): number;
  32000. /**
  32001. * The camera exposure used on this material.
  32002. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  32003. * This corresponds to a photographic exposure.
  32004. */
  32005. set cameraExposure(value: number);
  32006. /**
  32007. * Gets The camera contrast used on this material.
  32008. */
  32009. get cameraContrast(): number;
  32010. /**
  32011. * Sets The camera contrast used on this material.
  32012. */
  32013. set cameraContrast(value: number);
  32014. /**
  32015. * Gets the Color Grading 2D Lookup Texture.
  32016. */
  32017. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  32018. /**
  32019. * Sets the Color Grading 2D Lookup Texture.
  32020. */
  32021. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  32022. /**
  32023. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  32024. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  32025. * 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;
  32026. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  32027. */
  32028. get cameraColorCurves(): Nullable<ColorCurves>;
  32029. /**
  32030. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  32031. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  32032. * 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;
  32033. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  32034. */
  32035. set cameraColorCurves(value: Nullable<ColorCurves>);
  32036. /**
  32037. * Can this material render to several textures at once
  32038. */
  32039. get canRenderToMRT(): boolean;
  32040. /**
  32041. * Defines the detail map parameters for the material.
  32042. */
  32043. readonly detailMap: DetailMapConfiguration;
  32044. protected _renderTargets: SmartArray<RenderTargetTexture>;
  32045. protected _worldViewProjectionMatrix: Matrix;
  32046. protected _globalAmbientColor: Color3;
  32047. protected _useLogarithmicDepth: boolean;
  32048. protected _rebuildInParallel: boolean;
  32049. /**
  32050. * Instantiates a new standard material.
  32051. * This is the default material used in Babylon. It is the best trade off between quality
  32052. * and performances.
  32053. * @see https://doc.babylonjs.com/babylon101/materials
  32054. * @param name Define the name of the material in the scene
  32055. * @param scene Define the scene the material belong to
  32056. */
  32057. constructor(name: string, scene: Scene);
  32058. /**
  32059. * Gets a boolean indicating that current material needs to register RTT
  32060. */
  32061. get hasRenderTargetTextures(): boolean;
  32062. /**
  32063. * Gets the current class name of the material e.g. "StandardMaterial"
  32064. * Mainly use in serialization.
  32065. * @returns the class name
  32066. */
  32067. getClassName(): string;
  32068. /**
  32069. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  32070. * You can try switching to logarithmic depth.
  32071. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  32072. */
  32073. get useLogarithmicDepth(): boolean;
  32074. set useLogarithmicDepth(value: boolean);
  32075. /**
  32076. * Specifies if the material will require alpha blending
  32077. * @returns a boolean specifying if alpha blending is needed
  32078. */
  32079. needAlphaBlending(): boolean;
  32080. /**
  32081. * Specifies if this material should be rendered in alpha test mode
  32082. * @returns a boolean specifying if an alpha test is needed.
  32083. */
  32084. needAlphaTesting(): boolean;
  32085. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  32086. /**
  32087. * Get the texture used for alpha test purpose.
  32088. * @returns the diffuse texture in case of the standard material.
  32089. */
  32090. getAlphaTestTexture(): Nullable<BaseTexture>;
  32091. /**
  32092. * Get if the submesh is ready to be used and all its information available.
  32093. * Child classes can use it to update shaders
  32094. * @param mesh defines the mesh to check
  32095. * @param subMesh defines which submesh to check
  32096. * @param useInstances specifies that instances should be used
  32097. * @returns a boolean indicating that the submesh is ready or not
  32098. */
  32099. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  32100. /**
  32101. * Builds the material UBO layouts.
  32102. * Used internally during the effect preparation.
  32103. */
  32104. buildUniformLayout(): void;
  32105. /**
  32106. * Unbinds the material from the mesh
  32107. */
  32108. unbind(): void;
  32109. /**
  32110. * Binds the submesh to this material by preparing the effect and shader to draw
  32111. * @param world defines the world transformation matrix
  32112. * @param mesh defines the mesh containing the submesh
  32113. * @param subMesh defines the submesh to bind the material to
  32114. */
  32115. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  32116. /**
  32117. * Get the list of animatables in the material.
  32118. * @returns the list of animatables object used in the material
  32119. */
  32120. getAnimatables(): IAnimatable[];
  32121. /**
  32122. * Gets the active textures from the material
  32123. * @returns an array of textures
  32124. */
  32125. getActiveTextures(): BaseTexture[];
  32126. /**
  32127. * Specifies if the material uses a texture
  32128. * @param texture defines the texture to check against the material
  32129. * @returns a boolean specifying if the material uses the texture
  32130. */
  32131. hasTexture(texture: BaseTexture): boolean;
  32132. /**
  32133. * Disposes the material
  32134. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  32135. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  32136. */
  32137. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  32138. /**
  32139. * Makes a duplicate of the material, and gives it a new name
  32140. * @param name defines the new name for the duplicated material
  32141. * @returns the cloned material
  32142. */
  32143. clone(name: string): StandardMaterial;
  32144. /**
  32145. * Serializes this material in a JSON representation
  32146. * @returns the serialized material object
  32147. */
  32148. serialize(): any;
  32149. /**
  32150. * Creates a standard material from parsed material data
  32151. * @param source defines the JSON representation of the material
  32152. * @param scene defines the hosting scene
  32153. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  32154. * @returns a new standard material
  32155. */
  32156. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  32157. /**
  32158. * Are diffuse textures enabled in the application.
  32159. */
  32160. static get DiffuseTextureEnabled(): boolean;
  32161. static set DiffuseTextureEnabled(value: boolean);
  32162. /**
  32163. * Are detail textures enabled in the application.
  32164. */
  32165. static get DetailTextureEnabled(): boolean;
  32166. static set DetailTextureEnabled(value: boolean);
  32167. /**
  32168. * Are ambient textures enabled in the application.
  32169. */
  32170. static get AmbientTextureEnabled(): boolean;
  32171. static set AmbientTextureEnabled(value: boolean);
  32172. /**
  32173. * Are opacity textures enabled in the application.
  32174. */
  32175. static get OpacityTextureEnabled(): boolean;
  32176. static set OpacityTextureEnabled(value: boolean);
  32177. /**
  32178. * Are reflection textures enabled in the application.
  32179. */
  32180. static get ReflectionTextureEnabled(): boolean;
  32181. static set ReflectionTextureEnabled(value: boolean);
  32182. /**
  32183. * Are emissive textures enabled in the application.
  32184. */
  32185. static get EmissiveTextureEnabled(): boolean;
  32186. static set EmissiveTextureEnabled(value: boolean);
  32187. /**
  32188. * Are specular textures enabled in the application.
  32189. */
  32190. static get SpecularTextureEnabled(): boolean;
  32191. static set SpecularTextureEnabled(value: boolean);
  32192. /**
  32193. * Are bump textures enabled in the application.
  32194. */
  32195. static get BumpTextureEnabled(): boolean;
  32196. static set BumpTextureEnabled(value: boolean);
  32197. /**
  32198. * Are lightmap textures enabled in the application.
  32199. */
  32200. static get LightmapTextureEnabled(): boolean;
  32201. static set LightmapTextureEnabled(value: boolean);
  32202. /**
  32203. * Are refraction textures enabled in the application.
  32204. */
  32205. static get RefractionTextureEnabled(): boolean;
  32206. static set RefractionTextureEnabled(value: boolean);
  32207. /**
  32208. * Are color grading textures enabled in the application.
  32209. */
  32210. static get ColorGradingTextureEnabled(): boolean;
  32211. static set ColorGradingTextureEnabled(value: boolean);
  32212. /**
  32213. * Are fresnels enabled in the application.
  32214. */
  32215. static get FresnelEnabled(): boolean;
  32216. static set FresnelEnabled(value: boolean);
  32217. }
  32218. }
  32219. declare module "babylonjs/Particles/solidParticleSystem" {
  32220. import { Nullable } from "babylonjs/types";
  32221. import { Mesh } from "babylonjs/Meshes/mesh";
  32222. import { Scene, IDisposable } from "babylonjs/scene";
  32223. import { DepthSortedParticle, SolidParticle, SolidParticleVertex } from "babylonjs/Particles/solidParticle";
  32224. import { Material } from "babylonjs/Materials/material";
  32225. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  32226. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  32227. /**
  32228. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  32229. *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.
  32230. * The SPS is also a particle system. It provides some methods to manage the particles.
  32231. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  32232. *
  32233. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  32234. */
  32235. export class SolidParticleSystem implements IDisposable {
  32236. /**
  32237. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  32238. * Example : var p = SPS.particles[i];
  32239. */
  32240. particles: SolidParticle[];
  32241. /**
  32242. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  32243. */
  32244. nbParticles: number;
  32245. /**
  32246. * If the particles must ever face the camera (default false). Useful for planar particles.
  32247. */
  32248. billboard: boolean;
  32249. /**
  32250. * Recompute normals when adding a shape
  32251. */
  32252. recomputeNormals: boolean;
  32253. /**
  32254. * This a counter ofr your own usage. It's not set by any SPS functions.
  32255. */
  32256. counter: number;
  32257. /**
  32258. * The SPS name. This name is also given to the underlying mesh.
  32259. */
  32260. name: string;
  32261. /**
  32262. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  32263. */
  32264. mesh: Mesh;
  32265. /**
  32266. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  32267. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  32268. */
  32269. vars: any;
  32270. /**
  32271. * This array is populated when the SPS is set as 'pickable'.
  32272. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  32273. * Each element of this array is an object `{idx: int, faceId: int}`.
  32274. * `idx` is the picked particle index in the `SPS.particles` array
  32275. * `faceId` is the picked face index counted within this particle.
  32276. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  32277. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  32278. * Use the method SPS.pickedParticle(pickingInfo) instead.
  32279. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  32280. */
  32281. pickedParticles: {
  32282. idx: number;
  32283. faceId: number;
  32284. }[];
  32285. /**
  32286. * This array is populated when the SPS is set as 'pickable'
  32287. * Each key of this array is a submesh index.
  32288. * Each element of this array is a second array defined like this :
  32289. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  32290. * Each element of this second array is an object `{idx: int, faceId: int}`.
  32291. * `idx` is the picked particle index in the `SPS.particles` array
  32292. * `faceId` is the picked face index counted within this particle.
  32293. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  32294. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  32295. */
  32296. pickedBySubMesh: {
  32297. idx: number;
  32298. faceId: number;
  32299. }[][];
  32300. /**
  32301. * This array is populated when `enableDepthSort` is set to true.
  32302. * Each element of this array is an instance of the class DepthSortedParticle.
  32303. */
  32304. depthSortedParticles: DepthSortedParticle[];
  32305. /**
  32306. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  32307. * @hidden
  32308. */
  32309. _bSphereOnly: boolean;
  32310. /**
  32311. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  32312. * @hidden
  32313. */
  32314. _bSphereRadiusFactor: number;
  32315. private _scene;
  32316. private _positions;
  32317. private _indices;
  32318. private _normals;
  32319. private _colors;
  32320. private _uvs;
  32321. private _indices32;
  32322. private _positions32;
  32323. private _normals32;
  32324. private _fixedNormal32;
  32325. private _colors32;
  32326. private _uvs32;
  32327. private _index;
  32328. private _updatable;
  32329. private _pickable;
  32330. private _isVisibilityBoxLocked;
  32331. private _alwaysVisible;
  32332. private _depthSort;
  32333. private _expandable;
  32334. private _shapeCounter;
  32335. private _copy;
  32336. private _color;
  32337. private _computeParticleColor;
  32338. private _computeParticleTexture;
  32339. private _computeParticleRotation;
  32340. private _computeParticleVertex;
  32341. private _computeBoundingBox;
  32342. private _depthSortParticles;
  32343. private _camera;
  32344. private _mustUnrotateFixedNormals;
  32345. private _particlesIntersect;
  32346. private _needs32Bits;
  32347. private _isNotBuilt;
  32348. private _lastParticleId;
  32349. private _idxOfId;
  32350. private _multimaterialEnabled;
  32351. private _useModelMaterial;
  32352. private _indicesByMaterial;
  32353. private _materialIndexes;
  32354. private _depthSortFunction;
  32355. private _materialSortFunction;
  32356. private _materials;
  32357. private _multimaterial;
  32358. private _materialIndexesById;
  32359. private _defaultMaterial;
  32360. private _autoUpdateSubMeshes;
  32361. private _tmpVertex;
  32362. /**
  32363. * Creates a SPS (Solid Particle System) object.
  32364. * @param name (String) is the SPS name, this will be the underlying mesh name.
  32365. * @param scene (Scene) is the scene in which the SPS is added.
  32366. * @param options defines the options of the sps e.g.
  32367. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  32368. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  32369. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  32370. * * 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.
  32371. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  32372. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  32373. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  32374. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  32375. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  32376. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  32377. */
  32378. constructor(name: string, scene: Scene, options?: {
  32379. updatable?: boolean;
  32380. isPickable?: boolean;
  32381. enableDepthSort?: boolean;
  32382. particleIntersection?: boolean;
  32383. boundingSphereOnly?: boolean;
  32384. bSphereRadiusFactor?: number;
  32385. expandable?: boolean;
  32386. useModelMaterial?: boolean;
  32387. enableMultiMaterial?: boolean;
  32388. });
  32389. /**
  32390. * Builds the SPS underlying mesh. Returns a standard Mesh.
  32391. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  32392. * @returns the created mesh
  32393. */
  32394. buildMesh(): Mesh;
  32395. /**
  32396. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  32397. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  32398. * Thus the particles generated from `digest()` have their property `position` set yet.
  32399. * @param mesh ( Mesh ) is the mesh to be digested
  32400. * @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
  32401. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  32402. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  32403. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32404. * @returns the current SPS
  32405. */
  32406. digest(mesh: Mesh, options?: {
  32407. facetNb?: number;
  32408. number?: number;
  32409. delta?: number;
  32410. storage?: [];
  32411. }): SolidParticleSystem;
  32412. /**
  32413. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  32414. * @hidden
  32415. */
  32416. private _unrotateFixedNormals;
  32417. /**
  32418. * Resets the temporary working copy particle
  32419. * @hidden
  32420. */
  32421. private _resetCopy;
  32422. /**
  32423. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  32424. * @param p the current index in the positions array to be updated
  32425. * @param ind the current index in the indices array
  32426. * @param shape a Vector3 array, the shape geometry
  32427. * @param positions the positions array to be updated
  32428. * @param meshInd the shape indices array
  32429. * @param indices the indices array to be updated
  32430. * @param meshUV the shape uv array
  32431. * @param uvs the uv array to be updated
  32432. * @param meshCol the shape color array
  32433. * @param colors the color array to be updated
  32434. * @param meshNor the shape normals array
  32435. * @param normals the normals array to be updated
  32436. * @param idx the particle index
  32437. * @param idxInShape the particle index in its shape
  32438. * @param options the addShape() method passed options
  32439. * @model the particle model
  32440. * @hidden
  32441. */
  32442. private _meshBuilder;
  32443. /**
  32444. * Returns a shape Vector3 array from positions float array
  32445. * @param positions float array
  32446. * @returns a vector3 array
  32447. * @hidden
  32448. */
  32449. private _posToShape;
  32450. /**
  32451. * Returns a shapeUV array from a float uvs (array deep copy)
  32452. * @param uvs as a float array
  32453. * @returns a shapeUV array
  32454. * @hidden
  32455. */
  32456. private _uvsToShapeUV;
  32457. /**
  32458. * Adds a new particle object in the particles array
  32459. * @param idx particle index in particles array
  32460. * @param id particle id
  32461. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  32462. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  32463. * @param model particle ModelShape object
  32464. * @param shapeId model shape identifier
  32465. * @param idxInShape index of the particle in the current model
  32466. * @param bInfo model bounding info object
  32467. * @param storage target storage array, if any
  32468. * @hidden
  32469. */
  32470. private _addParticle;
  32471. /**
  32472. * Adds some particles to the SPS from the model shape. Returns the shape id.
  32473. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  32474. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  32475. * @param nb (positive integer) the number of particles to be created from this model
  32476. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  32477. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  32478. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32479. * @returns the number of shapes in the system
  32480. */
  32481. addShape(mesh: Mesh, nb: number, options?: {
  32482. positionFunction?: any;
  32483. vertexFunction?: any;
  32484. storage?: [];
  32485. }): number;
  32486. /**
  32487. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  32488. * @hidden
  32489. */
  32490. private _rebuildParticle;
  32491. /**
  32492. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  32493. * @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.
  32494. * @returns the SPS.
  32495. */
  32496. rebuildMesh(reset?: boolean): SolidParticleSystem;
  32497. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  32498. * Returns an array with the removed particles.
  32499. * 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.
  32500. * The SPS can't be empty so at least one particle needs to remain in place.
  32501. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  32502. * @param start index of the first particle to remove
  32503. * @param end index of the last particle to remove (included)
  32504. * @returns an array populated with the removed particles
  32505. */
  32506. removeParticles(start: number, end: number): SolidParticle[];
  32507. /**
  32508. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  32509. * @param solidParticleArray an array populated with Solid Particles objects
  32510. * @returns the SPS
  32511. */
  32512. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  32513. /**
  32514. * Creates a new particle and modifies the SPS mesh geometry :
  32515. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  32516. * - calls _addParticle() to populate the particle array
  32517. * factorized code from addShape() and insertParticlesFromArray()
  32518. * @param idx particle index in the particles array
  32519. * @param i particle index in its shape
  32520. * @param modelShape particle ModelShape object
  32521. * @param shape shape vertex array
  32522. * @param meshInd shape indices array
  32523. * @param meshUV shape uv array
  32524. * @param meshCol shape color array
  32525. * @param meshNor shape normals array
  32526. * @param bbInfo shape bounding info
  32527. * @param storage target particle storage
  32528. * @options addShape() passed options
  32529. * @hidden
  32530. */
  32531. private _insertNewParticle;
  32532. /**
  32533. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  32534. * This method calls `updateParticle()` for each particle of the SPS.
  32535. * For an animated SPS, it is usually called within the render loop.
  32536. * 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.
  32537. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  32538. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  32539. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  32540. * @returns the SPS.
  32541. */
  32542. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  32543. /**
  32544. * Disposes the SPS.
  32545. */
  32546. dispose(): void;
  32547. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  32548. * idx is the particle index in the SPS
  32549. * faceId is the picked face index counted within this particle.
  32550. * Returns null if the pickInfo can't identify a picked particle.
  32551. * @param pickingInfo (PickingInfo object)
  32552. * @returns {idx: number, faceId: number} or null
  32553. */
  32554. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  32555. idx: number;
  32556. faceId: number;
  32557. }>;
  32558. /**
  32559. * Returns a SolidParticle object from its identifier : particle.id
  32560. * @param id (integer) the particle Id
  32561. * @returns the searched particle or null if not found in the SPS.
  32562. */
  32563. getParticleById(id: number): Nullable<SolidParticle>;
  32564. /**
  32565. * Returns a new array populated with the particles having the passed shapeId.
  32566. * @param shapeId (integer) the shape identifier
  32567. * @returns a new solid particle array
  32568. */
  32569. getParticlesByShapeId(shapeId: number): SolidParticle[];
  32570. /**
  32571. * Populates the passed array "ref" with the particles having the passed shapeId.
  32572. * @param shapeId the shape identifier
  32573. * @returns the SPS
  32574. * @param ref
  32575. */
  32576. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  32577. /**
  32578. * Computes the required SubMeshes according the materials assigned to the particles.
  32579. * @returns the solid particle system.
  32580. * Does nothing if called before the SPS mesh is built.
  32581. */
  32582. computeSubMeshes(): SolidParticleSystem;
  32583. /**
  32584. * Sorts the solid particles by material when MultiMaterial is enabled.
  32585. * Updates the indices32 array.
  32586. * Updates the indicesByMaterial array.
  32587. * Updates the mesh indices array.
  32588. * @returns the SPS
  32589. * @hidden
  32590. */
  32591. private _sortParticlesByMaterial;
  32592. /**
  32593. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  32594. * @hidden
  32595. */
  32596. private _setMaterialIndexesById;
  32597. /**
  32598. * Returns an array with unique values of Materials from the passed array
  32599. * @param array the material array to be checked and filtered
  32600. * @hidden
  32601. */
  32602. private _filterUniqueMaterialId;
  32603. /**
  32604. * Sets a new Standard Material as _defaultMaterial if not already set.
  32605. * @hidden
  32606. */
  32607. private _setDefaultMaterial;
  32608. /**
  32609. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  32610. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32611. * @returns the SPS.
  32612. */
  32613. refreshVisibleSize(): SolidParticleSystem;
  32614. /**
  32615. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  32616. * @param size the size (float) of the visibility box
  32617. * note : this doesn't lock the SPS mesh bounding box.
  32618. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32619. */
  32620. setVisibilityBox(size: number): void;
  32621. /**
  32622. * Gets whether the SPS as always visible or not
  32623. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32624. */
  32625. get isAlwaysVisible(): boolean;
  32626. /**
  32627. * Sets the SPS as always visible or not
  32628. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32629. */
  32630. set isAlwaysVisible(val: boolean);
  32631. /**
  32632. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32633. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32634. */
  32635. set isVisibilityBoxLocked(val: boolean);
  32636. /**
  32637. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32638. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32639. */
  32640. get isVisibilityBoxLocked(): boolean;
  32641. /**
  32642. * Tells to `setParticles()` to compute the particle rotations or not.
  32643. * Default value : true. The SPS is faster when it's set to false.
  32644. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32645. */
  32646. set computeParticleRotation(val: boolean);
  32647. /**
  32648. * Tells to `setParticles()` to compute the particle colors or not.
  32649. * Default value : true. The SPS is faster when it's set to false.
  32650. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32651. */
  32652. set computeParticleColor(val: boolean);
  32653. set computeParticleTexture(val: boolean);
  32654. /**
  32655. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  32656. * Default value : false. The SPS is faster when it's set to false.
  32657. * Note : the particle custom vertex positions aren't stored values.
  32658. */
  32659. set computeParticleVertex(val: boolean);
  32660. /**
  32661. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  32662. */
  32663. set computeBoundingBox(val: boolean);
  32664. /**
  32665. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  32666. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32667. * Default : `true`
  32668. */
  32669. set depthSortParticles(val: boolean);
  32670. /**
  32671. * Gets if `setParticles()` computes the particle rotations or not.
  32672. * Default value : true. The SPS is faster when it's set to false.
  32673. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32674. */
  32675. get computeParticleRotation(): boolean;
  32676. /**
  32677. * Gets if `setParticles()` computes the particle colors or not.
  32678. * Default value : true. The SPS is faster when it's set to false.
  32679. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32680. */
  32681. get computeParticleColor(): boolean;
  32682. /**
  32683. * Gets if `setParticles()` computes the particle textures or not.
  32684. * Default value : true. The SPS is faster when it's set to false.
  32685. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  32686. */
  32687. get computeParticleTexture(): boolean;
  32688. /**
  32689. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  32690. * Default value : false. The SPS is faster when it's set to false.
  32691. * Note : the particle custom vertex positions aren't stored values.
  32692. */
  32693. get computeParticleVertex(): boolean;
  32694. /**
  32695. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  32696. */
  32697. get computeBoundingBox(): boolean;
  32698. /**
  32699. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  32700. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32701. * Default : `true`
  32702. */
  32703. get depthSortParticles(): boolean;
  32704. /**
  32705. * Gets if the SPS is created as expandable at construction time.
  32706. * Default : `false`
  32707. */
  32708. get expandable(): boolean;
  32709. /**
  32710. * Gets if the SPS supports the Multi Materials
  32711. */
  32712. get multimaterialEnabled(): boolean;
  32713. /**
  32714. * Gets if the SPS uses the model materials for its own multimaterial.
  32715. */
  32716. get useModelMaterial(): boolean;
  32717. /**
  32718. * The SPS used material array.
  32719. */
  32720. get materials(): Material[];
  32721. /**
  32722. * Sets the SPS MultiMaterial from the passed materials.
  32723. * Note : the passed array is internally copied and not used then by reference.
  32724. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  32725. */
  32726. setMultiMaterial(materials: Material[]): void;
  32727. /**
  32728. * The SPS computed multimaterial object
  32729. */
  32730. get multimaterial(): MultiMaterial;
  32731. set multimaterial(mm: MultiMaterial);
  32732. /**
  32733. * If the subMeshes must be updated on the next call to setParticles()
  32734. */
  32735. get autoUpdateSubMeshes(): boolean;
  32736. set autoUpdateSubMeshes(val: boolean);
  32737. /**
  32738. * This function does nothing. It may be overwritten to set all the particle first values.
  32739. * The SPS doesn't call this function, you may have to call it by your own.
  32740. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32741. */
  32742. initParticles(): void;
  32743. /**
  32744. * This function does nothing. It may be overwritten to recycle a particle.
  32745. * The SPS doesn't call this function, you may have to call it by your own.
  32746. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32747. * @param particle The particle to recycle
  32748. * @returns the recycled particle
  32749. */
  32750. recycleParticle(particle: SolidParticle): SolidParticle;
  32751. /**
  32752. * Updates a particle : this function should be overwritten by the user.
  32753. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  32754. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32755. * @example : just set a particle position or velocity and recycle conditions
  32756. * @param particle The particle to update
  32757. * @returns the updated particle
  32758. */
  32759. updateParticle(particle: SolidParticle): SolidParticle;
  32760. /**
  32761. * Updates a vertex of a particle : it can be overwritten by the user.
  32762. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  32763. * @param particle the current particle
  32764. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  32765. * @param pt the index of the current vertex in the particle shape
  32766. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  32767. * @example : just set a vertex particle position or color
  32768. * @returns the sps
  32769. */
  32770. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  32771. /**
  32772. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  32773. * This does nothing and may be overwritten by the user.
  32774. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32775. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32776. * @param update the boolean update value actually passed to setParticles()
  32777. */
  32778. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32779. /**
  32780. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  32781. * This will be passed three parameters.
  32782. * This does nothing and may be overwritten by the user.
  32783. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32784. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32785. * @param update the boolean update value actually passed to setParticles()
  32786. */
  32787. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32788. }
  32789. }
  32790. declare module "babylonjs/Particles/solidParticle" {
  32791. import { Nullable } from "babylonjs/types";
  32792. import { Vector3, Matrix, Quaternion, Vector4, Vector2 } from "babylonjs/Maths/math.vector";
  32793. import { Color4 } from "babylonjs/Maths/math.color";
  32794. import { Mesh } from "babylonjs/Meshes/mesh";
  32795. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  32796. import { SolidParticleSystem } from "babylonjs/Particles/solidParticleSystem";
  32797. import { Plane } from "babylonjs/Maths/math.plane";
  32798. import { Material } from "babylonjs/Materials/material";
  32799. /**
  32800. * Represents one particle of a solid particle system.
  32801. */
  32802. export class SolidParticle {
  32803. /**
  32804. * particle global index
  32805. */
  32806. idx: number;
  32807. /**
  32808. * particle identifier
  32809. */
  32810. id: number;
  32811. /**
  32812. * The color of the particle
  32813. */
  32814. color: Nullable<Color4>;
  32815. /**
  32816. * The world space position of the particle.
  32817. */
  32818. position: Vector3;
  32819. /**
  32820. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  32821. */
  32822. rotation: Vector3;
  32823. /**
  32824. * The world space rotation quaternion of the particle.
  32825. */
  32826. rotationQuaternion: Nullable<Quaternion>;
  32827. /**
  32828. * The scaling of the particle.
  32829. */
  32830. scaling: Vector3;
  32831. /**
  32832. * The uvs of the particle.
  32833. */
  32834. uvs: Vector4;
  32835. /**
  32836. * The current speed of the particle.
  32837. */
  32838. velocity: Vector3;
  32839. /**
  32840. * The pivot point in the particle local space.
  32841. */
  32842. pivot: Vector3;
  32843. /**
  32844. * Must the particle be translated from its pivot point in its local space ?
  32845. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  32846. * Default : false
  32847. */
  32848. translateFromPivot: boolean;
  32849. /**
  32850. * Is the particle active or not ?
  32851. */
  32852. alive: boolean;
  32853. /**
  32854. * Is the particle visible or not ?
  32855. */
  32856. isVisible: boolean;
  32857. /**
  32858. * Index of this particle in the global "positions" array (Internal use)
  32859. * @hidden
  32860. */
  32861. _pos: number;
  32862. /**
  32863. * @hidden Index of this particle in the global "indices" array (Internal use)
  32864. */
  32865. _ind: number;
  32866. /**
  32867. * @hidden ModelShape of this particle (Internal use)
  32868. */
  32869. _model: ModelShape;
  32870. /**
  32871. * ModelShape id of this particle
  32872. */
  32873. shapeId: number;
  32874. /**
  32875. * Index of the particle in its shape id
  32876. */
  32877. idxInShape: number;
  32878. /**
  32879. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  32880. */
  32881. _modelBoundingInfo: BoundingInfo;
  32882. /**
  32883. * @hidden Particle BoundingInfo object (Internal use)
  32884. */
  32885. _boundingInfo: BoundingInfo;
  32886. /**
  32887. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  32888. */
  32889. _sps: SolidParticleSystem;
  32890. /**
  32891. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  32892. */
  32893. _stillInvisible: boolean;
  32894. /**
  32895. * @hidden Last computed particle rotation matrix
  32896. */
  32897. _rotationMatrix: number[];
  32898. /**
  32899. * Parent particle Id, if any.
  32900. * Default null.
  32901. */
  32902. parentId: Nullable<number>;
  32903. /**
  32904. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  32905. */
  32906. materialIndex: Nullable<number>;
  32907. /**
  32908. * Custom object or properties.
  32909. */
  32910. props: Nullable<any>;
  32911. /**
  32912. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  32913. * The possible values are :
  32914. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  32915. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32916. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  32917. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  32918. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32919. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  32920. * */
  32921. cullingStrategy: number;
  32922. /**
  32923. * @hidden Internal global position in the SPS.
  32924. */
  32925. _globalPosition: Vector3;
  32926. /**
  32927. * Creates a Solid Particle object.
  32928. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  32929. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  32930. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  32931. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  32932. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  32933. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  32934. * @param shapeId (integer) is the model shape identifier in the SPS.
  32935. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  32936. * @param sps defines the sps it is associated to
  32937. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  32938. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  32939. */
  32940. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  32941. /**
  32942. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  32943. * @param target the particle target
  32944. * @returns the current particle
  32945. */
  32946. copyToRef(target: SolidParticle): SolidParticle;
  32947. /**
  32948. * Legacy support, changed scale to scaling
  32949. */
  32950. get scale(): Vector3;
  32951. /**
  32952. * Legacy support, changed scale to scaling
  32953. */
  32954. set scale(scale: Vector3);
  32955. /**
  32956. * Legacy support, changed quaternion to rotationQuaternion
  32957. */
  32958. get quaternion(): Nullable<Quaternion>;
  32959. /**
  32960. * Legacy support, changed quaternion to rotationQuaternion
  32961. */
  32962. set quaternion(q: Nullable<Quaternion>);
  32963. /**
  32964. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  32965. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  32966. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  32967. * @returns true if it intersects
  32968. */
  32969. intersectsMesh(target: Mesh | SolidParticle): boolean;
  32970. /**
  32971. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  32972. * A particle is in the frustum if its bounding box intersects the frustum
  32973. * @param frustumPlanes defines the frustum to test
  32974. * @returns true if the particle is in the frustum planes
  32975. */
  32976. isInFrustum(frustumPlanes: Plane[]): boolean;
  32977. /**
  32978. * get the rotation matrix of the particle
  32979. * @hidden
  32980. */
  32981. getRotationMatrix(m: Matrix): void;
  32982. }
  32983. /**
  32984. * Represents the shape of the model used by one particle of a solid particle system.
  32985. * SPS internal tool, don't use it manually.
  32986. */
  32987. export class ModelShape {
  32988. /**
  32989. * The shape id
  32990. * @hidden
  32991. */
  32992. shapeID: number;
  32993. /**
  32994. * flat array of model positions (internal use)
  32995. * @hidden
  32996. */
  32997. _shape: Vector3[];
  32998. /**
  32999. * flat array of model UVs (internal use)
  33000. * @hidden
  33001. */
  33002. _shapeUV: number[];
  33003. /**
  33004. * color array of the model
  33005. * @hidden
  33006. */
  33007. _shapeColors: number[];
  33008. /**
  33009. * indices array of the model
  33010. * @hidden
  33011. */
  33012. _indices: number[];
  33013. /**
  33014. * normals array of the model
  33015. * @hidden
  33016. */
  33017. _normals: number[];
  33018. /**
  33019. * length of the shape in the model indices array (internal use)
  33020. * @hidden
  33021. */
  33022. _indicesLength: number;
  33023. /**
  33024. * Custom position function (internal use)
  33025. * @hidden
  33026. */
  33027. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  33028. /**
  33029. * Custom vertex function (internal use)
  33030. * @hidden
  33031. */
  33032. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  33033. /**
  33034. * Model material (internal use)
  33035. * @hidden
  33036. */
  33037. _material: Nullable<Material>;
  33038. /**
  33039. * 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.
  33040. * SPS internal tool, don't use it manually.
  33041. * @hidden
  33042. */
  33043. 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>);
  33044. }
  33045. /**
  33046. * Represents a Depth Sorted Particle in the solid particle system.
  33047. * @hidden
  33048. */
  33049. export class DepthSortedParticle {
  33050. /**
  33051. * Particle index
  33052. */
  33053. idx: number;
  33054. /**
  33055. * Index of the particle in the "indices" array
  33056. */
  33057. ind: number;
  33058. /**
  33059. * Length of the particle shape in the "indices" array
  33060. */
  33061. indicesLength: number;
  33062. /**
  33063. * Squared distance from the particle to the camera
  33064. */
  33065. sqDistance: number;
  33066. /**
  33067. * Material index when used with MultiMaterials
  33068. */
  33069. materialIndex: number;
  33070. /**
  33071. * Creates a new sorted particle
  33072. * @param materialIndex
  33073. */
  33074. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  33075. }
  33076. /**
  33077. * Represents a solid particle vertex
  33078. */
  33079. export class SolidParticleVertex {
  33080. /**
  33081. * Vertex position
  33082. */
  33083. position: Vector3;
  33084. /**
  33085. * Vertex color
  33086. */
  33087. color: Color4;
  33088. /**
  33089. * Vertex UV
  33090. */
  33091. uv: Vector2;
  33092. /**
  33093. * Creates a new solid particle vertex
  33094. */
  33095. constructor();
  33096. /** Vertex x coordinate */
  33097. get x(): number;
  33098. set x(val: number);
  33099. /** Vertex y coordinate */
  33100. get y(): number;
  33101. set y(val: number);
  33102. /** Vertex z coordinate */
  33103. get z(): number;
  33104. set z(val: number);
  33105. }
  33106. }
  33107. declare module "babylonjs/Collisions/meshCollisionData" {
  33108. import { Collider } from "babylonjs/Collisions/collider";
  33109. import { Vector3 } from "babylonjs/Maths/math.vector";
  33110. import { Nullable } from "babylonjs/types";
  33111. import { Observer } from "babylonjs/Misc/observable";
  33112. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33113. /**
  33114. * @hidden
  33115. */
  33116. export class _MeshCollisionData {
  33117. _checkCollisions: boolean;
  33118. _collisionMask: number;
  33119. _collisionGroup: number;
  33120. _surroundingMeshes: Nullable<AbstractMesh[]>;
  33121. _collider: Nullable<Collider>;
  33122. _oldPositionForCollisions: Vector3;
  33123. _diffPositionForCollisions: Vector3;
  33124. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  33125. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  33126. _collisionResponse: boolean;
  33127. }
  33128. }
  33129. declare module "babylonjs/Meshes/abstractMesh" {
  33130. import { Observable } from "babylonjs/Misc/observable";
  33131. import { Nullable, FloatArray, IndicesArray, DeepImmutable } from "babylonjs/types";
  33132. import { Camera } from "babylonjs/Cameras/camera";
  33133. import { Scene, IDisposable } from "babylonjs/scene";
  33134. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  33135. import { Node } from "babylonjs/node";
  33136. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  33137. import { TransformNode } from "babylonjs/Meshes/transformNode";
  33138. import { SubMesh } from "babylonjs/Meshes/subMesh";
  33139. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  33140. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  33141. import { Material } from "babylonjs/Materials/material";
  33142. import { Light } from "babylonjs/Lights/light";
  33143. import { Skeleton } from "babylonjs/Bones/skeleton";
  33144. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  33145. import { SolidParticle } from "babylonjs/Particles/solidParticle";
  33146. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  33147. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  33148. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  33149. import { Plane } from "babylonjs/Maths/math.plane";
  33150. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  33151. import { Ray } from "babylonjs/Culling/ray";
  33152. import { Collider } from "babylonjs/Collisions/collider";
  33153. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  33154. import { RenderingGroup } from "babylonjs/Rendering/renderingGroup";
  33155. /** @hidden */
  33156. class _FacetDataStorage {
  33157. facetPositions: Vector3[];
  33158. facetNormals: Vector3[];
  33159. facetPartitioning: number[][];
  33160. facetNb: number;
  33161. partitioningSubdivisions: number;
  33162. partitioningBBoxRatio: number;
  33163. facetDataEnabled: boolean;
  33164. facetParameters: any;
  33165. bbSize: Vector3;
  33166. subDiv: {
  33167. max: number;
  33168. X: number;
  33169. Y: number;
  33170. Z: number;
  33171. };
  33172. facetDepthSort: boolean;
  33173. facetDepthSortEnabled: boolean;
  33174. depthSortedIndices: IndicesArray;
  33175. depthSortedFacets: {
  33176. ind: number;
  33177. sqDistance: number;
  33178. }[];
  33179. facetDepthSortFunction: (f1: {
  33180. ind: number;
  33181. sqDistance: number;
  33182. }, f2: {
  33183. ind: number;
  33184. sqDistance: number;
  33185. }) => number;
  33186. facetDepthSortFrom: Vector3;
  33187. facetDepthSortOrigin: Vector3;
  33188. invertedMatrix: Matrix;
  33189. }
  33190. /**
  33191. * @hidden
  33192. **/
  33193. class _InternalAbstractMeshDataInfo {
  33194. _hasVertexAlpha: boolean;
  33195. _useVertexColors: boolean;
  33196. _numBoneInfluencers: number;
  33197. _applyFog: boolean;
  33198. _receiveShadows: boolean;
  33199. _facetData: _FacetDataStorage;
  33200. _visibility: number;
  33201. _skeleton: Nullable<Skeleton>;
  33202. _layerMask: number;
  33203. _computeBonesUsingShaders: boolean;
  33204. _isActive: boolean;
  33205. _onlyForInstances: boolean;
  33206. _isActiveIntermediate: boolean;
  33207. _onlyForInstancesIntermediate: boolean;
  33208. _actAsRegularMesh: boolean;
  33209. }
  33210. /**
  33211. * Class used to store all common mesh properties
  33212. */
  33213. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  33214. /** No occlusion */
  33215. static OCCLUSION_TYPE_NONE: number;
  33216. /** Occlusion set to optimisitic */
  33217. static OCCLUSION_TYPE_OPTIMISTIC: number;
  33218. /** Occlusion set to strict */
  33219. static OCCLUSION_TYPE_STRICT: number;
  33220. /** Use an accurante occlusion algorithm */
  33221. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  33222. /** Use a conservative occlusion algorithm */
  33223. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  33224. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  33225. * Test order :
  33226. * Is the bounding sphere outside the frustum ?
  33227. * If not, are the bounding box vertices outside the frustum ?
  33228. * It not, then the cullable object is in the frustum.
  33229. */
  33230. static readonly CULLINGSTRATEGY_STANDARD: number;
  33231. /** Culling strategy : Bounding Sphere Only.
  33232. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  33233. * It's also less accurate than the standard because some not visible objects can still be selected.
  33234. * Test : is the bounding sphere outside the frustum ?
  33235. * If not, then the cullable object is in the frustum.
  33236. */
  33237. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  33238. /** Culling strategy : Optimistic Inclusion.
  33239. * This in an inclusion test first, then the standard exclusion test.
  33240. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  33241. * 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.
  33242. * Anyway, it's as accurate as the standard strategy.
  33243. * Test :
  33244. * Is the cullable object bounding sphere center in the frustum ?
  33245. * If not, apply the default culling strategy.
  33246. */
  33247. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  33248. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  33249. * This in an inclusion test first, then the bounding sphere only exclusion test.
  33250. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  33251. * 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.
  33252. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  33253. * Test :
  33254. * Is the cullable object bounding sphere center in the frustum ?
  33255. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  33256. */
  33257. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  33258. /**
  33259. * No billboard
  33260. */
  33261. static get BILLBOARDMODE_NONE(): number;
  33262. /** Billboard on X axis */
  33263. static get BILLBOARDMODE_X(): number;
  33264. /** Billboard on Y axis */
  33265. static get BILLBOARDMODE_Y(): number;
  33266. /** Billboard on Z axis */
  33267. static get BILLBOARDMODE_Z(): number;
  33268. /** Billboard on all axes */
  33269. static get BILLBOARDMODE_ALL(): number;
  33270. /** Billboard on using position instead of orientation */
  33271. static get BILLBOARDMODE_USE_POSITION(): number;
  33272. /** @hidden */
  33273. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  33274. /**
  33275. * The culling strategy to use to check whether the mesh must be rendered or not.
  33276. * This value can be changed at any time and will be used on the next render mesh selection.
  33277. * The possible values are :
  33278. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  33279. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  33280. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  33281. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  33282. * Please read each static variable documentation to get details about the culling process.
  33283. * */
  33284. cullingStrategy: number;
  33285. /**
  33286. * Gets the number of facets in the mesh
  33287. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  33288. */
  33289. get facetNb(): number;
  33290. /**
  33291. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  33292. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  33293. */
  33294. get partitioningSubdivisions(): number;
  33295. set partitioningSubdivisions(nb: number);
  33296. /**
  33297. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  33298. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  33299. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  33300. */
  33301. get partitioningBBoxRatio(): number;
  33302. set partitioningBBoxRatio(ratio: number);
  33303. /**
  33304. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  33305. * Works only for updatable meshes.
  33306. * Doesn't work with multi-materials
  33307. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  33308. */
  33309. get mustDepthSortFacets(): boolean;
  33310. set mustDepthSortFacets(sort: boolean);
  33311. /**
  33312. * The location (Vector3) where the facet depth sort must be computed from.
  33313. * By default, the active camera position.
  33314. * Used only when facet depth sort is enabled
  33315. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  33316. */
  33317. get facetDepthSortFrom(): Vector3;
  33318. set facetDepthSortFrom(location: Vector3);
  33319. /**
  33320. * gets a boolean indicating if facetData is enabled
  33321. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  33322. */
  33323. get isFacetDataEnabled(): boolean;
  33324. /** @hidden */
  33325. _updateNonUniformScalingState(value: boolean): boolean;
  33326. /**
  33327. * An event triggered when this mesh collides with another one
  33328. */
  33329. onCollideObservable: Observable<AbstractMesh>;
  33330. /** Set a function to call when this mesh collides with another one */
  33331. set onCollide(callback: () => void);
  33332. /**
  33333. * An event triggered when the collision's position changes
  33334. */
  33335. onCollisionPositionChangeObservable: Observable<Vector3>;
  33336. /** Set a function to call when the collision's position changes */
  33337. set onCollisionPositionChange(callback: () => void);
  33338. /**
  33339. * An event triggered when material is changed
  33340. */
  33341. onMaterialChangedObservable: Observable<AbstractMesh>;
  33342. /**
  33343. * Gets or sets the orientation for POV movement & rotation
  33344. */
  33345. definedFacingForward: boolean;
  33346. /** @hidden */
  33347. _occlusionQuery: Nullable<WebGLQuery>;
  33348. /** @hidden */
  33349. _renderingGroup: Nullable<RenderingGroup>;
  33350. /**
  33351. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  33352. */
  33353. get visibility(): number;
  33354. /**
  33355. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  33356. */
  33357. set visibility(value: number);
  33358. /** Gets or sets the alpha index used to sort transparent meshes
  33359. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  33360. */
  33361. alphaIndex: number;
  33362. /**
  33363. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  33364. */
  33365. isVisible: boolean;
  33366. /**
  33367. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  33368. */
  33369. isPickable: boolean;
  33370. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  33371. showSubMeshesBoundingBox: boolean;
  33372. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  33373. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  33374. */
  33375. isBlocker: boolean;
  33376. /**
  33377. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  33378. */
  33379. enablePointerMoveEvents: boolean;
  33380. private _renderingGroupId;
  33381. /**
  33382. * Specifies the rendering group id for this mesh (0 by default)
  33383. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  33384. */
  33385. get renderingGroupId(): number;
  33386. set renderingGroupId(value: number);
  33387. private _material;
  33388. /** Gets or sets current material */
  33389. get material(): Nullable<Material>;
  33390. set material(value: Nullable<Material>);
  33391. /**
  33392. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  33393. * @see https://doc.babylonjs.com/babylon101/shadows
  33394. */
  33395. get receiveShadows(): boolean;
  33396. set receiveShadows(value: boolean);
  33397. /** Defines color to use when rendering outline */
  33398. outlineColor: Color3;
  33399. /** Define width to use when rendering outline */
  33400. outlineWidth: number;
  33401. /** Defines color to use when rendering overlay */
  33402. overlayColor: Color3;
  33403. /** Defines alpha to use when rendering overlay */
  33404. overlayAlpha: number;
  33405. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  33406. get hasVertexAlpha(): boolean;
  33407. set hasVertexAlpha(value: boolean);
  33408. /** 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) */
  33409. get useVertexColors(): boolean;
  33410. set useVertexColors(value: boolean);
  33411. /**
  33412. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  33413. */
  33414. get computeBonesUsingShaders(): boolean;
  33415. set computeBonesUsingShaders(value: boolean);
  33416. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  33417. get numBoneInfluencers(): number;
  33418. set numBoneInfluencers(value: number);
  33419. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  33420. get applyFog(): boolean;
  33421. set applyFog(value: boolean);
  33422. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  33423. useOctreeForRenderingSelection: boolean;
  33424. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  33425. useOctreeForPicking: boolean;
  33426. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  33427. useOctreeForCollisions: boolean;
  33428. /**
  33429. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  33430. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  33431. */
  33432. get layerMask(): number;
  33433. set layerMask(value: number);
  33434. /**
  33435. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  33436. */
  33437. alwaysSelectAsActiveMesh: boolean;
  33438. /**
  33439. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  33440. */
  33441. doNotSyncBoundingInfo: boolean;
  33442. /**
  33443. * Gets or sets the current action manager
  33444. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  33445. */
  33446. actionManager: Nullable<AbstractActionManager>;
  33447. private _meshCollisionData;
  33448. /**
  33449. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  33450. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33451. */
  33452. ellipsoid: Vector3;
  33453. /**
  33454. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  33455. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33456. */
  33457. ellipsoidOffset: Vector3;
  33458. /**
  33459. * Gets or sets a collision mask used to mask collisions (default is -1).
  33460. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33461. */
  33462. get collisionMask(): number;
  33463. set collisionMask(mask: number);
  33464. /**
  33465. * Gets or sets a collision response flag (default is true).
  33466. * when collisionResponse is false, events are still triggered but colliding entity has no response
  33467. * This helps creating trigger volume when user wants collision feedback events but not position/velocity
  33468. * to respond to the collision.
  33469. */
  33470. get collisionResponse(): boolean;
  33471. set collisionResponse(response: boolean);
  33472. /**
  33473. * Gets or sets the current collision group mask (-1 by default).
  33474. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33475. */
  33476. get collisionGroup(): number;
  33477. set collisionGroup(mask: number);
  33478. /**
  33479. * Gets or sets current surrounding meshes (null by default).
  33480. *
  33481. * By default collision detection is tested against every mesh in the scene.
  33482. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  33483. * meshes will be tested for the collision.
  33484. *
  33485. * Note: if set to an empty array no collision will happen when this mesh is moved.
  33486. */
  33487. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  33488. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  33489. /**
  33490. * Defines edge width used when edgesRenderer is enabled
  33491. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33492. */
  33493. edgesWidth: number;
  33494. /**
  33495. * Defines edge color used when edgesRenderer is enabled
  33496. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33497. */
  33498. edgesColor: Color4;
  33499. /** @hidden */
  33500. _edgesRenderer: Nullable<IEdgesRenderer>;
  33501. /** @hidden */
  33502. _masterMesh: Nullable<AbstractMesh>;
  33503. /** @hidden */
  33504. _boundingInfo: Nullable<BoundingInfo>;
  33505. /** @hidden */
  33506. _renderId: number;
  33507. /**
  33508. * Gets or sets the list of subMeshes
  33509. * @see https://doc.babylonjs.com/how_to/multi_materials
  33510. */
  33511. subMeshes: SubMesh[];
  33512. /** @hidden */
  33513. _intersectionsInProgress: AbstractMesh[];
  33514. /** @hidden */
  33515. _unIndexed: boolean;
  33516. /** @hidden */
  33517. _lightSources: Light[];
  33518. /** Gets the list of lights affecting that mesh */
  33519. get lightSources(): Light[];
  33520. /** @hidden */
  33521. get _positions(): Nullable<Vector3[]>;
  33522. /** @hidden */
  33523. _waitingData: {
  33524. lods: Nullable<any>;
  33525. actions: Nullable<any>;
  33526. freezeWorldMatrix: Nullable<boolean>;
  33527. };
  33528. /** @hidden */
  33529. _bonesTransformMatrices: Nullable<Float32Array>;
  33530. /** @hidden */
  33531. _transformMatrixTexture: Nullable<RawTexture>;
  33532. /**
  33533. * Gets or sets a skeleton to apply skining transformations
  33534. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  33535. */
  33536. set skeleton(value: Nullable<Skeleton>);
  33537. get skeleton(): Nullable<Skeleton>;
  33538. /**
  33539. * An event triggered when the mesh is rebuilt.
  33540. */
  33541. onRebuildObservable: Observable<AbstractMesh>;
  33542. /**
  33543. * Creates a new AbstractMesh
  33544. * @param name defines the name of the mesh
  33545. * @param scene defines the hosting scene
  33546. */
  33547. constructor(name: string, scene?: Nullable<Scene>);
  33548. /**
  33549. * Returns the string "AbstractMesh"
  33550. * @returns "AbstractMesh"
  33551. */
  33552. getClassName(): string;
  33553. /**
  33554. * Gets a string representation of the current mesh
  33555. * @param fullDetails defines a boolean indicating if full details must be included
  33556. * @returns a string representation of the current mesh
  33557. */
  33558. toString(fullDetails?: boolean): string;
  33559. /**
  33560. * @hidden
  33561. */
  33562. protected _getEffectiveParent(): Nullable<Node>;
  33563. /** @hidden */
  33564. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  33565. /** @hidden */
  33566. _rebuild(): void;
  33567. /** @hidden */
  33568. _resyncLightSources(): void;
  33569. /** @hidden */
  33570. _resyncLightSource(light: Light): void;
  33571. /** @hidden */
  33572. _unBindEffect(): void;
  33573. /** @hidden */
  33574. _removeLightSource(light: Light, dispose: boolean): void;
  33575. private _markSubMeshesAsDirty;
  33576. /** @hidden */
  33577. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  33578. /** @hidden */
  33579. _markSubMeshesAsAttributesDirty(): void;
  33580. /** @hidden */
  33581. _markSubMeshesAsMiscDirty(): void;
  33582. /**
  33583. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  33584. */
  33585. get scaling(): Vector3;
  33586. set scaling(newScaling: Vector3);
  33587. /**
  33588. * Returns true if the mesh is blocked. Implemented by child classes
  33589. */
  33590. get isBlocked(): boolean;
  33591. /**
  33592. * Returns the mesh itself by default. Implemented by child classes
  33593. * @param camera defines the camera to use to pick the right LOD level
  33594. * @returns the currentAbstractMesh
  33595. */
  33596. getLOD(camera: Camera): Nullable<AbstractMesh>;
  33597. /**
  33598. * Returns 0 by default. Implemented by child classes
  33599. * @returns an integer
  33600. */
  33601. getTotalVertices(): number;
  33602. /**
  33603. * Returns a positive integer : the total number of indices in this mesh geometry.
  33604. * @returns the numner of indices or zero if the mesh has no geometry.
  33605. */
  33606. getTotalIndices(): number;
  33607. /**
  33608. * Returns null by default. Implemented by child classes
  33609. * @returns null
  33610. */
  33611. getIndices(): Nullable<IndicesArray>;
  33612. /**
  33613. * Returns the array of the requested vertex data kind. Implemented by child classes
  33614. * @param kind defines the vertex data kind to use
  33615. * @returns null
  33616. */
  33617. getVerticesData(kind: string): Nullable<FloatArray>;
  33618. /**
  33619. * Sets the vertex data of the mesh geometry for the requested `kind`.
  33620. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  33621. * Note that a new underlying VertexBuffer object is created each call.
  33622. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  33623. * @param kind defines vertex data kind:
  33624. * * VertexBuffer.PositionKind
  33625. * * VertexBuffer.UVKind
  33626. * * VertexBuffer.UV2Kind
  33627. * * VertexBuffer.UV3Kind
  33628. * * VertexBuffer.UV4Kind
  33629. * * VertexBuffer.UV5Kind
  33630. * * VertexBuffer.UV6Kind
  33631. * * VertexBuffer.ColorKind
  33632. * * VertexBuffer.MatricesIndicesKind
  33633. * * VertexBuffer.MatricesIndicesExtraKind
  33634. * * VertexBuffer.MatricesWeightsKind
  33635. * * VertexBuffer.MatricesWeightsExtraKind
  33636. * @param data defines the data source
  33637. * @param updatable defines if the data must be flagged as updatable (or static)
  33638. * @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
  33639. * @returns the current mesh
  33640. */
  33641. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  33642. /**
  33643. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  33644. * If the mesh has no geometry, it is simply returned as it is.
  33645. * @param kind defines vertex data kind:
  33646. * * VertexBuffer.PositionKind
  33647. * * VertexBuffer.UVKind
  33648. * * VertexBuffer.UV2Kind
  33649. * * VertexBuffer.UV3Kind
  33650. * * VertexBuffer.UV4Kind
  33651. * * VertexBuffer.UV5Kind
  33652. * * VertexBuffer.UV6Kind
  33653. * * VertexBuffer.ColorKind
  33654. * * VertexBuffer.MatricesIndicesKind
  33655. * * VertexBuffer.MatricesIndicesExtraKind
  33656. * * VertexBuffer.MatricesWeightsKind
  33657. * * VertexBuffer.MatricesWeightsExtraKind
  33658. * @param data defines the data source
  33659. * @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
  33660. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  33661. * @returns the current mesh
  33662. */
  33663. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  33664. /**
  33665. * Sets the mesh indices,
  33666. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  33667. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  33668. * @param totalVertices Defines the total number of vertices
  33669. * @returns the current mesh
  33670. */
  33671. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  33672. /**
  33673. * Gets a boolean indicating if specific vertex data is present
  33674. * @param kind defines the vertex data kind to use
  33675. * @returns true is data kind is present
  33676. */
  33677. isVerticesDataPresent(kind: string): boolean;
  33678. /**
  33679. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  33680. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  33681. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  33682. * @returns a BoundingInfo
  33683. */
  33684. getBoundingInfo(): BoundingInfo;
  33685. /**
  33686. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  33687. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  33688. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  33689. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  33690. * @returns the current mesh
  33691. */
  33692. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  33693. /**
  33694. * Overwrite the current bounding info
  33695. * @param boundingInfo defines the new bounding info
  33696. * @returns the current mesh
  33697. */
  33698. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  33699. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  33700. get useBones(): boolean;
  33701. /** @hidden */
  33702. _preActivate(): void;
  33703. /** @hidden */
  33704. _preActivateForIntermediateRendering(renderId: number): void;
  33705. /** @hidden */
  33706. _activate(renderId: number, intermediateRendering: boolean): boolean;
  33707. /** @hidden */
  33708. _postActivate(): void;
  33709. /** @hidden */
  33710. _freeze(): void;
  33711. /** @hidden */
  33712. _unFreeze(): void;
  33713. /**
  33714. * Gets the current world matrix
  33715. * @returns a Matrix
  33716. */
  33717. getWorldMatrix(): Matrix;
  33718. /** @hidden */
  33719. _getWorldMatrixDeterminant(): number;
  33720. /**
  33721. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  33722. */
  33723. get isAnInstance(): boolean;
  33724. /**
  33725. * Gets a boolean indicating if this mesh has instances
  33726. */
  33727. get hasInstances(): boolean;
  33728. /**
  33729. * Gets a boolean indicating if this mesh has thin instances
  33730. */
  33731. get hasThinInstances(): boolean;
  33732. /**
  33733. * Perform relative position change from the point of view of behind the front of the mesh.
  33734. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33735. * Supports definition of mesh facing forward or backward
  33736. * @param amountRight defines the distance on the right axis
  33737. * @param amountUp defines the distance on the up axis
  33738. * @param amountForward defines the distance on the forward axis
  33739. * @returns the current mesh
  33740. */
  33741. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  33742. /**
  33743. * Calculate relative position change from the point of view of behind the front of the mesh.
  33744. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33745. * Supports definition of mesh facing forward or backward
  33746. * @param amountRight defines the distance on the right axis
  33747. * @param amountUp defines the distance on the up axis
  33748. * @param amountForward defines the distance on the forward axis
  33749. * @returns the new displacement vector
  33750. */
  33751. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  33752. /**
  33753. * Perform relative rotation change from the point of view of behind the front of the mesh.
  33754. * Supports definition of mesh facing forward or backward
  33755. * @param flipBack defines the flip
  33756. * @param twirlClockwise defines the twirl
  33757. * @param tiltRight defines the tilt
  33758. * @returns the current mesh
  33759. */
  33760. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  33761. /**
  33762. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  33763. * Supports definition of mesh facing forward or backward.
  33764. * @param flipBack defines the flip
  33765. * @param twirlClockwise defines the twirl
  33766. * @param tiltRight defines the tilt
  33767. * @returns the new rotation vector
  33768. */
  33769. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  33770. /**
  33771. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  33772. * This means the mesh underlying bounding box and sphere are recomputed.
  33773. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  33774. * @returns the current mesh
  33775. */
  33776. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  33777. /** @hidden */
  33778. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  33779. /** @hidden */
  33780. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  33781. /** @hidden */
  33782. _updateBoundingInfo(): AbstractMesh;
  33783. /** @hidden */
  33784. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  33785. /** @hidden */
  33786. protected _afterComputeWorldMatrix(): void;
  33787. /** @hidden */
  33788. get _effectiveMesh(): AbstractMesh;
  33789. /**
  33790. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  33791. * A mesh is in the frustum if its bounding box intersects the frustum
  33792. * @param frustumPlanes defines the frustum to test
  33793. * @returns true if the mesh is in the frustum planes
  33794. */
  33795. isInFrustum(frustumPlanes: Plane[]): boolean;
  33796. /**
  33797. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  33798. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  33799. * @param frustumPlanes defines the frustum to test
  33800. * @returns true if the mesh is completely in the frustum planes
  33801. */
  33802. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  33803. /**
  33804. * True if the mesh intersects another mesh or a SolidParticle object
  33805. * @param mesh defines a target mesh or SolidParticle to test
  33806. * @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)
  33807. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  33808. * @returns true if there is an intersection
  33809. */
  33810. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  33811. /**
  33812. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  33813. * @param point defines the point to test
  33814. * @returns true if there is an intersection
  33815. */
  33816. intersectsPoint(point: Vector3): boolean;
  33817. /**
  33818. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  33819. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33820. */
  33821. get checkCollisions(): boolean;
  33822. set checkCollisions(collisionEnabled: boolean);
  33823. /**
  33824. * Gets Collider object used to compute collisions (not physics)
  33825. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33826. */
  33827. get collider(): Nullable<Collider>;
  33828. /**
  33829. * Move the mesh using collision engine
  33830. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33831. * @param displacement defines the requested displacement vector
  33832. * @returns the current mesh
  33833. */
  33834. moveWithCollisions(displacement: Vector3): AbstractMesh;
  33835. private _onCollisionPositionChange;
  33836. /** @hidden */
  33837. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  33838. /** @hidden */
  33839. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  33840. /** @hidden */
  33841. _checkCollision(collider: Collider): AbstractMesh;
  33842. /** @hidden */
  33843. _generatePointsArray(): boolean;
  33844. /**
  33845. * Checks if the passed Ray intersects with the mesh
  33846. * @param ray defines the ray to use
  33847. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  33848. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  33849. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  33850. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  33851. * @returns the picking info
  33852. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  33853. */
  33854. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  33855. /**
  33856. * Clones the current mesh
  33857. * @param name defines the mesh name
  33858. * @param newParent defines the new mesh parent
  33859. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  33860. * @returns the new mesh
  33861. */
  33862. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  33863. /**
  33864. * Disposes all the submeshes of the current meshnp
  33865. * @returns the current mesh
  33866. */
  33867. releaseSubMeshes(): AbstractMesh;
  33868. /**
  33869. * Releases resources associated with this abstract mesh.
  33870. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  33871. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  33872. */
  33873. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  33874. /**
  33875. * Adds the passed mesh as a child to the current mesh
  33876. * @param mesh defines the child mesh
  33877. * @returns the current mesh
  33878. */
  33879. addChild(mesh: AbstractMesh): AbstractMesh;
  33880. /**
  33881. * Removes the passed mesh from the current mesh children list
  33882. * @param mesh defines the child mesh
  33883. * @returns the current mesh
  33884. */
  33885. removeChild(mesh: AbstractMesh): AbstractMesh;
  33886. /** @hidden */
  33887. private _initFacetData;
  33888. /**
  33889. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  33890. * This method can be called within the render loop.
  33891. * 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
  33892. * @returns the current mesh
  33893. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33894. */
  33895. updateFacetData(): AbstractMesh;
  33896. /**
  33897. * Returns the facetLocalNormals array.
  33898. * The normals are expressed in the mesh local spac
  33899. * @returns an array of Vector3
  33900. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33901. */
  33902. getFacetLocalNormals(): Vector3[];
  33903. /**
  33904. * Returns the facetLocalPositions array.
  33905. * The facet positions are expressed in the mesh local space
  33906. * @returns an array of Vector3
  33907. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33908. */
  33909. getFacetLocalPositions(): Vector3[];
  33910. /**
  33911. * Returns the facetLocalPartioning array
  33912. * @returns an array of array of numbers
  33913. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33914. */
  33915. getFacetLocalPartitioning(): number[][];
  33916. /**
  33917. * Returns the i-th facet position in the world system.
  33918. * This method allocates a new Vector3 per call
  33919. * @param i defines the facet index
  33920. * @returns a new Vector3
  33921. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33922. */
  33923. getFacetPosition(i: number): Vector3;
  33924. /**
  33925. * Sets the reference Vector3 with the i-th facet position in the world system
  33926. * @param i defines the facet index
  33927. * @param ref defines the target vector
  33928. * @returns the current mesh
  33929. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33930. */
  33931. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  33932. /**
  33933. * Returns the i-th facet normal in the world system.
  33934. * This method allocates a new Vector3 per call
  33935. * @param i defines the facet index
  33936. * @returns a new Vector3
  33937. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33938. */
  33939. getFacetNormal(i: number): Vector3;
  33940. /**
  33941. * Sets the reference Vector3 with the i-th facet normal in the world system
  33942. * @param i defines the facet index
  33943. * @param ref defines the target vector
  33944. * @returns the current mesh
  33945. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33946. */
  33947. getFacetNormalToRef(i: number, ref: Vector3): this;
  33948. /**
  33949. * 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)
  33950. * @param x defines x coordinate
  33951. * @param y defines y coordinate
  33952. * @param z defines z coordinate
  33953. * @returns the array of facet indexes
  33954. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33955. */
  33956. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  33957. /**
  33958. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  33959. * @param projected sets as the (x,y,z) world projection on the facet
  33960. * @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
  33961. * @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
  33962. * @param x defines x coordinate
  33963. * @param y defines y coordinate
  33964. * @param z defines z coordinate
  33965. * @returns the face index if found (or null instead)
  33966. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33967. */
  33968. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33969. /**
  33970. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  33971. * @param projected sets as the (x,y,z) local projection on the facet
  33972. * @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
  33973. * @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
  33974. * @param x defines x coordinate
  33975. * @param y defines y coordinate
  33976. * @param z defines z coordinate
  33977. * @returns the face index if found (or null instead)
  33978. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33979. */
  33980. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33981. /**
  33982. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  33983. * @returns the parameters
  33984. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33985. */
  33986. getFacetDataParameters(): any;
  33987. /**
  33988. * Disables the feature FacetData and frees the related memory
  33989. * @returns the current mesh
  33990. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33991. */
  33992. disableFacetData(): AbstractMesh;
  33993. /**
  33994. * Updates the AbstractMesh indices array
  33995. * @param indices defines the data source
  33996. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  33997. * @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)
  33998. * @returns the current mesh
  33999. */
  34000. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  34001. /**
  34002. * Creates new normals data for the mesh
  34003. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  34004. * @returns the current mesh
  34005. */
  34006. createNormals(updatable: boolean): AbstractMesh;
  34007. /**
  34008. * Align the mesh with a normal
  34009. * @param normal defines the normal to use
  34010. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  34011. * @returns the current mesh
  34012. */
  34013. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  34014. /** @hidden */
  34015. _checkOcclusionQuery(): boolean;
  34016. /**
  34017. * Disables the mesh edge rendering mode
  34018. * @returns the currentAbstractMesh
  34019. */
  34020. disableEdgesRendering(): AbstractMesh;
  34021. /**
  34022. * Enables the edge rendering mode on the mesh.
  34023. * This mode makes the mesh edges visible
  34024. * @param epsilon defines the maximal distance between two angles to detect a face
  34025. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  34026. * @returns the currentAbstractMesh
  34027. * @see https://www.babylonjs-playground.com/#19O9TU#0
  34028. */
  34029. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  34030. /**
  34031. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  34032. * @returns an array of particle systems in the scene that use the mesh as an emitter
  34033. */
  34034. getConnectedParticleSystems(): IParticleSystem[];
  34035. }
  34036. }
  34037. declare module "babylonjs/Actions/actionEvent" {
  34038. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  34039. import { Nullable } from "babylonjs/types";
  34040. import { Sprite } from "babylonjs/Sprites/sprite";
  34041. import { Scene } from "babylonjs/scene";
  34042. import { Vector2 } from "babylonjs/Maths/math.vector";
  34043. /**
  34044. * Interface used to define ActionEvent
  34045. */
  34046. export interface IActionEvent {
  34047. /** The mesh or sprite that triggered the action */
  34048. source: any;
  34049. /** The X mouse cursor position at the time of the event */
  34050. pointerX: number;
  34051. /** The Y mouse cursor position at the time of the event */
  34052. pointerY: number;
  34053. /** The mesh that is currently pointed at (can be null) */
  34054. meshUnderPointer: Nullable<AbstractMesh>;
  34055. /** the original (browser) event that triggered the ActionEvent */
  34056. sourceEvent?: any;
  34057. /** additional data for the event */
  34058. additionalData?: any;
  34059. }
  34060. /**
  34061. * ActionEvent is the event being sent when an action is triggered.
  34062. */
  34063. export class ActionEvent implements IActionEvent {
  34064. /** The mesh or sprite that triggered the action */
  34065. source: any;
  34066. /** The X mouse cursor position at the time of the event */
  34067. pointerX: number;
  34068. /** The Y mouse cursor position at the time of the event */
  34069. pointerY: number;
  34070. /** The mesh that is currently pointed at (can be null) */
  34071. meshUnderPointer: Nullable<AbstractMesh>;
  34072. /** the original (browser) event that triggered the ActionEvent */
  34073. sourceEvent?: any;
  34074. /** additional data for the event */
  34075. additionalData?: any;
  34076. /**
  34077. * Creates a new ActionEvent
  34078. * @param source The mesh or sprite that triggered the action
  34079. * @param pointerX The X mouse cursor position at the time of the event
  34080. * @param pointerY The Y mouse cursor position at the time of the event
  34081. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  34082. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  34083. * @param additionalData additional data for the event
  34084. */
  34085. constructor(
  34086. /** The mesh or sprite that triggered the action */
  34087. source: any,
  34088. /** The X mouse cursor position at the time of the event */
  34089. pointerX: number,
  34090. /** The Y mouse cursor position at the time of the event */
  34091. pointerY: number,
  34092. /** The mesh that is currently pointed at (can be null) */
  34093. meshUnderPointer: Nullable<AbstractMesh>,
  34094. /** the original (browser) event that triggered the ActionEvent */
  34095. sourceEvent?: any,
  34096. /** additional data for the event */
  34097. additionalData?: any);
  34098. /**
  34099. * Helper function to auto-create an ActionEvent from a source mesh.
  34100. * @param source The source mesh that triggered the event
  34101. * @param evt The original (browser) event
  34102. * @param additionalData additional data for the event
  34103. * @returns the new ActionEvent
  34104. */
  34105. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  34106. /**
  34107. * Helper function to auto-create an ActionEvent from a source sprite
  34108. * @param source The source sprite that triggered the event
  34109. * @param scene Scene associated with the sprite
  34110. * @param evt The original (browser) event
  34111. * @param additionalData additional data for the event
  34112. * @returns the new ActionEvent
  34113. */
  34114. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  34115. /**
  34116. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  34117. * @param scene the scene where the event occurred
  34118. * @param evt The original (browser) event
  34119. * @returns the new ActionEvent
  34120. */
  34121. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  34122. /**
  34123. * Helper function to auto-create an ActionEvent from a primitive
  34124. * @param prim defines the target primitive
  34125. * @param pointerPos defines the pointer position
  34126. * @param evt The original (browser) event
  34127. * @param additionalData additional data for the event
  34128. * @returns the new ActionEvent
  34129. */
  34130. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  34131. }
  34132. }
  34133. declare module "babylonjs/Actions/abstractActionManager" {
  34134. import { IDisposable } from "babylonjs/scene";
  34135. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  34136. import { IAction } from "babylonjs/Actions/action";
  34137. import { Nullable } from "babylonjs/types";
  34138. /**
  34139. * Abstract class used to decouple action Manager from scene and meshes.
  34140. * Do not instantiate.
  34141. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  34142. */
  34143. export abstract class AbstractActionManager implements IDisposable {
  34144. /** Gets the list of active triggers */
  34145. static Triggers: {
  34146. [key: string]: number;
  34147. };
  34148. /** Gets the cursor to use when hovering items */
  34149. hoverCursor: string;
  34150. /** Gets the list of actions */
  34151. actions: IAction[];
  34152. /**
  34153. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  34154. */
  34155. isRecursive: boolean;
  34156. /**
  34157. * Releases all associated resources
  34158. */
  34159. abstract dispose(): void;
  34160. /**
  34161. * Does this action manager has pointer triggers
  34162. */
  34163. abstract get hasPointerTriggers(): boolean;
  34164. /**
  34165. * Does this action manager has pick triggers
  34166. */
  34167. abstract get hasPickTriggers(): boolean;
  34168. /**
  34169. * Process a specific trigger
  34170. * @param trigger defines the trigger to process
  34171. * @param evt defines the event details to be processed
  34172. */
  34173. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  34174. /**
  34175. * Does this action manager handles actions of any of the given triggers
  34176. * @param triggers defines the triggers to be tested
  34177. * @return a boolean indicating whether one (or more) of the triggers is handled
  34178. */
  34179. abstract hasSpecificTriggers(triggers: number[]): boolean;
  34180. /**
  34181. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  34182. * speed.
  34183. * @param triggerA defines the trigger to be tested
  34184. * @param triggerB defines the trigger to be tested
  34185. * @return a boolean indicating whether one (or more) of the triggers is handled
  34186. */
  34187. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  34188. /**
  34189. * Does this action manager handles actions of a given trigger
  34190. * @param trigger defines the trigger to be tested
  34191. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  34192. * @return whether the trigger is handled
  34193. */
  34194. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  34195. /**
  34196. * Serialize this manager to a JSON object
  34197. * @param name defines the property name to store this manager
  34198. * @returns a JSON representation of this manager
  34199. */
  34200. abstract serialize(name: string): any;
  34201. /**
  34202. * Registers an action to this action manager
  34203. * @param action defines the action to be registered
  34204. * @return the action amended (prepared) after registration
  34205. */
  34206. abstract registerAction(action: IAction): Nullable<IAction>;
  34207. /**
  34208. * Unregisters an action to this action manager
  34209. * @param action defines the action to be unregistered
  34210. * @return a boolean indicating whether the action has been unregistered
  34211. */
  34212. abstract unregisterAction(action: IAction): Boolean;
  34213. /**
  34214. * Does exist one action manager with at least one trigger
  34215. **/
  34216. static get HasTriggers(): boolean;
  34217. /**
  34218. * Does exist one action manager with at least one pick trigger
  34219. **/
  34220. static get HasPickTriggers(): boolean;
  34221. /**
  34222. * Does exist one action manager that handles actions of a given trigger
  34223. * @param trigger defines the trigger to be tested
  34224. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  34225. **/
  34226. static HasSpecificTrigger(trigger: number): boolean;
  34227. }
  34228. }
  34229. declare module "babylonjs/node" {
  34230. import { Scene } from "babylonjs/scene";
  34231. import { Nullable } from "babylonjs/types";
  34232. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  34233. import { Engine } from "babylonjs/Engines/engine";
  34234. import { IBehaviorAware, Behavior } from "babylonjs/Behaviors/behavior";
  34235. import { Observable } from "babylonjs/Misc/observable";
  34236. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  34237. import { IInspectable } from "babylonjs/Misc/iInspectable";
  34238. import { Animatable } from "babylonjs/Animations/animatable";
  34239. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  34240. import { Animation } from "babylonjs/Animations/animation";
  34241. import { AnimationRange } from "babylonjs/Animations/animationRange";
  34242. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  34243. /**
  34244. * Defines how a node can be built from a string name.
  34245. */
  34246. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  34247. /**
  34248. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  34249. */
  34250. export class Node implements IBehaviorAware<Node> {
  34251. /** @hidden */
  34252. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  34253. private static _NodeConstructors;
  34254. /**
  34255. * Add a new node constructor
  34256. * @param type defines the type name of the node to construct
  34257. * @param constructorFunc defines the constructor function
  34258. */
  34259. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  34260. /**
  34261. * Returns a node constructor based on type name
  34262. * @param type defines the type name
  34263. * @param name defines the new node name
  34264. * @param scene defines the hosting scene
  34265. * @param options defines optional options to transmit to constructors
  34266. * @returns the new constructor or null
  34267. */
  34268. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  34269. /**
  34270. * Gets or sets the name of the node
  34271. */
  34272. name: string;
  34273. /**
  34274. * Gets or sets the id of the node
  34275. */
  34276. id: string;
  34277. /**
  34278. * Gets or sets the unique id of the node
  34279. */
  34280. uniqueId: number;
  34281. /**
  34282. * Gets or sets a string used to store user defined state for the node
  34283. */
  34284. state: string;
  34285. /**
  34286. * Gets or sets an object used to store user defined information for the node
  34287. */
  34288. metadata: any;
  34289. /**
  34290. * For internal use only. Please do not use.
  34291. */
  34292. reservedDataStore: any;
  34293. /**
  34294. * List of inspectable custom properties (used by the Inspector)
  34295. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  34296. */
  34297. inspectableCustomProperties: IInspectable[];
  34298. private _doNotSerialize;
  34299. /**
  34300. * Gets or sets a boolean used to define if the node must be serialized
  34301. */
  34302. get doNotSerialize(): boolean;
  34303. set doNotSerialize(value: boolean);
  34304. /** @hidden */
  34305. _isDisposed: boolean;
  34306. /**
  34307. * Gets a list of Animations associated with the node
  34308. */
  34309. animations: import("babylonjs/Animations/animation").Animation[];
  34310. protected _ranges: {
  34311. [name: string]: Nullable<AnimationRange>;
  34312. };
  34313. /**
  34314. * Callback raised when the node is ready to be used
  34315. */
  34316. onReady: Nullable<(node: Node) => void>;
  34317. private _isEnabled;
  34318. private _isParentEnabled;
  34319. private _isReady;
  34320. /** @hidden */
  34321. _currentRenderId: number;
  34322. private _parentUpdateId;
  34323. /** @hidden */
  34324. _childUpdateId: number;
  34325. /** @hidden */
  34326. _waitingParentId: Nullable<string>;
  34327. /** @hidden */
  34328. _scene: Scene;
  34329. /** @hidden */
  34330. _cache: any;
  34331. private _parentNode;
  34332. private _children;
  34333. /** @hidden */
  34334. _worldMatrix: Matrix;
  34335. /** @hidden */
  34336. _worldMatrixDeterminant: number;
  34337. /** @hidden */
  34338. _worldMatrixDeterminantIsDirty: boolean;
  34339. /** @hidden */
  34340. private _sceneRootNodesIndex;
  34341. /**
  34342. * Gets a boolean indicating if the node has been disposed
  34343. * @returns true if the node was disposed
  34344. */
  34345. isDisposed(): boolean;
  34346. /**
  34347. * Gets or sets the parent of the node (without keeping the current position in the scene)
  34348. * @see https://doc.babylonjs.com/how_to/parenting
  34349. */
  34350. set parent(parent: Nullable<Node>);
  34351. get parent(): Nullable<Node>;
  34352. /** @hidden */
  34353. _addToSceneRootNodes(): void;
  34354. /** @hidden */
  34355. _removeFromSceneRootNodes(): void;
  34356. private _animationPropertiesOverride;
  34357. /**
  34358. * Gets or sets the animation properties override
  34359. */
  34360. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  34361. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  34362. /**
  34363. * Gets a string identifying the name of the class
  34364. * @returns "Node" string
  34365. */
  34366. getClassName(): string;
  34367. /** @hidden */
  34368. readonly _isNode: boolean;
  34369. /**
  34370. * An event triggered when the mesh is disposed
  34371. */
  34372. onDisposeObservable: Observable<Node>;
  34373. private _onDisposeObserver;
  34374. /**
  34375. * Sets a callback that will be raised when the node will be disposed
  34376. */
  34377. set onDispose(callback: () => void);
  34378. /**
  34379. * Creates a new Node
  34380. * @param name the name and id to be given to this node
  34381. * @param scene the scene this node will be added to
  34382. */
  34383. constructor(name: string, scene?: Nullable<Scene>);
  34384. /**
  34385. * Gets the scene of the node
  34386. * @returns a scene
  34387. */
  34388. getScene(): Scene;
  34389. /**
  34390. * Gets the engine of the node
  34391. * @returns a Engine
  34392. */
  34393. getEngine(): Engine;
  34394. private _behaviors;
  34395. /**
  34396. * Attach a behavior to the node
  34397. * @see https://doc.babylonjs.com/features/behaviour
  34398. * @param behavior defines the behavior to attach
  34399. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  34400. * @returns the current Node
  34401. */
  34402. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  34403. /**
  34404. * Remove an attached behavior
  34405. * @see https://doc.babylonjs.com/features/behaviour
  34406. * @param behavior defines the behavior to attach
  34407. * @returns the current Node
  34408. */
  34409. removeBehavior(behavior: Behavior<Node>): Node;
  34410. /**
  34411. * Gets the list of attached behaviors
  34412. * @see https://doc.babylonjs.com/features/behaviour
  34413. */
  34414. get behaviors(): Behavior<Node>[];
  34415. /**
  34416. * Gets an attached behavior by name
  34417. * @param name defines the name of the behavior to look for
  34418. * @see https://doc.babylonjs.com/features/behaviour
  34419. * @returns null if behavior was not found else the requested behavior
  34420. */
  34421. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  34422. /**
  34423. * Returns the latest update of the World matrix
  34424. * @returns a Matrix
  34425. */
  34426. getWorldMatrix(): Matrix;
  34427. /** @hidden */
  34428. _getWorldMatrixDeterminant(): number;
  34429. /**
  34430. * Returns directly the latest state of the mesh World matrix.
  34431. * A Matrix is returned.
  34432. */
  34433. get worldMatrixFromCache(): Matrix;
  34434. /** @hidden */
  34435. _initCache(): void;
  34436. /** @hidden */
  34437. updateCache(force?: boolean): void;
  34438. /** @hidden */
  34439. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  34440. /** @hidden */
  34441. _updateCache(ignoreParentClass?: boolean): void;
  34442. /** @hidden */
  34443. _isSynchronized(): boolean;
  34444. /** @hidden */
  34445. _markSyncedWithParent(): void;
  34446. /** @hidden */
  34447. isSynchronizedWithParent(): boolean;
  34448. /** @hidden */
  34449. isSynchronized(): boolean;
  34450. /**
  34451. * Is this node ready to be used/rendered
  34452. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  34453. * @return true if the node is ready
  34454. */
  34455. isReady(completeCheck?: boolean): boolean;
  34456. /**
  34457. * Is this node enabled?
  34458. * 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
  34459. * @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
  34460. * @return whether this node (and its parent) is enabled
  34461. */
  34462. isEnabled(checkAncestors?: boolean): boolean;
  34463. /** @hidden */
  34464. protected _syncParentEnabledState(): void;
  34465. /**
  34466. * Set the enabled state of this node
  34467. * @param value defines the new enabled state
  34468. */
  34469. setEnabled(value: boolean): void;
  34470. /**
  34471. * Is this node a descendant of the given node?
  34472. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  34473. * @param ancestor defines the parent node to inspect
  34474. * @returns a boolean indicating if this node is a descendant of the given node
  34475. */
  34476. isDescendantOf(ancestor: Node): boolean;
  34477. /** @hidden */
  34478. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  34479. /**
  34480. * Will return all nodes that have this node as ascendant
  34481. * @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
  34482. * @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
  34483. * @return all children nodes of all types
  34484. */
  34485. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  34486. /**
  34487. * Get all child-meshes of this node
  34488. * @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)
  34489. * @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
  34490. * @returns an array of AbstractMesh
  34491. */
  34492. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  34493. /**
  34494. * Get all direct children of this node
  34495. * @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
  34496. * @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)
  34497. * @returns an array of Node
  34498. */
  34499. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  34500. /** @hidden */
  34501. _setReady(state: boolean): void;
  34502. /**
  34503. * Get an animation by name
  34504. * @param name defines the name of the animation to look for
  34505. * @returns null if not found else the requested animation
  34506. */
  34507. getAnimationByName(name: string): Nullable<Animation>;
  34508. /**
  34509. * Creates an animation range for this node
  34510. * @param name defines the name of the range
  34511. * @param from defines the starting key
  34512. * @param to defines the end key
  34513. */
  34514. createAnimationRange(name: string, from: number, to: number): void;
  34515. /**
  34516. * Delete a specific animation range
  34517. * @param name defines the name of the range to delete
  34518. * @param deleteFrames defines if animation frames from the range must be deleted as well
  34519. */
  34520. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  34521. /**
  34522. * Get an animation range by name
  34523. * @param name defines the name of the animation range to look for
  34524. * @returns null if not found else the requested animation range
  34525. */
  34526. getAnimationRange(name: string): Nullable<AnimationRange>;
  34527. /**
  34528. * Gets the list of all animation ranges defined on this node
  34529. * @returns an array
  34530. */
  34531. getAnimationRanges(): Nullable<AnimationRange>[];
  34532. /**
  34533. * Will start the animation sequence
  34534. * @param name defines the range frames for animation sequence
  34535. * @param loop defines if the animation should loop (false by default)
  34536. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  34537. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  34538. * @returns the object created for this animation. If range does not exist, it will return null
  34539. */
  34540. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  34541. /**
  34542. * Serialize animation ranges into a JSON compatible object
  34543. * @returns serialization object
  34544. */
  34545. serializeAnimationRanges(): any;
  34546. /**
  34547. * Computes the world matrix of the node
  34548. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  34549. * @returns the world matrix
  34550. */
  34551. computeWorldMatrix(force?: boolean): Matrix;
  34552. /**
  34553. * Releases resources associated with this node.
  34554. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  34555. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  34556. */
  34557. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  34558. /**
  34559. * Parse animation range data from a serialization object and store them into a given node
  34560. * @param node defines where to store the animation ranges
  34561. * @param parsedNode defines the serialization object to read data from
  34562. * @param scene defines the hosting scene
  34563. */
  34564. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  34565. /**
  34566. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  34567. * @param includeDescendants Include bounding info from descendants as well (true by default)
  34568. * @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
  34569. * @returns the new bounding vectors
  34570. */
  34571. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  34572. min: Vector3;
  34573. max: Vector3;
  34574. };
  34575. }
  34576. }
  34577. declare module "babylonjs/Animations/animation" {
  34578. import { IEasingFunction, EasingFunction } from "babylonjs/Animations/easing";
  34579. import { Vector3, Quaternion, Vector2, Matrix } from "babylonjs/Maths/math.vector";
  34580. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  34581. import { Nullable } from "babylonjs/types";
  34582. import { Scene } from "babylonjs/scene";
  34583. import { IAnimationKey } from "babylonjs/Animations/animationKey";
  34584. import { AnimationRange } from "babylonjs/Animations/animationRange";
  34585. import { AnimationEvent } from "babylonjs/Animations/animationEvent";
  34586. import { Node } from "babylonjs/node";
  34587. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34588. import { Size } from "babylonjs/Maths/math.size";
  34589. import { Animatable } from "babylonjs/Animations/animatable";
  34590. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  34591. /**
  34592. * @hidden
  34593. */
  34594. export class _IAnimationState {
  34595. key: number;
  34596. repeatCount: number;
  34597. workValue?: any;
  34598. loopMode?: number;
  34599. offsetValue?: any;
  34600. highLimitValue?: any;
  34601. }
  34602. /**
  34603. * Class used to store any kind of animation
  34604. */
  34605. export class Animation {
  34606. /**Name of the animation */
  34607. name: string;
  34608. /**Property to animate */
  34609. targetProperty: string;
  34610. /**The frames per second of the animation */
  34611. framePerSecond: number;
  34612. /**The data type of the animation */
  34613. dataType: number;
  34614. /**The loop mode of the animation */
  34615. loopMode?: number | undefined;
  34616. /**Specifies if blending should be enabled */
  34617. enableBlending?: boolean | undefined;
  34618. /**
  34619. * Use matrix interpolation instead of using direct key value when animating matrices
  34620. */
  34621. static AllowMatricesInterpolation: boolean;
  34622. /**
  34623. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  34624. */
  34625. static AllowMatrixDecomposeForInterpolation: boolean;
  34626. /** Define the Url to load snippets */
  34627. static SnippetUrl: string;
  34628. /** Snippet ID if the animation was created from the snippet server */
  34629. snippetId: string;
  34630. /**
  34631. * Stores the key frames of the animation
  34632. */
  34633. private _keys;
  34634. /**
  34635. * Stores the easing function of the animation
  34636. */
  34637. private _easingFunction;
  34638. /**
  34639. * @hidden Internal use only
  34640. */
  34641. _runtimeAnimations: import("babylonjs/Animations/runtimeAnimation").RuntimeAnimation[];
  34642. /**
  34643. * The set of event that will be linked to this animation
  34644. */
  34645. private _events;
  34646. /**
  34647. * Stores an array of target property paths
  34648. */
  34649. targetPropertyPath: string[];
  34650. /**
  34651. * Stores the blending speed of the animation
  34652. */
  34653. blendingSpeed: number;
  34654. /**
  34655. * Stores the animation ranges for the animation
  34656. */
  34657. private _ranges;
  34658. /**
  34659. * @hidden Internal use
  34660. */
  34661. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  34662. /**
  34663. * Sets up an animation
  34664. * @param property The property to animate
  34665. * @param animationType The animation type to apply
  34666. * @param framePerSecond The frames per second of the animation
  34667. * @param easingFunction The easing function used in the animation
  34668. * @returns The created animation
  34669. */
  34670. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  34671. /**
  34672. * Create and start an animation on a node
  34673. * @param name defines the name of the global animation that will be run on all nodes
  34674. * @param node defines the root node where the animation will take place
  34675. * @param targetProperty defines property to animate
  34676. * @param framePerSecond defines the number of frame per second yo use
  34677. * @param totalFrame defines the number of frames in total
  34678. * @param from defines the initial value
  34679. * @param to defines the final value
  34680. * @param loopMode defines which loop mode you want to use (off by default)
  34681. * @param easingFunction defines the easing function to use (linear by default)
  34682. * @param onAnimationEnd defines the callback to call when animation end
  34683. * @returns the animatable created for this animation
  34684. */
  34685. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34686. /**
  34687. * Create and start an animation on a node and its descendants
  34688. * @param name defines the name of the global animation that will be run on all nodes
  34689. * @param node defines the root node where the animation will take place
  34690. * @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
  34691. * @param targetProperty defines property to animate
  34692. * @param framePerSecond defines the number of frame per second to use
  34693. * @param totalFrame defines the number of frames in total
  34694. * @param from defines the initial value
  34695. * @param to defines the final value
  34696. * @param loopMode defines which loop mode you want to use (off by default)
  34697. * @param easingFunction defines the easing function to use (linear by default)
  34698. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  34699. * @returns the list of animatables created for all nodes
  34700. * @example https://www.babylonjs-playground.com/#MH0VLI
  34701. */
  34702. 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[]>;
  34703. /**
  34704. * Creates a new animation, merges it with the existing animations and starts it
  34705. * @param name Name of the animation
  34706. * @param node Node which contains the scene that begins the animations
  34707. * @param targetProperty Specifies which property to animate
  34708. * @param framePerSecond The frames per second of the animation
  34709. * @param totalFrame The total number of frames
  34710. * @param from The frame at the beginning of the animation
  34711. * @param to The frame at the end of the animation
  34712. * @param loopMode Specifies the loop mode of the animation
  34713. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  34714. * @param onAnimationEnd Callback to run once the animation is complete
  34715. * @returns Nullable animation
  34716. */
  34717. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34718. /**
  34719. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  34720. * @param sourceAnimation defines the Animation containing keyframes to convert
  34721. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  34722. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  34723. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  34724. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  34725. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  34726. */
  34727. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  34728. /**
  34729. * Transition property of an host to the target Value
  34730. * @param property The property to transition
  34731. * @param targetValue The target Value of the property
  34732. * @param host The object where the property to animate belongs
  34733. * @param scene Scene used to run the animation
  34734. * @param frameRate Framerate (in frame/s) to use
  34735. * @param transition The transition type we want to use
  34736. * @param duration The duration of the animation, in milliseconds
  34737. * @param onAnimationEnd Callback trigger at the end of the animation
  34738. * @returns Nullable animation
  34739. */
  34740. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  34741. /**
  34742. * Return the array of runtime animations currently using this animation
  34743. */
  34744. get runtimeAnimations(): RuntimeAnimation[];
  34745. /**
  34746. * Specifies if any of the runtime animations are currently running
  34747. */
  34748. get hasRunningRuntimeAnimations(): boolean;
  34749. /**
  34750. * Initializes the animation
  34751. * @param name Name of the animation
  34752. * @param targetProperty Property to animate
  34753. * @param framePerSecond The frames per second of the animation
  34754. * @param dataType The data type of the animation
  34755. * @param loopMode The loop mode of the animation
  34756. * @param enableBlending Specifies if blending should be enabled
  34757. */
  34758. constructor(
  34759. /**Name of the animation */
  34760. name: string,
  34761. /**Property to animate */
  34762. targetProperty: string,
  34763. /**The frames per second of the animation */
  34764. framePerSecond: number,
  34765. /**The data type of the animation */
  34766. dataType: number,
  34767. /**The loop mode of the animation */
  34768. loopMode?: number | undefined,
  34769. /**Specifies if blending should be enabled */
  34770. enableBlending?: boolean | undefined);
  34771. /**
  34772. * Converts the animation to a string
  34773. * @param fullDetails support for multiple levels of logging within scene loading
  34774. * @returns String form of the animation
  34775. */
  34776. toString(fullDetails?: boolean): string;
  34777. /**
  34778. * Add an event to this animation
  34779. * @param event Event to add
  34780. */
  34781. addEvent(event: AnimationEvent): void;
  34782. /**
  34783. * Remove all events found at the given frame
  34784. * @param frame The frame to remove events from
  34785. */
  34786. removeEvents(frame: number): void;
  34787. /**
  34788. * Retrieves all the events from the animation
  34789. * @returns Events from the animation
  34790. */
  34791. getEvents(): AnimationEvent[];
  34792. /**
  34793. * Creates an animation range
  34794. * @param name Name of the animation range
  34795. * @param from Starting frame of the animation range
  34796. * @param to Ending frame of the animation
  34797. */
  34798. createRange(name: string, from: number, to: number): void;
  34799. /**
  34800. * Deletes an animation range by name
  34801. * @param name Name of the animation range to delete
  34802. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  34803. */
  34804. deleteRange(name: string, deleteFrames?: boolean): void;
  34805. /**
  34806. * Gets the animation range by name, or null if not defined
  34807. * @param name Name of the animation range
  34808. * @returns Nullable animation range
  34809. */
  34810. getRange(name: string): Nullable<AnimationRange>;
  34811. /**
  34812. * Gets the key frames from the animation
  34813. * @returns The key frames of the animation
  34814. */
  34815. getKeys(): Array<IAnimationKey>;
  34816. /**
  34817. * Gets the highest frame rate of the animation
  34818. * @returns Highest frame rate of the animation
  34819. */
  34820. getHighestFrame(): number;
  34821. /**
  34822. * Gets the easing function of the animation
  34823. * @returns Easing function of the animation
  34824. */
  34825. getEasingFunction(): IEasingFunction;
  34826. /**
  34827. * Sets the easing function of the animation
  34828. * @param easingFunction A custom mathematical formula for animation
  34829. */
  34830. setEasingFunction(easingFunction: EasingFunction): void;
  34831. /**
  34832. * Interpolates a scalar linearly
  34833. * @param startValue Start value of the animation curve
  34834. * @param endValue End value of the animation curve
  34835. * @param gradient Scalar amount to interpolate
  34836. * @returns Interpolated scalar value
  34837. */
  34838. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  34839. /**
  34840. * Interpolates a scalar cubically
  34841. * @param startValue Start value of the animation curve
  34842. * @param outTangent End tangent of the animation
  34843. * @param endValue End value of the animation curve
  34844. * @param inTangent Start tangent of the animation curve
  34845. * @param gradient Scalar amount to interpolate
  34846. * @returns Interpolated scalar value
  34847. */
  34848. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  34849. /**
  34850. * Interpolates a quaternion using a spherical linear interpolation
  34851. * @param startValue Start value of the animation curve
  34852. * @param endValue End value of the animation curve
  34853. * @param gradient Scalar amount to interpolate
  34854. * @returns Interpolated quaternion value
  34855. */
  34856. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  34857. /**
  34858. * Interpolates a quaternion cubically
  34859. * @param startValue Start value of the animation curve
  34860. * @param outTangent End tangent of the animation curve
  34861. * @param endValue End value of the animation curve
  34862. * @param inTangent Start tangent of the animation curve
  34863. * @param gradient Scalar amount to interpolate
  34864. * @returns Interpolated quaternion value
  34865. */
  34866. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  34867. /**
  34868. * Interpolates a Vector3 linearl
  34869. * @param startValue Start value of the animation curve
  34870. * @param endValue End value of the animation curve
  34871. * @param gradient Scalar amount to interpolate
  34872. * @returns Interpolated scalar value
  34873. */
  34874. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  34875. /**
  34876. * Interpolates a Vector3 cubically
  34877. * @param startValue Start value of the animation curve
  34878. * @param outTangent End tangent of the animation
  34879. * @param endValue End value of the animation curve
  34880. * @param inTangent Start tangent of the animation curve
  34881. * @param gradient Scalar amount to interpolate
  34882. * @returns InterpolatedVector3 value
  34883. */
  34884. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  34885. /**
  34886. * Interpolates a Vector2 linearly
  34887. * @param startValue Start value of the animation curve
  34888. * @param endValue End value of the animation curve
  34889. * @param gradient Scalar amount to interpolate
  34890. * @returns Interpolated Vector2 value
  34891. */
  34892. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  34893. /**
  34894. * Interpolates a Vector2 cubically
  34895. * @param startValue Start value of the animation curve
  34896. * @param outTangent End tangent of the animation
  34897. * @param endValue End value of the animation curve
  34898. * @param inTangent Start tangent of the animation curve
  34899. * @param gradient Scalar amount to interpolate
  34900. * @returns Interpolated Vector2 value
  34901. */
  34902. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  34903. /**
  34904. * Interpolates a size linearly
  34905. * @param startValue Start value of the animation curve
  34906. * @param endValue End value of the animation curve
  34907. * @param gradient Scalar amount to interpolate
  34908. * @returns Interpolated Size value
  34909. */
  34910. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  34911. /**
  34912. * Interpolates a Color3 linearly
  34913. * @param startValue Start value of the animation curve
  34914. * @param endValue End value of the animation curve
  34915. * @param gradient Scalar amount to interpolate
  34916. * @returns Interpolated Color3 value
  34917. */
  34918. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  34919. /**
  34920. * Interpolates a Color4 linearly
  34921. * @param startValue Start value of the animation curve
  34922. * @param endValue End value of the animation curve
  34923. * @param gradient Scalar amount to interpolate
  34924. * @returns Interpolated Color3 value
  34925. */
  34926. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  34927. /**
  34928. * @hidden Internal use only
  34929. */
  34930. _getKeyValue(value: any): any;
  34931. /**
  34932. * @hidden Internal use only
  34933. */
  34934. _interpolate(currentFrame: number, state: _IAnimationState): any;
  34935. /**
  34936. * Defines the function to use to interpolate matrices
  34937. * @param startValue defines the start matrix
  34938. * @param endValue defines the end matrix
  34939. * @param gradient defines the gradient between both matrices
  34940. * @param result defines an optional target matrix where to store the interpolation
  34941. * @returns the interpolated matrix
  34942. */
  34943. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  34944. /**
  34945. * Makes a copy of the animation
  34946. * @returns Cloned animation
  34947. */
  34948. clone(): Animation;
  34949. /**
  34950. * Sets the key frames of the animation
  34951. * @param values The animation key frames to set
  34952. */
  34953. setKeys(values: Array<IAnimationKey>): void;
  34954. /**
  34955. * Serializes the animation to an object
  34956. * @returns Serialized object
  34957. */
  34958. serialize(): any;
  34959. /**
  34960. * Float animation type
  34961. */
  34962. static readonly ANIMATIONTYPE_FLOAT: number;
  34963. /**
  34964. * Vector3 animation type
  34965. */
  34966. static readonly ANIMATIONTYPE_VECTOR3: number;
  34967. /**
  34968. * Quaternion animation type
  34969. */
  34970. static readonly ANIMATIONTYPE_QUATERNION: number;
  34971. /**
  34972. * Matrix animation type
  34973. */
  34974. static readonly ANIMATIONTYPE_MATRIX: number;
  34975. /**
  34976. * Color3 animation type
  34977. */
  34978. static readonly ANIMATIONTYPE_COLOR3: number;
  34979. /**
  34980. * Color3 animation type
  34981. */
  34982. static readonly ANIMATIONTYPE_COLOR4: number;
  34983. /**
  34984. * Vector2 animation type
  34985. */
  34986. static readonly ANIMATIONTYPE_VECTOR2: number;
  34987. /**
  34988. * Size animation type
  34989. */
  34990. static readonly ANIMATIONTYPE_SIZE: number;
  34991. /**
  34992. * Relative Loop Mode
  34993. */
  34994. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  34995. /**
  34996. * Cycle Loop Mode
  34997. */
  34998. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  34999. /**
  35000. * Constant Loop Mode
  35001. */
  35002. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  35003. /** @hidden */
  35004. static _UniversalLerp(left: any, right: any, amount: number): any;
  35005. /**
  35006. * Parses an animation object and creates an animation
  35007. * @param parsedAnimation Parsed animation object
  35008. * @returns Animation object
  35009. */
  35010. static Parse(parsedAnimation: any): Animation;
  35011. /**
  35012. * Appends the serialized animations from the source animations
  35013. * @param source Source containing the animations
  35014. * @param destination Target to store the animations
  35015. */
  35016. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  35017. /**
  35018. * Creates a new animation or an array of animations from a snippet saved in a remote file
  35019. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  35020. * @param url defines the url to load from
  35021. * @returns a promise that will resolve to the new animation or an array of animations
  35022. */
  35023. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  35024. /**
  35025. * Creates an animation or an array of animations from a snippet saved by the Inspector
  35026. * @param snippetId defines the snippet to load
  35027. * @returns a promise that will resolve to the new animation or a new array of animations
  35028. */
  35029. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  35030. }
  35031. }
  35032. declare module "babylonjs/Animations/animatable.interface" {
  35033. import { Nullable } from "babylonjs/types";
  35034. import { Animation } from "babylonjs/Animations/animation";
  35035. /**
  35036. * Interface containing an array of animations
  35037. */
  35038. export interface IAnimatable {
  35039. /**
  35040. * Array of animations
  35041. */
  35042. animations: Nullable<Array<Animation>>;
  35043. }
  35044. }
  35045. declare module "babylonjs/Misc/decorators" {
  35046. import { Nullable } from "babylonjs/types";
  35047. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  35048. import { Scene } from "babylonjs/scene";
  35049. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  35050. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  35051. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  35052. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  35053. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  35054. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35055. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35056. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35057. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35058. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35059. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35060. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35061. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35062. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35063. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35064. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35065. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35066. /**
  35067. * Decorator used to define property that can be serialized as reference to a camera
  35068. * @param sourceName defines the name of the property to decorate
  35069. */
  35070. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  35071. /**
  35072. * Class used to help serialization objects
  35073. */
  35074. export class SerializationHelper {
  35075. /** @hidden */
  35076. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  35077. /** @hidden */
  35078. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  35079. /** @hidden */
  35080. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  35081. /** @hidden */
  35082. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  35083. /**
  35084. * Appends the serialized animations from the source animations
  35085. * @param source Source containing the animations
  35086. * @param destination Target to store the animations
  35087. */
  35088. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  35089. /**
  35090. * Static function used to serialized a specific entity
  35091. * @param entity defines the entity to serialize
  35092. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  35093. * @returns a JSON compatible object representing the serialization of the entity
  35094. */
  35095. static Serialize<T>(entity: T, serializationObject?: any): any;
  35096. /**
  35097. * Creates a new entity from a serialization data object
  35098. * @param creationFunction defines a function used to instanciated the new entity
  35099. * @param source defines the source serialization data
  35100. * @param scene defines the hosting scene
  35101. * @param rootUrl defines the root url for resources
  35102. * @returns a new entity
  35103. */
  35104. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  35105. /**
  35106. * Clones an object
  35107. * @param creationFunction defines the function used to instanciate the new object
  35108. * @param source defines the source object
  35109. * @returns the cloned object
  35110. */
  35111. static Clone<T>(creationFunction: () => T, source: T): T;
  35112. /**
  35113. * Instanciates a new object based on a source one (some data will be shared between both object)
  35114. * @param creationFunction defines the function used to instanciate the new object
  35115. * @param source defines the source object
  35116. * @returns the new object
  35117. */
  35118. static Instanciate<T>(creationFunction: () => T, source: T): T;
  35119. }
  35120. }
  35121. declare module "babylonjs/Materials/Textures/baseTexture" {
  35122. import { Observable } from "babylonjs/Misc/observable";
  35123. import { Nullable } from "babylonjs/types";
  35124. import { Scene } from "babylonjs/scene";
  35125. import { Matrix } from "babylonjs/Maths/math.vector";
  35126. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35127. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  35128. import { ISize } from "babylonjs/Maths/math.size";
  35129. import "babylonjs/Misc/fileTools";
  35130. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  35131. /**
  35132. * Base class of all the textures in babylon.
  35133. * It groups all the common properties the materials, post process, lights... might need
  35134. * in order to make a correct use of the texture.
  35135. */
  35136. export class BaseTexture implements IAnimatable {
  35137. /**
  35138. * Default anisotropic filtering level for the application.
  35139. * It is set to 4 as a good tradeoff between perf and quality.
  35140. */
  35141. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  35142. /**
  35143. * Gets or sets the unique id of the texture
  35144. */
  35145. uniqueId: number;
  35146. /**
  35147. * Define the name of the texture.
  35148. */
  35149. name: string;
  35150. /**
  35151. * Gets or sets an object used to store user defined information.
  35152. */
  35153. metadata: any;
  35154. /**
  35155. * For internal use only. Please do not use.
  35156. */
  35157. reservedDataStore: any;
  35158. private _hasAlpha;
  35159. /**
  35160. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  35161. */
  35162. set hasAlpha(value: boolean);
  35163. get hasAlpha(): boolean;
  35164. /**
  35165. * Defines if the alpha value should be determined via the rgb values.
  35166. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  35167. */
  35168. getAlphaFromRGB: boolean;
  35169. /**
  35170. * Intensity or strength of the texture.
  35171. * It is commonly used by materials to fine tune the intensity of the texture
  35172. */
  35173. level: number;
  35174. /**
  35175. * Define the UV chanel to use starting from 0 and defaulting to 0.
  35176. * This is part of the texture as textures usually maps to one uv set.
  35177. */
  35178. coordinatesIndex: number;
  35179. protected _coordinatesMode: number;
  35180. /**
  35181. * How a texture is mapped.
  35182. *
  35183. * | Value | Type | Description |
  35184. * | ----- | ----------------------------------- | ----------- |
  35185. * | 0 | EXPLICIT_MODE | |
  35186. * | 1 | SPHERICAL_MODE | |
  35187. * | 2 | PLANAR_MODE | |
  35188. * | 3 | CUBIC_MODE | |
  35189. * | 4 | PROJECTION_MODE | |
  35190. * | 5 | SKYBOX_MODE | |
  35191. * | 6 | INVCUBIC_MODE | |
  35192. * | 7 | EQUIRECTANGULAR_MODE | |
  35193. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  35194. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  35195. */
  35196. set coordinatesMode(value: number);
  35197. get coordinatesMode(): number;
  35198. private _wrapU;
  35199. /**
  35200. * | Value | Type | Description |
  35201. * | ----- | ------------------ | ----------- |
  35202. * | 0 | CLAMP_ADDRESSMODE | |
  35203. * | 1 | WRAP_ADDRESSMODE | |
  35204. * | 2 | MIRROR_ADDRESSMODE | |
  35205. */
  35206. get wrapU(): number;
  35207. set wrapU(value: number);
  35208. private _wrapV;
  35209. /**
  35210. * | Value | Type | Description |
  35211. * | ----- | ------------------ | ----------- |
  35212. * | 0 | CLAMP_ADDRESSMODE | |
  35213. * | 1 | WRAP_ADDRESSMODE | |
  35214. * | 2 | MIRROR_ADDRESSMODE | |
  35215. */
  35216. get wrapV(): number;
  35217. set wrapV(value: number);
  35218. /**
  35219. * | Value | Type | Description |
  35220. * | ----- | ------------------ | ----------- |
  35221. * | 0 | CLAMP_ADDRESSMODE | |
  35222. * | 1 | WRAP_ADDRESSMODE | |
  35223. * | 2 | MIRROR_ADDRESSMODE | |
  35224. */
  35225. wrapR: number;
  35226. /**
  35227. * With compliant hardware and browser (supporting anisotropic filtering)
  35228. * this defines the level of anisotropic filtering in the texture.
  35229. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  35230. */
  35231. anisotropicFilteringLevel: number;
  35232. /**
  35233. * Define if the texture is a cube texture or if false a 2d texture.
  35234. */
  35235. get isCube(): boolean;
  35236. set isCube(value: boolean);
  35237. /**
  35238. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  35239. */
  35240. get is3D(): boolean;
  35241. set is3D(value: boolean);
  35242. /**
  35243. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  35244. */
  35245. get is2DArray(): boolean;
  35246. set is2DArray(value: boolean);
  35247. private _gammaSpace;
  35248. /**
  35249. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  35250. * HDR texture are usually stored in linear space.
  35251. * This only impacts the PBR and Background materials
  35252. */
  35253. get gammaSpace(): boolean;
  35254. set gammaSpace(gamma: boolean);
  35255. /**
  35256. * Gets or sets whether or not the texture contains RGBD data.
  35257. */
  35258. get isRGBD(): boolean;
  35259. set isRGBD(value: boolean);
  35260. /**
  35261. * Is Z inverted in the texture (useful in a cube texture).
  35262. */
  35263. invertZ: boolean;
  35264. /**
  35265. * Are mip maps generated for this texture or not.
  35266. */
  35267. get noMipmap(): boolean;
  35268. /**
  35269. * @hidden
  35270. */
  35271. lodLevelInAlpha: boolean;
  35272. /**
  35273. * With prefiltered texture, defined the offset used during the prefiltering steps.
  35274. */
  35275. get lodGenerationOffset(): number;
  35276. set lodGenerationOffset(value: number);
  35277. /**
  35278. * With prefiltered texture, defined the scale used during the prefiltering steps.
  35279. */
  35280. get lodGenerationScale(): number;
  35281. set lodGenerationScale(value: number);
  35282. /**
  35283. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  35284. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  35285. * average roughness values.
  35286. */
  35287. get linearSpecularLOD(): boolean;
  35288. set linearSpecularLOD(value: boolean);
  35289. /**
  35290. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  35291. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  35292. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  35293. */
  35294. get irradianceTexture(): Nullable<BaseTexture>;
  35295. set irradianceTexture(value: Nullable<BaseTexture>);
  35296. /**
  35297. * Define if the texture is a render target.
  35298. */
  35299. isRenderTarget: boolean;
  35300. /**
  35301. * Define the unique id of the texture in the scene.
  35302. */
  35303. get uid(): string;
  35304. /** @hidden */
  35305. _prefiltered: boolean;
  35306. /**
  35307. * Return a string representation of the texture.
  35308. * @returns the texture as a string
  35309. */
  35310. toString(): string;
  35311. /**
  35312. * Get the class name of the texture.
  35313. * @returns "BaseTexture"
  35314. */
  35315. getClassName(): string;
  35316. /**
  35317. * Define the list of animation attached to the texture.
  35318. */
  35319. animations: import("babylonjs/Animations/animation").Animation[];
  35320. /**
  35321. * An event triggered when the texture is disposed.
  35322. */
  35323. onDisposeObservable: Observable<BaseTexture>;
  35324. private _onDisposeObserver;
  35325. /**
  35326. * Callback triggered when the texture has been disposed.
  35327. * Kept for back compatibility, you can use the onDisposeObservable instead.
  35328. */
  35329. set onDispose(callback: () => void);
  35330. /**
  35331. * Define the current state of the loading sequence when in delayed load mode.
  35332. */
  35333. delayLoadState: number;
  35334. protected _scene: Nullable<Scene>;
  35335. protected _engine: Nullable<ThinEngine>;
  35336. /** @hidden */
  35337. _texture: Nullable<InternalTexture>;
  35338. private _uid;
  35339. /**
  35340. * Define if the texture is preventinga material to render or not.
  35341. * If not and the texture is not ready, the engine will use a default black texture instead.
  35342. */
  35343. get isBlocking(): boolean;
  35344. /**
  35345. * Instantiates a new BaseTexture.
  35346. * Base class of all the textures in babylon.
  35347. * It groups all the common properties the materials, post process, lights... might need
  35348. * in order to make a correct use of the texture.
  35349. * @param sceneOrEngine Define the scene or engine the texture blongs to
  35350. */
  35351. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  35352. /**
  35353. * Get the scene the texture belongs to.
  35354. * @returns the scene or null if undefined
  35355. */
  35356. getScene(): Nullable<Scene>;
  35357. /** @hidden */
  35358. protected _getEngine(): Nullable<ThinEngine>;
  35359. /**
  35360. * Get the texture transform matrix used to offset tile the texture for istance.
  35361. * @returns the transformation matrix
  35362. */
  35363. getTextureMatrix(): Matrix;
  35364. /**
  35365. * Get the texture reflection matrix used to rotate/transform the reflection.
  35366. * @returns the reflection matrix
  35367. */
  35368. getReflectionTextureMatrix(): Matrix;
  35369. /**
  35370. * Get the underlying lower level texture from Babylon.
  35371. * @returns the insternal texture
  35372. */
  35373. getInternalTexture(): Nullable<InternalTexture>;
  35374. /**
  35375. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  35376. * @returns true if ready or not blocking
  35377. */
  35378. isReadyOrNotBlocking(): boolean;
  35379. /**
  35380. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  35381. * @returns true if fully ready
  35382. */
  35383. isReady(): boolean;
  35384. private _cachedSize;
  35385. /**
  35386. * Get the size of the texture.
  35387. * @returns the texture size.
  35388. */
  35389. getSize(): ISize;
  35390. /**
  35391. * Get the base size of the texture.
  35392. * It can be different from the size if the texture has been resized for POT for instance
  35393. * @returns the base size
  35394. */
  35395. getBaseSize(): ISize;
  35396. /**
  35397. * Update the sampling mode of the texture.
  35398. * Default is Trilinear mode.
  35399. *
  35400. * | Value | Type | Description |
  35401. * | ----- | ------------------ | ----------- |
  35402. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  35403. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  35404. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  35405. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  35406. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  35407. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  35408. * | 7 | NEAREST_LINEAR | |
  35409. * | 8 | NEAREST_NEAREST | |
  35410. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  35411. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  35412. * | 11 | LINEAR_LINEAR | |
  35413. * | 12 | LINEAR_NEAREST | |
  35414. *
  35415. * > _mag_: magnification filter (close to the viewer)
  35416. * > _min_: minification filter (far from the viewer)
  35417. * > _mip_: filter used between mip map levels
  35418. *@param samplingMode Define the new sampling mode of the texture
  35419. */
  35420. updateSamplingMode(samplingMode: number): void;
  35421. /**
  35422. * Scales the texture if is `canRescale()`
  35423. * @param ratio the resize factor we want to use to rescale
  35424. */
  35425. scale(ratio: number): void;
  35426. /**
  35427. * Get if the texture can rescale.
  35428. */
  35429. get canRescale(): boolean;
  35430. /** @hidden */
  35431. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  35432. /** @hidden */
  35433. _rebuild(): void;
  35434. /**
  35435. * Triggers the load sequence in delayed load mode.
  35436. */
  35437. delayLoad(): void;
  35438. /**
  35439. * Clones the texture.
  35440. * @returns the cloned texture
  35441. */
  35442. clone(): Nullable<BaseTexture>;
  35443. /**
  35444. * Get the texture underlying type (INT, FLOAT...)
  35445. */
  35446. get textureType(): number;
  35447. /**
  35448. * Get the texture underlying format (RGB, RGBA...)
  35449. */
  35450. get textureFormat(): number;
  35451. /**
  35452. * Indicates that textures need to be re-calculated for all materials
  35453. */
  35454. protected _markAllSubMeshesAsTexturesDirty(): void;
  35455. /**
  35456. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  35457. * This will returns an RGBA array buffer containing either in values (0-255) or
  35458. * float values (0-1) depending of the underlying buffer type.
  35459. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  35460. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  35461. * @param buffer defines a user defined buffer to fill with data (can be null)
  35462. * @returns The Array buffer containing the pixels data.
  35463. */
  35464. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  35465. /**
  35466. * Release and destroy the underlying lower level texture aka internalTexture.
  35467. */
  35468. releaseInternalTexture(): void;
  35469. /** @hidden */
  35470. get _lodTextureHigh(): Nullable<BaseTexture>;
  35471. /** @hidden */
  35472. get _lodTextureMid(): Nullable<BaseTexture>;
  35473. /** @hidden */
  35474. get _lodTextureLow(): Nullable<BaseTexture>;
  35475. /**
  35476. * Dispose the texture and release its associated resources.
  35477. */
  35478. dispose(): void;
  35479. /**
  35480. * Serialize the texture into a JSON representation that can be parsed later on.
  35481. * @returns the JSON representation of the texture
  35482. */
  35483. serialize(): any;
  35484. /**
  35485. * Helper function to be called back once a list of texture contains only ready textures.
  35486. * @param textures Define the list of textures to wait for
  35487. * @param callback Define the callback triggered once the entire list will be ready
  35488. */
  35489. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  35490. private static _isScene;
  35491. }
  35492. }
  35493. declare module "babylonjs/Materials/effect" {
  35494. import { Observable } from "babylonjs/Misc/observable";
  35495. import { Nullable } from "babylonjs/types";
  35496. import { IDisposable } from "babylonjs/scene";
  35497. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  35498. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  35499. import { IMatrixLike, IVector2Like, IVector3Like, IVector4Like, IColor3Like, IColor4Like } from "babylonjs/Maths/math.like";
  35500. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  35501. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  35502. import { Engine } from "babylonjs/Engines/engine";
  35503. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35504. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  35505. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  35506. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  35507. /**
  35508. * Options to be used when creating an effect.
  35509. */
  35510. export interface IEffectCreationOptions {
  35511. /**
  35512. * Atrributes that will be used in the shader.
  35513. */
  35514. attributes: string[];
  35515. /**
  35516. * Uniform varible names that will be set in the shader.
  35517. */
  35518. uniformsNames: string[];
  35519. /**
  35520. * Uniform buffer variable names that will be set in the shader.
  35521. */
  35522. uniformBuffersNames: string[];
  35523. /**
  35524. * Sampler texture variable names that will be set in the shader.
  35525. */
  35526. samplers: string[];
  35527. /**
  35528. * Define statements that will be set in the shader.
  35529. */
  35530. defines: any;
  35531. /**
  35532. * Possible fallbacks for this effect to improve performance when needed.
  35533. */
  35534. fallbacks: Nullable<IEffectFallbacks>;
  35535. /**
  35536. * Callback that will be called when the shader is compiled.
  35537. */
  35538. onCompiled: Nullable<(effect: Effect) => void>;
  35539. /**
  35540. * Callback that will be called if an error occurs during shader compilation.
  35541. */
  35542. onError: Nullable<(effect: Effect, errors: string) => void>;
  35543. /**
  35544. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35545. */
  35546. indexParameters?: any;
  35547. /**
  35548. * Max number of lights that can be used in the shader.
  35549. */
  35550. maxSimultaneousLights?: number;
  35551. /**
  35552. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  35553. */
  35554. transformFeedbackVaryings?: Nullable<string[]>;
  35555. /**
  35556. * 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
  35557. */
  35558. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  35559. /**
  35560. * Is this effect rendering to several color attachments ?
  35561. */
  35562. multiTarget?: boolean;
  35563. }
  35564. /**
  35565. * Effect containing vertex and fragment shader that can be executed on an object.
  35566. */
  35567. export class Effect implements IDisposable {
  35568. /**
  35569. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  35570. */
  35571. static ShadersRepository: string;
  35572. /**
  35573. * Enable logging of the shader code when a compilation error occurs
  35574. */
  35575. static LogShaderCodeOnCompilationError: boolean;
  35576. /**
  35577. * Name of the effect.
  35578. */
  35579. name: any;
  35580. /**
  35581. * String container all the define statements that should be set on the shader.
  35582. */
  35583. defines: string;
  35584. /**
  35585. * Callback that will be called when the shader is compiled.
  35586. */
  35587. onCompiled: Nullable<(effect: Effect) => void>;
  35588. /**
  35589. * Callback that will be called if an error occurs during shader compilation.
  35590. */
  35591. onError: Nullable<(effect: Effect, errors: string) => void>;
  35592. /**
  35593. * Callback that will be called when effect is bound.
  35594. */
  35595. onBind: Nullable<(effect: Effect) => void>;
  35596. /**
  35597. * Unique ID of the effect.
  35598. */
  35599. uniqueId: number;
  35600. /**
  35601. * Observable that will be called when the shader is compiled.
  35602. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  35603. */
  35604. onCompileObservable: Observable<Effect>;
  35605. /**
  35606. * Observable that will be called if an error occurs during shader compilation.
  35607. */
  35608. onErrorObservable: Observable<Effect>;
  35609. /** @hidden */
  35610. _onBindObservable: Nullable<Observable<Effect>>;
  35611. /**
  35612. * @hidden
  35613. * Specifies if the effect was previously ready
  35614. */
  35615. _wasPreviouslyReady: boolean;
  35616. /**
  35617. * Observable that will be called when effect is bound.
  35618. */
  35619. get onBindObservable(): Observable<Effect>;
  35620. /** @hidden */
  35621. _bonesComputationForcedToCPU: boolean;
  35622. /** @hidden */
  35623. _multiTarget: boolean;
  35624. private static _uniqueIdSeed;
  35625. private _engine;
  35626. private _uniformBuffersNames;
  35627. private _uniformBuffersNamesList;
  35628. private _uniformsNames;
  35629. private _samplerList;
  35630. private _samplers;
  35631. private _isReady;
  35632. private _compilationError;
  35633. private _allFallbacksProcessed;
  35634. private _attributesNames;
  35635. private _attributes;
  35636. private _attributeLocationByName;
  35637. private _uniforms;
  35638. /**
  35639. * Key for the effect.
  35640. * @hidden
  35641. */
  35642. _key: string;
  35643. private _indexParameters;
  35644. private _fallbacks;
  35645. private _vertexSourceCode;
  35646. private _fragmentSourceCode;
  35647. private _vertexSourceCodeOverride;
  35648. private _fragmentSourceCodeOverride;
  35649. private _transformFeedbackVaryings;
  35650. /**
  35651. * Compiled shader to webGL program.
  35652. * @hidden
  35653. */
  35654. _pipelineContext: Nullable<IPipelineContext>;
  35655. private _valueCache;
  35656. private static _baseCache;
  35657. /**
  35658. * Instantiates an effect.
  35659. * An effect can be used to create/manage/execute vertex and fragment shaders.
  35660. * @param baseName Name of the effect.
  35661. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  35662. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  35663. * @param samplers List of sampler variables that will be passed to the shader.
  35664. * @param engine Engine to be used to render the effect
  35665. * @param defines Define statements to be added to the shader.
  35666. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  35667. * @param onCompiled Callback that will be called when the shader is compiled.
  35668. * @param onError Callback that will be called if an error occurs during shader compilation.
  35669. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35670. */
  35671. 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);
  35672. private _useFinalCode;
  35673. /**
  35674. * Unique key for this effect
  35675. */
  35676. get key(): string;
  35677. /**
  35678. * If the effect has been compiled and prepared.
  35679. * @returns if the effect is compiled and prepared.
  35680. */
  35681. isReady(): boolean;
  35682. private _isReadyInternal;
  35683. /**
  35684. * The engine the effect was initialized with.
  35685. * @returns the engine.
  35686. */
  35687. getEngine(): Engine;
  35688. /**
  35689. * The pipeline context for this effect
  35690. * @returns the associated pipeline context
  35691. */
  35692. getPipelineContext(): Nullable<IPipelineContext>;
  35693. /**
  35694. * The set of names of attribute variables for the shader.
  35695. * @returns An array of attribute names.
  35696. */
  35697. getAttributesNames(): string[];
  35698. /**
  35699. * Returns the attribute at the given index.
  35700. * @param index The index of the attribute.
  35701. * @returns The location of the attribute.
  35702. */
  35703. getAttributeLocation(index: number): number;
  35704. /**
  35705. * Returns the attribute based on the name of the variable.
  35706. * @param name of the attribute to look up.
  35707. * @returns the attribute location.
  35708. */
  35709. getAttributeLocationByName(name: string): number;
  35710. /**
  35711. * The number of attributes.
  35712. * @returns the numnber of attributes.
  35713. */
  35714. getAttributesCount(): number;
  35715. /**
  35716. * Gets the index of a uniform variable.
  35717. * @param uniformName of the uniform to look up.
  35718. * @returns the index.
  35719. */
  35720. getUniformIndex(uniformName: string): number;
  35721. /**
  35722. * Returns the attribute based on the name of the variable.
  35723. * @param uniformName of the uniform to look up.
  35724. * @returns the location of the uniform.
  35725. */
  35726. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  35727. /**
  35728. * Returns an array of sampler variable names
  35729. * @returns The array of sampler variable names.
  35730. */
  35731. getSamplers(): string[];
  35732. /**
  35733. * Returns an array of uniform variable names
  35734. * @returns The array of uniform variable names.
  35735. */
  35736. getUniformNames(): string[];
  35737. /**
  35738. * Returns an array of uniform buffer variable names
  35739. * @returns The array of uniform buffer variable names.
  35740. */
  35741. getUniformBuffersNames(): string[];
  35742. /**
  35743. * Returns the index parameters used to create the effect
  35744. * @returns The index parameters object
  35745. */
  35746. getIndexParameters(): any;
  35747. /**
  35748. * The error from the last compilation.
  35749. * @returns the error string.
  35750. */
  35751. getCompilationError(): string;
  35752. /**
  35753. * Gets a boolean indicating that all fallbacks were used during compilation
  35754. * @returns true if all fallbacks were used
  35755. */
  35756. allFallbacksProcessed(): boolean;
  35757. /**
  35758. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  35759. * @param func The callback to be used.
  35760. */
  35761. executeWhenCompiled(func: (effect: Effect) => void): void;
  35762. private _checkIsReady;
  35763. private _loadShader;
  35764. /**
  35765. * Gets the vertex shader source code of this effect
  35766. */
  35767. get vertexSourceCode(): string;
  35768. /**
  35769. * Gets the fragment shader source code of this effect
  35770. */
  35771. get fragmentSourceCode(): string;
  35772. /**
  35773. * Recompiles the webGL program
  35774. * @param vertexSourceCode The source code for the vertex shader.
  35775. * @param fragmentSourceCode The source code for the fragment shader.
  35776. * @param onCompiled Callback called when completed.
  35777. * @param onError Callback called on error.
  35778. * @hidden
  35779. */
  35780. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  35781. /**
  35782. * Prepares the effect
  35783. * @hidden
  35784. */
  35785. _prepareEffect(): void;
  35786. private _getShaderCodeAndErrorLine;
  35787. private _processCompilationErrors;
  35788. /**
  35789. * Checks if the effect is supported. (Must be called after compilation)
  35790. */
  35791. get isSupported(): boolean;
  35792. /**
  35793. * Binds a texture to the engine to be used as output of the shader.
  35794. * @param channel Name of the output variable.
  35795. * @param texture Texture to bind.
  35796. * @hidden
  35797. */
  35798. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  35799. /**
  35800. * Sets a texture on the engine to be used in the shader.
  35801. * @param channel Name of the sampler variable.
  35802. * @param texture Texture to set.
  35803. */
  35804. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  35805. /**
  35806. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  35807. * @param channel Name of the sampler variable.
  35808. * @param texture Texture to set.
  35809. */
  35810. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  35811. /**
  35812. * Sets an array of textures on the engine to be used in the shader.
  35813. * @param channel Name of the variable.
  35814. * @param textures Textures to set.
  35815. */
  35816. setTextureArray(channel: string, textures: BaseTexture[]): void;
  35817. /**
  35818. * 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)
  35819. * @param channel Name of the sampler variable.
  35820. * @param postProcess Post process to get the input texture from.
  35821. */
  35822. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  35823. /**
  35824. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  35825. * 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)
  35826. * @param channel Name of the sampler variable.
  35827. * @param postProcess Post process to get the output texture from.
  35828. */
  35829. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  35830. /** @hidden */
  35831. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  35832. /** @hidden */
  35833. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  35834. /** @hidden */
  35835. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  35836. /** @hidden */
  35837. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  35838. /**
  35839. * Binds a buffer to a uniform.
  35840. * @param buffer Buffer to bind.
  35841. * @param name Name of the uniform variable to bind to.
  35842. */
  35843. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  35844. /**
  35845. * Binds block to a uniform.
  35846. * @param blockName Name of the block to bind.
  35847. * @param index Index to bind.
  35848. */
  35849. bindUniformBlock(blockName: string, index: number): void;
  35850. /**
  35851. * Sets an interger value on a uniform variable.
  35852. * @param uniformName Name of the variable.
  35853. * @param value Value to be set.
  35854. * @returns this effect.
  35855. */
  35856. setInt(uniformName: string, value: number): Effect;
  35857. /**
  35858. * Sets an int array on a uniform variable.
  35859. * @param uniformName Name of the variable.
  35860. * @param array array to be set.
  35861. * @returns this effect.
  35862. */
  35863. setIntArray(uniformName: string, array: Int32Array): Effect;
  35864. /**
  35865. * 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)
  35866. * @param uniformName Name of the variable.
  35867. * @param array array to be set.
  35868. * @returns this effect.
  35869. */
  35870. setIntArray2(uniformName: string, array: Int32Array): Effect;
  35871. /**
  35872. * 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)
  35873. * @param uniformName Name of the variable.
  35874. * @param array array to be set.
  35875. * @returns this effect.
  35876. */
  35877. setIntArray3(uniformName: string, array: Int32Array): Effect;
  35878. /**
  35879. * 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)
  35880. * @param uniformName Name of the variable.
  35881. * @param array array to be set.
  35882. * @returns this effect.
  35883. */
  35884. setIntArray4(uniformName: string, array: Int32Array): Effect;
  35885. /**
  35886. * Sets an float array on a uniform variable.
  35887. * @param uniformName Name of the variable.
  35888. * @param array array to be set.
  35889. * @returns this effect.
  35890. */
  35891. setFloatArray(uniformName: string, array: Float32Array): Effect;
  35892. /**
  35893. * 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)
  35894. * @param uniformName Name of the variable.
  35895. * @param array array to be set.
  35896. * @returns this effect.
  35897. */
  35898. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  35899. /**
  35900. * 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)
  35901. * @param uniformName Name of the variable.
  35902. * @param array array to be set.
  35903. * @returns this effect.
  35904. */
  35905. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  35906. /**
  35907. * 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)
  35908. * @param uniformName Name of the variable.
  35909. * @param array array to be set.
  35910. * @returns this effect.
  35911. */
  35912. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  35913. /**
  35914. * Sets an array on a uniform variable.
  35915. * @param uniformName Name of the variable.
  35916. * @param array array to be set.
  35917. * @returns this effect.
  35918. */
  35919. setArray(uniformName: string, array: number[]): Effect;
  35920. /**
  35921. * 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)
  35922. * @param uniformName Name of the variable.
  35923. * @param array array to be set.
  35924. * @returns this effect.
  35925. */
  35926. setArray2(uniformName: string, array: number[]): Effect;
  35927. /**
  35928. * 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)
  35929. * @param uniformName Name of the variable.
  35930. * @param array array to be set.
  35931. * @returns this effect.
  35932. */
  35933. setArray3(uniformName: string, array: number[]): Effect;
  35934. /**
  35935. * 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)
  35936. * @param uniformName Name of the variable.
  35937. * @param array array to be set.
  35938. * @returns this effect.
  35939. */
  35940. setArray4(uniformName: string, array: number[]): Effect;
  35941. /**
  35942. * Sets matrices on a uniform variable.
  35943. * @param uniformName Name of the variable.
  35944. * @param matrices matrices to be set.
  35945. * @returns this effect.
  35946. */
  35947. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  35948. /**
  35949. * Sets matrix on a uniform variable.
  35950. * @param uniformName Name of the variable.
  35951. * @param matrix matrix to be set.
  35952. * @returns this effect.
  35953. */
  35954. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  35955. /**
  35956. * 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)
  35957. * @param uniformName Name of the variable.
  35958. * @param matrix matrix to be set.
  35959. * @returns this effect.
  35960. */
  35961. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35962. /**
  35963. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  35964. * @param uniformName Name of the variable.
  35965. * @param matrix matrix to be set.
  35966. * @returns this effect.
  35967. */
  35968. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35969. /**
  35970. * Sets a float on a uniform variable.
  35971. * @param uniformName Name of the variable.
  35972. * @param value value to be set.
  35973. * @returns this effect.
  35974. */
  35975. setFloat(uniformName: string, value: number): Effect;
  35976. /**
  35977. * Sets a boolean on a uniform variable.
  35978. * @param uniformName Name of the variable.
  35979. * @param bool value to be set.
  35980. * @returns this effect.
  35981. */
  35982. setBool(uniformName: string, bool: boolean): Effect;
  35983. /**
  35984. * Sets a Vector2 on a uniform variable.
  35985. * @param uniformName Name of the variable.
  35986. * @param vector2 vector2 to be set.
  35987. * @returns this effect.
  35988. */
  35989. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  35990. /**
  35991. * Sets a float2 on a uniform variable.
  35992. * @param uniformName Name of the variable.
  35993. * @param x First float in float2.
  35994. * @param y Second float in float2.
  35995. * @returns this effect.
  35996. */
  35997. setFloat2(uniformName: string, x: number, y: number): Effect;
  35998. /**
  35999. * Sets a Vector3 on a uniform variable.
  36000. * @param uniformName Name of the variable.
  36001. * @param vector3 Value to be set.
  36002. * @returns this effect.
  36003. */
  36004. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  36005. /**
  36006. * Sets a float3 on a uniform variable.
  36007. * @param uniformName Name of the variable.
  36008. * @param x First float in float3.
  36009. * @param y Second float in float3.
  36010. * @param z Third float in float3.
  36011. * @returns this effect.
  36012. */
  36013. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  36014. /**
  36015. * Sets a Vector4 on a uniform variable.
  36016. * @param uniformName Name of the variable.
  36017. * @param vector4 Value to be set.
  36018. * @returns this effect.
  36019. */
  36020. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  36021. /**
  36022. * Sets a float4 on a uniform variable.
  36023. * @param uniformName Name of the variable.
  36024. * @param x First float in float4.
  36025. * @param y Second float in float4.
  36026. * @param z Third float in float4.
  36027. * @param w Fourth float in float4.
  36028. * @returns this effect.
  36029. */
  36030. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  36031. /**
  36032. * Sets a Color3 on a uniform variable.
  36033. * @param uniformName Name of the variable.
  36034. * @param color3 Value to be set.
  36035. * @returns this effect.
  36036. */
  36037. setColor3(uniformName: string, color3: IColor3Like): Effect;
  36038. /**
  36039. * Sets a Color4 on a uniform variable.
  36040. * @param uniformName Name of the variable.
  36041. * @param color3 Value to be set.
  36042. * @param alpha Alpha value to be set.
  36043. * @returns this effect.
  36044. */
  36045. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  36046. /**
  36047. * Sets a Color4 on a uniform variable
  36048. * @param uniformName defines the name of the variable
  36049. * @param color4 defines the value to be set
  36050. * @returns this effect.
  36051. */
  36052. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  36053. /** Release all associated resources */
  36054. dispose(): void;
  36055. /**
  36056. * This function will add a new shader to the shader store
  36057. * @param name the name of the shader
  36058. * @param pixelShader optional pixel shader content
  36059. * @param vertexShader optional vertex shader content
  36060. */
  36061. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  36062. /**
  36063. * Store of each shader (The can be looked up using effect.key)
  36064. */
  36065. static ShadersStore: {
  36066. [key: string]: string;
  36067. };
  36068. /**
  36069. * Store of each included file for a shader (The can be looked up using effect.key)
  36070. */
  36071. static IncludesShadersStore: {
  36072. [key: string]: string;
  36073. };
  36074. /**
  36075. * Resets the cache of effects.
  36076. */
  36077. static ResetCache(): void;
  36078. }
  36079. }
  36080. declare module "babylonjs/Engines/engineCapabilities" {
  36081. /**
  36082. * Interface used to describe the capabilities of the engine relatively to the current browser
  36083. */
  36084. export interface EngineCapabilities {
  36085. /** Maximum textures units per fragment shader */
  36086. maxTexturesImageUnits: number;
  36087. /** Maximum texture units per vertex shader */
  36088. maxVertexTextureImageUnits: number;
  36089. /** Maximum textures units in the entire pipeline */
  36090. maxCombinedTexturesImageUnits: number;
  36091. /** Maximum texture size */
  36092. maxTextureSize: number;
  36093. /** Maximum texture samples */
  36094. maxSamples?: number;
  36095. /** Maximum cube texture size */
  36096. maxCubemapTextureSize: number;
  36097. /** Maximum render texture size */
  36098. maxRenderTextureSize: number;
  36099. /** Maximum number of vertex attributes */
  36100. maxVertexAttribs: number;
  36101. /** Maximum number of varyings */
  36102. maxVaryingVectors: number;
  36103. /** Maximum number of uniforms per vertex shader */
  36104. maxVertexUniformVectors: number;
  36105. /** Maximum number of uniforms per fragment shader */
  36106. maxFragmentUniformVectors: number;
  36107. /** Defines if standard derivates (dx/dy) are supported */
  36108. standardDerivatives: boolean;
  36109. /** Defines if s3tc texture compression is supported */
  36110. s3tc?: WEBGL_compressed_texture_s3tc;
  36111. /** Defines if pvrtc texture compression is supported */
  36112. pvrtc: any;
  36113. /** Defines if etc1 texture compression is supported */
  36114. etc1: any;
  36115. /** Defines if etc2 texture compression is supported */
  36116. etc2: any;
  36117. /** Defines if astc texture compression is supported */
  36118. astc: any;
  36119. /** Defines if bptc texture compression is supported */
  36120. bptc: any;
  36121. /** Defines if float textures are supported */
  36122. textureFloat: boolean;
  36123. /** Defines if vertex array objects are supported */
  36124. vertexArrayObject: boolean;
  36125. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  36126. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  36127. /** Gets the maximum level of anisotropy supported */
  36128. maxAnisotropy: number;
  36129. /** Defines if instancing is supported */
  36130. instancedArrays: boolean;
  36131. /** Defines if 32 bits indices are supported */
  36132. uintIndices: boolean;
  36133. /** Defines if high precision shaders are supported */
  36134. highPrecisionShaderSupported: boolean;
  36135. /** Defines if depth reading in the fragment shader is supported */
  36136. fragmentDepthSupported: boolean;
  36137. /** Defines if float texture linear filtering is supported*/
  36138. textureFloatLinearFiltering: boolean;
  36139. /** Defines if rendering to float textures is supported */
  36140. textureFloatRender: boolean;
  36141. /** Defines if half float textures are supported*/
  36142. textureHalfFloat: boolean;
  36143. /** Defines if half float texture linear filtering is supported*/
  36144. textureHalfFloatLinearFiltering: boolean;
  36145. /** Defines if rendering to half float textures is supported */
  36146. textureHalfFloatRender: boolean;
  36147. /** Defines if textureLOD shader command is supported */
  36148. textureLOD: boolean;
  36149. /** Defines if draw buffers extension is supported */
  36150. drawBuffersExtension: boolean;
  36151. /** Defines if depth textures are supported */
  36152. depthTextureExtension: boolean;
  36153. /** Defines if float color buffer are supported */
  36154. colorBufferFloat: boolean;
  36155. /** Gets disjoint timer query extension (null if not supported) */
  36156. timerQuery?: EXT_disjoint_timer_query;
  36157. /** Defines if timestamp can be used with timer query */
  36158. canUseTimestampForTimerQuery: boolean;
  36159. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  36160. multiview?: any;
  36161. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  36162. oculusMultiview?: any;
  36163. /** Function used to let the system compiles shaders in background */
  36164. parallelShaderCompile?: {
  36165. COMPLETION_STATUS_KHR: number;
  36166. };
  36167. /** Max number of texture samples for MSAA */
  36168. maxMSAASamples: number;
  36169. /** Defines if the blend min max extension is supported */
  36170. blendMinMax: boolean;
  36171. }
  36172. }
  36173. declare module "babylonjs/States/depthCullingState" {
  36174. import { Nullable } from "babylonjs/types";
  36175. /**
  36176. * @hidden
  36177. **/
  36178. export class DepthCullingState {
  36179. private _isDepthTestDirty;
  36180. private _isDepthMaskDirty;
  36181. private _isDepthFuncDirty;
  36182. private _isCullFaceDirty;
  36183. private _isCullDirty;
  36184. private _isZOffsetDirty;
  36185. private _isFrontFaceDirty;
  36186. private _depthTest;
  36187. private _depthMask;
  36188. private _depthFunc;
  36189. private _cull;
  36190. private _cullFace;
  36191. private _zOffset;
  36192. private _frontFace;
  36193. /**
  36194. * Initializes the state.
  36195. */
  36196. constructor();
  36197. get isDirty(): boolean;
  36198. get zOffset(): number;
  36199. set zOffset(value: number);
  36200. get cullFace(): Nullable<number>;
  36201. set cullFace(value: Nullable<number>);
  36202. get cull(): Nullable<boolean>;
  36203. set cull(value: Nullable<boolean>);
  36204. get depthFunc(): Nullable<number>;
  36205. set depthFunc(value: Nullable<number>);
  36206. get depthMask(): boolean;
  36207. set depthMask(value: boolean);
  36208. get depthTest(): boolean;
  36209. set depthTest(value: boolean);
  36210. get frontFace(): Nullable<number>;
  36211. set frontFace(value: Nullable<number>);
  36212. reset(): void;
  36213. apply(gl: WebGLRenderingContext): void;
  36214. }
  36215. }
  36216. declare module "babylonjs/States/stencilState" {
  36217. /**
  36218. * @hidden
  36219. **/
  36220. export class StencilState {
  36221. /** 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 */
  36222. static readonly ALWAYS: number;
  36223. /** Passed to stencilOperation to specify that stencil value must be kept */
  36224. static readonly KEEP: number;
  36225. /** Passed to stencilOperation to specify that stencil value must be replaced */
  36226. static readonly REPLACE: number;
  36227. private _isStencilTestDirty;
  36228. private _isStencilMaskDirty;
  36229. private _isStencilFuncDirty;
  36230. private _isStencilOpDirty;
  36231. private _stencilTest;
  36232. private _stencilMask;
  36233. private _stencilFunc;
  36234. private _stencilFuncRef;
  36235. private _stencilFuncMask;
  36236. private _stencilOpStencilFail;
  36237. private _stencilOpDepthFail;
  36238. private _stencilOpStencilDepthPass;
  36239. get isDirty(): boolean;
  36240. get stencilFunc(): number;
  36241. set stencilFunc(value: number);
  36242. get stencilFuncRef(): number;
  36243. set stencilFuncRef(value: number);
  36244. get stencilFuncMask(): number;
  36245. set stencilFuncMask(value: number);
  36246. get stencilOpStencilFail(): number;
  36247. set stencilOpStencilFail(value: number);
  36248. get stencilOpDepthFail(): number;
  36249. set stencilOpDepthFail(value: number);
  36250. get stencilOpStencilDepthPass(): number;
  36251. set stencilOpStencilDepthPass(value: number);
  36252. get stencilMask(): number;
  36253. set stencilMask(value: number);
  36254. get stencilTest(): boolean;
  36255. set stencilTest(value: boolean);
  36256. constructor();
  36257. reset(): void;
  36258. apply(gl: WebGLRenderingContext): void;
  36259. }
  36260. }
  36261. declare module "babylonjs/States/alphaCullingState" {
  36262. /**
  36263. * @hidden
  36264. **/
  36265. export class AlphaState {
  36266. private _isAlphaBlendDirty;
  36267. private _isBlendFunctionParametersDirty;
  36268. private _isBlendEquationParametersDirty;
  36269. private _isBlendConstantsDirty;
  36270. private _alphaBlend;
  36271. private _blendFunctionParameters;
  36272. private _blendEquationParameters;
  36273. private _blendConstants;
  36274. /**
  36275. * Initializes the state.
  36276. */
  36277. constructor();
  36278. get isDirty(): boolean;
  36279. get alphaBlend(): boolean;
  36280. set alphaBlend(value: boolean);
  36281. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  36282. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  36283. setAlphaEquationParameters(rgb: number, alpha: number): void;
  36284. reset(): void;
  36285. apply(gl: WebGLRenderingContext): void;
  36286. }
  36287. }
  36288. declare module "babylonjs/Engines/WebGL/webGL2ShaderProcessors" {
  36289. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  36290. /** @hidden */
  36291. export class WebGL2ShaderProcessor implements IShaderProcessor {
  36292. attributeProcessor(attribute: string): string;
  36293. varyingProcessor(varying: string, isFragment: boolean): string;
  36294. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  36295. }
  36296. }
  36297. declare module "babylonjs/Engines/instancingAttributeInfo" {
  36298. /**
  36299. * Interface for attribute information associated with buffer instanciation
  36300. */
  36301. export interface InstancingAttributeInfo {
  36302. /**
  36303. * Name of the GLSL attribute
  36304. * if attribute index is not specified, this is used to retrieve the index from the effect
  36305. */
  36306. attributeName: string;
  36307. /**
  36308. * Index/offset of the attribute in the vertex shader
  36309. * if not specified, this will be computes from the name.
  36310. */
  36311. index?: number;
  36312. /**
  36313. * size of the attribute, 1, 2, 3 or 4
  36314. */
  36315. attributeSize: number;
  36316. /**
  36317. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  36318. */
  36319. offset: number;
  36320. /**
  36321. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  36322. * default to 1
  36323. */
  36324. divisor?: number;
  36325. /**
  36326. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  36327. * default is FLOAT
  36328. */
  36329. attributeType?: number;
  36330. /**
  36331. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  36332. */
  36333. normalized?: boolean;
  36334. }
  36335. }
  36336. declare module "babylonjs/Engines/Extensions/engine.videoTexture" {
  36337. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36338. import { Nullable } from "babylonjs/types";
  36339. module "babylonjs/Engines/thinEngine" {
  36340. interface ThinEngine {
  36341. /**
  36342. * Update a video texture
  36343. * @param texture defines the texture to update
  36344. * @param video defines the video element to use
  36345. * @param invertY defines if data must be stored with Y axis inverted
  36346. */
  36347. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  36348. }
  36349. }
  36350. }
  36351. declare module "babylonjs/Engines/Extensions/engine.dynamicTexture" {
  36352. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36353. import { Nullable } from "babylonjs/types";
  36354. module "babylonjs/Engines/thinEngine" {
  36355. interface ThinEngine {
  36356. /**
  36357. * Creates a dynamic texture
  36358. * @param width defines the width of the texture
  36359. * @param height defines the height of the texture
  36360. * @param generateMipMaps defines if the engine should generate the mip levels
  36361. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  36362. * @returns the dynamic texture inside an InternalTexture
  36363. */
  36364. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  36365. /**
  36366. * Update the content of a dynamic texture
  36367. * @param texture defines the texture to update
  36368. * @param canvas defines the canvas containing the source
  36369. * @param invertY defines if data must be stored with Y axis inverted
  36370. * @param premulAlpha defines if alpha is stored as premultiplied
  36371. * @param format defines the format of the data
  36372. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  36373. */
  36374. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  36375. }
  36376. }
  36377. }
  36378. declare module "babylonjs/Materials/Textures/videoTexture" {
  36379. import { Observable } from "babylonjs/Misc/observable";
  36380. import { Nullable } from "babylonjs/types";
  36381. import { Scene } from "babylonjs/scene";
  36382. import { Texture } from "babylonjs/Materials/Textures/texture";
  36383. import "babylonjs/Engines/Extensions/engine.videoTexture";
  36384. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  36385. /**
  36386. * Settings for finer control over video usage
  36387. */
  36388. export interface VideoTextureSettings {
  36389. /**
  36390. * Applies `autoplay` to video, if specified
  36391. */
  36392. autoPlay?: boolean;
  36393. /**
  36394. * Applies `loop` to video, if specified
  36395. */
  36396. loop?: boolean;
  36397. /**
  36398. * Automatically updates internal texture from video at every frame in the render loop
  36399. */
  36400. autoUpdateTexture: boolean;
  36401. /**
  36402. * Image src displayed during the video loading or until the user interacts with the video.
  36403. */
  36404. poster?: string;
  36405. }
  36406. /**
  36407. * If you want to display a video in your scene, this is the special texture for that.
  36408. * This special texture works similar to other textures, with the exception of a few parameters.
  36409. * @see https://doc.babylonjs.com/how_to/video_texture
  36410. */
  36411. export class VideoTexture extends Texture {
  36412. /**
  36413. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  36414. */
  36415. readonly autoUpdateTexture: boolean;
  36416. /**
  36417. * The video instance used by the texture internally
  36418. */
  36419. readonly video: HTMLVideoElement;
  36420. private _onUserActionRequestedObservable;
  36421. /**
  36422. * Event triggerd when a dom action is required by the user to play the video.
  36423. * This happens due to recent changes in browser policies preventing video to auto start.
  36424. */
  36425. get onUserActionRequestedObservable(): Observable<Texture>;
  36426. private _generateMipMaps;
  36427. private _stillImageCaptured;
  36428. private _displayingPosterTexture;
  36429. private _settings;
  36430. private _createInternalTextureOnEvent;
  36431. private _frameId;
  36432. private _currentSrc;
  36433. /**
  36434. * Creates a video texture.
  36435. * If you want to display a video in your scene, this is the special texture for that.
  36436. * This special texture works similar to other textures, with the exception of a few parameters.
  36437. * @see https://doc.babylonjs.com/how_to/video_texture
  36438. * @param name optional name, will detect from video source, if not defined
  36439. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  36440. * @param scene is obviously the current scene.
  36441. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  36442. * @param invertY is false by default but can be used to invert video on Y axis
  36443. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  36444. * @param settings allows finer control over video usage
  36445. */
  36446. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  36447. private _getName;
  36448. private _getVideo;
  36449. private _createInternalTexture;
  36450. private reset;
  36451. /**
  36452. * @hidden Internal method to initiate `update`.
  36453. */
  36454. _rebuild(): void;
  36455. /**
  36456. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  36457. */
  36458. update(): void;
  36459. /**
  36460. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  36461. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  36462. */
  36463. updateTexture(isVisible: boolean): void;
  36464. protected _updateInternalTexture: () => void;
  36465. /**
  36466. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  36467. * @param url New url.
  36468. */
  36469. updateURL(url: string): void;
  36470. /**
  36471. * Clones the texture.
  36472. * @returns the cloned texture
  36473. */
  36474. clone(): VideoTexture;
  36475. /**
  36476. * Dispose the texture and release its associated resources.
  36477. */
  36478. dispose(): void;
  36479. /**
  36480. * Creates a video texture straight from a stream.
  36481. * @param scene Define the scene the texture should be created in
  36482. * @param stream Define the stream the texture should be created from
  36483. * @returns The created video texture as a promise
  36484. */
  36485. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  36486. /**
  36487. * Creates a video texture straight from your WebCam video feed.
  36488. * @param scene Define the scene the texture should be created in
  36489. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36490. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36491. * @returns The created video texture as a promise
  36492. */
  36493. static CreateFromWebCamAsync(scene: Scene, constraints: {
  36494. minWidth: number;
  36495. maxWidth: number;
  36496. minHeight: number;
  36497. maxHeight: number;
  36498. deviceId: string;
  36499. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  36500. /**
  36501. * Creates a video texture straight from your WebCam video feed.
  36502. * @param scene Define the scene the texture should be created in
  36503. * @param onReady Define a callback to triggered once the texture will be ready
  36504. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36505. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36506. */
  36507. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  36508. minWidth: number;
  36509. maxWidth: number;
  36510. minHeight: number;
  36511. maxHeight: number;
  36512. deviceId: string;
  36513. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  36514. }
  36515. }
  36516. declare module "babylonjs/Engines/thinEngine" {
  36517. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  36518. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  36519. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  36520. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  36521. import { Nullable, DataArray, IndicesArray } from "babylonjs/types";
  36522. import { EngineCapabilities } from "babylonjs/Engines/engineCapabilities";
  36523. import { Observable } from "babylonjs/Misc/observable";
  36524. import { DepthCullingState } from "babylonjs/States/depthCullingState";
  36525. import { StencilState } from "babylonjs/States/stencilState";
  36526. import { AlphaState } from "babylonjs/States/alphaCullingState";
  36527. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36528. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  36529. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  36530. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  36531. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  36532. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  36533. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  36534. import { InstancingAttributeInfo } from "babylonjs/Engines/instancingAttributeInfo";
  36535. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  36536. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  36537. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  36538. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  36539. import { WebRequest } from "babylonjs/Misc/webRequest";
  36540. import { LoadFileError } from "babylonjs/Misc/fileTools";
  36541. /**
  36542. * Defines the interface used by objects working like Scene
  36543. * @hidden
  36544. */
  36545. export interface ISceneLike {
  36546. _addPendingData(data: any): void;
  36547. _removePendingData(data: any): void;
  36548. offlineProvider: IOfflineProvider;
  36549. }
  36550. /**
  36551. * Information about the current host
  36552. */
  36553. export interface HostInformation {
  36554. /**
  36555. * Defines if the current host is a mobile
  36556. */
  36557. isMobile: boolean;
  36558. }
  36559. /** Interface defining initialization parameters for Engine class */
  36560. export interface EngineOptions extends WebGLContextAttributes {
  36561. /**
  36562. * Defines if the engine should no exceed a specified device ratio
  36563. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  36564. */
  36565. limitDeviceRatio?: number;
  36566. /**
  36567. * Defines if webvr should be enabled automatically
  36568. * @see https://doc.babylonjs.com/how_to/webvr_camera
  36569. */
  36570. autoEnableWebVR?: boolean;
  36571. /**
  36572. * Defines if webgl2 should be turned off even if supported
  36573. * @see https://doc.babylonjs.com/features/webgl2
  36574. */
  36575. disableWebGL2Support?: boolean;
  36576. /**
  36577. * Defines if webaudio should be initialized as well
  36578. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  36579. */
  36580. audioEngine?: boolean;
  36581. /**
  36582. * Defines if animations should run using a deterministic lock step
  36583. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  36584. */
  36585. deterministicLockstep?: boolean;
  36586. /** Defines the maximum steps to use with deterministic lock step mode */
  36587. lockstepMaxSteps?: number;
  36588. /** Defines the seconds between each deterministic lock step */
  36589. timeStep?: number;
  36590. /**
  36591. * Defines that engine should ignore context lost events
  36592. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  36593. */
  36594. doNotHandleContextLost?: boolean;
  36595. /**
  36596. * Defines that engine should ignore modifying touch action attribute and style
  36597. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  36598. */
  36599. doNotHandleTouchAction?: boolean;
  36600. /**
  36601. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  36602. */
  36603. useHighPrecisionFloats?: boolean;
  36604. /**
  36605. * Make the canvas XR Compatible for XR sessions
  36606. */
  36607. xrCompatible?: boolean;
  36608. /**
  36609. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  36610. */
  36611. useHighPrecisionMatrix?: boolean;
  36612. }
  36613. /**
  36614. * The base engine class (root of all engines)
  36615. */
  36616. export class ThinEngine {
  36617. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  36618. static ExceptionList: ({
  36619. key: string;
  36620. capture: string;
  36621. captureConstraint: number;
  36622. targets: string[];
  36623. } | {
  36624. key: string;
  36625. capture: null;
  36626. captureConstraint: null;
  36627. targets: string[];
  36628. })[];
  36629. /** @hidden */
  36630. static _TextureLoaders: IInternalTextureLoader[];
  36631. /**
  36632. * Returns the current npm package of the sdk
  36633. */
  36634. static get NpmPackage(): string;
  36635. /**
  36636. * Returns the current version of the framework
  36637. */
  36638. static get Version(): string;
  36639. /**
  36640. * Returns a string describing the current engine
  36641. */
  36642. get description(): string;
  36643. /**
  36644. * Gets or sets the epsilon value used by collision engine
  36645. */
  36646. static CollisionsEpsilon: number;
  36647. /**
  36648. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  36649. */
  36650. static get ShadersRepository(): string;
  36651. static set ShadersRepository(value: string);
  36652. /** @hidden */
  36653. _shaderProcessor: IShaderProcessor;
  36654. /**
  36655. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  36656. */
  36657. forcePOTTextures: boolean;
  36658. /**
  36659. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  36660. */
  36661. isFullscreen: boolean;
  36662. /**
  36663. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  36664. */
  36665. cullBackFaces: boolean;
  36666. /**
  36667. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  36668. */
  36669. renderEvenInBackground: boolean;
  36670. /**
  36671. * Gets or sets a boolean indicating that cache can be kept between frames
  36672. */
  36673. preventCacheWipeBetweenFrames: boolean;
  36674. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  36675. validateShaderPrograms: boolean;
  36676. /**
  36677. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  36678. * This can provide greater z depth for distant objects.
  36679. */
  36680. useReverseDepthBuffer: boolean;
  36681. /**
  36682. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  36683. */
  36684. disableUniformBuffers: boolean;
  36685. /** @hidden */
  36686. _uniformBuffers: UniformBuffer[];
  36687. /**
  36688. * Gets a boolean indicating that the engine supports uniform buffers
  36689. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  36690. */
  36691. get supportsUniformBuffers(): boolean;
  36692. /** @hidden */
  36693. _gl: WebGLRenderingContext;
  36694. /** @hidden */
  36695. _webGLVersion: number;
  36696. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  36697. protected _windowIsBackground: boolean;
  36698. protected _creationOptions: EngineOptions;
  36699. protected _highPrecisionShadersAllowed: boolean;
  36700. /** @hidden */
  36701. get _shouldUseHighPrecisionShader(): boolean;
  36702. /**
  36703. * Gets a boolean indicating that only power of 2 textures are supported
  36704. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  36705. */
  36706. get needPOTTextures(): boolean;
  36707. /** @hidden */
  36708. _badOS: boolean;
  36709. /** @hidden */
  36710. _badDesktopOS: boolean;
  36711. private _hardwareScalingLevel;
  36712. /** @hidden */
  36713. _caps: EngineCapabilities;
  36714. private _isStencilEnable;
  36715. private _glVersion;
  36716. private _glRenderer;
  36717. private _glVendor;
  36718. /** @hidden */
  36719. _videoTextureSupported: boolean;
  36720. protected _renderingQueueLaunched: boolean;
  36721. protected _activeRenderLoops: (() => void)[];
  36722. /**
  36723. * Observable signaled when a context lost event is raised
  36724. */
  36725. onContextLostObservable: Observable<ThinEngine>;
  36726. /**
  36727. * Observable signaled when a context restored event is raised
  36728. */
  36729. onContextRestoredObservable: Observable<ThinEngine>;
  36730. private _onContextLost;
  36731. private _onContextRestored;
  36732. protected _contextWasLost: boolean;
  36733. /** @hidden */
  36734. _doNotHandleContextLost: boolean;
  36735. /**
  36736. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  36737. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  36738. */
  36739. get doNotHandleContextLost(): boolean;
  36740. set doNotHandleContextLost(value: boolean);
  36741. /**
  36742. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  36743. */
  36744. disableVertexArrayObjects: boolean;
  36745. /** @hidden */
  36746. protected _colorWrite: boolean;
  36747. /** @hidden */
  36748. protected _colorWriteChanged: boolean;
  36749. /** @hidden */
  36750. protected _depthCullingState: DepthCullingState;
  36751. /** @hidden */
  36752. protected _stencilState: StencilState;
  36753. /** @hidden */
  36754. _alphaState: AlphaState;
  36755. /** @hidden */
  36756. _alphaMode: number;
  36757. /** @hidden */
  36758. _alphaEquation: number;
  36759. /** @hidden */
  36760. _internalTexturesCache: InternalTexture[];
  36761. /** @hidden */
  36762. protected _activeChannel: number;
  36763. private _currentTextureChannel;
  36764. /** @hidden */
  36765. protected _boundTexturesCache: {
  36766. [key: string]: Nullable<InternalTexture>;
  36767. };
  36768. /** @hidden */
  36769. protected _currentEffect: Nullable<Effect>;
  36770. /** @hidden */
  36771. protected _currentProgram: Nullable<WebGLProgram>;
  36772. private _compiledEffects;
  36773. private _vertexAttribArraysEnabled;
  36774. /** @hidden */
  36775. protected _cachedViewport: Nullable<IViewportLike>;
  36776. private _cachedVertexArrayObject;
  36777. /** @hidden */
  36778. protected _cachedVertexBuffers: any;
  36779. /** @hidden */
  36780. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  36781. /** @hidden */
  36782. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  36783. /** @hidden */
  36784. _currentRenderTarget: Nullable<InternalTexture>;
  36785. private _uintIndicesCurrentlySet;
  36786. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  36787. /** @hidden */
  36788. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  36789. /** @hidden */
  36790. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  36791. private _currentBufferPointers;
  36792. private _currentInstanceLocations;
  36793. private _currentInstanceBuffers;
  36794. private _textureUnits;
  36795. /** @hidden */
  36796. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  36797. /** @hidden */
  36798. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  36799. /** @hidden */
  36800. _boundRenderFunction: any;
  36801. private _vaoRecordInProgress;
  36802. private _mustWipeVertexAttributes;
  36803. private _emptyTexture;
  36804. private _emptyCubeTexture;
  36805. private _emptyTexture3D;
  36806. private _emptyTexture2DArray;
  36807. /** @hidden */
  36808. _frameHandler: number;
  36809. private _nextFreeTextureSlots;
  36810. private _maxSimultaneousTextures;
  36811. private _activeRequests;
  36812. /** @hidden */
  36813. _transformTextureUrl: Nullable<(url: string) => string>;
  36814. /**
  36815. * Gets information about the current host
  36816. */
  36817. hostInformation: HostInformation;
  36818. protected get _supportsHardwareTextureRescaling(): boolean;
  36819. private _framebufferDimensionsObject;
  36820. /**
  36821. * sets the object from which width and height will be taken from when getting render width and height
  36822. * Will fallback to the gl object
  36823. * @param dimensions the framebuffer width and height that will be used.
  36824. */
  36825. set framebufferDimensionsObject(dimensions: Nullable<{
  36826. framebufferWidth: number;
  36827. framebufferHeight: number;
  36828. }>);
  36829. /**
  36830. * Gets the current viewport
  36831. */
  36832. get currentViewport(): Nullable<IViewportLike>;
  36833. /**
  36834. * Gets the default empty texture
  36835. */
  36836. get emptyTexture(): InternalTexture;
  36837. /**
  36838. * Gets the default empty 3D texture
  36839. */
  36840. get emptyTexture3D(): InternalTexture;
  36841. /**
  36842. * Gets the default empty 2D array texture
  36843. */
  36844. get emptyTexture2DArray(): InternalTexture;
  36845. /**
  36846. * Gets the default empty cube texture
  36847. */
  36848. get emptyCubeTexture(): InternalTexture;
  36849. /**
  36850. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  36851. */
  36852. readonly premultipliedAlpha: boolean;
  36853. /**
  36854. * Observable event triggered before each texture is initialized
  36855. */
  36856. onBeforeTextureInitObservable: Observable<import("babylonjs/Materials/Textures/texture").Texture>;
  36857. /**
  36858. * Creates a new engine
  36859. * @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
  36860. * @param antialias defines enable antialiasing (default: false)
  36861. * @param options defines further options to be sent to the getContext() function
  36862. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  36863. */
  36864. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  36865. private _rebuildInternalTextures;
  36866. private _rebuildEffects;
  36867. /**
  36868. * Gets a boolean indicating if all created effects are ready
  36869. * @returns true if all effects are ready
  36870. */
  36871. areAllEffectsReady(): boolean;
  36872. protected _rebuildBuffers(): void;
  36873. protected _initGLContext(): void;
  36874. /**
  36875. * Gets version of the current webGL context
  36876. */
  36877. get webGLVersion(): number;
  36878. /**
  36879. * Gets a string identifying the name of the class
  36880. * @returns "Engine" string
  36881. */
  36882. getClassName(): string;
  36883. /**
  36884. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  36885. */
  36886. get isStencilEnable(): boolean;
  36887. /** @hidden */
  36888. _prepareWorkingCanvas(): void;
  36889. /**
  36890. * Reset the texture cache to empty state
  36891. */
  36892. resetTextureCache(): void;
  36893. /**
  36894. * Gets an object containing information about the current webGL context
  36895. * @returns an object containing the vender, the renderer and the version of the current webGL context
  36896. */
  36897. getGlInfo(): {
  36898. vendor: string;
  36899. renderer: string;
  36900. version: string;
  36901. };
  36902. /**
  36903. * Defines the hardware scaling level.
  36904. * By default the hardware scaling level is computed from the window device ratio.
  36905. * 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.
  36906. * @param level defines the level to use
  36907. */
  36908. setHardwareScalingLevel(level: number): void;
  36909. /**
  36910. * Gets the current hardware scaling level.
  36911. * By default the hardware scaling level is computed from the window device ratio.
  36912. * 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.
  36913. * @returns a number indicating the current hardware scaling level
  36914. */
  36915. getHardwareScalingLevel(): number;
  36916. /**
  36917. * Gets the list of loaded textures
  36918. * @returns an array containing all loaded textures
  36919. */
  36920. getLoadedTexturesCache(): InternalTexture[];
  36921. /**
  36922. * Gets the object containing all engine capabilities
  36923. * @returns the EngineCapabilities object
  36924. */
  36925. getCaps(): EngineCapabilities;
  36926. /**
  36927. * stop executing a render loop function and remove it from the execution array
  36928. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  36929. */
  36930. stopRenderLoop(renderFunction?: () => void): void;
  36931. /** @hidden */
  36932. _renderLoop(): void;
  36933. /**
  36934. * Gets the HTML canvas attached with the current webGL context
  36935. * @returns a HTML canvas
  36936. */
  36937. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  36938. /**
  36939. * Gets host window
  36940. * @returns the host window object
  36941. */
  36942. getHostWindow(): Nullable<Window>;
  36943. /**
  36944. * Gets the current render width
  36945. * @param useScreen defines if screen size must be used (or the current render target if any)
  36946. * @returns a number defining the current render width
  36947. */
  36948. getRenderWidth(useScreen?: boolean): number;
  36949. /**
  36950. * Gets the current render height
  36951. * @param useScreen defines if screen size must be used (or the current render target if any)
  36952. * @returns a number defining the current render height
  36953. */
  36954. getRenderHeight(useScreen?: boolean): number;
  36955. /**
  36956. * Can be used to override the current requestAnimationFrame requester.
  36957. * @hidden
  36958. */
  36959. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  36960. /**
  36961. * Register and execute a render loop. The engine can have more than one render function
  36962. * @param renderFunction defines the function to continuously execute
  36963. */
  36964. runRenderLoop(renderFunction: () => void): void;
  36965. /**
  36966. * Clear the current render buffer or the current render target (if any is set up)
  36967. * @param color defines the color to use
  36968. * @param backBuffer defines if the back buffer must be cleared
  36969. * @param depth defines if the depth buffer must be cleared
  36970. * @param stencil defines if the stencil buffer must be cleared
  36971. */
  36972. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  36973. private _viewportCached;
  36974. /** @hidden */
  36975. _viewport(x: number, y: number, width: number, height: number): void;
  36976. /**
  36977. * Set the WebGL's viewport
  36978. * @param viewport defines the viewport element to be used
  36979. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  36980. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  36981. */
  36982. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  36983. /**
  36984. * Begin a new frame
  36985. */
  36986. beginFrame(): void;
  36987. /**
  36988. * Enf the current frame
  36989. */
  36990. endFrame(): void;
  36991. /**
  36992. * Resize the view according to the canvas' size
  36993. */
  36994. resize(): void;
  36995. /**
  36996. * Force a specific size of the canvas
  36997. * @param width defines the new canvas' width
  36998. * @param height defines the new canvas' height
  36999. * @returns true if the size was changed
  37000. */
  37001. setSize(width: number, height: number): boolean;
  37002. /**
  37003. * Binds the frame buffer to the specified texture.
  37004. * @param texture The texture to render to or null for the default canvas
  37005. * @param faceIndex The face of the texture to render to in case of cube texture
  37006. * @param requiredWidth The width of the target to render to
  37007. * @param requiredHeight The height of the target to render to
  37008. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  37009. * @param lodLevel defines the lod level to bind to the frame buffer
  37010. * @param layer defines the 2d array index to bind to frame buffer to
  37011. */
  37012. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  37013. /** @hidden */
  37014. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  37015. /**
  37016. * Unbind the current render target texture from the webGL context
  37017. * @param texture defines the render target texture to unbind
  37018. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  37019. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  37020. */
  37021. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  37022. /**
  37023. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  37024. */
  37025. flushFramebuffer(): void;
  37026. /**
  37027. * Unbind the current render target and bind the default framebuffer
  37028. */
  37029. restoreDefaultFramebuffer(): void;
  37030. /** @hidden */
  37031. protected _resetVertexBufferBinding(): void;
  37032. /**
  37033. * Creates a vertex buffer
  37034. * @param data the data for the vertex buffer
  37035. * @returns the new WebGL static buffer
  37036. */
  37037. createVertexBuffer(data: DataArray): DataBuffer;
  37038. private _createVertexBuffer;
  37039. /**
  37040. * Creates a dynamic vertex buffer
  37041. * @param data the data for the dynamic vertex buffer
  37042. * @returns the new WebGL dynamic buffer
  37043. */
  37044. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  37045. protected _resetIndexBufferBinding(): void;
  37046. /**
  37047. * Creates a new index buffer
  37048. * @param indices defines the content of the index buffer
  37049. * @param updatable defines if the index buffer must be updatable
  37050. * @returns a new webGL buffer
  37051. */
  37052. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  37053. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  37054. /**
  37055. * Bind a webGL buffer to the webGL context
  37056. * @param buffer defines the buffer to bind
  37057. */
  37058. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  37059. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  37060. private bindBuffer;
  37061. /**
  37062. * update the bound buffer with the given data
  37063. * @param data defines the data to update
  37064. */
  37065. updateArrayBuffer(data: Float32Array): void;
  37066. private _vertexAttribPointer;
  37067. /** @hidden */
  37068. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  37069. private _bindVertexBuffersAttributes;
  37070. /**
  37071. * Records a vertex array object
  37072. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  37073. * @param vertexBuffers defines the list of vertex buffers to store
  37074. * @param indexBuffer defines the index buffer to store
  37075. * @param effect defines the effect to store
  37076. * @returns the new vertex array object
  37077. */
  37078. recordVertexArrayObject(vertexBuffers: {
  37079. [key: string]: VertexBuffer;
  37080. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  37081. /**
  37082. * Bind a specific vertex array object
  37083. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  37084. * @param vertexArrayObject defines the vertex array object to bind
  37085. * @param indexBuffer defines the index buffer to bind
  37086. */
  37087. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  37088. /**
  37089. * Bind webGl buffers directly to the webGL context
  37090. * @param vertexBuffer defines the vertex buffer to bind
  37091. * @param indexBuffer defines the index buffer to bind
  37092. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  37093. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  37094. * @param effect defines the effect associated with the vertex buffer
  37095. */
  37096. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  37097. private _unbindVertexArrayObject;
  37098. /**
  37099. * Bind a list of vertex buffers to the webGL context
  37100. * @param vertexBuffers defines the list of vertex buffers to bind
  37101. * @param indexBuffer defines the index buffer to bind
  37102. * @param effect defines the effect associated with the vertex buffers
  37103. */
  37104. bindBuffers(vertexBuffers: {
  37105. [key: string]: Nullable<VertexBuffer>;
  37106. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  37107. /**
  37108. * Unbind all instance attributes
  37109. */
  37110. unbindInstanceAttributes(): void;
  37111. /**
  37112. * Release and free the memory of a vertex array object
  37113. * @param vao defines the vertex array object to delete
  37114. */
  37115. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  37116. /** @hidden */
  37117. _releaseBuffer(buffer: DataBuffer): boolean;
  37118. protected _deleteBuffer(buffer: DataBuffer): void;
  37119. /**
  37120. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  37121. * @param instancesBuffer defines the webGL buffer to update and bind
  37122. * @param data defines the data to store in the buffer
  37123. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  37124. */
  37125. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  37126. /**
  37127. * Bind the content of a webGL buffer used with instantiation
  37128. * @param instancesBuffer defines the webGL buffer to bind
  37129. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  37130. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  37131. */
  37132. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  37133. /**
  37134. * Disable the instance attribute corresponding to the name in parameter
  37135. * @param name defines the name of the attribute to disable
  37136. */
  37137. disableInstanceAttributeByName(name: string): void;
  37138. /**
  37139. * Disable the instance attribute corresponding to the location in parameter
  37140. * @param attributeLocation defines the attribute location of the attribute to disable
  37141. */
  37142. disableInstanceAttribute(attributeLocation: number): void;
  37143. /**
  37144. * Disable the attribute corresponding to the location in parameter
  37145. * @param attributeLocation defines the attribute location of the attribute to disable
  37146. */
  37147. disableAttributeByIndex(attributeLocation: number): void;
  37148. /**
  37149. * Send a draw order
  37150. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  37151. * @param indexStart defines the starting index
  37152. * @param indexCount defines the number of index to draw
  37153. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37154. */
  37155. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  37156. /**
  37157. * Draw a list of points
  37158. * @param verticesStart defines the index of first vertex to draw
  37159. * @param verticesCount defines the count of vertices to draw
  37160. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37161. */
  37162. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37163. /**
  37164. * Draw a list of unindexed primitives
  37165. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  37166. * @param verticesStart defines the index of first vertex to draw
  37167. * @param verticesCount defines the count of vertices to draw
  37168. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37169. */
  37170. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37171. /**
  37172. * Draw a list of indexed primitives
  37173. * @param fillMode defines the primitive to use
  37174. * @param indexStart defines the starting index
  37175. * @param indexCount defines the number of index to draw
  37176. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37177. */
  37178. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  37179. /**
  37180. * Draw a list of unindexed primitives
  37181. * @param fillMode defines the primitive to use
  37182. * @param verticesStart defines the index of first vertex to draw
  37183. * @param verticesCount defines the count of vertices to draw
  37184. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37185. */
  37186. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37187. private _drawMode;
  37188. /** @hidden */
  37189. protected _reportDrawCall(): void;
  37190. /** @hidden */
  37191. _releaseEffect(effect: Effect): void;
  37192. /** @hidden */
  37193. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  37194. /**
  37195. * Create a new effect (used to store vertex/fragment shaders)
  37196. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  37197. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  37198. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  37199. * @param samplers defines an array of string used to represent textures
  37200. * @param defines defines the string containing the defines to use to compile the shaders
  37201. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  37202. * @param onCompiled defines a function to call when the effect creation is successful
  37203. * @param onError defines a function to call when the effect creation has failed
  37204. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  37205. * @returns the new Effect
  37206. */
  37207. 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;
  37208. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  37209. private _compileShader;
  37210. private _compileRawShader;
  37211. /** @hidden */
  37212. _getShaderSource(shader: WebGLShader): Nullable<string>;
  37213. /**
  37214. * Directly creates a webGL program
  37215. * @param pipelineContext defines the pipeline context to attach to
  37216. * @param vertexCode defines the vertex shader code to use
  37217. * @param fragmentCode defines the fragment shader code to use
  37218. * @param context defines the webGL context to use (if not set, the current one will be used)
  37219. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  37220. * @returns the new webGL program
  37221. */
  37222. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37223. /**
  37224. * Creates a webGL program
  37225. * @param pipelineContext defines the pipeline context to attach to
  37226. * @param vertexCode defines the vertex shader code to use
  37227. * @param fragmentCode defines the fragment shader code to use
  37228. * @param defines defines the string containing the defines to use to compile the shaders
  37229. * @param context defines the webGL context to use (if not set, the current one will be used)
  37230. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  37231. * @returns the new webGL program
  37232. */
  37233. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37234. /**
  37235. * Creates a new pipeline context
  37236. * @returns the new pipeline
  37237. */
  37238. createPipelineContext(): IPipelineContext;
  37239. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37240. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  37241. /** @hidden */
  37242. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  37243. /** @hidden */
  37244. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  37245. /** @hidden */
  37246. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  37247. /**
  37248. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  37249. * @param pipelineContext defines the pipeline context to use
  37250. * @param uniformsNames defines the list of uniform names
  37251. * @returns an array of webGL uniform locations
  37252. */
  37253. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  37254. /**
  37255. * Gets the lsit of active attributes for a given webGL program
  37256. * @param pipelineContext defines the pipeline context to use
  37257. * @param attributesNames defines the list of attribute names to get
  37258. * @returns an array of indices indicating the offset of each attribute
  37259. */
  37260. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  37261. /**
  37262. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  37263. * @param effect defines the effect to activate
  37264. */
  37265. enableEffect(effect: Nullable<Effect>): void;
  37266. /**
  37267. * Set the value of an uniform to a number (int)
  37268. * @param uniform defines the webGL uniform location where to store the value
  37269. * @param value defines the int number to store
  37270. * @returns true if the value was set
  37271. */
  37272. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): boolean;
  37273. /**
  37274. * Set the value of an uniform to an array of int32
  37275. * @param uniform defines the webGL uniform location where to store the value
  37276. * @param array defines the array of int32 to store
  37277. * @returns true if the value was set
  37278. */
  37279. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  37280. /**
  37281. * Set the value of an uniform to an array of int32 (stored as vec2)
  37282. * @param uniform defines the webGL uniform location where to store the value
  37283. * @param array defines the array of int32 to store
  37284. * @returns true if the value was set
  37285. */
  37286. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  37287. /**
  37288. * Set the value of an uniform to an array of int32 (stored as vec3)
  37289. * @param uniform defines the webGL uniform location where to store the value
  37290. * @param array defines the array of int32 to store
  37291. * @returns true if the value was set
  37292. */
  37293. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  37294. /**
  37295. * Set the value of an uniform to an array of int32 (stored as vec4)
  37296. * @param uniform defines the webGL uniform location where to store the value
  37297. * @param array defines the array of int32 to store
  37298. * @returns true if the value was set
  37299. */
  37300. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  37301. /**
  37302. * Set the value of an uniform to an array of number
  37303. * @param uniform defines the webGL uniform location where to store the value
  37304. * @param array defines the array of number to store
  37305. * @returns true if the value was set
  37306. */
  37307. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  37308. /**
  37309. * Set the value of an uniform to an array of number (stored as vec2)
  37310. * @param uniform defines the webGL uniform location where to store the value
  37311. * @param array defines the array of number to store
  37312. * @returns true if the value was set
  37313. */
  37314. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  37315. /**
  37316. * Set the value of an uniform to an array of number (stored as vec3)
  37317. * @param uniform defines the webGL uniform location where to store the value
  37318. * @param array defines the array of number to store
  37319. * @returns true if the value was set
  37320. */
  37321. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  37322. /**
  37323. * Set the value of an uniform to an array of number (stored as vec4)
  37324. * @param uniform defines the webGL uniform location where to store the value
  37325. * @param array defines the array of number to store
  37326. * @returns true if the value was set
  37327. */
  37328. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  37329. /**
  37330. * Set the value of an uniform to an array of float32 (stored as matrices)
  37331. * @param uniform defines the webGL uniform location where to store the value
  37332. * @param matrices defines the array of float32 to store
  37333. * @returns true if the value was set
  37334. */
  37335. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): boolean;
  37336. /**
  37337. * Set the value of an uniform to a matrix (3x3)
  37338. * @param uniform defines the webGL uniform location where to store the value
  37339. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  37340. * @returns true if the value was set
  37341. */
  37342. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): boolean;
  37343. /**
  37344. * Set the value of an uniform to a matrix (2x2)
  37345. * @param uniform defines the webGL uniform location where to store the value
  37346. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  37347. * @returns true if the value was set
  37348. */
  37349. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): boolean;
  37350. /**
  37351. * Set the value of an uniform to a number (float)
  37352. * @param uniform defines the webGL uniform location where to store the value
  37353. * @param value defines the float number to store
  37354. * @returns true if the value was transfered
  37355. */
  37356. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): boolean;
  37357. /**
  37358. * Set the value of an uniform to a vec2
  37359. * @param uniform defines the webGL uniform location where to store the value
  37360. * @param x defines the 1st component of the value
  37361. * @param y defines the 2nd component of the value
  37362. * @returns true if the value was set
  37363. */
  37364. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): boolean;
  37365. /**
  37366. * Set the value of an uniform to a vec3
  37367. * @param uniform defines the webGL uniform location where to store the value
  37368. * @param x defines the 1st component of the value
  37369. * @param y defines the 2nd component of the value
  37370. * @param z defines the 3rd component of the value
  37371. * @returns true if the value was set
  37372. */
  37373. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): boolean;
  37374. /**
  37375. * Set the value of an uniform to a vec4
  37376. * @param uniform defines the webGL uniform location where to store the value
  37377. * @param x defines the 1st component of the value
  37378. * @param y defines the 2nd component of the value
  37379. * @param z defines the 3rd component of the value
  37380. * @param w defines the 4th component of the value
  37381. * @returns true if the value was set
  37382. */
  37383. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): boolean;
  37384. /**
  37385. * Apply all cached states (depth, culling, stencil and alpha)
  37386. */
  37387. applyStates(): void;
  37388. /**
  37389. * Enable or disable color writing
  37390. * @param enable defines the state to set
  37391. */
  37392. setColorWrite(enable: boolean): void;
  37393. /**
  37394. * Gets a boolean indicating if color writing is enabled
  37395. * @returns the current color writing state
  37396. */
  37397. getColorWrite(): boolean;
  37398. /**
  37399. * Gets the depth culling state manager
  37400. */
  37401. get depthCullingState(): DepthCullingState;
  37402. /**
  37403. * Gets the alpha state manager
  37404. */
  37405. get alphaState(): AlphaState;
  37406. /**
  37407. * Gets the stencil state manager
  37408. */
  37409. get stencilState(): StencilState;
  37410. /**
  37411. * Clears the list of texture accessible through engine.
  37412. * This can help preventing texture load conflict due to name collision.
  37413. */
  37414. clearInternalTexturesCache(): void;
  37415. /**
  37416. * Force the entire cache to be cleared
  37417. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  37418. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  37419. */
  37420. wipeCaches(bruteForce?: boolean): void;
  37421. /** @hidden */
  37422. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  37423. min: number;
  37424. mag: number;
  37425. };
  37426. /** @hidden */
  37427. _createTexture(): WebGLTexture;
  37428. /**
  37429. * Usually called from Texture.ts.
  37430. * Passed information to create a WebGLTexture
  37431. * @param url defines a value which contains one of the following:
  37432. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  37433. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  37434. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  37435. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  37436. * @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)
  37437. * @param scene needed for loading to the correct scene
  37438. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  37439. * @param onLoad optional callback to be called upon successful completion
  37440. * @param onError optional callback to be called upon failure
  37441. * @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
  37442. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  37443. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  37444. * @param forcedExtension defines the extension to use to pick the right loader
  37445. * @param mimeType defines an optional mime type
  37446. * @returns a InternalTexture for assignment back into BABYLON.Texture
  37447. */
  37448. 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;
  37449. /**
  37450. * Loads an image as an HTMLImageElement.
  37451. * @param input url string, ArrayBuffer, or Blob to load
  37452. * @param onLoad callback called when the image successfully loads
  37453. * @param onError callback called when the image fails to load
  37454. * @param offlineProvider offline provider for caching
  37455. * @param mimeType optional mime type
  37456. * @returns the HTMLImageElement of the loaded image
  37457. * @hidden
  37458. */
  37459. 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>;
  37460. /**
  37461. * @hidden
  37462. */
  37463. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  37464. private _unpackFlipYCached;
  37465. /**
  37466. * In case you are sharing the context with other applications, it might
  37467. * be interested to not cache the unpack flip y state to ensure a consistent
  37468. * value would be set.
  37469. */
  37470. enableUnpackFlipYCached: boolean;
  37471. /** @hidden */
  37472. _unpackFlipY(value: boolean): void;
  37473. /** @hidden */
  37474. _getUnpackAlignement(): number;
  37475. private _getTextureTarget;
  37476. /**
  37477. * Update the sampling mode of a given texture
  37478. * @param samplingMode defines the required sampling mode
  37479. * @param texture defines the texture to update
  37480. * @param generateMipMaps defines whether to generate mipmaps for the texture
  37481. */
  37482. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  37483. /**
  37484. * Update the sampling mode of a given texture
  37485. * @param texture defines the texture to update
  37486. * @param wrapU defines the texture wrap mode of the u coordinates
  37487. * @param wrapV defines the texture wrap mode of the v coordinates
  37488. * @param wrapR defines the texture wrap mode of the r coordinates
  37489. */
  37490. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  37491. /** @hidden */
  37492. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  37493. width: number;
  37494. height: number;
  37495. layers?: number;
  37496. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  37497. /** @hidden */
  37498. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37499. /** @hidden */
  37500. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  37501. /**
  37502. * Update a portion of an internal texture
  37503. * @param texture defines the texture to update
  37504. * @param imageData defines the data to store into the texture
  37505. * @param xOffset defines the x coordinates of the update rectangle
  37506. * @param yOffset defines the y coordinates of the update rectangle
  37507. * @param width defines the width of the update rectangle
  37508. * @param height defines the height of the update rectangle
  37509. * @param faceIndex defines the face index if texture is a cube (0 by default)
  37510. * @param lod defines the lod level to update (0 by default)
  37511. */
  37512. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  37513. /** @hidden */
  37514. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37515. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  37516. private _prepareWebGLTexture;
  37517. /** @hidden */
  37518. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  37519. private _getDepthStencilBuffer;
  37520. /** @hidden */
  37521. _releaseFramebufferObjects(texture: InternalTexture): void;
  37522. /** @hidden */
  37523. _releaseTexture(texture: InternalTexture): void;
  37524. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  37525. protected _setProgram(program: WebGLProgram): void;
  37526. protected _boundUniforms: {
  37527. [key: number]: WebGLUniformLocation;
  37528. };
  37529. /**
  37530. * Binds an effect to the webGL context
  37531. * @param effect defines the effect to bind
  37532. */
  37533. bindSamplers(effect: Effect): void;
  37534. private _activateCurrentTexture;
  37535. /** @hidden */
  37536. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  37537. /** @hidden */
  37538. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  37539. /**
  37540. * Unbind all textures from the webGL context
  37541. */
  37542. unbindAllTextures(): void;
  37543. /**
  37544. * Sets a texture to the according uniform.
  37545. * @param channel The texture channel
  37546. * @param uniform The uniform to set
  37547. * @param texture The texture to apply
  37548. */
  37549. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  37550. private _bindSamplerUniformToChannel;
  37551. private _getTextureWrapMode;
  37552. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  37553. /**
  37554. * Sets an array of texture to the webGL context
  37555. * @param channel defines the channel where the texture array must be set
  37556. * @param uniform defines the associated uniform location
  37557. * @param textures defines the array of textures to bind
  37558. */
  37559. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  37560. /** @hidden */
  37561. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  37562. private _setTextureParameterFloat;
  37563. private _setTextureParameterInteger;
  37564. /**
  37565. * Unbind all vertex attributes from the webGL context
  37566. */
  37567. unbindAllAttributes(): void;
  37568. /**
  37569. * 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
  37570. */
  37571. releaseEffects(): void;
  37572. /**
  37573. * Dispose and release all associated resources
  37574. */
  37575. dispose(): void;
  37576. /**
  37577. * Attach a new callback raised when context lost event is fired
  37578. * @param callback defines the callback to call
  37579. */
  37580. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37581. /**
  37582. * Attach a new callback raised when context restored event is fired
  37583. * @param callback defines the callback to call
  37584. */
  37585. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37586. /**
  37587. * Get the current error code of the webGL context
  37588. * @returns the error code
  37589. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  37590. */
  37591. getError(): number;
  37592. private _canRenderToFloatFramebuffer;
  37593. private _canRenderToHalfFloatFramebuffer;
  37594. private _canRenderToFramebuffer;
  37595. /** @hidden */
  37596. _getWebGLTextureType(type: number): number;
  37597. /** @hidden */
  37598. _getInternalFormat(format: number): number;
  37599. /** @hidden */
  37600. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  37601. /** @hidden */
  37602. _getRGBAMultiSampleBufferFormat(type: number): number;
  37603. /** @hidden */
  37604. _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;
  37605. /**
  37606. * Loads a file from a url
  37607. * @param url url to load
  37608. * @param onSuccess callback called when the file successfully loads
  37609. * @param onProgress callback called while file is loading (if the server supports this mode)
  37610. * @param offlineProvider defines the offline provider for caching
  37611. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  37612. * @param onError callback called when the file fails to load
  37613. * @returns a file request object
  37614. * @hidden
  37615. */
  37616. 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;
  37617. /**
  37618. * Reads pixels from the current frame buffer. Please note that this function can be slow
  37619. * @param x defines the x coordinate of the rectangle where pixels must be read
  37620. * @param y defines the y coordinate of the rectangle where pixels must be read
  37621. * @param width defines the width of the rectangle where pixels must be read
  37622. * @param height defines the height of the rectangle where pixels must be read
  37623. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  37624. * @returns a Uint8Array containing RGBA colors
  37625. */
  37626. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  37627. private static _isSupported;
  37628. /**
  37629. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  37630. * @returns true if the engine can be created
  37631. * @ignorenaming
  37632. */
  37633. static isSupported(): boolean;
  37634. /**
  37635. * Find the next highest power of two.
  37636. * @param x Number to start search from.
  37637. * @return Next highest power of two.
  37638. */
  37639. static CeilingPOT(x: number): number;
  37640. /**
  37641. * Find the next lowest power of two.
  37642. * @param x Number to start search from.
  37643. * @return Next lowest power of two.
  37644. */
  37645. static FloorPOT(x: number): number;
  37646. /**
  37647. * Find the nearest power of two.
  37648. * @param x Number to start search from.
  37649. * @return Next nearest power of two.
  37650. */
  37651. static NearestPOT(x: number): number;
  37652. /**
  37653. * Get the closest exponent of two
  37654. * @param value defines the value to approximate
  37655. * @param max defines the maximum value to return
  37656. * @param mode defines how to define the closest value
  37657. * @returns closest exponent of two of the given value
  37658. */
  37659. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  37660. /**
  37661. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  37662. * @param func - the function to be called
  37663. * @param requester - the object that will request the next frame. Falls back to window.
  37664. * @returns frame number
  37665. */
  37666. static QueueNewFrame(func: () => void, requester?: any): number;
  37667. /**
  37668. * Gets host document
  37669. * @returns the host document object
  37670. */
  37671. getHostDocument(): Nullable<Document>;
  37672. }
  37673. }
  37674. declare module "babylonjs/Maths/sphericalPolynomial" {
  37675. import { Vector3 } from "babylonjs/Maths/math.vector";
  37676. import { Color3 } from "babylonjs/Maths/math.color";
  37677. /**
  37678. * Class representing spherical harmonics coefficients to the 3rd degree
  37679. */
  37680. export class SphericalHarmonics {
  37681. /**
  37682. * Defines whether or not the harmonics have been prescaled for rendering.
  37683. */
  37684. preScaled: boolean;
  37685. /**
  37686. * The l0,0 coefficients of the spherical harmonics
  37687. */
  37688. l00: Vector3;
  37689. /**
  37690. * The l1,-1 coefficients of the spherical harmonics
  37691. */
  37692. l1_1: Vector3;
  37693. /**
  37694. * The l1,0 coefficients of the spherical harmonics
  37695. */
  37696. l10: Vector3;
  37697. /**
  37698. * The l1,1 coefficients of the spherical harmonics
  37699. */
  37700. l11: Vector3;
  37701. /**
  37702. * The l2,-2 coefficients of the spherical harmonics
  37703. */
  37704. l2_2: Vector3;
  37705. /**
  37706. * The l2,-1 coefficients of the spherical harmonics
  37707. */
  37708. l2_1: Vector3;
  37709. /**
  37710. * The l2,0 coefficients of the spherical harmonics
  37711. */
  37712. l20: Vector3;
  37713. /**
  37714. * The l2,1 coefficients of the spherical harmonics
  37715. */
  37716. l21: Vector3;
  37717. /**
  37718. * The l2,2 coefficients of the spherical harmonics
  37719. */
  37720. l22: Vector3;
  37721. /**
  37722. * Adds a light to the spherical harmonics
  37723. * @param direction the direction of the light
  37724. * @param color the color of the light
  37725. * @param deltaSolidAngle the delta solid angle of the light
  37726. */
  37727. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  37728. /**
  37729. * Scales the spherical harmonics by the given amount
  37730. * @param scale the amount to scale
  37731. */
  37732. scaleInPlace(scale: number): void;
  37733. /**
  37734. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  37735. *
  37736. * ```
  37737. * E_lm = A_l * L_lm
  37738. * ```
  37739. *
  37740. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  37741. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  37742. * the scaling factors are given in equation 9.
  37743. */
  37744. convertIncidentRadianceToIrradiance(): void;
  37745. /**
  37746. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  37747. *
  37748. * ```
  37749. * L = (1/pi) * E * rho
  37750. * ```
  37751. *
  37752. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  37753. */
  37754. convertIrradianceToLambertianRadiance(): void;
  37755. /**
  37756. * Integrates the reconstruction coefficients directly in to the SH preventing further
  37757. * required operations at run time.
  37758. *
  37759. * This is simply done by scaling back the SH with Ylm constants parameter.
  37760. * The trigonometric part being applied by the shader at run time.
  37761. */
  37762. preScaleForRendering(): void;
  37763. /**
  37764. * Constructs a spherical harmonics from an array.
  37765. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  37766. * @returns the spherical harmonics
  37767. */
  37768. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  37769. /**
  37770. * Gets the spherical harmonics from polynomial
  37771. * @param polynomial the spherical polynomial
  37772. * @returns the spherical harmonics
  37773. */
  37774. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  37775. }
  37776. /**
  37777. * Class representing spherical polynomial coefficients to the 3rd degree
  37778. */
  37779. export class SphericalPolynomial {
  37780. private _harmonics;
  37781. /**
  37782. * The spherical harmonics used to create the polynomials.
  37783. */
  37784. get preScaledHarmonics(): SphericalHarmonics;
  37785. /**
  37786. * The x coefficients of the spherical polynomial
  37787. */
  37788. x: Vector3;
  37789. /**
  37790. * The y coefficients of the spherical polynomial
  37791. */
  37792. y: Vector3;
  37793. /**
  37794. * The z coefficients of the spherical polynomial
  37795. */
  37796. z: Vector3;
  37797. /**
  37798. * The xx coefficients of the spherical polynomial
  37799. */
  37800. xx: Vector3;
  37801. /**
  37802. * The yy coefficients of the spherical polynomial
  37803. */
  37804. yy: Vector3;
  37805. /**
  37806. * The zz coefficients of the spherical polynomial
  37807. */
  37808. zz: Vector3;
  37809. /**
  37810. * The xy coefficients of the spherical polynomial
  37811. */
  37812. xy: Vector3;
  37813. /**
  37814. * The yz coefficients of the spherical polynomial
  37815. */
  37816. yz: Vector3;
  37817. /**
  37818. * The zx coefficients of the spherical polynomial
  37819. */
  37820. zx: Vector3;
  37821. /**
  37822. * Adds an ambient color to the spherical polynomial
  37823. * @param color the color to add
  37824. */
  37825. addAmbient(color: Color3): void;
  37826. /**
  37827. * Scales the spherical polynomial by the given amount
  37828. * @param scale the amount to scale
  37829. */
  37830. scaleInPlace(scale: number): void;
  37831. /**
  37832. * Gets the spherical polynomial from harmonics
  37833. * @param harmonics the spherical harmonics
  37834. * @returns the spherical polynomial
  37835. */
  37836. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  37837. /**
  37838. * Constructs a spherical polynomial from an array.
  37839. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  37840. * @returns the spherical polynomial
  37841. */
  37842. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  37843. }
  37844. }
  37845. declare module "babylonjs/Materials/Textures/internalTexture" {
  37846. import { Observable } from "babylonjs/Misc/observable";
  37847. import { Nullable, int } from "babylonjs/types";
  37848. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  37849. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  37850. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  37851. /**
  37852. * Defines the source of the internal texture
  37853. */
  37854. export enum InternalTextureSource {
  37855. /**
  37856. * The source of the texture data is unknown
  37857. */
  37858. Unknown = 0,
  37859. /**
  37860. * Texture data comes from an URL
  37861. */
  37862. Url = 1,
  37863. /**
  37864. * Texture data is only used for temporary storage
  37865. */
  37866. Temp = 2,
  37867. /**
  37868. * Texture data comes from raw data (ArrayBuffer)
  37869. */
  37870. Raw = 3,
  37871. /**
  37872. * Texture content is dynamic (video or dynamic texture)
  37873. */
  37874. Dynamic = 4,
  37875. /**
  37876. * Texture content is generated by rendering to it
  37877. */
  37878. RenderTarget = 5,
  37879. /**
  37880. * Texture content is part of a multi render target process
  37881. */
  37882. MultiRenderTarget = 6,
  37883. /**
  37884. * Texture data comes from a cube data file
  37885. */
  37886. Cube = 7,
  37887. /**
  37888. * Texture data comes from a raw cube data
  37889. */
  37890. CubeRaw = 8,
  37891. /**
  37892. * Texture data come from a prefiltered cube data file
  37893. */
  37894. CubePrefiltered = 9,
  37895. /**
  37896. * Texture content is raw 3D data
  37897. */
  37898. Raw3D = 10,
  37899. /**
  37900. * Texture content is raw 2D array data
  37901. */
  37902. Raw2DArray = 11,
  37903. /**
  37904. * Texture content is a depth texture
  37905. */
  37906. Depth = 12,
  37907. /**
  37908. * Texture data comes from a raw cube data encoded with RGBD
  37909. */
  37910. CubeRawRGBD = 13
  37911. }
  37912. /**
  37913. * Class used to store data associated with WebGL texture data for the engine
  37914. * This class should not be used directly
  37915. */
  37916. export class InternalTexture {
  37917. /** @hidden */
  37918. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  37919. /**
  37920. * Defines if the texture is ready
  37921. */
  37922. isReady: boolean;
  37923. /**
  37924. * Defines if the texture is a cube texture
  37925. */
  37926. isCube: boolean;
  37927. /**
  37928. * Defines if the texture contains 3D data
  37929. */
  37930. is3D: boolean;
  37931. /**
  37932. * Defines if the texture contains 2D array data
  37933. */
  37934. is2DArray: boolean;
  37935. /**
  37936. * Defines if the texture contains multiview data
  37937. */
  37938. isMultiview: boolean;
  37939. /**
  37940. * Gets the URL used to load this texture
  37941. */
  37942. url: string;
  37943. /**
  37944. * Gets the sampling mode of the texture
  37945. */
  37946. samplingMode: number;
  37947. /**
  37948. * Gets a boolean indicating if the texture needs mipmaps generation
  37949. */
  37950. generateMipMaps: boolean;
  37951. /**
  37952. * Gets the number of samples used by the texture (WebGL2+ only)
  37953. */
  37954. samples: number;
  37955. /**
  37956. * Gets the type of the texture (int, float...)
  37957. */
  37958. type: number;
  37959. /**
  37960. * Gets the format of the texture (RGB, RGBA...)
  37961. */
  37962. format: number;
  37963. /**
  37964. * Observable called when the texture is loaded
  37965. */
  37966. onLoadedObservable: Observable<InternalTexture>;
  37967. /**
  37968. * Gets the width of the texture
  37969. */
  37970. width: number;
  37971. /**
  37972. * Gets the height of the texture
  37973. */
  37974. height: number;
  37975. /**
  37976. * Gets the depth of the texture
  37977. */
  37978. depth: number;
  37979. /**
  37980. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  37981. */
  37982. baseWidth: number;
  37983. /**
  37984. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  37985. */
  37986. baseHeight: number;
  37987. /**
  37988. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  37989. */
  37990. baseDepth: number;
  37991. /**
  37992. * Gets a boolean indicating if the texture is inverted on Y axis
  37993. */
  37994. invertY: boolean;
  37995. /** @hidden */
  37996. _invertVScale: boolean;
  37997. /** @hidden */
  37998. _associatedChannel: number;
  37999. /** @hidden */
  38000. _source: InternalTextureSource;
  38001. /** @hidden */
  38002. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  38003. /** @hidden */
  38004. _bufferView: Nullable<ArrayBufferView>;
  38005. /** @hidden */
  38006. _bufferViewArray: Nullable<ArrayBufferView[]>;
  38007. /** @hidden */
  38008. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  38009. /** @hidden */
  38010. _size: number;
  38011. /** @hidden */
  38012. _extension: string;
  38013. /** @hidden */
  38014. _files: Nullable<string[]>;
  38015. /** @hidden */
  38016. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  38017. /** @hidden */
  38018. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  38019. /** @hidden */
  38020. _framebuffer: Nullable<WebGLFramebuffer>;
  38021. /** @hidden */
  38022. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  38023. /** @hidden */
  38024. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  38025. /** @hidden */
  38026. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  38027. /** @hidden */
  38028. _attachments: Nullable<number[]>;
  38029. /** @hidden */
  38030. _textureArray: Nullable<InternalTexture[]>;
  38031. /** @hidden */
  38032. _cachedCoordinatesMode: Nullable<number>;
  38033. /** @hidden */
  38034. _cachedWrapU: Nullable<number>;
  38035. /** @hidden */
  38036. _cachedWrapV: Nullable<number>;
  38037. /** @hidden */
  38038. _cachedWrapR: Nullable<number>;
  38039. /** @hidden */
  38040. _cachedAnisotropicFilteringLevel: Nullable<number>;
  38041. /** @hidden */
  38042. _isDisabled: boolean;
  38043. /** @hidden */
  38044. _compression: Nullable<string>;
  38045. /** @hidden */
  38046. _generateStencilBuffer: boolean;
  38047. /** @hidden */
  38048. _generateDepthBuffer: boolean;
  38049. /** @hidden */
  38050. _comparisonFunction: number;
  38051. /** @hidden */
  38052. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  38053. /** @hidden */
  38054. _lodGenerationScale: number;
  38055. /** @hidden */
  38056. _lodGenerationOffset: number;
  38057. /** @hidden */
  38058. _depthStencilTexture: Nullable<InternalTexture>;
  38059. /** @hidden */
  38060. _colorTextureArray: Nullable<WebGLTexture>;
  38061. /** @hidden */
  38062. _depthStencilTextureArray: Nullable<WebGLTexture>;
  38063. /** @hidden */
  38064. _lodTextureHigh: Nullable<BaseTexture>;
  38065. /** @hidden */
  38066. _lodTextureMid: Nullable<BaseTexture>;
  38067. /** @hidden */
  38068. _lodTextureLow: Nullable<BaseTexture>;
  38069. /** @hidden */
  38070. _isRGBD: boolean;
  38071. /** @hidden */
  38072. _linearSpecularLOD: boolean;
  38073. /** @hidden */
  38074. _irradianceTexture: Nullable<BaseTexture>;
  38075. /** @hidden */
  38076. _webGLTexture: Nullable<WebGLTexture>;
  38077. /** @hidden */
  38078. _references: number;
  38079. /** @hidden */
  38080. _gammaSpace: Nullable<boolean>;
  38081. private _engine;
  38082. /**
  38083. * Gets the Engine the texture belongs to.
  38084. * @returns The babylon engine
  38085. */
  38086. getEngine(): ThinEngine;
  38087. /**
  38088. * Gets the data source type of the texture
  38089. */
  38090. get source(): InternalTextureSource;
  38091. /**
  38092. * Creates a new InternalTexture
  38093. * @param engine defines the engine to use
  38094. * @param source defines the type of data that will be used
  38095. * @param delayAllocation if the texture allocation should be delayed (default: false)
  38096. */
  38097. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  38098. /**
  38099. * Increments the number of references (ie. the number of Texture that point to it)
  38100. */
  38101. incrementReferences(): void;
  38102. /**
  38103. * Change the size of the texture (not the size of the content)
  38104. * @param width defines the new width
  38105. * @param height defines the new height
  38106. * @param depth defines the new depth (1 by default)
  38107. */
  38108. updateSize(width: int, height: int, depth?: int): void;
  38109. /** @hidden */
  38110. _rebuild(): void;
  38111. /** @hidden */
  38112. _swapAndDie(target: InternalTexture): void;
  38113. /**
  38114. * Dispose the current allocated resources
  38115. */
  38116. dispose(): void;
  38117. }
  38118. }
  38119. declare module "babylonjs/Audio/analyser" {
  38120. import { Scene } from "babylonjs/scene";
  38121. /**
  38122. * Class used to work with sound analyzer using fast fourier transform (FFT)
  38123. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38124. */
  38125. export class Analyser {
  38126. /**
  38127. * Gets or sets the smoothing
  38128. * @ignorenaming
  38129. */
  38130. SMOOTHING: number;
  38131. /**
  38132. * Gets or sets the FFT table size
  38133. * @ignorenaming
  38134. */
  38135. FFT_SIZE: number;
  38136. /**
  38137. * Gets or sets the bar graph amplitude
  38138. * @ignorenaming
  38139. */
  38140. BARGRAPHAMPLITUDE: number;
  38141. /**
  38142. * Gets or sets the position of the debug canvas
  38143. * @ignorenaming
  38144. */
  38145. DEBUGCANVASPOS: {
  38146. x: number;
  38147. y: number;
  38148. };
  38149. /**
  38150. * Gets or sets the debug canvas size
  38151. * @ignorenaming
  38152. */
  38153. DEBUGCANVASSIZE: {
  38154. width: number;
  38155. height: number;
  38156. };
  38157. private _byteFreqs;
  38158. private _byteTime;
  38159. private _floatFreqs;
  38160. private _webAudioAnalyser;
  38161. private _debugCanvas;
  38162. private _debugCanvasContext;
  38163. private _scene;
  38164. private _registerFunc;
  38165. private _audioEngine;
  38166. /**
  38167. * Creates a new analyser
  38168. * @param scene defines hosting scene
  38169. */
  38170. constructor(scene: Scene);
  38171. /**
  38172. * Get the number of data values you will have to play with for the visualization
  38173. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  38174. * @returns a number
  38175. */
  38176. getFrequencyBinCount(): number;
  38177. /**
  38178. * Gets the current frequency data as a byte array
  38179. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  38180. * @returns a Uint8Array
  38181. */
  38182. getByteFrequencyData(): Uint8Array;
  38183. /**
  38184. * Gets the current waveform as a byte array
  38185. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  38186. * @returns a Uint8Array
  38187. */
  38188. getByteTimeDomainData(): Uint8Array;
  38189. /**
  38190. * Gets the current frequency data as a float array
  38191. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  38192. * @returns a Float32Array
  38193. */
  38194. getFloatFrequencyData(): Float32Array;
  38195. /**
  38196. * Renders the debug canvas
  38197. */
  38198. drawDebugCanvas(): void;
  38199. /**
  38200. * Stops rendering the debug canvas and removes it
  38201. */
  38202. stopDebugCanvas(): void;
  38203. /**
  38204. * Connects two audio nodes
  38205. * @param inputAudioNode defines first node to connect
  38206. * @param outputAudioNode defines second node to connect
  38207. */
  38208. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  38209. /**
  38210. * Releases all associated resources
  38211. */
  38212. dispose(): void;
  38213. }
  38214. }
  38215. declare module "babylonjs/Audio/audioEngine" {
  38216. import { IDisposable } from "babylonjs/scene";
  38217. import { Analyser } from "babylonjs/Audio/analyser";
  38218. import { Nullable } from "babylonjs/types";
  38219. import { Observable } from "babylonjs/Misc/observable";
  38220. /**
  38221. * This represents an audio engine and it is responsible
  38222. * to play, synchronize and analyse sounds throughout the application.
  38223. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38224. */
  38225. export interface IAudioEngine extends IDisposable {
  38226. /**
  38227. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  38228. */
  38229. readonly canUseWebAudio: boolean;
  38230. /**
  38231. * Gets the current AudioContext if available.
  38232. */
  38233. readonly audioContext: Nullable<AudioContext>;
  38234. /**
  38235. * The master gain node defines the global audio volume of your audio engine.
  38236. */
  38237. readonly masterGain: GainNode;
  38238. /**
  38239. * Gets whether or not mp3 are supported by your browser.
  38240. */
  38241. readonly isMP3supported: boolean;
  38242. /**
  38243. * Gets whether or not ogg are supported by your browser.
  38244. */
  38245. readonly isOGGsupported: boolean;
  38246. /**
  38247. * Defines if Babylon should emit a warning if WebAudio is not supported.
  38248. * @ignoreNaming
  38249. */
  38250. WarnedWebAudioUnsupported: boolean;
  38251. /**
  38252. * Defines if the audio engine relies on a custom unlocked button.
  38253. * In this case, the embedded button will not be displayed.
  38254. */
  38255. useCustomUnlockedButton: boolean;
  38256. /**
  38257. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  38258. */
  38259. readonly unlocked: boolean;
  38260. /**
  38261. * Event raised when audio has been unlocked on the browser.
  38262. */
  38263. onAudioUnlockedObservable: Observable<AudioEngine>;
  38264. /**
  38265. * Event raised when audio has been locked on the browser.
  38266. */
  38267. onAudioLockedObservable: Observable<AudioEngine>;
  38268. /**
  38269. * Flags the audio engine in Locked state.
  38270. * This happens due to new browser policies preventing audio to autoplay.
  38271. */
  38272. lock(): void;
  38273. /**
  38274. * Unlocks the audio engine once a user action has been done on the dom.
  38275. * This is helpful to resume play once browser policies have been satisfied.
  38276. */
  38277. unlock(): void;
  38278. /**
  38279. * Gets the global volume sets on the master gain.
  38280. * @returns the global volume if set or -1 otherwise
  38281. */
  38282. getGlobalVolume(): number;
  38283. /**
  38284. * Sets the global volume of your experience (sets on the master gain).
  38285. * @param newVolume Defines the new global volume of the application
  38286. */
  38287. setGlobalVolume(newVolume: number): void;
  38288. /**
  38289. * Connect the audio engine to an audio analyser allowing some amazing
  38290. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  38291. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  38292. * @param analyser The analyser to connect to the engine
  38293. */
  38294. connectToAnalyser(analyser: Analyser): void;
  38295. }
  38296. /**
  38297. * This represents the default audio engine used in babylon.
  38298. * It is responsible to play, synchronize and analyse sounds throughout the application.
  38299. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38300. */
  38301. export class AudioEngine implements IAudioEngine {
  38302. private _audioContext;
  38303. private _audioContextInitialized;
  38304. private _muteButton;
  38305. private _hostElement;
  38306. /**
  38307. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  38308. */
  38309. canUseWebAudio: boolean;
  38310. /**
  38311. * The master gain node defines the global audio volume of your audio engine.
  38312. */
  38313. masterGain: GainNode;
  38314. /**
  38315. * Defines if Babylon should emit a warning if WebAudio is not supported.
  38316. * @ignoreNaming
  38317. */
  38318. WarnedWebAudioUnsupported: boolean;
  38319. /**
  38320. * Gets whether or not mp3 are supported by your browser.
  38321. */
  38322. isMP3supported: boolean;
  38323. /**
  38324. * Gets whether or not ogg are supported by your browser.
  38325. */
  38326. isOGGsupported: boolean;
  38327. /**
  38328. * Gets whether audio has been unlocked on the device.
  38329. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  38330. * a user interaction has happened.
  38331. */
  38332. unlocked: boolean;
  38333. /**
  38334. * Defines if the audio engine relies on a custom unlocked button.
  38335. * In this case, the embedded button will not be displayed.
  38336. */
  38337. useCustomUnlockedButton: boolean;
  38338. /**
  38339. * Event raised when audio has been unlocked on the browser.
  38340. */
  38341. onAudioUnlockedObservable: Observable<AudioEngine>;
  38342. /**
  38343. * Event raised when audio has been locked on the browser.
  38344. */
  38345. onAudioLockedObservable: Observable<AudioEngine>;
  38346. /**
  38347. * Gets the current AudioContext if available.
  38348. */
  38349. get audioContext(): Nullable<AudioContext>;
  38350. private _connectedAnalyser;
  38351. /**
  38352. * Instantiates a new audio engine.
  38353. *
  38354. * There should be only one per page as some browsers restrict the number
  38355. * of audio contexts you can create.
  38356. * @param hostElement defines the host element where to display the mute icon if necessary
  38357. */
  38358. constructor(hostElement?: Nullable<HTMLElement>);
  38359. /**
  38360. * Flags the audio engine in Locked state.
  38361. * This happens due to new browser policies preventing audio to autoplay.
  38362. */
  38363. lock(): void;
  38364. /**
  38365. * Unlocks the audio engine once a user action has been done on the dom.
  38366. * This is helpful to resume play once browser policies have been satisfied.
  38367. */
  38368. unlock(): void;
  38369. private _resumeAudioContext;
  38370. private _initializeAudioContext;
  38371. private _tryToRun;
  38372. private _triggerRunningState;
  38373. private _triggerSuspendedState;
  38374. private _displayMuteButton;
  38375. private _moveButtonToTopLeft;
  38376. private _onResize;
  38377. private _hideMuteButton;
  38378. /**
  38379. * Destroy and release the resources associated with the audio ccontext.
  38380. */
  38381. dispose(): void;
  38382. /**
  38383. * Gets the global volume sets on the master gain.
  38384. * @returns the global volume if set or -1 otherwise
  38385. */
  38386. getGlobalVolume(): number;
  38387. /**
  38388. * Sets the global volume of your experience (sets on the master gain).
  38389. * @param newVolume Defines the new global volume of the application
  38390. */
  38391. setGlobalVolume(newVolume: number): void;
  38392. /**
  38393. * Connect the audio engine to an audio analyser allowing some amazing
  38394. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  38395. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  38396. * @param analyser The analyser to connect to the engine
  38397. */
  38398. connectToAnalyser(analyser: Analyser): void;
  38399. }
  38400. }
  38401. declare module "babylonjs/Loading/loadingScreen" {
  38402. /**
  38403. * Interface used to present a loading screen while loading a scene
  38404. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38405. */
  38406. export interface ILoadingScreen {
  38407. /**
  38408. * Function called to display the loading screen
  38409. */
  38410. displayLoadingUI: () => void;
  38411. /**
  38412. * Function called to hide the loading screen
  38413. */
  38414. hideLoadingUI: () => void;
  38415. /**
  38416. * Gets or sets the color to use for the background
  38417. */
  38418. loadingUIBackgroundColor: string;
  38419. /**
  38420. * Gets or sets the text to display while loading
  38421. */
  38422. loadingUIText: string;
  38423. }
  38424. /**
  38425. * Class used for the default loading screen
  38426. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38427. */
  38428. export class DefaultLoadingScreen implements ILoadingScreen {
  38429. private _renderingCanvas;
  38430. private _loadingText;
  38431. private _loadingDivBackgroundColor;
  38432. private _loadingDiv;
  38433. private _loadingTextDiv;
  38434. /** Gets or sets the logo url to use for the default loading screen */
  38435. static DefaultLogoUrl: string;
  38436. /** Gets or sets the spinner url to use for the default loading screen */
  38437. static DefaultSpinnerUrl: string;
  38438. /**
  38439. * Creates a new default loading screen
  38440. * @param _renderingCanvas defines the canvas used to render the scene
  38441. * @param _loadingText defines the default text to display
  38442. * @param _loadingDivBackgroundColor defines the default background color
  38443. */
  38444. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  38445. /**
  38446. * Function called to display the loading screen
  38447. */
  38448. displayLoadingUI(): void;
  38449. /**
  38450. * Function called to hide the loading screen
  38451. */
  38452. hideLoadingUI(): void;
  38453. /**
  38454. * Gets or sets the text to display while loading
  38455. */
  38456. set loadingUIText(text: string);
  38457. get loadingUIText(): string;
  38458. /**
  38459. * Gets or sets the color to use for the background
  38460. */
  38461. get loadingUIBackgroundColor(): string;
  38462. set loadingUIBackgroundColor(color: string);
  38463. private _resizeLoadingUI;
  38464. }
  38465. }
  38466. declare module "babylonjs/Misc/customAnimationFrameRequester" {
  38467. /**
  38468. * Interface for any object that can request an animation frame
  38469. */
  38470. export interface ICustomAnimationFrameRequester {
  38471. /**
  38472. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  38473. */
  38474. renderFunction?: Function;
  38475. /**
  38476. * Called to request the next frame to render to
  38477. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  38478. */
  38479. requestAnimationFrame: Function;
  38480. /**
  38481. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  38482. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  38483. */
  38484. requestID?: number;
  38485. }
  38486. }
  38487. declare module "babylonjs/Misc/performanceMonitor" {
  38488. /**
  38489. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  38490. */
  38491. export class PerformanceMonitor {
  38492. private _enabled;
  38493. private _rollingFrameTime;
  38494. private _lastFrameTimeMs;
  38495. /**
  38496. * constructor
  38497. * @param frameSampleSize The number of samples required to saturate the sliding window
  38498. */
  38499. constructor(frameSampleSize?: number);
  38500. /**
  38501. * Samples current frame
  38502. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  38503. */
  38504. sampleFrame(timeMs?: number): void;
  38505. /**
  38506. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38507. */
  38508. get averageFrameTime(): number;
  38509. /**
  38510. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38511. */
  38512. get averageFrameTimeVariance(): number;
  38513. /**
  38514. * Returns the frame time of the most recent frame
  38515. */
  38516. get instantaneousFrameTime(): number;
  38517. /**
  38518. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  38519. */
  38520. get averageFPS(): number;
  38521. /**
  38522. * Returns the average framerate in frames per second using the most recent frame time
  38523. */
  38524. get instantaneousFPS(): number;
  38525. /**
  38526. * Returns true if enough samples have been taken to completely fill the sliding window
  38527. */
  38528. get isSaturated(): boolean;
  38529. /**
  38530. * Enables contributions to the sliding window sample set
  38531. */
  38532. enable(): void;
  38533. /**
  38534. * Disables contributions to the sliding window sample set
  38535. * Samples will not be interpolated over the disabled period
  38536. */
  38537. disable(): void;
  38538. /**
  38539. * Returns true if sampling is enabled
  38540. */
  38541. get isEnabled(): boolean;
  38542. /**
  38543. * Resets performance monitor
  38544. */
  38545. reset(): void;
  38546. }
  38547. /**
  38548. * RollingAverage
  38549. *
  38550. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  38551. */
  38552. export class RollingAverage {
  38553. /**
  38554. * Current average
  38555. */
  38556. average: number;
  38557. /**
  38558. * Current variance
  38559. */
  38560. variance: number;
  38561. protected _samples: Array<number>;
  38562. protected _sampleCount: number;
  38563. protected _pos: number;
  38564. protected _m2: number;
  38565. /**
  38566. * constructor
  38567. * @param length The number of samples required to saturate the sliding window
  38568. */
  38569. constructor(length: number);
  38570. /**
  38571. * Adds a sample to the sample set
  38572. * @param v The sample value
  38573. */
  38574. add(v: number): void;
  38575. /**
  38576. * Returns previously added values or null if outside of history or outside the sliding window domain
  38577. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  38578. * @return Value previously recorded with add() or null if outside of range
  38579. */
  38580. history(i: number): number;
  38581. /**
  38582. * Returns true if enough samples have been taken to completely fill the sliding window
  38583. * @return true if sample-set saturated
  38584. */
  38585. isSaturated(): boolean;
  38586. /**
  38587. * Resets the rolling average (equivalent to 0 samples taken so far)
  38588. */
  38589. reset(): void;
  38590. /**
  38591. * Wraps a value around the sample range boundaries
  38592. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  38593. * @return Wrapped position in sample range
  38594. */
  38595. protected _wrapPosition(i: number): number;
  38596. }
  38597. }
  38598. declare module "babylonjs/Misc/perfCounter" {
  38599. /**
  38600. * This class is used to track a performance counter which is number based.
  38601. * The user has access to many properties which give statistics of different nature.
  38602. *
  38603. * The implementer can track two kinds of Performance Counter: time and count.
  38604. * 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.
  38605. * 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.
  38606. */
  38607. export class PerfCounter {
  38608. /**
  38609. * Gets or sets a global boolean to turn on and off all the counters
  38610. */
  38611. static Enabled: boolean;
  38612. /**
  38613. * Returns the smallest value ever
  38614. */
  38615. get min(): number;
  38616. /**
  38617. * Returns the biggest value ever
  38618. */
  38619. get max(): number;
  38620. /**
  38621. * Returns the average value since the performance counter is running
  38622. */
  38623. get average(): number;
  38624. /**
  38625. * Returns the average value of the last second the counter was monitored
  38626. */
  38627. get lastSecAverage(): number;
  38628. /**
  38629. * Returns the current value
  38630. */
  38631. get current(): number;
  38632. /**
  38633. * Gets the accumulated total
  38634. */
  38635. get total(): number;
  38636. /**
  38637. * Gets the total value count
  38638. */
  38639. get count(): number;
  38640. /**
  38641. * Creates a new counter
  38642. */
  38643. constructor();
  38644. /**
  38645. * Call this method to start monitoring a new frame.
  38646. * 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.
  38647. */
  38648. fetchNewFrame(): void;
  38649. /**
  38650. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  38651. * @param newCount the count value to add to the monitored count
  38652. * @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.
  38653. */
  38654. addCount(newCount: number, fetchResult: boolean): void;
  38655. /**
  38656. * Start monitoring this performance counter
  38657. */
  38658. beginMonitoring(): void;
  38659. /**
  38660. * Compute the time lapsed since the previous beginMonitoring() call.
  38661. * @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
  38662. */
  38663. endMonitoring(newFrame?: boolean): void;
  38664. private _fetchResult;
  38665. private _startMonitoringTime;
  38666. private _min;
  38667. private _max;
  38668. private _average;
  38669. private _current;
  38670. private _totalValueCount;
  38671. private _totalAccumulated;
  38672. private _lastSecAverage;
  38673. private _lastSecAccumulated;
  38674. private _lastSecTime;
  38675. private _lastSecValueCount;
  38676. }
  38677. }
  38678. declare module "babylonjs/Engines/Extensions/engine.readTexture" {
  38679. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38680. import { Nullable } from "babylonjs/types";
  38681. module "babylonjs/Engines/thinEngine" {
  38682. interface ThinEngine {
  38683. /** @hidden */
  38684. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  38685. }
  38686. }
  38687. }
  38688. declare module "babylonjs/Engines/engine" {
  38689. import { Observable } from "babylonjs/Misc/observable";
  38690. import { Nullable } from "babylonjs/types";
  38691. import { Scene } from "babylonjs/scene";
  38692. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38693. import { IAudioEngine } from "babylonjs/Audio/audioEngine";
  38694. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  38695. import { ILoadingScreen } from "babylonjs/Loading/loadingScreen";
  38696. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  38697. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  38698. import { ICustomAnimationFrameRequester } from "babylonjs/Misc/customAnimationFrameRequester";
  38699. import { ThinEngine, EngineOptions } from "babylonjs/Engines/thinEngine";
  38700. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  38701. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  38702. import { PerformanceMonitor } from "babylonjs/Misc/performanceMonitor";
  38703. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  38704. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  38705. import "babylonjs/Engines/Extensions/engine.alpha";
  38706. import "babylonjs/Engines/Extensions/engine.readTexture";
  38707. import "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  38708. import { Material } from "babylonjs/Materials/material";
  38709. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  38710. /**
  38711. * Defines the interface used by display changed events
  38712. */
  38713. export interface IDisplayChangedEventArgs {
  38714. /** Gets the vrDisplay object (if any) */
  38715. vrDisplay: Nullable<any>;
  38716. /** Gets a boolean indicating if webVR is supported */
  38717. vrSupported: boolean;
  38718. }
  38719. /**
  38720. * Defines the interface used by objects containing a viewport (like a camera)
  38721. */
  38722. interface IViewportOwnerLike {
  38723. /**
  38724. * Gets or sets the viewport
  38725. */
  38726. viewport: IViewportLike;
  38727. }
  38728. /**
  38729. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  38730. */
  38731. export class Engine extends ThinEngine {
  38732. /** Defines that alpha blending is disabled */
  38733. static readonly ALPHA_DISABLE: number;
  38734. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  38735. static readonly ALPHA_ADD: number;
  38736. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  38737. static readonly ALPHA_COMBINE: number;
  38738. /** Defines that alpha blending to DEST - SRC * DEST */
  38739. static readonly ALPHA_SUBTRACT: number;
  38740. /** Defines that alpha blending to SRC * DEST */
  38741. static readonly ALPHA_MULTIPLY: number;
  38742. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  38743. static readonly ALPHA_MAXIMIZED: number;
  38744. /** Defines that alpha blending to SRC + DEST */
  38745. static readonly ALPHA_ONEONE: number;
  38746. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  38747. static readonly ALPHA_PREMULTIPLIED: number;
  38748. /**
  38749. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  38750. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  38751. */
  38752. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  38753. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  38754. static readonly ALPHA_INTERPOLATE: number;
  38755. /**
  38756. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  38757. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  38758. */
  38759. static readonly ALPHA_SCREENMODE: number;
  38760. /** Defines that the ressource is not delayed*/
  38761. static readonly DELAYLOADSTATE_NONE: number;
  38762. /** Defines that the ressource was successfully delay loaded */
  38763. static readonly DELAYLOADSTATE_LOADED: number;
  38764. /** Defines that the ressource is currently delay loading */
  38765. static readonly DELAYLOADSTATE_LOADING: number;
  38766. /** Defines that the ressource is delayed and has not started loading */
  38767. static readonly DELAYLOADSTATE_NOTLOADED: number;
  38768. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  38769. static readonly NEVER: number;
  38770. /** 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 */
  38771. static readonly ALWAYS: number;
  38772. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  38773. static readonly LESS: number;
  38774. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  38775. static readonly EQUAL: number;
  38776. /** 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 */
  38777. static readonly LEQUAL: number;
  38778. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  38779. static readonly GREATER: number;
  38780. /** 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 */
  38781. static readonly GEQUAL: number;
  38782. /** 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 */
  38783. static readonly NOTEQUAL: number;
  38784. /** Passed to stencilOperation to specify that stencil value must be kept */
  38785. static readonly KEEP: number;
  38786. /** Passed to stencilOperation to specify that stencil value must be replaced */
  38787. static readonly REPLACE: number;
  38788. /** Passed to stencilOperation to specify that stencil value must be incremented */
  38789. static readonly INCR: number;
  38790. /** Passed to stencilOperation to specify that stencil value must be decremented */
  38791. static readonly DECR: number;
  38792. /** Passed to stencilOperation to specify that stencil value must be inverted */
  38793. static readonly INVERT: number;
  38794. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  38795. static readonly INCR_WRAP: number;
  38796. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  38797. static readonly DECR_WRAP: number;
  38798. /** Texture is not repeating outside of 0..1 UVs */
  38799. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  38800. /** Texture is repeating outside of 0..1 UVs */
  38801. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  38802. /** Texture is repeating and mirrored */
  38803. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  38804. /** ALPHA */
  38805. static readonly TEXTUREFORMAT_ALPHA: number;
  38806. /** LUMINANCE */
  38807. static readonly TEXTUREFORMAT_LUMINANCE: number;
  38808. /** LUMINANCE_ALPHA */
  38809. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  38810. /** RGB */
  38811. static readonly TEXTUREFORMAT_RGB: number;
  38812. /** RGBA */
  38813. static readonly TEXTUREFORMAT_RGBA: number;
  38814. /** RED */
  38815. static readonly TEXTUREFORMAT_RED: number;
  38816. /** RED (2nd reference) */
  38817. static readonly TEXTUREFORMAT_R: number;
  38818. /** RG */
  38819. static readonly TEXTUREFORMAT_RG: number;
  38820. /** RED_INTEGER */
  38821. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  38822. /** RED_INTEGER (2nd reference) */
  38823. static readonly TEXTUREFORMAT_R_INTEGER: number;
  38824. /** RG_INTEGER */
  38825. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  38826. /** RGB_INTEGER */
  38827. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  38828. /** RGBA_INTEGER */
  38829. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  38830. /** UNSIGNED_BYTE */
  38831. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  38832. /** UNSIGNED_BYTE (2nd reference) */
  38833. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  38834. /** FLOAT */
  38835. static readonly TEXTURETYPE_FLOAT: number;
  38836. /** HALF_FLOAT */
  38837. static readonly TEXTURETYPE_HALF_FLOAT: number;
  38838. /** BYTE */
  38839. static readonly TEXTURETYPE_BYTE: number;
  38840. /** SHORT */
  38841. static readonly TEXTURETYPE_SHORT: number;
  38842. /** UNSIGNED_SHORT */
  38843. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  38844. /** INT */
  38845. static readonly TEXTURETYPE_INT: number;
  38846. /** UNSIGNED_INT */
  38847. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  38848. /** UNSIGNED_SHORT_4_4_4_4 */
  38849. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  38850. /** UNSIGNED_SHORT_5_5_5_1 */
  38851. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  38852. /** UNSIGNED_SHORT_5_6_5 */
  38853. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  38854. /** UNSIGNED_INT_2_10_10_10_REV */
  38855. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  38856. /** UNSIGNED_INT_24_8 */
  38857. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  38858. /** UNSIGNED_INT_10F_11F_11F_REV */
  38859. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  38860. /** UNSIGNED_INT_5_9_9_9_REV */
  38861. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  38862. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  38863. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  38864. /** nearest is mag = nearest and min = nearest and mip = linear */
  38865. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  38866. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38867. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  38868. /** Trilinear is mag = linear and min = linear and mip = linear */
  38869. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  38870. /** nearest is mag = nearest and min = nearest and mip = linear */
  38871. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  38872. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38873. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  38874. /** Trilinear is mag = linear and min = linear and mip = linear */
  38875. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  38876. /** mag = nearest and min = nearest and mip = nearest */
  38877. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  38878. /** mag = nearest and min = linear and mip = nearest */
  38879. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  38880. /** mag = nearest and min = linear and mip = linear */
  38881. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  38882. /** mag = nearest and min = linear and mip = none */
  38883. static readonly TEXTURE_NEAREST_LINEAR: number;
  38884. /** mag = nearest and min = nearest and mip = none */
  38885. static readonly TEXTURE_NEAREST_NEAREST: number;
  38886. /** mag = linear and min = nearest and mip = nearest */
  38887. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  38888. /** mag = linear and min = nearest and mip = linear */
  38889. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  38890. /** mag = linear and min = linear and mip = none */
  38891. static readonly TEXTURE_LINEAR_LINEAR: number;
  38892. /** mag = linear and min = nearest and mip = none */
  38893. static readonly TEXTURE_LINEAR_NEAREST: number;
  38894. /** Explicit coordinates mode */
  38895. static readonly TEXTURE_EXPLICIT_MODE: number;
  38896. /** Spherical coordinates mode */
  38897. static readonly TEXTURE_SPHERICAL_MODE: number;
  38898. /** Planar coordinates mode */
  38899. static readonly TEXTURE_PLANAR_MODE: number;
  38900. /** Cubic coordinates mode */
  38901. static readonly TEXTURE_CUBIC_MODE: number;
  38902. /** Projection coordinates mode */
  38903. static readonly TEXTURE_PROJECTION_MODE: number;
  38904. /** Skybox coordinates mode */
  38905. static readonly TEXTURE_SKYBOX_MODE: number;
  38906. /** Inverse Cubic coordinates mode */
  38907. static readonly TEXTURE_INVCUBIC_MODE: number;
  38908. /** Equirectangular coordinates mode */
  38909. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  38910. /** Equirectangular Fixed coordinates mode */
  38911. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  38912. /** Equirectangular Fixed Mirrored coordinates mode */
  38913. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  38914. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  38915. static readonly SCALEMODE_FLOOR: number;
  38916. /** Defines that texture rescaling will look for the nearest power of 2 size */
  38917. static readonly SCALEMODE_NEAREST: number;
  38918. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  38919. static readonly SCALEMODE_CEILING: number;
  38920. /**
  38921. * Returns the current npm package of the sdk
  38922. */
  38923. static get NpmPackage(): string;
  38924. /**
  38925. * Returns the current version of the framework
  38926. */
  38927. static get Version(): string;
  38928. /** Gets the list of created engines */
  38929. static get Instances(): Engine[];
  38930. /**
  38931. * Gets the latest created engine
  38932. */
  38933. static get LastCreatedEngine(): Nullable<Engine>;
  38934. /**
  38935. * Gets the latest created scene
  38936. */
  38937. static get LastCreatedScene(): Nullable<Scene>;
  38938. /**
  38939. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  38940. * @param flag defines which part of the materials must be marked as dirty
  38941. * @param predicate defines a predicate used to filter which materials should be affected
  38942. */
  38943. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  38944. /**
  38945. * Method called to create the default loading screen.
  38946. * This can be overriden in your own app.
  38947. * @param canvas The rendering canvas element
  38948. * @returns The loading screen
  38949. */
  38950. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  38951. /**
  38952. * Method called to create the default rescale post process on each engine.
  38953. */
  38954. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  38955. /**
  38956. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  38957. **/
  38958. enableOfflineSupport: boolean;
  38959. /**
  38960. * 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)
  38961. **/
  38962. disableManifestCheck: boolean;
  38963. /**
  38964. * Gets the list of created scenes
  38965. */
  38966. scenes: Scene[];
  38967. /**
  38968. * Event raised when a new scene is created
  38969. */
  38970. onNewSceneAddedObservable: Observable<Scene>;
  38971. /**
  38972. * Gets the list of created postprocesses
  38973. */
  38974. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  38975. /**
  38976. * Gets a boolean indicating if the pointer is currently locked
  38977. */
  38978. isPointerLock: boolean;
  38979. /**
  38980. * Observable event triggered each time the rendering canvas is resized
  38981. */
  38982. onResizeObservable: Observable<Engine>;
  38983. /**
  38984. * Observable event triggered each time the canvas loses focus
  38985. */
  38986. onCanvasBlurObservable: Observable<Engine>;
  38987. /**
  38988. * Observable event triggered each time the canvas gains focus
  38989. */
  38990. onCanvasFocusObservable: Observable<Engine>;
  38991. /**
  38992. * Observable event triggered each time the canvas receives pointerout event
  38993. */
  38994. onCanvasPointerOutObservable: Observable<PointerEvent>;
  38995. /**
  38996. * Observable raised when the engine begins a new frame
  38997. */
  38998. onBeginFrameObservable: Observable<Engine>;
  38999. /**
  39000. * If set, will be used to request the next animation frame for the render loop
  39001. */
  39002. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  39003. /**
  39004. * Observable raised when the engine ends the current frame
  39005. */
  39006. onEndFrameObservable: Observable<Engine>;
  39007. /**
  39008. * Observable raised when the engine is about to compile a shader
  39009. */
  39010. onBeforeShaderCompilationObservable: Observable<Engine>;
  39011. /**
  39012. * Observable raised when the engine has jsut compiled a shader
  39013. */
  39014. onAfterShaderCompilationObservable: Observable<Engine>;
  39015. /**
  39016. * Gets the audio engine
  39017. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  39018. * @ignorenaming
  39019. */
  39020. static audioEngine: IAudioEngine;
  39021. /**
  39022. * Default AudioEngine factory responsible of creating the Audio Engine.
  39023. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  39024. */
  39025. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  39026. /**
  39027. * Default offline support factory responsible of creating a tool used to store data locally.
  39028. * By default, this will create a Database object if the workload has been embedded.
  39029. */
  39030. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  39031. private _loadingScreen;
  39032. private _pointerLockRequested;
  39033. private _rescalePostProcess;
  39034. private _deterministicLockstep;
  39035. private _lockstepMaxSteps;
  39036. private _timeStep;
  39037. protected get _supportsHardwareTextureRescaling(): boolean;
  39038. private _fps;
  39039. private _deltaTime;
  39040. /** @hidden */
  39041. _drawCalls: PerfCounter;
  39042. /** 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 */
  39043. canvasTabIndex: number;
  39044. /**
  39045. * Turn this value on if you want to pause FPS computation when in background
  39046. */
  39047. disablePerformanceMonitorInBackground: boolean;
  39048. private _performanceMonitor;
  39049. /**
  39050. * Gets the performance monitor attached to this engine
  39051. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  39052. */
  39053. get performanceMonitor(): PerformanceMonitor;
  39054. private _onFocus;
  39055. private _onBlur;
  39056. private _onCanvasPointerOut;
  39057. private _onCanvasBlur;
  39058. private _onCanvasFocus;
  39059. private _onFullscreenChange;
  39060. private _onPointerLockChange;
  39061. /**
  39062. * Gets the HTML element used to attach event listeners
  39063. * @returns a HTML element
  39064. */
  39065. getInputElement(): Nullable<HTMLElement>;
  39066. /**
  39067. * Creates a new engine
  39068. * @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
  39069. * @param antialias defines enable antialiasing (default: false)
  39070. * @param options defines further options to be sent to the getContext() function
  39071. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  39072. */
  39073. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  39074. /**
  39075. * Gets current aspect ratio
  39076. * @param viewportOwner defines the camera to use to get the aspect ratio
  39077. * @param useScreen defines if screen size must be used (or the current render target if any)
  39078. * @returns a number defining the aspect ratio
  39079. */
  39080. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  39081. /**
  39082. * Gets current screen aspect ratio
  39083. * @returns a number defining the aspect ratio
  39084. */
  39085. getScreenAspectRatio(): number;
  39086. /**
  39087. * Gets the client rect of the HTML canvas attached with the current webGL context
  39088. * @returns a client rectanglee
  39089. */
  39090. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  39091. /**
  39092. * Gets the client rect of the HTML element used for events
  39093. * @returns a client rectanglee
  39094. */
  39095. getInputElementClientRect(): Nullable<ClientRect>;
  39096. /**
  39097. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  39098. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  39099. * @returns true if engine is in deterministic lock step mode
  39100. */
  39101. isDeterministicLockStep(): boolean;
  39102. /**
  39103. * Gets the max steps when engine is running in deterministic lock step
  39104. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  39105. * @returns the max steps
  39106. */
  39107. getLockstepMaxSteps(): number;
  39108. /**
  39109. * Returns the time in ms between steps when using deterministic lock step.
  39110. * @returns time step in (ms)
  39111. */
  39112. getTimeStep(): number;
  39113. /**
  39114. * Force the mipmap generation for the given render target texture
  39115. * @param texture defines the render target texture to use
  39116. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  39117. */
  39118. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  39119. /** States */
  39120. /**
  39121. * Set various states to the webGL context
  39122. * @param culling defines backface culling state
  39123. * @param zOffset defines the value to apply to zOffset (0 by default)
  39124. * @param force defines if states must be applied even if cache is up to date
  39125. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  39126. */
  39127. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  39128. /**
  39129. * Set the z offset to apply to current rendering
  39130. * @param value defines the offset to apply
  39131. */
  39132. setZOffset(value: number): void;
  39133. /**
  39134. * Gets the current value of the zOffset
  39135. * @returns the current zOffset state
  39136. */
  39137. getZOffset(): number;
  39138. /**
  39139. * Enable or disable depth buffering
  39140. * @param enable defines the state to set
  39141. */
  39142. setDepthBuffer(enable: boolean): void;
  39143. /**
  39144. * Gets a boolean indicating if depth writing is enabled
  39145. * @returns the current depth writing state
  39146. */
  39147. getDepthWrite(): boolean;
  39148. /**
  39149. * Enable or disable depth writing
  39150. * @param enable defines the state to set
  39151. */
  39152. setDepthWrite(enable: boolean): void;
  39153. /**
  39154. * Gets a boolean indicating if stencil buffer is enabled
  39155. * @returns the current stencil buffer state
  39156. */
  39157. getStencilBuffer(): boolean;
  39158. /**
  39159. * Enable or disable the stencil buffer
  39160. * @param enable defines if the stencil buffer must be enabled or disabled
  39161. */
  39162. setStencilBuffer(enable: boolean): void;
  39163. /**
  39164. * Gets the current stencil mask
  39165. * @returns a number defining the new stencil mask to use
  39166. */
  39167. getStencilMask(): number;
  39168. /**
  39169. * Sets the current stencil mask
  39170. * @param mask defines the new stencil mask to use
  39171. */
  39172. setStencilMask(mask: number): void;
  39173. /**
  39174. * Gets the current stencil function
  39175. * @returns a number defining the stencil function to use
  39176. */
  39177. getStencilFunction(): number;
  39178. /**
  39179. * Gets the current stencil reference value
  39180. * @returns a number defining the stencil reference value to use
  39181. */
  39182. getStencilFunctionReference(): number;
  39183. /**
  39184. * Gets the current stencil mask
  39185. * @returns a number defining the stencil mask to use
  39186. */
  39187. getStencilFunctionMask(): number;
  39188. /**
  39189. * Sets the current stencil function
  39190. * @param stencilFunc defines the new stencil function to use
  39191. */
  39192. setStencilFunction(stencilFunc: number): void;
  39193. /**
  39194. * Sets the current stencil reference
  39195. * @param reference defines the new stencil reference to use
  39196. */
  39197. setStencilFunctionReference(reference: number): void;
  39198. /**
  39199. * Sets the current stencil mask
  39200. * @param mask defines the new stencil mask to use
  39201. */
  39202. setStencilFunctionMask(mask: number): void;
  39203. /**
  39204. * Gets the current stencil operation when stencil fails
  39205. * @returns a number defining stencil operation to use when stencil fails
  39206. */
  39207. getStencilOperationFail(): number;
  39208. /**
  39209. * Gets the current stencil operation when depth fails
  39210. * @returns a number defining stencil operation to use when depth fails
  39211. */
  39212. getStencilOperationDepthFail(): number;
  39213. /**
  39214. * Gets the current stencil operation when stencil passes
  39215. * @returns a number defining stencil operation to use when stencil passes
  39216. */
  39217. getStencilOperationPass(): number;
  39218. /**
  39219. * Sets the stencil operation to use when stencil fails
  39220. * @param operation defines the stencil operation to use when stencil fails
  39221. */
  39222. setStencilOperationFail(operation: number): void;
  39223. /**
  39224. * Sets the stencil operation to use when depth fails
  39225. * @param operation defines the stencil operation to use when depth fails
  39226. */
  39227. setStencilOperationDepthFail(operation: number): void;
  39228. /**
  39229. * Sets the stencil operation to use when stencil passes
  39230. * @param operation defines the stencil operation to use when stencil passes
  39231. */
  39232. setStencilOperationPass(operation: number): void;
  39233. /**
  39234. * Sets a boolean indicating if the dithering state is enabled or disabled
  39235. * @param value defines the dithering state
  39236. */
  39237. setDitheringState(value: boolean): void;
  39238. /**
  39239. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  39240. * @param value defines the rasterizer state
  39241. */
  39242. setRasterizerState(value: boolean): void;
  39243. /**
  39244. * Gets the current depth function
  39245. * @returns a number defining the depth function
  39246. */
  39247. getDepthFunction(): Nullable<number>;
  39248. /**
  39249. * Sets the current depth function
  39250. * @param depthFunc defines the function to use
  39251. */
  39252. setDepthFunction(depthFunc: number): void;
  39253. /**
  39254. * Sets the current depth function to GREATER
  39255. */
  39256. setDepthFunctionToGreater(): void;
  39257. /**
  39258. * Sets the current depth function to GEQUAL
  39259. */
  39260. setDepthFunctionToGreaterOrEqual(): void;
  39261. /**
  39262. * Sets the current depth function to LESS
  39263. */
  39264. setDepthFunctionToLess(): void;
  39265. /**
  39266. * Sets the current depth function to LEQUAL
  39267. */
  39268. setDepthFunctionToLessOrEqual(): void;
  39269. private _cachedStencilBuffer;
  39270. private _cachedStencilFunction;
  39271. private _cachedStencilMask;
  39272. private _cachedStencilOperationPass;
  39273. private _cachedStencilOperationFail;
  39274. private _cachedStencilOperationDepthFail;
  39275. private _cachedStencilReference;
  39276. /**
  39277. * Caches the the state of the stencil buffer
  39278. */
  39279. cacheStencilState(): void;
  39280. /**
  39281. * Restores the state of the stencil buffer
  39282. */
  39283. restoreStencilState(): void;
  39284. /**
  39285. * Directly set the WebGL Viewport
  39286. * @param x defines the x coordinate of the viewport (in screen space)
  39287. * @param y defines the y coordinate of the viewport (in screen space)
  39288. * @param width defines the width of the viewport (in screen space)
  39289. * @param height defines the height of the viewport (in screen space)
  39290. * @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
  39291. */
  39292. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  39293. /**
  39294. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  39295. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  39296. * @param y defines the y-coordinate of the corner of the clear rectangle
  39297. * @param width defines the width of the clear rectangle
  39298. * @param height defines the height of the clear rectangle
  39299. * @param clearColor defines the clear color
  39300. */
  39301. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  39302. /**
  39303. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  39304. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  39305. * @param y defines the y-coordinate of the corner of the clear rectangle
  39306. * @param width defines the width of the clear rectangle
  39307. * @param height defines the height of the clear rectangle
  39308. */
  39309. enableScissor(x: number, y: number, width: number, height: number): void;
  39310. /**
  39311. * Disable previously set scissor test rectangle
  39312. */
  39313. disableScissor(): void;
  39314. protected _reportDrawCall(): void;
  39315. /**
  39316. * Initializes a webVR display and starts listening to display change events
  39317. * The onVRDisplayChangedObservable will be notified upon these changes
  39318. * @returns The onVRDisplayChangedObservable
  39319. */
  39320. initWebVR(): Observable<IDisplayChangedEventArgs>;
  39321. /** @hidden */
  39322. _prepareVRComponent(): void;
  39323. /** @hidden */
  39324. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  39325. /** @hidden */
  39326. _submitVRFrame(): void;
  39327. /**
  39328. * Call this function to leave webVR mode
  39329. * Will do nothing if webVR is not supported or if there is no webVR device
  39330. * @see https://doc.babylonjs.com/how_to/webvr_camera
  39331. */
  39332. disableVR(): void;
  39333. /**
  39334. * Gets a boolean indicating that the system is in VR mode and is presenting
  39335. * @returns true if VR mode is engaged
  39336. */
  39337. isVRPresenting(): boolean;
  39338. /** @hidden */
  39339. _requestVRFrame(): void;
  39340. /** @hidden */
  39341. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  39342. /**
  39343. * Gets the source code of the vertex shader associated with a specific webGL program
  39344. * @param program defines the program to use
  39345. * @returns a string containing the source code of the vertex shader associated with the program
  39346. */
  39347. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  39348. /**
  39349. * Gets the source code of the fragment shader associated with a specific webGL program
  39350. * @param program defines the program to use
  39351. * @returns a string containing the source code of the fragment shader associated with the program
  39352. */
  39353. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  39354. /**
  39355. * Sets a depth stencil texture from a render target to the according uniform.
  39356. * @param channel The texture channel
  39357. * @param uniform The uniform to set
  39358. * @param texture The render target texture containing the depth stencil texture to apply
  39359. */
  39360. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  39361. /**
  39362. * Sets a texture to the webGL context from a postprocess
  39363. * @param channel defines the channel to use
  39364. * @param postProcess defines the source postprocess
  39365. */
  39366. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  39367. /**
  39368. * Binds the output of the passed in post process to the texture channel specified
  39369. * @param channel The channel the texture should be bound to
  39370. * @param postProcess The post process which's output should be bound
  39371. */
  39372. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  39373. protected _rebuildBuffers(): void;
  39374. /** @hidden */
  39375. _renderFrame(): void;
  39376. _renderLoop(): void;
  39377. /** @hidden */
  39378. _renderViews(): boolean;
  39379. /**
  39380. * Toggle full screen mode
  39381. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39382. */
  39383. switchFullscreen(requestPointerLock: boolean): void;
  39384. /**
  39385. * Enters full screen mode
  39386. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39387. */
  39388. enterFullscreen(requestPointerLock: boolean): void;
  39389. /**
  39390. * Exits full screen mode
  39391. */
  39392. exitFullscreen(): void;
  39393. /**
  39394. * Enters Pointerlock mode
  39395. */
  39396. enterPointerlock(): void;
  39397. /**
  39398. * Exits Pointerlock mode
  39399. */
  39400. exitPointerlock(): void;
  39401. /**
  39402. * Begin a new frame
  39403. */
  39404. beginFrame(): void;
  39405. /**
  39406. * Enf the current frame
  39407. */
  39408. endFrame(): void;
  39409. resize(): void;
  39410. /**
  39411. * Force a specific size of the canvas
  39412. * @param width defines the new canvas' width
  39413. * @param height defines the new canvas' height
  39414. * @returns true if the size was changed
  39415. */
  39416. setSize(width: number, height: number): boolean;
  39417. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  39418. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39419. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39420. _releaseTexture(texture: InternalTexture): void;
  39421. /**
  39422. * @hidden
  39423. * Rescales a texture
  39424. * @param source input texutre
  39425. * @param destination destination texture
  39426. * @param scene scene to use to render the resize
  39427. * @param internalFormat format to use when resizing
  39428. * @param onComplete callback to be called when resize has completed
  39429. */
  39430. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  39431. /**
  39432. * Gets the current framerate
  39433. * @returns a number representing the framerate
  39434. */
  39435. getFps(): number;
  39436. /**
  39437. * Gets the time spent between current and previous frame
  39438. * @returns a number representing the delta time in ms
  39439. */
  39440. getDeltaTime(): number;
  39441. private _measureFps;
  39442. /** @hidden */
  39443. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  39444. /**
  39445. * Updates the sample count of a render target texture
  39446. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  39447. * @param texture defines the texture to update
  39448. * @param samples defines the sample count to set
  39449. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  39450. */
  39451. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  39452. /**
  39453. * Updates a depth texture Comparison Mode and Function.
  39454. * If the comparison Function is equal to 0, the mode will be set to none.
  39455. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  39456. * @param texture The texture to set the comparison function for
  39457. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  39458. */
  39459. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  39460. /**
  39461. * Creates a webGL buffer to use with instanciation
  39462. * @param capacity defines the size of the buffer
  39463. * @returns the webGL buffer
  39464. */
  39465. createInstancesBuffer(capacity: number): DataBuffer;
  39466. /**
  39467. * Delete a webGL buffer used with instanciation
  39468. * @param buffer defines the webGL buffer to delete
  39469. */
  39470. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  39471. private _clientWaitAsync;
  39472. /** @hidden */
  39473. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  39474. dispose(): void;
  39475. private _disableTouchAction;
  39476. /**
  39477. * Display the loading screen
  39478. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39479. */
  39480. displayLoadingUI(): void;
  39481. /**
  39482. * Hide the loading screen
  39483. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39484. */
  39485. hideLoadingUI(): void;
  39486. /**
  39487. * Gets the current loading screen object
  39488. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39489. */
  39490. get loadingScreen(): ILoadingScreen;
  39491. /**
  39492. * Sets the current loading screen object
  39493. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39494. */
  39495. set loadingScreen(loadingScreen: ILoadingScreen);
  39496. /**
  39497. * Sets the current loading screen text
  39498. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39499. */
  39500. set loadingUIText(text: string);
  39501. /**
  39502. * Sets the current loading screen background color
  39503. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39504. */
  39505. set loadingUIBackgroundColor(color: string);
  39506. /** Pointerlock and fullscreen */
  39507. /**
  39508. * Ask the browser to promote the current element to pointerlock mode
  39509. * @param element defines the DOM element to promote
  39510. */
  39511. static _RequestPointerlock(element: HTMLElement): void;
  39512. /**
  39513. * Asks the browser to exit pointerlock mode
  39514. */
  39515. static _ExitPointerlock(): void;
  39516. /**
  39517. * Ask the browser to promote the current element to fullscreen rendering mode
  39518. * @param element defines the DOM element to promote
  39519. */
  39520. static _RequestFullscreen(element: HTMLElement): void;
  39521. /**
  39522. * Asks the browser to exit fullscreen mode
  39523. */
  39524. static _ExitFullscreen(): void;
  39525. }
  39526. }
  39527. declare module "babylonjs/Engines/engineStore" {
  39528. import { Nullable } from "babylonjs/types";
  39529. import { Engine } from "babylonjs/Engines/engine";
  39530. import { Scene } from "babylonjs/scene";
  39531. /**
  39532. * The engine store class is responsible to hold all the instances of Engine and Scene created
  39533. * during the life time of the application.
  39534. */
  39535. export class EngineStore {
  39536. /** Gets the list of created engines */
  39537. static Instances: import("babylonjs/Engines/engine").Engine[];
  39538. /** @hidden */
  39539. static _LastCreatedScene: Nullable<Scene>;
  39540. /**
  39541. * Gets the latest created engine
  39542. */
  39543. static get LastCreatedEngine(): Nullable<Engine>;
  39544. /**
  39545. * Gets the latest created scene
  39546. */
  39547. static get LastCreatedScene(): Nullable<Scene>;
  39548. /**
  39549. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39550. * @ignorenaming
  39551. */
  39552. static UseFallbackTexture: boolean;
  39553. /**
  39554. * Texture content used if a texture cannot loaded
  39555. * @ignorenaming
  39556. */
  39557. static FallbackTexture: string;
  39558. }
  39559. }
  39560. declare module "babylonjs/Misc/promise" {
  39561. /**
  39562. * Helper class that provides a small promise polyfill
  39563. */
  39564. export class PromisePolyfill {
  39565. /**
  39566. * Static function used to check if the polyfill is required
  39567. * If this is the case then the function will inject the polyfill to window.Promise
  39568. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  39569. */
  39570. static Apply(force?: boolean): void;
  39571. }
  39572. }
  39573. declare module "babylonjs/Misc/interfaces/screenshotSize" {
  39574. /**
  39575. * Interface for screenshot methods with describe argument called `size` as object with options
  39576. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  39577. */
  39578. export interface IScreenshotSize {
  39579. /**
  39580. * number in pixels for canvas height
  39581. */
  39582. height?: number;
  39583. /**
  39584. * multiplier allowing render at a higher or lower resolution
  39585. * If value is defined then height and width will be ignored and taken from camera
  39586. */
  39587. precision?: number;
  39588. /**
  39589. * number in pixels for canvas width
  39590. */
  39591. width?: number;
  39592. }
  39593. }
  39594. declare module "babylonjs/Misc/tools" {
  39595. import { Nullable, float } from "babylonjs/types";
  39596. import { DomManagement } from "babylonjs/Misc/domManagement";
  39597. import { WebRequest } from "babylonjs/Misc/webRequest";
  39598. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  39599. import { ReadFileError } from "babylonjs/Misc/fileTools";
  39600. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  39601. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  39602. import { Camera } from "babylonjs/Cameras/camera";
  39603. import { Engine } from "babylonjs/Engines/engine";
  39604. interface IColor4Like {
  39605. r: float;
  39606. g: float;
  39607. b: float;
  39608. a: float;
  39609. }
  39610. /**
  39611. * Class containing a set of static utilities functions
  39612. */
  39613. export class Tools {
  39614. /**
  39615. * Gets or sets the base URL to use to load assets
  39616. */
  39617. static get BaseUrl(): string;
  39618. static set BaseUrl(value: string);
  39619. /**
  39620. * Enable/Disable Custom HTTP Request Headers globally.
  39621. * default = false
  39622. * @see CustomRequestHeaders
  39623. */
  39624. static UseCustomRequestHeaders: boolean;
  39625. /**
  39626. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  39627. * i.e. when loading files, where the server/service expects an Authorization header
  39628. */
  39629. static CustomRequestHeaders: {
  39630. [key: string]: string;
  39631. };
  39632. /**
  39633. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  39634. */
  39635. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  39636. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  39637. /**
  39638. * Default behaviour for cors in the application.
  39639. * It can be a string if the expected behavior is identical in the entire app.
  39640. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  39641. */
  39642. static get CorsBehavior(): string | ((url: string | string[]) => string);
  39643. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  39644. /**
  39645. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39646. * @ignorenaming
  39647. */
  39648. static get UseFallbackTexture(): boolean;
  39649. static set UseFallbackTexture(value: boolean);
  39650. /**
  39651. * Use this object to register external classes like custom textures or material
  39652. * to allow the laoders to instantiate them
  39653. */
  39654. static get RegisteredExternalClasses(): {
  39655. [key: string]: Object;
  39656. };
  39657. static set RegisteredExternalClasses(classes: {
  39658. [key: string]: Object;
  39659. });
  39660. /**
  39661. * Texture content used if a texture cannot loaded
  39662. * @ignorenaming
  39663. */
  39664. static get fallbackTexture(): string;
  39665. static set fallbackTexture(value: string);
  39666. /**
  39667. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  39668. * @param u defines the coordinate on X axis
  39669. * @param v defines the coordinate on Y axis
  39670. * @param width defines the width of the source data
  39671. * @param height defines the height of the source data
  39672. * @param pixels defines the source byte array
  39673. * @param color defines the output color
  39674. */
  39675. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  39676. /**
  39677. * Interpolates between a and b via alpha
  39678. * @param a The lower value (returned when alpha = 0)
  39679. * @param b The upper value (returned when alpha = 1)
  39680. * @param alpha The interpolation-factor
  39681. * @return The mixed value
  39682. */
  39683. static Mix(a: number, b: number, alpha: number): number;
  39684. /**
  39685. * Tries to instantiate a new object from a given class name
  39686. * @param className defines the class name to instantiate
  39687. * @returns the new object or null if the system was not able to do the instantiation
  39688. */
  39689. static Instantiate(className: string): any;
  39690. /**
  39691. * Provides a slice function that will work even on IE
  39692. * @param data defines the array to slice
  39693. * @param start defines the start of the data (optional)
  39694. * @param end defines the end of the data (optional)
  39695. * @returns the new sliced array
  39696. */
  39697. static Slice<T>(data: T, start?: number, end?: number): T;
  39698. /**
  39699. * Polyfill for setImmediate
  39700. * @param action defines the action to execute after the current execution block
  39701. */
  39702. static SetImmediate(action: () => void): void;
  39703. /**
  39704. * Function indicating if a number is an exponent of 2
  39705. * @param value defines the value to test
  39706. * @returns true if the value is an exponent of 2
  39707. */
  39708. static IsExponentOfTwo(value: number): boolean;
  39709. private static _tmpFloatArray;
  39710. /**
  39711. * Returns the nearest 32-bit single precision float representation of a Number
  39712. * @param value A Number. If the parameter is of a different type, it will get converted
  39713. * to a number or to NaN if it cannot be converted
  39714. * @returns number
  39715. */
  39716. static FloatRound(value: number): number;
  39717. /**
  39718. * Extracts the filename from a path
  39719. * @param path defines the path to use
  39720. * @returns the filename
  39721. */
  39722. static GetFilename(path: string): string;
  39723. /**
  39724. * Extracts the "folder" part of a path (everything before the filename).
  39725. * @param uri The URI to extract the info from
  39726. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  39727. * @returns The "folder" part of the path
  39728. */
  39729. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  39730. /**
  39731. * Extracts text content from a DOM element hierarchy
  39732. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  39733. */
  39734. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  39735. /**
  39736. * Convert an angle in radians to degrees
  39737. * @param angle defines the angle to convert
  39738. * @returns the angle in degrees
  39739. */
  39740. static ToDegrees(angle: number): number;
  39741. /**
  39742. * Convert an angle in degrees to radians
  39743. * @param angle defines the angle to convert
  39744. * @returns the angle in radians
  39745. */
  39746. static ToRadians(angle: number): number;
  39747. /**
  39748. * Returns an array if obj is not an array
  39749. * @param obj defines the object to evaluate as an array
  39750. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  39751. * @returns either obj directly if obj is an array or a new array containing obj
  39752. */
  39753. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  39754. /**
  39755. * Gets the pointer prefix to use
  39756. * @param engine defines the engine we are finding the prefix for
  39757. * @returns "pointer" if touch is enabled. Else returns "mouse"
  39758. */
  39759. static GetPointerPrefix(engine: Engine): string;
  39760. /**
  39761. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  39762. * @param url define the url we are trying
  39763. * @param element define the dom element where to configure the cors policy
  39764. */
  39765. static SetCorsBehavior(url: string | string[], element: {
  39766. crossOrigin: string | null;
  39767. }): void;
  39768. /**
  39769. * Removes unwanted characters from an url
  39770. * @param url defines the url to clean
  39771. * @returns the cleaned url
  39772. */
  39773. static CleanUrl(url: string): string;
  39774. /**
  39775. * Gets or sets a function used to pre-process url before using them to load assets
  39776. */
  39777. static get PreprocessUrl(): (url: string) => string;
  39778. static set PreprocessUrl(processor: (url: string) => string);
  39779. /**
  39780. * Loads an image as an HTMLImageElement.
  39781. * @param input url string, ArrayBuffer, or Blob to load
  39782. * @param onLoad callback called when the image successfully loads
  39783. * @param onError callback called when the image fails to load
  39784. * @param offlineProvider offline provider for caching
  39785. * @param mimeType optional mime type
  39786. * @returns the HTMLImageElement of the loaded image
  39787. */
  39788. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  39789. /**
  39790. * Loads a file from a url
  39791. * @param url url string, ArrayBuffer, or Blob to load
  39792. * @param onSuccess callback called when the file successfully loads
  39793. * @param onProgress callback called while file is loading (if the server supports this mode)
  39794. * @param offlineProvider defines the offline provider for caching
  39795. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39796. * @param onError callback called when the file fails to load
  39797. * @returns a file request object
  39798. */
  39799. 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;
  39800. /**
  39801. * Loads a file from a url
  39802. * @param url the file url to load
  39803. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39804. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  39805. */
  39806. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  39807. /**
  39808. * Load a script (identified by an url). When the url returns, the
  39809. * content of this file is added into a new script element, attached to the DOM (body element)
  39810. * @param scriptUrl defines the url of the script to laod
  39811. * @param onSuccess defines the callback called when the script is loaded
  39812. * @param onError defines the callback to call if an error occurs
  39813. * @param scriptId defines the id of the script element
  39814. */
  39815. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  39816. /**
  39817. * Load an asynchronous script (identified by an url). When the url returns, the
  39818. * content of this file is added into a new script element, attached to the DOM (body element)
  39819. * @param scriptUrl defines the url of the script to laod
  39820. * @param scriptId defines the id of the script element
  39821. * @returns a promise request object
  39822. */
  39823. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  39824. /**
  39825. * Loads a file from a blob
  39826. * @param fileToLoad defines the blob to use
  39827. * @param callback defines the callback to call when data is loaded
  39828. * @param progressCallback defines the callback to call during loading process
  39829. * @returns a file request object
  39830. */
  39831. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  39832. /**
  39833. * Reads a file from a File object
  39834. * @param file defines the file to load
  39835. * @param onSuccess defines the callback to call when data is loaded
  39836. * @param onProgress defines the callback to call during loading process
  39837. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  39838. * @param onError defines the callback to call when an error occurs
  39839. * @returns a file request object
  39840. */
  39841. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  39842. /**
  39843. * Creates a data url from a given string content
  39844. * @param content defines the content to convert
  39845. * @returns the new data url link
  39846. */
  39847. static FileAsURL(content: string): string;
  39848. /**
  39849. * Format the given number to a specific decimal format
  39850. * @param value defines the number to format
  39851. * @param decimals defines the number of decimals to use
  39852. * @returns the formatted string
  39853. */
  39854. static Format(value: number, decimals?: number): string;
  39855. /**
  39856. * Tries to copy an object by duplicating every property
  39857. * @param source defines the source object
  39858. * @param destination defines the target object
  39859. * @param doNotCopyList defines a list of properties to avoid
  39860. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  39861. */
  39862. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  39863. /**
  39864. * Gets a boolean indicating if the given object has no own property
  39865. * @param obj defines the object to test
  39866. * @returns true if object has no own property
  39867. */
  39868. static IsEmpty(obj: any): boolean;
  39869. /**
  39870. * Function used to register events at window level
  39871. * @param windowElement defines the Window object to use
  39872. * @param events defines the events to register
  39873. */
  39874. static RegisterTopRootEvents(windowElement: Window, events: {
  39875. name: string;
  39876. handler: Nullable<(e: FocusEvent) => any>;
  39877. }[]): void;
  39878. /**
  39879. * Function used to unregister events from window level
  39880. * @param windowElement defines the Window object to use
  39881. * @param events defines the events to unregister
  39882. */
  39883. static UnregisterTopRootEvents(windowElement: Window, events: {
  39884. name: string;
  39885. handler: Nullable<(e: FocusEvent) => any>;
  39886. }[]): void;
  39887. /**
  39888. * @ignore
  39889. */
  39890. static _ScreenshotCanvas: HTMLCanvasElement;
  39891. /**
  39892. * Dumps the current bound framebuffer
  39893. * @param width defines the rendering width
  39894. * @param height defines the rendering height
  39895. * @param engine defines the hosting engine
  39896. * @param successCallback defines the callback triggered once the data are available
  39897. * @param mimeType defines the mime type of the result
  39898. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  39899. */
  39900. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39901. /**
  39902. * Converts the canvas data to blob.
  39903. * This acts as a polyfill for browsers not supporting the to blob function.
  39904. * @param canvas Defines the canvas to extract the data from
  39905. * @param successCallback Defines the callback triggered once the data are available
  39906. * @param mimeType Defines the mime type of the result
  39907. */
  39908. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  39909. /**
  39910. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  39911. * @param successCallback defines the callback triggered once the data are available
  39912. * @param mimeType defines the mime type of the result
  39913. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  39914. */
  39915. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39916. /**
  39917. * Downloads a blob in the browser
  39918. * @param blob defines the blob to download
  39919. * @param fileName defines the name of the downloaded file
  39920. */
  39921. static Download(blob: Blob, fileName: string): void;
  39922. /**
  39923. * Captures a screenshot of the current rendering
  39924. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39925. * @param engine defines the rendering engine
  39926. * @param camera defines the source camera
  39927. * @param size This parameter can be set to a single number or to an object with the
  39928. * following (optional) properties: precision, width, height. If a single number is passed,
  39929. * it will be used for both width and height. If an object is passed, the screenshot size
  39930. * will be derived from the parameters. The precision property is a multiplier allowing
  39931. * rendering at a higher or lower resolution
  39932. * @param successCallback defines the callback receives a single parameter which contains the
  39933. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39934. * src parameter of an <img> to display it
  39935. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39936. * Check your browser for supported MIME types
  39937. */
  39938. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  39939. /**
  39940. * Captures a screenshot of the current rendering
  39941. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39942. * @param engine defines the rendering engine
  39943. * @param camera defines the source camera
  39944. * @param size This parameter can be set to a single number or to an object with the
  39945. * following (optional) properties: precision, width, height. If a single number is passed,
  39946. * it will be used for both width and height. If an object is passed, the screenshot size
  39947. * will be derived from the parameters. The precision property is a multiplier allowing
  39948. * rendering at a higher or lower resolution
  39949. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39950. * Check your browser for supported MIME types
  39951. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39952. * to the src parameter of an <img> to display it
  39953. */
  39954. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  39955. /**
  39956. * Generates an image screenshot from the specified camera.
  39957. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39958. * @param engine The engine to use for rendering
  39959. * @param camera The camera to use for rendering
  39960. * @param size This parameter can be set to a single number or to an object with the
  39961. * following (optional) properties: precision, width, height. If a single number is passed,
  39962. * it will be used for both width and height. If an object is passed, the screenshot size
  39963. * will be derived from the parameters. The precision property is a multiplier allowing
  39964. * rendering at a higher or lower resolution
  39965. * @param successCallback The callback receives a single parameter which contains the
  39966. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39967. * src parameter of an <img> to display it
  39968. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39969. * Check your browser for supported MIME types
  39970. * @param samples Texture samples (default: 1)
  39971. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39972. * @param fileName A name for for the downloaded file.
  39973. */
  39974. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  39975. /**
  39976. * Generates an image screenshot from the specified camera.
  39977. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39978. * @param engine The engine to use for rendering
  39979. * @param camera The camera to use for rendering
  39980. * @param size This parameter can be set to a single number or to an object with the
  39981. * following (optional) properties: precision, width, height. If a single number is passed,
  39982. * it will be used for both width and height. If an object is passed, the screenshot size
  39983. * will be derived from the parameters. The precision property is a multiplier allowing
  39984. * rendering at a higher or lower resolution
  39985. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39986. * Check your browser for supported MIME types
  39987. * @param samples Texture samples (default: 1)
  39988. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39989. * @param fileName A name for for the downloaded file.
  39990. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39991. * to the src parameter of an <img> to display it
  39992. */
  39993. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  39994. /**
  39995. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  39996. * Be aware Math.random() could cause collisions, but:
  39997. * "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"
  39998. * @returns a pseudo random id
  39999. */
  40000. static RandomId(): string;
  40001. /**
  40002. * Test if the given uri is a base64 string
  40003. * @param uri The uri to test
  40004. * @return True if the uri is a base64 string or false otherwise
  40005. */
  40006. static IsBase64(uri: string): boolean;
  40007. /**
  40008. * Decode the given base64 uri.
  40009. * @param uri The uri to decode
  40010. * @return The decoded base64 data.
  40011. */
  40012. static DecodeBase64(uri: string): ArrayBuffer;
  40013. /**
  40014. * Gets the absolute url.
  40015. * @param url the input url
  40016. * @return the absolute url
  40017. */
  40018. static GetAbsoluteUrl(url: string): string;
  40019. /**
  40020. * No log
  40021. */
  40022. static readonly NoneLogLevel: number;
  40023. /**
  40024. * Only message logs
  40025. */
  40026. static readonly MessageLogLevel: number;
  40027. /**
  40028. * Only warning logs
  40029. */
  40030. static readonly WarningLogLevel: number;
  40031. /**
  40032. * Only error logs
  40033. */
  40034. static readonly ErrorLogLevel: number;
  40035. /**
  40036. * All logs
  40037. */
  40038. static readonly AllLogLevel: number;
  40039. /**
  40040. * Gets a value indicating the number of loading errors
  40041. * @ignorenaming
  40042. */
  40043. static get errorsCount(): number;
  40044. /**
  40045. * Callback called when a new log is added
  40046. */
  40047. static OnNewCacheEntry: (entry: string) => void;
  40048. /**
  40049. * Log a message to the console
  40050. * @param message defines the message to log
  40051. */
  40052. static Log(message: string): void;
  40053. /**
  40054. * Write a warning message to the console
  40055. * @param message defines the message to log
  40056. */
  40057. static Warn(message: string): void;
  40058. /**
  40059. * Write an error message to the console
  40060. * @param message defines the message to log
  40061. */
  40062. static Error(message: string): void;
  40063. /**
  40064. * Gets current log cache (list of logs)
  40065. */
  40066. static get LogCache(): string;
  40067. /**
  40068. * Clears the log cache
  40069. */
  40070. static ClearLogCache(): void;
  40071. /**
  40072. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  40073. */
  40074. static set LogLevels(level: number);
  40075. /**
  40076. * Checks if the window object exists
  40077. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  40078. */
  40079. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  40080. /**
  40081. * No performance log
  40082. */
  40083. static readonly PerformanceNoneLogLevel: number;
  40084. /**
  40085. * Use user marks to log performance
  40086. */
  40087. static readonly PerformanceUserMarkLogLevel: number;
  40088. /**
  40089. * Log performance to the console
  40090. */
  40091. static readonly PerformanceConsoleLogLevel: number;
  40092. private static _performance;
  40093. /**
  40094. * Sets the current performance log level
  40095. */
  40096. static set PerformanceLogLevel(level: number);
  40097. private static _StartPerformanceCounterDisabled;
  40098. private static _EndPerformanceCounterDisabled;
  40099. private static _StartUserMark;
  40100. private static _EndUserMark;
  40101. private static _StartPerformanceConsole;
  40102. private static _EndPerformanceConsole;
  40103. /**
  40104. * Starts a performance counter
  40105. */
  40106. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  40107. /**
  40108. * Ends a specific performance coutner
  40109. */
  40110. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  40111. /**
  40112. * Gets either window.performance.now() if supported or Date.now() else
  40113. */
  40114. static get Now(): number;
  40115. /**
  40116. * This method will return the name of the class used to create the instance of the given object.
  40117. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  40118. * @param object the object to get the class name from
  40119. * @param isType defines if the object is actually a type
  40120. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  40121. */
  40122. static GetClassName(object: any, isType?: boolean): string;
  40123. /**
  40124. * Gets the first element of an array satisfying a given predicate
  40125. * @param array defines the array to browse
  40126. * @param predicate defines the predicate to use
  40127. * @returns null if not found or the element
  40128. */
  40129. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  40130. /**
  40131. * This method will return the name of the full name of the class, including its owning module (if any).
  40132. * 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).
  40133. * @param object the object to get the class name from
  40134. * @param isType defines if the object is actually a type
  40135. * @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.
  40136. * @ignorenaming
  40137. */
  40138. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  40139. /**
  40140. * Returns a promise that resolves after the given amount of time.
  40141. * @param delay Number of milliseconds to delay
  40142. * @returns Promise that resolves after the given amount of time
  40143. */
  40144. static DelayAsync(delay: number): Promise<void>;
  40145. /**
  40146. * Utility function to detect if the current user agent is Safari
  40147. * @returns whether or not the current user agent is safari
  40148. */
  40149. static IsSafari(): boolean;
  40150. }
  40151. /**
  40152. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  40153. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  40154. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  40155. * @param name The name of the class, case should be preserved
  40156. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  40157. */
  40158. export function className(name: string, module?: string): (target: Object) => void;
  40159. /**
  40160. * An implementation of a loop for asynchronous functions.
  40161. */
  40162. export class AsyncLoop {
  40163. /**
  40164. * Defines the number of iterations for the loop
  40165. */
  40166. iterations: number;
  40167. /**
  40168. * Defines the current index of the loop.
  40169. */
  40170. index: number;
  40171. private _done;
  40172. private _fn;
  40173. private _successCallback;
  40174. /**
  40175. * Constructor.
  40176. * @param iterations the number of iterations.
  40177. * @param func the function to run each iteration
  40178. * @param successCallback the callback that will be called upon succesful execution
  40179. * @param offset starting offset.
  40180. */
  40181. constructor(
  40182. /**
  40183. * Defines the number of iterations for the loop
  40184. */
  40185. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  40186. /**
  40187. * Execute the next iteration. Must be called after the last iteration was finished.
  40188. */
  40189. executeNext(): void;
  40190. /**
  40191. * Break the loop and run the success callback.
  40192. */
  40193. breakLoop(): void;
  40194. /**
  40195. * Create and run an async loop.
  40196. * @param iterations the number of iterations.
  40197. * @param fn the function to run each iteration
  40198. * @param successCallback the callback that will be called upon succesful execution
  40199. * @param offset starting offset.
  40200. * @returns the created async loop object
  40201. */
  40202. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  40203. /**
  40204. * A for-loop that will run a given number of iterations synchronous and the rest async.
  40205. * @param iterations total number of iterations
  40206. * @param syncedIterations number of synchronous iterations in each async iteration.
  40207. * @param fn the function to call each iteration.
  40208. * @param callback a success call back that will be called when iterating stops.
  40209. * @param breakFunction a break condition (optional)
  40210. * @param timeout timeout settings for the setTimeout function. default - 0.
  40211. * @returns the created async loop object
  40212. */
  40213. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  40214. }
  40215. }
  40216. declare module "babylonjs/Misc/stringDictionary" {
  40217. import { Nullable } from "babylonjs/types";
  40218. /**
  40219. * This class implement a typical dictionary using a string as key and the generic type T as value.
  40220. * The underlying implementation relies on an associative array to ensure the best performances.
  40221. * The value can be anything including 'null' but except 'undefined'
  40222. */
  40223. export class StringDictionary<T> {
  40224. /**
  40225. * This will clear this dictionary and copy the content from the 'source' one.
  40226. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  40227. * @param source the dictionary to take the content from and copy to this dictionary
  40228. */
  40229. copyFrom(source: StringDictionary<T>): void;
  40230. /**
  40231. * Get a value based from its key
  40232. * @param key the given key to get the matching value from
  40233. * @return the value if found, otherwise undefined is returned
  40234. */
  40235. get(key: string): T | undefined;
  40236. /**
  40237. * Get a value from its key or add it if it doesn't exist.
  40238. * This method will ensure you that a given key/data will be present in the dictionary.
  40239. * @param key the given key to get the matching value from
  40240. * @param factory the factory that will create the value if the key is not present in the dictionary.
  40241. * The factory will only be invoked if there's no data for the given key.
  40242. * @return the value corresponding to the key.
  40243. */
  40244. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  40245. /**
  40246. * Get a value from its key if present in the dictionary otherwise add it
  40247. * @param key the key to get the value from
  40248. * @param val if there's no such key/value pair in the dictionary add it with this value
  40249. * @return the value corresponding to the key
  40250. */
  40251. getOrAdd(key: string, val: T): T;
  40252. /**
  40253. * Check if there's a given key in the dictionary
  40254. * @param key the key to check for
  40255. * @return true if the key is present, false otherwise
  40256. */
  40257. contains(key: string): boolean;
  40258. /**
  40259. * Add a new key and its corresponding value
  40260. * @param key the key to add
  40261. * @param value the value corresponding to the key
  40262. * @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
  40263. */
  40264. add(key: string, value: T): boolean;
  40265. /**
  40266. * Update a specific value associated to a key
  40267. * @param key defines the key to use
  40268. * @param value defines the value to store
  40269. * @returns true if the value was updated (or false if the key was not found)
  40270. */
  40271. set(key: string, value: T): boolean;
  40272. /**
  40273. * Get the element of the given key and remove it from the dictionary
  40274. * @param key defines the key to search
  40275. * @returns the value associated with the key or null if not found
  40276. */
  40277. getAndRemove(key: string): Nullable<T>;
  40278. /**
  40279. * Remove a key/value from the dictionary.
  40280. * @param key the key to remove
  40281. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  40282. */
  40283. remove(key: string): boolean;
  40284. /**
  40285. * Clear the whole content of the dictionary
  40286. */
  40287. clear(): void;
  40288. /**
  40289. * Gets the current count
  40290. */
  40291. get count(): number;
  40292. /**
  40293. * Execute a callback on each key/val of the dictionary.
  40294. * Note that you can remove any element in this dictionary in the callback implementation
  40295. * @param callback the callback to execute on a given key/value pair
  40296. */
  40297. forEach(callback: (key: string, val: T) => void): void;
  40298. /**
  40299. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  40300. * If the callback returns null or undefined the method will iterate to the next key/value pair
  40301. * Note that you can remove any element in this dictionary in the callback implementation
  40302. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  40303. * @returns the first item
  40304. */
  40305. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  40306. private _count;
  40307. private _data;
  40308. }
  40309. }
  40310. declare module "babylonjs/Collisions/collisionCoordinator" {
  40311. import { Nullable } from "babylonjs/types";
  40312. import { Scene } from "babylonjs/scene";
  40313. import { Vector3 } from "babylonjs/Maths/math.vector";
  40314. import { Collider } from "babylonjs/Collisions/collider";
  40315. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40316. /** @hidden */
  40317. export interface ICollisionCoordinator {
  40318. createCollider(): Collider;
  40319. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  40320. init(scene: Scene): void;
  40321. }
  40322. /** @hidden */
  40323. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  40324. private _scene;
  40325. private _scaledPosition;
  40326. private _scaledVelocity;
  40327. private _finalPosition;
  40328. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  40329. createCollider(): Collider;
  40330. init(scene: Scene): void;
  40331. private _collideWithWorld;
  40332. }
  40333. }
  40334. declare module "babylonjs/Inputs/scene.inputManager" {
  40335. import { Nullable } from "babylonjs/types";
  40336. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40337. import { Vector2 } from "babylonjs/Maths/math.vector";
  40338. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40339. import { Scene } from "babylonjs/scene";
  40340. /**
  40341. * Class used to manage all inputs for the scene.
  40342. */
  40343. export class InputManager {
  40344. /** The distance in pixel that you have to move to prevent some events */
  40345. static DragMovementThreshold: number;
  40346. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  40347. static LongPressDelay: number;
  40348. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  40349. static DoubleClickDelay: number;
  40350. /** If you need to check double click without raising a single click at first click, enable this flag */
  40351. static ExclusiveDoubleClickMode: boolean;
  40352. /** 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. */
  40353. private _alreadyAttached;
  40354. private _wheelEventName;
  40355. private _onPointerMove;
  40356. private _onPointerDown;
  40357. private _onPointerUp;
  40358. private _initClickEvent;
  40359. private _initActionManager;
  40360. private _delayedSimpleClick;
  40361. private _delayedSimpleClickTimeout;
  40362. private _previousDelayedSimpleClickTimeout;
  40363. private _meshPickProceed;
  40364. private _previousButtonPressed;
  40365. private _currentPickResult;
  40366. private _previousPickResult;
  40367. private _totalPointersPressed;
  40368. private _doubleClickOccured;
  40369. private _pointerOverMesh;
  40370. private _pickedDownMesh;
  40371. private _pickedUpMesh;
  40372. private _pointerX;
  40373. private _pointerY;
  40374. private _unTranslatedPointerX;
  40375. private _unTranslatedPointerY;
  40376. private _startingPointerPosition;
  40377. private _previousStartingPointerPosition;
  40378. private _startingPointerTime;
  40379. private _previousStartingPointerTime;
  40380. private _pointerCaptures;
  40381. private _meshUnderPointerId;
  40382. private _onKeyDown;
  40383. private _onKeyUp;
  40384. private _onCanvasFocusObserver;
  40385. private _onCanvasBlurObserver;
  40386. private _scene;
  40387. /**
  40388. * Creates a new InputManager
  40389. * @param scene defines the hosting scene
  40390. */
  40391. constructor(scene: Scene);
  40392. /**
  40393. * Gets the mesh that is currently under the pointer
  40394. */
  40395. get meshUnderPointer(): Nullable<AbstractMesh>;
  40396. /**
  40397. * When using more than one pointer (for example in XR) you can get the mesh under the specific pointer
  40398. * @param pointerId the pointer id to use
  40399. * @returns The mesh under this pointer id or null if not found
  40400. */
  40401. getMeshUnderPointerByPointerId(pointerId: number): Nullable<AbstractMesh>;
  40402. /**
  40403. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  40404. */
  40405. get unTranslatedPointer(): Vector2;
  40406. /**
  40407. * Gets or sets the current on-screen X position of the pointer
  40408. */
  40409. get pointerX(): number;
  40410. set pointerX(value: number);
  40411. /**
  40412. * Gets or sets the current on-screen Y position of the pointer
  40413. */
  40414. get pointerY(): number;
  40415. set pointerY(value: number);
  40416. private _updatePointerPosition;
  40417. private _processPointerMove;
  40418. private _setRayOnPointerInfo;
  40419. private _checkPrePointerObservable;
  40420. /**
  40421. * Use this method to simulate a pointer move on a mesh
  40422. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40423. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40424. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40425. */
  40426. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40427. /**
  40428. * Use this method to simulate a pointer down on a mesh
  40429. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40430. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40431. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40432. */
  40433. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40434. private _processPointerDown;
  40435. /** @hidden */
  40436. _isPointerSwiping(): boolean;
  40437. /**
  40438. * Use this method to simulate a pointer up on a mesh
  40439. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40440. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40441. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40442. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  40443. */
  40444. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  40445. private _processPointerUp;
  40446. /**
  40447. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  40448. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  40449. * @returns true if the pointer was captured
  40450. */
  40451. isPointerCaptured(pointerId?: number): boolean;
  40452. /**
  40453. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  40454. * @param attachUp defines if you want to attach events to pointerup
  40455. * @param attachDown defines if you want to attach events to pointerdown
  40456. * @param attachMove defines if you want to attach events to pointermove
  40457. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  40458. */
  40459. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  40460. /**
  40461. * Detaches all event handlers
  40462. */
  40463. detachControl(): void;
  40464. /**
  40465. * Force the value of meshUnderPointer
  40466. * @param mesh defines the mesh to use
  40467. * @param pointerId optional pointer id when using more than one pointer. Defaults to 0
  40468. */
  40469. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  40470. /**
  40471. * Gets the mesh under the pointer
  40472. * @returns a Mesh or null if no mesh is under the pointer
  40473. */
  40474. getPointerOverMesh(): Nullable<AbstractMesh>;
  40475. }
  40476. }
  40477. declare module "babylonjs/Animations/animationGroup" {
  40478. import { Animatable } from "babylonjs/Animations/animatable";
  40479. import { Animation } from "babylonjs/Animations/animation";
  40480. import { Scene, IDisposable } from "babylonjs/scene";
  40481. import { Observable } from "babylonjs/Misc/observable";
  40482. import { Nullable } from "babylonjs/types";
  40483. import "babylonjs/Animations/animatable";
  40484. /**
  40485. * This class defines the direct association between an animation and a target
  40486. */
  40487. export class TargetedAnimation {
  40488. /**
  40489. * Animation to perform
  40490. */
  40491. animation: Animation;
  40492. /**
  40493. * Target to animate
  40494. */
  40495. target: any;
  40496. /**
  40497. * Returns the string "TargetedAnimation"
  40498. * @returns "TargetedAnimation"
  40499. */
  40500. getClassName(): string;
  40501. /**
  40502. * Serialize the object
  40503. * @returns the JSON object representing the current entity
  40504. */
  40505. serialize(): any;
  40506. }
  40507. /**
  40508. * Use this class to create coordinated animations on multiple targets
  40509. */
  40510. export class AnimationGroup implements IDisposable {
  40511. /** The name of the animation group */
  40512. name: string;
  40513. private _scene;
  40514. private _targetedAnimations;
  40515. private _animatables;
  40516. private _from;
  40517. private _to;
  40518. private _isStarted;
  40519. private _isPaused;
  40520. private _speedRatio;
  40521. private _loopAnimation;
  40522. private _isAdditive;
  40523. /**
  40524. * Gets or sets the unique id of the node
  40525. */
  40526. uniqueId: number;
  40527. /**
  40528. * This observable will notify when one animation have ended
  40529. */
  40530. onAnimationEndObservable: Observable<TargetedAnimation>;
  40531. /**
  40532. * Observer raised when one animation loops
  40533. */
  40534. onAnimationLoopObservable: Observable<TargetedAnimation>;
  40535. /**
  40536. * Observer raised when all animations have looped
  40537. */
  40538. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  40539. /**
  40540. * This observable will notify when all animations have ended.
  40541. */
  40542. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  40543. /**
  40544. * This observable will notify when all animations have paused.
  40545. */
  40546. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  40547. /**
  40548. * This observable will notify when all animations are playing.
  40549. */
  40550. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  40551. /**
  40552. * Gets the first frame
  40553. */
  40554. get from(): number;
  40555. /**
  40556. * Gets the last frame
  40557. */
  40558. get to(): number;
  40559. /**
  40560. * Define if the animations are started
  40561. */
  40562. get isStarted(): boolean;
  40563. /**
  40564. * Gets a value indicating that the current group is playing
  40565. */
  40566. get isPlaying(): boolean;
  40567. /**
  40568. * Gets or sets the speed ratio to use for all animations
  40569. */
  40570. get speedRatio(): number;
  40571. /**
  40572. * Gets or sets the speed ratio to use for all animations
  40573. */
  40574. set speedRatio(value: number);
  40575. /**
  40576. * Gets or sets if all animations should loop or not
  40577. */
  40578. get loopAnimation(): boolean;
  40579. set loopAnimation(value: boolean);
  40580. /**
  40581. * Gets or sets if all animations should be evaluated additively
  40582. */
  40583. get isAdditive(): boolean;
  40584. set isAdditive(value: boolean);
  40585. /**
  40586. * Gets the targeted animations for this animation group
  40587. */
  40588. get targetedAnimations(): Array<TargetedAnimation>;
  40589. /**
  40590. * returning the list of animatables controlled by this animation group.
  40591. */
  40592. get animatables(): Array<Animatable>;
  40593. /**
  40594. * Gets the list of target animations
  40595. */
  40596. get children(): TargetedAnimation[];
  40597. /**
  40598. * Instantiates a new Animation Group.
  40599. * This helps managing several animations at once.
  40600. * @see https://doc.babylonjs.com/how_to/group
  40601. * @param name Defines the name of the group
  40602. * @param scene Defines the scene the group belongs to
  40603. */
  40604. constructor(
  40605. /** The name of the animation group */
  40606. name: string, scene?: Nullable<Scene>);
  40607. /**
  40608. * Add an animation (with its target) in the group
  40609. * @param animation defines the animation we want to add
  40610. * @param target defines the target of the animation
  40611. * @returns the TargetedAnimation object
  40612. */
  40613. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  40614. /**
  40615. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  40616. * It can add constant keys at begin or end
  40617. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  40618. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  40619. * @returns the animation group
  40620. */
  40621. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  40622. private _animationLoopCount;
  40623. private _animationLoopFlags;
  40624. private _processLoop;
  40625. /**
  40626. * Start all animations on given targets
  40627. * @param loop defines if animations must loop
  40628. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  40629. * @param from defines the from key (optional)
  40630. * @param to defines the to key (optional)
  40631. * @param isAdditive defines the additive state for the resulting animatables (optional)
  40632. * @returns the current animation group
  40633. */
  40634. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  40635. /**
  40636. * Pause all animations
  40637. * @returns the animation group
  40638. */
  40639. pause(): AnimationGroup;
  40640. /**
  40641. * Play all animations to initial state
  40642. * This function will start() the animations if they were not started or will restart() them if they were paused
  40643. * @param loop defines if animations must loop
  40644. * @returns the animation group
  40645. */
  40646. play(loop?: boolean): AnimationGroup;
  40647. /**
  40648. * Reset all animations to initial state
  40649. * @returns the animation group
  40650. */
  40651. reset(): AnimationGroup;
  40652. /**
  40653. * Restart animations from key 0
  40654. * @returns the animation group
  40655. */
  40656. restart(): AnimationGroup;
  40657. /**
  40658. * Stop all animations
  40659. * @returns the animation group
  40660. */
  40661. stop(): AnimationGroup;
  40662. /**
  40663. * Set animation weight for all animatables
  40664. * @param weight defines the weight to use
  40665. * @return the animationGroup
  40666. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40667. */
  40668. setWeightForAllAnimatables(weight: number): AnimationGroup;
  40669. /**
  40670. * Synchronize and normalize all animatables with a source animatable
  40671. * @param root defines the root animatable to synchronize with
  40672. * @return the animationGroup
  40673. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40674. */
  40675. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  40676. /**
  40677. * Goes to a specific frame in this animation group
  40678. * @param frame the frame number to go to
  40679. * @return the animationGroup
  40680. */
  40681. goToFrame(frame: number): AnimationGroup;
  40682. /**
  40683. * Dispose all associated resources
  40684. */
  40685. dispose(): void;
  40686. private _checkAnimationGroupEnded;
  40687. /**
  40688. * Clone the current animation group and returns a copy
  40689. * @param newName defines the name of the new group
  40690. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  40691. * @returns the new aniamtion group
  40692. */
  40693. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  40694. /**
  40695. * Serializes the animationGroup to an object
  40696. * @returns Serialized object
  40697. */
  40698. serialize(): any;
  40699. /**
  40700. * Returns a new AnimationGroup object parsed from the source provided.
  40701. * @param parsedAnimationGroup defines the source
  40702. * @param scene defines the scene that will receive the animationGroup
  40703. * @returns a new AnimationGroup
  40704. */
  40705. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  40706. /**
  40707. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  40708. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  40709. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  40710. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  40711. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  40712. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  40713. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  40714. */
  40715. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  40716. /**
  40717. * Returns the string "AnimationGroup"
  40718. * @returns "AnimationGroup"
  40719. */
  40720. getClassName(): string;
  40721. /**
  40722. * Creates a detailled string about the object
  40723. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  40724. * @returns a string representing the object
  40725. */
  40726. toString(fullDetails?: boolean): string;
  40727. }
  40728. }
  40729. declare module "babylonjs/scene" {
  40730. import { Nullable } from "babylonjs/types";
  40731. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  40732. import { Observable } from "babylonjs/Misc/observable";
  40733. import { SmartArrayNoDuplicate, SmartArray, ISmartArrayLike } from "babylonjs/Misc/smartArray";
  40734. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  40735. import { Geometry } from "babylonjs/Meshes/geometry";
  40736. import { TransformNode } from "babylonjs/Meshes/transformNode";
  40737. import { SubMesh } from "babylonjs/Meshes/subMesh";
  40738. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40739. import { Mesh } from "babylonjs/Meshes/mesh";
  40740. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  40741. import { Bone } from "babylonjs/Bones/bone";
  40742. import { Skeleton } from "babylonjs/Bones/skeleton";
  40743. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  40744. import { Camera } from "babylonjs/Cameras/camera";
  40745. import { AbstractScene } from "babylonjs/abstractScene";
  40746. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  40747. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  40748. import { Material } from "babylonjs/Materials/material";
  40749. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  40750. import { Effect } from "babylonjs/Materials/effect";
  40751. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  40752. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  40753. import { Light } from "babylonjs/Lights/light";
  40754. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40755. import { ICollisionCoordinator } from "babylonjs/Collisions/collisionCoordinator";
  40756. import { PointerEventTypes, PointerInfoPre, PointerInfo } from "babylonjs/Events/pointerEvents";
  40757. import { KeyboardInfoPre, KeyboardInfo } from "babylonjs/Events/keyboardEvents";
  40758. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  40759. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  40760. import { RenderingGroupInfo, IRenderingManagerAutoClearSetup } from "babylonjs/Rendering/renderingManager";
  40761. import { ISceneComponent, ISceneSerializableComponent, Stage, SimpleStageAction, RenderTargetsStageAction, RenderTargetStageAction, MeshStageAction, EvaluateSubMeshStageAction, ActiveMeshStageAction, CameraStageAction, RenderingGroupStageAction, RenderingMeshStageAction, PointerMoveStageAction, PointerUpDownStageAction, CameraStageFrameBufferAction } from "babylonjs/sceneComponent";
  40762. import { Engine } from "babylonjs/Engines/engine";
  40763. import { Node } from "babylonjs/node";
  40764. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  40765. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  40766. import { WebRequest } from "babylonjs/Misc/webRequest";
  40767. import { InputManager } from "babylonjs/Inputs/scene.inputManager";
  40768. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  40769. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  40770. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  40771. import { Plane } from "babylonjs/Maths/math.plane";
  40772. import { LoadFileError, RequestFileError, ReadFileError } from "babylonjs/Misc/fileTools";
  40773. import { IClipPlanesHolder } from "babylonjs/Misc/interfaces/iClipPlanesHolder";
  40774. import { Ray } from "babylonjs/Culling/ray";
  40775. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  40776. import { Animation } from "babylonjs/Animations/animation";
  40777. import { Animatable } from "babylonjs/Animations/animatable";
  40778. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  40779. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  40780. import { Collider } from "babylonjs/Collisions/collider";
  40781. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  40782. /**
  40783. * Define an interface for all classes that will hold resources
  40784. */
  40785. export interface IDisposable {
  40786. /**
  40787. * Releases all held resources
  40788. */
  40789. dispose(): void;
  40790. }
  40791. /** Interface defining initialization parameters for Scene class */
  40792. export interface SceneOptions {
  40793. /**
  40794. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  40795. * It will improve performance when the number of geometries becomes important.
  40796. */
  40797. useGeometryUniqueIdsMap?: boolean;
  40798. /**
  40799. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  40800. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40801. */
  40802. useMaterialMeshMap?: boolean;
  40803. /**
  40804. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  40805. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40806. */
  40807. useClonedMeshMap?: boolean;
  40808. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  40809. virtual?: boolean;
  40810. }
  40811. /**
  40812. * Represents a scene to be rendered by the engine.
  40813. * @see https://doc.babylonjs.com/features/scene
  40814. */
  40815. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  40816. /** The fog is deactivated */
  40817. static readonly FOGMODE_NONE: number;
  40818. /** The fog density is following an exponential function */
  40819. static readonly FOGMODE_EXP: number;
  40820. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  40821. static readonly FOGMODE_EXP2: number;
  40822. /** The fog density is following a linear function. */
  40823. static readonly FOGMODE_LINEAR: number;
  40824. /**
  40825. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  40826. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40827. */
  40828. static MinDeltaTime: number;
  40829. /**
  40830. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  40831. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40832. */
  40833. static MaxDeltaTime: number;
  40834. /**
  40835. * Factory used to create the default material.
  40836. * @param name The name of the material to create
  40837. * @param scene The scene to create the material for
  40838. * @returns The default material
  40839. */
  40840. static DefaultMaterialFactory(scene: Scene): Material;
  40841. /**
  40842. * Factory used to create the a collision coordinator.
  40843. * @returns The collision coordinator
  40844. */
  40845. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  40846. /** @hidden */
  40847. _inputManager: InputManager;
  40848. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  40849. cameraToUseForPointers: Nullable<Camera>;
  40850. /** @hidden */
  40851. readonly _isScene: boolean;
  40852. /** @hidden */
  40853. _blockEntityCollection: boolean;
  40854. /**
  40855. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  40856. */
  40857. autoClear: boolean;
  40858. /**
  40859. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  40860. */
  40861. autoClearDepthAndStencil: boolean;
  40862. /**
  40863. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  40864. */
  40865. clearColor: Color4;
  40866. /**
  40867. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  40868. */
  40869. ambientColor: Color3;
  40870. /**
  40871. * This is use to store the default BRDF lookup for PBR materials in your scene.
  40872. * It should only be one of the following (if not the default embedded one):
  40873. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  40874. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  40875. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  40876. * The material properties need to be setup according to the type of texture in use.
  40877. */
  40878. environmentBRDFTexture: BaseTexture;
  40879. /**
  40880. * Texture used in all pbr material as the reflection texture.
  40881. * As in the majority of the scene they are the same (exception for multi room and so on),
  40882. * this is easier to reference from here than from all the materials.
  40883. */
  40884. get environmentTexture(): Nullable<BaseTexture>;
  40885. /**
  40886. * Texture used in all pbr material as the reflection texture.
  40887. * As in the majority of the scene they are the same (exception for multi room and so on),
  40888. * this is easier to set here than in all the materials.
  40889. */
  40890. set environmentTexture(value: Nullable<BaseTexture>);
  40891. /** @hidden */
  40892. protected _environmentIntensity: number;
  40893. /**
  40894. * Intensity of the environment in all pbr material.
  40895. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40896. * As in the majority of the scene they are the same (exception for multi room and so on),
  40897. * this is easier to reference from here than from all the materials.
  40898. */
  40899. get environmentIntensity(): number;
  40900. /**
  40901. * Intensity of the environment in all pbr material.
  40902. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40903. * As in the majority of the scene they are the same (exception for multi room and so on),
  40904. * this is easier to set here than in all the materials.
  40905. */
  40906. set environmentIntensity(value: number);
  40907. /** @hidden */
  40908. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  40909. /**
  40910. * Default image processing configuration used either in the rendering
  40911. * Forward main pass or through the imageProcessingPostProcess if present.
  40912. * As in the majority of the scene they are the same (exception for multi camera),
  40913. * this is easier to reference from here than from all the materials and post process.
  40914. *
  40915. * No setter as we it is a shared configuration, you can set the values instead.
  40916. */
  40917. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  40918. private _forceWireframe;
  40919. /**
  40920. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  40921. */
  40922. set forceWireframe(value: boolean);
  40923. get forceWireframe(): boolean;
  40924. private _skipFrustumClipping;
  40925. /**
  40926. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  40927. */
  40928. set skipFrustumClipping(value: boolean);
  40929. get skipFrustumClipping(): boolean;
  40930. private _forcePointsCloud;
  40931. /**
  40932. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  40933. */
  40934. set forcePointsCloud(value: boolean);
  40935. get forcePointsCloud(): boolean;
  40936. /**
  40937. * Gets or sets the active clipplane 1
  40938. */
  40939. clipPlane: Nullable<Plane>;
  40940. /**
  40941. * Gets or sets the active clipplane 2
  40942. */
  40943. clipPlane2: Nullable<Plane>;
  40944. /**
  40945. * Gets or sets the active clipplane 3
  40946. */
  40947. clipPlane3: Nullable<Plane>;
  40948. /**
  40949. * Gets or sets the active clipplane 4
  40950. */
  40951. clipPlane4: Nullable<Plane>;
  40952. /**
  40953. * Gets or sets the active clipplane 5
  40954. */
  40955. clipPlane5: Nullable<Plane>;
  40956. /**
  40957. * Gets or sets the active clipplane 6
  40958. */
  40959. clipPlane6: Nullable<Plane>;
  40960. /**
  40961. * Gets or sets a boolean indicating if animations are enabled
  40962. */
  40963. animationsEnabled: boolean;
  40964. private _animationPropertiesOverride;
  40965. /**
  40966. * Gets or sets the animation properties override
  40967. */
  40968. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  40969. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  40970. /**
  40971. * Gets or sets a boolean indicating if a constant deltatime has to be used
  40972. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  40973. */
  40974. useConstantAnimationDeltaTime: boolean;
  40975. /**
  40976. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  40977. * Please note that it requires to run a ray cast through the scene on every frame
  40978. */
  40979. constantlyUpdateMeshUnderPointer: boolean;
  40980. /**
  40981. * Defines the HTML cursor to use when hovering over interactive elements
  40982. */
  40983. hoverCursor: string;
  40984. /**
  40985. * Defines the HTML default cursor to use (empty by default)
  40986. */
  40987. defaultCursor: string;
  40988. /**
  40989. * Defines whether cursors are handled by the scene.
  40990. */
  40991. doNotHandleCursors: boolean;
  40992. /**
  40993. * This is used to call preventDefault() on pointer down
  40994. * in order to block unwanted artifacts like system double clicks
  40995. */
  40996. preventDefaultOnPointerDown: boolean;
  40997. /**
  40998. * This is used to call preventDefault() on pointer up
  40999. * in order to block unwanted artifacts like system double clicks
  41000. */
  41001. preventDefaultOnPointerUp: boolean;
  41002. /**
  41003. * Gets or sets user defined metadata
  41004. */
  41005. metadata: any;
  41006. /**
  41007. * For internal use only. Please do not use.
  41008. */
  41009. reservedDataStore: any;
  41010. /**
  41011. * Gets the name of the plugin used to load this scene (null by default)
  41012. */
  41013. loadingPluginName: string;
  41014. /**
  41015. * Use this array to add regular expressions used to disable offline support for specific urls
  41016. */
  41017. disableOfflineSupportExceptionRules: RegExp[];
  41018. /**
  41019. * An event triggered when the scene is disposed.
  41020. */
  41021. onDisposeObservable: Observable<Scene>;
  41022. private _onDisposeObserver;
  41023. /** Sets a function to be executed when this scene is disposed. */
  41024. set onDispose(callback: () => void);
  41025. /**
  41026. * An event triggered before rendering the scene (right after animations and physics)
  41027. */
  41028. onBeforeRenderObservable: Observable<Scene>;
  41029. private _onBeforeRenderObserver;
  41030. /** Sets a function to be executed before rendering this scene */
  41031. set beforeRender(callback: Nullable<() => void>);
  41032. /**
  41033. * An event triggered after rendering the scene
  41034. */
  41035. onAfterRenderObservable: Observable<Scene>;
  41036. /**
  41037. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  41038. */
  41039. onAfterRenderCameraObservable: Observable<Camera>;
  41040. private _onAfterRenderObserver;
  41041. /** Sets a function to be executed after rendering this scene */
  41042. set afterRender(callback: Nullable<() => void>);
  41043. /**
  41044. * An event triggered before animating the scene
  41045. */
  41046. onBeforeAnimationsObservable: Observable<Scene>;
  41047. /**
  41048. * An event triggered after animations processing
  41049. */
  41050. onAfterAnimationsObservable: Observable<Scene>;
  41051. /**
  41052. * An event triggered before draw calls are ready to be sent
  41053. */
  41054. onBeforeDrawPhaseObservable: Observable<Scene>;
  41055. /**
  41056. * An event triggered after draw calls have been sent
  41057. */
  41058. onAfterDrawPhaseObservable: Observable<Scene>;
  41059. /**
  41060. * An event triggered when the scene is ready
  41061. */
  41062. onReadyObservable: Observable<Scene>;
  41063. /**
  41064. * An event triggered before rendering a camera
  41065. */
  41066. onBeforeCameraRenderObservable: Observable<Camera>;
  41067. private _onBeforeCameraRenderObserver;
  41068. /** Sets a function to be executed before rendering a camera*/
  41069. set beforeCameraRender(callback: () => void);
  41070. /**
  41071. * An event triggered after rendering a camera
  41072. */
  41073. onAfterCameraRenderObservable: Observable<Camera>;
  41074. private _onAfterCameraRenderObserver;
  41075. /** Sets a function to be executed after rendering a camera*/
  41076. set afterCameraRender(callback: () => void);
  41077. /**
  41078. * An event triggered when active meshes evaluation is about to start
  41079. */
  41080. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  41081. /**
  41082. * An event triggered when active meshes evaluation is done
  41083. */
  41084. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  41085. /**
  41086. * An event triggered when particles rendering is about to start
  41087. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  41088. */
  41089. onBeforeParticlesRenderingObservable: Observable<Scene>;
  41090. /**
  41091. * An event triggered when particles rendering is done
  41092. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  41093. */
  41094. onAfterParticlesRenderingObservable: Observable<Scene>;
  41095. /**
  41096. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  41097. */
  41098. onDataLoadedObservable: Observable<Scene>;
  41099. /**
  41100. * An event triggered when a camera is created
  41101. */
  41102. onNewCameraAddedObservable: Observable<Camera>;
  41103. /**
  41104. * An event triggered when a camera is removed
  41105. */
  41106. onCameraRemovedObservable: Observable<Camera>;
  41107. /**
  41108. * An event triggered when a light is created
  41109. */
  41110. onNewLightAddedObservable: Observable<Light>;
  41111. /**
  41112. * An event triggered when a light is removed
  41113. */
  41114. onLightRemovedObservable: Observable<Light>;
  41115. /**
  41116. * An event triggered when a geometry is created
  41117. */
  41118. onNewGeometryAddedObservable: Observable<Geometry>;
  41119. /**
  41120. * An event triggered when a geometry is removed
  41121. */
  41122. onGeometryRemovedObservable: Observable<Geometry>;
  41123. /**
  41124. * An event triggered when a transform node is created
  41125. */
  41126. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  41127. /**
  41128. * An event triggered when a transform node is removed
  41129. */
  41130. onTransformNodeRemovedObservable: Observable<TransformNode>;
  41131. /**
  41132. * An event triggered when a mesh is created
  41133. */
  41134. onNewMeshAddedObservable: Observable<AbstractMesh>;
  41135. /**
  41136. * An event triggered when a mesh is removed
  41137. */
  41138. onMeshRemovedObservable: Observable<AbstractMesh>;
  41139. /**
  41140. * An event triggered when a skeleton is created
  41141. */
  41142. onNewSkeletonAddedObservable: Observable<Skeleton>;
  41143. /**
  41144. * An event triggered when a skeleton is removed
  41145. */
  41146. onSkeletonRemovedObservable: Observable<Skeleton>;
  41147. /**
  41148. * An event triggered when a material is created
  41149. */
  41150. onNewMaterialAddedObservable: Observable<Material>;
  41151. /**
  41152. * An event triggered when a material is removed
  41153. */
  41154. onMaterialRemovedObservable: Observable<Material>;
  41155. /**
  41156. * An event triggered when a texture is created
  41157. */
  41158. onNewTextureAddedObservable: Observable<BaseTexture>;
  41159. /**
  41160. * An event triggered when a texture is removed
  41161. */
  41162. onTextureRemovedObservable: Observable<BaseTexture>;
  41163. /**
  41164. * An event triggered when render targets are about to be rendered
  41165. * Can happen multiple times per frame.
  41166. */
  41167. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  41168. /**
  41169. * An event triggered when render targets were rendered.
  41170. * Can happen multiple times per frame.
  41171. */
  41172. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  41173. /**
  41174. * An event triggered before calculating deterministic simulation step
  41175. */
  41176. onBeforeStepObservable: Observable<Scene>;
  41177. /**
  41178. * An event triggered after calculating deterministic simulation step
  41179. */
  41180. onAfterStepObservable: Observable<Scene>;
  41181. /**
  41182. * An event triggered when the activeCamera property is updated
  41183. */
  41184. onActiveCameraChanged: Observable<Scene>;
  41185. /**
  41186. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  41187. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  41188. * 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)
  41189. */
  41190. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  41191. /**
  41192. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  41193. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  41194. * 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)
  41195. */
  41196. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  41197. /**
  41198. * This Observable will when a mesh has been imported into the scene.
  41199. */
  41200. onMeshImportedObservable: Observable<AbstractMesh>;
  41201. /**
  41202. * This Observable will when an animation file has been imported into the scene.
  41203. */
  41204. onAnimationFileImportedObservable: Observable<Scene>;
  41205. /**
  41206. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  41207. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  41208. */
  41209. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  41210. /** @hidden */
  41211. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  41212. /**
  41213. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  41214. */
  41215. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  41216. /**
  41217. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  41218. */
  41219. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  41220. /**
  41221. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  41222. */
  41223. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  41224. /** Callback called when a pointer move is detected */
  41225. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  41226. /** Callback called when a pointer down is detected */
  41227. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  41228. /** Callback called when a pointer up is detected */
  41229. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  41230. /** Callback called when a pointer pick is detected */
  41231. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  41232. /**
  41233. * 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).
  41234. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  41235. */
  41236. onPrePointerObservable: Observable<PointerInfoPre>;
  41237. /**
  41238. * Observable event triggered each time an input event is received from the rendering canvas
  41239. */
  41240. onPointerObservable: Observable<PointerInfo>;
  41241. /**
  41242. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  41243. */
  41244. get unTranslatedPointer(): Vector2;
  41245. /**
  41246. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  41247. */
  41248. static get DragMovementThreshold(): number;
  41249. static set DragMovementThreshold(value: number);
  41250. /**
  41251. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  41252. */
  41253. static get LongPressDelay(): number;
  41254. static set LongPressDelay(value: number);
  41255. /**
  41256. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  41257. */
  41258. static get DoubleClickDelay(): number;
  41259. static set DoubleClickDelay(value: number);
  41260. /** If you need to check double click without raising a single click at first click, enable this flag */
  41261. static get ExclusiveDoubleClickMode(): boolean;
  41262. static set ExclusiveDoubleClickMode(value: boolean);
  41263. /** @hidden */
  41264. _mirroredCameraPosition: Nullable<Vector3>;
  41265. /**
  41266. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  41267. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  41268. */
  41269. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  41270. /**
  41271. * Observable event triggered each time an keyboard event is received from the hosting window
  41272. */
  41273. onKeyboardObservable: Observable<KeyboardInfo>;
  41274. private _useRightHandedSystem;
  41275. /**
  41276. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  41277. */
  41278. set useRightHandedSystem(value: boolean);
  41279. get useRightHandedSystem(): boolean;
  41280. private _timeAccumulator;
  41281. private _currentStepId;
  41282. private _currentInternalStep;
  41283. /**
  41284. * Sets the step Id used by deterministic lock step
  41285. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41286. * @param newStepId defines the step Id
  41287. */
  41288. setStepId(newStepId: number): void;
  41289. /**
  41290. * Gets the step Id used by deterministic lock step
  41291. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41292. * @returns the step Id
  41293. */
  41294. getStepId(): number;
  41295. /**
  41296. * Gets the internal step used by deterministic lock step
  41297. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41298. * @returns the internal step
  41299. */
  41300. getInternalStep(): number;
  41301. private _fogEnabled;
  41302. /**
  41303. * Gets or sets a boolean indicating if fog is enabled on this scene
  41304. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41305. * (Default is true)
  41306. */
  41307. set fogEnabled(value: boolean);
  41308. get fogEnabled(): boolean;
  41309. private _fogMode;
  41310. /**
  41311. * Gets or sets the fog mode to use
  41312. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41313. * | mode | value |
  41314. * | --- | --- |
  41315. * | FOGMODE_NONE | 0 |
  41316. * | FOGMODE_EXP | 1 |
  41317. * | FOGMODE_EXP2 | 2 |
  41318. * | FOGMODE_LINEAR | 3 |
  41319. */
  41320. set fogMode(value: number);
  41321. get fogMode(): number;
  41322. /**
  41323. * Gets or sets the fog color to use
  41324. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41325. * (Default is Color3(0.2, 0.2, 0.3))
  41326. */
  41327. fogColor: Color3;
  41328. /**
  41329. * Gets or sets the fog density to use
  41330. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41331. * (Default is 0.1)
  41332. */
  41333. fogDensity: number;
  41334. /**
  41335. * Gets or sets the fog start distance to use
  41336. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41337. * (Default is 0)
  41338. */
  41339. fogStart: number;
  41340. /**
  41341. * Gets or sets the fog end distance to use
  41342. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41343. * (Default is 1000)
  41344. */
  41345. fogEnd: number;
  41346. /**
  41347. * Flag indicating that the frame buffer binding is handled by another component
  41348. */
  41349. prePass: boolean;
  41350. private _shadowsEnabled;
  41351. /**
  41352. * Gets or sets a boolean indicating if shadows are enabled on this scene
  41353. */
  41354. set shadowsEnabled(value: boolean);
  41355. get shadowsEnabled(): boolean;
  41356. private _lightsEnabled;
  41357. /**
  41358. * Gets or sets a boolean indicating if lights are enabled on this scene
  41359. */
  41360. set lightsEnabled(value: boolean);
  41361. get lightsEnabled(): boolean;
  41362. /** All of the active cameras added to this scene. */
  41363. activeCameras: Camera[];
  41364. /** @hidden */
  41365. _activeCamera: Nullable<Camera>;
  41366. /** Gets or sets the current active camera */
  41367. get activeCamera(): Nullable<Camera>;
  41368. set activeCamera(value: Nullable<Camera>);
  41369. private _defaultMaterial;
  41370. /** The default material used on meshes when no material is affected */
  41371. get defaultMaterial(): Material;
  41372. /** The default material used on meshes when no material is affected */
  41373. set defaultMaterial(value: Material);
  41374. private _texturesEnabled;
  41375. /**
  41376. * Gets or sets a boolean indicating if textures are enabled on this scene
  41377. */
  41378. set texturesEnabled(value: boolean);
  41379. get texturesEnabled(): boolean;
  41380. /**
  41381. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  41382. */
  41383. physicsEnabled: boolean;
  41384. /**
  41385. * Gets or sets a boolean indicating if particles are enabled on this scene
  41386. */
  41387. particlesEnabled: boolean;
  41388. /**
  41389. * Gets or sets a boolean indicating if sprites are enabled on this scene
  41390. */
  41391. spritesEnabled: boolean;
  41392. private _skeletonsEnabled;
  41393. /**
  41394. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  41395. */
  41396. set skeletonsEnabled(value: boolean);
  41397. get skeletonsEnabled(): boolean;
  41398. /**
  41399. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  41400. */
  41401. lensFlaresEnabled: boolean;
  41402. /**
  41403. * Gets or sets a boolean indicating if collisions are enabled on this scene
  41404. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41405. */
  41406. collisionsEnabled: boolean;
  41407. private _collisionCoordinator;
  41408. /** @hidden */
  41409. get collisionCoordinator(): ICollisionCoordinator;
  41410. /**
  41411. * Defines the gravity applied to this scene (used only for collisions)
  41412. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41413. */
  41414. gravity: Vector3;
  41415. /**
  41416. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  41417. */
  41418. postProcessesEnabled: boolean;
  41419. /**
  41420. * Gets the current postprocess manager
  41421. */
  41422. postProcessManager: PostProcessManager;
  41423. /**
  41424. * Gets or sets a boolean indicating if render targets are enabled on this scene
  41425. */
  41426. renderTargetsEnabled: boolean;
  41427. /**
  41428. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  41429. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  41430. */
  41431. dumpNextRenderTargets: boolean;
  41432. /**
  41433. * The list of user defined render targets added to the scene
  41434. */
  41435. customRenderTargets: RenderTargetTexture[];
  41436. /**
  41437. * Defines if texture loading must be delayed
  41438. * If true, textures will only be loaded when they need to be rendered
  41439. */
  41440. useDelayedTextureLoading: boolean;
  41441. /**
  41442. * Gets the list of meshes imported to the scene through SceneLoader
  41443. */
  41444. importedMeshesFiles: String[];
  41445. /**
  41446. * Gets or sets a boolean indicating if probes are enabled on this scene
  41447. */
  41448. probesEnabled: boolean;
  41449. /**
  41450. * Gets or sets the current offline provider to use to store scene data
  41451. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  41452. */
  41453. offlineProvider: IOfflineProvider;
  41454. /**
  41455. * Gets or sets the action manager associated with the scene
  41456. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  41457. */
  41458. actionManager: AbstractActionManager;
  41459. private _meshesForIntersections;
  41460. /**
  41461. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  41462. */
  41463. proceduralTexturesEnabled: boolean;
  41464. private _engine;
  41465. private _totalVertices;
  41466. /** @hidden */
  41467. _activeIndices: PerfCounter;
  41468. /** @hidden */
  41469. _activeParticles: PerfCounter;
  41470. /** @hidden */
  41471. _activeBones: PerfCounter;
  41472. private _animationRatio;
  41473. /** @hidden */
  41474. _animationTimeLast: number;
  41475. /** @hidden */
  41476. _animationTime: number;
  41477. /**
  41478. * Gets or sets a general scale for animation speed
  41479. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  41480. */
  41481. animationTimeScale: number;
  41482. /** @hidden */
  41483. _cachedMaterial: Nullable<Material>;
  41484. /** @hidden */
  41485. _cachedEffect: Nullable<Effect>;
  41486. /** @hidden */
  41487. _cachedVisibility: Nullable<number>;
  41488. private _renderId;
  41489. private _frameId;
  41490. private _executeWhenReadyTimeoutId;
  41491. private _intermediateRendering;
  41492. private _viewUpdateFlag;
  41493. private _projectionUpdateFlag;
  41494. /** @hidden */
  41495. _toBeDisposed: Nullable<IDisposable>[];
  41496. private _activeRequests;
  41497. /** @hidden */
  41498. _pendingData: any[];
  41499. private _isDisposed;
  41500. /**
  41501. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  41502. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  41503. */
  41504. dispatchAllSubMeshesOfActiveMeshes: boolean;
  41505. private _activeMeshes;
  41506. private _processedMaterials;
  41507. private _renderTargets;
  41508. /** @hidden */
  41509. _activeParticleSystems: SmartArray<IParticleSystem>;
  41510. private _activeSkeletons;
  41511. private _softwareSkinnedMeshes;
  41512. private _renderingManager;
  41513. /** @hidden */
  41514. _activeAnimatables: import("babylonjs/Animations/animatable").Animatable[];
  41515. private _transformMatrix;
  41516. private _sceneUbo;
  41517. /** @hidden */
  41518. _viewMatrix: Matrix;
  41519. private _projectionMatrix;
  41520. /** @hidden */
  41521. _forcedViewPosition: Nullable<Vector3>;
  41522. /** @hidden */
  41523. _frustumPlanes: Plane[];
  41524. /**
  41525. * Gets the list of frustum planes (built from the active camera)
  41526. */
  41527. get frustumPlanes(): Plane[];
  41528. /**
  41529. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  41530. * This is useful if there are more lights that the maximum simulteanous authorized
  41531. */
  41532. requireLightSorting: boolean;
  41533. /** @hidden */
  41534. readonly useMaterialMeshMap: boolean;
  41535. /** @hidden */
  41536. readonly useClonedMeshMap: boolean;
  41537. private _externalData;
  41538. private _uid;
  41539. /**
  41540. * @hidden
  41541. * Backing store of defined scene components.
  41542. */
  41543. _components: ISceneComponent[];
  41544. /**
  41545. * @hidden
  41546. * Backing store of defined scene components.
  41547. */
  41548. _serializableComponents: ISceneSerializableComponent[];
  41549. /**
  41550. * List of components to register on the next registration step.
  41551. */
  41552. private _transientComponents;
  41553. /**
  41554. * Registers the transient components if needed.
  41555. */
  41556. private _registerTransientComponents;
  41557. /**
  41558. * @hidden
  41559. * Add a component to the scene.
  41560. * Note that the ccomponent could be registered on th next frame if this is called after
  41561. * the register component stage.
  41562. * @param component Defines the component to add to the scene
  41563. */
  41564. _addComponent(component: ISceneComponent): void;
  41565. /**
  41566. * @hidden
  41567. * Gets a component from the scene.
  41568. * @param name defines the name of the component to retrieve
  41569. * @returns the component or null if not present
  41570. */
  41571. _getComponent(name: string): Nullable<ISceneComponent>;
  41572. /**
  41573. * @hidden
  41574. * Defines the actions happening before camera updates.
  41575. */
  41576. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  41577. /**
  41578. * @hidden
  41579. * Defines the actions happening before clear the canvas.
  41580. */
  41581. _beforeClearStage: Stage<SimpleStageAction>;
  41582. /**
  41583. * @hidden
  41584. * Defines the actions when collecting render targets for the frame.
  41585. */
  41586. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41587. /**
  41588. * @hidden
  41589. * Defines the actions happening for one camera in the frame.
  41590. */
  41591. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41592. /**
  41593. * @hidden
  41594. * Defines the actions happening during the per mesh ready checks.
  41595. */
  41596. _isReadyForMeshStage: Stage<MeshStageAction>;
  41597. /**
  41598. * @hidden
  41599. * Defines the actions happening before evaluate active mesh checks.
  41600. */
  41601. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  41602. /**
  41603. * @hidden
  41604. * Defines the actions happening during the evaluate sub mesh checks.
  41605. */
  41606. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  41607. /**
  41608. * @hidden
  41609. * Defines the actions happening during the active mesh stage.
  41610. */
  41611. _activeMeshStage: Stage<ActiveMeshStageAction>;
  41612. /**
  41613. * @hidden
  41614. * Defines the actions happening during the per camera render target step.
  41615. */
  41616. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  41617. /**
  41618. * @hidden
  41619. * Defines the actions happening just before the active camera is drawing.
  41620. */
  41621. _beforeCameraDrawStage: Stage<CameraStageAction>;
  41622. /**
  41623. * @hidden
  41624. * Defines the actions happening just before a render target is drawing.
  41625. */
  41626. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41627. /**
  41628. * @hidden
  41629. * Defines the actions happening just before a rendering group is drawing.
  41630. */
  41631. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41632. /**
  41633. * @hidden
  41634. * Defines the actions happening just before a mesh is drawing.
  41635. */
  41636. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41637. /**
  41638. * @hidden
  41639. * Defines the actions happening just after a mesh has been drawn.
  41640. */
  41641. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41642. /**
  41643. * @hidden
  41644. * Defines the actions happening just after a rendering group has been drawn.
  41645. */
  41646. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41647. /**
  41648. * @hidden
  41649. * Defines the actions happening just after the active camera has been drawn.
  41650. */
  41651. _afterCameraDrawStage: Stage<CameraStageAction>;
  41652. /**
  41653. * @hidden
  41654. * Defines the actions happening just after a render target has been drawn.
  41655. */
  41656. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41657. /**
  41658. * @hidden
  41659. * Defines the actions happening just after rendering all cameras and computing intersections.
  41660. */
  41661. _afterRenderStage: Stage<SimpleStageAction>;
  41662. /**
  41663. * @hidden
  41664. * Defines the actions happening when a pointer move event happens.
  41665. */
  41666. _pointerMoveStage: Stage<PointerMoveStageAction>;
  41667. /**
  41668. * @hidden
  41669. * Defines the actions happening when a pointer down event happens.
  41670. */
  41671. _pointerDownStage: Stage<PointerUpDownStageAction>;
  41672. /**
  41673. * @hidden
  41674. * Defines the actions happening when a pointer up event happens.
  41675. */
  41676. _pointerUpStage: Stage<PointerUpDownStageAction>;
  41677. /**
  41678. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  41679. */
  41680. private geometriesByUniqueId;
  41681. /**
  41682. * Creates a new Scene
  41683. * @param engine defines the engine to use to render this scene
  41684. * @param options defines the scene options
  41685. */
  41686. constructor(engine: Engine, options?: SceneOptions);
  41687. /**
  41688. * Gets a string identifying the name of the class
  41689. * @returns "Scene" string
  41690. */
  41691. getClassName(): string;
  41692. private _defaultMeshCandidates;
  41693. /**
  41694. * @hidden
  41695. */
  41696. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  41697. private _defaultSubMeshCandidates;
  41698. /**
  41699. * @hidden
  41700. */
  41701. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  41702. /**
  41703. * Sets the default candidate providers for the scene.
  41704. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  41705. * and getCollidingSubMeshCandidates to their default function
  41706. */
  41707. setDefaultCandidateProviders(): void;
  41708. /**
  41709. * Gets the mesh that is currently under the pointer
  41710. */
  41711. get meshUnderPointer(): Nullable<AbstractMesh>;
  41712. /**
  41713. * Gets or sets the current on-screen X position of the pointer
  41714. */
  41715. get pointerX(): number;
  41716. set pointerX(value: number);
  41717. /**
  41718. * Gets or sets the current on-screen Y position of the pointer
  41719. */
  41720. get pointerY(): number;
  41721. set pointerY(value: number);
  41722. /**
  41723. * Gets the cached material (ie. the latest rendered one)
  41724. * @returns the cached material
  41725. */
  41726. getCachedMaterial(): Nullable<Material>;
  41727. /**
  41728. * Gets the cached effect (ie. the latest rendered one)
  41729. * @returns the cached effect
  41730. */
  41731. getCachedEffect(): Nullable<Effect>;
  41732. /**
  41733. * Gets the cached visibility state (ie. the latest rendered one)
  41734. * @returns the cached visibility state
  41735. */
  41736. getCachedVisibility(): Nullable<number>;
  41737. /**
  41738. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  41739. * @param material defines the current material
  41740. * @param effect defines the current effect
  41741. * @param visibility defines the current visibility state
  41742. * @returns true if one parameter is not cached
  41743. */
  41744. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  41745. /**
  41746. * Gets the engine associated with the scene
  41747. * @returns an Engine
  41748. */
  41749. getEngine(): Engine;
  41750. /**
  41751. * Gets the total number of vertices rendered per frame
  41752. * @returns the total number of vertices rendered per frame
  41753. */
  41754. getTotalVertices(): number;
  41755. /**
  41756. * Gets the performance counter for total vertices
  41757. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41758. */
  41759. get totalVerticesPerfCounter(): PerfCounter;
  41760. /**
  41761. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  41762. * @returns the total number of active indices rendered per frame
  41763. */
  41764. getActiveIndices(): number;
  41765. /**
  41766. * Gets the performance counter for active indices
  41767. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41768. */
  41769. get totalActiveIndicesPerfCounter(): PerfCounter;
  41770. /**
  41771. * Gets the total number of active particles rendered per frame
  41772. * @returns the total number of active particles rendered per frame
  41773. */
  41774. getActiveParticles(): number;
  41775. /**
  41776. * Gets the performance counter for active particles
  41777. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41778. */
  41779. get activeParticlesPerfCounter(): PerfCounter;
  41780. /**
  41781. * Gets the total number of active bones rendered per frame
  41782. * @returns the total number of active bones rendered per frame
  41783. */
  41784. getActiveBones(): number;
  41785. /**
  41786. * Gets the performance counter for active bones
  41787. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41788. */
  41789. get activeBonesPerfCounter(): PerfCounter;
  41790. /**
  41791. * Gets the array of active meshes
  41792. * @returns an array of AbstractMesh
  41793. */
  41794. getActiveMeshes(): SmartArray<AbstractMesh>;
  41795. /**
  41796. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  41797. * @returns a number
  41798. */
  41799. getAnimationRatio(): number;
  41800. /**
  41801. * Gets an unique Id for the current render phase
  41802. * @returns a number
  41803. */
  41804. getRenderId(): number;
  41805. /**
  41806. * Gets an unique Id for the current frame
  41807. * @returns a number
  41808. */
  41809. getFrameId(): number;
  41810. /** Call this function if you want to manually increment the render Id*/
  41811. incrementRenderId(): void;
  41812. private _createUbo;
  41813. /**
  41814. * Use this method to simulate a pointer move on a mesh
  41815. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41816. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41817. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41818. * @returns the current scene
  41819. */
  41820. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41821. /**
  41822. * Use this method to simulate a pointer down on a mesh
  41823. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41824. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41825. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41826. * @returns the current scene
  41827. */
  41828. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41829. /**
  41830. * Use this method to simulate a pointer up on a mesh
  41831. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41832. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41833. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41834. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  41835. * @returns the current scene
  41836. */
  41837. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  41838. /**
  41839. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  41840. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  41841. * @returns true if the pointer was captured
  41842. */
  41843. isPointerCaptured(pointerId?: number): boolean;
  41844. /**
  41845. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  41846. * @param attachUp defines if you want to attach events to pointerup
  41847. * @param attachDown defines if you want to attach events to pointerdown
  41848. * @param attachMove defines if you want to attach events to pointermove
  41849. */
  41850. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  41851. /** Detaches all event handlers*/
  41852. detachControl(): void;
  41853. /**
  41854. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  41855. * Delay loaded resources are not taking in account
  41856. * @return true if all required resources are ready
  41857. */
  41858. isReady(): boolean;
  41859. /** Resets all cached information relative to material (including effect and visibility) */
  41860. resetCachedMaterial(): void;
  41861. /**
  41862. * Registers a function to be called before every frame render
  41863. * @param func defines the function to register
  41864. */
  41865. registerBeforeRender(func: () => void): void;
  41866. /**
  41867. * Unregisters a function called before every frame render
  41868. * @param func defines the function to unregister
  41869. */
  41870. unregisterBeforeRender(func: () => void): void;
  41871. /**
  41872. * Registers a function to be called after every frame render
  41873. * @param func defines the function to register
  41874. */
  41875. registerAfterRender(func: () => void): void;
  41876. /**
  41877. * Unregisters a function called after every frame render
  41878. * @param func defines the function to unregister
  41879. */
  41880. unregisterAfterRender(func: () => void): void;
  41881. private _executeOnceBeforeRender;
  41882. /**
  41883. * The provided function will run before render once and will be disposed afterwards.
  41884. * A timeout delay can be provided so that the function will be executed in N ms.
  41885. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  41886. * @param func The function to be executed.
  41887. * @param timeout optional delay in ms
  41888. */
  41889. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  41890. /** @hidden */
  41891. _addPendingData(data: any): void;
  41892. /** @hidden */
  41893. _removePendingData(data: any): void;
  41894. /**
  41895. * Returns the number of items waiting to be loaded
  41896. * @returns the number of items waiting to be loaded
  41897. */
  41898. getWaitingItemsCount(): number;
  41899. /**
  41900. * Returns a boolean indicating if the scene is still loading data
  41901. */
  41902. get isLoading(): boolean;
  41903. /**
  41904. * Registers a function to be executed when the scene is ready
  41905. * @param {Function} func - the function to be executed
  41906. */
  41907. executeWhenReady(func: () => void): void;
  41908. /**
  41909. * Returns a promise that resolves when the scene is ready
  41910. * @returns A promise that resolves when the scene is ready
  41911. */
  41912. whenReadyAsync(): Promise<void>;
  41913. /** @hidden */
  41914. _checkIsReady(): void;
  41915. /**
  41916. * Gets all animatable attached to the scene
  41917. */
  41918. get animatables(): Animatable[];
  41919. /**
  41920. * Resets the last animation time frame.
  41921. * Useful to override when animations start running when loading a scene for the first time.
  41922. */
  41923. resetLastAnimationTimeFrame(): void;
  41924. /**
  41925. * Gets the current view matrix
  41926. * @returns a Matrix
  41927. */
  41928. getViewMatrix(): Matrix;
  41929. /**
  41930. * Gets the current projection matrix
  41931. * @returns a Matrix
  41932. */
  41933. getProjectionMatrix(): Matrix;
  41934. /**
  41935. * Gets the current transform matrix
  41936. * @returns a Matrix made of View * Projection
  41937. */
  41938. getTransformMatrix(): Matrix;
  41939. /**
  41940. * Sets the current transform matrix
  41941. * @param viewL defines the View matrix to use
  41942. * @param projectionL defines the Projection matrix to use
  41943. * @param viewR defines the right View matrix to use (if provided)
  41944. * @param projectionR defines the right Projection matrix to use (if provided)
  41945. */
  41946. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  41947. /**
  41948. * Gets the uniform buffer used to store scene data
  41949. * @returns a UniformBuffer
  41950. */
  41951. getSceneUniformBuffer(): UniformBuffer;
  41952. /**
  41953. * Gets an unique (relatively to the current scene) Id
  41954. * @returns an unique number for the scene
  41955. */
  41956. getUniqueId(): number;
  41957. /**
  41958. * Add a mesh to the list of scene's meshes
  41959. * @param newMesh defines the mesh to add
  41960. * @param recursive if all child meshes should also be added to the scene
  41961. */
  41962. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  41963. /**
  41964. * Remove a mesh for the list of scene's meshes
  41965. * @param toRemove defines the mesh to remove
  41966. * @param recursive if all child meshes should also be removed from the scene
  41967. * @returns the index where the mesh was in the mesh list
  41968. */
  41969. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  41970. /**
  41971. * Add a transform node to the list of scene's transform nodes
  41972. * @param newTransformNode defines the transform node to add
  41973. */
  41974. addTransformNode(newTransformNode: TransformNode): void;
  41975. /**
  41976. * Remove a transform node for the list of scene's transform nodes
  41977. * @param toRemove defines the transform node to remove
  41978. * @returns the index where the transform node was in the transform node list
  41979. */
  41980. removeTransformNode(toRemove: TransformNode): number;
  41981. /**
  41982. * Remove a skeleton for the list of scene's skeletons
  41983. * @param toRemove defines the skeleton to remove
  41984. * @returns the index where the skeleton was in the skeleton list
  41985. */
  41986. removeSkeleton(toRemove: Skeleton): number;
  41987. /**
  41988. * Remove a morph target for the list of scene's morph targets
  41989. * @param toRemove defines the morph target to remove
  41990. * @returns the index where the morph target was in the morph target list
  41991. */
  41992. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  41993. /**
  41994. * Remove a light for the list of scene's lights
  41995. * @param toRemove defines the light to remove
  41996. * @returns the index where the light was in the light list
  41997. */
  41998. removeLight(toRemove: Light): number;
  41999. /**
  42000. * Remove a camera for the list of scene's cameras
  42001. * @param toRemove defines the camera to remove
  42002. * @returns the index where the camera was in the camera list
  42003. */
  42004. removeCamera(toRemove: Camera): number;
  42005. /**
  42006. * Remove a particle system for the list of scene's particle systems
  42007. * @param toRemove defines the particle system to remove
  42008. * @returns the index where the particle system was in the particle system list
  42009. */
  42010. removeParticleSystem(toRemove: IParticleSystem): number;
  42011. /**
  42012. * Remove a animation for the list of scene's animations
  42013. * @param toRemove defines the animation to remove
  42014. * @returns the index where the animation was in the animation list
  42015. */
  42016. removeAnimation(toRemove: Animation): number;
  42017. /**
  42018. * Will stop the animation of the given target
  42019. * @param target - the target
  42020. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  42021. * @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)
  42022. */
  42023. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  42024. /**
  42025. * Removes the given animation group from this scene.
  42026. * @param toRemove The animation group to remove
  42027. * @returns The index of the removed animation group
  42028. */
  42029. removeAnimationGroup(toRemove: AnimationGroup): number;
  42030. /**
  42031. * Removes the given multi-material from this scene.
  42032. * @param toRemove The multi-material to remove
  42033. * @returns The index of the removed multi-material
  42034. */
  42035. removeMultiMaterial(toRemove: MultiMaterial): number;
  42036. /**
  42037. * Removes the given material from this scene.
  42038. * @param toRemove The material to remove
  42039. * @returns The index of the removed material
  42040. */
  42041. removeMaterial(toRemove: Material): number;
  42042. /**
  42043. * Removes the given action manager from this scene.
  42044. * @param toRemove The action manager to remove
  42045. * @returns The index of the removed action manager
  42046. */
  42047. removeActionManager(toRemove: AbstractActionManager): number;
  42048. /**
  42049. * Removes the given texture from this scene.
  42050. * @param toRemove The texture to remove
  42051. * @returns The index of the removed texture
  42052. */
  42053. removeTexture(toRemove: BaseTexture): number;
  42054. /**
  42055. * Adds the given light to this scene
  42056. * @param newLight The light to add
  42057. */
  42058. addLight(newLight: Light): void;
  42059. /**
  42060. * Sorts the list list based on light priorities
  42061. */
  42062. sortLightsByPriority(): void;
  42063. /**
  42064. * Adds the given camera to this scene
  42065. * @param newCamera The camera to add
  42066. */
  42067. addCamera(newCamera: Camera): void;
  42068. /**
  42069. * Adds the given skeleton to this scene
  42070. * @param newSkeleton The skeleton to add
  42071. */
  42072. addSkeleton(newSkeleton: Skeleton): void;
  42073. /**
  42074. * Adds the given particle system to this scene
  42075. * @param newParticleSystem The particle system to add
  42076. */
  42077. addParticleSystem(newParticleSystem: IParticleSystem): void;
  42078. /**
  42079. * Adds the given animation to this scene
  42080. * @param newAnimation The animation to add
  42081. */
  42082. addAnimation(newAnimation: Animation): void;
  42083. /**
  42084. * Adds the given animation group to this scene.
  42085. * @param newAnimationGroup The animation group to add
  42086. */
  42087. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  42088. /**
  42089. * Adds the given multi-material to this scene
  42090. * @param newMultiMaterial The multi-material to add
  42091. */
  42092. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  42093. /**
  42094. * Adds the given material to this scene
  42095. * @param newMaterial The material to add
  42096. */
  42097. addMaterial(newMaterial: Material): void;
  42098. /**
  42099. * Adds the given morph target to this scene
  42100. * @param newMorphTargetManager The morph target to add
  42101. */
  42102. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  42103. /**
  42104. * Adds the given geometry to this scene
  42105. * @param newGeometry The geometry to add
  42106. */
  42107. addGeometry(newGeometry: Geometry): void;
  42108. /**
  42109. * Adds the given action manager to this scene
  42110. * @param newActionManager The action manager to add
  42111. */
  42112. addActionManager(newActionManager: AbstractActionManager): void;
  42113. /**
  42114. * Adds the given texture to this scene.
  42115. * @param newTexture The texture to add
  42116. */
  42117. addTexture(newTexture: BaseTexture): void;
  42118. /**
  42119. * Switch active camera
  42120. * @param newCamera defines the new active camera
  42121. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  42122. */
  42123. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  42124. /**
  42125. * sets the active camera of the scene using its ID
  42126. * @param id defines the camera's ID
  42127. * @return the new active camera or null if none found.
  42128. */
  42129. setActiveCameraByID(id: string): Nullable<Camera>;
  42130. /**
  42131. * sets the active camera of the scene using its name
  42132. * @param name defines the camera's name
  42133. * @returns the new active camera or null if none found.
  42134. */
  42135. setActiveCameraByName(name: string): Nullable<Camera>;
  42136. /**
  42137. * get an animation group using its name
  42138. * @param name defines the material's name
  42139. * @return the animation group or null if none found.
  42140. */
  42141. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  42142. /**
  42143. * Get a material using its unique id
  42144. * @param uniqueId defines the material's unique id
  42145. * @return the material or null if none found.
  42146. */
  42147. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  42148. /**
  42149. * get a material using its id
  42150. * @param id defines the material's ID
  42151. * @return the material or null if none found.
  42152. */
  42153. getMaterialByID(id: string): Nullable<Material>;
  42154. /**
  42155. * Gets a the last added material using a given id
  42156. * @param id defines the material's ID
  42157. * @return the last material with the given id or null if none found.
  42158. */
  42159. getLastMaterialByID(id: string): Nullable<Material>;
  42160. /**
  42161. * Gets a material using its name
  42162. * @param name defines the material's name
  42163. * @return the material or null if none found.
  42164. */
  42165. getMaterialByName(name: string): Nullable<Material>;
  42166. /**
  42167. * Get a texture using its unique id
  42168. * @param uniqueId defines the texture's unique id
  42169. * @return the texture or null if none found.
  42170. */
  42171. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  42172. /**
  42173. * Gets a camera using its id
  42174. * @param id defines the id to look for
  42175. * @returns the camera or null if not found
  42176. */
  42177. getCameraByID(id: string): Nullable<Camera>;
  42178. /**
  42179. * Gets a camera using its unique id
  42180. * @param uniqueId defines the unique id to look for
  42181. * @returns the camera or null if not found
  42182. */
  42183. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  42184. /**
  42185. * Gets a camera using its name
  42186. * @param name defines the camera's name
  42187. * @return the camera or null if none found.
  42188. */
  42189. getCameraByName(name: string): Nullable<Camera>;
  42190. /**
  42191. * Gets a bone using its id
  42192. * @param id defines the bone's id
  42193. * @return the bone or null if not found
  42194. */
  42195. getBoneByID(id: string): Nullable<Bone>;
  42196. /**
  42197. * Gets a bone using its id
  42198. * @param name defines the bone's name
  42199. * @return the bone or null if not found
  42200. */
  42201. getBoneByName(name: string): Nullable<Bone>;
  42202. /**
  42203. * Gets a light node using its name
  42204. * @param name defines the the light's name
  42205. * @return the light or null if none found.
  42206. */
  42207. getLightByName(name: string): Nullable<Light>;
  42208. /**
  42209. * Gets a light node using its id
  42210. * @param id defines the light's id
  42211. * @return the light or null if none found.
  42212. */
  42213. getLightByID(id: string): Nullable<Light>;
  42214. /**
  42215. * Gets a light node using its scene-generated unique ID
  42216. * @param uniqueId defines the light's unique id
  42217. * @return the light or null if none found.
  42218. */
  42219. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  42220. /**
  42221. * Gets a particle system by id
  42222. * @param id defines the particle system id
  42223. * @return the corresponding system or null if none found
  42224. */
  42225. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  42226. /**
  42227. * Gets a geometry using its ID
  42228. * @param id defines the geometry's id
  42229. * @return the geometry or null if none found.
  42230. */
  42231. getGeometryByID(id: string): Nullable<Geometry>;
  42232. private _getGeometryByUniqueID;
  42233. /**
  42234. * Add a new geometry to this scene
  42235. * @param geometry defines the geometry to be added to the scene.
  42236. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  42237. * @return a boolean defining if the geometry was added or not
  42238. */
  42239. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  42240. /**
  42241. * Removes an existing geometry
  42242. * @param geometry defines the geometry to be removed from the scene
  42243. * @return a boolean defining if the geometry was removed or not
  42244. */
  42245. removeGeometry(geometry: Geometry): boolean;
  42246. /**
  42247. * Gets the list of geometries attached to the scene
  42248. * @returns an array of Geometry
  42249. */
  42250. getGeometries(): Geometry[];
  42251. /**
  42252. * Gets the first added mesh found of a given ID
  42253. * @param id defines the id to search for
  42254. * @return the mesh found or null if not found at all
  42255. */
  42256. getMeshByID(id: string): Nullable<AbstractMesh>;
  42257. /**
  42258. * Gets a list of meshes using their id
  42259. * @param id defines the id to search for
  42260. * @returns a list of meshes
  42261. */
  42262. getMeshesByID(id: string): Array<AbstractMesh>;
  42263. /**
  42264. * Gets the first added transform node found of a given ID
  42265. * @param id defines the id to search for
  42266. * @return the found transform node or null if not found at all.
  42267. */
  42268. getTransformNodeByID(id: string): Nullable<TransformNode>;
  42269. /**
  42270. * Gets a transform node with its auto-generated unique id
  42271. * @param uniqueId efines the unique id to search for
  42272. * @return the found transform node or null if not found at all.
  42273. */
  42274. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  42275. /**
  42276. * Gets a list of transform nodes using their id
  42277. * @param id defines the id to search for
  42278. * @returns a list of transform nodes
  42279. */
  42280. getTransformNodesByID(id: string): Array<TransformNode>;
  42281. /**
  42282. * Gets a mesh with its auto-generated unique id
  42283. * @param uniqueId defines the unique id to search for
  42284. * @return the found mesh or null if not found at all.
  42285. */
  42286. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  42287. /**
  42288. * Gets a the last added mesh using a given id
  42289. * @param id defines the id to search for
  42290. * @return the found mesh or null if not found at all.
  42291. */
  42292. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  42293. /**
  42294. * Gets a the last added node (Mesh, Camera, Light) using a given id
  42295. * @param id defines the id to search for
  42296. * @return the found node or null if not found at all
  42297. */
  42298. getLastEntryByID(id: string): Nullable<Node>;
  42299. /**
  42300. * Gets a node (Mesh, Camera, Light) using a given id
  42301. * @param id defines the id to search for
  42302. * @return the found node or null if not found at all
  42303. */
  42304. getNodeByID(id: string): Nullable<Node>;
  42305. /**
  42306. * Gets a node (Mesh, Camera, Light) using a given name
  42307. * @param name defines the name to search for
  42308. * @return the found node or null if not found at all.
  42309. */
  42310. getNodeByName(name: string): Nullable<Node>;
  42311. /**
  42312. * Gets a mesh using a given name
  42313. * @param name defines the name to search for
  42314. * @return the found mesh or null if not found at all.
  42315. */
  42316. getMeshByName(name: string): Nullable<AbstractMesh>;
  42317. /**
  42318. * Gets a transform node using a given name
  42319. * @param name defines the name to search for
  42320. * @return the found transform node or null if not found at all.
  42321. */
  42322. getTransformNodeByName(name: string): Nullable<TransformNode>;
  42323. /**
  42324. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  42325. * @param id defines the id to search for
  42326. * @return the found skeleton or null if not found at all.
  42327. */
  42328. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  42329. /**
  42330. * Gets a skeleton using a given auto generated unique id
  42331. * @param uniqueId defines the unique id to search for
  42332. * @return the found skeleton or null if not found at all.
  42333. */
  42334. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  42335. /**
  42336. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  42337. * @param id defines the id to search for
  42338. * @return the found skeleton or null if not found at all.
  42339. */
  42340. getSkeletonById(id: string): Nullable<Skeleton>;
  42341. /**
  42342. * Gets a skeleton using a given name
  42343. * @param name defines the name to search for
  42344. * @return the found skeleton or null if not found at all.
  42345. */
  42346. getSkeletonByName(name: string): Nullable<Skeleton>;
  42347. /**
  42348. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  42349. * @param id defines the id to search for
  42350. * @return the found morph target manager or null if not found at all.
  42351. */
  42352. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  42353. /**
  42354. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  42355. * @param id defines the id to search for
  42356. * @return the found morph target or null if not found at all.
  42357. */
  42358. getMorphTargetById(id: string): Nullable<MorphTarget>;
  42359. /**
  42360. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  42361. * @param name defines the name to search for
  42362. * @return the found morph target or null if not found at all.
  42363. */
  42364. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  42365. /**
  42366. * Gets a post process using a given name (if many are found, this function will pick the first one)
  42367. * @param name defines the name to search for
  42368. * @return the found post process or null if not found at all.
  42369. */
  42370. getPostProcessByName(name: string): Nullable<PostProcess>;
  42371. /**
  42372. * Gets a boolean indicating if the given mesh is active
  42373. * @param mesh defines the mesh to look for
  42374. * @returns true if the mesh is in the active list
  42375. */
  42376. isActiveMesh(mesh: AbstractMesh): boolean;
  42377. /**
  42378. * Return a unique id as a string which can serve as an identifier for the scene
  42379. */
  42380. get uid(): string;
  42381. /**
  42382. * Add an externaly attached data from its key.
  42383. * This method call will fail and return false, if such key already exists.
  42384. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  42385. * @param key the unique key that identifies the data
  42386. * @param data the data object to associate to the key for this Engine instance
  42387. * @return true if no such key were already present and the data was added successfully, false otherwise
  42388. */
  42389. addExternalData<T>(key: string, data: T): boolean;
  42390. /**
  42391. * Get an externaly attached data from its key
  42392. * @param key the unique key that identifies the data
  42393. * @return the associated data, if present (can be null), or undefined if not present
  42394. */
  42395. getExternalData<T>(key: string): Nullable<T>;
  42396. /**
  42397. * Get an externaly attached data from its key, create it using a factory if it's not already present
  42398. * @param key the unique key that identifies the data
  42399. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  42400. * @return the associated data, can be null if the factory returned null.
  42401. */
  42402. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  42403. /**
  42404. * Remove an externaly attached data from the Engine instance
  42405. * @param key the unique key that identifies the data
  42406. * @return true if the data was successfully removed, false if it doesn't exist
  42407. */
  42408. removeExternalData(key: string): boolean;
  42409. private _evaluateSubMesh;
  42410. /**
  42411. * Clear the processed materials smart array preventing retention point in material dispose.
  42412. */
  42413. freeProcessedMaterials(): void;
  42414. private _preventFreeActiveMeshesAndRenderingGroups;
  42415. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  42416. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  42417. * when disposing several meshes in a row or a hierarchy of meshes.
  42418. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  42419. */
  42420. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  42421. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  42422. /**
  42423. * Clear the active meshes smart array preventing retention point in mesh dispose.
  42424. */
  42425. freeActiveMeshes(): void;
  42426. /**
  42427. * Clear the info related to rendering groups preventing retention points during dispose.
  42428. */
  42429. freeRenderingGroups(): void;
  42430. /** @hidden */
  42431. _isInIntermediateRendering(): boolean;
  42432. /**
  42433. * Lambda returning the list of potentially active meshes.
  42434. */
  42435. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  42436. /**
  42437. * Lambda returning the list of potentially active sub meshes.
  42438. */
  42439. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  42440. /**
  42441. * Lambda returning the list of potentially intersecting sub meshes.
  42442. */
  42443. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  42444. /**
  42445. * Lambda returning the list of potentially colliding sub meshes.
  42446. */
  42447. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  42448. private _activeMeshesFrozen;
  42449. private _skipEvaluateActiveMeshesCompletely;
  42450. /**
  42451. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  42452. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  42453. * @returns the current scene
  42454. */
  42455. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  42456. /**
  42457. * Use this function to restart evaluating active meshes on every frame
  42458. * @returns the current scene
  42459. */
  42460. unfreezeActiveMeshes(): Scene;
  42461. private _evaluateActiveMeshes;
  42462. private _activeMesh;
  42463. /**
  42464. * Update the transform matrix to update from the current active camera
  42465. * @param force defines a boolean used to force the update even if cache is up to date
  42466. */
  42467. updateTransformMatrix(force?: boolean): void;
  42468. private _bindFrameBuffer;
  42469. /** @hidden */
  42470. _allowPostProcessClearColor: boolean;
  42471. /** @hidden */
  42472. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  42473. private _processSubCameras;
  42474. private _checkIntersections;
  42475. /** @hidden */
  42476. _advancePhysicsEngineStep(step: number): void;
  42477. /**
  42478. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  42479. */
  42480. getDeterministicFrameTime: () => number;
  42481. /** @hidden */
  42482. _animate(): void;
  42483. /** Execute all animations (for a frame) */
  42484. animate(): void;
  42485. /**
  42486. * Render the scene
  42487. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  42488. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  42489. */
  42490. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  42491. /**
  42492. * Freeze all materials
  42493. * A frozen material will not be updatable but should be faster to render
  42494. */
  42495. freezeMaterials(): void;
  42496. /**
  42497. * Unfreeze all materials
  42498. * A frozen material will not be updatable but should be faster to render
  42499. */
  42500. unfreezeMaterials(): void;
  42501. /**
  42502. * Releases all held ressources
  42503. */
  42504. dispose(): void;
  42505. /**
  42506. * Gets if the scene is already disposed
  42507. */
  42508. get isDisposed(): boolean;
  42509. /**
  42510. * Call this function to reduce memory footprint of the scene.
  42511. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  42512. */
  42513. clearCachedVertexData(): void;
  42514. /**
  42515. * This function will remove the local cached buffer data from texture.
  42516. * It will save memory but will prevent the texture from being rebuilt
  42517. */
  42518. cleanCachedTextureBuffer(): void;
  42519. /**
  42520. * Get the world extend vectors with an optional filter
  42521. *
  42522. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  42523. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  42524. */
  42525. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  42526. min: Vector3;
  42527. max: Vector3;
  42528. };
  42529. /**
  42530. * Creates a ray that can be used to pick in the scene
  42531. * @param x defines the x coordinate of the origin (on-screen)
  42532. * @param y defines the y coordinate of the origin (on-screen)
  42533. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42534. * @param camera defines the camera to use for the picking
  42535. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42536. * @returns a Ray
  42537. */
  42538. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  42539. /**
  42540. * Creates a ray that can be used to pick in the scene
  42541. * @param x defines the x coordinate of the origin (on-screen)
  42542. * @param y defines the y coordinate of the origin (on-screen)
  42543. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42544. * @param result defines the ray where to store the picking ray
  42545. * @param camera defines the camera to use for the picking
  42546. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42547. * @returns the current scene
  42548. */
  42549. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  42550. /**
  42551. * Creates a ray that can be used to pick in the scene
  42552. * @param x defines the x coordinate of the origin (on-screen)
  42553. * @param y defines the y coordinate of the origin (on-screen)
  42554. * @param camera defines the camera to use for the picking
  42555. * @returns a Ray
  42556. */
  42557. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  42558. /**
  42559. * Creates a ray that can be used to pick in the scene
  42560. * @param x defines the x coordinate of the origin (on-screen)
  42561. * @param y defines the y coordinate of the origin (on-screen)
  42562. * @param result defines the ray where to store the picking ray
  42563. * @param camera defines the camera to use for the picking
  42564. * @returns the current scene
  42565. */
  42566. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  42567. /** Launch a ray to try to pick a mesh in the scene
  42568. * @param x position on screen
  42569. * @param y position on screen
  42570. * @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
  42571. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42572. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42573. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42574. * @returns a PickingInfo
  42575. */
  42576. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42577. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  42578. * @param x position on screen
  42579. * @param y position on screen
  42580. * @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
  42581. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42582. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42583. * @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)
  42584. */
  42585. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  42586. /** Use the given ray to pick a mesh in the scene
  42587. * @param ray The ray to use to pick meshes
  42588. * @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
  42589. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42590. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42591. * @returns a PickingInfo
  42592. */
  42593. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42594. /**
  42595. * Launch a ray to try to pick a mesh in the scene
  42596. * @param x X position on screen
  42597. * @param y Y position on screen
  42598. * @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
  42599. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42600. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42601. * @returns an array of PickingInfo
  42602. */
  42603. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42604. /**
  42605. * Launch a ray to try to pick a mesh in the scene
  42606. * @param ray Ray to use
  42607. * @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
  42608. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42609. * @returns an array of PickingInfo
  42610. */
  42611. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42612. /**
  42613. * Force the value of meshUnderPointer
  42614. * @param mesh defines the mesh to use
  42615. * @param pointerId optional pointer id when using more than one pointer
  42616. */
  42617. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  42618. /**
  42619. * Gets the mesh under the pointer
  42620. * @returns a Mesh or null if no mesh is under the pointer
  42621. */
  42622. getPointerOverMesh(): Nullable<AbstractMesh>;
  42623. /** @hidden */
  42624. _rebuildGeometries(): void;
  42625. /** @hidden */
  42626. _rebuildTextures(): void;
  42627. private _getByTags;
  42628. /**
  42629. * Get a list of meshes by tags
  42630. * @param tagsQuery defines the tags query to use
  42631. * @param forEach defines a predicate used to filter results
  42632. * @returns an array of Mesh
  42633. */
  42634. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  42635. /**
  42636. * Get a list of cameras by tags
  42637. * @param tagsQuery defines the tags query to use
  42638. * @param forEach defines a predicate used to filter results
  42639. * @returns an array of Camera
  42640. */
  42641. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  42642. /**
  42643. * Get a list of lights by tags
  42644. * @param tagsQuery defines the tags query to use
  42645. * @param forEach defines a predicate used to filter results
  42646. * @returns an array of Light
  42647. */
  42648. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  42649. /**
  42650. * Get a list of materials by tags
  42651. * @param tagsQuery defines the tags query to use
  42652. * @param forEach defines a predicate used to filter results
  42653. * @returns an array of Material
  42654. */
  42655. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  42656. /**
  42657. * Get a list of transform nodes by tags
  42658. * @param tagsQuery defines the tags query to use
  42659. * @param forEach defines a predicate used to filter results
  42660. * @returns an array of TransformNode
  42661. */
  42662. getTransformNodesByTags(tagsQuery: string, forEach?: (transform: TransformNode) => void): TransformNode[];
  42663. /**
  42664. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  42665. * This allowed control for front to back rendering or reversly depending of the special needs.
  42666. *
  42667. * @param renderingGroupId The rendering group id corresponding to its index
  42668. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  42669. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  42670. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  42671. */
  42672. 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;
  42673. /**
  42674. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  42675. *
  42676. * @param renderingGroupId The rendering group id corresponding to its index
  42677. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  42678. * @param depth Automatically clears depth between groups if true and autoClear is true.
  42679. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  42680. */
  42681. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  42682. /**
  42683. * Gets the current auto clear configuration for one rendering group of the rendering
  42684. * manager.
  42685. * @param index the rendering group index to get the information for
  42686. * @returns The auto clear setup for the requested rendering group
  42687. */
  42688. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  42689. private _blockMaterialDirtyMechanism;
  42690. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  42691. get blockMaterialDirtyMechanism(): boolean;
  42692. set blockMaterialDirtyMechanism(value: boolean);
  42693. /**
  42694. * Will flag all materials as dirty to trigger new shader compilation
  42695. * @param flag defines the flag used to specify which material part must be marked as dirty
  42696. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  42697. */
  42698. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  42699. /** @hidden */
  42700. _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;
  42701. /** @hidden */
  42702. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42703. /** @hidden */
  42704. _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;
  42705. /** @hidden */
  42706. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  42707. /** @hidden */
  42708. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  42709. /** @hidden */
  42710. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42711. }
  42712. }
  42713. declare module "babylonjs/assetContainer" {
  42714. import { AbstractScene } from "babylonjs/abstractScene";
  42715. import { Scene } from "babylonjs/scene";
  42716. import { Mesh } from "babylonjs/Meshes/mesh";
  42717. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42718. import { Skeleton } from "babylonjs/Bones/skeleton";
  42719. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42720. import { Animatable } from "babylonjs/Animations/animatable";
  42721. import { Nullable } from "babylonjs/types";
  42722. import { Node } from "babylonjs/node";
  42723. /**
  42724. * Set of assets to keep when moving a scene into an asset container.
  42725. */
  42726. export class KeepAssets extends AbstractScene {
  42727. }
  42728. /**
  42729. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  42730. */
  42731. export class InstantiatedEntries {
  42732. /**
  42733. * List of new root nodes (eg. nodes with no parent)
  42734. */
  42735. rootNodes: TransformNode[];
  42736. /**
  42737. * List of new skeletons
  42738. */
  42739. skeletons: Skeleton[];
  42740. /**
  42741. * List of new animation groups
  42742. */
  42743. animationGroups: AnimationGroup[];
  42744. }
  42745. /**
  42746. * Container with a set of assets that can be added or removed from a scene.
  42747. */
  42748. export class AssetContainer extends AbstractScene {
  42749. private _wasAddedToScene;
  42750. /**
  42751. * The scene the AssetContainer belongs to.
  42752. */
  42753. scene: Scene;
  42754. /**
  42755. * Instantiates an AssetContainer.
  42756. * @param scene The scene the AssetContainer belongs to.
  42757. */
  42758. constructor(scene: Scene);
  42759. /**
  42760. * Instantiate or clone all meshes and add the new ones to the scene.
  42761. * Skeletons and animation groups will all be cloned
  42762. * @param nameFunction defines an optional function used to get new names for clones
  42763. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  42764. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  42765. */
  42766. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  42767. /**
  42768. * Adds all the assets from the container to the scene.
  42769. */
  42770. addAllToScene(): void;
  42771. /**
  42772. * Removes all the assets in the container from the scene
  42773. */
  42774. removeAllFromScene(): void;
  42775. /**
  42776. * Disposes all the assets in the container
  42777. */
  42778. dispose(): void;
  42779. private _moveAssets;
  42780. /**
  42781. * Removes all the assets contained in the scene and adds them to the container.
  42782. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  42783. */
  42784. moveAllFromScene(keepAssets?: KeepAssets): void;
  42785. /**
  42786. * 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.
  42787. * @returns the root mesh
  42788. */
  42789. createRootMesh(): Mesh;
  42790. /**
  42791. * Merge animations (direct and animation groups) from this asset container into a scene
  42792. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  42793. * @param animatables set of animatables to retarget to a node from the scene
  42794. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  42795. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  42796. */
  42797. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  42798. }
  42799. }
  42800. declare module "babylonjs/abstractScene" {
  42801. import { Scene } from "babylonjs/scene";
  42802. import { Nullable } from "babylonjs/types";
  42803. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42804. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42805. import { Geometry } from "babylonjs/Meshes/geometry";
  42806. import { Skeleton } from "babylonjs/Bones/skeleton";
  42807. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  42808. import { AssetContainer } from "babylonjs/assetContainer";
  42809. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  42810. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42811. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  42812. import { Material } from "babylonjs/Materials/material";
  42813. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  42814. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  42815. import { Camera } from "babylonjs/Cameras/camera";
  42816. import { Light } from "babylonjs/Lights/light";
  42817. import { Node } from "babylonjs/node";
  42818. import { Animation } from "babylonjs/Animations/animation";
  42819. /**
  42820. * Defines how the parser contract is defined.
  42821. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  42822. */
  42823. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  42824. /**
  42825. * Defines how the individual parser contract is defined.
  42826. * These parser can parse an individual asset
  42827. */
  42828. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  42829. /**
  42830. * Base class of the scene acting as a container for the different elements composing a scene.
  42831. * This class is dynamically extended by the different components of the scene increasing
  42832. * flexibility and reducing coupling
  42833. */
  42834. export abstract class AbstractScene {
  42835. /**
  42836. * Stores the list of available parsers in the application.
  42837. */
  42838. private static _BabylonFileParsers;
  42839. /**
  42840. * Stores the list of available individual parsers in the application.
  42841. */
  42842. private static _IndividualBabylonFileParsers;
  42843. /**
  42844. * Adds a parser in the list of available ones
  42845. * @param name Defines the name of the parser
  42846. * @param parser Defines the parser to add
  42847. */
  42848. static AddParser(name: string, parser: BabylonFileParser): void;
  42849. /**
  42850. * Gets a general parser from the list of avaialble ones
  42851. * @param name Defines the name of the parser
  42852. * @returns the requested parser or null
  42853. */
  42854. static GetParser(name: string): Nullable<BabylonFileParser>;
  42855. /**
  42856. * Adds n individual parser in the list of available ones
  42857. * @param name Defines the name of the parser
  42858. * @param parser Defines the parser to add
  42859. */
  42860. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  42861. /**
  42862. * Gets an individual parser from the list of avaialble ones
  42863. * @param name Defines the name of the parser
  42864. * @returns the requested parser or null
  42865. */
  42866. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  42867. /**
  42868. * Parser json data and populate both a scene and its associated container object
  42869. * @param jsonData Defines the data to parse
  42870. * @param scene Defines the scene to parse the data for
  42871. * @param container Defines the container attached to the parsing sequence
  42872. * @param rootUrl Defines the root url of the data
  42873. */
  42874. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  42875. /**
  42876. * Gets the list of root nodes (ie. nodes with no parent)
  42877. */
  42878. rootNodes: Node[];
  42879. /** All of the cameras added to this scene
  42880. * @see https://doc.babylonjs.com/babylon101/cameras
  42881. */
  42882. cameras: Camera[];
  42883. /**
  42884. * All of the lights added to this scene
  42885. * @see https://doc.babylonjs.com/babylon101/lights
  42886. */
  42887. lights: Light[];
  42888. /**
  42889. * All of the (abstract) meshes added to this scene
  42890. */
  42891. meshes: AbstractMesh[];
  42892. /**
  42893. * The list of skeletons added to the scene
  42894. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  42895. */
  42896. skeletons: Skeleton[];
  42897. /**
  42898. * All of the particle systems added to this scene
  42899. * @see https://doc.babylonjs.com/babylon101/particles
  42900. */
  42901. particleSystems: IParticleSystem[];
  42902. /**
  42903. * Gets a list of Animations associated with the scene
  42904. */
  42905. animations: Animation[];
  42906. /**
  42907. * All of the animation groups added to this scene
  42908. * @see https://doc.babylonjs.com/how_to/group
  42909. */
  42910. animationGroups: AnimationGroup[];
  42911. /**
  42912. * All of the multi-materials added to this scene
  42913. * @see https://doc.babylonjs.com/how_to/multi_materials
  42914. */
  42915. multiMaterials: MultiMaterial[];
  42916. /**
  42917. * All of the materials added to this scene
  42918. * In the context of a Scene, it is not supposed to be modified manually.
  42919. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  42920. * Note also that the order of the Material within the array is not significant and might change.
  42921. * @see https://doc.babylonjs.com/babylon101/materials
  42922. */
  42923. materials: Material[];
  42924. /**
  42925. * The list of morph target managers added to the scene
  42926. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  42927. */
  42928. morphTargetManagers: MorphTargetManager[];
  42929. /**
  42930. * The list of geometries used in the scene.
  42931. */
  42932. geometries: Geometry[];
  42933. /**
  42934. * All of the tranform nodes added to this scene
  42935. * In the context of a Scene, it is not supposed to be modified manually.
  42936. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  42937. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  42938. * @see https://doc.babylonjs.com/how_to/transformnode
  42939. */
  42940. transformNodes: TransformNode[];
  42941. /**
  42942. * ActionManagers available on the scene.
  42943. */
  42944. actionManagers: AbstractActionManager[];
  42945. /**
  42946. * Textures to keep.
  42947. */
  42948. textures: BaseTexture[];
  42949. /** @hidden */
  42950. protected _environmentTexture: Nullable<BaseTexture>;
  42951. /**
  42952. * Texture used in all pbr material as the reflection texture.
  42953. * As in the majority of the scene they are the same (exception for multi room and so on),
  42954. * this is easier to reference from here than from all the materials.
  42955. */
  42956. get environmentTexture(): Nullable<BaseTexture>;
  42957. set environmentTexture(value: Nullable<BaseTexture>);
  42958. /**
  42959. * The list of postprocesses added to the scene
  42960. */
  42961. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  42962. /**
  42963. * @returns all meshes, lights, cameras, transformNodes and bones
  42964. */
  42965. getNodes(): Array<Node>;
  42966. }
  42967. }
  42968. declare module "babylonjs/Audio/sound" {
  42969. import { Observable } from "babylonjs/Misc/observable";
  42970. import { Vector3 } from "babylonjs/Maths/math.vector";
  42971. import { Nullable } from "babylonjs/types";
  42972. import { Scene } from "babylonjs/scene";
  42973. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42974. /**
  42975. * Interface used to define options for Sound class
  42976. */
  42977. export interface ISoundOptions {
  42978. /**
  42979. * Does the sound autoplay once loaded.
  42980. */
  42981. autoplay?: boolean;
  42982. /**
  42983. * Does the sound loop after it finishes playing once.
  42984. */
  42985. loop?: boolean;
  42986. /**
  42987. * Sound's volume
  42988. */
  42989. volume?: number;
  42990. /**
  42991. * Is it a spatial sound?
  42992. */
  42993. spatialSound?: boolean;
  42994. /**
  42995. * Maximum distance to hear that sound
  42996. */
  42997. maxDistance?: number;
  42998. /**
  42999. * Uses user defined attenuation function
  43000. */
  43001. useCustomAttenuation?: boolean;
  43002. /**
  43003. * Define the roll off factor of spatial sounds.
  43004. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43005. */
  43006. rolloffFactor?: number;
  43007. /**
  43008. * Define the reference distance the sound should be heard perfectly.
  43009. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43010. */
  43011. refDistance?: number;
  43012. /**
  43013. * Define the distance attenuation model the sound will follow.
  43014. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43015. */
  43016. distanceModel?: string;
  43017. /**
  43018. * Defines the playback speed (1 by default)
  43019. */
  43020. playbackRate?: number;
  43021. /**
  43022. * Defines if the sound is from a streaming source
  43023. */
  43024. streaming?: boolean;
  43025. /**
  43026. * Defines an optional length (in seconds) inside the sound file
  43027. */
  43028. length?: number;
  43029. /**
  43030. * Defines an optional offset (in seconds) inside the sound file
  43031. */
  43032. offset?: number;
  43033. /**
  43034. * If true, URLs will not be required to state the audio file codec to use.
  43035. */
  43036. skipCodecCheck?: boolean;
  43037. }
  43038. /**
  43039. * Defines a sound that can be played in the application.
  43040. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  43041. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43042. */
  43043. export class Sound {
  43044. /**
  43045. * The name of the sound in the scene.
  43046. */
  43047. name: string;
  43048. /**
  43049. * Does the sound autoplay once loaded.
  43050. */
  43051. autoplay: boolean;
  43052. /**
  43053. * Does the sound loop after it finishes playing once.
  43054. */
  43055. loop: boolean;
  43056. /**
  43057. * Does the sound use a custom attenuation curve to simulate the falloff
  43058. * happening when the source gets further away from the camera.
  43059. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  43060. */
  43061. useCustomAttenuation: boolean;
  43062. /**
  43063. * The sound track id this sound belongs to.
  43064. */
  43065. soundTrackId: number;
  43066. /**
  43067. * Is this sound currently played.
  43068. */
  43069. isPlaying: boolean;
  43070. /**
  43071. * Is this sound currently paused.
  43072. */
  43073. isPaused: boolean;
  43074. /**
  43075. * Does this sound enables spatial sound.
  43076. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43077. */
  43078. spatialSound: boolean;
  43079. /**
  43080. * Define the reference distance the sound should be heard perfectly.
  43081. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43082. */
  43083. refDistance: number;
  43084. /**
  43085. * Define the roll off factor of spatial sounds.
  43086. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43087. */
  43088. rolloffFactor: number;
  43089. /**
  43090. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  43091. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43092. */
  43093. maxDistance: number;
  43094. /**
  43095. * Define the distance attenuation model the sound will follow.
  43096. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43097. */
  43098. distanceModel: string;
  43099. /**
  43100. * @hidden
  43101. * Back Compat
  43102. **/
  43103. onended: () => any;
  43104. /**
  43105. * Gets or sets an object used to store user defined information for the sound.
  43106. */
  43107. metadata: any;
  43108. /**
  43109. * Observable event when the current playing sound finishes.
  43110. */
  43111. onEndedObservable: Observable<Sound>;
  43112. private _panningModel;
  43113. private _playbackRate;
  43114. private _streaming;
  43115. private _startTime;
  43116. private _startOffset;
  43117. private _position;
  43118. /** @hidden */
  43119. _positionInEmitterSpace: boolean;
  43120. private _localDirection;
  43121. private _volume;
  43122. private _isReadyToPlay;
  43123. private _isDirectional;
  43124. private _readyToPlayCallback;
  43125. private _audioBuffer;
  43126. private _soundSource;
  43127. private _streamingSource;
  43128. private _soundPanner;
  43129. private _soundGain;
  43130. private _inputAudioNode;
  43131. private _outputAudioNode;
  43132. private _coneInnerAngle;
  43133. private _coneOuterAngle;
  43134. private _coneOuterGain;
  43135. private _scene;
  43136. private _connectedTransformNode;
  43137. private _customAttenuationFunction;
  43138. private _registerFunc;
  43139. private _isOutputConnected;
  43140. private _htmlAudioElement;
  43141. private _urlType;
  43142. private _length?;
  43143. private _offset?;
  43144. /** @hidden */
  43145. static _SceneComponentInitialization: (scene: Scene) => void;
  43146. /**
  43147. * Create a sound and attach it to a scene
  43148. * @param name Name of your sound
  43149. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  43150. * @param scene defines the scene the sound belongs to
  43151. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  43152. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  43153. */
  43154. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  43155. /**
  43156. * Release the sound and its associated resources
  43157. */
  43158. dispose(): void;
  43159. /**
  43160. * Gets if the sounds is ready to be played or not.
  43161. * @returns true if ready, otherwise false
  43162. */
  43163. isReady(): boolean;
  43164. private _soundLoaded;
  43165. /**
  43166. * Sets the data of the sound from an audiobuffer
  43167. * @param audioBuffer The audioBuffer containing the data
  43168. */
  43169. setAudioBuffer(audioBuffer: AudioBuffer): void;
  43170. /**
  43171. * Updates the current sounds options such as maxdistance, loop...
  43172. * @param options A JSON object containing values named as the object properties
  43173. */
  43174. updateOptions(options: ISoundOptions): void;
  43175. private _createSpatialParameters;
  43176. private _updateSpatialParameters;
  43177. /**
  43178. * Switch the panning model to HRTF:
  43179. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  43180. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43181. */
  43182. switchPanningModelToHRTF(): void;
  43183. /**
  43184. * Switch the panning model to Equal Power:
  43185. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  43186. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43187. */
  43188. switchPanningModelToEqualPower(): void;
  43189. private _switchPanningModel;
  43190. /**
  43191. * Connect this sound to a sound track audio node like gain...
  43192. * @param soundTrackAudioNode the sound track audio node to connect to
  43193. */
  43194. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  43195. /**
  43196. * Transform this sound into a directional source
  43197. * @param coneInnerAngle Size of the inner cone in degree
  43198. * @param coneOuterAngle Size of the outer cone in degree
  43199. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  43200. */
  43201. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  43202. /**
  43203. * Gets or sets the inner angle for the directional cone.
  43204. */
  43205. get directionalConeInnerAngle(): number;
  43206. /**
  43207. * Gets or sets the inner angle for the directional cone.
  43208. */
  43209. set directionalConeInnerAngle(value: number);
  43210. /**
  43211. * Gets or sets the outer angle for the directional cone.
  43212. */
  43213. get directionalConeOuterAngle(): number;
  43214. /**
  43215. * Gets or sets the outer angle for the directional cone.
  43216. */
  43217. set directionalConeOuterAngle(value: number);
  43218. /**
  43219. * Sets the position of the emitter if spatial sound is enabled
  43220. * @param newPosition Defines the new posisiton
  43221. */
  43222. setPosition(newPosition: Vector3): void;
  43223. /**
  43224. * Sets the local direction of the emitter if spatial sound is enabled
  43225. * @param newLocalDirection Defines the new local direction
  43226. */
  43227. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  43228. private _updateDirection;
  43229. /** @hidden */
  43230. updateDistanceFromListener(): void;
  43231. /**
  43232. * Sets a new custom attenuation function for the sound.
  43233. * @param callback Defines the function used for the attenuation
  43234. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  43235. */
  43236. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  43237. /**
  43238. * Play the sound
  43239. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  43240. * @param offset (optional) Start the sound at a specific time in seconds
  43241. * @param length (optional) Sound duration (in seconds)
  43242. */
  43243. play(time?: number, offset?: number, length?: number): void;
  43244. private _onended;
  43245. /**
  43246. * Stop the sound
  43247. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  43248. */
  43249. stop(time?: number): void;
  43250. /**
  43251. * Put the sound in pause
  43252. */
  43253. pause(): void;
  43254. /**
  43255. * Sets a dedicated volume for this sounds
  43256. * @param newVolume Define the new volume of the sound
  43257. * @param time Define time for gradual change to new volume
  43258. */
  43259. setVolume(newVolume: number, time?: number): void;
  43260. /**
  43261. * Set the sound play back rate
  43262. * @param newPlaybackRate Define the playback rate the sound should be played at
  43263. */
  43264. setPlaybackRate(newPlaybackRate: number): void;
  43265. /**
  43266. * Gets the volume of the sound.
  43267. * @returns the volume of the sound
  43268. */
  43269. getVolume(): number;
  43270. /**
  43271. * Attach the sound to a dedicated mesh
  43272. * @param transformNode The transform node to connect the sound with
  43273. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  43274. */
  43275. attachToMesh(transformNode: TransformNode): void;
  43276. /**
  43277. * Detach the sound from the previously attached mesh
  43278. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  43279. */
  43280. detachFromMesh(): void;
  43281. private _onRegisterAfterWorldMatrixUpdate;
  43282. /**
  43283. * Clone the current sound in the scene.
  43284. * @returns the new sound clone
  43285. */
  43286. clone(): Nullable<Sound>;
  43287. /**
  43288. * Gets the current underlying audio buffer containing the data
  43289. * @returns the audio buffer
  43290. */
  43291. getAudioBuffer(): Nullable<AudioBuffer>;
  43292. /**
  43293. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  43294. * @returns the source node
  43295. */
  43296. getSoundSource(): Nullable<AudioBufferSourceNode>;
  43297. /**
  43298. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  43299. * @returns the gain node
  43300. */
  43301. getSoundGain(): Nullable<GainNode>;
  43302. /**
  43303. * Serializes the Sound in a JSON representation
  43304. * @returns the JSON representation of the sound
  43305. */
  43306. serialize(): any;
  43307. /**
  43308. * Parse a JSON representation of a sound to innstantiate in a given scene
  43309. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  43310. * @param scene Define the scene the new parsed sound should be created in
  43311. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  43312. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  43313. * @returns the newly parsed sound
  43314. */
  43315. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  43316. }
  43317. }
  43318. declare module "babylonjs/Actions/directAudioActions" {
  43319. import { Action } from "babylonjs/Actions/action";
  43320. import { Condition } from "babylonjs/Actions/condition";
  43321. import { Sound } from "babylonjs/Audio/sound";
  43322. /**
  43323. * This defines an action helpful to play a defined sound on a triggered action.
  43324. */
  43325. export class PlaySoundAction extends Action {
  43326. private _sound;
  43327. /**
  43328. * Instantiate the action
  43329. * @param triggerOptions defines the trigger options
  43330. * @param sound defines the sound to play
  43331. * @param condition defines the trigger related conditions
  43332. */
  43333. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  43334. /** @hidden */
  43335. _prepare(): void;
  43336. /**
  43337. * Execute the action and play the sound.
  43338. */
  43339. execute(): void;
  43340. /**
  43341. * Serializes the actions and its related information.
  43342. * @param parent defines the object to serialize in
  43343. * @returns the serialized object
  43344. */
  43345. serialize(parent: any): any;
  43346. }
  43347. /**
  43348. * This defines an action helpful to stop a defined sound on a triggered action.
  43349. */
  43350. export class StopSoundAction extends Action {
  43351. private _sound;
  43352. /**
  43353. * Instantiate the action
  43354. * @param triggerOptions defines the trigger options
  43355. * @param sound defines the sound to stop
  43356. * @param condition defines the trigger related conditions
  43357. */
  43358. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  43359. /** @hidden */
  43360. _prepare(): void;
  43361. /**
  43362. * Execute the action and stop the sound.
  43363. */
  43364. execute(): void;
  43365. /**
  43366. * Serializes the actions and its related information.
  43367. * @param parent defines the object to serialize in
  43368. * @returns the serialized object
  43369. */
  43370. serialize(parent: any): any;
  43371. }
  43372. }
  43373. declare module "babylonjs/Actions/interpolateValueAction" {
  43374. import { Action } from "babylonjs/Actions/action";
  43375. import { Condition } from "babylonjs/Actions/condition";
  43376. import { Observable } from "babylonjs/Misc/observable";
  43377. /**
  43378. * This defines an action responsible to change the value of a property
  43379. * by interpolating between its current value and the newly set one once triggered.
  43380. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  43381. */
  43382. export class InterpolateValueAction extends Action {
  43383. /**
  43384. * Defines the path of the property where the value should be interpolated
  43385. */
  43386. propertyPath: string;
  43387. /**
  43388. * Defines the target value at the end of the interpolation.
  43389. */
  43390. value: any;
  43391. /**
  43392. * Defines the time it will take for the property to interpolate to the value.
  43393. */
  43394. duration: number;
  43395. /**
  43396. * Defines if the other scene animations should be stopped when the action has been triggered
  43397. */
  43398. stopOtherAnimations?: boolean;
  43399. /**
  43400. * Defines a callback raised once the interpolation animation has been done.
  43401. */
  43402. onInterpolationDone?: () => void;
  43403. /**
  43404. * Observable triggered once the interpolation animation has been done.
  43405. */
  43406. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  43407. private _target;
  43408. private _effectiveTarget;
  43409. private _property;
  43410. /**
  43411. * Instantiate the action
  43412. * @param triggerOptions defines the trigger options
  43413. * @param target defines the object containing the value to interpolate
  43414. * @param propertyPath defines the path to the property in the target object
  43415. * @param value defines the target value at the end of the interpolation
  43416. * @param duration deines the time it will take for the property to interpolate to the value.
  43417. * @param condition defines the trigger related conditions
  43418. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  43419. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  43420. */
  43421. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  43422. /** @hidden */
  43423. _prepare(): void;
  43424. /**
  43425. * Execute the action starts the value interpolation.
  43426. */
  43427. execute(): void;
  43428. /**
  43429. * Serializes the actions and its related information.
  43430. * @param parent defines the object to serialize in
  43431. * @returns the serialized object
  43432. */
  43433. serialize(parent: any): any;
  43434. }
  43435. }
  43436. declare module "babylonjs/Actions/index" {
  43437. export * from "babylonjs/Actions/abstractActionManager";
  43438. export * from "babylonjs/Actions/action";
  43439. export * from "babylonjs/Actions/actionEvent";
  43440. export * from "babylonjs/Actions/actionManager";
  43441. export * from "babylonjs/Actions/condition";
  43442. export * from "babylonjs/Actions/directActions";
  43443. export * from "babylonjs/Actions/directAudioActions";
  43444. export * from "babylonjs/Actions/interpolateValueAction";
  43445. }
  43446. declare module "babylonjs/Animations/index" {
  43447. export * from "babylonjs/Animations/animatable";
  43448. export * from "babylonjs/Animations/animation";
  43449. export * from "babylonjs/Animations/animationGroup";
  43450. export * from "babylonjs/Animations/animationPropertiesOverride";
  43451. export * from "babylonjs/Animations/easing";
  43452. export * from "babylonjs/Animations/runtimeAnimation";
  43453. export * from "babylonjs/Animations/animationEvent";
  43454. export * from "babylonjs/Animations/animationGroup";
  43455. export * from "babylonjs/Animations/animationKey";
  43456. export * from "babylonjs/Animations/animationRange";
  43457. export * from "babylonjs/Animations/animatable.interface";
  43458. }
  43459. declare module "babylonjs/Audio/soundTrack" {
  43460. import { Sound } from "babylonjs/Audio/sound";
  43461. import { Analyser } from "babylonjs/Audio/analyser";
  43462. import { Scene } from "babylonjs/scene";
  43463. /**
  43464. * Options allowed during the creation of a sound track.
  43465. */
  43466. export interface ISoundTrackOptions {
  43467. /**
  43468. * The volume the sound track should take during creation
  43469. */
  43470. volume?: number;
  43471. /**
  43472. * Define if the sound track is the main sound track of the scene
  43473. */
  43474. mainTrack?: boolean;
  43475. }
  43476. /**
  43477. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  43478. * It will be also used in a future release to apply effects on a specific track.
  43479. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43480. */
  43481. export class SoundTrack {
  43482. /**
  43483. * The unique identifier of the sound track in the scene.
  43484. */
  43485. id: number;
  43486. /**
  43487. * The list of sounds included in the sound track.
  43488. */
  43489. soundCollection: Array<Sound>;
  43490. private _outputAudioNode;
  43491. private _scene;
  43492. private _connectedAnalyser;
  43493. private _options;
  43494. private _isInitialized;
  43495. /**
  43496. * Creates a new sound track.
  43497. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43498. * @param scene Define the scene the sound track belongs to
  43499. * @param options
  43500. */
  43501. constructor(scene: Scene, options?: ISoundTrackOptions);
  43502. private _initializeSoundTrackAudioGraph;
  43503. /**
  43504. * Release the sound track and its associated resources
  43505. */
  43506. dispose(): void;
  43507. /**
  43508. * Adds a sound to this sound track
  43509. * @param sound define the cound to add
  43510. * @ignoreNaming
  43511. */
  43512. AddSound(sound: Sound): void;
  43513. /**
  43514. * Removes a sound to this sound track
  43515. * @param sound define the cound to remove
  43516. * @ignoreNaming
  43517. */
  43518. RemoveSound(sound: Sound): void;
  43519. /**
  43520. * Set a global volume for the full sound track.
  43521. * @param newVolume Define the new volume of the sound track
  43522. */
  43523. setVolume(newVolume: number): void;
  43524. /**
  43525. * Switch the panning model to HRTF:
  43526. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  43527. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43528. */
  43529. switchPanningModelToHRTF(): void;
  43530. /**
  43531. * Switch the panning model to Equal Power:
  43532. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  43533. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43534. */
  43535. switchPanningModelToEqualPower(): void;
  43536. /**
  43537. * Connect the sound track to an audio analyser allowing some amazing
  43538. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  43539. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  43540. * @param analyser The analyser to connect to the engine
  43541. */
  43542. connectToAnalyser(analyser: Analyser): void;
  43543. }
  43544. }
  43545. declare module "babylonjs/Audio/audioSceneComponent" {
  43546. import { Sound } from "babylonjs/Audio/sound";
  43547. import { SoundTrack } from "babylonjs/Audio/soundTrack";
  43548. import { Nullable } from "babylonjs/types";
  43549. import { Vector3 } from "babylonjs/Maths/math.vector";
  43550. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  43551. import { Scene } from "babylonjs/scene";
  43552. import { AbstractScene } from "babylonjs/abstractScene";
  43553. import "babylonjs/Audio/audioEngine";
  43554. module "babylonjs/abstractScene" {
  43555. interface AbstractScene {
  43556. /**
  43557. * The list of sounds used in the scene.
  43558. */
  43559. sounds: Nullable<Array<Sound>>;
  43560. }
  43561. }
  43562. module "babylonjs/scene" {
  43563. interface Scene {
  43564. /**
  43565. * @hidden
  43566. * Backing field
  43567. */
  43568. _mainSoundTrack: SoundTrack;
  43569. /**
  43570. * The main sound track played by the scene.
  43571. * It cotains your primary collection of sounds.
  43572. */
  43573. mainSoundTrack: SoundTrack;
  43574. /**
  43575. * The list of sound tracks added to the scene
  43576. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43577. */
  43578. soundTracks: Nullable<Array<SoundTrack>>;
  43579. /**
  43580. * Gets a sound using a given name
  43581. * @param name defines the name to search for
  43582. * @return the found sound or null if not found at all.
  43583. */
  43584. getSoundByName(name: string): Nullable<Sound>;
  43585. /**
  43586. * Gets or sets if audio support is enabled
  43587. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43588. */
  43589. audioEnabled: boolean;
  43590. /**
  43591. * Gets or sets if audio will be output to headphones
  43592. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43593. */
  43594. headphone: boolean;
  43595. /**
  43596. * Gets or sets custom audio listener position provider
  43597. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43598. */
  43599. audioListenerPositionProvider: Nullable<() => Vector3>;
  43600. /**
  43601. * Gets or sets a refresh rate when using 3D audio positioning
  43602. */
  43603. audioPositioningRefreshRate: number;
  43604. }
  43605. }
  43606. /**
  43607. * Defines the sound scene component responsible to manage any sounds
  43608. * in a given scene.
  43609. */
  43610. export class AudioSceneComponent implements ISceneSerializableComponent {
  43611. private static _CameraDirectionLH;
  43612. private static _CameraDirectionRH;
  43613. /**
  43614. * The component name helpfull to identify the component in the list of scene components.
  43615. */
  43616. readonly name: string;
  43617. /**
  43618. * The scene the component belongs to.
  43619. */
  43620. scene: Scene;
  43621. private _audioEnabled;
  43622. /**
  43623. * Gets whether audio is enabled or not.
  43624. * Please use related enable/disable method to switch state.
  43625. */
  43626. get audioEnabled(): boolean;
  43627. private _headphone;
  43628. /**
  43629. * Gets whether audio is outputing to headphone or not.
  43630. * Please use the according Switch methods to change output.
  43631. */
  43632. get headphone(): boolean;
  43633. /**
  43634. * Gets or sets a refresh rate when using 3D audio positioning
  43635. */
  43636. audioPositioningRefreshRate: number;
  43637. private _audioListenerPositionProvider;
  43638. /**
  43639. * Gets the current audio listener position provider
  43640. */
  43641. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  43642. /**
  43643. * Sets a custom listener position for all sounds in the scene
  43644. * By default, this is the position of the first active camera
  43645. */
  43646. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  43647. /**
  43648. * Creates a new instance of the component for the given scene
  43649. * @param scene Defines the scene to register the component in
  43650. */
  43651. constructor(scene: Scene);
  43652. /**
  43653. * Registers the component in a given scene
  43654. */
  43655. register(): void;
  43656. /**
  43657. * Rebuilds the elements related to this component in case of
  43658. * context lost for instance.
  43659. */
  43660. rebuild(): void;
  43661. /**
  43662. * Serializes the component data to the specified json object
  43663. * @param serializationObject The object to serialize to
  43664. */
  43665. serialize(serializationObject: any): void;
  43666. /**
  43667. * Adds all the elements from the container to the scene
  43668. * @param container the container holding the elements
  43669. */
  43670. addFromContainer(container: AbstractScene): void;
  43671. /**
  43672. * Removes all the elements in the container from the scene
  43673. * @param container contains the elements to remove
  43674. * @param dispose if the removed element should be disposed (default: false)
  43675. */
  43676. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  43677. /**
  43678. * Disposes the component and the associated ressources.
  43679. */
  43680. dispose(): void;
  43681. /**
  43682. * Disables audio in the associated scene.
  43683. */
  43684. disableAudio(): void;
  43685. /**
  43686. * Enables audio in the associated scene.
  43687. */
  43688. enableAudio(): void;
  43689. /**
  43690. * Switch audio to headphone output.
  43691. */
  43692. switchAudioModeForHeadphones(): void;
  43693. /**
  43694. * Switch audio to normal speakers.
  43695. */
  43696. switchAudioModeForNormalSpeakers(): void;
  43697. private _cachedCameraDirection;
  43698. private _cachedCameraPosition;
  43699. private _lastCheck;
  43700. private _afterRender;
  43701. }
  43702. }
  43703. declare module "babylonjs/Audio/weightedsound" {
  43704. import { Sound } from "babylonjs/Audio/sound";
  43705. /**
  43706. * Wraps one or more Sound objects and selects one with random weight for playback.
  43707. */
  43708. export class WeightedSound {
  43709. /** When true a Sound will be selected and played when the current playing Sound completes. */
  43710. loop: boolean;
  43711. private _coneInnerAngle;
  43712. private _coneOuterAngle;
  43713. private _volume;
  43714. /** A Sound is currently playing. */
  43715. isPlaying: boolean;
  43716. /** A Sound is currently paused. */
  43717. isPaused: boolean;
  43718. private _sounds;
  43719. private _weights;
  43720. private _currentIndex?;
  43721. /**
  43722. * Creates a new WeightedSound from the list of sounds given.
  43723. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  43724. * @param sounds Array of Sounds that will be selected from.
  43725. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  43726. */
  43727. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  43728. /**
  43729. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  43730. */
  43731. get directionalConeInnerAngle(): number;
  43732. /**
  43733. * The size of cone in degress for a directional sound in which there will be no attenuation.
  43734. */
  43735. set directionalConeInnerAngle(value: number);
  43736. /**
  43737. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43738. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43739. */
  43740. get directionalConeOuterAngle(): number;
  43741. /**
  43742. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43743. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43744. */
  43745. set directionalConeOuterAngle(value: number);
  43746. /**
  43747. * Playback volume.
  43748. */
  43749. get volume(): number;
  43750. /**
  43751. * Playback volume.
  43752. */
  43753. set volume(value: number);
  43754. private _onended;
  43755. /**
  43756. * Suspend playback
  43757. */
  43758. pause(): void;
  43759. /**
  43760. * Stop playback
  43761. */
  43762. stop(): void;
  43763. /**
  43764. * Start playback.
  43765. * @param startOffset Position the clip head at a specific time in seconds.
  43766. */
  43767. play(startOffset?: number): void;
  43768. }
  43769. }
  43770. declare module "babylonjs/Audio/index" {
  43771. export * from "babylonjs/Audio/analyser";
  43772. export * from "babylonjs/Audio/audioEngine";
  43773. export * from "babylonjs/Audio/audioSceneComponent";
  43774. export * from "babylonjs/Audio/sound";
  43775. export * from "babylonjs/Audio/soundTrack";
  43776. export * from "babylonjs/Audio/weightedsound";
  43777. }
  43778. declare module "babylonjs/Behaviors/Cameras/bouncingBehavior" {
  43779. import { Behavior } from "babylonjs/Behaviors/behavior";
  43780. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43781. import { BackEase } from "babylonjs/Animations/easing";
  43782. /**
  43783. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  43784. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  43785. */
  43786. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  43787. /**
  43788. * Gets the name of the behavior.
  43789. */
  43790. get name(): string;
  43791. /**
  43792. * The easing function used by animations
  43793. */
  43794. static EasingFunction: BackEase;
  43795. /**
  43796. * The easing mode used by animations
  43797. */
  43798. static EasingMode: number;
  43799. /**
  43800. * The duration of the animation, in milliseconds
  43801. */
  43802. transitionDuration: number;
  43803. /**
  43804. * Length of the distance animated by the transition when lower radius is reached
  43805. */
  43806. lowerRadiusTransitionRange: number;
  43807. /**
  43808. * Length of the distance animated by the transition when upper radius is reached
  43809. */
  43810. upperRadiusTransitionRange: number;
  43811. private _autoTransitionRange;
  43812. /**
  43813. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43814. */
  43815. get autoTransitionRange(): boolean;
  43816. /**
  43817. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43818. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  43819. */
  43820. set autoTransitionRange(value: boolean);
  43821. private _attachedCamera;
  43822. private _onAfterCheckInputsObserver;
  43823. private _onMeshTargetChangedObserver;
  43824. /**
  43825. * Initializes the behavior.
  43826. */
  43827. init(): void;
  43828. /**
  43829. * Attaches the behavior to its arc rotate camera.
  43830. * @param camera Defines the camera to attach the behavior to
  43831. */
  43832. attach(camera: ArcRotateCamera): void;
  43833. /**
  43834. * Detaches the behavior from its current arc rotate camera.
  43835. */
  43836. detach(): void;
  43837. private _radiusIsAnimating;
  43838. private _radiusBounceTransition;
  43839. private _animatables;
  43840. private _cachedWheelPrecision;
  43841. /**
  43842. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  43843. * @param radiusLimit The limit to check against.
  43844. * @return Bool to indicate if at limit.
  43845. */
  43846. private _isRadiusAtLimit;
  43847. /**
  43848. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  43849. * @param radiusDelta The delta by which to animate to. Can be negative.
  43850. */
  43851. private _applyBoundRadiusAnimation;
  43852. /**
  43853. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  43854. */
  43855. protected _clearAnimationLocks(): void;
  43856. /**
  43857. * Stops and removes all animations that have been applied to the camera
  43858. */
  43859. stopAllAnimations(): void;
  43860. }
  43861. }
  43862. declare module "babylonjs/Behaviors/Cameras/framingBehavior" {
  43863. import { Behavior } from "babylonjs/Behaviors/behavior";
  43864. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43865. import { ExponentialEase } from "babylonjs/Animations/easing";
  43866. import { Nullable } from "babylonjs/types";
  43867. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43868. import { Vector3 } from "babylonjs/Maths/math.vector";
  43869. /**
  43870. * 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.
  43871. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  43872. */
  43873. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  43874. /**
  43875. * Gets the name of the behavior.
  43876. */
  43877. get name(): string;
  43878. private _mode;
  43879. private _radiusScale;
  43880. private _positionScale;
  43881. private _defaultElevation;
  43882. private _elevationReturnTime;
  43883. private _elevationReturnWaitTime;
  43884. private _zoomStopsAnimation;
  43885. private _framingTime;
  43886. /**
  43887. * The easing function used by animations
  43888. */
  43889. static EasingFunction: ExponentialEase;
  43890. /**
  43891. * The easing mode used by animations
  43892. */
  43893. static EasingMode: number;
  43894. /**
  43895. * Sets the current mode used by the behavior
  43896. */
  43897. set mode(mode: number);
  43898. /**
  43899. * Gets current mode used by the behavior.
  43900. */
  43901. get mode(): number;
  43902. /**
  43903. * Sets the scale applied to the radius (1 by default)
  43904. */
  43905. set radiusScale(radius: number);
  43906. /**
  43907. * Gets the scale applied to the radius
  43908. */
  43909. get radiusScale(): number;
  43910. /**
  43911. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43912. */
  43913. set positionScale(scale: number);
  43914. /**
  43915. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43916. */
  43917. get positionScale(): number;
  43918. /**
  43919. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43920. * behaviour is triggered, in radians.
  43921. */
  43922. set defaultElevation(elevation: number);
  43923. /**
  43924. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43925. * behaviour is triggered, in radians.
  43926. */
  43927. get defaultElevation(): number;
  43928. /**
  43929. * Sets the time (in milliseconds) taken to return to the default beta position.
  43930. * Negative value indicates camera should not return to default.
  43931. */
  43932. set elevationReturnTime(speed: number);
  43933. /**
  43934. * Gets the time (in milliseconds) taken to return to the default beta position.
  43935. * Negative value indicates camera should not return to default.
  43936. */
  43937. get elevationReturnTime(): number;
  43938. /**
  43939. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43940. */
  43941. set elevationReturnWaitTime(time: number);
  43942. /**
  43943. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43944. */
  43945. get elevationReturnWaitTime(): number;
  43946. /**
  43947. * Sets the flag that indicates if user zooming should stop animation.
  43948. */
  43949. set zoomStopsAnimation(flag: boolean);
  43950. /**
  43951. * Gets the flag that indicates if user zooming should stop animation.
  43952. */
  43953. get zoomStopsAnimation(): boolean;
  43954. /**
  43955. * Sets the transition time when framing the mesh, in milliseconds
  43956. */
  43957. set framingTime(time: number);
  43958. /**
  43959. * Gets the transition time when framing the mesh, in milliseconds
  43960. */
  43961. get framingTime(): number;
  43962. /**
  43963. * Define if the behavior should automatically change the configured
  43964. * camera limits and sensibilities.
  43965. */
  43966. autoCorrectCameraLimitsAndSensibility: boolean;
  43967. private _onPrePointerObservableObserver;
  43968. private _onAfterCheckInputsObserver;
  43969. private _onMeshTargetChangedObserver;
  43970. private _attachedCamera;
  43971. private _isPointerDown;
  43972. private _lastInteractionTime;
  43973. /**
  43974. * Initializes the behavior.
  43975. */
  43976. init(): void;
  43977. /**
  43978. * Attaches the behavior to its arc rotate camera.
  43979. * @param camera Defines the camera to attach the behavior to
  43980. */
  43981. attach(camera: ArcRotateCamera): void;
  43982. /**
  43983. * Detaches the behavior from its current arc rotate camera.
  43984. */
  43985. detach(): void;
  43986. private _animatables;
  43987. private _betaIsAnimating;
  43988. private _betaTransition;
  43989. private _radiusTransition;
  43990. private _vectorTransition;
  43991. /**
  43992. * Targets the given mesh and updates zoom level accordingly.
  43993. * @param mesh The mesh to target.
  43994. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43995. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43996. */
  43997. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43998. /**
  43999. * Targets the given mesh with its children and updates zoom level accordingly.
  44000. * @param mesh The mesh to target.
  44001. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  44002. * @param onAnimationEnd Callback triggered at the end of the framing animation
  44003. */
  44004. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  44005. /**
  44006. * Targets the given meshes with their children and updates zoom level accordingly.
  44007. * @param meshes The mesh to target.
  44008. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  44009. * @param onAnimationEnd Callback triggered at the end of the framing animation
  44010. */
  44011. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  44012. /**
  44013. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  44014. * @param minimumWorld Determines the smaller position of the bounding box extend
  44015. * @param maximumWorld Determines the bigger position of the bounding box extend
  44016. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  44017. * @param onAnimationEnd Callback triggered at the end of the framing animation
  44018. */
  44019. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  44020. /**
  44021. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  44022. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  44023. * frustum width.
  44024. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  44025. * to fully enclose the mesh in the viewing frustum.
  44026. */
  44027. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  44028. /**
  44029. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  44030. * is automatically returned to its default position (expected to be above ground plane).
  44031. */
  44032. private _maintainCameraAboveGround;
  44033. /**
  44034. * Returns the frustum slope based on the canvas ratio and camera FOV
  44035. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  44036. */
  44037. private _getFrustumSlope;
  44038. /**
  44039. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  44040. */
  44041. private _clearAnimationLocks;
  44042. /**
  44043. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  44044. */
  44045. private _applyUserInteraction;
  44046. /**
  44047. * Stops and removes all animations that have been applied to the camera
  44048. */
  44049. stopAllAnimations(): void;
  44050. /**
  44051. * Gets a value indicating if the user is moving the camera
  44052. */
  44053. get isUserIsMoving(): boolean;
  44054. /**
  44055. * The camera can move all the way towards the mesh.
  44056. */
  44057. static IgnoreBoundsSizeMode: number;
  44058. /**
  44059. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  44060. */
  44061. static FitFrustumSidesMode: number;
  44062. }
  44063. }
  44064. declare module "babylonjs/Cameras/Inputs/BaseCameraPointersInput" {
  44065. import { Nullable } from "babylonjs/types";
  44066. import { Camera } from "babylonjs/Cameras/camera";
  44067. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44068. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  44069. /**
  44070. * Base class for Camera Pointer Inputs.
  44071. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  44072. * for example usage.
  44073. */
  44074. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  44075. /**
  44076. * Defines the camera the input is attached to.
  44077. */
  44078. abstract camera: Camera;
  44079. /**
  44080. * Whether keyboard modifier keys are pressed at time of last mouse event.
  44081. */
  44082. protected _altKey: boolean;
  44083. protected _ctrlKey: boolean;
  44084. protected _metaKey: boolean;
  44085. protected _shiftKey: boolean;
  44086. /**
  44087. * Which mouse buttons were pressed at time of last mouse event.
  44088. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  44089. */
  44090. protected _buttonsPressed: number;
  44091. /**
  44092. * Defines the buttons associated with the input to handle camera move.
  44093. */
  44094. buttons: number[];
  44095. /**
  44096. * Attach the input controls to a specific dom element to get the input from.
  44097. * @param element Defines the element the controls should be listened from
  44098. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44099. */
  44100. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44101. /**
  44102. * Detach the current controls from the specified dom element.
  44103. * @param element Defines the element to stop listening the inputs from
  44104. */
  44105. detachControl(element: Nullable<HTMLElement>): void;
  44106. /**
  44107. * Gets the class name of the current input.
  44108. * @returns the class name
  44109. */
  44110. getClassName(): string;
  44111. /**
  44112. * Get the friendly name associated with the input class.
  44113. * @returns the input friendly name
  44114. */
  44115. getSimpleName(): string;
  44116. /**
  44117. * Called on pointer POINTERDOUBLETAP event.
  44118. * Override this method to provide functionality on POINTERDOUBLETAP event.
  44119. */
  44120. protected onDoubleTap(type: string): void;
  44121. /**
  44122. * Called on pointer POINTERMOVE event if only a single touch is active.
  44123. * Override this method to provide functionality.
  44124. */
  44125. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  44126. /**
  44127. * Called on pointer POINTERMOVE event if multiple touches are active.
  44128. * Override this method to provide functionality.
  44129. */
  44130. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  44131. /**
  44132. * Called on JS contextmenu event.
  44133. * Override this method to provide functionality.
  44134. */
  44135. protected onContextMenu(evt: PointerEvent): void;
  44136. /**
  44137. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  44138. * press.
  44139. * Override this method to provide functionality.
  44140. */
  44141. protected onButtonDown(evt: PointerEvent): void;
  44142. /**
  44143. * Called each time a new POINTERUP event occurs. Ie, for each button
  44144. * release.
  44145. * Override this method to provide functionality.
  44146. */
  44147. protected onButtonUp(evt: PointerEvent): void;
  44148. /**
  44149. * Called when window becomes inactive.
  44150. * Override this method to provide functionality.
  44151. */
  44152. protected onLostFocus(): void;
  44153. private _pointerInput;
  44154. private _observer;
  44155. private _onLostFocus;
  44156. private pointA;
  44157. private pointB;
  44158. }
  44159. }
  44160. declare module "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput" {
  44161. import { Nullable } from "babylonjs/types";
  44162. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44163. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  44164. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  44165. /**
  44166. * Manage the pointers inputs to control an arc rotate camera.
  44167. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44168. */
  44169. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  44170. /**
  44171. * Defines the camera the input is attached to.
  44172. */
  44173. camera: ArcRotateCamera;
  44174. /**
  44175. * Gets the class name of the current input.
  44176. * @returns the class name
  44177. */
  44178. getClassName(): string;
  44179. /**
  44180. * Defines the buttons associated with the input to handle camera move.
  44181. */
  44182. buttons: number[];
  44183. /**
  44184. * Defines the pointer angular sensibility along the X axis or how fast is
  44185. * the camera rotating.
  44186. */
  44187. angularSensibilityX: number;
  44188. /**
  44189. * Defines the pointer angular sensibility along the Y axis or how fast is
  44190. * the camera rotating.
  44191. */
  44192. angularSensibilityY: number;
  44193. /**
  44194. * Defines the pointer pinch precision or how fast is the camera zooming.
  44195. */
  44196. pinchPrecision: number;
  44197. /**
  44198. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  44199. * from 0.
  44200. * It defines the percentage of current camera.radius to use as delta when
  44201. * pinch zoom is used.
  44202. */
  44203. pinchDeltaPercentage: number;
  44204. /**
  44205. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  44206. * that any object in the plane at the camera's target point will scale
  44207. * perfectly with finger motion.
  44208. * Overrides pinchDeltaPercentage and pinchPrecision.
  44209. */
  44210. useNaturalPinchZoom: boolean;
  44211. /**
  44212. * Defines the pointer panning sensibility or how fast is the camera moving.
  44213. */
  44214. panningSensibility: number;
  44215. /**
  44216. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  44217. */
  44218. multiTouchPanning: boolean;
  44219. /**
  44220. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  44221. * zoom (pinch) through multitouch.
  44222. */
  44223. multiTouchPanAndZoom: boolean;
  44224. /**
  44225. * Revers pinch action direction.
  44226. */
  44227. pinchInwards: boolean;
  44228. private _isPanClick;
  44229. private _twoFingerActivityCount;
  44230. private _isPinching;
  44231. /**
  44232. * Called on pointer POINTERMOVE event if only a single touch is active.
  44233. */
  44234. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  44235. /**
  44236. * Called on pointer POINTERDOUBLETAP event.
  44237. */
  44238. protected onDoubleTap(type: string): void;
  44239. /**
  44240. * Called on pointer POINTERMOVE event if multiple touches are active.
  44241. */
  44242. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  44243. /**
  44244. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  44245. * press.
  44246. */
  44247. protected onButtonDown(evt: PointerEvent): void;
  44248. /**
  44249. * Called each time a new POINTERUP event occurs. Ie, for each button
  44250. * release.
  44251. */
  44252. protected onButtonUp(evt: PointerEvent): void;
  44253. /**
  44254. * Called when window becomes inactive.
  44255. */
  44256. protected onLostFocus(): void;
  44257. }
  44258. }
  44259. declare module "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput" {
  44260. import { Nullable } from "babylonjs/types";
  44261. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44262. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44263. /**
  44264. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  44265. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44266. */
  44267. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  44268. /**
  44269. * Defines the camera the input is attached to.
  44270. */
  44271. camera: ArcRotateCamera;
  44272. /**
  44273. * Defines the list of key codes associated with the up action (increase alpha)
  44274. */
  44275. keysUp: number[];
  44276. /**
  44277. * Defines the list of key codes associated with the down action (decrease alpha)
  44278. */
  44279. keysDown: number[];
  44280. /**
  44281. * Defines the list of key codes associated with the left action (increase beta)
  44282. */
  44283. keysLeft: number[];
  44284. /**
  44285. * Defines the list of key codes associated with the right action (decrease beta)
  44286. */
  44287. keysRight: number[];
  44288. /**
  44289. * Defines the list of key codes associated with the reset action.
  44290. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  44291. */
  44292. keysReset: number[];
  44293. /**
  44294. * Defines the panning sensibility of the inputs.
  44295. * (How fast is the camera panning)
  44296. */
  44297. panningSensibility: number;
  44298. /**
  44299. * Defines the zooming sensibility of the inputs.
  44300. * (How fast is the camera zooming)
  44301. */
  44302. zoomingSensibility: number;
  44303. /**
  44304. * Defines whether maintaining the alt key down switch the movement mode from
  44305. * orientation to zoom.
  44306. */
  44307. useAltToZoom: boolean;
  44308. /**
  44309. * Rotation speed of the camera
  44310. */
  44311. angularSpeed: number;
  44312. private _keys;
  44313. private _ctrlPressed;
  44314. private _altPressed;
  44315. private _onCanvasBlurObserver;
  44316. private _onKeyboardObserver;
  44317. private _engine;
  44318. private _scene;
  44319. /**
  44320. * Attach the input controls to a specific dom element to get the input from.
  44321. * @param element Defines the element the controls should be listened from
  44322. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44323. */
  44324. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44325. /**
  44326. * Detach the current controls from the specified dom element.
  44327. * @param element Defines the element to stop listening the inputs from
  44328. */
  44329. detachControl(element: Nullable<HTMLElement>): void;
  44330. /**
  44331. * Update the current camera state depending on the inputs that have been used this frame.
  44332. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  44333. */
  44334. checkInputs(): void;
  44335. /**
  44336. * Gets the class name of the current intput.
  44337. * @returns the class name
  44338. */
  44339. getClassName(): string;
  44340. /**
  44341. * Get the friendly name associated with the input class.
  44342. * @returns the input friendly name
  44343. */
  44344. getSimpleName(): string;
  44345. }
  44346. }
  44347. declare module "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput" {
  44348. import { Nullable } from "babylonjs/types";
  44349. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44350. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44351. /**
  44352. * Manage the mouse wheel inputs to control an arc rotate camera.
  44353. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44354. */
  44355. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  44356. /**
  44357. * Defines the camera the input is attached to.
  44358. */
  44359. camera: ArcRotateCamera;
  44360. /**
  44361. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44362. */
  44363. wheelPrecision: number;
  44364. /**
  44365. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  44366. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  44367. */
  44368. wheelDeltaPercentage: number;
  44369. private _wheel;
  44370. private _observer;
  44371. private computeDeltaFromMouseWheelLegacyEvent;
  44372. /**
  44373. * Attach the input controls to a specific dom element to get the input from.
  44374. * @param element Defines the element the controls should be listened from
  44375. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44376. */
  44377. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44378. /**
  44379. * Detach the current controls from the specified dom element.
  44380. * @param element Defines the element to stop listening the inputs from
  44381. */
  44382. detachControl(element: Nullable<HTMLElement>): void;
  44383. /**
  44384. * Gets the class name of the current intput.
  44385. * @returns the class name
  44386. */
  44387. getClassName(): string;
  44388. /**
  44389. * Get the friendly name associated with the input class.
  44390. * @returns the input friendly name
  44391. */
  44392. getSimpleName(): string;
  44393. }
  44394. }
  44395. declare module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  44396. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44397. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  44398. /**
  44399. * Default Inputs manager for the ArcRotateCamera.
  44400. * It groups all the default supported inputs for ease of use.
  44401. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44402. */
  44403. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  44404. /**
  44405. * Instantiates a new ArcRotateCameraInputsManager.
  44406. * @param camera Defines the camera the inputs belong to
  44407. */
  44408. constructor(camera: ArcRotateCamera);
  44409. /**
  44410. * Add mouse wheel input support to the input manager.
  44411. * @returns the current input manager
  44412. */
  44413. addMouseWheel(): ArcRotateCameraInputsManager;
  44414. /**
  44415. * Add pointers input support to the input manager.
  44416. * @returns the current input manager
  44417. */
  44418. addPointers(): ArcRotateCameraInputsManager;
  44419. /**
  44420. * Add keyboard input support to the input manager.
  44421. * @returns the current input manager
  44422. */
  44423. addKeyboard(): ArcRotateCameraInputsManager;
  44424. }
  44425. }
  44426. declare module "babylonjs/Cameras/arcRotateCamera" {
  44427. import { Observable } from "babylonjs/Misc/observable";
  44428. import { Nullable } from "babylonjs/types";
  44429. import { Scene } from "babylonjs/scene";
  44430. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  44431. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44432. import { AutoRotationBehavior } from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44433. import { BouncingBehavior } from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44434. import { FramingBehavior } from "babylonjs/Behaviors/Cameras/framingBehavior";
  44435. import { Camera } from "babylonjs/Cameras/camera";
  44436. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  44437. import { ArcRotateCameraInputsManager } from "babylonjs/Cameras/arcRotateCameraInputsManager";
  44438. import { Collider } from "babylonjs/Collisions/collider";
  44439. /**
  44440. * This represents an orbital type of camera.
  44441. *
  44442. * 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.
  44443. * 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.
  44444. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  44445. */
  44446. export class ArcRotateCamera extends TargetCamera {
  44447. /**
  44448. * Defines the rotation angle of the camera along the longitudinal axis.
  44449. */
  44450. alpha: number;
  44451. /**
  44452. * Defines the rotation angle of the camera along the latitudinal axis.
  44453. */
  44454. beta: number;
  44455. /**
  44456. * Defines the radius of the camera from it s target point.
  44457. */
  44458. radius: number;
  44459. protected _target: Vector3;
  44460. protected _targetHost: Nullable<AbstractMesh>;
  44461. /**
  44462. * Defines the target point of the camera.
  44463. * The camera looks towards it form the radius distance.
  44464. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  44465. */
  44466. get target(): Vector3;
  44467. set target(value: Vector3);
  44468. /**
  44469. * Define the current local position of the camera in the scene
  44470. */
  44471. get position(): Vector3;
  44472. set position(newPosition: Vector3);
  44473. protected _upToYMatrix: Matrix;
  44474. protected _YToUpMatrix: Matrix;
  44475. /**
  44476. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  44477. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  44478. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  44479. */
  44480. set upVector(vec: Vector3);
  44481. get upVector(): Vector3;
  44482. /**
  44483. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  44484. */
  44485. setMatUp(): void;
  44486. /**
  44487. * Current inertia value on the longitudinal axis.
  44488. * The bigger this number the longer it will take for the camera to stop.
  44489. */
  44490. inertialAlphaOffset: number;
  44491. /**
  44492. * Current inertia value on the latitudinal axis.
  44493. * The bigger this number the longer it will take for the camera to stop.
  44494. */
  44495. inertialBetaOffset: number;
  44496. /**
  44497. * Current inertia value on the radius axis.
  44498. * The bigger this number the longer it will take for the camera to stop.
  44499. */
  44500. inertialRadiusOffset: number;
  44501. /**
  44502. * Minimum allowed angle on the longitudinal axis.
  44503. * This can help limiting how the Camera is able to move in the scene.
  44504. */
  44505. lowerAlphaLimit: Nullable<number>;
  44506. /**
  44507. * Maximum allowed angle on the longitudinal axis.
  44508. * This can help limiting how the Camera is able to move in the scene.
  44509. */
  44510. upperAlphaLimit: Nullable<number>;
  44511. /**
  44512. * Minimum allowed angle on the latitudinal axis.
  44513. * This can help limiting how the Camera is able to move in the scene.
  44514. */
  44515. lowerBetaLimit: number;
  44516. /**
  44517. * Maximum allowed angle on the latitudinal axis.
  44518. * This can help limiting how the Camera is able to move in the scene.
  44519. */
  44520. upperBetaLimit: number;
  44521. /**
  44522. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  44523. * This can help limiting how the Camera is able to move in the scene.
  44524. */
  44525. lowerRadiusLimit: Nullable<number>;
  44526. /**
  44527. * Maximum allowed distance of the camera to the target (The camera can not get further).
  44528. * This can help limiting how the Camera is able to move in the scene.
  44529. */
  44530. upperRadiusLimit: Nullable<number>;
  44531. /**
  44532. * Defines the current inertia value used during panning of the camera along the X axis.
  44533. */
  44534. inertialPanningX: number;
  44535. /**
  44536. * Defines the current inertia value used during panning of the camera along the Y axis.
  44537. */
  44538. inertialPanningY: number;
  44539. /**
  44540. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  44541. * Basically if your fingers moves away from more than this distance you will be considered
  44542. * in pinch mode.
  44543. */
  44544. pinchToPanMaxDistance: number;
  44545. /**
  44546. * Defines the maximum distance the camera can pan.
  44547. * This could help keeping the cammera always in your scene.
  44548. */
  44549. panningDistanceLimit: Nullable<number>;
  44550. /**
  44551. * Defines the target of the camera before paning.
  44552. */
  44553. panningOriginTarget: Vector3;
  44554. /**
  44555. * Defines the value of the inertia used during panning.
  44556. * 0 would mean stop inertia and one would mean no decelleration at all.
  44557. */
  44558. panningInertia: number;
  44559. /**
  44560. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  44561. */
  44562. get angularSensibilityX(): number;
  44563. set angularSensibilityX(value: number);
  44564. /**
  44565. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  44566. */
  44567. get angularSensibilityY(): number;
  44568. set angularSensibilityY(value: number);
  44569. /**
  44570. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  44571. */
  44572. get pinchPrecision(): number;
  44573. set pinchPrecision(value: number);
  44574. /**
  44575. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  44576. * It will be used instead of pinchDeltaPrecision if different from 0.
  44577. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44578. */
  44579. get pinchDeltaPercentage(): number;
  44580. set pinchDeltaPercentage(value: number);
  44581. /**
  44582. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  44583. * and pinch delta percentage.
  44584. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  44585. * that any object in the plane at the camera's target point will scale
  44586. * perfectly with finger motion.
  44587. */
  44588. get useNaturalPinchZoom(): boolean;
  44589. set useNaturalPinchZoom(value: boolean);
  44590. /**
  44591. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  44592. */
  44593. get panningSensibility(): number;
  44594. set panningSensibility(value: number);
  44595. /**
  44596. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  44597. */
  44598. get keysUp(): number[];
  44599. set keysUp(value: number[]);
  44600. /**
  44601. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  44602. */
  44603. get keysDown(): number[];
  44604. set keysDown(value: number[]);
  44605. /**
  44606. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  44607. */
  44608. get keysLeft(): number[];
  44609. set keysLeft(value: number[]);
  44610. /**
  44611. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  44612. */
  44613. get keysRight(): number[];
  44614. set keysRight(value: number[]);
  44615. /**
  44616. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44617. */
  44618. get wheelPrecision(): number;
  44619. set wheelPrecision(value: number);
  44620. /**
  44621. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  44622. * It will be used instead of pinchDeltaPrecision if different from 0.
  44623. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44624. */
  44625. get wheelDeltaPercentage(): number;
  44626. set wheelDeltaPercentage(value: number);
  44627. /**
  44628. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  44629. */
  44630. zoomOnFactor: number;
  44631. /**
  44632. * Defines a screen offset for the camera position.
  44633. */
  44634. targetScreenOffset: Vector2;
  44635. /**
  44636. * Allows the camera to be completely reversed.
  44637. * If false the camera can not arrive upside down.
  44638. */
  44639. allowUpsideDown: boolean;
  44640. /**
  44641. * Define if double tap/click is used to restore the previously saved state of the camera.
  44642. */
  44643. useInputToRestoreState: boolean;
  44644. /** @hidden */
  44645. _viewMatrix: Matrix;
  44646. /** @hidden */
  44647. _useCtrlForPanning: boolean;
  44648. /** @hidden */
  44649. _panningMouseButton: number;
  44650. /**
  44651. * Defines the input associated to the camera.
  44652. */
  44653. inputs: ArcRotateCameraInputsManager;
  44654. /** @hidden */
  44655. _reset: () => void;
  44656. /**
  44657. * Defines the allowed panning axis.
  44658. */
  44659. panningAxis: Vector3;
  44660. protected _localDirection: Vector3;
  44661. protected _transformedDirection: Vector3;
  44662. private _bouncingBehavior;
  44663. /**
  44664. * Gets the bouncing behavior of the camera if it has been enabled.
  44665. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44666. */
  44667. get bouncingBehavior(): Nullable<BouncingBehavior>;
  44668. /**
  44669. * Defines if the bouncing behavior of the camera is enabled on the camera.
  44670. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44671. */
  44672. get useBouncingBehavior(): boolean;
  44673. set useBouncingBehavior(value: boolean);
  44674. private _framingBehavior;
  44675. /**
  44676. * Gets the framing behavior of the camera if it has been enabled.
  44677. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44678. */
  44679. get framingBehavior(): Nullable<FramingBehavior>;
  44680. /**
  44681. * Defines if the framing behavior of the camera is enabled on the camera.
  44682. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44683. */
  44684. get useFramingBehavior(): boolean;
  44685. set useFramingBehavior(value: boolean);
  44686. private _autoRotationBehavior;
  44687. /**
  44688. * Gets the auto rotation behavior of the camera if it has been enabled.
  44689. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44690. */
  44691. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  44692. /**
  44693. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  44694. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44695. */
  44696. get useAutoRotationBehavior(): boolean;
  44697. set useAutoRotationBehavior(value: boolean);
  44698. /**
  44699. * Observable triggered when the mesh target has been changed on the camera.
  44700. */
  44701. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  44702. /**
  44703. * Event raised when the camera is colliding with a mesh.
  44704. */
  44705. onCollide: (collidedMesh: AbstractMesh) => void;
  44706. /**
  44707. * Defines whether the camera should check collision with the objects oh the scene.
  44708. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  44709. */
  44710. checkCollisions: boolean;
  44711. /**
  44712. * Defines the collision radius of the camera.
  44713. * This simulates a sphere around the camera.
  44714. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  44715. */
  44716. collisionRadius: Vector3;
  44717. protected _collider: Collider;
  44718. protected _previousPosition: Vector3;
  44719. protected _collisionVelocity: Vector3;
  44720. protected _newPosition: Vector3;
  44721. protected _previousAlpha: number;
  44722. protected _previousBeta: number;
  44723. protected _previousRadius: number;
  44724. protected _collisionTriggered: boolean;
  44725. protected _targetBoundingCenter: Nullable<Vector3>;
  44726. private _computationVector;
  44727. /**
  44728. * Instantiates a new ArcRotateCamera in a given scene
  44729. * @param name Defines the name of the camera
  44730. * @param alpha Defines the camera rotation along the logitudinal axis
  44731. * @param beta Defines the camera rotation along the latitudinal axis
  44732. * @param radius Defines the camera distance from its target
  44733. * @param target Defines the camera target
  44734. * @param scene Defines the scene the camera belongs to
  44735. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  44736. */
  44737. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  44738. /** @hidden */
  44739. _initCache(): void;
  44740. /** @hidden */
  44741. _updateCache(ignoreParentClass?: boolean): void;
  44742. protected _getTargetPosition(): Vector3;
  44743. private _storedAlpha;
  44744. private _storedBeta;
  44745. private _storedRadius;
  44746. private _storedTarget;
  44747. private _storedTargetScreenOffset;
  44748. /**
  44749. * Stores the current state of the camera (alpha, beta, radius and target)
  44750. * @returns the camera itself
  44751. */
  44752. storeState(): Camera;
  44753. /**
  44754. * @hidden
  44755. * Restored camera state. You must call storeState() first
  44756. */
  44757. _restoreStateValues(): boolean;
  44758. /** @hidden */
  44759. _isSynchronizedViewMatrix(): boolean;
  44760. /**
  44761. * Attached controls to the current camera.
  44762. * @param element Defines the element the controls should be listened from
  44763. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44764. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  44765. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  44766. */
  44767. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  44768. /**
  44769. * Detach the current controls from the camera.
  44770. * The camera will stop reacting to inputs.
  44771. * @param element Defines the element to stop listening the inputs from
  44772. */
  44773. detachControl(element: HTMLElement): void;
  44774. /** @hidden */
  44775. _checkInputs(): void;
  44776. protected _checkLimits(): void;
  44777. /**
  44778. * Rebuilds angles (alpha, beta) and radius from the give position and target
  44779. */
  44780. rebuildAnglesAndRadius(): void;
  44781. /**
  44782. * Use a position to define the current camera related information like alpha, beta and radius
  44783. * @param position Defines the position to set the camera at
  44784. */
  44785. setPosition(position: Vector3): void;
  44786. /**
  44787. * Defines the target the camera should look at.
  44788. * This will automatically adapt alpha beta and radius to fit within the new target.
  44789. * @param target Defines the new target as a Vector or a mesh
  44790. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  44791. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  44792. */
  44793. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  44794. /** @hidden */
  44795. _getViewMatrix(): Matrix;
  44796. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  44797. /**
  44798. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  44799. * @param meshes Defines the mesh to zoom on
  44800. * @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)
  44801. */
  44802. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  44803. /**
  44804. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  44805. * The target will be changed but the radius
  44806. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  44807. * @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)
  44808. */
  44809. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  44810. min: Vector3;
  44811. max: Vector3;
  44812. distance: number;
  44813. }, doNotUpdateMaxZ?: boolean): void;
  44814. /**
  44815. * @override
  44816. * Override Camera.createRigCamera
  44817. */
  44818. createRigCamera(name: string, cameraIndex: number): Camera;
  44819. /**
  44820. * @hidden
  44821. * @override
  44822. * Override Camera._updateRigCameras
  44823. */
  44824. _updateRigCameras(): void;
  44825. /**
  44826. * Destroy the camera and release the current resources hold by it.
  44827. */
  44828. dispose(): void;
  44829. /**
  44830. * Gets the current object class name.
  44831. * @return the class name
  44832. */
  44833. getClassName(): string;
  44834. }
  44835. }
  44836. declare module "babylonjs/Behaviors/Cameras/autoRotationBehavior" {
  44837. import { Behavior } from "babylonjs/Behaviors/behavior";
  44838. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44839. /**
  44840. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  44841. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44842. */
  44843. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  44844. /**
  44845. * Gets the name of the behavior.
  44846. */
  44847. get name(): string;
  44848. private _zoomStopsAnimation;
  44849. private _idleRotationSpeed;
  44850. private _idleRotationWaitTime;
  44851. private _idleRotationSpinupTime;
  44852. /**
  44853. * Sets the flag that indicates if user zooming should stop animation.
  44854. */
  44855. set zoomStopsAnimation(flag: boolean);
  44856. /**
  44857. * Gets the flag that indicates if user zooming should stop animation.
  44858. */
  44859. get zoomStopsAnimation(): boolean;
  44860. /**
  44861. * Sets the default speed at which the camera rotates around the model.
  44862. */
  44863. set idleRotationSpeed(speed: number);
  44864. /**
  44865. * Gets the default speed at which the camera rotates around the model.
  44866. */
  44867. get idleRotationSpeed(): number;
  44868. /**
  44869. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  44870. */
  44871. set idleRotationWaitTime(time: number);
  44872. /**
  44873. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  44874. */
  44875. get idleRotationWaitTime(): number;
  44876. /**
  44877. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44878. */
  44879. set idleRotationSpinupTime(time: number);
  44880. /**
  44881. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44882. */
  44883. get idleRotationSpinupTime(): number;
  44884. /**
  44885. * Gets a value indicating if the camera is currently rotating because of this behavior
  44886. */
  44887. get rotationInProgress(): boolean;
  44888. private _onPrePointerObservableObserver;
  44889. private _onAfterCheckInputsObserver;
  44890. private _attachedCamera;
  44891. private _isPointerDown;
  44892. private _lastFrameTime;
  44893. private _lastInteractionTime;
  44894. private _cameraRotationSpeed;
  44895. /**
  44896. * Initializes the behavior.
  44897. */
  44898. init(): void;
  44899. /**
  44900. * Attaches the behavior to its arc rotate camera.
  44901. * @param camera Defines the camera to attach the behavior to
  44902. */
  44903. attach(camera: ArcRotateCamera): void;
  44904. /**
  44905. * Detaches the behavior from its current arc rotate camera.
  44906. */
  44907. detach(): void;
  44908. /**
  44909. * Returns true if user is scrolling.
  44910. * @return true if user is scrolling.
  44911. */
  44912. private _userIsZooming;
  44913. private _lastFrameRadius;
  44914. private _shouldAnimationStopForInteraction;
  44915. /**
  44916. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  44917. */
  44918. private _applyUserInteraction;
  44919. private _userIsMoving;
  44920. }
  44921. }
  44922. declare module "babylonjs/Behaviors/Cameras/index" {
  44923. export * from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44924. export * from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44925. export * from "babylonjs/Behaviors/Cameras/framingBehavior";
  44926. }
  44927. declare module "babylonjs/Behaviors/Meshes/attachToBoxBehavior" {
  44928. import { Mesh } from "babylonjs/Meshes/mesh";
  44929. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44930. import { Behavior } from "babylonjs/Behaviors/behavior";
  44931. /**
  44932. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  44933. */
  44934. export class AttachToBoxBehavior implements Behavior<Mesh> {
  44935. private ui;
  44936. /**
  44937. * The name of the behavior
  44938. */
  44939. name: string;
  44940. /**
  44941. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  44942. */
  44943. distanceAwayFromFace: number;
  44944. /**
  44945. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  44946. */
  44947. distanceAwayFromBottomOfFace: number;
  44948. private _faceVectors;
  44949. private _target;
  44950. private _scene;
  44951. private _onRenderObserver;
  44952. private _tmpMatrix;
  44953. private _tmpVector;
  44954. /**
  44955. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  44956. * @param ui The transform node that should be attched to the mesh
  44957. */
  44958. constructor(ui: TransformNode);
  44959. /**
  44960. * Initializes the behavior
  44961. */
  44962. init(): void;
  44963. private _closestFace;
  44964. private _zeroVector;
  44965. private _lookAtTmpMatrix;
  44966. private _lookAtToRef;
  44967. /**
  44968. * Attaches the AttachToBoxBehavior to the passed in mesh
  44969. * @param target The mesh that the specified node will be attached to
  44970. */
  44971. attach(target: Mesh): void;
  44972. /**
  44973. * Detaches the behavior from the mesh
  44974. */
  44975. detach(): void;
  44976. }
  44977. }
  44978. declare module "babylonjs/Behaviors/Meshes/fadeInOutBehavior" {
  44979. import { Behavior } from "babylonjs/Behaviors/behavior";
  44980. import { Mesh } from "babylonjs/Meshes/mesh";
  44981. /**
  44982. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  44983. */
  44984. export class FadeInOutBehavior implements Behavior<Mesh> {
  44985. /**
  44986. * Time in milliseconds to delay before fading in (Default: 0)
  44987. */
  44988. delay: number;
  44989. /**
  44990. * Time in milliseconds for the mesh to fade in (Default: 300)
  44991. */
  44992. fadeInTime: number;
  44993. private _millisecondsPerFrame;
  44994. private _hovered;
  44995. private _hoverValue;
  44996. private _ownerNode;
  44997. /**
  44998. * Instatiates the FadeInOutBehavior
  44999. */
  45000. constructor();
  45001. /**
  45002. * The name of the behavior
  45003. */
  45004. get name(): string;
  45005. /**
  45006. * Initializes the behavior
  45007. */
  45008. init(): void;
  45009. /**
  45010. * Attaches the fade behavior on the passed in mesh
  45011. * @param ownerNode The mesh that will be faded in/out once attached
  45012. */
  45013. attach(ownerNode: Mesh): void;
  45014. /**
  45015. * Detaches the behavior from the mesh
  45016. */
  45017. detach(): void;
  45018. /**
  45019. * Triggers the mesh to begin fading in or out
  45020. * @param value if the object should fade in or out (true to fade in)
  45021. */
  45022. fadeIn(value: boolean): void;
  45023. private _update;
  45024. private _setAllVisibility;
  45025. }
  45026. }
  45027. declare module "babylonjs/Misc/pivotTools" {
  45028. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45029. /**
  45030. * Class containing a set of static utilities functions for managing Pivots
  45031. * @hidden
  45032. */
  45033. export class PivotTools {
  45034. private static _PivotCached;
  45035. private static _OldPivotPoint;
  45036. private static _PivotTranslation;
  45037. private static _PivotTmpVector;
  45038. private static _PivotPostMultiplyPivotMatrix;
  45039. /** @hidden */
  45040. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  45041. /** @hidden */
  45042. static _RestorePivotPoint(mesh: AbstractMesh): void;
  45043. }
  45044. }
  45045. declare module "babylonjs/Meshes/Builders/planeBuilder" {
  45046. import { Scene } from "babylonjs/scene";
  45047. import { Vector4 } from "babylonjs/Maths/math.vector";
  45048. import { Mesh } from "babylonjs/Meshes/mesh";
  45049. import { Nullable } from "babylonjs/types";
  45050. import { Plane } from "babylonjs/Maths/math.plane";
  45051. /**
  45052. * Class containing static functions to help procedurally build meshes
  45053. */
  45054. export class PlaneBuilder {
  45055. /**
  45056. * Creates a plane mesh
  45057. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  45058. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  45059. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  45060. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  45061. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  45062. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45063. * @param name defines the name of the mesh
  45064. * @param options defines the options used to create the mesh
  45065. * @param scene defines the hosting scene
  45066. * @returns the plane mesh
  45067. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  45068. */
  45069. static CreatePlane(name: string, options: {
  45070. size?: number;
  45071. width?: number;
  45072. height?: number;
  45073. sideOrientation?: number;
  45074. frontUVs?: Vector4;
  45075. backUVs?: Vector4;
  45076. updatable?: boolean;
  45077. sourcePlane?: Plane;
  45078. }, scene?: Nullable<Scene>): Mesh;
  45079. }
  45080. }
  45081. declare module "babylonjs/Behaviors/Meshes/pointerDragBehavior" {
  45082. import { Behavior } from "babylonjs/Behaviors/behavior";
  45083. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45084. import { Observable } from "babylonjs/Misc/observable";
  45085. import { Vector3 } from "babylonjs/Maths/math.vector";
  45086. import { Ray } from "babylonjs/Culling/ray";
  45087. import "babylonjs/Meshes/Builders/planeBuilder";
  45088. /**
  45089. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  45090. */
  45091. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  45092. private static _AnyMouseID;
  45093. /**
  45094. * Abstract mesh the behavior is set on
  45095. */
  45096. attachedNode: AbstractMesh;
  45097. private _dragPlane;
  45098. private _scene;
  45099. private _pointerObserver;
  45100. private _beforeRenderObserver;
  45101. private static _planeScene;
  45102. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  45103. /**
  45104. * 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)
  45105. */
  45106. maxDragAngle: number;
  45107. /**
  45108. * @hidden
  45109. */
  45110. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  45111. /**
  45112. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  45113. */
  45114. currentDraggingPointerID: number;
  45115. /**
  45116. * The last position where the pointer hit the drag plane in world space
  45117. */
  45118. lastDragPosition: Vector3;
  45119. /**
  45120. * If the behavior is currently in a dragging state
  45121. */
  45122. dragging: boolean;
  45123. /**
  45124. * 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)
  45125. */
  45126. dragDeltaRatio: number;
  45127. /**
  45128. * If the drag plane orientation should be updated during the dragging (Default: true)
  45129. */
  45130. updateDragPlane: boolean;
  45131. private _debugMode;
  45132. private _moving;
  45133. /**
  45134. * Fires each time the attached mesh is dragged with the pointer
  45135. * * delta between last drag position and current drag position in world space
  45136. * * dragDistance along the drag axis
  45137. * * dragPlaneNormal normal of the current drag plane used during the drag
  45138. * * dragPlanePoint in world space where the drag intersects the drag plane
  45139. */
  45140. onDragObservable: Observable<{
  45141. delta: Vector3;
  45142. dragPlanePoint: Vector3;
  45143. dragPlaneNormal: Vector3;
  45144. dragDistance: number;
  45145. pointerId: number;
  45146. }>;
  45147. /**
  45148. * Fires each time a drag begins (eg. mouse down on mesh)
  45149. */
  45150. onDragStartObservable: Observable<{
  45151. dragPlanePoint: Vector3;
  45152. pointerId: number;
  45153. }>;
  45154. /**
  45155. * Fires each time a drag ends (eg. mouse release after drag)
  45156. */
  45157. onDragEndObservable: Observable<{
  45158. dragPlanePoint: Vector3;
  45159. pointerId: number;
  45160. }>;
  45161. /**
  45162. * If the attached mesh should be moved when dragged
  45163. */
  45164. moveAttached: boolean;
  45165. /**
  45166. * If the drag behavior will react to drag events (Default: true)
  45167. */
  45168. enabled: boolean;
  45169. /**
  45170. * If pointer events should start and release the drag (Default: true)
  45171. */
  45172. startAndReleaseDragOnPointerEvents: boolean;
  45173. /**
  45174. * If camera controls should be detached during the drag
  45175. */
  45176. detachCameraControls: boolean;
  45177. /**
  45178. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  45179. */
  45180. useObjectOrientationForDragging: boolean;
  45181. private _options;
  45182. /**
  45183. * Gets the options used by the behavior
  45184. */
  45185. get options(): {
  45186. dragAxis?: Vector3;
  45187. dragPlaneNormal?: Vector3;
  45188. };
  45189. /**
  45190. * Sets the options used by the behavior
  45191. */
  45192. set options(options: {
  45193. dragAxis?: Vector3;
  45194. dragPlaneNormal?: Vector3;
  45195. });
  45196. /**
  45197. * Creates a pointer drag behavior that can be attached to a mesh
  45198. * @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)
  45199. */
  45200. constructor(options?: {
  45201. dragAxis?: Vector3;
  45202. dragPlaneNormal?: Vector3;
  45203. });
  45204. /**
  45205. * Predicate to determine if it is valid to move the object to a new position when it is moved
  45206. */
  45207. validateDrag: (targetPosition: Vector3) => boolean;
  45208. /**
  45209. * The name of the behavior
  45210. */
  45211. get name(): string;
  45212. /**
  45213. * Initializes the behavior
  45214. */
  45215. init(): void;
  45216. private _tmpVector;
  45217. private _alternatePickedPoint;
  45218. private _worldDragAxis;
  45219. private _targetPosition;
  45220. private _attachedElement;
  45221. /**
  45222. * Attaches the drag behavior the passed in mesh
  45223. * @param ownerNode The mesh that will be dragged around once attached
  45224. * @param predicate Predicate to use for pick filtering
  45225. */
  45226. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  45227. /**
  45228. * Force relase the drag action by code.
  45229. */
  45230. releaseDrag(): void;
  45231. private _startDragRay;
  45232. private _lastPointerRay;
  45233. /**
  45234. * Simulates the start of a pointer drag event on the behavior
  45235. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  45236. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  45237. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  45238. */
  45239. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  45240. protected _startDrag(pointerId: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  45241. private _dragDelta;
  45242. protected _moveDrag(ray: Ray): void;
  45243. private _pickWithRayOnDragPlane;
  45244. private _pointA;
  45245. private _pointC;
  45246. private _localAxis;
  45247. private _lookAt;
  45248. private _updateDragPlanePosition;
  45249. /**
  45250. * Detaches the behavior from the mesh
  45251. */
  45252. detach(): void;
  45253. }
  45254. }
  45255. declare module "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior" {
  45256. import { Mesh } from "babylonjs/Meshes/mesh";
  45257. import { Behavior } from "babylonjs/Behaviors/behavior";
  45258. /**
  45259. * A behavior that when attached to a mesh will allow the mesh to be scaled
  45260. */
  45261. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  45262. private _dragBehaviorA;
  45263. private _dragBehaviorB;
  45264. private _startDistance;
  45265. private _initialScale;
  45266. private _targetScale;
  45267. private _ownerNode;
  45268. private _sceneRenderObserver;
  45269. /**
  45270. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  45271. */
  45272. constructor();
  45273. /**
  45274. * The name of the behavior
  45275. */
  45276. get name(): string;
  45277. /**
  45278. * Initializes the behavior
  45279. */
  45280. init(): void;
  45281. private _getCurrentDistance;
  45282. /**
  45283. * Attaches the scale behavior the passed in mesh
  45284. * @param ownerNode The mesh that will be scaled around once attached
  45285. */
  45286. attach(ownerNode: Mesh): void;
  45287. /**
  45288. * Detaches the behavior from the mesh
  45289. */
  45290. detach(): void;
  45291. }
  45292. }
  45293. declare module "babylonjs/Behaviors/Meshes/sixDofDragBehavior" {
  45294. import { Behavior } from "babylonjs/Behaviors/behavior";
  45295. import { Mesh } from "babylonjs/Meshes/mesh";
  45296. import { Observable } from "babylonjs/Misc/observable";
  45297. /**
  45298. * 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
  45299. */
  45300. export class SixDofDragBehavior implements Behavior<Mesh> {
  45301. private static _virtualScene;
  45302. private _ownerNode;
  45303. private _sceneRenderObserver;
  45304. private _scene;
  45305. private _targetPosition;
  45306. private _virtualOriginMesh;
  45307. private _virtualDragMesh;
  45308. private _pointerObserver;
  45309. private _moving;
  45310. private _startingOrientation;
  45311. private _attachedElement;
  45312. /**
  45313. * 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)
  45314. */
  45315. private zDragFactor;
  45316. /**
  45317. * If the object should rotate to face the drag origin
  45318. */
  45319. rotateDraggedObject: boolean;
  45320. /**
  45321. * If the behavior is currently in a dragging state
  45322. */
  45323. dragging: boolean;
  45324. /**
  45325. * 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)
  45326. */
  45327. dragDeltaRatio: number;
  45328. /**
  45329. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  45330. */
  45331. currentDraggingPointerID: number;
  45332. /**
  45333. * If camera controls should be detached during the drag
  45334. */
  45335. detachCameraControls: boolean;
  45336. /**
  45337. * Fires each time a drag starts
  45338. */
  45339. onDragStartObservable: Observable<{}>;
  45340. /**
  45341. * Fires each time a drag ends (eg. mouse release after drag)
  45342. */
  45343. onDragEndObservable: Observable<{}>;
  45344. /**
  45345. * 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
  45346. */
  45347. constructor();
  45348. /**
  45349. * The name of the behavior
  45350. */
  45351. get name(): string;
  45352. /**
  45353. * Initializes the behavior
  45354. */
  45355. init(): void;
  45356. /**
  45357. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  45358. */
  45359. private get _pointerCamera();
  45360. /**
  45361. * Attaches the scale behavior the passed in mesh
  45362. * @param ownerNode The mesh that will be scaled around once attached
  45363. */
  45364. attach(ownerNode: Mesh): void;
  45365. /**
  45366. * Detaches the behavior from the mesh
  45367. */
  45368. detach(): void;
  45369. }
  45370. }
  45371. declare module "babylonjs/Behaviors/Meshes/index" {
  45372. export * from "babylonjs/Behaviors/Meshes/attachToBoxBehavior";
  45373. export * from "babylonjs/Behaviors/Meshes/fadeInOutBehavior";
  45374. export * from "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior";
  45375. export * from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  45376. export * from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  45377. }
  45378. declare module "babylonjs/Behaviors/index" {
  45379. export * from "babylonjs/Behaviors/behavior";
  45380. export * from "babylonjs/Behaviors/Cameras/index";
  45381. export * from "babylonjs/Behaviors/Meshes/index";
  45382. }
  45383. declare module "babylonjs/Bones/boneIKController" {
  45384. import { Bone } from "babylonjs/Bones/bone";
  45385. import { Vector3 } from "babylonjs/Maths/math.vector";
  45386. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45387. import { Nullable } from "babylonjs/types";
  45388. /**
  45389. * Class used to apply inverse kinematics to bones
  45390. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  45391. */
  45392. export class BoneIKController {
  45393. private static _tmpVecs;
  45394. private static _tmpQuat;
  45395. private static _tmpMats;
  45396. /**
  45397. * Gets or sets the target mesh
  45398. */
  45399. targetMesh: AbstractMesh;
  45400. /** Gets or sets the mesh used as pole */
  45401. poleTargetMesh: AbstractMesh;
  45402. /**
  45403. * Gets or sets the bone used as pole
  45404. */
  45405. poleTargetBone: Nullable<Bone>;
  45406. /**
  45407. * Gets or sets the target position
  45408. */
  45409. targetPosition: Vector3;
  45410. /**
  45411. * Gets or sets the pole target position
  45412. */
  45413. poleTargetPosition: Vector3;
  45414. /**
  45415. * Gets or sets the pole target local offset
  45416. */
  45417. poleTargetLocalOffset: Vector3;
  45418. /**
  45419. * Gets or sets the pole angle
  45420. */
  45421. poleAngle: number;
  45422. /**
  45423. * Gets or sets the mesh associated with the controller
  45424. */
  45425. mesh: AbstractMesh;
  45426. /**
  45427. * 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)
  45428. */
  45429. slerpAmount: number;
  45430. private _bone1Quat;
  45431. private _bone1Mat;
  45432. private _bone2Ang;
  45433. private _bone1;
  45434. private _bone2;
  45435. private _bone1Length;
  45436. private _bone2Length;
  45437. private _maxAngle;
  45438. private _maxReach;
  45439. private _rightHandedSystem;
  45440. private _bendAxis;
  45441. private _slerping;
  45442. private _adjustRoll;
  45443. /**
  45444. * Gets or sets maximum allowed angle
  45445. */
  45446. get maxAngle(): number;
  45447. set maxAngle(value: number);
  45448. /**
  45449. * Creates a new BoneIKController
  45450. * @param mesh defines the mesh to control
  45451. * @param bone defines the bone to control
  45452. * @param options defines options to set up the controller
  45453. */
  45454. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  45455. targetMesh?: AbstractMesh;
  45456. poleTargetMesh?: AbstractMesh;
  45457. poleTargetBone?: Bone;
  45458. poleTargetLocalOffset?: Vector3;
  45459. poleAngle?: number;
  45460. bendAxis?: Vector3;
  45461. maxAngle?: number;
  45462. slerpAmount?: number;
  45463. });
  45464. private _setMaxAngle;
  45465. /**
  45466. * Force the controller to update the bones
  45467. */
  45468. update(): void;
  45469. }
  45470. }
  45471. declare module "babylonjs/Bones/boneLookController" {
  45472. import { Vector3 } from "babylonjs/Maths/math.vector";
  45473. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45474. import { Bone } from "babylonjs/Bones/bone";
  45475. import { Space } from "babylonjs/Maths/math.axis";
  45476. /**
  45477. * Class used to make a bone look toward a point in space
  45478. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  45479. */
  45480. export class BoneLookController {
  45481. private static _tmpVecs;
  45482. private static _tmpQuat;
  45483. private static _tmpMats;
  45484. /**
  45485. * The target Vector3 that the bone will look at
  45486. */
  45487. target: Vector3;
  45488. /**
  45489. * The mesh that the bone is attached to
  45490. */
  45491. mesh: AbstractMesh;
  45492. /**
  45493. * The bone that will be looking to the target
  45494. */
  45495. bone: Bone;
  45496. /**
  45497. * The up axis of the coordinate system that is used when the bone is rotated
  45498. */
  45499. upAxis: Vector3;
  45500. /**
  45501. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  45502. */
  45503. upAxisSpace: Space;
  45504. /**
  45505. * Used to make an adjustment to the yaw of the bone
  45506. */
  45507. adjustYaw: number;
  45508. /**
  45509. * Used to make an adjustment to the pitch of the bone
  45510. */
  45511. adjustPitch: number;
  45512. /**
  45513. * Used to make an adjustment to the roll of the bone
  45514. */
  45515. adjustRoll: number;
  45516. /**
  45517. * 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)
  45518. */
  45519. slerpAmount: number;
  45520. private _minYaw;
  45521. private _maxYaw;
  45522. private _minPitch;
  45523. private _maxPitch;
  45524. private _minYawSin;
  45525. private _minYawCos;
  45526. private _maxYawSin;
  45527. private _maxYawCos;
  45528. private _midYawConstraint;
  45529. private _minPitchTan;
  45530. private _maxPitchTan;
  45531. private _boneQuat;
  45532. private _slerping;
  45533. private _transformYawPitch;
  45534. private _transformYawPitchInv;
  45535. private _firstFrameSkipped;
  45536. private _yawRange;
  45537. private _fowardAxis;
  45538. /**
  45539. * Gets or sets the minimum yaw angle that the bone can look to
  45540. */
  45541. get minYaw(): number;
  45542. set minYaw(value: number);
  45543. /**
  45544. * Gets or sets the maximum yaw angle that the bone can look to
  45545. */
  45546. get maxYaw(): number;
  45547. set maxYaw(value: number);
  45548. /**
  45549. * Gets or sets the minimum pitch angle that the bone can look to
  45550. */
  45551. get minPitch(): number;
  45552. set minPitch(value: number);
  45553. /**
  45554. * Gets or sets the maximum pitch angle that the bone can look to
  45555. */
  45556. get maxPitch(): number;
  45557. set maxPitch(value: number);
  45558. /**
  45559. * Create a BoneLookController
  45560. * @param mesh the mesh that the bone belongs to
  45561. * @param bone the bone that will be looking to the target
  45562. * @param target the target Vector3 to look at
  45563. * @param options optional settings:
  45564. * * maxYaw: the maximum angle the bone will yaw to
  45565. * * minYaw: the minimum angle the bone will yaw to
  45566. * * maxPitch: the maximum angle the bone will pitch to
  45567. * * minPitch: the minimum angle the bone will yaw to
  45568. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  45569. * * upAxis: the up axis of the coordinate system
  45570. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  45571. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  45572. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  45573. * * adjustYaw: used to make an adjustment to the yaw of the bone
  45574. * * adjustPitch: used to make an adjustment to the pitch of the bone
  45575. * * adjustRoll: used to make an adjustment to the roll of the bone
  45576. **/
  45577. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  45578. maxYaw?: number;
  45579. minYaw?: number;
  45580. maxPitch?: number;
  45581. minPitch?: number;
  45582. slerpAmount?: number;
  45583. upAxis?: Vector3;
  45584. upAxisSpace?: Space;
  45585. yawAxis?: Vector3;
  45586. pitchAxis?: Vector3;
  45587. adjustYaw?: number;
  45588. adjustPitch?: number;
  45589. adjustRoll?: number;
  45590. });
  45591. /**
  45592. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  45593. */
  45594. update(): void;
  45595. private _getAngleDiff;
  45596. private _getAngleBetween;
  45597. private _isAngleBetween;
  45598. }
  45599. }
  45600. declare module "babylonjs/Bones/index" {
  45601. export * from "babylonjs/Bones/bone";
  45602. export * from "babylonjs/Bones/boneIKController";
  45603. export * from "babylonjs/Bones/boneLookController";
  45604. export * from "babylonjs/Bones/skeleton";
  45605. }
  45606. declare module "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput" {
  45607. import { Nullable } from "babylonjs/types";
  45608. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45609. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45610. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  45611. /**
  45612. * Manage the gamepad inputs to control an arc rotate camera.
  45613. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45614. */
  45615. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  45616. /**
  45617. * Defines the camera the input is attached to.
  45618. */
  45619. camera: ArcRotateCamera;
  45620. /**
  45621. * Defines the gamepad the input is gathering event from.
  45622. */
  45623. gamepad: Nullable<Gamepad>;
  45624. /**
  45625. * Defines the gamepad rotation sensiblity.
  45626. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  45627. */
  45628. gamepadRotationSensibility: number;
  45629. /**
  45630. * Defines the gamepad move sensiblity.
  45631. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  45632. */
  45633. gamepadMoveSensibility: number;
  45634. private _yAxisScale;
  45635. /**
  45636. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  45637. */
  45638. get invertYAxis(): boolean;
  45639. set invertYAxis(value: boolean);
  45640. private _onGamepadConnectedObserver;
  45641. private _onGamepadDisconnectedObserver;
  45642. /**
  45643. * Attach the input controls to a specific dom element to get the input from.
  45644. * @param element Defines the element the controls should be listened from
  45645. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45646. */
  45647. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45648. /**
  45649. * Detach the current controls from the specified dom element.
  45650. * @param element Defines the element to stop listening the inputs from
  45651. */
  45652. detachControl(element: Nullable<HTMLElement>): void;
  45653. /**
  45654. * Update the current camera state depending on the inputs that have been used this frame.
  45655. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45656. */
  45657. checkInputs(): void;
  45658. /**
  45659. * Gets the class name of the current intput.
  45660. * @returns the class name
  45661. */
  45662. getClassName(): string;
  45663. /**
  45664. * Get the friendly name associated with the input class.
  45665. * @returns the input friendly name
  45666. */
  45667. getSimpleName(): string;
  45668. }
  45669. }
  45670. declare module "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput" {
  45671. import { Nullable } from "babylonjs/types";
  45672. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45673. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45674. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  45675. interface ArcRotateCameraInputsManager {
  45676. /**
  45677. * Add orientation input support to the input manager.
  45678. * @returns the current input manager
  45679. */
  45680. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  45681. }
  45682. }
  45683. /**
  45684. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  45685. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45686. */
  45687. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  45688. /**
  45689. * Defines the camera the input is attached to.
  45690. */
  45691. camera: ArcRotateCamera;
  45692. /**
  45693. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  45694. */
  45695. alphaCorrection: number;
  45696. /**
  45697. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  45698. */
  45699. gammaCorrection: number;
  45700. private _alpha;
  45701. private _gamma;
  45702. private _dirty;
  45703. private _deviceOrientationHandler;
  45704. /**
  45705. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  45706. */
  45707. constructor();
  45708. /**
  45709. * Attach the input controls to a specific dom element to get the input from.
  45710. * @param element Defines the element the controls should be listened from
  45711. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45712. */
  45713. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45714. /** @hidden */
  45715. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  45716. /**
  45717. * Update the current camera state depending on the inputs that have been used this frame.
  45718. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45719. */
  45720. checkInputs(): void;
  45721. /**
  45722. * Detach the current controls from the specified dom element.
  45723. * @param element Defines the element to stop listening the inputs from
  45724. */
  45725. detachControl(element: Nullable<HTMLElement>): void;
  45726. /**
  45727. * Gets the class name of the current intput.
  45728. * @returns the class name
  45729. */
  45730. getClassName(): string;
  45731. /**
  45732. * Get the friendly name associated with the input class.
  45733. * @returns the input friendly name
  45734. */
  45735. getSimpleName(): string;
  45736. }
  45737. }
  45738. declare module "babylonjs/Cameras/Inputs/flyCameraMouseInput" {
  45739. import { Nullable } from "babylonjs/types";
  45740. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45741. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45742. /**
  45743. * Listen to mouse events to control the camera.
  45744. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45745. */
  45746. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  45747. /**
  45748. * Defines the camera the input is attached to.
  45749. */
  45750. camera: FlyCamera;
  45751. /**
  45752. * Defines if touch is enabled. (Default is true.)
  45753. */
  45754. touchEnabled: boolean;
  45755. /**
  45756. * Defines the buttons associated with the input to handle camera rotation.
  45757. */
  45758. buttons: number[];
  45759. /**
  45760. * Assign buttons for Yaw control.
  45761. */
  45762. buttonsYaw: number[];
  45763. /**
  45764. * Assign buttons for Pitch control.
  45765. */
  45766. buttonsPitch: number[];
  45767. /**
  45768. * Assign buttons for Roll control.
  45769. */
  45770. buttonsRoll: number[];
  45771. /**
  45772. * Detect if any button is being pressed while mouse is moved.
  45773. * -1 = Mouse locked.
  45774. * 0 = Left button.
  45775. * 1 = Middle Button.
  45776. * 2 = Right Button.
  45777. */
  45778. activeButton: number;
  45779. /**
  45780. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  45781. * Higher values reduce its sensitivity.
  45782. */
  45783. angularSensibility: number;
  45784. private _mousemoveCallback;
  45785. private _observer;
  45786. private _rollObserver;
  45787. private previousPosition;
  45788. private noPreventDefault;
  45789. private element;
  45790. /**
  45791. * Listen to mouse events to control the camera.
  45792. * @param touchEnabled Define if touch is enabled. (Default is true.)
  45793. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45794. */
  45795. constructor(touchEnabled?: boolean);
  45796. /**
  45797. * Attach the mouse control to the HTML DOM element.
  45798. * @param element Defines the element that listens to the input events.
  45799. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  45800. */
  45801. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45802. /**
  45803. * Detach the current controls from the specified dom element.
  45804. * @param element Defines the element to stop listening the inputs from
  45805. */
  45806. detachControl(element: Nullable<HTMLElement>): void;
  45807. /**
  45808. * Gets the class name of the current input.
  45809. * @returns the class name.
  45810. */
  45811. getClassName(): string;
  45812. /**
  45813. * Get the friendly name associated with the input class.
  45814. * @returns the input's friendly name.
  45815. */
  45816. getSimpleName(): string;
  45817. private _pointerInput;
  45818. private _onMouseMove;
  45819. /**
  45820. * Rotate camera by mouse offset.
  45821. */
  45822. private rotateCamera;
  45823. }
  45824. }
  45825. declare module "babylonjs/Cameras/flyCameraInputsManager" {
  45826. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45827. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  45828. /**
  45829. * Default Inputs manager for the FlyCamera.
  45830. * It groups all the default supported inputs for ease of use.
  45831. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45832. */
  45833. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  45834. /**
  45835. * Instantiates a new FlyCameraInputsManager.
  45836. * @param camera Defines the camera the inputs belong to.
  45837. */
  45838. constructor(camera: FlyCamera);
  45839. /**
  45840. * Add keyboard input support to the input manager.
  45841. * @returns the new FlyCameraKeyboardMoveInput().
  45842. */
  45843. addKeyboard(): FlyCameraInputsManager;
  45844. /**
  45845. * Add mouse input support to the input manager.
  45846. * @param touchEnabled Enable touch screen support.
  45847. * @returns the new FlyCameraMouseInput().
  45848. */
  45849. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  45850. }
  45851. }
  45852. declare module "babylonjs/Cameras/flyCamera" {
  45853. import { Scene } from "babylonjs/scene";
  45854. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  45855. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45856. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  45857. import { FlyCameraInputsManager } from "babylonjs/Cameras/flyCameraInputsManager";
  45858. /**
  45859. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45860. * such as in a 3D Space Shooter or a Flight Simulator.
  45861. */
  45862. export class FlyCamera extends TargetCamera {
  45863. /**
  45864. * Define the collision ellipsoid of the camera.
  45865. * This is helpful for simulating a camera body, like a player's body.
  45866. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  45867. */
  45868. ellipsoid: Vector3;
  45869. /**
  45870. * Define an offset for the position of the ellipsoid around the camera.
  45871. * This can be helpful if the camera is attached away from the player's body center,
  45872. * such as at its head.
  45873. */
  45874. ellipsoidOffset: Vector3;
  45875. /**
  45876. * Enable or disable collisions of the camera with the rest of the scene objects.
  45877. */
  45878. checkCollisions: boolean;
  45879. /**
  45880. * Enable or disable gravity on the camera.
  45881. */
  45882. applyGravity: boolean;
  45883. /**
  45884. * Define the current direction the camera is moving to.
  45885. */
  45886. cameraDirection: Vector3;
  45887. /**
  45888. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  45889. * This overrides and empties cameraRotation.
  45890. */
  45891. rotationQuaternion: Quaternion;
  45892. /**
  45893. * Track Roll to maintain the wanted Rolling when looking around.
  45894. */
  45895. _trackRoll: number;
  45896. /**
  45897. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  45898. */
  45899. rollCorrect: number;
  45900. /**
  45901. * Mimic a banked turn, Rolling the camera when Yawing.
  45902. * It's recommended to use rollCorrect = 10 for faster banking correction.
  45903. */
  45904. bankedTurn: boolean;
  45905. /**
  45906. * Limit in radians for how much Roll banking will add. (Default: 90°)
  45907. */
  45908. bankedTurnLimit: number;
  45909. /**
  45910. * Value of 0 disables the banked Roll.
  45911. * Value of 1 is equal to the Yaw angle in radians.
  45912. */
  45913. bankedTurnMultiplier: number;
  45914. /**
  45915. * The inputs manager loads all the input sources, such as keyboard and mouse.
  45916. */
  45917. inputs: FlyCameraInputsManager;
  45918. /**
  45919. * Gets the input sensibility for mouse input.
  45920. * Higher values reduce sensitivity.
  45921. */
  45922. get angularSensibility(): number;
  45923. /**
  45924. * Sets the input sensibility for a mouse input.
  45925. * Higher values reduce sensitivity.
  45926. */
  45927. set angularSensibility(value: number);
  45928. /**
  45929. * Get the keys for camera movement forward.
  45930. */
  45931. get keysForward(): number[];
  45932. /**
  45933. * Set the keys for camera movement forward.
  45934. */
  45935. set keysForward(value: number[]);
  45936. /**
  45937. * Get the keys for camera movement backward.
  45938. */
  45939. get keysBackward(): number[];
  45940. set keysBackward(value: number[]);
  45941. /**
  45942. * Get the keys for camera movement up.
  45943. */
  45944. get keysUp(): number[];
  45945. /**
  45946. * Set the keys for camera movement up.
  45947. */
  45948. set keysUp(value: number[]);
  45949. /**
  45950. * Get the keys for camera movement down.
  45951. */
  45952. get keysDown(): number[];
  45953. /**
  45954. * Set the keys for camera movement down.
  45955. */
  45956. set keysDown(value: number[]);
  45957. /**
  45958. * Get the keys for camera movement left.
  45959. */
  45960. get keysLeft(): number[];
  45961. /**
  45962. * Set the keys for camera movement left.
  45963. */
  45964. set keysLeft(value: number[]);
  45965. /**
  45966. * Set the keys for camera movement right.
  45967. */
  45968. get keysRight(): number[];
  45969. /**
  45970. * Set the keys for camera movement right.
  45971. */
  45972. set keysRight(value: number[]);
  45973. /**
  45974. * Event raised when the camera collides with a mesh in the scene.
  45975. */
  45976. onCollide: (collidedMesh: AbstractMesh) => void;
  45977. private _collider;
  45978. private _needMoveForGravity;
  45979. private _oldPosition;
  45980. private _diffPosition;
  45981. private _newPosition;
  45982. /** @hidden */
  45983. _localDirection: Vector3;
  45984. /** @hidden */
  45985. _transformedDirection: Vector3;
  45986. /**
  45987. * Instantiates a FlyCamera.
  45988. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45989. * such as in a 3D Space Shooter or a Flight Simulator.
  45990. * @param name Define the name of the camera in the scene.
  45991. * @param position Define the starting position of the camera in the scene.
  45992. * @param scene Define the scene the camera belongs to.
  45993. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  45994. */
  45995. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  45996. /**
  45997. * Attach a control to the HTML DOM element.
  45998. * @param element Defines the element that listens to the input events.
  45999. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  46000. */
  46001. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46002. /**
  46003. * Detach a control from the HTML DOM element.
  46004. * The camera will stop reacting to that input.
  46005. * @param element Defines the element that listens to the input events.
  46006. */
  46007. detachControl(element: HTMLElement): void;
  46008. private _collisionMask;
  46009. /**
  46010. * Get the mask that the camera ignores in collision events.
  46011. */
  46012. get collisionMask(): number;
  46013. /**
  46014. * Set the mask that the camera ignores in collision events.
  46015. */
  46016. set collisionMask(mask: number);
  46017. /** @hidden */
  46018. _collideWithWorld(displacement: Vector3): void;
  46019. /** @hidden */
  46020. private _onCollisionPositionChange;
  46021. /** @hidden */
  46022. _checkInputs(): void;
  46023. /** @hidden */
  46024. _decideIfNeedsToMove(): boolean;
  46025. /** @hidden */
  46026. _updatePosition(): void;
  46027. /**
  46028. * Restore the Roll to its target value at the rate specified.
  46029. * @param rate - Higher means slower restoring.
  46030. * @hidden
  46031. */
  46032. restoreRoll(rate: number): void;
  46033. /**
  46034. * Destroy the camera and release the current resources held by it.
  46035. */
  46036. dispose(): void;
  46037. /**
  46038. * Get the current object class name.
  46039. * @returns the class name.
  46040. */
  46041. getClassName(): string;
  46042. }
  46043. }
  46044. declare module "babylonjs/Cameras/Inputs/flyCameraKeyboardInput" {
  46045. import { Nullable } from "babylonjs/types";
  46046. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46047. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  46048. /**
  46049. * Listen to keyboard events to control the camera.
  46050. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46051. */
  46052. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  46053. /**
  46054. * Defines the camera the input is attached to.
  46055. */
  46056. camera: FlyCamera;
  46057. /**
  46058. * The list of keyboard keys used to control the forward move of the camera.
  46059. */
  46060. keysForward: number[];
  46061. /**
  46062. * The list of keyboard keys used to control the backward move of the camera.
  46063. */
  46064. keysBackward: number[];
  46065. /**
  46066. * The list of keyboard keys used to control the forward move of the camera.
  46067. */
  46068. keysUp: number[];
  46069. /**
  46070. * The list of keyboard keys used to control the backward move of the camera.
  46071. */
  46072. keysDown: number[];
  46073. /**
  46074. * The list of keyboard keys used to control the right strafe move of the camera.
  46075. */
  46076. keysRight: number[];
  46077. /**
  46078. * The list of keyboard keys used to control the left strafe move of the camera.
  46079. */
  46080. keysLeft: number[];
  46081. private _keys;
  46082. private _onCanvasBlurObserver;
  46083. private _onKeyboardObserver;
  46084. private _engine;
  46085. private _scene;
  46086. /**
  46087. * Attach the input controls to a specific dom element to get the input from.
  46088. * @param element Defines the element the controls should be listened from
  46089. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46090. */
  46091. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46092. /**
  46093. * Detach the current controls from the specified dom element.
  46094. * @param element Defines the element to stop listening the inputs from
  46095. */
  46096. detachControl(element: Nullable<HTMLElement>): void;
  46097. /**
  46098. * Gets the class name of the current intput.
  46099. * @returns the class name
  46100. */
  46101. getClassName(): string;
  46102. /** @hidden */
  46103. _onLostFocus(e: FocusEvent): void;
  46104. /**
  46105. * Get the friendly name associated with the input class.
  46106. * @returns the input friendly name
  46107. */
  46108. getSimpleName(): string;
  46109. /**
  46110. * Update the current camera state depending on the inputs that have been used this frame.
  46111. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46112. */
  46113. checkInputs(): void;
  46114. }
  46115. }
  46116. declare module "babylonjs/Cameras/Inputs/followCameraMouseWheelInput" {
  46117. import { Nullable } from "babylonjs/types";
  46118. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46119. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46120. /**
  46121. * Manage the mouse wheel inputs to control a follow camera.
  46122. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46123. */
  46124. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  46125. /**
  46126. * Defines the camera the input is attached to.
  46127. */
  46128. camera: FollowCamera;
  46129. /**
  46130. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  46131. */
  46132. axisControlRadius: boolean;
  46133. /**
  46134. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  46135. */
  46136. axisControlHeight: boolean;
  46137. /**
  46138. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  46139. */
  46140. axisControlRotation: boolean;
  46141. /**
  46142. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  46143. * relation to mouseWheel events.
  46144. */
  46145. wheelPrecision: number;
  46146. /**
  46147. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  46148. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  46149. */
  46150. wheelDeltaPercentage: number;
  46151. private _wheel;
  46152. private _observer;
  46153. /**
  46154. * Attach the input controls to a specific dom element to get the input from.
  46155. * @param element Defines the element the controls should be listened from
  46156. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46157. */
  46158. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46159. /**
  46160. * Detach the current controls from the specified dom element.
  46161. * @param element Defines the element to stop listening the inputs from
  46162. */
  46163. detachControl(element: Nullable<HTMLElement>): void;
  46164. /**
  46165. * Gets the class name of the current intput.
  46166. * @returns the class name
  46167. */
  46168. getClassName(): string;
  46169. /**
  46170. * Get the friendly name associated with the input class.
  46171. * @returns the input friendly name
  46172. */
  46173. getSimpleName(): string;
  46174. }
  46175. }
  46176. declare module "babylonjs/Cameras/Inputs/followCameraPointersInput" {
  46177. import { Nullable } from "babylonjs/types";
  46178. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46179. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  46180. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  46181. /**
  46182. * Manage the pointers inputs to control an follow camera.
  46183. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46184. */
  46185. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  46186. /**
  46187. * Defines the camera the input is attached to.
  46188. */
  46189. camera: FollowCamera;
  46190. /**
  46191. * Gets the class name of the current input.
  46192. * @returns the class name
  46193. */
  46194. getClassName(): string;
  46195. /**
  46196. * Defines the pointer angular sensibility along the X axis or how fast is
  46197. * the camera rotating.
  46198. * A negative number will reverse the axis direction.
  46199. */
  46200. angularSensibilityX: number;
  46201. /**
  46202. * Defines the pointer angular sensibility along the Y axis or how fast is
  46203. * the camera rotating.
  46204. * A negative number will reverse the axis direction.
  46205. */
  46206. angularSensibilityY: number;
  46207. /**
  46208. * Defines the pointer pinch precision or how fast is the camera zooming.
  46209. * A negative number will reverse the axis direction.
  46210. */
  46211. pinchPrecision: number;
  46212. /**
  46213. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  46214. * from 0.
  46215. * It defines the percentage of current camera.radius to use as delta when
  46216. * pinch zoom is used.
  46217. */
  46218. pinchDeltaPercentage: number;
  46219. /**
  46220. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  46221. */
  46222. axisXControlRadius: boolean;
  46223. /**
  46224. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  46225. */
  46226. axisXControlHeight: boolean;
  46227. /**
  46228. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  46229. */
  46230. axisXControlRotation: boolean;
  46231. /**
  46232. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  46233. */
  46234. axisYControlRadius: boolean;
  46235. /**
  46236. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  46237. */
  46238. axisYControlHeight: boolean;
  46239. /**
  46240. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  46241. */
  46242. axisYControlRotation: boolean;
  46243. /**
  46244. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  46245. */
  46246. axisPinchControlRadius: boolean;
  46247. /**
  46248. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  46249. */
  46250. axisPinchControlHeight: boolean;
  46251. /**
  46252. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  46253. */
  46254. axisPinchControlRotation: boolean;
  46255. /**
  46256. * Log error messages if basic misconfiguration has occurred.
  46257. */
  46258. warningEnable: boolean;
  46259. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  46260. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  46261. private _warningCounter;
  46262. private _warning;
  46263. }
  46264. }
  46265. declare module "babylonjs/Cameras/followCameraInputsManager" {
  46266. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  46267. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46268. /**
  46269. * Default Inputs manager for the FollowCamera.
  46270. * It groups all the default supported inputs for ease of use.
  46271. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46272. */
  46273. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  46274. /**
  46275. * Instantiates a new FollowCameraInputsManager.
  46276. * @param camera Defines the camera the inputs belong to
  46277. */
  46278. constructor(camera: FollowCamera);
  46279. /**
  46280. * Add keyboard input support to the input manager.
  46281. * @returns the current input manager
  46282. */
  46283. addKeyboard(): FollowCameraInputsManager;
  46284. /**
  46285. * Add mouse wheel input support to the input manager.
  46286. * @returns the current input manager
  46287. */
  46288. addMouseWheel(): FollowCameraInputsManager;
  46289. /**
  46290. * Add pointers input support to the input manager.
  46291. * @returns the current input manager
  46292. */
  46293. addPointers(): FollowCameraInputsManager;
  46294. /**
  46295. * Add orientation input support to the input manager.
  46296. * @returns the current input manager
  46297. */
  46298. addVRDeviceOrientation(): FollowCameraInputsManager;
  46299. }
  46300. }
  46301. declare module "babylonjs/Cameras/followCamera" {
  46302. import { Nullable } from "babylonjs/types";
  46303. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  46304. import { Scene } from "babylonjs/scene";
  46305. import { Vector3 } from "babylonjs/Maths/math.vector";
  46306. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46307. import { FollowCameraInputsManager } from "babylonjs/Cameras/followCameraInputsManager";
  46308. /**
  46309. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  46310. * an arc rotate version arcFollowCamera are available.
  46311. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46312. */
  46313. export class FollowCamera extends TargetCamera {
  46314. /**
  46315. * Distance the follow camera should follow an object at
  46316. */
  46317. radius: number;
  46318. /**
  46319. * Minimum allowed distance of the camera to the axis of rotation
  46320. * (The camera can not get closer).
  46321. * This can help limiting how the Camera is able to move in the scene.
  46322. */
  46323. lowerRadiusLimit: Nullable<number>;
  46324. /**
  46325. * Maximum allowed distance of the camera to the axis of rotation
  46326. * (The camera can not get further).
  46327. * This can help limiting how the Camera is able to move in the scene.
  46328. */
  46329. upperRadiusLimit: Nullable<number>;
  46330. /**
  46331. * Define a rotation offset between the camera and the object it follows
  46332. */
  46333. rotationOffset: number;
  46334. /**
  46335. * Minimum allowed angle to camera position relative to target object.
  46336. * This can help limiting how the Camera is able to move in the scene.
  46337. */
  46338. lowerRotationOffsetLimit: Nullable<number>;
  46339. /**
  46340. * Maximum allowed angle to camera position relative to target object.
  46341. * This can help limiting how the Camera is able to move in the scene.
  46342. */
  46343. upperRotationOffsetLimit: Nullable<number>;
  46344. /**
  46345. * Define a height offset between the camera and the object it follows.
  46346. * It can help following an object from the top (like a car chaing a plane)
  46347. */
  46348. heightOffset: number;
  46349. /**
  46350. * Minimum allowed height of camera position relative to target object.
  46351. * This can help limiting how the Camera is able to move in the scene.
  46352. */
  46353. lowerHeightOffsetLimit: Nullable<number>;
  46354. /**
  46355. * Maximum allowed height of camera position relative to target object.
  46356. * This can help limiting how the Camera is able to move in the scene.
  46357. */
  46358. upperHeightOffsetLimit: Nullable<number>;
  46359. /**
  46360. * Define how fast the camera can accelerate to follow it s target.
  46361. */
  46362. cameraAcceleration: number;
  46363. /**
  46364. * Define the speed limit of the camera following an object.
  46365. */
  46366. maxCameraSpeed: number;
  46367. /**
  46368. * Define the target of the camera.
  46369. */
  46370. lockedTarget: Nullable<AbstractMesh>;
  46371. /**
  46372. * Defines the input associated with the camera.
  46373. */
  46374. inputs: FollowCameraInputsManager;
  46375. /**
  46376. * Instantiates the follow camera.
  46377. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46378. * @param name Define the name of the camera in the scene
  46379. * @param position Define the position of the camera
  46380. * @param scene Define the scene the camera belong to
  46381. * @param lockedTarget Define the target of the camera
  46382. */
  46383. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  46384. private _follow;
  46385. /**
  46386. * Attached controls to the current camera.
  46387. * @param element Defines the element the controls should be listened from
  46388. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46389. */
  46390. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46391. /**
  46392. * Detach the current controls from the camera.
  46393. * The camera will stop reacting to inputs.
  46394. * @param element Defines the element to stop listening the inputs from
  46395. */
  46396. detachControl(element: HTMLElement): void;
  46397. /** @hidden */
  46398. _checkInputs(): void;
  46399. private _checkLimits;
  46400. /**
  46401. * Gets the camera class name.
  46402. * @returns the class name
  46403. */
  46404. getClassName(): string;
  46405. }
  46406. /**
  46407. * Arc Rotate version of the follow camera.
  46408. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  46409. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46410. */
  46411. export class ArcFollowCamera extends TargetCamera {
  46412. /** The longitudinal angle of the camera */
  46413. alpha: number;
  46414. /** The latitudinal angle of the camera */
  46415. beta: number;
  46416. /** The radius of the camera from its target */
  46417. radius: number;
  46418. private _cartesianCoordinates;
  46419. /** Define the camera target (the mesh it should follow) */
  46420. private _meshTarget;
  46421. /**
  46422. * Instantiates a new ArcFollowCamera
  46423. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46424. * @param name Define the name of the camera
  46425. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  46426. * @param beta Define the rotation angle of the camera around the elevation axis
  46427. * @param radius Define the radius of the camera from its target point
  46428. * @param target Define the target of the camera
  46429. * @param scene Define the scene the camera belongs to
  46430. */
  46431. constructor(name: string,
  46432. /** The longitudinal angle of the camera */
  46433. alpha: number,
  46434. /** The latitudinal angle of the camera */
  46435. beta: number,
  46436. /** The radius of the camera from its target */
  46437. radius: number,
  46438. /** Define the camera target (the mesh it should follow) */
  46439. target: Nullable<AbstractMesh>, scene: Scene);
  46440. private _follow;
  46441. /** @hidden */
  46442. _checkInputs(): void;
  46443. /**
  46444. * Returns the class name of the object.
  46445. * It is mostly used internally for serialization purposes.
  46446. */
  46447. getClassName(): string;
  46448. }
  46449. }
  46450. declare module "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput" {
  46451. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46452. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46453. import { Nullable } from "babylonjs/types";
  46454. /**
  46455. * Manage the keyboard inputs to control the movement of a follow camera.
  46456. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46457. */
  46458. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  46459. /**
  46460. * Defines the camera the input is attached to.
  46461. */
  46462. camera: FollowCamera;
  46463. /**
  46464. * Defines the list of key codes associated with the up action (increase heightOffset)
  46465. */
  46466. keysHeightOffsetIncr: number[];
  46467. /**
  46468. * Defines the list of key codes associated with the down action (decrease heightOffset)
  46469. */
  46470. keysHeightOffsetDecr: number[];
  46471. /**
  46472. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  46473. */
  46474. keysHeightOffsetModifierAlt: boolean;
  46475. /**
  46476. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  46477. */
  46478. keysHeightOffsetModifierCtrl: boolean;
  46479. /**
  46480. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  46481. */
  46482. keysHeightOffsetModifierShift: boolean;
  46483. /**
  46484. * Defines the list of key codes associated with the left action (increase rotationOffset)
  46485. */
  46486. keysRotationOffsetIncr: number[];
  46487. /**
  46488. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  46489. */
  46490. keysRotationOffsetDecr: number[];
  46491. /**
  46492. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  46493. */
  46494. keysRotationOffsetModifierAlt: boolean;
  46495. /**
  46496. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  46497. */
  46498. keysRotationOffsetModifierCtrl: boolean;
  46499. /**
  46500. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  46501. */
  46502. keysRotationOffsetModifierShift: boolean;
  46503. /**
  46504. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  46505. */
  46506. keysRadiusIncr: number[];
  46507. /**
  46508. * Defines the list of key codes associated with the zoom-out action (increase radius)
  46509. */
  46510. keysRadiusDecr: number[];
  46511. /**
  46512. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  46513. */
  46514. keysRadiusModifierAlt: boolean;
  46515. /**
  46516. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  46517. */
  46518. keysRadiusModifierCtrl: boolean;
  46519. /**
  46520. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  46521. */
  46522. keysRadiusModifierShift: boolean;
  46523. /**
  46524. * Defines the rate of change of heightOffset.
  46525. */
  46526. heightSensibility: number;
  46527. /**
  46528. * Defines the rate of change of rotationOffset.
  46529. */
  46530. rotationSensibility: number;
  46531. /**
  46532. * Defines the rate of change of radius.
  46533. */
  46534. radiusSensibility: number;
  46535. private _keys;
  46536. private _ctrlPressed;
  46537. private _altPressed;
  46538. private _shiftPressed;
  46539. private _onCanvasBlurObserver;
  46540. private _onKeyboardObserver;
  46541. private _engine;
  46542. private _scene;
  46543. /**
  46544. * Attach the input controls to a specific dom element to get the input from.
  46545. * @param element Defines the element the controls should be listened from
  46546. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46547. */
  46548. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46549. /**
  46550. * Detach the current controls from the specified dom element.
  46551. * @param element Defines the element to stop listening the inputs from
  46552. */
  46553. detachControl(element: Nullable<HTMLElement>): void;
  46554. /**
  46555. * Update the current camera state depending on the inputs that have been used this frame.
  46556. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46557. */
  46558. checkInputs(): void;
  46559. /**
  46560. * Gets the class name of the current input.
  46561. * @returns the class name
  46562. */
  46563. getClassName(): string;
  46564. /**
  46565. * Get the friendly name associated with the input class.
  46566. * @returns the input friendly name
  46567. */
  46568. getSimpleName(): string;
  46569. /**
  46570. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46571. * allow modification of the heightOffset value.
  46572. */
  46573. private _modifierHeightOffset;
  46574. /**
  46575. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46576. * allow modification of the rotationOffset value.
  46577. */
  46578. private _modifierRotationOffset;
  46579. /**
  46580. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46581. * allow modification of the radius value.
  46582. */
  46583. private _modifierRadius;
  46584. }
  46585. }
  46586. declare module "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput" {
  46587. import { Nullable } from "babylonjs/types";
  46588. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46589. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46590. import { Observable } from "babylonjs/Misc/observable";
  46591. module "babylonjs/Cameras/freeCameraInputsManager" {
  46592. interface FreeCameraInputsManager {
  46593. /**
  46594. * @hidden
  46595. */
  46596. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  46597. /**
  46598. * Add orientation input support to the input manager.
  46599. * @returns the current input manager
  46600. */
  46601. addDeviceOrientation(): FreeCameraInputsManager;
  46602. }
  46603. }
  46604. /**
  46605. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  46606. * Screen rotation is taken into account.
  46607. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46608. */
  46609. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  46610. private _camera;
  46611. private _screenOrientationAngle;
  46612. private _constantTranform;
  46613. private _screenQuaternion;
  46614. private _alpha;
  46615. private _beta;
  46616. private _gamma;
  46617. /**
  46618. * Can be used to detect if a device orientation sensor is available on a device
  46619. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  46620. * @returns a promise that will resolve on orientation change
  46621. */
  46622. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  46623. /**
  46624. * @hidden
  46625. */
  46626. _onDeviceOrientationChangedObservable: Observable<void>;
  46627. /**
  46628. * Instantiates a new input
  46629. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46630. */
  46631. constructor();
  46632. /**
  46633. * Define the camera controlled by the input.
  46634. */
  46635. get camera(): FreeCamera;
  46636. set camera(camera: FreeCamera);
  46637. /**
  46638. * Attach the input controls to a specific dom element to get the input from.
  46639. * @param element Defines the element the controls should be listened from
  46640. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46641. */
  46642. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46643. private _orientationChanged;
  46644. private _deviceOrientation;
  46645. /**
  46646. * Detach the current controls from the specified dom element.
  46647. * @param element Defines the element to stop listening the inputs from
  46648. */
  46649. detachControl(element: Nullable<HTMLElement>): void;
  46650. /**
  46651. * Update the current camera state depending on the inputs that have been used this frame.
  46652. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46653. */
  46654. checkInputs(): void;
  46655. /**
  46656. * Gets the class name of the current intput.
  46657. * @returns the class name
  46658. */
  46659. getClassName(): string;
  46660. /**
  46661. * Get the friendly name associated with the input class.
  46662. * @returns the input friendly name
  46663. */
  46664. getSimpleName(): string;
  46665. }
  46666. }
  46667. declare module "babylonjs/Cameras/Inputs/freeCameraGamepadInput" {
  46668. import { Nullable } from "babylonjs/types";
  46669. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46670. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46671. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46672. /**
  46673. * Manage the gamepad inputs to control a free camera.
  46674. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46675. */
  46676. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  46677. /**
  46678. * Define the camera the input is attached to.
  46679. */
  46680. camera: FreeCamera;
  46681. /**
  46682. * Define the Gamepad controlling the input
  46683. */
  46684. gamepad: Nullable<Gamepad>;
  46685. /**
  46686. * Defines the gamepad rotation sensiblity.
  46687. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  46688. */
  46689. gamepadAngularSensibility: number;
  46690. /**
  46691. * Defines the gamepad move sensiblity.
  46692. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  46693. */
  46694. gamepadMoveSensibility: number;
  46695. private _yAxisScale;
  46696. /**
  46697. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  46698. */
  46699. get invertYAxis(): boolean;
  46700. set invertYAxis(value: boolean);
  46701. private _onGamepadConnectedObserver;
  46702. private _onGamepadDisconnectedObserver;
  46703. private _cameraTransform;
  46704. private _deltaTransform;
  46705. private _vector3;
  46706. private _vector2;
  46707. /**
  46708. * Attach the input controls to a specific dom element to get the input from.
  46709. * @param element Defines the element the controls should be listened from
  46710. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46711. */
  46712. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46713. /**
  46714. * Detach the current controls from the specified dom element.
  46715. * @param element Defines the element to stop listening the inputs from
  46716. */
  46717. detachControl(element: Nullable<HTMLElement>): void;
  46718. /**
  46719. * Update the current camera state depending on the inputs that have been used this frame.
  46720. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46721. */
  46722. checkInputs(): void;
  46723. /**
  46724. * Gets the class name of the current intput.
  46725. * @returns the class name
  46726. */
  46727. getClassName(): string;
  46728. /**
  46729. * Get the friendly name associated with the input class.
  46730. * @returns the input friendly name
  46731. */
  46732. getSimpleName(): string;
  46733. }
  46734. }
  46735. declare module "babylonjs/Misc/virtualJoystick" {
  46736. import { Nullable } from "babylonjs/types";
  46737. import { Vector3 } from "babylonjs/Maths/math.vector";
  46738. /**
  46739. * Defines the potential axis of a Joystick
  46740. */
  46741. export enum JoystickAxis {
  46742. /** X axis */
  46743. X = 0,
  46744. /** Y axis */
  46745. Y = 1,
  46746. /** Z axis */
  46747. Z = 2
  46748. }
  46749. /**
  46750. * Represents the different customization options available
  46751. * for VirtualJoystick
  46752. */
  46753. interface VirtualJoystickCustomizations {
  46754. /**
  46755. * Size of the joystick's puck
  46756. */
  46757. puckSize: number;
  46758. /**
  46759. * Size of the joystick's container
  46760. */
  46761. containerSize: number;
  46762. /**
  46763. * Color of the joystick && puck
  46764. */
  46765. color: string;
  46766. /**
  46767. * Image URL for the joystick's puck
  46768. */
  46769. puckImage?: string;
  46770. /**
  46771. * Image URL for the joystick's container
  46772. */
  46773. containerImage?: string;
  46774. /**
  46775. * Defines the unmoving position of the joystick container
  46776. */
  46777. position?: {
  46778. x: number;
  46779. y: number;
  46780. };
  46781. /**
  46782. * Defines whether or not the joystick container is always visible
  46783. */
  46784. alwaysVisible: boolean;
  46785. /**
  46786. * Defines whether or not to limit the movement of the puck to the joystick's container
  46787. */
  46788. limitToContainer: boolean;
  46789. }
  46790. /**
  46791. * Class used to define virtual joystick (used in touch mode)
  46792. */
  46793. export class VirtualJoystick {
  46794. /**
  46795. * Gets or sets a boolean indicating that left and right values must be inverted
  46796. */
  46797. reverseLeftRight: boolean;
  46798. /**
  46799. * Gets or sets a boolean indicating that up and down values must be inverted
  46800. */
  46801. reverseUpDown: boolean;
  46802. /**
  46803. * Gets the offset value for the position (ie. the change of the position value)
  46804. */
  46805. deltaPosition: Vector3;
  46806. /**
  46807. * Gets a boolean indicating if the virtual joystick was pressed
  46808. */
  46809. pressed: boolean;
  46810. /**
  46811. * Canvas the virtual joystick will render onto, default z-index of this is 5
  46812. */
  46813. static Canvas: Nullable<HTMLCanvasElement>;
  46814. /**
  46815. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  46816. */
  46817. limitToContainer: boolean;
  46818. private static _globalJoystickIndex;
  46819. private static _alwaysVisibleSticks;
  46820. private static vjCanvasContext;
  46821. private static vjCanvasWidth;
  46822. private static vjCanvasHeight;
  46823. private static halfWidth;
  46824. private static _GetDefaultOptions;
  46825. private _action;
  46826. private _axisTargetedByLeftAndRight;
  46827. private _axisTargetedByUpAndDown;
  46828. private _joystickSensibility;
  46829. private _inversedSensibility;
  46830. private _joystickPointerID;
  46831. private _joystickColor;
  46832. private _joystickPointerPos;
  46833. private _joystickPreviousPointerPos;
  46834. private _joystickPointerStartPos;
  46835. private _deltaJoystickVector;
  46836. private _leftJoystick;
  46837. private _touches;
  46838. private _joystickPosition;
  46839. private _alwaysVisible;
  46840. private _puckImage;
  46841. private _containerImage;
  46842. private _joystickPuckSize;
  46843. private _joystickContainerSize;
  46844. private _clearPuckSize;
  46845. private _clearContainerSize;
  46846. private _clearPuckSizeOffset;
  46847. private _clearContainerSizeOffset;
  46848. private _onPointerDownHandlerRef;
  46849. private _onPointerMoveHandlerRef;
  46850. private _onPointerUpHandlerRef;
  46851. private _onResize;
  46852. /**
  46853. * Creates a new virtual joystick
  46854. * @param leftJoystick defines that the joystick is for left hand (false by default)
  46855. * @param customizations Defines the options we want to customize the VirtualJoystick
  46856. */
  46857. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  46858. /**
  46859. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  46860. * @param newJoystickSensibility defines the new sensibility
  46861. */
  46862. setJoystickSensibility(newJoystickSensibility: number): void;
  46863. private _onPointerDown;
  46864. private _onPointerMove;
  46865. private _onPointerUp;
  46866. /**
  46867. * Change the color of the virtual joystick
  46868. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  46869. */
  46870. setJoystickColor(newColor: string): void;
  46871. /**
  46872. * Size of the joystick's container
  46873. */
  46874. set containerSize(newSize: number);
  46875. get containerSize(): number;
  46876. /**
  46877. * Size of the joystick's puck
  46878. */
  46879. set puckSize(newSize: number);
  46880. get puckSize(): number;
  46881. /**
  46882. * Clears the set position of the joystick
  46883. */
  46884. clearPosition(): void;
  46885. /**
  46886. * Defines whether or not the joystick container is always visible
  46887. */
  46888. set alwaysVisible(value: boolean);
  46889. get alwaysVisible(): boolean;
  46890. /**
  46891. * Sets the constant position of the Joystick container
  46892. * @param x X axis coordinate
  46893. * @param y Y axis coordinate
  46894. */
  46895. setPosition(x: number, y: number): void;
  46896. /**
  46897. * Defines a callback to call when the joystick is touched
  46898. * @param action defines the callback
  46899. */
  46900. setActionOnTouch(action: () => any): void;
  46901. /**
  46902. * Defines which axis you'd like to control for left & right
  46903. * @param axis defines the axis to use
  46904. */
  46905. setAxisForLeftRight(axis: JoystickAxis): void;
  46906. /**
  46907. * Defines which axis you'd like to control for up & down
  46908. * @param axis defines the axis to use
  46909. */
  46910. setAxisForUpDown(axis: JoystickAxis): void;
  46911. /**
  46912. * Clears the canvas from the previous puck / container draw
  46913. */
  46914. private _clearPreviousDraw;
  46915. /**
  46916. * Loads `urlPath` to be used for the container's image
  46917. * @param urlPath defines the urlPath of an image to use
  46918. */
  46919. setContainerImage(urlPath: string): void;
  46920. /**
  46921. * Loads `urlPath` to be used for the puck's image
  46922. * @param urlPath defines the urlPath of an image to use
  46923. */
  46924. setPuckImage(urlPath: string): void;
  46925. /**
  46926. * Draws the Virtual Joystick's container
  46927. */
  46928. private _drawContainer;
  46929. /**
  46930. * Draws the Virtual Joystick's puck
  46931. */
  46932. private _drawPuck;
  46933. private _drawVirtualJoystick;
  46934. /**
  46935. * Release internal HTML canvas
  46936. */
  46937. releaseCanvas(): void;
  46938. }
  46939. }
  46940. declare module "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput" {
  46941. import { VirtualJoystick } from "babylonjs/Misc/virtualJoystick";
  46942. import { Nullable } from "babylonjs/types";
  46943. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46944. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46945. module "babylonjs/Cameras/freeCameraInputsManager" {
  46946. interface FreeCameraInputsManager {
  46947. /**
  46948. * Add virtual joystick input support to the input manager.
  46949. * @returns the current input manager
  46950. */
  46951. addVirtualJoystick(): FreeCameraInputsManager;
  46952. }
  46953. }
  46954. /**
  46955. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  46956. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46957. */
  46958. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  46959. /**
  46960. * Defines the camera the input is attached to.
  46961. */
  46962. camera: FreeCamera;
  46963. private _leftjoystick;
  46964. private _rightjoystick;
  46965. /**
  46966. * Gets the left stick of the virtual joystick.
  46967. * @returns The virtual Joystick
  46968. */
  46969. getLeftJoystick(): VirtualJoystick;
  46970. /**
  46971. * Gets the right stick of the virtual joystick.
  46972. * @returns The virtual Joystick
  46973. */
  46974. getRightJoystick(): VirtualJoystick;
  46975. /**
  46976. * Update the current camera state depending on the inputs that have been used this frame.
  46977. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46978. */
  46979. checkInputs(): void;
  46980. /**
  46981. * Attach the input controls to a specific dom element to get the input from.
  46982. * @param element Defines the element the controls should be listened from
  46983. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46984. */
  46985. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46986. /**
  46987. * Detach the current controls from the specified dom element.
  46988. * @param element Defines the element to stop listening the inputs from
  46989. */
  46990. detachControl(element: Nullable<HTMLElement>): void;
  46991. /**
  46992. * Gets the class name of the current intput.
  46993. * @returns the class name
  46994. */
  46995. getClassName(): string;
  46996. /**
  46997. * Get the friendly name associated with the input class.
  46998. * @returns the input friendly name
  46999. */
  47000. getSimpleName(): string;
  47001. }
  47002. }
  47003. declare module "babylonjs/Cameras/Inputs/index" {
  47004. export * from "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput";
  47005. export * from "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput";
  47006. export * from "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput";
  47007. export * from "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput";
  47008. export * from "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  47009. export * from "babylonjs/Cameras/Inputs/flyCameraKeyboardInput";
  47010. export * from "babylonjs/Cameras/Inputs/flyCameraMouseInput";
  47011. export * from "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput";
  47012. export * from "babylonjs/Cameras/Inputs/followCameraMouseWheelInput";
  47013. export * from "babylonjs/Cameras/Inputs/followCameraPointersInput";
  47014. export * from "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  47015. export * from "babylonjs/Cameras/Inputs/freeCameraGamepadInput";
  47016. export * from "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput";
  47017. export * from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  47018. export * from "babylonjs/Cameras/Inputs/freeCameraTouchInput";
  47019. export * from "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  47020. }
  47021. declare module "babylonjs/Cameras/touchCamera" {
  47022. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47023. import { Scene } from "babylonjs/scene";
  47024. import { Vector3 } from "babylonjs/Maths/math.vector";
  47025. /**
  47026. * This represents a FPS type of camera controlled by touch.
  47027. * This is like a universal camera minus the Gamepad controls.
  47028. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47029. */
  47030. export class TouchCamera extends FreeCamera {
  47031. /**
  47032. * Defines the touch sensibility for rotation.
  47033. * The higher the faster.
  47034. */
  47035. get touchAngularSensibility(): number;
  47036. set touchAngularSensibility(value: number);
  47037. /**
  47038. * Defines the touch sensibility for move.
  47039. * The higher the faster.
  47040. */
  47041. get touchMoveSensibility(): number;
  47042. set touchMoveSensibility(value: number);
  47043. /**
  47044. * Instantiates a new touch camera.
  47045. * This represents a FPS type of camera controlled by touch.
  47046. * This is like a universal camera minus the Gamepad controls.
  47047. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47048. * @param name Define the name of the camera in the scene
  47049. * @param position Define the start position of the camera in the scene
  47050. * @param scene Define the scene the camera belongs to
  47051. */
  47052. constructor(name: string, position: Vector3, scene: Scene);
  47053. /**
  47054. * Gets the current object class name.
  47055. * @return the class name
  47056. */
  47057. getClassName(): string;
  47058. /** @hidden */
  47059. _setupInputs(): void;
  47060. }
  47061. }
  47062. declare module "babylonjs/Cameras/deviceOrientationCamera" {
  47063. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47064. import { Scene } from "babylonjs/scene";
  47065. import { Vector3 } from "babylonjs/Maths/math.vector";
  47066. import "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  47067. import { Axis } from "babylonjs/Maths/math.axis";
  47068. /**
  47069. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  47070. * being tilted forward or back and left or right.
  47071. */
  47072. export class DeviceOrientationCamera extends FreeCamera {
  47073. private _initialQuaternion;
  47074. private _quaternionCache;
  47075. private _tmpDragQuaternion;
  47076. private _disablePointerInputWhenUsingDeviceOrientation;
  47077. /**
  47078. * Creates a new device orientation camera
  47079. * @param name The name of the camera
  47080. * @param position The start position camera
  47081. * @param scene The scene the camera belongs to
  47082. */
  47083. constructor(name: string, position: Vector3, scene: Scene);
  47084. /**
  47085. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  47086. */
  47087. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  47088. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  47089. private _dragFactor;
  47090. /**
  47091. * Enabled turning on the y axis when the orientation sensor is active
  47092. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  47093. */
  47094. enableHorizontalDragging(dragFactor?: number): void;
  47095. /**
  47096. * Gets the current instance class name ("DeviceOrientationCamera").
  47097. * This helps avoiding instanceof at run time.
  47098. * @returns the class name
  47099. */
  47100. getClassName(): string;
  47101. /**
  47102. * @hidden
  47103. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  47104. */
  47105. _checkInputs(): void;
  47106. /**
  47107. * Reset the camera to its default orientation on the specified axis only.
  47108. * @param axis The axis to reset
  47109. */
  47110. resetToCurrentRotation(axis?: Axis): void;
  47111. }
  47112. }
  47113. declare module "babylonjs/Gamepads/xboxGamepad" {
  47114. import { Observable } from "babylonjs/Misc/observable";
  47115. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47116. /**
  47117. * Defines supported buttons for XBox360 compatible gamepads
  47118. */
  47119. export enum Xbox360Button {
  47120. /** A */
  47121. A = 0,
  47122. /** B */
  47123. B = 1,
  47124. /** X */
  47125. X = 2,
  47126. /** Y */
  47127. Y = 3,
  47128. /** Left button */
  47129. LB = 4,
  47130. /** Right button */
  47131. RB = 5,
  47132. /** Back */
  47133. Back = 8,
  47134. /** Start */
  47135. Start = 9,
  47136. /** Left stick */
  47137. LeftStick = 10,
  47138. /** Right stick */
  47139. RightStick = 11
  47140. }
  47141. /** Defines values for XBox360 DPad */
  47142. export enum Xbox360Dpad {
  47143. /** Up */
  47144. Up = 12,
  47145. /** Down */
  47146. Down = 13,
  47147. /** Left */
  47148. Left = 14,
  47149. /** Right */
  47150. Right = 15
  47151. }
  47152. /**
  47153. * Defines a XBox360 gamepad
  47154. */
  47155. export class Xbox360Pad extends Gamepad {
  47156. private _leftTrigger;
  47157. private _rightTrigger;
  47158. private _onlefttriggerchanged;
  47159. private _onrighttriggerchanged;
  47160. private _onbuttondown;
  47161. private _onbuttonup;
  47162. private _ondpaddown;
  47163. private _ondpadup;
  47164. /** Observable raised when a button is pressed */
  47165. onButtonDownObservable: Observable<Xbox360Button>;
  47166. /** Observable raised when a button is released */
  47167. onButtonUpObservable: Observable<Xbox360Button>;
  47168. /** Observable raised when a pad is pressed */
  47169. onPadDownObservable: Observable<Xbox360Dpad>;
  47170. /** Observable raised when a pad is released */
  47171. onPadUpObservable: Observable<Xbox360Dpad>;
  47172. private _buttonA;
  47173. private _buttonB;
  47174. private _buttonX;
  47175. private _buttonY;
  47176. private _buttonBack;
  47177. private _buttonStart;
  47178. private _buttonLB;
  47179. private _buttonRB;
  47180. private _buttonLeftStick;
  47181. private _buttonRightStick;
  47182. private _dPadUp;
  47183. private _dPadDown;
  47184. private _dPadLeft;
  47185. private _dPadRight;
  47186. private _isXboxOnePad;
  47187. /**
  47188. * Creates a new XBox360 gamepad object
  47189. * @param id defines the id of this gamepad
  47190. * @param index defines its index
  47191. * @param gamepad defines the internal HTML gamepad object
  47192. * @param xboxOne defines if it is a XBox One gamepad
  47193. */
  47194. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  47195. /**
  47196. * Defines the callback to call when left trigger is pressed
  47197. * @param callback defines the callback to use
  47198. */
  47199. onlefttriggerchanged(callback: (value: number) => void): void;
  47200. /**
  47201. * Defines the callback to call when right trigger is pressed
  47202. * @param callback defines the callback to use
  47203. */
  47204. onrighttriggerchanged(callback: (value: number) => void): void;
  47205. /**
  47206. * Gets the left trigger value
  47207. */
  47208. get leftTrigger(): number;
  47209. /**
  47210. * Sets the left trigger value
  47211. */
  47212. set leftTrigger(newValue: number);
  47213. /**
  47214. * Gets the right trigger value
  47215. */
  47216. get rightTrigger(): number;
  47217. /**
  47218. * Sets the right trigger value
  47219. */
  47220. set rightTrigger(newValue: number);
  47221. /**
  47222. * Defines the callback to call when a button is pressed
  47223. * @param callback defines the callback to use
  47224. */
  47225. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  47226. /**
  47227. * Defines the callback to call when a button is released
  47228. * @param callback defines the callback to use
  47229. */
  47230. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  47231. /**
  47232. * Defines the callback to call when a pad is pressed
  47233. * @param callback defines the callback to use
  47234. */
  47235. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  47236. /**
  47237. * Defines the callback to call when a pad is released
  47238. * @param callback defines the callback to use
  47239. */
  47240. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  47241. private _setButtonValue;
  47242. private _setDPadValue;
  47243. /**
  47244. * Gets the value of the `A` button
  47245. */
  47246. get buttonA(): number;
  47247. /**
  47248. * Sets the value of the `A` button
  47249. */
  47250. set buttonA(value: number);
  47251. /**
  47252. * Gets the value of the `B` button
  47253. */
  47254. get buttonB(): number;
  47255. /**
  47256. * Sets the value of the `B` button
  47257. */
  47258. set buttonB(value: number);
  47259. /**
  47260. * Gets the value of the `X` button
  47261. */
  47262. get buttonX(): number;
  47263. /**
  47264. * Sets the value of the `X` button
  47265. */
  47266. set buttonX(value: number);
  47267. /**
  47268. * Gets the value of the `Y` button
  47269. */
  47270. get buttonY(): number;
  47271. /**
  47272. * Sets the value of the `Y` button
  47273. */
  47274. set buttonY(value: number);
  47275. /**
  47276. * Gets the value of the `Start` button
  47277. */
  47278. get buttonStart(): number;
  47279. /**
  47280. * Sets the value of the `Start` button
  47281. */
  47282. set buttonStart(value: number);
  47283. /**
  47284. * Gets the value of the `Back` button
  47285. */
  47286. get buttonBack(): number;
  47287. /**
  47288. * Sets the value of the `Back` button
  47289. */
  47290. set buttonBack(value: number);
  47291. /**
  47292. * Gets the value of the `Left` button
  47293. */
  47294. get buttonLB(): number;
  47295. /**
  47296. * Sets the value of the `Left` button
  47297. */
  47298. set buttonLB(value: number);
  47299. /**
  47300. * Gets the value of the `Right` button
  47301. */
  47302. get buttonRB(): number;
  47303. /**
  47304. * Sets the value of the `Right` button
  47305. */
  47306. set buttonRB(value: number);
  47307. /**
  47308. * Gets the value of the Left joystick
  47309. */
  47310. get buttonLeftStick(): number;
  47311. /**
  47312. * Sets the value of the Left joystick
  47313. */
  47314. set buttonLeftStick(value: number);
  47315. /**
  47316. * Gets the value of the Right joystick
  47317. */
  47318. get buttonRightStick(): number;
  47319. /**
  47320. * Sets the value of the Right joystick
  47321. */
  47322. set buttonRightStick(value: number);
  47323. /**
  47324. * Gets the value of D-pad up
  47325. */
  47326. get dPadUp(): number;
  47327. /**
  47328. * Sets the value of D-pad up
  47329. */
  47330. set dPadUp(value: number);
  47331. /**
  47332. * Gets the value of D-pad down
  47333. */
  47334. get dPadDown(): number;
  47335. /**
  47336. * Sets the value of D-pad down
  47337. */
  47338. set dPadDown(value: number);
  47339. /**
  47340. * Gets the value of D-pad left
  47341. */
  47342. get dPadLeft(): number;
  47343. /**
  47344. * Sets the value of D-pad left
  47345. */
  47346. set dPadLeft(value: number);
  47347. /**
  47348. * Gets the value of D-pad right
  47349. */
  47350. get dPadRight(): number;
  47351. /**
  47352. * Sets the value of D-pad right
  47353. */
  47354. set dPadRight(value: number);
  47355. /**
  47356. * Force the gamepad to synchronize with device values
  47357. */
  47358. update(): void;
  47359. /**
  47360. * Disposes the gamepad
  47361. */
  47362. dispose(): void;
  47363. }
  47364. }
  47365. declare module "babylonjs/Gamepads/dualShockGamepad" {
  47366. import { Observable } from "babylonjs/Misc/observable";
  47367. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47368. /**
  47369. * Defines supported buttons for DualShock compatible gamepads
  47370. */
  47371. export enum DualShockButton {
  47372. /** Cross */
  47373. Cross = 0,
  47374. /** Circle */
  47375. Circle = 1,
  47376. /** Square */
  47377. Square = 2,
  47378. /** Triangle */
  47379. Triangle = 3,
  47380. /** L1 */
  47381. L1 = 4,
  47382. /** R1 */
  47383. R1 = 5,
  47384. /** Share */
  47385. Share = 8,
  47386. /** Options */
  47387. Options = 9,
  47388. /** Left stick */
  47389. LeftStick = 10,
  47390. /** Right stick */
  47391. RightStick = 11
  47392. }
  47393. /** Defines values for DualShock DPad */
  47394. export enum DualShockDpad {
  47395. /** Up */
  47396. Up = 12,
  47397. /** Down */
  47398. Down = 13,
  47399. /** Left */
  47400. Left = 14,
  47401. /** Right */
  47402. Right = 15
  47403. }
  47404. /**
  47405. * Defines a DualShock gamepad
  47406. */
  47407. export class DualShockPad extends Gamepad {
  47408. private _leftTrigger;
  47409. private _rightTrigger;
  47410. private _onlefttriggerchanged;
  47411. private _onrighttriggerchanged;
  47412. private _onbuttondown;
  47413. private _onbuttonup;
  47414. private _ondpaddown;
  47415. private _ondpadup;
  47416. /** Observable raised when a button is pressed */
  47417. onButtonDownObservable: Observable<DualShockButton>;
  47418. /** Observable raised when a button is released */
  47419. onButtonUpObservable: Observable<DualShockButton>;
  47420. /** Observable raised when a pad is pressed */
  47421. onPadDownObservable: Observable<DualShockDpad>;
  47422. /** Observable raised when a pad is released */
  47423. onPadUpObservable: Observable<DualShockDpad>;
  47424. private _buttonCross;
  47425. private _buttonCircle;
  47426. private _buttonSquare;
  47427. private _buttonTriangle;
  47428. private _buttonShare;
  47429. private _buttonOptions;
  47430. private _buttonL1;
  47431. private _buttonR1;
  47432. private _buttonLeftStick;
  47433. private _buttonRightStick;
  47434. private _dPadUp;
  47435. private _dPadDown;
  47436. private _dPadLeft;
  47437. private _dPadRight;
  47438. /**
  47439. * Creates a new DualShock gamepad object
  47440. * @param id defines the id of this gamepad
  47441. * @param index defines its index
  47442. * @param gamepad defines the internal HTML gamepad object
  47443. */
  47444. constructor(id: string, index: number, gamepad: any);
  47445. /**
  47446. * Defines the callback to call when left trigger is pressed
  47447. * @param callback defines the callback to use
  47448. */
  47449. onlefttriggerchanged(callback: (value: number) => void): void;
  47450. /**
  47451. * Defines the callback to call when right trigger is pressed
  47452. * @param callback defines the callback to use
  47453. */
  47454. onrighttriggerchanged(callback: (value: number) => void): void;
  47455. /**
  47456. * Gets the left trigger value
  47457. */
  47458. get leftTrigger(): number;
  47459. /**
  47460. * Sets the left trigger value
  47461. */
  47462. set leftTrigger(newValue: number);
  47463. /**
  47464. * Gets the right trigger value
  47465. */
  47466. get rightTrigger(): number;
  47467. /**
  47468. * Sets the right trigger value
  47469. */
  47470. set rightTrigger(newValue: number);
  47471. /**
  47472. * Defines the callback to call when a button is pressed
  47473. * @param callback defines the callback to use
  47474. */
  47475. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  47476. /**
  47477. * Defines the callback to call when a button is released
  47478. * @param callback defines the callback to use
  47479. */
  47480. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  47481. /**
  47482. * Defines the callback to call when a pad is pressed
  47483. * @param callback defines the callback to use
  47484. */
  47485. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  47486. /**
  47487. * Defines the callback to call when a pad is released
  47488. * @param callback defines the callback to use
  47489. */
  47490. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  47491. private _setButtonValue;
  47492. private _setDPadValue;
  47493. /**
  47494. * Gets the value of the `Cross` button
  47495. */
  47496. get buttonCross(): number;
  47497. /**
  47498. * Sets the value of the `Cross` button
  47499. */
  47500. set buttonCross(value: number);
  47501. /**
  47502. * Gets the value of the `Circle` button
  47503. */
  47504. get buttonCircle(): number;
  47505. /**
  47506. * Sets the value of the `Circle` button
  47507. */
  47508. set buttonCircle(value: number);
  47509. /**
  47510. * Gets the value of the `Square` button
  47511. */
  47512. get buttonSquare(): number;
  47513. /**
  47514. * Sets the value of the `Square` button
  47515. */
  47516. set buttonSquare(value: number);
  47517. /**
  47518. * Gets the value of the `Triangle` button
  47519. */
  47520. get buttonTriangle(): number;
  47521. /**
  47522. * Sets the value of the `Triangle` button
  47523. */
  47524. set buttonTriangle(value: number);
  47525. /**
  47526. * Gets the value of the `Options` button
  47527. */
  47528. get buttonOptions(): number;
  47529. /**
  47530. * Sets the value of the `Options` button
  47531. */
  47532. set buttonOptions(value: number);
  47533. /**
  47534. * Gets the value of the `Share` button
  47535. */
  47536. get buttonShare(): number;
  47537. /**
  47538. * Sets the value of the `Share` button
  47539. */
  47540. set buttonShare(value: number);
  47541. /**
  47542. * Gets the value of the `L1` button
  47543. */
  47544. get buttonL1(): number;
  47545. /**
  47546. * Sets the value of the `L1` button
  47547. */
  47548. set buttonL1(value: number);
  47549. /**
  47550. * Gets the value of the `R1` button
  47551. */
  47552. get buttonR1(): number;
  47553. /**
  47554. * Sets the value of the `R1` button
  47555. */
  47556. set buttonR1(value: number);
  47557. /**
  47558. * Gets the value of the Left joystick
  47559. */
  47560. get buttonLeftStick(): number;
  47561. /**
  47562. * Sets the value of the Left joystick
  47563. */
  47564. set buttonLeftStick(value: number);
  47565. /**
  47566. * Gets the value of the Right joystick
  47567. */
  47568. get buttonRightStick(): number;
  47569. /**
  47570. * Sets the value of the Right joystick
  47571. */
  47572. set buttonRightStick(value: number);
  47573. /**
  47574. * Gets the value of D-pad up
  47575. */
  47576. get dPadUp(): number;
  47577. /**
  47578. * Sets the value of D-pad up
  47579. */
  47580. set dPadUp(value: number);
  47581. /**
  47582. * Gets the value of D-pad down
  47583. */
  47584. get dPadDown(): number;
  47585. /**
  47586. * Sets the value of D-pad down
  47587. */
  47588. set dPadDown(value: number);
  47589. /**
  47590. * Gets the value of D-pad left
  47591. */
  47592. get dPadLeft(): number;
  47593. /**
  47594. * Sets the value of D-pad left
  47595. */
  47596. set dPadLeft(value: number);
  47597. /**
  47598. * Gets the value of D-pad right
  47599. */
  47600. get dPadRight(): number;
  47601. /**
  47602. * Sets the value of D-pad right
  47603. */
  47604. set dPadRight(value: number);
  47605. /**
  47606. * Force the gamepad to synchronize with device values
  47607. */
  47608. update(): void;
  47609. /**
  47610. * Disposes the gamepad
  47611. */
  47612. dispose(): void;
  47613. }
  47614. }
  47615. declare module "babylonjs/Gamepads/gamepadManager" {
  47616. import { Observable } from "babylonjs/Misc/observable";
  47617. import { Nullable } from "babylonjs/types";
  47618. import { Scene } from "babylonjs/scene";
  47619. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47620. /**
  47621. * Manager for handling gamepads
  47622. */
  47623. export class GamepadManager {
  47624. private _scene?;
  47625. private _babylonGamepads;
  47626. private _oneGamepadConnected;
  47627. /** @hidden */
  47628. _isMonitoring: boolean;
  47629. private _gamepadEventSupported;
  47630. private _gamepadSupport?;
  47631. /**
  47632. * observable to be triggered when the gamepad controller has been connected
  47633. */
  47634. onGamepadConnectedObservable: Observable<Gamepad>;
  47635. /**
  47636. * observable to be triggered when the gamepad controller has been disconnected
  47637. */
  47638. onGamepadDisconnectedObservable: Observable<Gamepad>;
  47639. private _onGamepadConnectedEvent;
  47640. private _onGamepadDisconnectedEvent;
  47641. /**
  47642. * Initializes the gamepad manager
  47643. * @param _scene BabylonJS scene
  47644. */
  47645. constructor(_scene?: Scene | undefined);
  47646. /**
  47647. * The gamepads in the game pad manager
  47648. */
  47649. get gamepads(): Gamepad[];
  47650. /**
  47651. * Get the gamepad controllers based on type
  47652. * @param type The type of gamepad controller
  47653. * @returns Nullable gamepad
  47654. */
  47655. getGamepadByType(type?: number): Nullable<Gamepad>;
  47656. /**
  47657. * Disposes the gamepad manager
  47658. */
  47659. dispose(): void;
  47660. private _addNewGamepad;
  47661. private _startMonitoringGamepads;
  47662. private _stopMonitoringGamepads;
  47663. /** @hidden */
  47664. _checkGamepadsStatus(): void;
  47665. private _updateGamepadObjects;
  47666. }
  47667. }
  47668. declare module "babylonjs/Gamepads/gamepadSceneComponent" {
  47669. import { Nullable } from "babylonjs/types";
  47670. import { Scene } from "babylonjs/scene";
  47671. import { ISceneComponent } from "babylonjs/sceneComponent";
  47672. import { GamepadManager } from "babylonjs/Gamepads/gamepadManager";
  47673. module "babylonjs/scene" {
  47674. interface Scene {
  47675. /** @hidden */
  47676. _gamepadManager: Nullable<GamepadManager>;
  47677. /**
  47678. * Gets the gamepad manager associated with the scene
  47679. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  47680. */
  47681. gamepadManager: GamepadManager;
  47682. }
  47683. }
  47684. module "babylonjs/Cameras/freeCameraInputsManager" {
  47685. /**
  47686. * Interface representing a free camera inputs manager
  47687. */
  47688. interface FreeCameraInputsManager {
  47689. /**
  47690. * Adds gamepad input support to the FreeCameraInputsManager.
  47691. * @returns the FreeCameraInputsManager
  47692. */
  47693. addGamepad(): FreeCameraInputsManager;
  47694. }
  47695. }
  47696. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  47697. /**
  47698. * Interface representing an arc rotate camera inputs manager
  47699. */
  47700. interface ArcRotateCameraInputsManager {
  47701. /**
  47702. * Adds gamepad input support to the ArcRotateCamera InputManager.
  47703. * @returns the camera inputs manager
  47704. */
  47705. addGamepad(): ArcRotateCameraInputsManager;
  47706. }
  47707. }
  47708. /**
  47709. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  47710. */
  47711. export class GamepadSystemSceneComponent implements ISceneComponent {
  47712. /**
  47713. * The component name helpfull to identify the component in the list of scene components.
  47714. */
  47715. readonly name: string;
  47716. /**
  47717. * The scene the component belongs to.
  47718. */
  47719. scene: Scene;
  47720. /**
  47721. * Creates a new instance of the component for the given scene
  47722. * @param scene Defines the scene to register the component in
  47723. */
  47724. constructor(scene: Scene);
  47725. /**
  47726. * Registers the component in a given scene
  47727. */
  47728. register(): void;
  47729. /**
  47730. * Rebuilds the elements related to this component in case of
  47731. * context lost for instance.
  47732. */
  47733. rebuild(): void;
  47734. /**
  47735. * Disposes the component and the associated ressources
  47736. */
  47737. dispose(): void;
  47738. private _beforeCameraUpdate;
  47739. }
  47740. }
  47741. declare module "babylonjs/Cameras/universalCamera" {
  47742. import { TouchCamera } from "babylonjs/Cameras/touchCamera";
  47743. import { Scene } from "babylonjs/scene";
  47744. import { Vector3 } from "babylonjs/Maths/math.vector";
  47745. import "babylonjs/Gamepads/gamepadSceneComponent";
  47746. /**
  47747. * 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,
  47748. * which still works and will still be found in many Playgrounds.
  47749. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47750. */
  47751. export class UniversalCamera extends TouchCamera {
  47752. /**
  47753. * Defines the gamepad rotation sensiblity.
  47754. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  47755. */
  47756. get gamepadAngularSensibility(): number;
  47757. set gamepadAngularSensibility(value: number);
  47758. /**
  47759. * Defines the gamepad move sensiblity.
  47760. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  47761. */
  47762. get gamepadMoveSensibility(): number;
  47763. set gamepadMoveSensibility(value: number);
  47764. /**
  47765. * 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,
  47766. * which still works and will still be found in many Playgrounds.
  47767. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47768. * @param name Define the name of the camera in the scene
  47769. * @param position Define the start position of the camera in the scene
  47770. * @param scene Define the scene the camera belongs to
  47771. */
  47772. constructor(name: string, position: Vector3, scene: Scene);
  47773. /**
  47774. * Gets the current object class name.
  47775. * @return the class name
  47776. */
  47777. getClassName(): string;
  47778. }
  47779. }
  47780. declare module "babylonjs/Cameras/gamepadCamera" {
  47781. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47782. import { Scene } from "babylonjs/scene";
  47783. import { Vector3 } from "babylonjs/Maths/math.vector";
  47784. /**
  47785. * This represents a FPS type of camera. This is only here for back compat purpose.
  47786. * Please use the UniversalCamera instead as both are identical.
  47787. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47788. */
  47789. export class GamepadCamera extends UniversalCamera {
  47790. /**
  47791. * Instantiates a new Gamepad Camera
  47792. * This represents a FPS type of camera. This is only here for back compat purpose.
  47793. * Please use the UniversalCamera instead as both are identical.
  47794. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47795. * @param name Define the name of the camera in the scene
  47796. * @param position Define the start position of the camera in the scene
  47797. * @param scene Define the scene the camera belongs to
  47798. */
  47799. constructor(name: string, position: Vector3, scene: Scene);
  47800. /**
  47801. * Gets the current object class name.
  47802. * @return the class name
  47803. */
  47804. getClassName(): string;
  47805. }
  47806. }
  47807. declare module "babylonjs/Shaders/pass.fragment" {
  47808. /** @hidden */
  47809. export var passPixelShader: {
  47810. name: string;
  47811. shader: string;
  47812. };
  47813. }
  47814. declare module "babylonjs/Shaders/passCube.fragment" {
  47815. /** @hidden */
  47816. export var passCubePixelShader: {
  47817. name: string;
  47818. shader: string;
  47819. };
  47820. }
  47821. declare module "babylonjs/PostProcesses/passPostProcess" {
  47822. import { Nullable } from "babylonjs/types";
  47823. import { Camera } from "babylonjs/Cameras/camera";
  47824. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47825. import { Engine } from "babylonjs/Engines/engine";
  47826. import "babylonjs/Shaders/pass.fragment";
  47827. import "babylonjs/Shaders/passCube.fragment";
  47828. import { Scene } from "babylonjs/scene";
  47829. /**
  47830. * PassPostProcess which produces an output the same as it's input
  47831. */
  47832. export class PassPostProcess extends PostProcess {
  47833. /**
  47834. * Gets a string identifying the name of the class
  47835. * @returns "PassPostProcess" string
  47836. */
  47837. getClassName(): string;
  47838. /**
  47839. * Creates the PassPostProcess
  47840. * @param name The name of the effect.
  47841. * @param options The required width/height ratio to downsize to before computing the render pass.
  47842. * @param camera The camera to apply the render pass to.
  47843. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47844. * @param engine The engine which the post process will be applied. (default: current engine)
  47845. * @param reusable If the post process can be reused on the same frame. (default: false)
  47846. * @param textureType The type of texture to be used when performing the post processing.
  47847. * @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)
  47848. */
  47849. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47850. /** @hidden */
  47851. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  47852. }
  47853. /**
  47854. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  47855. */
  47856. export class PassCubePostProcess extends PostProcess {
  47857. private _face;
  47858. /**
  47859. * Gets or sets the cube face to display.
  47860. * * 0 is +X
  47861. * * 1 is -X
  47862. * * 2 is +Y
  47863. * * 3 is -Y
  47864. * * 4 is +Z
  47865. * * 5 is -Z
  47866. */
  47867. get face(): number;
  47868. set face(value: number);
  47869. /**
  47870. * Gets a string identifying the name of the class
  47871. * @returns "PassCubePostProcess" string
  47872. */
  47873. getClassName(): string;
  47874. /**
  47875. * Creates the PassCubePostProcess
  47876. * @param name The name of the effect.
  47877. * @param options The required width/height ratio to downsize to before computing the render pass.
  47878. * @param camera The camera to apply the render pass to.
  47879. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47880. * @param engine The engine which the post process will be applied. (default: current engine)
  47881. * @param reusable If the post process can be reused on the same frame. (default: false)
  47882. * @param textureType The type of texture to be used when performing the post processing.
  47883. * @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)
  47884. */
  47885. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47886. /** @hidden */
  47887. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  47888. }
  47889. }
  47890. declare module "babylonjs/Shaders/anaglyph.fragment" {
  47891. /** @hidden */
  47892. export var anaglyphPixelShader: {
  47893. name: string;
  47894. shader: string;
  47895. };
  47896. }
  47897. declare module "babylonjs/PostProcesses/anaglyphPostProcess" {
  47898. import { Engine } from "babylonjs/Engines/engine";
  47899. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47900. import { Camera } from "babylonjs/Cameras/camera";
  47901. import "babylonjs/Shaders/anaglyph.fragment";
  47902. /**
  47903. * Postprocess used to generate anaglyphic rendering
  47904. */
  47905. export class AnaglyphPostProcess extends PostProcess {
  47906. private _passedProcess;
  47907. /**
  47908. * Gets a string identifying the name of the class
  47909. * @returns "AnaglyphPostProcess" string
  47910. */
  47911. getClassName(): string;
  47912. /**
  47913. * Creates a new AnaglyphPostProcess
  47914. * @param name defines postprocess name
  47915. * @param options defines creation options or target ratio scale
  47916. * @param rigCameras defines cameras using this postprocess
  47917. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  47918. * @param engine defines hosting engine
  47919. * @param reusable defines if the postprocess will be reused multiple times per frame
  47920. */
  47921. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  47922. }
  47923. }
  47924. declare module "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode" { }
  47925. declare module "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera" {
  47926. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47927. import { Scene } from "babylonjs/scene";
  47928. import { Vector3 } from "babylonjs/Maths/math.vector";
  47929. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47930. /**
  47931. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  47932. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47933. */
  47934. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  47935. /**
  47936. * Creates a new AnaglyphArcRotateCamera
  47937. * @param name defines camera name
  47938. * @param alpha defines alpha angle (in radians)
  47939. * @param beta defines beta angle (in radians)
  47940. * @param radius defines radius
  47941. * @param target defines camera target
  47942. * @param interaxialDistance defines distance between each color axis
  47943. * @param scene defines the hosting scene
  47944. */
  47945. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  47946. /**
  47947. * Gets camera class name
  47948. * @returns AnaglyphArcRotateCamera
  47949. */
  47950. getClassName(): string;
  47951. }
  47952. }
  47953. declare module "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera" {
  47954. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47955. import { Scene } from "babylonjs/scene";
  47956. import { Vector3 } from "babylonjs/Maths/math.vector";
  47957. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47958. /**
  47959. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  47960. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47961. */
  47962. export class AnaglyphFreeCamera extends FreeCamera {
  47963. /**
  47964. * Creates a new AnaglyphFreeCamera
  47965. * @param name defines camera name
  47966. * @param position defines initial position
  47967. * @param interaxialDistance defines distance between each color axis
  47968. * @param scene defines the hosting scene
  47969. */
  47970. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47971. /**
  47972. * Gets camera class name
  47973. * @returns AnaglyphFreeCamera
  47974. */
  47975. getClassName(): string;
  47976. }
  47977. }
  47978. declare module "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera" {
  47979. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  47980. import { Scene } from "babylonjs/scene";
  47981. import { Vector3 } from "babylonjs/Maths/math.vector";
  47982. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47983. /**
  47984. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  47985. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47986. */
  47987. export class AnaglyphGamepadCamera extends GamepadCamera {
  47988. /**
  47989. * Creates a new AnaglyphGamepadCamera
  47990. * @param name defines camera name
  47991. * @param position defines initial position
  47992. * @param interaxialDistance defines distance between each color axis
  47993. * @param scene defines the hosting scene
  47994. */
  47995. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47996. /**
  47997. * Gets camera class name
  47998. * @returns AnaglyphGamepadCamera
  47999. */
  48000. getClassName(): string;
  48001. }
  48002. }
  48003. declare module "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera" {
  48004. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  48005. import { Scene } from "babylonjs/scene";
  48006. import { Vector3 } from "babylonjs/Maths/math.vector";
  48007. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  48008. /**
  48009. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  48010. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  48011. */
  48012. export class AnaglyphUniversalCamera extends UniversalCamera {
  48013. /**
  48014. * Creates a new AnaglyphUniversalCamera
  48015. * @param name defines camera name
  48016. * @param position defines initial position
  48017. * @param interaxialDistance defines distance between each color axis
  48018. * @param scene defines the hosting scene
  48019. */
  48020. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  48021. /**
  48022. * Gets camera class name
  48023. * @returns AnaglyphUniversalCamera
  48024. */
  48025. getClassName(): string;
  48026. }
  48027. }
  48028. declare module "babylonjs/Cameras/RigModes/stereoscopicRigMode" { }
  48029. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera" {
  48030. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  48031. import { Scene } from "babylonjs/scene";
  48032. import { Vector3 } from "babylonjs/Maths/math.vector";
  48033. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  48034. /**
  48035. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  48036. * @see https://doc.babylonjs.com/features/cameras
  48037. */
  48038. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  48039. /**
  48040. * Creates a new StereoscopicArcRotateCamera
  48041. * @param name defines camera name
  48042. * @param alpha defines alpha angle (in radians)
  48043. * @param beta defines beta angle (in radians)
  48044. * @param radius defines radius
  48045. * @param target defines camera target
  48046. * @param interaxialDistance defines distance between each color axis
  48047. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  48048. * @param scene defines the hosting scene
  48049. */
  48050. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  48051. /**
  48052. * Gets camera class name
  48053. * @returns StereoscopicArcRotateCamera
  48054. */
  48055. getClassName(): string;
  48056. }
  48057. }
  48058. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera" {
  48059. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  48060. import { Scene } from "babylonjs/scene";
  48061. import { Vector3 } from "babylonjs/Maths/math.vector";
  48062. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  48063. /**
  48064. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  48065. * @see https://doc.babylonjs.com/features/cameras
  48066. */
  48067. export class StereoscopicFreeCamera extends FreeCamera {
  48068. /**
  48069. * Creates a new StereoscopicFreeCamera
  48070. * @param name defines camera name
  48071. * @param position defines initial position
  48072. * @param interaxialDistance defines distance between each color axis
  48073. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  48074. * @param scene defines the hosting scene
  48075. */
  48076. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  48077. /**
  48078. * Gets camera class name
  48079. * @returns StereoscopicFreeCamera
  48080. */
  48081. getClassName(): string;
  48082. }
  48083. }
  48084. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera" {
  48085. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  48086. import { Scene } from "babylonjs/scene";
  48087. import { Vector3 } from "babylonjs/Maths/math.vector";
  48088. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  48089. /**
  48090. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  48091. * @see https://doc.babylonjs.com/features/cameras
  48092. */
  48093. export class StereoscopicGamepadCamera extends GamepadCamera {
  48094. /**
  48095. * Creates a new StereoscopicGamepadCamera
  48096. * @param name defines camera name
  48097. * @param position defines initial position
  48098. * @param interaxialDistance defines distance between each color axis
  48099. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  48100. * @param scene defines the hosting scene
  48101. */
  48102. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  48103. /**
  48104. * Gets camera class name
  48105. * @returns StereoscopicGamepadCamera
  48106. */
  48107. getClassName(): string;
  48108. }
  48109. }
  48110. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera" {
  48111. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  48112. import { Scene } from "babylonjs/scene";
  48113. import { Vector3 } from "babylonjs/Maths/math.vector";
  48114. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  48115. /**
  48116. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  48117. * @see https://doc.babylonjs.com/features/cameras
  48118. */
  48119. export class StereoscopicUniversalCamera extends UniversalCamera {
  48120. /**
  48121. * Creates a new StereoscopicUniversalCamera
  48122. * @param name defines camera name
  48123. * @param position defines initial position
  48124. * @param interaxialDistance defines distance between each color axis
  48125. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  48126. * @param scene defines the hosting scene
  48127. */
  48128. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  48129. /**
  48130. * Gets camera class name
  48131. * @returns StereoscopicUniversalCamera
  48132. */
  48133. getClassName(): string;
  48134. }
  48135. }
  48136. declare module "babylonjs/Cameras/Stereoscopic/index" {
  48137. export * from "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera";
  48138. export * from "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera";
  48139. export * from "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera";
  48140. export * from "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera";
  48141. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera";
  48142. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera";
  48143. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera";
  48144. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera";
  48145. }
  48146. declare module "babylonjs/Cameras/virtualJoysticksCamera" {
  48147. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  48148. import { Scene } from "babylonjs/scene";
  48149. import { Vector3 } from "babylonjs/Maths/math.vector";
  48150. import "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  48151. /**
  48152. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  48153. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  48154. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  48155. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  48156. */
  48157. export class VirtualJoysticksCamera extends FreeCamera {
  48158. /**
  48159. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  48160. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  48161. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  48162. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  48163. * @param name Define the name of the camera in the scene
  48164. * @param position Define the start position of the camera in the scene
  48165. * @param scene Define the scene the camera belongs to
  48166. */
  48167. constructor(name: string, position: Vector3, scene: Scene);
  48168. /**
  48169. * Gets the current object class name.
  48170. * @return the class name
  48171. */
  48172. getClassName(): string;
  48173. }
  48174. }
  48175. declare module "babylonjs/Cameras/VR/vrCameraMetrics" {
  48176. import { Matrix } from "babylonjs/Maths/math.vector";
  48177. /**
  48178. * This represents all the required metrics to create a VR camera.
  48179. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  48180. */
  48181. export class VRCameraMetrics {
  48182. /**
  48183. * Define the horizontal resolution off the screen.
  48184. */
  48185. hResolution: number;
  48186. /**
  48187. * Define the vertical resolution off the screen.
  48188. */
  48189. vResolution: number;
  48190. /**
  48191. * Define the horizontal screen size.
  48192. */
  48193. hScreenSize: number;
  48194. /**
  48195. * Define the vertical screen size.
  48196. */
  48197. vScreenSize: number;
  48198. /**
  48199. * Define the vertical screen center position.
  48200. */
  48201. vScreenCenter: number;
  48202. /**
  48203. * Define the distance of the eyes to the screen.
  48204. */
  48205. eyeToScreenDistance: number;
  48206. /**
  48207. * Define the distance between both lenses
  48208. */
  48209. lensSeparationDistance: number;
  48210. /**
  48211. * Define the distance between both viewer's eyes.
  48212. */
  48213. interpupillaryDistance: number;
  48214. /**
  48215. * Define the distortion factor of the VR postprocess.
  48216. * Please, touch with care.
  48217. */
  48218. distortionK: number[];
  48219. /**
  48220. * Define the chromatic aberration correction factors for the VR post process.
  48221. */
  48222. chromaAbCorrection: number[];
  48223. /**
  48224. * Define the scale factor of the post process.
  48225. * The smaller the better but the slower.
  48226. */
  48227. postProcessScaleFactor: number;
  48228. /**
  48229. * Define an offset for the lens center.
  48230. */
  48231. lensCenterOffset: number;
  48232. /**
  48233. * Define if the current vr camera should compensate the distortion of the lense or not.
  48234. */
  48235. compensateDistortion: boolean;
  48236. /**
  48237. * Defines if multiview should be enabled when rendering (Default: false)
  48238. */
  48239. multiviewEnabled: boolean;
  48240. /**
  48241. * Gets the rendering aspect ratio based on the provided resolutions.
  48242. */
  48243. get aspectRatio(): number;
  48244. /**
  48245. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  48246. */
  48247. get aspectRatioFov(): number;
  48248. /**
  48249. * @hidden
  48250. */
  48251. get leftHMatrix(): Matrix;
  48252. /**
  48253. * @hidden
  48254. */
  48255. get rightHMatrix(): Matrix;
  48256. /**
  48257. * @hidden
  48258. */
  48259. get leftPreViewMatrix(): Matrix;
  48260. /**
  48261. * @hidden
  48262. */
  48263. get rightPreViewMatrix(): Matrix;
  48264. /**
  48265. * Get the default VRMetrics based on the most generic setup.
  48266. * @returns the default vr metrics
  48267. */
  48268. static GetDefault(): VRCameraMetrics;
  48269. }
  48270. }
  48271. declare module "babylonjs/Shaders/vrDistortionCorrection.fragment" {
  48272. /** @hidden */
  48273. export var vrDistortionCorrectionPixelShader: {
  48274. name: string;
  48275. shader: string;
  48276. };
  48277. }
  48278. declare module "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess" {
  48279. import { Camera } from "babylonjs/Cameras/camera";
  48280. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48281. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  48282. import "babylonjs/Shaders/vrDistortionCorrection.fragment";
  48283. /**
  48284. * VRDistortionCorrectionPostProcess used for mobile VR
  48285. */
  48286. export class VRDistortionCorrectionPostProcess extends PostProcess {
  48287. private _isRightEye;
  48288. private _distortionFactors;
  48289. private _postProcessScaleFactor;
  48290. private _lensCenterOffset;
  48291. private _scaleIn;
  48292. private _scaleFactor;
  48293. private _lensCenter;
  48294. /**
  48295. * Gets a string identifying the name of the class
  48296. * @returns "VRDistortionCorrectionPostProcess" string
  48297. */
  48298. getClassName(): string;
  48299. /**
  48300. * Initializes the VRDistortionCorrectionPostProcess
  48301. * @param name The name of the effect.
  48302. * @param camera The camera to apply the render pass to.
  48303. * @param isRightEye If this is for the right eye distortion
  48304. * @param vrMetrics All the required metrics for the VR camera
  48305. */
  48306. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  48307. }
  48308. }
  48309. declare module "babylonjs/Cameras/RigModes/vrRigMode" { }
  48310. declare module "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera" {
  48311. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  48312. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48313. import { Scene } from "babylonjs/scene";
  48314. import { Vector3 } from "babylonjs/Maths/math.vector";
  48315. import "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  48316. import "babylonjs/Cameras/RigModes/vrRigMode";
  48317. /**
  48318. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  48319. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48320. */
  48321. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  48322. /**
  48323. * Creates a new VRDeviceOrientationArcRotateCamera
  48324. * @param name defines camera name
  48325. * @param alpha defines the camera rotation along the logitudinal axis
  48326. * @param beta defines the camera rotation along the latitudinal axis
  48327. * @param radius defines the camera distance from its target
  48328. * @param target defines the camera target
  48329. * @param scene defines the scene the camera belongs to
  48330. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48331. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48332. */
  48333. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48334. /**
  48335. * Gets camera class name
  48336. * @returns VRDeviceOrientationArcRotateCamera
  48337. */
  48338. getClassName(): string;
  48339. }
  48340. }
  48341. declare module "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera" {
  48342. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  48343. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48344. import { Scene } from "babylonjs/scene";
  48345. import { Vector3 } from "babylonjs/Maths/math.vector";
  48346. import "babylonjs/Cameras/RigModes/vrRigMode";
  48347. /**
  48348. * Camera used to simulate VR rendering (based on FreeCamera)
  48349. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48350. */
  48351. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  48352. /**
  48353. * Creates a new VRDeviceOrientationFreeCamera
  48354. * @param name defines camera name
  48355. * @param position defines the start position of the camera
  48356. * @param scene defines the scene the camera belongs to
  48357. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48358. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48359. */
  48360. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48361. /**
  48362. * Gets camera class name
  48363. * @returns VRDeviceOrientationFreeCamera
  48364. */
  48365. getClassName(): string;
  48366. }
  48367. }
  48368. declare module "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera" {
  48369. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  48370. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48371. import { Scene } from "babylonjs/scene";
  48372. import { Vector3 } from "babylonjs/Maths/math.vector";
  48373. import "babylonjs/Gamepads/gamepadSceneComponent";
  48374. /**
  48375. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  48376. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48377. */
  48378. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  48379. /**
  48380. * Creates a new VRDeviceOrientationGamepadCamera
  48381. * @param name defines camera name
  48382. * @param position defines the start position of the camera
  48383. * @param scene defines the scene the camera belongs to
  48384. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48385. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48386. */
  48387. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48388. /**
  48389. * Gets camera class name
  48390. * @returns VRDeviceOrientationGamepadCamera
  48391. */
  48392. getClassName(): string;
  48393. }
  48394. }
  48395. declare module "babylonjs/Materials/Textures/dynamicTexture" {
  48396. import { Scene } from "babylonjs/scene";
  48397. import { Texture } from "babylonjs/Materials/Textures/texture";
  48398. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  48399. /**
  48400. * A class extending Texture allowing drawing on a texture
  48401. * @see https://doc.babylonjs.com/how_to/dynamictexture
  48402. */
  48403. export class DynamicTexture extends Texture {
  48404. private _generateMipMaps;
  48405. private _canvas;
  48406. private _context;
  48407. /**
  48408. * Creates a DynamicTexture
  48409. * @param name defines the name of the texture
  48410. * @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
  48411. * @param scene defines the scene where you want the texture
  48412. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  48413. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  48414. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  48415. */
  48416. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  48417. /**
  48418. * Get the current class name of the texture useful for serialization or dynamic coding.
  48419. * @returns "DynamicTexture"
  48420. */
  48421. getClassName(): string;
  48422. /**
  48423. * Gets the current state of canRescale
  48424. */
  48425. get canRescale(): boolean;
  48426. private _recreate;
  48427. /**
  48428. * Scales the texture
  48429. * @param ratio the scale factor to apply to both width and height
  48430. */
  48431. scale(ratio: number): void;
  48432. /**
  48433. * Resizes the texture
  48434. * @param width the new width
  48435. * @param height the new height
  48436. */
  48437. scaleTo(width: number, height: number): void;
  48438. /**
  48439. * Gets the context of the canvas used by the texture
  48440. * @returns the canvas context of the dynamic texture
  48441. */
  48442. getContext(): CanvasRenderingContext2D;
  48443. /**
  48444. * Clears the texture
  48445. */
  48446. clear(): void;
  48447. /**
  48448. * Updates the texture
  48449. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48450. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  48451. */
  48452. update(invertY?: boolean, premulAlpha?: boolean): void;
  48453. /**
  48454. * Draws text onto the texture
  48455. * @param text defines the text to be drawn
  48456. * @param x defines the placement of the text from the left
  48457. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  48458. * @param font defines the font to be used with font-style, font-size, font-name
  48459. * @param color defines the color used for the text
  48460. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  48461. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48462. * @param update defines whether texture is immediately update (default is true)
  48463. */
  48464. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  48465. /**
  48466. * Clones the texture
  48467. * @returns the clone of the texture.
  48468. */
  48469. clone(): DynamicTexture;
  48470. /**
  48471. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  48472. * @returns a serialized dynamic texture object
  48473. */
  48474. serialize(): any;
  48475. private _IsCanvasElement;
  48476. /** @hidden */
  48477. _rebuild(): void;
  48478. }
  48479. }
  48480. declare module "babylonjs/Meshes/Builders/groundBuilder" {
  48481. import { Scene } from "babylonjs/scene";
  48482. import { Color3 } from "babylonjs/Maths/math.color";
  48483. import { Mesh } from "babylonjs/Meshes/mesh";
  48484. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  48485. import { Nullable } from "babylonjs/types";
  48486. /**
  48487. * Class containing static functions to help procedurally build meshes
  48488. */
  48489. export class GroundBuilder {
  48490. /**
  48491. * Creates a ground mesh
  48492. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  48493. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  48494. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  48495. * @param name defines the name of the mesh
  48496. * @param options defines the options used to create the mesh
  48497. * @param scene defines the hosting scene
  48498. * @returns the ground mesh
  48499. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  48500. */
  48501. static CreateGround(name: string, options: {
  48502. width?: number;
  48503. height?: number;
  48504. subdivisions?: number;
  48505. subdivisionsX?: number;
  48506. subdivisionsY?: number;
  48507. updatable?: boolean;
  48508. }, scene: any): Mesh;
  48509. /**
  48510. * Creates a tiled ground mesh
  48511. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  48512. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  48513. * * 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
  48514. * * 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
  48515. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48516. * @param name defines the name of the mesh
  48517. * @param options defines the options used to create the mesh
  48518. * @param scene defines the hosting scene
  48519. * @returns the tiled ground mesh
  48520. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  48521. */
  48522. static CreateTiledGround(name: string, options: {
  48523. xmin: number;
  48524. zmin: number;
  48525. xmax: number;
  48526. zmax: number;
  48527. subdivisions?: {
  48528. w: number;
  48529. h: number;
  48530. };
  48531. precision?: {
  48532. w: number;
  48533. h: number;
  48534. };
  48535. updatable?: boolean;
  48536. }, scene?: Nullable<Scene>): Mesh;
  48537. /**
  48538. * Creates a ground mesh from a height map
  48539. * * The parameter `url` sets the URL of the height map image resource.
  48540. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  48541. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  48542. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  48543. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  48544. * * 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.
  48545. * * 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).
  48546. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  48547. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48548. * @param name defines the name of the mesh
  48549. * @param url defines the url to the height map
  48550. * @param options defines the options used to create the mesh
  48551. * @param scene defines the hosting scene
  48552. * @returns the ground mesh
  48553. * @see https://doc.babylonjs.com/babylon101/height_map
  48554. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  48555. */
  48556. static CreateGroundFromHeightMap(name: string, url: string, options: {
  48557. width?: number;
  48558. height?: number;
  48559. subdivisions?: number;
  48560. minHeight?: number;
  48561. maxHeight?: number;
  48562. colorFilter?: Color3;
  48563. alphaFilter?: number;
  48564. updatable?: boolean;
  48565. onReady?: (mesh: GroundMesh) => void;
  48566. }, scene?: Nullable<Scene>): GroundMesh;
  48567. }
  48568. }
  48569. declare module "babylonjs/Meshes/Builders/torusBuilder" {
  48570. import { Vector4 } from "babylonjs/Maths/math.vector";
  48571. import { Mesh } from "babylonjs/Meshes/mesh";
  48572. /**
  48573. * Class containing static functions to help procedurally build meshes
  48574. */
  48575. export class TorusBuilder {
  48576. /**
  48577. * Creates a torus mesh
  48578. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  48579. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  48580. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  48581. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48582. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  48583. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48584. * @param name defines the name of the mesh
  48585. * @param options defines the options used to create the mesh
  48586. * @param scene defines the hosting scene
  48587. * @returns the torus mesh
  48588. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  48589. */
  48590. static CreateTorus(name: string, options: {
  48591. diameter?: number;
  48592. thickness?: number;
  48593. tessellation?: number;
  48594. updatable?: boolean;
  48595. sideOrientation?: number;
  48596. frontUVs?: Vector4;
  48597. backUVs?: Vector4;
  48598. }, scene: any): Mesh;
  48599. }
  48600. }
  48601. declare module "babylonjs/Meshes/Builders/cylinderBuilder" {
  48602. import { Vector4 } from "babylonjs/Maths/math.vector";
  48603. import { Color4 } from "babylonjs/Maths/math.color";
  48604. import { Mesh } from "babylonjs/Meshes/mesh";
  48605. /**
  48606. * Class containing static functions to help procedurally build meshes
  48607. */
  48608. export class CylinderBuilder {
  48609. /**
  48610. * Creates a cylinder or a cone mesh
  48611. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  48612. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  48613. * * 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.
  48614. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  48615. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  48616. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  48617. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  48618. * * 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).
  48619. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  48620. * * 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).
  48621. * * 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
  48622. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  48623. * * 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
  48624. * * 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.
  48625. * * If `enclose` is false, a ring surface is one element.
  48626. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  48627. * * 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
  48628. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48629. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  48630. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48631. * @param name defines the name of the mesh
  48632. * @param options defines the options used to create the mesh
  48633. * @param scene defines the hosting scene
  48634. * @returns the cylinder mesh
  48635. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  48636. */
  48637. static CreateCylinder(name: string, options: {
  48638. height?: number;
  48639. diameterTop?: number;
  48640. diameterBottom?: number;
  48641. diameter?: number;
  48642. tessellation?: number;
  48643. subdivisions?: number;
  48644. arc?: number;
  48645. faceColors?: Color4[];
  48646. faceUV?: Vector4[];
  48647. updatable?: boolean;
  48648. hasRings?: boolean;
  48649. enclose?: boolean;
  48650. cap?: number;
  48651. sideOrientation?: number;
  48652. frontUVs?: Vector4;
  48653. backUVs?: Vector4;
  48654. }, scene: any): Mesh;
  48655. }
  48656. }
  48657. declare module "babylonjs/XR/webXRTypes" {
  48658. import { Nullable } from "babylonjs/types";
  48659. import { IDisposable } from "babylonjs/scene";
  48660. /**
  48661. * States of the webXR experience
  48662. */
  48663. export enum WebXRState {
  48664. /**
  48665. * Transitioning to being in XR mode
  48666. */
  48667. ENTERING_XR = 0,
  48668. /**
  48669. * Transitioning to non XR mode
  48670. */
  48671. EXITING_XR = 1,
  48672. /**
  48673. * In XR mode and presenting
  48674. */
  48675. IN_XR = 2,
  48676. /**
  48677. * Not entered XR mode
  48678. */
  48679. NOT_IN_XR = 3
  48680. }
  48681. /**
  48682. * Abstraction of the XR render target
  48683. */
  48684. export interface WebXRRenderTarget extends IDisposable {
  48685. /**
  48686. * xrpresent context of the canvas which can be used to display/mirror xr content
  48687. */
  48688. canvasContext: WebGLRenderingContext;
  48689. /**
  48690. * xr layer for the canvas
  48691. */
  48692. xrLayer: Nullable<XRWebGLLayer>;
  48693. /**
  48694. * Initializes the xr layer for the session
  48695. * @param xrSession xr session
  48696. * @returns a promise that will resolve once the XR Layer has been created
  48697. */
  48698. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48699. }
  48700. }
  48701. declare module "babylonjs/XR/webXRManagedOutputCanvas" {
  48702. import { Nullable } from "babylonjs/types";
  48703. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  48704. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48705. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48706. import { Observable } from "babylonjs/Misc/observable";
  48707. /**
  48708. * COnfiguration object for WebXR output canvas
  48709. */
  48710. export class WebXRManagedOutputCanvasOptions {
  48711. /**
  48712. * An optional canvas in case you wish to create it yourself and provide it here.
  48713. * If not provided, a new canvas will be created
  48714. */
  48715. canvasElement?: HTMLCanvasElement;
  48716. /**
  48717. * Options for this XR Layer output
  48718. */
  48719. canvasOptions?: XRWebGLLayerOptions;
  48720. /**
  48721. * CSS styling for a newly created canvas (if not provided)
  48722. */
  48723. newCanvasCssStyle?: string;
  48724. /**
  48725. * Get the default values of the configuration object
  48726. * @param engine defines the engine to use (can be null)
  48727. * @returns default values of this configuration object
  48728. */
  48729. static GetDefaults(engine?: ThinEngine): WebXRManagedOutputCanvasOptions;
  48730. }
  48731. /**
  48732. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  48733. */
  48734. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  48735. private _options;
  48736. private _canvas;
  48737. private _engine;
  48738. private _originalCanvasSize;
  48739. /**
  48740. * Rendering context of the canvas which can be used to display/mirror xr content
  48741. */
  48742. canvasContext: WebGLRenderingContext;
  48743. /**
  48744. * xr layer for the canvas
  48745. */
  48746. xrLayer: Nullable<XRWebGLLayer>;
  48747. /**
  48748. * Obseervers registered here will be triggered when the xr layer was initialized
  48749. */
  48750. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  48751. /**
  48752. * Initializes the canvas to be added/removed upon entering/exiting xr
  48753. * @param _xrSessionManager The XR Session manager
  48754. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  48755. */
  48756. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  48757. /**
  48758. * Disposes of the object
  48759. */
  48760. dispose(): void;
  48761. /**
  48762. * Initializes the xr layer for the session
  48763. * @param xrSession xr session
  48764. * @returns a promise that will resolve once the XR Layer has been created
  48765. */
  48766. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48767. private _addCanvas;
  48768. private _removeCanvas;
  48769. private _setCanvasSize;
  48770. private _setManagedOutputCanvas;
  48771. }
  48772. }
  48773. declare module "babylonjs/XR/webXRSessionManager" {
  48774. import { Observable } from "babylonjs/Misc/observable";
  48775. import { Nullable } from "babylonjs/types";
  48776. import { IDisposable, Scene } from "babylonjs/scene";
  48777. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  48778. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48779. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  48780. /**
  48781. * Manages an XRSession to work with Babylon's engine
  48782. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  48783. */
  48784. export class WebXRSessionManager implements IDisposable {
  48785. /** The scene which the session should be created for */
  48786. scene: Scene;
  48787. private _referenceSpace;
  48788. private _rttProvider;
  48789. private _sessionEnded;
  48790. private _xrNavigator;
  48791. private baseLayer;
  48792. /**
  48793. * The base reference space from which the session started. good if you want to reset your
  48794. * reference space
  48795. */
  48796. baseReferenceSpace: XRReferenceSpace;
  48797. /**
  48798. * Current XR frame
  48799. */
  48800. currentFrame: Nullable<XRFrame>;
  48801. /** WebXR timestamp updated every frame */
  48802. currentTimestamp: number;
  48803. /**
  48804. * Used just in case of a failure to initialize an immersive session.
  48805. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  48806. */
  48807. defaultHeightCompensation: number;
  48808. /**
  48809. * Fires every time a new xrFrame arrives which can be used to update the camera
  48810. */
  48811. onXRFrameObservable: Observable<XRFrame>;
  48812. /**
  48813. * Fires when the reference space changed
  48814. */
  48815. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  48816. /**
  48817. * Fires when the xr session is ended either by the device or manually done
  48818. */
  48819. onXRSessionEnded: Observable<any>;
  48820. /**
  48821. * Fires when the xr session is ended either by the device or manually done
  48822. */
  48823. onXRSessionInit: Observable<XRSession>;
  48824. /**
  48825. * Underlying xr session
  48826. */
  48827. session: XRSession;
  48828. /**
  48829. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  48830. * or get the offset the player is currently at.
  48831. */
  48832. viewerReferenceSpace: XRReferenceSpace;
  48833. /**
  48834. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  48835. * @param scene The scene which the session should be created for
  48836. */
  48837. constructor(
  48838. /** The scene which the session should be created for */
  48839. scene: Scene);
  48840. /**
  48841. * The current reference space used in this session. This reference space can constantly change!
  48842. * It is mainly used to offset the camera's position.
  48843. */
  48844. get referenceSpace(): XRReferenceSpace;
  48845. /**
  48846. * Set a new reference space and triggers the observable
  48847. */
  48848. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  48849. /**
  48850. * Disposes of the session manager
  48851. */
  48852. dispose(): void;
  48853. /**
  48854. * Stops the xrSession and restores the render loop
  48855. * @returns Promise which resolves after it exits XR
  48856. */
  48857. exitXRAsync(): Promise<void>;
  48858. /**
  48859. * Gets the correct render target texture to be rendered this frame for this eye
  48860. * @param eye the eye for which to get the render target
  48861. * @returns the render target for the specified eye
  48862. */
  48863. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  48864. /**
  48865. * Creates a WebXRRenderTarget object for the XR session
  48866. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  48867. * @param options optional options to provide when creating a new render target
  48868. * @returns a WebXR render target to which the session can render
  48869. */
  48870. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  48871. /**
  48872. * Initializes the manager
  48873. * After initialization enterXR can be called to start an XR session
  48874. * @returns Promise which resolves after it is initialized
  48875. */
  48876. initializeAsync(): Promise<void>;
  48877. /**
  48878. * Initializes an xr session
  48879. * @param xrSessionMode mode to initialize
  48880. * @param xrSessionInit defines optional and required values to pass to the session builder
  48881. * @returns a promise which will resolve once the session has been initialized
  48882. */
  48883. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  48884. /**
  48885. * Checks if a session would be supported for the creation options specified
  48886. * @param sessionMode session mode to check if supported eg. immersive-vr
  48887. * @returns A Promise that resolves to true if supported and false if not
  48888. */
  48889. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48890. /**
  48891. * Resets the reference space to the one started the session
  48892. */
  48893. resetReferenceSpace(): void;
  48894. /**
  48895. * Starts rendering to the xr layer
  48896. */
  48897. runXRRenderLoop(): void;
  48898. /**
  48899. * Sets the reference space on the xr session
  48900. * @param referenceSpaceType space to set
  48901. * @returns a promise that will resolve once the reference space has been set
  48902. */
  48903. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  48904. /**
  48905. * Updates the render state of the session
  48906. * @param state state to set
  48907. * @returns a promise that resolves once the render state has been updated
  48908. */
  48909. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  48910. /**
  48911. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  48912. * @param sessionMode defines the session to test
  48913. * @returns a promise with boolean as final value
  48914. */
  48915. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48916. private _createRenderTargetTexture;
  48917. }
  48918. }
  48919. declare module "babylonjs/XR/webXRCamera" {
  48920. import { Vector3 } from "babylonjs/Maths/math.vector";
  48921. import { Scene } from "babylonjs/scene";
  48922. import { Camera } from "babylonjs/Cameras/camera";
  48923. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  48924. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48925. import { Observable } from "babylonjs/Misc/observable";
  48926. /**
  48927. * WebXR Camera which holds the views for the xrSession
  48928. * @see https://doc.babylonjs.com/how_to/webxr_camera
  48929. */
  48930. export class WebXRCamera extends FreeCamera {
  48931. private _xrSessionManager;
  48932. private _firstFrame;
  48933. private _referenceQuaternion;
  48934. private _referencedPosition;
  48935. private _xrInvPositionCache;
  48936. private _xrInvQuaternionCache;
  48937. /**
  48938. * Observable raised before camera teleportation
  48939. */
  48940. onBeforeCameraTeleport: Observable<Vector3>;
  48941. /**
  48942. * Observable raised after camera teleportation
  48943. */
  48944. onAfterCameraTeleport: Observable<Vector3>;
  48945. /**
  48946. * Should position compensation execute on first frame.
  48947. * This is used when copying the position from a native (non XR) camera
  48948. */
  48949. compensateOnFirstFrame: boolean;
  48950. /**
  48951. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  48952. * @param name the name of the camera
  48953. * @param scene the scene to add the camera to
  48954. * @param _xrSessionManager a constructed xr session manager
  48955. */
  48956. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  48957. /**
  48958. * Return the user's height, unrelated to the current ground.
  48959. * This will be the y position of this camera, when ground level is 0.
  48960. */
  48961. get realWorldHeight(): number;
  48962. /** @hidden */
  48963. _updateForDualEyeDebugging(): void;
  48964. /**
  48965. * Sets this camera's transformation based on a non-vr camera
  48966. * @param otherCamera the non-vr camera to copy the transformation from
  48967. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  48968. */
  48969. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  48970. /**
  48971. * Gets the current instance class name ("WebXRCamera").
  48972. * @returns the class name
  48973. */
  48974. getClassName(): string;
  48975. private _rotate180;
  48976. private _updateFromXRSession;
  48977. private _updateNumberOfRigCameras;
  48978. private _updateReferenceSpace;
  48979. private _updateReferenceSpaceOffset;
  48980. }
  48981. }
  48982. declare module "babylonjs/XR/webXRFeaturesManager" {
  48983. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48984. import { IDisposable } from "babylonjs/scene";
  48985. /**
  48986. * Defining the interface required for a (webxr) feature
  48987. */
  48988. export interface IWebXRFeature extends IDisposable {
  48989. /**
  48990. * Is this feature attached
  48991. */
  48992. attached: boolean;
  48993. /**
  48994. * Should auto-attach be disabled?
  48995. */
  48996. disableAutoAttach: boolean;
  48997. /**
  48998. * Attach the feature to the session
  48999. * Will usually be called by the features manager
  49000. *
  49001. * @param force should attachment be forced (even when already attached)
  49002. * @returns true if successful.
  49003. */
  49004. attach(force?: boolean): boolean;
  49005. /**
  49006. * Detach the feature from the session
  49007. * Will usually be called by the features manager
  49008. *
  49009. * @returns true if successful.
  49010. */
  49011. detach(): boolean;
  49012. /**
  49013. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  49014. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  49015. *
  49016. * @returns whether or not the feature is compatible in this environment
  49017. */
  49018. isCompatible(): boolean;
  49019. /**
  49020. * Was this feature disposed;
  49021. */
  49022. isDisposed: boolean;
  49023. /**
  49024. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  49025. */
  49026. xrNativeFeatureName?: string;
  49027. /**
  49028. * A list of (Babylon WebXR) features this feature depends on
  49029. */
  49030. dependsOn?: string[];
  49031. }
  49032. /**
  49033. * A list of the currently available features without referencing them
  49034. */
  49035. export class WebXRFeatureName {
  49036. /**
  49037. * The name of the anchor system feature
  49038. */
  49039. static readonly ANCHOR_SYSTEM: string;
  49040. /**
  49041. * The name of the background remover feature
  49042. */
  49043. static readonly BACKGROUND_REMOVER: string;
  49044. /**
  49045. * The name of the hit test feature
  49046. */
  49047. static readonly HIT_TEST: string;
  49048. /**
  49049. * physics impostors for xr controllers feature
  49050. */
  49051. static readonly PHYSICS_CONTROLLERS: string;
  49052. /**
  49053. * The name of the plane detection feature
  49054. */
  49055. static readonly PLANE_DETECTION: string;
  49056. /**
  49057. * The name of the pointer selection feature
  49058. */
  49059. static readonly POINTER_SELECTION: string;
  49060. /**
  49061. * The name of the teleportation feature
  49062. */
  49063. static readonly TELEPORTATION: string;
  49064. /**
  49065. * The name of the feature points feature.
  49066. */
  49067. static readonly FEATURE_POINTS: string;
  49068. /**
  49069. * The name of the hand tracking feature.
  49070. */
  49071. static readonly HAND_TRACKING: string;
  49072. }
  49073. /**
  49074. * Defining the constructor of a feature. Used to register the modules.
  49075. */
  49076. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  49077. /**
  49078. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  49079. * It is mainly used in AR sessions.
  49080. *
  49081. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  49082. */
  49083. export class WebXRFeaturesManager implements IDisposable {
  49084. private _xrSessionManager;
  49085. private static readonly _AvailableFeatures;
  49086. private _features;
  49087. /**
  49088. * constructs a new features manages.
  49089. *
  49090. * @param _xrSessionManager an instance of WebXRSessionManager
  49091. */
  49092. constructor(_xrSessionManager: WebXRSessionManager);
  49093. /**
  49094. * Used to register a module. After calling this function a developer can use this feature in the scene.
  49095. * Mainly used internally.
  49096. *
  49097. * @param featureName the name of the feature to register
  49098. * @param constructorFunction the function used to construct the module
  49099. * @param version the (babylon) version of the module
  49100. * @param stable is that a stable version of this module
  49101. */
  49102. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  49103. /**
  49104. * Returns a constructor of a specific feature.
  49105. *
  49106. * @param featureName the name of the feature to construct
  49107. * @param version the version of the feature to load
  49108. * @param xrSessionManager the xrSessionManager. Used to construct the module
  49109. * @param options optional options provided to the module.
  49110. * @returns a function that, when called, will return a new instance of this feature
  49111. */
  49112. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  49113. /**
  49114. * Can be used to return the list of features currently registered
  49115. *
  49116. * @returns an Array of available features
  49117. */
  49118. static GetAvailableFeatures(): string[];
  49119. /**
  49120. * Gets the versions available for a specific feature
  49121. * @param featureName the name of the feature
  49122. * @returns an array with the available versions
  49123. */
  49124. static GetAvailableVersions(featureName: string): string[];
  49125. /**
  49126. * Return the latest unstable version of this feature
  49127. * @param featureName the name of the feature to search
  49128. * @returns the version number. if not found will return -1
  49129. */
  49130. static GetLatestVersionOfFeature(featureName: string): number;
  49131. /**
  49132. * Return the latest stable version of this feature
  49133. * @param featureName the name of the feature to search
  49134. * @returns the version number. if not found will return -1
  49135. */
  49136. static GetStableVersionOfFeature(featureName: string): number;
  49137. /**
  49138. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  49139. * Can be used during a session to start a feature
  49140. * @param featureName the name of feature to attach
  49141. */
  49142. attachFeature(featureName: string): void;
  49143. /**
  49144. * Can be used inside a session or when the session ends to detach a specific feature
  49145. * @param featureName the name of the feature to detach
  49146. */
  49147. detachFeature(featureName: string): void;
  49148. /**
  49149. * Used to disable an already-enabled feature
  49150. * The feature will be disposed and will be recreated once enabled.
  49151. * @param featureName the feature to disable
  49152. * @returns true if disable was successful
  49153. */
  49154. disableFeature(featureName: string | {
  49155. Name: string;
  49156. }): boolean;
  49157. /**
  49158. * dispose this features manager
  49159. */
  49160. dispose(): void;
  49161. /**
  49162. * 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.
  49163. * 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.
  49164. *
  49165. * @param featureName the name of the feature to load or the class of the feature
  49166. * @param version optional version to load. if not provided the latest version will be enabled
  49167. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  49168. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  49169. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  49170. * @returns a new constructed feature or throws an error if feature not found.
  49171. */
  49172. enableFeature(featureName: string | {
  49173. Name: string;
  49174. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  49175. /**
  49176. * get the implementation of an enabled feature.
  49177. * @param featureName the name of the feature to load
  49178. * @returns the feature class, if found
  49179. */
  49180. getEnabledFeature(featureName: string): IWebXRFeature;
  49181. /**
  49182. * Get the list of enabled features
  49183. * @returns an array of enabled features
  49184. */
  49185. getEnabledFeatures(): string[];
  49186. /**
  49187. * This function will exten the session creation configuration object with enabled features.
  49188. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  49189. * according to the defined "required" variable, provided during enableFeature call
  49190. * @param xrSessionInit the xr Session init object to extend
  49191. *
  49192. * @returns an extended XRSessionInit object
  49193. */
  49194. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  49195. }
  49196. }
  49197. declare module "babylonjs/XR/webXRExperienceHelper" {
  49198. import { Observable } from "babylonjs/Misc/observable";
  49199. import { IDisposable, Scene } from "babylonjs/scene";
  49200. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  49201. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  49202. import { WebXRState, WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  49203. import { WebXRFeaturesManager } from "babylonjs/XR/webXRFeaturesManager";
  49204. /**
  49205. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  49206. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  49207. */
  49208. export class WebXRExperienceHelper implements IDisposable {
  49209. private scene;
  49210. private _nonVRCamera;
  49211. private _originalSceneAutoClear;
  49212. private _supported;
  49213. /**
  49214. * Camera used to render xr content
  49215. */
  49216. camera: WebXRCamera;
  49217. /** A features manager for this xr session */
  49218. featuresManager: WebXRFeaturesManager;
  49219. /**
  49220. * Observers registered here will be triggered after the camera's initial transformation is set
  49221. * This can be used to set a different ground level or an extra rotation.
  49222. *
  49223. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  49224. * to the position set after this observable is done executing.
  49225. */
  49226. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  49227. /**
  49228. * Fires when the state of the experience helper has changed
  49229. */
  49230. onStateChangedObservable: Observable<WebXRState>;
  49231. /** Session manager used to keep track of xr session */
  49232. sessionManager: WebXRSessionManager;
  49233. /**
  49234. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  49235. */
  49236. state: WebXRState;
  49237. /**
  49238. * Creates a WebXRExperienceHelper
  49239. * @param scene The scene the helper should be created in
  49240. */
  49241. private constructor();
  49242. /**
  49243. * Creates the experience helper
  49244. * @param scene the scene to attach the experience helper to
  49245. * @returns a promise for the experience helper
  49246. */
  49247. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  49248. /**
  49249. * Disposes of the experience helper
  49250. */
  49251. dispose(): void;
  49252. /**
  49253. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  49254. * @param sessionMode options for the XR session
  49255. * @param referenceSpaceType frame of reference of the XR session
  49256. * @param renderTarget the output canvas that will be used to enter XR mode
  49257. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  49258. * @returns promise that resolves after xr mode has entered
  49259. */
  49260. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  49261. /**
  49262. * Exits XR mode and returns the scene to its original state
  49263. * @returns promise that resolves after xr mode has exited
  49264. */
  49265. exitXRAsync(): Promise<void>;
  49266. private _nonXRToXRCamera;
  49267. private _setState;
  49268. }
  49269. }
  49270. declare module "babylonjs/XR/motionController/webXRControllerComponent" {
  49271. import { IMinimalMotionControllerObject, MotionControllerComponentType } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  49272. import { Observable } from "babylonjs/Misc/observable";
  49273. import { IDisposable } from "babylonjs/scene";
  49274. /**
  49275. * X-Y values for axes in WebXR
  49276. */
  49277. export interface IWebXRMotionControllerAxesValue {
  49278. /**
  49279. * The value of the x axis
  49280. */
  49281. x: number;
  49282. /**
  49283. * The value of the y-axis
  49284. */
  49285. y: number;
  49286. }
  49287. /**
  49288. * changed / previous values for the values of this component
  49289. */
  49290. export interface IWebXRMotionControllerComponentChangesValues<T> {
  49291. /**
  49292. * current (this frame) value
  49293. */
  49294. current: T;
  49295. /**
  49296. * previous (last change) value
  49297. */
  49298. previous: T;
  49299. }
  49300. /**
  49301. * Represents changes in the component between current frame and last values recorded
  49302. */
  49303. export interface IWebXRMotionControllerComponentChanges {
  49304. /**
  49305. * will be populated with previous and current values if axes changed
  49306. */
  49307. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  49308. /**
  49309. * will be populated with previous and current values if pressed changed
  49310. */
  49311. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  49312. /**
  49313. * will be populated with previous and current values if touched changed
  49314. */
  49315. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  49316. /**
  49317. * will be populated with previous and current values if value changed
  49318. */
  49319. value?: IWebXRMotionControllerComponentChangesValues<number>;
  49320. }
  49321. /**
  49322. * This class represents a single component (for example button or thumbstick) of a motion controller
  49323. */
  49324. export class WebXRControllerComponent implements IDisposable {
  49325. /**
  49326. * the id of this component
  49327. */
  49328. id: string;
  49329. /**
  49330. * the type of the component
  49331. */
  49332. type: MotionControllerComponentType;
  49333. private _buttonIndex;
  49334. private _axesIndices;
  49335. private _axes;
  49336. private _changes;
  49337. private _currentValue;
  49338. private _hasChanges;
  49339. private _pressed;
  49340. private _touched;
  49341. /**
  49342. * button component type
  49343. */
  49344. static BUTTON_TYPE: MotionControllerComponentType;
  49345. /**
  49346. * squeeze component type
  49347. */
  49348. static SQUEEZE_TYPE: MotionControllerComponentType;
  49349. /**
  49350. * Thumbstick component type
  49351. */
  49352. static THUMBSTICK_TYPE: MotionControllerComponentType;
  49353. /**
  49354. * Touchpad component type
  49355. */
  49356. static TOUCHPAD_TYPE: MotionControllerComponentType;
  49357. /**
  49358. * trigger component type
  49359. */
  49360. static TRIGGER_TYPE: MotionControllerComponentType;
  49361. /**
  49362. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  49363. * the axes data changes
  49364. */
  49365. onAxisValueChangedObservable: Observable<{
  49366. x: number;
  49367. y: number;
  49368. }>;
  49369. /**
  49370. * Observers registered here will be triggered when the state of a button changes
  49371. * State change is either pressed / touched / value
  49372. */
  49373. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  49374. /**
  49375. * Creates a new component for a motion controller.
  49376. * It is created by the motion controller itself
  49377. *
  49378. * @param id the id of this component
  49379. * @param type the type of the component
  49380. * @param _buttonIndex index in the buttons array of the gamepad
  49381. * @param _axesIndices indices of the values in the axes array of the gamepad
  49382. */
  49383. constructor(
  49384. /**
  49385. * the id of this component
  49386. */
  49387. id: string,
  49388. /**
  49389. * the type of the component
  49390. */
  49391. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  49392. /**
  49393. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  49394. */
  49395. get axes(): IWebXRMotionControllerAxesValue;
  49396. /**
  49397. * Get the changes. Elements will be populated only if they changed with their previous and current value
  49398. */
  49399. get changes(): IWebXRMotionControllerComponentChanges;
  49400. /**
  49401. * Return whether or not the component changed the last frame
  49402. */
  49403. get hasChanges(): boolean;
  49404. /**
  49405. * is the button currently pressed
  49406. */
  49407. get pressed(): boolean;
  49408. /**
  49409. * is the button currently touched
  49410. */
  49411. get touched(): boolean;
  49412. /**
  49413. * Get the current value of this component
  49414. */
  49415. get value(): number;
  49416. /**
  49417. * Dispose this component
  49418. */
  49419. dispose(): void;
  49420. /**
  49421. * Are there axes correlating to this component
  49422. * @return true is axes data is available
  49423. */
  49424. isAxes(): boolean;
  49425. /**
  49426. * Is this component a button (hence - pressable)
  49427. * @returns true if can be pressed
  49428. */
  49429. isButton(): boolean;
  49430. /**
  49431. * update this component using the gamepad object it is in. Called on every frame
  49432. * @param nativeController the native gamepad controller object
  49433. */
  49434. update(nativeController: IMinimalMotionControllerObject): void;
  49435. }
  49436. }
  49437. declare module "babylonjs/Loading/sceneLoader" {
  49438. import { Observable } from "babylonjs/Misc/observable";
  49439. import { Nullable } from "babylonjs/types";
  49440. import { Scene } from "babylonjs/scene";
  49441. import { Engine } from "babylonjs/Engines/engine";
  49442. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49443. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  49444. import { AssetContainer } from "babylonjs/assetContainer";
  49445. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  49446. import { Skeleton } from "babylonjs/Bones/skeleton";
  49447. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  49448. import { WebRequest } from "babylonjs/Misc/webRequest";
  49449. /**
  49450. * Interface used to represent data loading progression
  49451. */
  49452. export interface ISceneLoaderProgressEvent {
  49453. /**
  49454. * Defines if data length to load can be evaluated
  49455. */
  49456. readonly lengthComputable: boolean;
  49457. /**
  49458. * Defines the loaded data length
  49459. */
  49460. readonly loaded: number;
  49461. /**
  49462. * Defines the data length to load
  49463. */
  49464. readonly total: number;
  49465. }
  49466. /**
  49467. * Interface used by SceneLoader plugins to define supported file extensions
  49468. */
  49469. export interface ISceneLoaderPluginExtensions {
  49470. /**
  49471. * Defines the list of supported extensions
  49472. */
  49473. [extension: string]: {
  49474. isBinary: boolean;
  49475. };
  49476. }
  49477. /**
  49478. * Interface used by SceneLoader plugin factory
  49479. */
  49480. export interface ISceneLoaderPluginFactory {
  49481. /**
  49482. * Defines the name of the factory
  49483. */
  49484. name: string;
  49485. /**
  49486. * Function called to create a new plugin
  49487. * @return the new plugin
  49488. */
  49489. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  49490. /**
  49491. * The callback that returns true if the data can be directly loaded.
  49492. * @param data string containing the file data
  49493. * @returns if the data can be loaded directly
  49494. */
  49495. canDirectLoad?(data: string): boolean;
  49496. }
  49497. /**
  49498. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  49499. */
  49500. export interface ISceneLoaderPluginBase {
  49501. /**
  49502. * The friendly name of this plugin.
  49503. */
  49504. name: string;
  49505. /**
  49506. * The file extensions supported by this plugin.
  49507. */
  49508. extensions: string | ISceneLoaderPluginExtensions;
  49509. /**
  49510. * The callback called when loading from a url.
  49511. * @param scene scene loading this url
  49512. * @param url url to load
  49513. * @param onSuccess callback called when the file successfully loads
  49514. * @param onProgress callback called while file is loading (if the server supports this mode)
  49515. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  49516. * @param onError callback called when the file fails to load
  49517. * @returns a file request object
  49518. */
  49519. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49520. /**
  49521. * The callback called when loading from a file object.
  49522. * @param scene scene loading this file
  49523. * @param file defines the file to load
  49524. * @param onSuccess defines the callback to call when data is loaded
  49525. * @param onProgress defines the callback to call during loading process
  49526. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  49527. * @param onError defines the callback to call when an error occurs
  49528. * @returns a file request object
  49529. */
  49530. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49531. /**
  49532. * The callback that returns true if the data can be directly loaded.
  49533. * @param data string containing the file data
  49534. * @returns if the data can be loaded directly
  49535. */
  49536. canDirectLoad?(data: string): boolean;
  49537. /**
  49538. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  49539. * @param scene scene loading this data
  49540. * @param data string containing the data
  49541. * @returns data to pass to the plugin
  49542. */
  49543. directLoad?(scene: Scene, data: string): any;
  49544. /**
  49545. * The callback that allows custom handling of the root url based on the response url.
  49546. * @param rootUrl the original root url
  49547. * @param responseURL the response url if available
  49548. * @returns the new root url
  49549. */
  49550. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  49551. }
  49552. /**
  49553. * Interface used to define a SceneLoader plugin
  49554. */
  49555. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  49556. /**
  49557. * Import meshes into a scene.
  49558. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49559. * @param scene The scene to import into
  49560. * @param data The data to import
  49561. * @param rootUrl The root url for scene and resources
  49562. * @param meshes The meshes array to import into
  49563. * @param particleSystems The particle systems array to import into
  49564. * @param skeletons The skeletons array to import into
  49565. * @param onError The callback when import fails
  49566. * @returns True if successful or false otherwise
  49567. */
  49568. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  49569. /**
  49570. * Load into a scene.
  49571. * @param scene The scene to load into
  49572. * @param data The data to import
  49573. * @param rootUrl The root url for scene and resources
  49574. * @param onError The callback when import fails
  49575. * @returns True if successful or false otherwise
  49576. */
  49577. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  49578. /**
  49579. * Load into an asset container.
  49580. * @param scene The scene to load into
  49581. * @param data The data to import
  49582. * @param rootUrl The root url for scene and resources
  49583. * @param onError The callback when import fails
  49584. * @returns The loaded asset container
  49585. */
  49586. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  49587. }
  49588. /**
  49589. * Interface used to define an async SceneLoader plugin
  49590. */
  49591. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  49592. /**
  49593. * Import meshes into a scene.
  49594. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49595. * @param scene The scene to import into
  49596. * @param data The data to import
  49597. * @param rootUrl The root url for scene and resources
  49598. * @param onProgress The callback when the load progresses
  49599. * @param fileName Defines the name of the file to load
  49600. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  49601. */
  49602. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  49603. meshes: AbstractMesh[];
  49604. particleSystems: IParticleSystem[];
  49605. skeletons: Skeleton[];
  49606. animationGroups: AnimationGroup[];
  49607. }>;
  49608. /**
  49609. * Load into a scene.
  49610. * @param scene The scene to load into
  49611. * @param data The data to import
  49612. * @param rootUrl The root url for scene and resources
  49613. * @param onProgress The callback when the load progresses
  49614. * @param fileName Defines the name of the file to load
  49615. * @returns Nothing
  49616. */
  49617. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  49618. /**
  49619. * Load into an asset container.
  49620. * @param scene The scene to load into
  49621. * @param data The data to import
  49622. * @param rootUrl The root url for scene and resources
  49623. * @param onProgress The callback when the load progresses
  49624. * @param fileName Defines the name of the file to load
  49625. * @returns The loaded asset container
  49626. */
  49627. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  49628. }
  49629. /**
  49630. * Mode that determines how to handle old animation groups before loading new ones.
  49631. */
  49632. export enum SceneLoaderAnimationGroupLoadingMode {
  49633. /**
  49634. * Reset all old animations to initial state then dispose them.
  49635. */
  49636. Clean = 0,
  49637. /**
  49638. * Stop all old animations.
  49639. */
  49640. Stop = 1,
  49641. /**
  49642. * Restart old animations from first frame.
  49643. */
  49644. Sync = 2,
  49645. /**
  49646. * Old animations remains untouched.
  49647. */
  49648. NoSync = 3
  49649. }
  49650. /**
  49651. * Defines a plugin registered by the SceneLoader
  49652. */
  49653. interface IRegisteredPlugin {
  49654. /**
  49655. * Defines the plugin to use
  49656. */
  49657. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49658. /**
  49659. * Defines if the plugin supports binary data
  49660. */
  49661. isBinary: boolean;
  49662. }
  49663. /**
  49664. * Class used to load scene from various file formats using registered plugins
  49665. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  49666. */
  49667. export class SceneLoader {
  49668. /**
  49669. * No logging while loading
  49670. */
  49671. static readonly NO_LOGGING: number;
  49672. /**
  49673. * Minimal logging while loading
  49674. */
  49675. static readonly MINIMAL_LOGGING: number;
  49676. /**
  49677. * Summary logging while loading
  49678. */
  49679. static readonly SUMMARY_LOGGING: number;
  49680. /**
  49681. * Detailled logging while loading
  49682. */
  49683. static readonly DETAILED_LOGGING: number;
  49684. /**
  49685. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  49686. */
  49687. static get ForceFullSceneLoadingForIncremental(): boolean;
  49688. static set ForceFullSceneLoadingForIncremental(value: boolean);
  49689. /**
  49690. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  49691. */
  49692. static get ShowLoadingScreen(): boolean;
  49693. static set ShowLoadingScreen(value: boolean);
  49694. /**
  49695. * Defines the current logging level (while loading the scene)
  49696. * @ignorenaming
  49697. */
  49698. static get loggingLevel(): number;
  49699. static set loggingLevel(value: number);
  49700. /**
  49701. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  49702. */
  49703. static get CleanBoneMatrixWeights(): boolean;
  49704. static set CleanBoneMatrixWeights(value: boolean);
  49705. /**
  49706. * Event raised when a plugin is used to load a scene
  49707. */
  49708. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  49709. private static _registeredPlugins;
  49710. private static _showingLoadingScreen;
  49711. /**
  49712. * Gets the default plugin (used to load Babylon files)
  49713. * @returns the .babylon plugin
  49714. */
  49715. static GetDefaultPlugin(): IRegisteredPlugin;
  49716. private static _GetPluginForExtension;
  49717. private static _GetPluginForDirectLoad;
  49718. private static _GetPluginForFilename;
  49719. private static _GetDirectLoad;
  49720. private static _LoadData;
  49721. private static _GetFileInfo;
  49722. /**
  49723. * Gets a plugin that can load the given extension
  49724. * @param extension defines the extension to load
  49725. * @returns a plugin or null if none works
  49726. */
  49727. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49728. /**
  49729. * Gets a boolean indicating that the given extension can be loaded
  49730. * @param extension defines the extension to load
  49731. * @returns true if the extension is supported
  49732. */
  49733. static IsPluginForExtensionAvailable(extension: string): boolean;
  49734. /**
  49735. * Adds a new plugin to the list of registered plugins
  49736. * @param plugin defines the plugin to add
  49737. */
  49738. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  49739. /**
  49740. * Import meshes into a scene
  49741. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49742. * @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)
  49743. * @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)
  49744. * @param scene the instance of BABYLON.Scene to append to
  49745. * @param onSuccess a callback with a list of imported meshes, particleSystems, skeletons, and animationGroups when import succeeds
  49746. * @param onProgress a callback with a progress event for each file being loaded
  49747. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49748. * @param pluginExtension the extension used to determine the plugin
  49749. * @returns The loaded plugin
  49750. */
  49751. 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>;
  49752. /**
  49753. * Import meshes into a scene
  49754. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49755. * @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)
  49756. * @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)
  49757. * @param scene the instance of BABYLON.Scene to append to
  49758. * @param onProgress a callback with a progress event for each file being loaded
  49759. * @param pluginExtension the extension used to determine the plugin
  49760. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  49761. */
  49762. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  49763. meshes: AbstractMesh[];
  49764. particleSystems: IParticleSystem[];
  49765. skeletons: Skeleton[];
  49766. animationGroups: AnimationGroup[];
  49767. }>;
  49768. /**
  49769. * Load a scene
  49770. * @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)
  49771. * @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)
  49772. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49773. * @param onSuccess a callback with the scene when import succeeds
  49774. * @param onProgress a callback with a progress event for each file being loaded
  49775. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49776. * @param pluginExtension the extension used to determine the plugin
  49777. * @returns The loaded plugin
  49778. */
  49779. 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>;
  49780. /**
  49781. * Load a scene
  49782. * @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)
  49783. * @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)
  49784. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49785. * @param onProgress a callback with a progress event for each file being loaded
  49786. * @param pluginExtension the extension used to determine the plugin
  49787. * @returns The loaded scene
  49788. */
  49789. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49790. /**
  49791. * Append a scene
  49792. * @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)
  49793. * @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)
  49794. * @param scene is the instance of BABYLON.Scene to append to
  49795. * @param onSuccess a callback with the scene when import succeeds
  49796. * @param onProgress a callback with a progress event for each file being loaded
  49797. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49798. * @param pluginExtension the extension used to determine the plugin
  49799. * @returns The loaded plugin
  49800. */
  49801. 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>;
  49802. /**
  49803. * Append a scene
  49804. * @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)
  49805. * @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)
  49806. * @param scene is the instance of BABYLON.Scene to append to
  49807. * @param onProgress a callback with a progress event for each file being loaded
  49808. * @param pluginExtension the extension used to determine the plugin
  49809. * @returns The given scene
  49810. */
  49811. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49812. /**
  49813. * Load a scene into an asset container
  49814. * @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)
  49815. * @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)
  49816. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49817. * @param onSuccess a callback with the scene when import succeeds
  49818. * @param onProgress a callback with a progress event for each file being loaded
  49819. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49820. * @param pluginExtension the extension used to determine the plugin
  49821. * @returns The loaded plugin
  49822. */
  49823. 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>;
  49824. /**
  49825. * Load a scene into an asset container
  49826. * @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)
  49827. * @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)
  49828. * @param scene is the instance of Scene to append to
  49829. * @param onProgress a callback with a progress event for each file being loaded
  49830. * @param pluginExtension the extension used to determine the plugin
  49831. * @returns The loaded asset container
  49832. */
  49833. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  49834. /**
  49835. * Import animations from a file into a scene
  49836. * @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)
  49837. * @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)
  49838. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49839. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49840. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49841. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49842. * @param onSuccess a callback with the scene when import succeeds
  49843. * @param onProgress a callback with a progress event for each file being loaded
  49844. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49845. * @param pluginExtension the extension used to determine the plugin
  49846. */
  49847. 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;
  49848. /**
  49849. * Import animations from a file into a scene
  49850. * @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)
  49851. * @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)
  49852. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49853. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49854. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49855. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49856. * @param onSuccess a callback with the scene when import succeeds
  49857. * @param onProgress a callback with a progress event for each file being loaded
  49858. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49859. * @param pluginExtension the extension used to determine the plugin
  49860. * @returns the updated scene with imported animations
  49861. */
  49862. 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>;
  49863. }
  49864. }
  49865. declare module "babylonjs/XR/motionController/webXRAbstractMotionController" {
  49866. import { IDisposable, Scene } from "babylonjs/scene";
  49867. import { WebXRControllerComponent } from "babylonjs/XR/motionController/webXRControllerComponent";
  49868. import { Observable } from "babylonjs/Misc/observable";
  49869. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49870. import { Nullable } from "babylonjs/types";
  49871. /**
  49872. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  49873. */
  49874. export type MotionControllerHandedness = "none" | "left" | "right";
  49875. /**
  49876. * The type of components available in motion controllers.
  49877. * This is not the name of the component.
  49878. */
  49879. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  49880. /**
  49881. * The state of a controller component
  49882. */
  49883. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  49884. /**
  49885. * The schema of motion controller layout.
  49886. * No object will be initialized using this interface
  49887. * This is used just to define the profile.
  49888. */
  49889. export interface IMotionControllerLayout {
  49890. /**
  49891. * Path to load the assets. Usually relative to the base path
  49892. */
  49893. assetPath: string;
  49894. /**
  49895. * Available components (unsorted)
  49896. */
  49897. components: {
  49898. /**
  49899. * A map of component Ids
  49900. */
  49901. [componentId: string]: {
  49902. /**
  49903. * The type of input the component outputs
  49904. */
  49905. type: MotionControllerComponentType;
  49906. /**
  49907. * The indices of this component in the gamepad object
  49908. */
  49909. gamepadIndices: {
  49910. /**
  49911. * Index of button
  49912. */
  49913. button?: number;
  49914. /**
  49915. * If available, index of x-axis
  49916. */
  49917. xAxis?: number;
  49918. /**
  49919. * If available, index of y-axis
  49920. */
  49921. yAxis?: number;
  49922. };
  49923. /**
  49924. * The mesh's root node name
  49925. */
  49926. rootNodeName: string;
  49927. /**
  49928. * Animation definitions for this model
  49929. */
  49930. visualResponses: {
  49931. [stateKey: string]: {
  49932. /**
  49933. * What property will be animated
  49934. */
  49935. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  49936. /**
  49937. * What states influence this visual response
  49938. */
  49939. states: MotionControllerComponentStateType[];
  49940. /**
  49941. * Type of animation - movement or visibility
  49942. */
  49943. valueNodeProperty: "transform" | "visibility";
  49944. /**
  49945. * Base node name to move. Its position will be calculated according to the min and max nodes
  49946. */
  49947. valueNodeName?: string;
  49948. /**
  49949. * Minimum movement node
  49950. */
  49951. minNodeName?: string;
  49952. /**
  49953. * Max movement node
  49954. */
  49955. maxNodeName?: string;
  49956. };
  49957. };
  49958. /**
  49959. * If touch enabled, what is the name of node to display user feedback
  49960. */
  49961. touchPointNodeName?: string;
  49962. };
  49963. };
  49964. /**
  49965. * Is it xr standard mapping or not
  49966. */
  49967. gamepadMapping: "" | "xr-standard";
  49968. /**
  49969. * Base root node of this entire model
  49970. */
  49971. rootNodeName: string;
  49972. /**
  49973. * Defines the main button component id
  49974. */
  49975. selectComponentId: string;
  49976. }
  49977. /**
  49978. * A definition for the layout map in the input profile
  49979. */
  49980. export interface IMotionControllerLayoutMap {
  49981. /**
  49982. * Layouts with handedness type as a key
  49983. */
  49984. [handedness: string]: IMotionControllerLayout;
  49985. }
  49986. /**
  49987. * The XR Input profile schema
  49988. * Profiles can be found here:
  49989. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  49990. */
  49991. export interface IMotionControllerProfile {
  49992. /**
  49993. * fallback profiles for this profileId
  49994. */
  49995. fallbackProfileIds: string[];
  49996. /**
  49997. * The layout map, with handedness as key
  49998. */
  49999. layouts: IMotionControllerLayoutMap;
  50000. /**
  50001. * The id of this profile
  50002. * correlates to the profile(s) in the xrInput.profiles array
  50003. */
  50004. profileId: string;
  50005. }
  50006. /**
  50007. * A helper-interface for the 3 meshes needed for controller button animation
  50008. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  50009. */
  50010. export interface IMotionControllerButtonMeshMap {
  50011. /**
  50012. * the mesh that defines the pressed value mesh position.
  50013. * This is used to find the max-position of this button
  50014. */
  50015. pressedMesh: AbstractMesh;
  50016. /**
  50017. * the mesh that defines the unpressed value mesh position.
  50018. * This is used to find the min (or initial) position of this button
  50019. */
  50020. unpressedMesh: AbstractMesh;
  50021. /**
  50022. * The mesh that will be changed when value changes
  50023. */
  50024. valueMesh: AbstractMesh;
  50025. }
  50026. /**
  50027. * A helper-interface for the 3 meshes needed for controller axis animation.
  50028. * This will be expanded when touchpad animations are fully supported
  50029. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  50030. */
  50031. export interface IMotionControllerMeshMap {
  50032. /**
  50033. * the mesh that defines the maximum value mesh position.
  50034. */
  50035. maxMesh?: AbstractMesh;
  50036. /**
  50037. * the mesh that defines the minimum value mesh position.
  50038. */
  50039. minMesh?: AbstractMesh;
  50040. /**
  50041. * The mesh that will be changed when axis value changes
  50042. */
  50043. valueMesh?: AbstractMesh;
  50044. }
  50045. /**
  50046. * The elements needed for change-detection of the gamepad objects in motion controllers
  50047. */
  50048. export interface IMinimalMotionControllerObject {
  50049. /**
  50050. * Available axes of this controller
  50051. */
  50052. axes: number[];
  50053. /**
  50054. * An array of available buttons
  50055. */
  50056. buttons: Array<{
  50057. /**
  50058. * Value of the button/trigger
  50059. */
  50060. value: number;
  50061. /**
  50062. * If the button/trigger is currently touched
  50063. */
  50064. touched: boolean;
  50065. /**
  50066. * If the button/trigger is currently pressed
  50067. */
  50068. pressed: boolean;
  50069. }>;
  50070. /**
  50071. * EXPERIMENTAL haptic support.
  50072. */
  50073. hapticActuators?: Array<{
  50074. pulse: (value: number, duration: number) => Promise<boolean>;
  50075. }>;
  50076. }
  50077. /**
  50078. * An Abstract Motion controller
  50079. * This class receives an xrInput and a profile layout and uses those to initialize the components
  50080. * Each component has an observable to check for changes in value and state
  50081. */
  50082. export abstract class WebXRAbstractMotionController implements IDisposable {
  50083. protected scene: Scene;
  50084. protected layout: IMotionControllerLayout;
  50085. /**
  50086. * The gamepad object correlating to this controller
  50087. */
  50088. gamepadObject: IMinimalMotionControllerObject;
  50089. /**
  50090. * handedness (left/right/none) of this controller
  50091. */
  50092. handedness: MotionControllerHandedness;
  50093. private _initComponent;
  50094. private _modelReady;
  50095. /**
  50096. * A map of components (WebXRControllerComponent) in this motion controller
  50097. * Components have a ComponentType and can also have both button and axis definitions
  50098. */
  50099. readonly components: {
  50100. [id: string]: WebXRControllerComponent;
  50101. };
  50102. /**
  50103. * Disable the model's animation. Can be set at any time.
  50104. */
  50105. disableAnimation: boolean;
  50106. /**
  50107. * Observers registered here will be triggered when the model of this controller is done loading
  50108. */
  50109. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  50110. /**
  50111. * The profile id of this motion controller
  50112. */
  50113. abstract profileId: string;
  50114. /**
  50115. * The root mesh of the model. It is null if the model was not yet initialized
  50116. */
  50117. rootMesh: Nullable<AbstractMesh>;
  50118. /**
  50119. * constructs a new abstract motion controller
  50120. * @param scene the scene to which the model of the controller will be added
  50121. * @param layout The profile layout to load
  50122. * @param gamepadObject The gamepad object correlating to this controller
  50123. * @param handedness handedness (left/right/none) of this controller
  50124. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  50125. */
  50126. constructor(scene: Scene, layout: IMotionControllerLayout,
  50127. /**
  50128. * The gamepad object correlating to this controller
  50129. */
  50130. gamepadObject: IMinimalMotionControllerObject,
  50131. /**
  50132. * handedness (left/right/none) of this controller
  50133. */
  50134. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  50135. /**
  50136. * Dispose this controller, the model mesh and all its components
  50137. */
  50138. dispose(): void;
  50139. /**
  50140. * Returns all components of specific type
  50141. * @param type the type to search for
  50142. * @return an array of components with this type
  50143. */
  50144. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  50145. /**
  50146. * get a component based an its component id as defined in layout.components
  50147. * @param id the id of the component
  50148. * @returns the component correlates to the id or undefined if not found
  50149. */
  50150. getComponent(id: string): WebXRControllerComponent;
  50151. /**
  50152. * Get the list of components available in this motion controller
  50153. * @returns an array of strings correlating to available components
  50154. */
  50155. getComponentIds(): string[];
  50156. /**
  50157. * Get the first component of specific type
  50158. * @param type type of component to find
  50159. * @return a controller component or null if not found
  50160. */
  50161. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  50162. /**
  50163. * Get the main (Select) component of this controller as defined in the layout
  50164. * @returns the main component of this controller
  50165. */
  50166. getMainComponent(): WebXRControllerComponent;
  50167. /**
  50168. * Loads the model correlating to this controller
  50169. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  50170. * @returns A promise fulfilled with the result of the model loading
  50171. */
  50172. loadModel(): Promise<boolean>;
  50173. /**
  50174. * Update this model using the current XRFrame
  50175. * @param xrFrame the current xr frame to use and update the model
  50176. */
  50177. updateFromXRFrame(xrFrame: XRFrame): void;
  50178. /**
  50179. * Backwards compatibility due to a deeply-integrated typo
  50180. */
  50181. get handness(): XREye;
  50182. /**
  50183. * Pulse (vibrate) this controller
  50184. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  50185. * Consecutive calls to this function will cancel the last pulse call
  50186. *
  50187. * @param value the strength of the pulse in 0.0...1.0 range
  50188. * @param duration Duration of the pulse in milliseconds
  50189. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  50190. * @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
  50191. */
  50192. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  50193. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  50194. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  50195. /**
  50196. * Moves the axis on the controller mesh based on its current state
  50197. * @param axis the index of the axis
  50198. * @param axisValue the value of the axis which determines the meshes new position
  50199. * @hidden
  50200. */
  50201. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  50202. /**
  50203. * Update the model itself with the current frame data
  50204. * @param xrFrame the frame to use for updating the model mesh
  50205. */
  50206. protected updateModel(xrFrame: XRFrame): void;
  50207. /**
  50208. * Get the filename and path for this controller's model
  50209. * @returns a map of filename and path
  50210. */
  50211. protected abstract _getFilenameAndPath(): {
  50212. filename: string;
  50213. path: string;
  50214. };
  50215. /**
  50216. * This function is called before the mesh is loaded. It checks for loading constraints.
  50217. * For example, this function can check if the GLB loader is available
  50218. * If this function returns false, the generic controller will be loaded instead
  50219. * @returns Is the client ready to load the mesh
  50220. */
  50221. protected abstract _getModelLoadingConstraints(): boolean;
  50222. /**
  50223. * This function will be called after the model was successfully loaded and can be used
  50224. * for mesh transformations before it is available for the user
  50225. * @param meshes the loaded meshes
  50226. */
  50227. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  50228. /**
  50229. * Set the root mesh for this controller. Important for the WebXR controller class
  50230. * @param meshes the loaded meshes
  50231. */
  50232. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  50233. /**
  50234. * A function executed each frame that updates the mesh (if needed)
  50235. * @param xrFrame the current xrFrame
  50236. */
  50237. protected abstract _updateModel(xrFrame: XRFrame): void;
  50238. private _getGenericFilenameAndPath;
  50239. private _getGenericParentMesh;
  50240. }
  50241. }
  50242. declare module "babylonjs/XR/motionController/webXRGenericMotionController" {
  50243. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50244. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50245. import { Scene } from "babylonjs/scene";
  50246. /**
  50247. * A generic trigger-only motion controller for WebXR
  50248. */
  50249. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  50250. /**
  50251. * Static version of the profile id of this controller
  50252. */
  50253. static ProfileId: string;
  50254. profileId: string;
  50255. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  50256. protected _getFilenameAndPath(): {
  50257. filename: string;
  50258. path: string;
  50259. };
  50260. protected _getModelLoadingConstraints(): boolean;
  50261. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  50262. protected _setRootMesh(meshes: AbstractMesh[]): void;
  50263. protected _updateModel(): void;
  50264. }
  50265. }
  50266. declare module "babylonjs/Meshes/Builders/sphereBuilder" {
  50267. import { Vector4 } from "babylonjs/Maths/math.vector";
  50268. import { Mesh } from "babylonjs/Meshes/mesh";
  50269. import { Scene } from "babylonjs/scene";
  50270. import { Nullable } from "babylonjs/types";
  50271. /**
  50272. * Class containing static functions to help procedurally build meshes
  50273. */
  50274. export class SphereBuilder {
  50275. /**
  50276. * Creates a sphere mesh
  50277. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  50278. * * 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`)
  50279. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  50280. * * 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
  50281. * * 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)
  50282. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  50283. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  50284. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50285. * @param name defines the name of the mesh
  50286. * @param options defines the options used to create the mesh
  50287. * @param scene defines the hosting scene
  50288. * @returns the sphere mesh
  50289. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  50290. */
  50291. static CreateSphere(name: string, options: {
  50292. segments?: number;
  50293. diameter?: number;
  50294. diameterX?: number;
  50295. diameterY?: number;
  50296. diameterZ?: number;
  50297. arc?: number;
  50298. slice?: number;
  50299. sideOrientation?: number;
  50300. frontUVs?: Vector4;
  50301. backUVs?: Vector4;
  50302. updatable?: boolean;
  50303. }, scene?: Nullable<Scene>): Mesh;
  50304. }
  50305. }
  50306. declare module "babylonjs/XR/motionController/webXRProfiledMotionController" {
  50307. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50308. import { WebXRAbstractMotionController, IMotionControllerProfile } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50309. import { Scene } from "babylonjs/scene";
  50310. /**
  50311. * A profiled motion controller has its profile loaded from an online repository.
  50312. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  50313. */
  50314. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  50315. private _repositoryUrl;
  50316. private _buttonMeshMapping;
  50317. private _touchDots;
  50318. /**
  50319. * The profile ID of this controller. Will be populated when the controller initializes.
  50320. */
  50321. profileId: string;
  50322. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  50323. dispose(): void;
  50324. protected _getFilenameAndPath(): {
  50325. filename: string;
  50326. path: string;
  50327. };
  50328. protected _getModelLoadingConstraints(): boolean;
  50329. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  50330. protected _setRootMesh(meshes: AbstractMesh[]): void;
  50331. protected _updateModel(_xrFrame: XRFrame): void;
  50332. }
  50333. }
  50334. declare module "babylonjs/XR/motionController/webXRMotionControllerManager" {
  50335. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50336. import { Scene } from "babylonjs/scene";
  50337. /**
  50338. * A construction function type to create a new controller based on an xrInput object
  50339. */
  50340. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  50341. /**
  50342. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  50343. *
  50344. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  50345. * it should be replaced with auto-loaded controllers.
  50346. *
  50347. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  50348. */
  50349. export class WebXRMotionControllerManager {
  50350. private static _AvailableControllers;
  50351. private static _Fallbacks;
  50352. private static _ProfileLoadingPromises;
  50353. private static _ProfilesList;
  50354. /**
  50355. * The base URL of the online controller repository. Can be changed at any time.
  50356. */
  50357. static BaseRepositoryUrl: string;
  50358. /**
  50359. * Which repository gets priority - local or online
  50360. */
  50361. static PrioritizeOnlineRepository: boolean;
  50362. /**
  50363. * Use the online repository, or use only locally-defined controllers
  50364. */
  50365. static UseOnlineRepository: boolean;
  50366. /**
  50367. * Clear the cache used for profile loading and reload when requested again
  50368. */
  50369. static ClearProfilesCache(): void;
  50370. /**
  50371. * Register the default fallbacks.
  50372. * This function is called automatically when this file is imported.
  50373. */
  50374. static DefaultFallbacks(): void;
  50375. /**
  50376. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  50377. * @param profileId the profile to which a fallback needs to be found
  50378. * @return an array with corresponding fallback profiles
  50379. */
  50380. static FindFallbackWithProfileId(profileId: string): string[];
  50381. /**
  50382. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  50383. * The order of search:
  50384. *
  50385. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  50386. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  50387. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  50388. * 4) return the generic trigger controller if none were found
  50389. *
  50390. * @param xrInput the xrInput to which a new controller is initialized
  50391. * @param scene the scene to which the model will be added
  50392. * @param forceProfile force a certain profile for this controller
  50393. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  50394. */
  50395. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  50396. /**
  50397. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  50398. *
  50399. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  50400. *
  50401. * @param type the profile type to register
  50402. * @param constructFunction the function to be called when loading this profile
  50403. */
  50404. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  50405. /**
  50406. * Register a fallback to a specific profile.
  50407. * @param profileId the profileId that will receive the fallbacks
  50408. * @param fallbacks A list of fallback profiles
  50409. */
  50410. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  50411. /**
  50412. * Will update the list of profiles available in the repository
  50413. * @return a promise that resolves to a map of profiles available online
  50414. */
  50415. static UpdateProfilesList(): Promise<{
  50416. [profile: string]: string;
  50417. }>;
  50418. private static _LoadProfileFromRepository;
  50419. private static _LoadProfilesFromAvailableControllers;
  50420. }
  50421. }
  50422. declare module "babylonjs/XR/webXRInputSource" {
  50423. import { Observable } from "babylonjs/Misc/observable";
  50424. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50425. import { Ray } from "babylonjs/Culling/ray";
  50426. import { Scene } from "babylonjs/scene";
  50427. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50428. /**
  50429. * Configuration options for the WebXR controller creation
  50430. */
  50431. export interface IWebXRControllerOptions {
  50432. /**
  50433. * Should the controller mesh be animated when a user interacts with it
  50434. * The pressed buttons / thumbstick and touchpad animations will be disabled
  50435. */
  50436. disableMotionControllerAnimation?: boolean;
  50437. /**
  50438. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  50439. */
  50440. doNotLoadControllerMesh?: boolean;
  50441. /**
  50442. * Force a specific controller type for this controller.
  50443. * This can be used when creating your own profile or when testing different controllers
  50444. */
  50445. forceControllerProfile?: string;
  50446. /**
  50447. * Defines a rendering group ID for meshes that will be loaded.
  50448. * This is for the default controllers only.
  50449. */
  50450. renderingGroupId?: number;
  50451. }
  50452. /**
  50453. * Represents an XR controller
  50454. */
  50455. export class WebXRInputSource {
  50456. private _scene;
  50457. /** The underlying input source for the controller */
  50458. inputSource: XRInputSource;
  50459. private _options;
  50460. private _tmpVector;
  50461. private _uniqueId;
  50462. private _disposed;
  50463. /**
  50464. * 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
  50465. */
  50466. grip?: AbstractMesh;
  50467. /**
  50468. * If available, this is the gamepad object related to this controller.
  50469. * Using this object it is possible to get click events and trackpad changes of the
  50470. * webxr controller that is currently being used.
  50471. */
  50472. motionController?: WebXRAbstractMotionController;
  50473. /**
  50474. * Event that fires when the controller is removed/disposed.
  50475. * The object provided as event data is this controller, after associated assets were disposed.
  50476. * uniqueId is still available.
  50477. */
  50478. onDisposeObservable: Observable<WebXRInputSource>;
  50479. /**
  50480. * Will be triggered when the mesh associated with the motion controller is done loading.
  50481. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  50482. * A shortened version of controller -> motion controller -> on mesh loaded.
  50483. */
  50484. onMeshLoadedObservable: Observable<AbstractMesh>;
  50485. /**
  50486. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  50487. */
  50488. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  50489. /**
  50490. * Pointer which can be used to select objects or attach a visible laser to
  50491. */
  50492. pointer: AbstractMesh;
  50493. /**
  50494. * Creates the input source object
  50495. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  50496. * @param _scene the scene which the controller should be associated to
  50497. * @param inputSource the underlying input source for the controller
  50498. * @param _options options for this controller creation
  50499. */
  50500. constructor(_scene: Scene,
  50501. /** The underlying input source for the controller */
  50502. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  50503. /**
  50504. * Get this controllers unique id
  50505. */
  50506. get uniqueId(): string;
  50507. /**
  50508. * Disposes of the object
  50509. */
  50510. dispose(): void;
  50511. /**
  50512. * Gets a world space ray coming from the pointer or grip
  50513. * @param result the resulting ray
  50514. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  50515. */
  50516. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  50517. /**
  50518. * Updates the controller pose based on the given XRFrame
  50519. * @param xrFrame xr frame to update the pose with
  50520. * @param referenceSpace reference space to use
  50521. */
  50522. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  50523. }
  50524. }
  50525. declare module "babylonjs/XR/webXRInput" {
  50526. import { Observable } from "babylonjs/Misc/observable";
  50527. import { IDisposable } from "babylonjs/scene";
  50528. import { WebXRInputSource, IWebXRControllerOptions } from "babylonjs/XR/webXRInputSource";
  50529. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50530. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50531. /**
  50532. * The schema for initialization options of the XR Input class
  50533. */
  50534. export interface IWebXRInputOptions {
  50535. /**
  50536. * If set to true no model will be automatically loaded
  50537. */
  50538. doNotLoadControllerMeshes?: boolean;
  50539. /**
  50540. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  50541. * If not found, the xr input profile data will be used.
  50542. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  50543. */
  50544. forceInputProfile?: string;
  50545. /**
  50546. * Do not send a request to the controller repository to load the profile.
  50547. *
  50548. * Instead, use the controllers available in babylon itself.
  50549. */
  50550. disableOnlineControllerRepository?: boolean;
  50551. /**
  50552. * A custom URL for the controllers repository
  50553. */
  50554. customControllersRepositoryURL?: string;
  50555. /**
  50556. * Should the controller model's components not move according to the user input
  50557. */
  50558. disableControllerAnimation?: boolean;
  50559. /**
  50560. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  50561. */
  50562. controllerOptions?: IWebXRControllerOptions;
  50563. }
  50564. /**
  50565. * XR input used to track XR inputs such as controllers/rays
  50566. */
  50567. export class WebXRInput implements IDisposable {
  50568. /**
  50569. * the xr session manager for this session
  50570. */
  50571. xrSessionManager: WebXRSessionManager;
  50572. /**
  50573. * the WebXR camera for this session. Mainly used for teleportation
  50574. */
  50575. xrCamera: WebXRCamera;
  50576. private readonly options;
  50577. /**
  50578. * XR controllers being tracked
  50579. */
  50580. controllers: Array<WebXRInputSource>;
  50581. private _frameObserver;
  50582. private _sessionEndedObserver;
  50583. private _sessionInitObserver;
  50584. /**
  50585. * Event when a controller has been connected/added
  50586. */
  50587. onControllerAddedObservable: Observable<WebXRInputSource>;
  50588. /**
  50589. * Event when a controller has been removed/disconnected
  50590. */
  50591. onControllerRemovedObservable: Observable<WebXRInputSource>;
  50592. /**
  50593. * Initializes the WebXRInput
  50594. * @param xrSessionManager the xr session manager for this session
  50595. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  50596. * @param options = initialization options for this xr input
  50597. */
  50598. constructor(
  50599. /**
  50600. * the xr session manager for this session
  50601. */
  50602. xrSessionManager: WebXRSessionManager,
  50603. /**
  50604. * the WebXR camera for this session. Mainly used for teleportation
  50605. */
  50606. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  50607. private _onInputSourcesChange;
  50608. private _addAndRemoveControllers;
  50609. /**
  50610. * Disposes of the object
  50611. */
  50612. dispose(): void;
  50613. }
  50614. }
  50615. declare module "babylonjs/XR/features/WebXRAbstractFeature" {
  50616. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  50617. import { Observable, EventState } from "babylonjs/Misc/observable";
  50618. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50619. /**
  50620. * This is the base class for all WebXR features.
  50621. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  50622. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  50623. */
  50624. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  50625. protected _xrSessionManager: WebXRSessionManager;
  50626. private _attached;
  50627. private _removeOnDetach;
  50628. /**
  50629. * Is this feature disposed?
  50630. */
  50631. isDisposed: boolean;
  50632. /**
  50633. * Should auto-attach be disabled?
  50634. */
  50635. disableAutoAttach: boolean;
  50636. /**
  50637. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  50638. */
  50639. xrNativeFeatureName: string;
  50640. /**
  50641. * Construct a new (abstract) WebXR feature
  50642. * @param _xrSessionManager the xr session manager for this feature
  50643. */
  50644. constructor(_xrSessionManager: WebXRSessionManager);
  50645. /**
  50646. * Is this feature attached
  50647. */
  50648. get attached(): boolean;
  50649. /**
  50650. * attach this feature
  50651. *
  50652. * @param force should attachment be forced (even when already attached)
  50653. * @returns true if successful, false is failed or already attached
  50654. */
  50655. attach(force?: boolean): boolean;
  50656. /**
  50657. * detach this feature.
  50658. *
  50659. * @returns true if successful, false if failed or already detached
  50660. */
  50661. detach(): boolean;
  50662. /**
  50663. * Dispose this feature and all of the resources attached
  50664. */
  50665. dispose(): void;
  50666. /**
  50667. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  50668. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  50669. *
  50670. * @returns whether or not the feature is compatible in this environment
  50671. */
  50672. isCompatible(): boolean;
  50673. /**
  50674. * This is used to register callbacks that will automatically be removed when detach is called.
  50675. * @param observable the observable to which the observer will be attached
  50676. * @param callback the callback to register
  50677. */
  50678. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  50679. /**
  50680. * Code in this function will be executed on each xrFrame received from the browser.
  50681. * This function will not execute after the feature is detached.
  50682. * @param _xrFrame the current frame
  50683. */
  50684. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  50685. }
  50686. }
  50687. declare module "babylonjs/Rendering/utilityLayerRenderer" {
  50688. import { IDisposable, Scene } from "babylonjs/scene";
  50689. import { Nullable } from "babylonjs/types";
  50690. import { Observable } from "babylonjs/Misc/observable";
  50691. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50692. import { HemisphericLight } from "babylonjs/Lights/hemisphericLight";
  50693. import { Camera } from "babylonjs/Cameras/camera";
  50694. /**
  50695. * Renders a layer on top of an existing scene
  50696. */
  50697. export class UtilityLayerRenderer implements IDisposable {
  50698. /** the original scene that will be rendered on top of */
  50699. originalScene: Scene;
  50700. private _pointerCaptures;
  50701. private _lastPointerEvents;
  50702. private static _DefaultUtilityLayer;
  50703. private static _DefaultKeepDepthUtilityLayer;
  50704. private _sharedGizmoLight;
  50705. private _renderCamera;
  50706. /**
  50707. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  50708. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  50709. * @returns the camera that is used when rendering the utility layer
  50710. */
  50711. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  50712. /**
  50713. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  50714. * @param cam the camera that should be used when rendering the utility layer
  50715. */
  50716. setRenderCamera(cam: Nullable<Camera>): void;
  50717. /**
  50718. * @hidden
  50719. * Light which used by gizmos to get light shading
  50720. */
  50721. _getSharedGizmoLight(): HemisphericLight;
  50722. /**
  50723. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  50724. */
  50725. pickUtilitySceneFirst: boolean;
  50726. /**
  50727. * 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)
  50728. */
  50729. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  50730. /**
  50731. * 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)
  50732. */
  50733. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  50734. /**
  50735. * The scene that is rendered on top of the original scene
  50736. */
  50737. utilityLayerScene: Scene;
  50738. /**
  50739. * If the utility layer should automatically be rendered on top of existing scene
  50740. */
  50741. shouldRender: boolean;
  50742. /**
  50743. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  50744. */
  50745. onlyCheckPointerDownEvents: boolean;
  50746. /**
  50747. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  50748. */
  50749. processAllEvents: boolean;
  50750. /**
  50751. * Observable raised when the pointer move from the utility layer scene to the main scene
  50752. */
  50753. onPointerOutObservable: Observable<number>;
  50754. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  50755. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  50756. private _afterRenderObserver;
  50757. private _sceneDisposeObserver;
  50758. private _originalPointerObserver;
  50759. /**
  50760. * Instantiates a UtilityLayerRenderer
  50761. * @param originalScene the original scene that will be rendered on top of
  50762. * @param handleEvents boolean indicating if the utility layer should handle events
  50763. */
  50764. constructor(
  50765. /** the original scene that will be rendered on top of */
  50766. originalScene: Scene, handleEvents?: boolean);
  50767. private _notifyObservers;
  50768. /**
  50769. * Renders the utility layers scene on top of the original scene
  50770. */
  50771. render(): void;
  50772. /**
  50773. * Disposes of the renderer
  50774. */
  50775. dispose(): void;
  50776. private _updateCamera;
  50777. }
  50778. }
  50779. declare module "babylonjs/XR/features/WebXRControllerPointerSelection" {
  50780. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50781. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50782. import { WebXRInput } from "babylonjs/XR/webXRInput";
  50783. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  50784. import { Scene } from "babylonjs/scene";
  50785. import { Nullable } from "babylonjs/types";
  50786. import { Color3 } from "babylonjs/Maths/math.color";
  50787. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  50788. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50789. /**
  50790. * Options interface for the pointer selection module
  50791. */
  50792. export interface IWebXRControllerPointerSelectionOptions {
  50793. /**
  50794. * if provided, this scene will be used to render meshes.
  50795. */
  50796. customUtilityLayerScene?: Scene;
  50797. /**
  50798. * 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)
  50799. * If not disabled, the last picked point will be used to execute a pointer up event
  50800. * If disabled, pointer up event will be triggered right after the pointer down event.
  50801. * Used in screen and gaze target ray mode only
  50802. */
  50803. disablePointerUpOnTouchOut: boolean;
  50804. /**
  50805. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  50806. */
  50807. forceGazeMode: boolean;
  50808. /**
  50809. * 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
  50810. * to start a new countdown to the pointer down event.
  50811. * Defaults to 1.
  50812. */
  50813. gazeModePointerMovedFactor?: number;
  50814. /**
  50815. * Different button type to use instead of the main component
  50816. */
  50817. overrideButtonId?: string;
  50818. /**
  50819. * use this rendering group id for the meshes (optional)
  50820. */
  50821. renderingGroupId?: number;
  50822. /**
  50823. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  50824. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  50825. * 3000 means 3 seconds between pointing at something and selecting it
  50826. */
  50827. timeToSelect?: number;
  50828. /**
  50829. * Should meshes created here be added to a utility layer or the main scene
  50830. */
  50831. useUtilityLayer?: boolean;
  50832. /**
  50833. * Optional WebXR camera to be used for gaze selection
  50834. */
  50835. gazeCamera?: WebXRCamera;
  50836. /**
  50837. * the xr input to use with this pointer selection
  50838. */
  50839. xrInput: WebXRInput;
  50840. }
  50841. /**
  50842. * A module that will enable pointer selection for motion controllers of XR Input Sources
  50843. */
  50844. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  50845. private readonly _options;
  50846. private static _idCounter;
  50847. private _attachController;
  50848. private _controllers;
  50849. private _scene;
  50850. private _tmpVectorForPickCompare;
  50851. /**
  50852. * The module's name
  50853. */
  50854. static readonly Name: string;
  50855. /**
  50856. * The (Babylon) version of this module.
  50857. * This is an integer representing the implementation version.
  50858. * This number does not correspond to the WebXR specs version
  50859. */
  50860. static readonly Version: number;
  50861. /**
  50862. * Disable lighting on the laser pointer (so it will always be visible)
  50863. */
  50864. disablePointerLighting: boolean;
  50865. /**
  50866. * Disable lighting on the selection mesh (so it will always be visible)
  50867. */
  50868. disableSelectionMeshLighting: boolean;
  50869. /**
  50870. * Should the laser pointer be displayed
  50871. */
  50872. displayLaserPointer: boolean;
  50873. /**
  50874. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  50875. */
  50876. displaySelectionMesh: boolean;
  50877. /**
  50878. * This color will be set to the laser pointer when selection is triggered
  50879. */
  50880. laserPointerPickedColor: Color3;
  50881. /**
  50882. * Default color of the laser pointer
  50883. */
  50884. laserPointerDefaultColor: Color3;
  50885. /**
  50886. * default color of the selection ring
  50887. */
  50888. selectionMeshDefaultColor: Color3;
  50889. /**
  50890. * This color will be applied to the selection ring when selection is triggered
  50891. */
  50892. selectionMeshPickedColor: Color3;
  50893. /**
  50894. * Optional filter to be used for ray selection. This predicate shares behavior with
  50895. * scene.pointerMovePredicate which takes priority if it is also assigned.
  50896. */
  50897. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  50898. /**
  50899. * constructs a new background remover module
  50900. * @param _xrSessionManager the session manager for this module
  50901. * @param _options read-only options to be used in this module
  50902. */
  50903. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  50904. /**
  50905. * attach this feature
  50906. * Will usually be called by the features manager
  50907. *
  50908. * @returns true if successful.
  50909. */
  50910. attach(): boolean;
  50911. /**
  50912. * detach this feature.
  50913. * Will usually be called by the features manager
  50914. *
  50915. * @returns true if successful.
  50916. */
  50917. detach(): boolean;
  50918. /**
  50919. * Will get the mesh under a specific pointer.
  50920. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  50921. * @param controllerId the controllerId to check
  50922. * @returns The mesh under pointer or null if no mesh is under the pointer
  50923. */
  50924. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  50925. /**
  50926. * Get the xr controller that correlates to the pointer id in the pointer event
  50927. *
  50928. * @param id the pointer id to search for
  50929. * @returns the controller that correlates to this id or null if not found
  50930. */
  50931. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  50932. protected _onXRFrame(_xrFrame: XRFrame): void;
  50933. private _attachGazeMode;
  50934. private _attachScreenRayMode;
  50935. private _attachTrackedPointerRayMode;
  50936. private _convertNormalToDirectionOfRay;
  50937. private _detachController;
  50938. private _generateNewMeshPair;
  50939. private _pickingMoved;
  50940. private _updatePointerDistance;
  50941. /** @hidden */
  50942. get lasterPointerDefaultColor(): Color3;
  50943. }
  50944. }
  50945. declare module "babylonjs/XR/webXREnterExitUI" {
  50946. import { Nullable } from "babylonjs/types";
  50947. import { Observable } from "babylonjs/Misc/observable";
  50948. import { IDisposable, Scene } from "babylonjs/scene";
  50949. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  50950. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  50951. /**
  50952. * Button which can be used to enter a different mode of XR
  50953. */
  50954. export class WebXREnterExitUIButton {
  50955. /** button element */
  50956. element: HTMLElement;
  50957. /** XR initialization options for the button */
  50958. sessionMode: XRSessionMode;
  50959. /** Reference space type */
  50960. referenceSpaceType: XRReferenceSpaceType;
  50961. /**
  50962. * Creates a WebXREnterExitUIButton
  50963. * @param element button element
  50964. * @param sessionMode XR initialization session mode
  50965. * @param referenceSpaceType the type of reference space to be used
  50966. */
  50967. constructor(
  50968. /** button element */
  50969. element: HTMLElement,
  50970. /** XR initialization options for the button */
  50971. sessionMode: XRSessionMode,
  50972. /** Reference space type */
  50973. referenceSpaceType: XRReferenceSpaceType);
  50974. /**
  50975. * Extendable function which can be used to update the button's visuals when the state changes
  50976. * @param activeButton the current active button in the UI
  50977. */
  50978. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  50979. }
  50980. /**
  50981. * Options to create the webXR UI
  50982. */
  50983. export class WebXREnterExitUIOptions {
  50984. /**
  50985. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  50986. */
  50987. customButtons?: Array<WebXREnterExitUIButton>;
  50988. /**
  50989. * A reference space type to use when creating the default button.
  50990. * Default is local-floor
  50991. */
  50992. referenceSpaceType?: XRReferenceSpaceType;
  50993. /**
  50994. * Context to enter xr with
  50995. */
  50996. renderTarget?: Nullable<WebXRRenderTarget>;
  50997. /**
  50998. * A session mode to use when creating the default button.
  50999. * Default is immersive-vr
  51000. */
  51001. sessionMode?: XRSessionMode;
  51002. /**
  51003. * A list of optional features to init the session with
  51004. */
  51005. optionalFeatures?: string[];
  51006. /**
  51007. * A list of optional features to init the session with
  51008. */
  51009. requiredFeatures?: string[];
  51010. }
  51011. /**
  51012. * UI to allow the user to enter/exit XR mode
  51013. */
  51014. export class WebXREnterExitUI implements IDisposable {
  51015. private scene;
  51016. /** version of the options passed to this UI */
  51017. options: WebXREnterExitUIOptions;
  51018. private _activeButton;
  51019. private _buttons;
  51020. /**
  51021. * The HTML Div Element to which buttons are added.
  51022. */
  51023. readonly overlay: HTMLDivElement;
  51024. /**
  51025. * Fired every time the active button is changed.
  51026. *
  51027. * When xr is entered via a button that launches xr that button will be the callback parameter
  51028. *
  51029. * When exiting xr the callback parameter will be null)
  51030. */
  51031. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  51032. /**
  51033. *
  51034. * @param scene babylon scene object to use
  51035. * @param options (read-only) version of the options passed to this UI
  51036. */
  51037. private constructor();
  51038. /**
  51039. * Creates UI to allow the user to enter/exit XR mode
  51040. * @param scene the scene to add the ui to
  51041. * @param helper the xr experience helper to enter/exit xr with
  51042. * @param options options to configure the UI
  51043. * @returns the created ui
  51044. */
  51045. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  51046. /**
  51047. * Disposes of the XR UI component
  51048. */
  51049. dispose(): void;
  51050. private _updateButtons;
  51051. }
  51052. }
  51053. declare module "babylonjs/Meshes/Builders/linesBuilder" {
  51054. import { Vector3 } from "babylonjs/Maths/math.vector";
  51055. import { Color4 } from "babylonjs/Maths/math.color";
  51056. import { Nullable } from "babylonjs/types";
  51057. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  51058. import { Scene } from "babylonjs/scene";
  51059. /**
  51060. * Class containing static functions to help procedurally build meshes
  51061. */
  51062. export class LinesBuilder {
  51063. /**
  51064. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  51065. * * 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
  51066. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  51067. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  51068. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  51069. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  51070. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  51071. * * 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
  51072. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  51073. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  51074. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  51075. * @param name defines the name of the new line system
  51076. * @param options defines the options used to create the line system
  51077. * @param scene defines the hosting scene
  51078. * @returns a new line system mesh
  51079. */
  51080. static CreateLineSystem(name: string, options: {
  51081. lines: Vector3[][];
  51082. updatable?: boolean;
  51083. instance?: Nullable<LinesMesh>;
  51084. colors?: Nullable<Color4[][]>;
  51085. useVertexAlpha?: boolean;
  51086. }, scene: Nullable<Scene>): LinesMesh;
  51087. /**
  51088. * Creates a line mesh
  51089. * 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
  51090. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  51091. * * The parameter `points` is an array successive Vector3
  51092. * * 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
  51093. * * The optional parameter `colors` is an array of successive Color4, one per line point
  51094. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  51095. * * When updating an instance, remember that only point positions can change, not the number of points
  51096. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  51097. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  51098. * @param name defines the name of the new line system
  51099. * @param options defines the options used to create the line system
  51100. * @param scene defines the hosting scene
  51101. * @returns a new line mesh
  51102. */
  51103. static CreateLines(name: string, options: {
  51104. points: Vector3[];
  51105. updatable?: boolean;
  51106. instance?: Nullable<LinesMesh>;
  51107. colors?: Color4[];
  51108. useVertexAlpha?: boolean;
  51109. }, scene?: Nullable<Scene>): LinesMesh;
  51110. /**
  51111. * Creates a dashed line mesh
  51112. * * 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
  51113. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  51114. * * The parameter `points` is an array successive Vector3
  51115. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  51116. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  51117. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  51118. * * 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
  51119. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  51120. * * When updating an instance, remember that only point positions can change, not the number of points
  51121. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  51122. * @param name defines the name of the mesh
  51123. * @param options defines the options used to create the mesh
  51124. * @param scene defines the hosting scene
  51125. * @returns the dashed line mesh
  51126. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  51127. */
  51128. static CreateDashedLines(name: string, options: {
  51129. points: Vector3[];
  51130. dashSize?: number;
  51131. gapSize?: number;
  51132. dashNb?: number;
  51133. updatable?: boolean;
  51134. instance?: LinesMesh;
  51135. useVertexAlpha?: boolean;
  51136. }, scene?: Nullable<Scene>): LinesMesh;
  51137. }
  51138. }
  51139. declare module "babylonjs/Misc/timer" {
  51140. import { Observable, Observer } from "babylonjs/Misc/observable";
  51141. import { Nullable } from "babylonjs/types";
  51142. import { IDisposable } from "babylonjs/scene";
  51143. /**
  51144. * Construction options for a timer
  51145. */
  51146. export interface ITimerOptions<T> {
  51147. /**
  51148. * Time-to-end
  51149. */
  51150. timeout: number;
  51151. /**
  51152. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  51153. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  51154. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  51155. */
  51156. contextObservable: Observable<T>;
  51157. /**
  51158. * Optional parameters when adding an observer to the observable
  51159. */
  51160. observableParameters?: {
  51161. mask?: number;
  51162. insertFirst?: boolean;
  51163. scope?: any;
  51164. };
  51165. /**
  51166. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  51167. */
  51168. breakCondition?: (data?: ITimerData<T>) => boolean;
  51169. /**
  51170. * Will be triggered when the time condition has met
  51171. */
  51172. onEnded?: (data: ITimerData<any>) => void;
  51173. /**
  51174. * Will be triggered when the break condition has met (prematurely ended)
  51175. */
  51176. onAborted?: (data: ITimerData<any>) => void;
  51177. /**
  51178. * Optional function to execute on each tick (or count)
  51179. */
  51180. onTick?: (data: ITimerData<any>) => void;
  51181. }
  51182. /**
  51183. * An interface defining the data sent by the timer
  51184. */
  51185. export interface ITimerData<T> {
  51186. /**
  51187. * When did it start
  51188. */
  51189. startTime: number;
  51190. /**
  51191. * Time now
  51192. */
  51193. currentTime: number;
  51194. /**
  51195. * Time passed since started
  51196. */
  51197. deltaTime: number;
  51198. /**
  51199. * How much is completed, in [0.0...1.0].
  51200. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  51201. */
  51202. completeRate: number;
  51203. /**
  51204. * What the registered observable sent in the last count
  51205. */
  51206. payload: T;
  51207. }
  51208. /**
  51209. * The current state of the timer
  51210. */
  51211. export enum TimerState {
  51212. /**
  51213. * Timer initialized, not yet started
  51214. */
  51215. INIT = 0,
  51216. /**
  51217. * Timer started and counting
  51218. */
  51219. STARTED = 1,
  51220. /**
  51221. * Timer ended (whether aborted or time reached)
  51222. */
  51223. ENDED = 2
  51224. }
  51225. /**
  51226. * A simple version of the timer. Will take options and start the timer immediately after calling it
  51227. *
  51228. * @param options options with which to initialize this timer
  51229. */
  51230. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  51231. /**
  51232. * An advanced implementation of a timer class
  51233. */
  51234. export class AdvancedTimer<T = any> implements IDisposable {
  51235. /**
  51236. * Will notify each time the timer calculates the remaining time
  51237. */
  51238. onEachCountObservable: Observable<ITimerData<T>>;
  51239. /**
  51240. * Will trigger when the timer was aborted due to the break condition
  51241. */
  51242. onTimerAbortedObservable: Observable<ITimerData<T>>;
  51243. /**
  51244. * Will trigger when the timer ended successfully
  51245. */
  51246. onTimerEndedObservable: Observable<ITimerData<T>>;
  51247. /**
  51248. * Will trigger when the timer state has changed
  51249. */
  51250. onStateChangedObservable: Observable<TimerState>;
  51251. private _observer;
  51252. private _contextObservable;
  51253. private _observableParameters;
  51254. private _startTime;
  51255. private _timer;
  51256. private _state;
  51257. private _breakCondition;
  51258. private _timeToEnd;
  51259. private _breakOnNextTick;
  51260. /**
  51261. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  51262. * @param options construction options for this advanced timer
  51263. */
  51264. constructor(options: ITimerOptions<T>);
  51265. /**
  51266. * set a breaking condition for this timer. Default is to never break during count
  51267. * @param predicate the new break condition. Returns true to break, false otherwise
  51268. */
  51269. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  51270. /**
  51271. * Reset ALL associated observables in this advanced timer
  51272. */
  51273. clearObservables(): void;
  51274. /**
  51275. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  51276. *
  51277. * @param timeToEnd how much time to measure until timer ended
  51278. */
  51279. start(timeToEnd?: number): void;
  51280. /**
  51281. * Will force a stop on the next tick.
  51282. */
  51283. stop(): void;
  51284. /**
  51285. * Dispose this timer, clearing all resources
  51286. */
  51287. dispose(): void;
  51288. private _setState;
  51289. private _tick;
  51290. private _stop;
  51291. }
  51292. }
  51293. declare module "babylonjs/XR/features/WebXRControllerTeleportation" {
  51294. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  51295. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  51296. import { Nullable } from "babylonjs/types";
  51297. import { WebXRInput } from "babylonjs/XR/webXRInput";
  51298. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51299. import { Vector3 } from "babylonjs/Maths/math.vector";
  51300. import { Material } from "babylonjs/Materials/material";
  51301. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  51302. import { Scene } from "babylonjs/scene";
  51303. /**
  51304. * The options container for the teleportation module
  51305. */
  51306. export interface IWebXRTeleportationOptions {
  51307. /**
  51308. * if provided, this scene will be used to render meshes.
  51309. */
  51310. customUtilityLayerScene?: Scene;
  51311. /**
  51312. * Values to configure the default target mesh
  51313. */
  51314. defaultTargetMeshOptions?: {
  51315. /**
  51316. * Fill color of the teleportation area
  51317. */
  51318. teleportationFillColor?: string;
  51319. /**
  51320. * Border color for the teleportation area
  51321. */
  51322. teleportationBorderColor?: string;
  51323. /**
  51324. * Disable the mesh's animation sequence
  51325. */
  51326. disableAnimation?: boolean;
  51327. /**
  51328. * Disable lighting on the material or the ring and arrow
  51329. */
  51330. disableLighting?: boolean;
  51331. /**
  51332. * Override the default material of the torus and arrow
  51333. */
  51334. torusArrowMaterial?: Material;
  51335. };
  51336. /**
  51337. * A list of meshes to use as floor meshes.
  51338. * Meshes can be added and removed after initializing the feature using the
  51339. * addFloorMesh and removeFloorMesh functions
  51340. * If empty, rotation will still work
  51341. */
  51342. floorMeshes?: AbstractMesh[];
  51343. /**
  51344. * use this rendering group id for the meshes (optional)
  51345. */
  51346. renderingGroupId?: number;
  51347. /**
  51348. * Should teleportation move only to snap points
  51349. */
  51350. snapPointsOnly?: boolean;
  51351. /**
  51352. * An array of points to which the teleportation will snap to.
  51353. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  51354. */
  51355. snapPositions?: Vector3[];
  51356. /**
  51357. * How close should the teleportation ray be in order to snap to position.
  51358. * Default to 0.8 units (meters)
  51359. */
  51360. snapToPositionRadius?: number;
  51361. /**
  51362. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  51363. * If you want to support rotation, make sure your mesh has a direction indicator.
  51364. *
  51365. * When left untouched, the default mesh will be initialized.
  51366. */
  51367. teleportationTargetMesh?: AbstractMesh;
  51368. /**
  51369. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  51370. */
  51371. timeToTeleport?: number;
  51372. /**
  51373. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  51374. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  51375. */
  51376. useMainComponentOnly?: boolean;
  51377. /**
  51378. * Should meshes created here be added to a utility layer or the main scene
  51379. */
  51380. useUtilityLayer?: boolean;
  51381. /**
  51382. * Babylon XR Input class for controller
  51383. */
  51384. xrInput: WebXRInput;
  51385. /**
  51386. * Meshes that the teleportation ray cannot go through
  51387. */
  51388. pickBlockerMeshes?: AbstractMesh[];
  51389. }
  51390. /**
  51391. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  51392. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  51393. * the input of the attached controllers.
  51394. */
  51395. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  51396. private _options;
  51397. private _controllers;
  51398. private _currentTeleportationControllerId;
  51399. private _floorMeshes;
  51400. private _quadraticBezierCurve;
  51401. private _selectionFeature;
  51402. private _snapToPositions;
  51403. private _snappedToPoint;
  51404. private _teleportationRingMaterial?;
  51405. private _tmpRay;
  51406. private _tmpVector;
  51407. private _tmpQuaternion;
  51408. /**
  51409. * The module's name
  51410. */
  51411. static readonly Name: string;
  51412. /**
  51413. * The (Babylon) version of this module.
  51414. * This is an integer representing the implementation version.
  51415. * This number does not correspond to the webxr specs version
  51416. */
  51417. static readonly Version: number;
  51418. /**
  51419. * Is movement backwards enabled
  51420. */
  51421. backwardsMovementEnabled: boolean;
  51422. /**
  51423. * Distance to travel when moving backwards
  51424. */
  51425. backwardsTeleportationDistance: number;
  51426. /**
  51427. * The distance from the user to the inspection point in the direction of the controller
  51428. * A higher number will allow the user to move further
  51429. * defaults to 5 (meters, in xr units)
  51430. */
  51431. parabolicCheckRadius: number;
  51432. /**
  51433. * Should the module support parabolic ray on top of direct ray
  51434. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  51435. * Very helpful when moving between floors / different heights
  51436. */
  51437. parabolicRayEnabled: boolean;
  51438. /**
  51439. * How much rotation should be applied when rotating right and left
  51440. */
  51441. rotationAngle: number;
  51442. /**
  51443. * Is rotation enabled when moving forward?
  51444. * Disabling this feature will prevent the user from deciding the direction when teleporting
  51445. */
  51446. rotationEnabled: boolean;
  51447. /**
  51448. * constructs a new anchor system
  51449. * @param _xrSessionManager an instance of WebXRSessionManager
  51450. * @param _options configuration object for this feature
  51451. */
  51452. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  51453. /**
  51454. * Get the snapPointsOnly flag
  51455. */
  51456. get snapPointsOnly(): boolean;
  51457. /**
  51458. * Sets the snapPointsOnly flag
  51459. * @param snapToPoints should teleportation be exclusively to snap points
  51460. */
  51461. set snapPointsOnly(snapToPoints: boolean);
  51462. /**
  51463. * Add a new mesh to the floor meshes array
  51464. * @param mesh the mesh to use as floor mesh
  51465. */
  51466. addFloorMesh(mesh: AbstractMesh): void;
  51467. /**
  51468. * Add a new snap-to point to fix teleportation to this position
  51469. * @param newSnapPoint The new Snap-To point
  51470. */
  51471. addSnapPoint(newSnapPoint: Vector3): void;
  51472. attach(): boolean;
  51473. detach(): boolean;
  51474. dispose(): void;
  51475. /**
  51476. * Remove a mesh from the floor meshes array
  51477. * @param mesh the mesh to remove
  51478. */
  51479. removeFloorMesh(mesh: AbstractMesh): void;
  51480. /**
  51481. * Remove a mesh from the floor meshes array using its name
  51482. * @param name the mesh name to remove
  51483. */
  51484. removeFloorMeshByName(name: string): void;
  51485. /**
  51486. * 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
  51487. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  51488. * @returns was the point found and removed or not
  51489. */
  51490. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  51491. /**
  51492. * This function sets a selection feature that will be disabled when
  51493. * the forward ray is shown and will be reattached when hidden.
  51494. * This is used to remove the selection rays when moving.
  51495. * @param selectionFeature the feature to disable when forward movement is enabled
  51496. */
  51497. setSelectionFeature(selectionFeature: Nullable<IWebXRFeature>): void;
  51498. protected _onXRFrame(_xrFrame: XRFrame): void;
  51499. private _attachController;
  51500. private _createDefaultTargetMesh;
  51501. private _detachController;
  51502. private _findClosestSnapPointWithRadius;
  51503. private _setTargetMeshPosition;
  51504. private _setTargetMeshVisibility;
  51505. private _showParabolicPath;
  51506. private _teleportForward;
  51507. }
  51508. }
  51509. declare module "babylonjs/XR/webXRDefaultExperience" {
  51510. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  51511. import { Scene } from "babylonjs/scene";
  51512. import { WebXRInput, IWebXRInputOptions } from "babylonjs/XR/webXRInput";
  51513. import { WebXRControllerPointerSelection } from "babylonjs/XR/features/WebXRControllerPointerSelection";
  51514. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  51515. import { WebXREnterExitUI, WebXREnterExitUIOptions } from "babylonjs/XR/webXREnterExitUI";
  51516. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51517. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  51518. import { WebXRMotionControllerTeleportation } from "babylonjs/XR/features/WebXRControllerTeleportation";
  51519. /**
  51520. * Options for the default xr helper
  51521. */
  51522. export class WebXRDefaultExperienceOptions {
  51523. /**
  51524. * Enable or disable default UI to enter XR
  51525. */
  51526. disableDefaultUI?: boolean;
  51527. /**
  51528. * Should teleportation not initialize. defaults to false.
  51529. */
  51530. disableTeleportation?: boolean;
  51531. /**
  51532. * Floor meshes that will be used for teleport
  51533. */
  51534. floorMeshes?: Array<AbstractMesh>;
  51535. /**
  51536. * If set to true, the first frame will not be used to reset position
  51537. * The first frame is mainly used when copying transformation from the old camera
  51538. * Mainly used in AR
  51539. */
  51540. ignoreNativeCameraTransformation?: boolean;
  51541. /**
  51542. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  51543. */
  51544. inputOptions?: IWebXRInputOptions;
  51545. /**
  51546. * optional configuration for the output canvas
  51547. */
  51548. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  51549. /**
  51550. * optional UI options. This can be used among other to change session mode and reference space type
  51551. */
  51552. uiOptions?: WebXREnterExitUIOptions;
  51553. /**
  51554. * When loading teleportation and pointer select, use stable versions instead of latest.
  51555. */
  51556. useStablePlugins?: boolean;
  51557. /**
  51558. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  51559. */
  51560. renderingGroupId?: number;
  51561. /**
  51562. * A list of optional features to init the session with
  51563. * If set to true, all features we support will be added
  51564. */
  51565. optionalFeatures?: boolean | string[];
  51566. }
  51567. /**
  51568. * Default experience which provides a similar setup to the previous webVRExperience
  51569. */
  51570. export class WebXRDefaultExperience {
  51571. /**
  51572. * Base experience
  51573. */
  51574. baseExperience: WebXRExperienceHelper;
  51575. /**
  51576. * Enables ui for entering/exiting xr
  51577. */
  51578. enterExitUI: WebXREnterExitUI;
  51579. /**
  51580. * Input experience extension
  51581. */
  51582. input: WebXRInput;
  51583. /**
  51584. * Enables laser pointer and selection
  51585. */
  51586. pointerSelection: WebXRControllerPointerSelection;
  51587. /**
  51588. * Default target xr should render to
  51589. */
  51590. renderTarget: WebXRRenderTarget;
  51591. /**
  51592. * Enables teleportation
  51593. */
  51594. teleportation: WebXRMotionControllerTeleportation;
  51595. private constructor();
  51596. /**
  51597. * Creates the default xr experience
  51598. * @param scene scene
  51599. * @param options options for basic configuration
  51600. * @returns resulting WebXRDefaultExperience
  51601. */
  51602. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  51603. /**
  51604. * DIsposes of the experience helper
  51605. */
  51606. dispose(): void;
  51607. }
  51608. }
  51609. declare module "babylonjs/Cameras/VR/vrExperienceHelper" {
  51610. import { Observable } from "babylonjs/Misc/observable";
  51611. import { Nullable } from "babylonjs/types";
  51612. import { Camera } from "babylonjs/Cameras/camera";
  51613. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  51614. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51615. import { WebVROptions, WebVRFreeCamera } from "babylonjs/Cameras/VR/webVRCamera";
  51616. import { Scene } from "babylonjs/scene";
  51617. import { Vector3 } from "babylonjs/Maths/math.vector";
  51618. import { Color3 } from "babylonjs/Maths/math.color";
  51619. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  51620. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51621. import { Mesh } from "babylonjs/Meshes/mesh";
  51622. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  51623. import { EasingFunction } from "babylonjs/Animations/easing";
  51624. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  51625. import "babylonjs/Meshes/Builders/groundBuilder";
  51626. import "babylonjs/Meshes/Builders/torusBuilder";
  51627. import "babylonjs/Meshes/Builders/cylinderBuilder";
  51628. import "babylonjs/Gamepads/gamepadSceneComponent";
  51629. import "babylonjs/Animations/animatable";
  51630. import { WebXRDefaultExperience } from "babylonjs/XR/webXRDefaultExperience";
  51631. /**
  51632. * Options to modify the vr teleportation behavior.
  51633. */
  51634. export interface VRTeleportationOptions {
  51635. /**
  51636. * The name of the mesh which should be used as the teleportation floor. (default: null)
  51637. */
  51638. floorMeshName?: string;
  51639. /**
  51640. * A list of meshes to be used as the teleportation floor. (default: empty)
  51641. */
  51642. floorMeshes?: Mesh[];
  51643. /**
  51644. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  51645. */
  51646. teleportationMode?: number;
  51647. /**
  51648. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  51649. */
  51650. teleportationTime?: number;
  51651. /**
  51652. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  51653. */
  51654. teleportationSpeed?: number;
  51655. /**
  51656. * The easing function used in the animation or null for Linear. (default CircleEase)
  51657. */
  51658. easingFunction?: EasingFunction;
  51659. }
  51660. /**
  51661. * Options to modify the vr experience helper's behavior.
  51662. */
  51663. export interface VRExperienceHelperOptions extends WebVROptions {
  51664. /**
  51665. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  51666. */
  51667. createDeviceOrientationCamera?: boolean;
  51668. /**
  51669. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  51670. */
  51671. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  51672. /**
  51673. * Uses the main button on the controller to toggle the laser casted. (default: true)
  51674. */
  51675. laserToggle?: boolean;
  51676. /**
  51677. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  51678. */
  51679. floorMeshes?: Mesh[];
  51680. /**
  51681. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  51682. */
  51683. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  51684. /**
  51685. * Defines if WebXR should be used instead of WebVR (if available)
  51686. */
  51687. useXR?: boolean;
  51688. }
  51689. /**
  51690. * Event containing information after VR has been entered
  51691. */
  51692. export class OnAfterEnteringVRObservableEvent {
  51693. /**
  51694. * If entering vr was successful
  51695. */
  51696. success: boolean;
  51697. }
  51698. /**
  51699. * Helps to quickly add VR support to an existing scene.
  51700. * See https://doc.babylonjs.com/how_to/webvr_helper
  51701. */
  51702. export class VRExperienceHelper {
  51703. /** Options to modify the vr experience helper's behavior. */
  51704. webVROptions: VRExperienceHelperOptions;
  51705. private _scene;
  51706. private _position;
  51707. private _btnVR;
  51708. private _btnVRDisplayed;
  51709. private _webVRsupported;
  51710. private _webVRready;
  51711. private _webVRrequesting;
  51712. private _webVRpresenting;
  51713. private _hasEnteredVR;
  51714. private _fullscreenVRpresenting;
  51715. private _inputElement;
  51716. private _webVRCamera;
  51717. private _vrDeviceOrientationCamera;
  51718. private _deviceOrientationCamera;
  51719. private _existingCamera;
  51720. private _onKeyDown;
  51721. private _onVrDisplayPresentChange;
  51722. private _onVRDisplayChanged;
  51723. private _onVRRequestPresentStart;
  51724. private _onVRRequestPresentComplete;
  51725. /**
  51726. * 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)
  51727. */
  51728. enableGazeEvenWhenNoPointerLock: boolean;
  51729. /**
  51730. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  51731. */
  51732. exitVROnDoubleTap: boolean;
  51733. /**
  51734. * Observable raised right before entering VR.
  51735. */
  51736. onEnteringVRObservable: Observable<VRExperienceHelper>;
  51737. /**
  51738. * Observable raised when entering VR has completed.
  51739. */
  51740. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  51741. /**
  51742. * Observable raised when exiting VR.
  51743. */
  51744. onExitingVRObservable: Observable<VRExperienceHelper>;
  51745. /**
  51746. * Observable raised when controller mesh is loaded.
  51747. */
  51748. onControllerMeshLoadedObservable: Observable<WebVRController>;
  51749. /** Return this.onEnteringVRObservable
  51750. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  51751. */
  51752. get onEnteringVR(): Observable<VRExperienceHelper>;
  51753. /** Return this.onExitingVRObservable
  51754. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  51755. */
  51756. get onExitingVR(): Observable<VRExperienceHelper>;
  51757. /** Return this.onControllerMeshLoadedObservable
  51758. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  51759. */
  51760. get onControllerMeshLoaded(): Observable<WebVRController>;
  51761. private _rayLength;
  51762. private _useCustomVRButton;
  51763. private _teleportationRequested;
  51764. private _teleportActive;
  51765. private _floorMeshName;
  51766. private _floorMeshesCollection;
  51767. private _teleportationMode;
  51768. private _teleportationTime;
  51769. private _teleportationSpeed;
  51770. private _teleportationEasing;
  51771. private _rotationAllowed;
  51772. private _teleportBackwardsVector;
  51773. private _teleportationTarget;
  51774. private _isDefaultTeleportationTarget;
  51775. private _postProcessMove;
  51776. private _teleportationFillColor;
  51777. private _teleportationBorderColor;
  51778. private _rotationAngle;
  51779. private _haloCenter;
  51780. private _cameraGazer;
  51781. private _padSensibilityUp;
  51782. private _padSensibilityDown;
  51783. private _leftController;
  51784. private _rightController;
  51785. private _gazeColor;
  51786. private _laserColor;
  51787. private _pickedLaserColor;
  51788. private _pickedGazeColor;
  51789. /**
  51790. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  51791. */
  51792. onNewMeshSelected: Observable<AbstractMesh>;
  51793. /**
  51794. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  51795. * This observable will provide the mesh and the controller used to select the mesh
  51796. */
  51797. onMeshSelectedWithController: Observable<{
  51798. mesh: AbstractMesh;
  51799. controller: WebVRController;
  51800. }>;
  51801. /**
  51802. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  51803. */
  51804. onNewMeshPicked: Observable<PickingInfo>;
  51805. private _circleEase;
  51806. /**
  51807. * Observable raised before camera teleportation
  51808. */
  51809. onBeforeCameraTeleport: Observable<Vector3>;
  51810. /**
  51811. * Observable raised after camera teleportation
  51812. */
  51813. onAfterCameraTeleport: Observable<Vector3>;
  51814. /**
  51815. * Observable raised when current selected mesh gets unselected
  51816. */
  51817. onSelectedMeshUnselected: Observable<AbstractMesh>;
  51818. private _raySelectionPredicate;
  51819. /**
  51820. * To be optionaly changed by user to define custom ray selection
  51821. */
  51822. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  51823. /**
  51824. * To be optionaly changed by user to define custom selection logic (after ray selection)
  51825. */
  51826. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  51827. /**
  51828. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  51829. */
  51830. teleportationEnabled: boolean;
  51831. private _defaultHeight;
  51832. private _teleportationInitialized;
  51833. private _interactionsEnabled;
  51834. private _interactionsRequested;
  51835. private _displayGaze;
  51836. private _displayLaserPointer;
  51837. /**
  51838. * The mesh used to display where the user is going to teleport.
  51839. */
  51840. get teleportationTarget(): Mesh;
  51841. /**
  51842. * Sets the mesh to be used to display where the user is going to teleport.
  51843. */
  51844. set teleportationTarget(value: Mesh);
  51845. /**
  51846. * 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
  51847. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  51848. * See https://doc.babylonjs.com/resources/baking_transformations
  51849. */
  51850. get gazeTrackerMesh(): Mesh;
  51851. set gazeTrackerMesh(value: Mesh);
  51852. /**
  51853. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  51854. */
  51855. updateGazeTrackerScale: boolean;
  51856. /**
  51857. * If the gaze trackers color should be updated when selecting meshes
  51858. */
  51859. updateGazeTrackerColor: boolean;
  51860. /**
  51861. * If the controller laser color should be updated when selecting meshes
  51862. */
  51863. updateControllerLaserColor: boolean;
  51864. /**
  51865. * The gaze tracking mesh corresponding to the left controller
  51866. */
  51867. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  51868. /**
  51869. * The gaze tracking mesh corresponding to the right controller
  51870. */
  51871. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  51872. /**
  51873. * If the ray of the gaze should be displayed.
  51874. */
  51875. get displayGaze(): boolean;
  51876. /**
  51877. * Sets if the ray of the gaze should be displayed.
  51878. */
  51879. set displayGaze(value: boolean);
  51880. /**
  51881. * If the ray of the LaserPointer should be displayed.
  51882. */
  51883. get displayLaserPointer(): boolean;
  51884. /**
  51885. * Sets if the ray of the LaserPointer should be displayed.
  51886. */
  51887. set displayLaserPointer(value: boolean);
  51888. /**
  51889. * The deviceOrientationCamera used as the camera when not in VR.
  51890. */
  51891. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  51892. /**
  51893. * Based on the current WebVR support, returns the current VR camera used.
  51894. */
  51895. get currentVRCamera(): Nullable<Camera>;
  51896. /**
  51897. * The webVRCamera which is used when in VR.
  51898. */
  51899. get webVRCamera(): WebVRFreeCamera;
  51900. /**
  51901. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  51902. */
  51903. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  51904. /**
  51905. * The html button that is used to trigger entering into VR.
  51906. */
  51907. get vrButton(): Nullable<HTMLButtonElement>;
  51908. private get _teleportationRequestInitiated();
  51909. /**
  51910. * Defines whether or not Pointer lock should be requested when switching to
  51911. * full screen.
  51912. */
  51913. requestPointerLockOnFullScreen: boolean;
  51914. /**
  51915. * If asking to force XR, this will be populated with the default xr experience
  51916. */
  51917. xr: WebXRDefaultExperience;
  51918. /**
  51919. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  51920. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  51921. */
  51922. xrTestDone: boolean;
  51923. /**
  51924. * Instantiates a VRExperienceHelper.
  51925. * Helps to quickly add VR support to an existing scene.
  51926. * @param scene The scene the VRExperienceHelper belongs to.
  51927. * @param webVROptions Options to modify the vr experience helper's behavior.
  51928. */
  51929. constructor(scene: Scene,
  51930. /** Options to modify the vr experience helper's behavior. */
  51931. webVROptions?: VRExperienceHelperOptions);
  51932. private completeVRInit;
  51933. private _onDefaultMeshLoaded;
  51934. private _onResize;
  51935. private _onFullscreenChange;
  51936. /**
  51937. * Gets a value indicating if we are currently in VR mode.
  51938. */
  51939. get isInVRMode(): boolean;
  51940. private onVrDisplayPresentChange;
  51941. private onVRDisplayChanged;
  51942. private moveButtonToBottomRight;
  51943. private displayVRButton;
  51944. private updateButtonVisibility;
  51945. private _cachedAngularSensibility;
  51946. /**
  51947. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  51948. * Otherwise, will use the fullscreen API.
  51949. */
  51950. enterVR(): void;
  51951. /**
  51952. * Attempt to exit VR, or fullscreen.
  51953. */
  51954. exitVR(): void;
  51955. /**
  51956. * The position of the vr experience helper.
  51957. */
  51958. get position(): Vector3;
  51959. /**
  51960. * Sets the position of the vr experience helper.
  51961. */
  51962. set position(value: Vector3);
  51963. /**
  51964. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  51965. */
  51966. enableInteractions(): void;
  51967. private get _noControllerIsActive();
  51968. private beforeRender;
  51969. private _isTeleportationFloor;
  51970. /**
  51971. * Adds a floor mesh to be used for teleportation.
  51972. * @param floorMesh the mesh to be used for teleportation.
  51973. */
  51974. addFloorMesh(floorMesh: Mesh): void;
  51975. /**
  51976. * Removes a floor mesh from being used for teleportation.
  51977. * @param floorMesh the mesh to be removed.
  51978. */
  51979. removeFloorMesh(floorMesh: Mesh): void;
  51980. /**
  51981. * Enables interactions and teleportation using the VR controllers and gaze.
  51982. * @param vrTeleportationOptions options to modify teleportation behavior.
  51983. */
  51984. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  51985. private _onNewGamepadConnected;
  51986. private _tryEnableInteractionOnController;
  51987. private _onNewGamepadDisconnected;
  51988. private _enableInteractionOnController;
  51989. private _checkTeleportWithRay;
  51990. private _checkRotate;
  51991. private _checkTeleportBackwards;
  51992. private _enableTeleportationOnController;
  51993. private _createTeleportationCircles;
  51994. private _displayTeleportationTarget;
  51995. private _hideTeleportationTarget;
  51996. private _rotateCamera;
  51997. private _moveTeleportationSelectorTo;
  51998. private _workingVector;
  51999. private _workingQuaternion;
  52000. private _workingMatrix;
  52001. /**
  52002. * Time Constant Teleportation Mode
  52003. */
  52004. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  52005. /**
  52006. * Speed Constant Teleportation Mode
  52007. */
  52008. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  52009. /**
  52010. * Teleports the users feet to the desired location
  52011. * @param location The location where the user's feet should be placed
  52012. */
  52013. teleportCamera(location: Vector3): void;
  52014. private _convertNormalToDirectionOfRay;
  52015. private _castRayAndSelectObject;
  52016. private _notifySelectedMeshUnselected;
  52017. /**
  52018. * Permanently set new colors for the laser pointer
  52019. * @param color the new laser color
  52020. * @param pickedColor the new laser color when picked mesh detected
  52021. */
  52022. setLaserColor(color: Color3, pickedColor?: Color3): void;
  52023. /**
  52024. * Set lighting enabled / disabled on the laser pointer of both controllers
  52025. * @param enabled should the lighting be enabled on the laser pointer
  52026. */
  52027. setLaserLightingState(enabled?: boolean): void;
  52028. /**
  52029. * Permanently set new colors for the gaze pointer
  52030. * @param color the new gaze color
  52031. * @param pickedColor the new gaze color when picked mesh detected
  52032. */
  52033. setGazeColor(color: Color3, pickedColor?: Color3): void;
  52034. /**
  52035. * Sets the color of the laser ray from the vr controllers.
  52036. * @param color new color for the ray.
  52037. */
  52038. changeLaserColor(color: Color3): void;
  52039. /**
  52040. * Sets the color of the ray from the vr headsets gaze.
  52041. * @param color new color for the ray.
  52042. */
  52043. changeGazeColor(color: Color3): void;
  52044. /**
  52045. * Exits VR and disposes of the vr experience helper
  52046. */
  52047. dispose(): void;
  52048. /**
  52049. * Gets the name of the VRExperienceHelper class
  52050. * @returns "VRExperienceHelper"
  52051. */
  52052. getClassName(): string;
  52053. }
  52054. }
  52055. declare module "babylonjs/Cameras/VR/index" {
  52056. export * from "babylonjs/Cameras/VR/vrCameraMetrics";
  52057. export * from "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera";
  52058. export * from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  52059. export * from "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera";
  52060. export * from "babylonjs/Cameras/VR/vrExperienceHelper";
  52061. export * from "babylonjs/Cameras/VR/webVRCamera";
  52062. }
  52063. declare module "babylonjs/Cameras/RigModes/index" {
  52064. export * from "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  52065. export * from "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  52066. export * from "babylonjs/Cameras/RigModes/vrRigMode";
  52067. export * from "babylonjs/Cameras/RigModes/webVRRigMode";
  52068. }
  52069. declare module "babylonjs/Cameras/index" {
  52070. export * from "babylonjs/Cameras/Inputs/index";
  52071. export * from "babylonjs/Cameras/cameraInputsManager";
  52072. export * from "babylonjs/Cameras/camera";
  52073. export * from "babylonjs/Cameras/targetCamera";
  52074. export * from "babylonjs/Cameras/freeCamera";
  52075. export * from "babylonjs/Cameras/freeCameraInputsManager";
  52076. export * from "babylonjs/Cameras/touchCamera";
  52077. export * from "babylonjs/Cameras/arcRotateCamera";
  52078. export * from "babylonjs/Cameras/arcRotateCameraInputsManager";
  52079. export * from "babylonjs/Cameras/deviceOrientationCamera";
  52080. export * from "babylonjs/Cameras/flyCamera";
  52081. export * from "babylonjs/Cameras/flyCameraInputsManager";
  52082. export * from "babylonjs/Cameras/followCamera";
  52083. export * from "babylonjs/Cameras/followCameraInputsManager";
  52084. export * from "babylonjs/Cameras/gamepadCamera";
  52085. export * from "babylonjs/Cameras/Stereoscopic/index";
  52086. export * from "babylonjs/Cameras/universalCamera";
  52087. export * from "babylonjs/Cameras/virtualJoysticksCamera";
  52088. export * from "babylonjs/Cameras/VR/index";
  52089. export * from "babylonjs/Cameras/RigModes/index";
  52090. }
  52091. declare module "babylonjs/Collisions/index" {
  52092. export * from "babylonjs/Collisions/collider";
  52093. export * from "babylonjs/Collisions/collisionCoordinator";
  52094. export * from "babylonjs/Collisions/pickingInfo";
  52095. export * from "babylonjs/Collisions/intersectionInfo";
  52096. export * from "babylonjs/Collisions/meshCollisionData";
  52097. }
  52098. declare module "babylonjs/Culling/Octrees/octreeBlock" {
  52099. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  52100. import { Vector3 } from "babylonjs/Maths/math.vector";
  52101. import { Ray } from "babylonjs/Culling/ray";
  52102. import { Plane } from "babylonjs/Maths/math.plane";
  52103. /**
  52104. * Contains an array of blocks representing the octree
  52105. */
  52106. export interface IOctreeContainer<T> {
  52107. /**
  52108. * Blocks within the octree
  52109. */
  52110. blocks: Array<OctreeBlock<T>>;
  52111. }
  52112. /**
  52113. * Class used to store a cell in an octree
  52114. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52115. */
  52116. export class OctreeBlock<T> {
  52117. /**
  52118. * Gets the content of the current block
  52119. */
  52120. entries: T[];
  52121. /**
  52122. * Gets the list of block children
  52123. */
  52124. blocks: Array<OctreeBlock<T>>;
  52125. private _depth;
  52126. private _maxDepth;
  52127. private _capacity;
  52128. private _minPoint;
  52129. private _maxPoint;
  52130. private _boundingVectors;
  52131. private _creationFunc;
  52132. /**
  52133. * Creates a new block
  52134. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  52135. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  52136. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  52137. * @param depth defines the current depth of this block in the octree
  52138. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  52139. * @param creationFunc defines a callback to call when an element is added to the block
  52140. */
  52141. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  52142. /**
  52143. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  52144. */
  52145. get capacity(): number;
  52146. /**
  52147. * Gets the minimum vector (in world space) of the block's bounding box
  52148. */
  52149. get minPoint(): Vector3;
  52150. /**
  52151. * Gets the maximum vector (in world space) of the block's bounding box
  52152. */
  52153. get maxPoint(): Vector3;
  52154. /**
  52155. * Add a new element to this block
  52156. * @param entry defines the element to add
  52157. */
  52158. addEntry(entry: T): void;
  52159. /**
  52160. * Remove an element from this block
  52161. * @param entry defines the element to remove
  52162. */
  52163. removeEntry(entry: T): void;
  52164. /**
  52165. * Add an array of elements to this block
  52166. * @param entries defines the array of elements to add
  52167. */
  52168. addEntries(entries: T[]): void;
  52169. /**
  52170. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  52171. * @param frustumPlanes defines the frustum planes to test
  52172. * @param selection defines the array to store current content if selection is positive
  52173. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52174. */
  52175. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  52176. /**
  52177. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  52178. * @param sphereCenter defines the bounding sphere center
  52179. * @param sphereRadius defines the bounding sphere radius
  52180. * @param selection defines the array to store current content if selection is positive
  52181. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52182. */
  52183. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  52184. /**
  52185. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  52186. * @param ray defines the ray to test with
  52187. * @param selection defines the array to store current content if selection is positive
  52188. */
  52189. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  52190. /**
  52191. * Subdivide the content into child blocks (this block will then be empty)
  52192. */
  52193. createInnerBlocks(): void;
  52194. /**
  52195. * @hidden
  52196. */
  52197. 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;
  52198. }
  52199. }
  52200. declare module "babylonjs/Culling/Octrees/octree" {
  52201. import { SmartArray } from "babylonjs/Misc/smartArray";
  52202. import { Vector3 } from "babylonjs/Maths/math.vector";
  52203. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52204. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52205. import { Ray } from "babylonjs/Culling/ray";
  52206. import { OctreeBlock } from "babylonjs/Culling/Octrees/octreeBlock";
  52207. import { Plane } from "babylonjs/Maths/math.plane";
  52208. /**
  52209. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  52210. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52211. */
  52212. export class Octree<T> {
  52213. /** 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.) */
  52214. maxDepth: number;
  52215. /**
  52216. * Blocks within the octree containing objects
  52217. */
  52218. blocks: Array<OctreeBlock<T>>;
  52219. /**
  52220. * Content stored in the octree
  52221. */
  52222. dynamicContent: T[];
  52223. private _maxBlockCapacity;
  52224. private _selectionContent;
  52225. private _creationFunc;
  52226. /**
  52227. * Creates a octree
  52228. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52229. * @param creationFunc function to be used to instatiate the octree
  52230. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  52231. * @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.)
  52232. */
  52233. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  52234. /** 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.) */
  52235. maxDepth?: number);
  52236. /**
  52237. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  52238. * @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);
  52239. * @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);
  52240. * @param entries meshes to be added to the octree blocks
  52241. */
  52242. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  52243. /**
  52244. * Adds a mesh to the octree
  52245. * @param entry Mesh to add to the octree
  52246. */
  52247. addMesh(entry: T): void;
  52248. /**
  52249. * Remove an element from the octree
  52250. * @param entry defines the element to remove
  52251. */
  52252. removeMesh(entry: T): void;
  52253. /**
  52254. * Selects an array of meshes within the frustum
  52255. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  52256. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  52257. * @returns array of meshes within the frustum
  52258. */
  52259. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  52260. /**
  52261. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  52262. * @param sphereCenter defines the bounding sphere center
  52263. * @param sphereRadius defines the bounding sphere radius
  52264. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52265. * @returns an array of objects that intersect the sphere
  52266. */
  52267. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  52268. /**
  52269. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  52270. * @param ray defines the ray to test with
  52271. * @returns array of intersected objects
  52272. */
  52273. intersectsRay(ray: Ray): SmartArray<T>;
  52274. /**
  52275. * Adds a mesh into the octree block if it intersects the block
  52276. */
  52277. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  52278. /**
  52279. * Adds a submesh into the octree block if it intersects the block
  52280. */
  52281. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  52282. }
  52283. }
  52284. declare module "babylonjs/Culling/Octrees/octreeSceneComponent" {
  52285. import { ISmartArrayLike } from "babylonjs/Misc/smartArray";
  52286. import { Scene } from "babylonjs/scene";
  52287. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52288. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52289. import { Ray } from "babylonjs/Culling/ray";
  52290. import { Octree } from "babylonjs/Culling/Octrees/octree";
  52291. import { Collider } from "babylonjs/Collisions/collider";
  52292. module "babylonjs/scene" {
  52293. interface Scene {
  52294. /**
  52295. * @hidden
  52296. * Backing Filed
  52297. */
  52298. _selectionOctree: Octree<AbstractMesh>;
  52299. /**
  52300. * Gets the octree used to boost mesh selection (picking)
  52301. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52302. */
  52303. selectionOctree: Octree<AbstractMesh>;
  52304. /**
  52305. * Creates or updates the octree used to boost selection (picking)
  52306. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52307. * @param maxCapacity defines the maximum capacity per leaf
  52308. * @param maxDepth defines the maximum depth of the octree
  52309. * @returns an octree of AbstractMesh
  52310. */
  52311. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  52312. }
  52313. }
  52314. module "babylonjs/Meshes/abstractMesh" {
  52315. interface AbstractMesh {
  52316. /**
  52317. * @hidden
  52318. * Backing Field
  52319. */
  52320. _submeshesOctree: Octree<SubMesh>;
  52321. /**
  52322. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  52323. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  52324. * @param maxCapacity defines the maximum size of each block (64 by default)
  52325. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  52326. * @returns the new octree
  52327. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  52328. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52329. */
  52330. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  52331. }
  52332. }
  52333. /**
  52334. * Defines the octree scene component responsible to manage any octrees
  52335. * in a given scene.
  52336. */
  52337. export class OctreeSceneComponent {
  52338. /**
  52339. * The component name help to identify the component in the list of scene components.
  52340. */
  52341. readonly name: string;
  52342. /**
  52343. * The scene the component belongs to.
  52344. */
  52345. scene: Scene;
  52346. /**
  52347. * Indicates if the meshes have been checked to make sure they are isEnabled()
  52348. */
  52349. readonly checksIsEnabled: boolean;
  52350. /**
  52351. * Creates a new instance of the component for the given scene
  52352. * @param scene Defines the scene to register the component in
  52353. */
  52354. constructor(scene: Scene);
  52355. /**
  52356. * Registers the component in a given scene
  52357. */
  52358. register(): void;
  52359. /**
  52360. * Return the list of active meshes
  52361. * @returns the list of active meshes
  52362. */
  52363. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  52364. /**
  52365. * Return the list of active sub meshes
  52366. * @param mesh The mesh to get the candidates sub meshes from
  52367. * @returns the list of active sub meshes
  52368. */
  52369. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  52370. private _tempRay;
  52371. /**
  52372. * Return the list of sub meshes intersecting with a given local ray
  52373. * @param mesh defines the mesh to find the submesh for
  52374. * @param localRay defines the ray in local space
  52375. * @returns the list of intersecting sub meshes
  52376. */
  52377. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  52378. /**
  52379. * Return the list of sub meshes colliding with a collider
  52380. * @param mesh defines the mesh to find the submesh for
  52381. * @param collider defines the collider to evaluate the collision against
  52382. * @returns the list of colliding sub meshes
  52383. */
  52384. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  52385. /**
  52386. * Rebuilds the elements related to this component in case of
  52387. * context lost for instance.
  52388. */
  52389. rebuild(): void;
  52390. /**
  52391. * Disposes the component and the associated ressources.
  52392. */
  52393. dispose(): void;
  52394. }
  52395. }
  52396. declare module "babylonjs/Culling/Octrees/index" {
  52397. export * from "babylonjs/Culling/Octrees/octree";
  52398. export * from "babylonjs/Culling/Octrees/octreeBlock";
  52399. export * from "babylonjs/Culling/Octrees/octreeSceneComponent";
  52400. }
  52401. declare module "babylonjs/Culling/index" {
  52402. export * from "babylonjs/Culling/boundingBox";
  52403. export * from "babylonjs/Culling/boundingInfo";
  52404. export * from "babylonjs/Culling/boundingSphere";
  52405. export * from "babylonjs/Culling/Octrees/index";
  52406. export * from "babylonjs/Culling/ray";
  52407. }
  52408. declare module "babylonjs/Gizmos/gizmo" {
  52409. import { Nullable } from "babylonjs/types";
  52410. import { IDisposable } from "babylonjs/scene";
  52411. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52412. import { Mesh } from "babylonjs/Meshes/mesh";
  52413. import { Node } from "babylonjs/node";
  52414. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52415. /**
  52416. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  52417. */
  52418. export class Gizmo implements IDisposable {
  52419. /** The utility layer the gizmo will be added to */
  52420. gizmoLayer: UtilityLayerRenderer;
  52421. /**
  52422. * The root mesh of the gizmo
  52423. */
  52424. _rootMesh: Mesh;
  52425. private _attachedMesh;
  52426. private _attachedNode;
  52427. /**
  52428. * Ratio for the scale of the gizmo (Default: 1)
  52429. */
  52430. protected _scaleRatio: number;
  52431. /**
  52432. * boolean updated by pointermove when a gizmo mesh is hovered
  52433. */
  52434. protected _isHovered: boolean;
  52435. /**
  52436. * Ratio for the scale of the gizmo (Default: 1)
  52437. */
  52438. set scaleRatio(value: number);
  52439. get scaleRatio(): number;
  52440. /**
  52441. * True when the mouse pointer is hovered a gizmo mesh
  52442. */
  52443. get isHovered(): boolean;
  52444. /**
  52445. * If a custom mesh has been set (Default: false)
  52446. */
  52447. protected _customMeshSet: boolean;
  52448. /**
  52449. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  52450. * * When set, interactions will be enabled
  52451. */
  52452. get attachedMesh(): Nullable<AbstractMesh>;
  52453. set attachedMesh(value: Nullable<AbstractMesh>);
  52454. /**
  52455. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  52456. * * When set, interactions will be enabled
  52457. */
  52458. get attachedNode(): Nullable<Node>;
  52459. set attachedNode(value: Nullable<Node>);
  52460. /**
  52461. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  52462. * @param mesh The mesh to replace the default mesh of the gizmo
  52463. */
  52464. setCustomMesh(mesh: Mesh): void;
  52465. protected _updateGizmoRotationToMatchAttachedMesh: boolean;
  52466. /**
  52467. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  52468. */
  52469. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  52470. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  52471. /**
  52472. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  52473. */
  52474. updateGizmoPositionToMatchAttachedMesh: boolean;
  52475. /**
  52476. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  52477. */
  52478. updateScale: boolean;
  52479. protected _interactionsEnabled: boolean;
  52480. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52481. private _beforeRenderObserver;
  52482. private _tempQuaternion;
  52483. private _tempVector;
  52484. private _tempVector2;
  52485. private _tempMatrix1;
  52486. private _tempMatrix2;
  52487. private _rightHandtoLeftHandMatrix;
  52488. /**
  52489. * Creates a gizmo
  52490. * @param gizmoLayer The utility layer the gizmo will be added to
  52491. */
  52492. constructor(
  52493. /** The utility layer the gizmo will be added to */
  52494. gizmoLayer?: UtilityLayerRenderer);
  52495. /**
  52496. * Updates the gizmo to match the attached mesh's position/rotation
  52497. */
  52498. protected _update(): void;
  52499. /**
  52500. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  52501. * @param value Node, TransformNode or mesh
  52502. */
  52503. protected _matrixChanged(): void;
  52504. /**
  52505. * Disposes of the gizmo
  52506. */
  52507. dispose(): void;
  52508. }
  52509. }
  52510. declare module "babylonjs/Gizmos/planeDragGizmo" {
  52511. import { Observable } from "babylonjs/Misc/observable";
  52512. import { Nullable } from "babylonjs/types";
  52513. import { Vector3 } from "babylonjs/Maths/math.vector";
  52514. import { Color3 } from "babylonjs/Maths/math.color";
  52515. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52516. import { Node } from "babylonjs/node";
  52517. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52518. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52519. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52520. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52521. import { Scene } from "babylonjs/scene";
  52522. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52523. /**
  52524. * Single plane drag gizmo
  52525. */
  52526. export class PlaneDragGizmo extends Gizmo {
  52527. /**
  52528. * Drag behavior responsible for the gizmos dragging interactions
  52529. */
  52530. dragBehavior: PointerDragBehavior;
  52531. private _pointerObserver;
  52532. /**
  52533. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52534. */
  52535. snapDistance: number;
  52536. /**
  52537. * Event that fires each time the gizmo snaps to a new location.
  52538. * * snapDistance is the the change in distance
  52539. */
  52540. onSnapObservable: Observable<{
  52541. snapDistance: number;
  52542. }>;
  52543. private _plane;
  52544. private _coloredMaterial;
  52545. private _hoverMaterial;
  52546. private _isEnabled;
  52547. private _parent;
  52548. /** @hidden */
  52549. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  52550. /** @hidden */
  52551. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52552. /**
  52553. * Creates a PlaneDragGizmo
  52554. * @param gizmoLayer The utility layer the gizmo will be added to
  52555. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  52556. * @param color The color of the gizmo
  52557. */
  52558. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  52559. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52560. /**
  52561. * If the gizmo is enabled
  52562. */
  52563. set isEnabled(value: boolean);
  52564. get isEnabled(): boolean;
  52565. /**
  52566. * Disposes of the gizmo
  52567. */
  52568. dispose(): void;
  52569. }
  52570. }
  52571. declare module "babylonjs/Gizmos/positionGizmo" {
  52572. import { Observable } from "babylonjs/Misc/observable";
  52573. import { Nullable } from "babylonjs/types";
  52574. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52575. import { Node } from "babylonjs/node";
  52576. import { Mesh } from "babylonjs/Meshes/mesh";
  52577. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52578. import { AxisDragGizmo } from "babylonjs/Gizmos/axisDragGizmo";
  52579. import { PlaneDragGizmo } from "babylonjs/Gizmos/planeDragGizmo";
  52580. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52581. /**
  52582. * Gizmo that enables dragging a mesh along 3 axis
  52583. */
  52584. export class PositionGizmo extends Gizmo {
  52585. /**
  52586. * Internal gizmo used for interactions on the x axis
  52587. */
  52588. xGizmo: AxisDragGizmo;
  52589. /**
  52590. * Internal gizmo used for interactions on the y axis
  52591. */
  52592. yGizmo: AxisDragGizmo;
  52593. /**
  52594. * Internal gizmo used for interactions on the z axis
  52595. */
  52596. zGizmo: AxisDragGizmo;
  52597. /**
  52598. * Internal gizmo used for interactions on the yz plane
  52599. */
  52600. xPlaneGizmo: PlaneDragGizmo;
  52601. /**
  52602. * Internal gizmo used for interactions on the xz plane
  52603. */
  52604. yPlaneGizmo: PlaneDragGizmo;
  52605. /**
  52606. * Internal gizmo used for interactions on the xy plane
  52607. */
  52608. zPlaneGizmo: PlaneDragGizmo;
  52609. /**
  52610. * private variables
  52611. */
  52612. private _meshAttached;
  52613. private _nodeAttached;
  52614. private _snapDistance;
  52615. /** Fires an event when any of it's sub gizmos are dragged */
  52616. onDragStartObservable: Observable<unknown>;
  52617. /** Fires an event when any of it's sub gizmos are released from dragging */
  52618. onDragEndObservable: Observable<unknown>;
  52619. /**
  52620. * If set to true, planar drag is enabled
  52621. */
  52622. private _planarGizmoEnabled;
  52623. get attachedMesh(): Nullable<AbstractMesh>;
  52624. set attachedMesh(mesh: Nullable<AbstractMesh>);
  52625. get attachedNode(): Nullable<Node>;
  52626. set attachedNode(node: Nullable<Node>);
  52627. /**
  52628. * True when the mouse pointer is hovering a gizmo mesh
  52629. */
  52630. get isHovered(): boolean;
  52631. /**
  52632. * Creates a PositionGizmo
  52633. * @param gizmoLayer The utility layer the gizmo will be added to
  52634. @param thickness display gizmo axis thickness
  52635. */
  52636. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  52637. /**
  52638. * If the planar drag gizmo is enabled
  52639. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  52640. */
  52641. set planarGizmoEnabled(value: boolean);
  52642. get planarGizmoEnabled(): boolean;
  52643. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  52644. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  52645. /**
  52646. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52647. */
  52648. set snapDistance(value: number);
  52649. get snapDistance(): number;
  52650. /**
  52651. * Ratio for the scale of the gizmo (Default: 1)
  52652. */
  52653. set scaleRatio(value: number);
  52654. get scaleRatio(): number;
  52655. /**
  52656. * Disposes of the gizmo
  52657. */
  52658. dispose(): void;
  52659. /**
  52660. * CustomMeshes are not supported by this gizmo
  52661. * @param mesh The mesh to replace the default mesh of the gizmo
  52662. */
  52663. setCustomMesh(mesh: Mesh): void;
  52664. }
  52665. }
  52666. declare module "babylonjs/Gizmos/axisDragGizmo" {
  52667. import { Observable } from "babylonjs/Misc/observable";
  52668. import { Nullable } from "babylonjs/types";
  52669. import { Vector3 } from "babylonjs/Maths/math.vector";
  52670. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52671. import { Node } from "babylonjs/node";
  52672. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52673. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52674. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52675. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52676. import { Scene } from "babylonjs/scene";
  52677. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52678. import { Color3 } from "babylonjs/Maths/math.color";
  52679. /**
  52680. * Single axis drag gizmo
  52681. */
  52682. export class AxisDragGizmo extends Gizmo {
  52683. /**
  52684. * Drag behavior responsible for the gizmos dragging interactions
  52685. */
  52686. dragBehavior: PointerDragBehavior;
  52687. private _pointerObserver;
  52688. /**
  52689. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52690. */
  52691. snapDistance: number;
  52692. /**
  52693. * Event that fires each time the gizmo snaps to a new location.
  52694. * * snapDistance is the the change in distance
  52695. */
  52696. onSnapObservable: Observable<{
  52697. snapDistance: number;
  52698. }>;
  52699. private _isEnabled;
  52700. private _parent;
  52701. private _arrow;
  52702. private _coloredMaterial;
  52703. private _hoverMaterial;
  52704. /** @hidden */
  52705. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  52706. /** @hidden */
  52707. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52708. /**
  52709. * Creates an AxisDragGizmo
  52710. * @param gizmoLayer The utility layer the gizmo will be added to
  52711. * @param dragAxis The axis which the gizmo will be able to drag on
  52712. * @param color The color of the gizmo
  52713. * @param thickness display gizmo axis thickness
  52714. */
  52715. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  52716. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52717. /**
  52718. * If the gizmo is enabled
  52719. */
  52720. set isEnabled(value: boolean);
  52721. get isEnabled(): boolean;
  52722. /**
  52723. * Disposes of the gizmo
  52724. */
  52725. dispose(): void;
  52726. }
  52727. }
  52728. declare module "babylonjs/Debug/axesViewer" {
  52729. import { Vector3 } from "babylonjs/Maths/math.vector";
  52730. import { Nullable } from "babylonjs/types";
  52731. import { Scene } from "babylonjs/scene";
  52732. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52733. /**
  52734. * The Axes viewer will show 3 axes in a specific point in space
  52735. */
  52736. export class AxesViewer {
  52737. private _xAxis;
  52738. private _yAxis;
  52739. private _zAxis;
  52740. private _scaleLinesFactor;
  52741. private _instanced;
  52742. /**
  52743. * Gets the hosting scene
  52744. */
  52745. scene: Nullable<Scene>;
  52746. /**
  52747. * Gets or sets a number used to scale line length
  52748. */
  52749. scaleLines: number;
  52750. /** Gets the node hierarchy used to render x-axis */
  52751. get xAxis(): TransformNode;
  52752. /** Gets the node hierarchy used to render y-axis */
  52753. get yAxis(): TransformNode;
  52754. /** Gets the node hierarchy used to render z-axis */
  52755. get zAxis(): TransformNode;
  52756. /**
  52757. * Creates a new AxesViewer
  52758. * @param scene defines the hosting scene
  52759. * @param scaleLines defines a number used to scale line length (1 by default)
  52760. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  52761. * @param xAxis defines the node hierarchy used to render the x-axis
  52762. * @param yAxis defines the node hierarchy used to render the y-axis
  52763. * @param zAxis defines the node hierarchy used to render the z-axis
  52764. */
  52765. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  52766. /**
  52767. * Force the viewer to update
  52768. * @param position defines the position of the viewer
  52769. * @param xaxis defines the x axis of the viewer
  52770. * @param yaxis defines the y axis of the viewer
  52771. * @param zaxis defines the z axis of the viewer
  52772. */
  52773. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  52774. /**
  52775. * Creates an instance of this axes viewer.
  52776. * @returns a new axes viewer with instanced meshes
  52777. */
  52778. createInstance(): AxesViewer;
  52779. /** Releases resources */
  52780. dispose(): void;
  52781. private static _SetRenderingGroupId;
  52782. }
  52783. }
  52784. declare module "babylonjs/Debug/boneAxesViewer" {
  52785. import { Nullable } from "babylonjs/types";
  52786. import { AxesViewer } from "babylonjs/Debug/axesViewer";
  52787. import { Vector3 } from "babylonjs/Maths/math.vector";
  52788. import { Mesh } from "babylonjs/Meshes/mesh";
  52789. import { Bone } from "babylonjs/Bones/bone";
  52790. import { Scene } from "babylonjs/scene";
  52791. /**
  52792. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  52793. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  52794. */
  52795. export class BoneAxesViewer extends AxesViewer {
  52796. /**
  52797. * Gets or sets the target mesh where to display the axes viewer
  52798. */
  52799. mesh: Nullable<Mesh>;
  52800. /**
  52801. * Gets or sets the target bone where to display the axes viewer
  52802. */
  52803. bone: Nullable<Bone>;
  52804. /** Gets current position */
  52805. pos: Vector3;
  52806. /** Gets direction of X axis */
  52807. xaxis: Vector3;
  52808. /** Gets direction of Y axis */
  52809. yaxis: Vector3;
  52810. /** Gets direction of Z axis */
  52811. zaxis: Vector3;
  52812. /**
  52813. * Creates a new BoneAxesViewer
  52814. * @param scene defines the hosting scene
  52815. * @param bone defines the target bone
  52816. * @param mesh defines the target mesh
  52817. * @param scaleLines defines a scaling factor for line length (1 by default)
  52818. */
  52819. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  52820. /**
  52821. * Force the viewer to update
  52822. */
  52823. update(): void;
  52824. /** Releases resources */
  52825. dispose(): void;
  52826. }
  52827. }
  52828. declare module "babylonjs/Debug/debugLayer" {
  52829. import { Scene } from "babylonjs/scene";
  52830. /**
  52831. * Interface used to define scene explorer extensibility option
  52832. */
  52833. export interface IExplorerExtensibilityOption {
  52834. /**
  52835. * Define the option label
  52836. */
  52837. label: string;
  52838. /**
  52839. * Defines the action to execute on click
  52840. */
  52841. action: (entity: any) => void;
  52842. }
  52843. /**
  52844. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  52845. */
  52846. export interface IExplorerExtensibilityGroup {
  52847. /**
  52848. * Defines a predicate to test if a given type mut be extended
  52849. */
  52850. predicate: (entity: any) => boolean;
  52851. /**
  52852. * Gets the list of options added to a type
  52853. */
  52854. entries: IExplorerExtensibilityOption[];
  52855. }
  52856. /**
  52857. * Interface used to define the options to use to create the Inspector
  52858. */
  52859. export interface IInspectorOptions {
  52860. /**
  52861. * Display in overlay mode (default: false)
  52862. */
  52863. overlay?: boolean;
  52864. /**
  52865. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  52866. */
  52867. globalRoot?: HTMLElement;
  52868. /**
  52869. * Display the Scene explorer
  52870. */
  52871. showExplorer?: boolean;
  52872. /**
  52873. * Display the property inspector
  52874. */
  52875. showInspector?: boolean;
  52876. /**
  52877. * Display in embed mode (both panes on the right)
  52878. */
  52879. embedMode?: boolean;
  52880. /**
  52881. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  52882. */
  52883. handleResize?: boolean;
  52884. /**
  52885. * Allow the panes to popup (default: true)
  52886. */
  52887. enablePopup?: boolean;
  52888. /**
  52889. * Allow the panes to be closed by users (default: true)
  52890. */
  52891. enableClose?: boolean;
  52892. /**
  52893. * Optional list of extensibility entries
  52894. */
  52895. explorerExtensibility?: IExplorerExtensibilityGroup[];
  52896. /**
  52897. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  52898. */
  52899. inspectorURL?: string;
  52900. /**
  52901. * Optional initial tab (default to DebugLayerTab.Properties)
  52902. */
  52903. initialTab?: DebugLayerTab;
  52904. }
  52905. module "babylonjs/scene" {
  52906. interface Scene {
  52907. /**
  52908. * @hidden
  52909. * Backing field
  52910. */
  52911. _debugLayer: DebugLayer;
  52912. /**
  52913. * Gets the debug layer (aka Inspector) associated with the scene
  52914. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52915. */
  52916. debugLayer: DebugLayer;
  52917. }
  52918. }
  52919. /**
  52920. * Enum of inspector action tab
  52921. */
  52922. export enum DebugLayerTab {
  52923. /**
  52924. * Properties tag (default)
  52925. */
  52926. Properties = 0,
  52927. /**
  52928. * Debug tab
  52929. */
  52930. Debug = 1,
  52931. /**
  52932. * Statistics tab
  52933. */
  52934. Statistics = 2,
  52935. /**
  52936. * Tools tab
  52937. */
  52938. Tools = 3,
  52939. /**
  52940. * Settings tab
  52941. */
  52942. Settings = 4
  52943. }
  52944. /**
  52945. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52946. * what is happening in your scene
  52947. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52948. */
  52949. export class DebugLayer {
  52950. /**
  52951. * Define the url to get the inspector script from.
  52952. * By default it uses the babylonjs CDN.
  52953. * @ignoreNaming
  52954. */
  52955. static InspectorURL: string;
  52956. private _scene;
  52957. private BJSINSPECTOR;
  52958. private _onPropertyChangedObservable?;
  52959. /**
  52960. * Observable triggered when a property is changed through the inspector.
  52961. */
  52962. get onPropertyChangedObservable(): any;
  52963. /**
  52964. * Instantiates a new debug layer.
  52965. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52966. * what is happening in your scene
  52967. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52968. * @param scene Defines the scene to inspect
  52969. */
  52970. constructor(scene: Scene);
  52971. /** Creates the inspector window. */
  52972. private _createInspector;
  52973. /**
  52974. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  52975. * @param entity defines the entity to select
  52976. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  52977. */
  52978. select(entity: any, lineContainerTitles?: string | string[]): void;
  52979. /** Get the inspector from bundle or global */
  52980. private _getGlobalInspector;
  52981. /**
  52982. * Get if the inspector is visible or not.
  52983. * @returns true if visible otherwise, false
  52984. */
  52985. isVisible(): boolean;
  52986. /**
  52987. * Hide the inspector and close its window.
  52988. */
  52989. hide(): void;
  52990. /**
  52991. * Update the scene in the inspector
  52992. */
  52993. setAsActiveScene(): void;
  52994. /**
  52995. * Launch the debugLayer.
  52996. * @param config Define the configuration of the inspector
  52997. * @return a promise fulfilled when the debug layer is visible
  52998. */
  52999. show(config?: IInspectorOptions): Promise<DebugLayer>;
  53000. }
  53001. }
  53002. declare module "babylonjs/Meshes/Builders/boxBuilder" {
  53003. import { Nullable } from "babylonjs/types";
  53004. import { Scene } from "babylonjs/scene";
  53005. import { Vector4 } from "babylonjs/Maths/math.vector";
  53006. import { Color4 } from "babylonjs/Maths/math.color";
  53007. import { Mesh } from "babylonjs/Meshes/mesh";
  53008. /**
  53009. * Class containing static functions to help procedurally build meshes
  53010. */
  53011. export class BoxBuilder {
  53012. /**
  53013. * Creates a box mesh
  53014. * * The parameter `size` sets the size (float) of each box side (default 1)
  53015. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  53016. * * 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)
  53017. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  53018. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53019. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53020. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53021. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  53022. * @param name defines the name of the mesh
  53023. * @param options defines the options used to create the mesh
  53024. * @param scene defines the hosting scene
  53025. * @returns the box mesh
  53026. */
  53027. static CreateBox(name: string, options: {
  53028. size?: number;
  53029. width?: number;
  53030. height?: number;
  53031. depth?: number;
  53032. faceUV?: Vector4[];
  53033. faceColors?: Color4[];
  53034. sideOrientation?: number;
  53035. frontUVs?: Vector4;
  53036. backUVs?: Vector4;
  53037. wrap?: boolean;
  53038. topBaseAt?: number;
  53039. bottomBaseAt?: number;
  53040. updatable?: boolean;
  53041. }, scene?: Nullable<Scene>): Mesh;
  53042. }
  53043. }
  53044. declare module "babylonjs/Debug/physicsViewer" {
  53045. import { Nullable } from "babylonjs/types";
  53046. import { Scene } from "babylonjs/scene";
  53047. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53048. import { Mesh } from "babylonjs/Meshes/mesh";
  53049. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  53050. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  53051. /**
  53052. * Used to show the physics impostor around the specific mesh
  53053. */
  53054. export class PhysicsViewer {
  53055. /** @hidden */
  53056. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  53057. /** @hidden */
  53058. protected _meshes: Array<Nullable<AbstractMesh>>;
  53059. /** @hidden */
  53060. protected _scene: Nullable<Scene>;
  53061. /** @hidden */
  53062. protected _numMeshes: number;
  53063. /** @hidden */
  53064. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  53065. private _renderFunction;
  53066. private _utilityLayer;
  53067. private _debugBoxMesh;
  53068. private _debugSphereMesh;
  53069. private _debugCylinderMesh;
  53070. private _debugMaterial;
  53071. private _debugMeshMeshes;
  53072. /**
  53073. * Creates a new PhysicsViewer
  53074. * @param scene defines the hosting scene
  53075. */
  53076. constructor(scene: Scene);
  53077. /** @hidden */
  53078. protected _updateDebugMeshes(): void;
  53079. /**
  53080. * Renders a specified physic impostor
  53081. * @param impostor defines the impostor to render
  53082. * @param targetMesh defines the mesh represented by the impostor
  53083. * @returns the new debug mesh used to render the impostor
  53084. */
  53085. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  53086. /**
  53087. * Hides a specified physic impostor
  53088. * @param impostor defines the impostor to hide
  53089. */
  53090. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  53091. private _getDebugMaterial;
  53092. private _getDebugBoxMesh;
  53093. private _getDebugSphereMesh;
  53094. private _getDebugCylinderMesh;
  53095. private _getDebugMeshMesh;
  53096. private _getDebugMesh;
  53097. /** Releases all resources */
  53098. dispose(): void;
  53099. }
  53100. }
  53101. declare module "babylonjs/Debug/rayHelper" {
  53102. import { Nullable } from "babylonjs/types";
  53103. import { Ray } from "babylonjs/Culling/ray";
  53104. import { Vector3 } from "babylonjs/Maths/math.vector";
  53105. import { Color3 } from "babylonjs/Maths/math.color";
  53106. import { Scene } from "babylonjs/scene";
  53107. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53108. import "babylonjs/Meshes/Builders/linesBuilder";
  53109. /**
  53110. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  53111. * in order to better appreciate the issue one might have.
  53112. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  53113. */
  53114. export class RayHelper {
  53115. /**
  53116. * Defines the ray we are currently tryin to visualize.
  53117. */
  53118. ray: Nullable<Ray>;
  53119. private _renderPoints;
  53120. private _renderLine;
  53121. private _renderFunction;
  53122. private _scene;
  53123. private _onAfterRenderObserver;
  53124. private _onAfterStepObserver;
  53125. private _attachedToMesh;
  53126. private _meshSpaceDirection;
  53127. private _meshSpaceOrigin;
  53128. /**
  53129. * Helper function to create a colored helper in a scene in one line.
  53130. * @param ray Defines the ray we are currently tryin to visualize
  53131. * @param scene Defines the scene the ray is used in
  53132. * @param color Defines the color we want to see the ray in
  53133. * @returns The newly created ray helper.
  53134. */
  53135. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  53136. /**
  53137. * Instantiate a new ray helper.
  53138. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  53139. * in order to better appreciate the issue one might have.
  53140. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  53141. * @param ray Defines the ray we are currently tryin to visualize
  53142. */
  53143. constructor(ray: Ray);
  53144. /**
  53145. * Shows the ray we are willing to debug.
  53146. * @param scene Defines the scene the ray needs to be rendered in
  53147. * @param color Defines the color the ray needs to be rendered in
  53148. */
  53149. show(scene: Scene, color?: Color3): void;
  53150. /**
  53151. * Hides the ray we are debugging.
  53152. */
  53153. hide(): void;
  53154. private _render;
  53155. /**
  53156. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  53157. * @param mesh Defines the mesh we want the helper attached to
  53158. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  53159. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  53160. * @param length Defines the length of the ray
  53161. */
  53162. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  53163. /**
  53164. * Detach the ray helper from the mesh it has previously been attached to.
  53165. */
  53166. detachFromMesh(): void;
  53167. private _updateToMesh;
  53168. /**
  53169. * Dispose the helper and release its associated resources.
  53170. */
  53171. dispose(): void;
  53172. }
  53173. }
  53174. declare module "babylonjs/Debug/ISkeletonViewer" {
  53175. import { Skeleton } from "babylonjs/Bones/skeleton";
  53176. import { Color3 } from "babylonjs/Maths/math.color";
  53177. /**
  53178. * Defines the options associated with the creation of a SkeletonViewer.
  53179. */
  53180. export interface ISkeletonViewerOptions {
  53181. /** Should the system pause animations before building the Viewer? */
  53182. pauseAnimations: boolean;
  53183. /** Should the system return the skeleton to rest before building? */
  53184. returnToRest: boolean;
  53185. /** public Display Mode of the Viewer */
  53186. displayMode: number;
  53187. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  53188. displayOptions: ISkeletonViewerDisplayOptions;
  53189. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  53190. computeBonesUsingShaders: boolean;
  53191. /** Flag ignore non weighted bones */
  53192. useAllBones: boolean;
  53193. }
  53194. /**
  53195. * Defines how to display the various bone meshes for the viewer.
  53196. */
  53197. export interface ISkeletonViewerDisplayOptions {
  53198. /** How far down to start tapering the bone spurs */
  53199. midStep?: number;
  53200. /** How big is the midStep? */
  53201. midStepFactor?: number;
  53202. /** Base for the Sphere Size */
  53203. sphereBaseSize?: number;
  53204. /** The ratio of the sphere to the longest bone in units */
  53205. sphereScaleUnit?: number;
  53206. /** Ratio for the Sphere Size */
  53207. sphereFactor?: number;
  53208. /** Whether to show local axes or not */
  53209. showLocalAxes?: boolean;
  53210. /** Length of each local axis */
  53211. localAxesSize?: number;
  53212. }
  53213. /**
  53214. * Defines the constructor options for the BoneWeight Shader.
  53215. */
  53216. export interface IBoneWeightShaderOptions {
  53217. /** Skeleton to Map */
  53218. skeleton: Skeleton;
  53219. /** Colors for Uninfluenced bones */
  53220. colorBase?: Color3;
  53221. /** Colors for 0.0-0.25 Weight bones */
  53222. colorZero?: Color3;
  53223. /** Color for 0.25-0.5 Weight Influence */
  53224. colorQuarter?: Color3;
  53225. /** Color for 0.5-0.75 Weight Influence */
  53226. colorHalf?: Color3;
  53227. /** Color for 0.75-1 Weight Influence */
  53228. colorFull?: Color3;
  53229. /** Color for Zero Weight Influence */
  53230. targetBoneIndex?: number;
  53231. }
  53232. /**
  53233. * Simple structure of the gradient steps for the Color Map.
  53234. */
  53235. export interface ISkeletonMapShaderColorMapKnot {
  53236. /** Color of the Knot */
  53237. color: Color3;
  53238. /** Location of the Knot */
  53239. location: number;
  53240. }
  53241. /**
  53242. * Defines the constructor options for the SkeletonMap Shader.
  53243. */
  53244. export interface ISkeletonMapShaderOptions {
  53245. /** Skeleton to Map */
  53246. skeleton: Skeleton;
  53247. /** Array of ColorMapKnots that make the gradient must be ordered with knot[i].location < knot[i+1].location*/
  53248. colorMap?: ISkeletonMapShaderColorMapKnot[];
  53249. }
  53250. }
  53251. declare module "babylonjs/Meshes/Builders/ribbonBuilder" {
  53252. import { Nullable } from "babylonjs/types";
  53253. import { Scene } from "babylonjs/scene";
  53254. import { Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  53255. import { Color4 } from "babylonjs/Maths/math.color";
  53256. import { Mesh } from "babylonjs/Meshes/mesh";
  53257. /**
  53258. * Class containing static functions to help procedurally build meshes
  53259. */
  53260. export class RibbonBuilder {
  53261. /**
  53262. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  53263. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  53264. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  53265. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  53266. * * 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
  53267. * * 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
  53268. * * 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
  53269. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53270. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53271. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53272. * * 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
  53273. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  53274. * * 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
  53275. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  53276. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53277. * @param name defines the name of the mesh
  53278. * @param options defines the options used to create the mesh
  53279. * @param scene defines the hosting scene
  53280. * @returns the ribbon mesh
  53281. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  53282. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53283. */
  53284. static CreateRibbon(name: string, options: {
  53285. pathArray: Vector3[][];
  53286. closeArray?: boolean;
  53287. closePath?: boolean;
  53288. offset?: number;
  53289. updatable?: boolean;
  53290. sideOrientation?: number;
  53291. frontUVs?: Vector4;
  53292. backUVs?: Vector4;
  53293. instance?: Mesh;
  53294. invertUV?: boolean;
  53295. uvs?: Vector2[];
  53296. colors?: Color4[];
  53297. }, scene?: Nullable<Scene>): Mesh;
  53298. }
  53299. }
  53300. declare module "babylonjs/Meshes/Builders/shapeBuilder" {
  53301. import { Nullable } from "babylonjs/types";
  53302. import { Scene } from "babylonjs/scene";
  53303. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  53304. import { Mesh } from "babylonjs/Meshes/mesh";
  53305. /**
  53306. * Class containing static functions to help procedurally build meshes
  53307. */
  53308. export class ShapeBuilder {
  53309. /**
  53310. * 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.
  53311. * * 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.
  53312. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53313. * * 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.
  53314. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  53315. * * 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
  53316. * * 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
  53317. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  53318. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53319. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53320. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  53321. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  53322. * @param name defines the name of the mesh
  53323. * @param options defines the options used to create the mesh
  53324. * @param scene defines the hosting scene
  53325. * @returns the extruded shape mesh
  53326. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53327. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53328. */
  53329. static ExtrudeShape(name: string, options: {
  53330. shape: Vector3[];
  53331. path: Vector3[];
  53332. scale?: number;
  53333. rotation?: number;
  53334. cap?: number;
  53335. updatable?: boolean;
  53336. sideOrientation?: number;
  53337. frontUVs?: Vector4;
  53338. backUVs?: Vector4;
  53339. instance?: Mesh;
  53340. invertUV?: boolean;
  53341. }, scene?: Nullable<Scene>): Mesh;
  53342. /**
  53343. * Creates an custom extruded shape mesh.
  53344. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  53345. * * 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.
  53346. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53347. * * 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
  53348. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  53349. * * 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
  53350. * * It must returns a float value that will be the scale value applied to the shape on each path point
  53351. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  53352. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  53353. * * 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
  53354. * * 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
  53355. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  53356. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53357. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53358. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53359. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53360. * @param name defines the name of the mesh
  53361. * @param options defines the options used to create the mesh
  53362. * @param scene defines the hosting scene
  53363. * @returns the custom extruded shape mesh
  53364. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  53365. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53366. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53367. */
  53368. static ExtrudeShapeCustom(name: string, options: {
  53369. shape: Vector3[];
  53370. path: Vector3[];
  53371. scaleFunction?: any;
  53372. rotationFunction?: any;
  53373. ribbonCloseArray?: boolean;
  53374. ribbonClosePath?: boolean;
  53375. cap?: number;
  53376. updatable?: boolean;
  53377. sideOrientation?: number;
  53378. frontUVs?: Vector4;
  53379. backUVs?: Vector4;
  53380. instance?: Mesh;
  53381. invertUV?: boolean;
  53382. }, scene?: Nullable<Scene>): Mesh;
  53383. private static _ExtrudeShapeGeneric;
  53384. }
  53385. }
  53386. declare module "babylonjs/Debug/skeletonViewer" {
  53387. import { Color3 } from "babylonjs/Maths/math.color";
  53388. import { Scene } from "babylonjs/scene";
  53389. import { Nullable } from "babylonjs/types";
  53390. import { Skeleton } from "babylonjs/Bones/skeleton";
  53391. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53392. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  53393. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  53394. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  53395. import { ISkeletonViewerOptions, IBoneWeightShaderOptions, ISkeletonMapShaderOptions } from "babylonjs/Debug/ISkeletonViewer";
  53396. /**
  53397. * Class used to render a debug view of a given skeleton
  53398. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  53399. */
  53400. export class SkeletonViewer {
  53401. /** defines the skeleton to render */
  53402. skeleton: Skeleton;
  53403. /** defines the mesh attached to the skeleton */
  53404. mesh: AbstractMesh;
  53405. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  53406. autoUpdateBonesMatrices: boolean;
  53407. /** defines the rendering group id to use with the viewer */
  53408. renderingGroupId: number;
  53409. /** is the options for the viewer */
  53410. options: Partial<ISkeletonViewerOptions>;
  53411. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  53412. static readonly DISPLAY_LINES: number;
  53413. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  53414. static readonly DISPLAY_SPHERES: number;
  53415. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  53416. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  53417. /** public static method to create a BoneWeight Shader
  53418. * @param options The constructor options
  53419. * @param scene The scene that the shader is scoped to
  53420. * @returns The created ShaderMaterial
  53421. * @see http://www.babylonjs-playground.com/#1BZJVJ#395
  53422. */
  53423. static CreateBoneWeightShader(options: IBoneWeightShaderOptions, scene: Scene): ShaderMaterial;
  53424. /** public static method to create a BoneWeight Shader
  53425. * @param options The constructor options
  53426. * @param scene The scene that the shader is scoped to
  53427. * @returns The created ShaderMaterial
  53428. */
  53429. static CreateSkeletonMapShader(options: ISkeletonMapShaderOptions, scene: Scene): ShaderMaterial;
  53430. /** private static method to create a BoneWeight Shader
  53431. * @param size The size of the buffer to create (usually the bone count)
  53432. * @param colorMap The gradient data to generate
  53433. * @param scene The scene that the shader is scoped to
  53434. * @returns an Array of floats from the color gradient values
  53435. */
  53436. private static _CreateBoneMapColorBuffer;
  53437. /** If SkeletonViewer scene scope. */
  53438. private _scene;
  53439. /** Gets or sets the color used to render the skeleton */
  53440. color: Color3;
  53441. /** Array of the points of the skeleton fo the line view. */
  53442. private _debugLines;
  53443. /** The SkeletonViewers Mesh. */
  53444. private _debugMesh;
  53445. /** The local axes Meshes. */
  53446. private _localAxes;
  53447. /** If SkeletonViewer is enabled. */
  53448. private _isEnabled;
  53449. /** If SkeletonViewer is ready. */
  53450. private _ready;
  53451. /** SkeletonViewer render observable. */
  53452. private _obs;
  53453. /** The Utility Layer to render the gizmos in. */
  53454. private _utilityLayer;
  53455. private _boneIndices;
  53456. /** Gets the Scene. */
  53457. get scene(): Scene;
  53458. /** Gets the utilityLayer. */
  53459. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  53460. /** Checks Ready Status. */
  53461. get isReady(): Boolean;
  53462. /** Sets Ready Status. */
  53463. set ready(value: boolean);
  53464. /** Gets the debugMesh */
  53465. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  53466. /** Sets the debugMesh */
  53467. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  53468. /** Gets the displayMode */
  53469. get displayMode(): number;
  53470. /** Sets the displayMode */
  53471. set displayMode(value: number);
  53472. /**
  53473. * Creates a new SkeletonViewer
  53474. * @param skeleton defines the skeleton to render
  53475. * @param mesh defines the mesh attached to the skeleton
  53476. * @param scene defines the hosting scene
  53477. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  53478. * @param renderingGroupId defines the rendering group id to use with the viewer
  53479. * @param options All of the extra constructor options for the SkeletonViewer
  53480. */
  53481. constructor(
  53482. /** defines the skeleton to render */
  53483. skeleton: Skeleton,
  53484. /** defines the mesh attached to the skeleton */
  53485. mesh: AbstractMesh,
  53486. /** The Scene scope*/
  53487. scene: Scene,
  53488. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  53489. autoUpdateBonesMatrices?: boolean,
  53490. /** defines the rendering group id to use with the viewer */
  53491. renderingGroupId?: number,
  53492. /** is the options for the viewer */
  53493. options?: Partial<ISkeletonViewerOptions>);
  53494. /** The Dynamic bindings for the update functions */
  53495. private _bindObs;
  53496. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  53497. update(): void;
  53498. /** Gets or sets a boolean indicating if the viewer is enabled */
  53499. set isEnabled(value: boolean);
  53500. get isEnabled(): boolean;
  53501. private _getBonePosition;
  53502. private _getLinesForBonesWithLength;
  53503. private _getLinesForBonesNoLength;
  53504. /** function to revert the mesh and scene back to the initial state. */
  53505. private _revert;
  53506. /** function to get the absolute bind pose of a bone by accumulating transformations up the bone hierarchy. */
  53507. private _getAbsoluteBindPoseToRef;
  53508. /** function to build and bind sphere joint points and spur bone representations. */
  53509. private _buildSpheresAndSpurs;
  53510. private _buildLocalAxes;
  53511. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  53512. private _displayLinesUpdate;
  53513. /** Changes the displayMode of the skeleton viewer
  53514. * @param mode The displayMode numerical value
  53515. */
  53516. changeDisplayMode(mode: number): void;
  53517. /** Sets a display option of the skeleton viewer
  53518. *
  53519. * | Option | Type | Default | Description |
  53520. * | --------------- | ------- | ------- | ----------- |
  53521. * | 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`. |
  53522. * | 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`. |
  53523. * | sphereBaseSize | float | 2 | Sphere base size. Only used when `displayMode` is set to `DISPLAY_SPHERE_AND_SPURS`. |
  53524. * | 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`. |
  53525. * | showLocalAxes | boolean | false | Displays local axes on all bones. |
  53526. * | localAxesSize | float | 0.075 | Determines the length of each local axis. |
  53527. *
  53528. * @param option String of the option name
  53529. * @param value The numerical option value
  53530. */
  53531. changeDisplayOptions(option: string, value: number): void;
  53532. /** Release associated resources */
  53533. dispose(): void;
  53534. }
  53535. }
  53536. declare module "babylonjs/Debug/index" {
  53537. export * from "babylonjs/Debug/axesViewer";
  53538. export * from "babylonjs/Debug/boneAxesViewer";
  53539. export * from "babylonjs/Debug/debugLayer";
  53540. export * from "babylonjs/Debug/physicsViewer";
  53541. export * from "babylonjs/Debug/rayHelper";
  53542. export * from "babylonjs/Debug/skeletonViewer";
  53543. export * from "babylonjs/Debug/ISkeletonViewer";
  53544. }
  53545. declare module "babylonjs/DeviceInput/InputDevices/deviceEnums" {
  53546. /**
  53547. * Enum for Device Types
  53548. */
  53549. export enum DeviceType {
  53550. /** Generic */
  53551. Generic = 0,
  53552. /** Keyboard */
  53553. Keyboard = 1,
  53554. /** Mouse */
  53555. Mouse = 2,
  53556. /** Touch Pointers */
  53557. Touch = 3,
  53558. /** PS4 Dual Shock */
  53559. DualShock = 4,
  53560. /** Xbox */
  53561. Xbox = 5,
  53562. /** Switch Controller */
  53563. Switch = 6
  53564. }
  53565. /**
  53566. * Enum for All Pointers (Touch/Mouse)
  53567. */
  53568. export enum PointerInput {
  53569. /** Horizontal Axis */
  53570. Horizontal = 0,
  53571. /** Vertical Axis */
  53572. Vertical = 1,
  53573. /** Left Click or Touch */
  53574. LeftClick = 2,
  53575. /** Middle Click */
  53576. MiddleClick = 3,
  53577. /** Right Click */
  53578. RightClick = 4,
  53579. /** Browser Back */
  53580. BrowserBack = 5,
  53581. /** Browser Forward */
  53582. BrowserForward = 6
  53583. }
  53584. /**
  53585. * Enum for Dual Shock Gamepad
  53586. */
  53587. export enum DualShockInput {
  53588. /** Cross */
  53589. Cross = 0,
  53590. /** Circle */
  53591. Circle = 1,
  53592. /** Square */
  53593. Square = 2,
  53594. /** Triangle */
  53595. Triangle = 3,
  53596. /** L1 */
  53597. L1 = 4,
  53598. /** R1 */
  53599. R1 = 5,
  53600. /** L2 */
  53601. L2 = 6,
  53602. /** R2 */
  53603. R2 = 7,
  53604. /** Share */
  53605. Share = 8,
  53606. /** Options */
  53607. Options = 9,
  53608. /** L3 */
  53609. L3 = 10,
  53610. /** R3 */
  53611. R3 = 11,
  53612. /** DPadUp */
  53613. DPadUp = 12,
  53614. /** DPadDown */
  53615. DPadDown = 13,
  53616. /** DPadLeft */
  53617. DPadLeft = 14,
  53618. /** DRight */
  53619. DPadRight = 15,
  53620. /** Home */
  53621. Home = 16,
  53622. /** TouchPad */
  53623. TouchPad = 17,
  53624. /** LStickXAxis */
  53625. LStickXAxis = 18,
  53626. /** LStickYAxis */
  53627. LStickYAxis = 19,
  53628. /** RStickXAxis */
  53629. RStickXAxis = 20,
  53630. /** RStickYAxis */
  53631. RStickYAxis = 21
  53632. }
  53633. /**
  53634. * Enum for Xbox Gamepad
  53635. */
  53636. export enum XboxInput {
  53637. /** A */
  53638. A = 0,
  53639. /** B */
  53640. B = 1,
  53641. /** X */
  53642. X = 2,
  53643. /** Y */
  53644. Y = 3,
  53645. /** LB */
  53646. LB = 4,
  53647. /** RB */
  53648. RB = 5,
  53649. /** LT */
  53650. LT = 6,
  53651. /** RT */
  53652. RT = 7,
  53653. /** Back */
  53654. Back = 8,
  53655. /** Start */
  53656. Start = 9,
  53657. /** LS */
  53658. LS = 10,
  53659. /** RS */
  53660. RS = 11,
  53661. /** DPadUp */
  53662. DPadUp = 12,
  53663. /** DPadDown */
  53664. DPadDown = 13,
  53665. /** DPadLeft */
  53666. DPadLeft = 14,
  53667. /** DRight */
  53668. DPadRight = 15,
  53669. /** Home */
  53670. Home = 16,
  53671. /** LStickXAxis */
  53672. LStickXAxis = 17,
  53673. /** LStickYAxis */
  53674. LStickYAxis = 18,
  53675. /** RStickXAxis */
  53676. RStickXAxis = 19,
  53677. /** RStickYAxis */
  53678. RStickYAxis = 20
  53679. }
  53680. /**
  53681. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  53682. */
  53683. export enum SwitchInput {
  53684. /** B */
  53685. B = 0,
  53686. /** A */
  53687. A = 1,
  53688. /** Y */
  53689. Y = 2,
  53690. /** X */
  53691. X = 3,
  53692. /** L */
  53693. L = 4,
  53694. /** R */
  53695. R = 5,
  53696. /** ZL */
  53697. ZL = 6,
  53698. /** ZR */
  53699. ZR = 7,
  53700. /** Minus */
  53701. Minus = 8,
  53702. /** Plus */
  53703. Plus = 9,
  53704. /** LS */
  53705. LS = 10,
  53706. /** RS */
  53707. RS = 11,
  53708. /** DPadUp */
  53709. DPadUp = 12,
  53710. /** DPadDown */
  53711. DPadDown = 13,
  53712. /** DPadLeft */
  53713. DPadLeft = 14,
  53714. /** DRight */
  53715. DPadRight = 15,
  53716. /** Home */
  53717. Home = 16,
  53718. /** Capture */
  53719. Capture = 17,
  53720. /** LStickXAxis */
  53721. LStickXAxis = 18,
  53722. /** LStickYAxis */
  53723. LStickYAxis = 19,
  53724. /** RStickXAxis */
  53725. RStickXAxis = 20,
  53726. /** RStickYAxis */
  53727. RStickYAxis = 21
  53728. }
  53729. }
  53730. declare module "babylonjs/DeviceInput/deviceInputSystem" {
  53731. import { Engine } from "babylonjs/Engines/engine";
  53732. import { IDisposable } from "babylonjs/scene";
  53733. import { Nullable } from "babylonjs/types";
  53734. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53735. /**
  53736. * This class will take all inputs from Keyboard, Pointer, and
  53737. * any Gamepads and provide a polling system that all devices
  53738. * will use. This class assumes that there will only be one
  53739. * pointer device and one keyboard.
  53740. */
  53741. export class DeviceInputSystem implements IDisposable {
  53742. /**
  53743. * Callback to be triggered when a device is connected
  53744. */
  53745. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  53746. /**
  53747. * Callback to be triggered when a device is disconnected
  53748. */
  53749. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  53750. /**
  53751. * Callback to be triggered when event driven input is updated
  53752. */
  53753. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  53754. private _inputs;
  53755. private _gamepads;
  53756. private _keyboardActive;
  53757. private _pointerActive;
  53758. private _elementToAttachTo;
  53759. private _keyboardDownEvent;
  53760. private _keyboardUpEvent;
  53761. private _pointerMoveEvent;
  53762. private _pointerDownEvent;
  53763. private _pointerUpEvent;
  53764. private _gamepadConnectedEvent;
  53765. private _gamepadDisconnectedEvent;
  53766. private static _MAX_KEYCODES;
  53767. private static _MAX_POINTER_INPUTS;
  53768. private constructor();
  53769. /**
  53770. * Creates a new DeviceInputSystem instance
  53771. * @param engine Engine to pull input element from
  53772. * @returns The new instance
  53773. */
  53774. static Create(engine: Engine): DeviceInputSystem;
  53775. /**
  53776. * Checks for current device input value, given an id and input index
  53777. * @param deviceName Id of connected device
  53778. * @param inputIndex Index of device input
  53779. * @returns Current value of input
  53780. */
  53781. /**
  53782. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  53783. * @param deviceType Enum specifiying device type
  53784. * @param deviceSlot "Slot" or index that device is referenced in
  53785. * @param inputIndex Id of input to be checked
  53786. * @returns Current value of input
  53787. */
  53788. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  53789. /**
  53790. * Dispose of all the eventlisteners
  53791. */
  53792. dispose(): void;
  53793. /**
  53794. * Add device and inputs to device array
  53795. * @param deviceType Enum specifiying device type
  53796. * @param deviceSlot "Slot" or index that device is referenced in
  53797. * @param numberOfInputs Number of input entries to create for given device
  53798. */
  53799. private _registerDevice;
  53800. /**
  53801. * Given a specific device name, remove that device from the device map
  53802. * @param deviceType Enum specifiying device type
  53803. * @param deviceSlot "Slot" or index that device is referenced in
  53804. */
  53805. private _unregisterDevice;
  53806. /**
  53807. * Handle all actions that come from keyboard interaction
  53808. */
  53809. private _handleKeyActions;
  53810. /**
  53811. * Handle all actions that come from pointer interaction
  53812. */
  53813. private _handlePointerActions;
  53814. /**
  53815. * Handle all actions that come from gamepad interaction
  53816. */
  53817. private _handleGamepadActions;
  53818. /**
  53819. * Update all non-event based devices with each frame
  53820. * @param deviceType Enum specifiying device type
  53821. * @param deviceSlot "Slot" or index that device is referenced in
  53822. * @param inputIndex Id of input to be checked
  53823. */
  53824. private _updateDevice;
  53825. /**
  53826. * Gets DeviceType from the device name
  53827. * @param deviceName Name of Device from DeviceInputSystem
  53828. * @returns DeviceType enum value
  53829. */
  53830. private _getGamepadDeviceType;
  53831. }
  53832. }
  53833. declare module "babylonjs/DeviceInput/InputDevices/deviceTypes" {
  53834. import { DeviceType, PointerInput, DualShockInput, XboxInput, SwitchInput } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53835. /**
  53836. * Type to handle enforcement of inputs
  53837. */
  53838. 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;
  53839. }
  53840. declare module "babylonjs/DeviceInput/InputDevices/deviceSourceManager" {
  53841. import { DeviceInputSystem } from "babylonjs/DeviceInput/deviceInputSystem";
  53842. import { Engine } from "babylonjs/Engines/engine";
  53843. import { IDisposable } from "babylonjs/scene";
  53844. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53845. import { Nullable } from "babylonjs/types";
  53846. import { Observable } from "babylonjs/Misc/observable";
  53847. import { DeviceInput } from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53848. /**
  53849. * Class that handles all input for a specific device
  53850. */
  53851. export class DeviceSource<T extends DeviceType> {
  53852. /** Type of device */
  53853. readonly deviceType: DeviceType;
  53854. /** "Slot" or index that device is referenced in */
  53855. readonly deviceSlot: number;
  53856. /**
  53857. * Observable to handle device input changes per device
  53858. */
  53859. readonly onInputChangedObservable: Observable<{
  53860. inputIndex: DeviceInput<T>;
  53861. previousState: Nullable<number>;
  53862. currentState: Nullable<number>;
  53863. }>;
  53864. private readonly _deviceInputSystem;
  53865. /**
  53866. * Default Constructor
  53867. * @param deviceInputSystem Reference to DeviceInputSystem
  53868. * @param deviceType Type of device
  53869. * @param deviceSlot "Slot" or index that device is referenced in
  53870. */
  53871. constructor(deviceInputSystem: DeviceInputSystem,
  53872. /** Type of device */
  53873. deviceType: DeviceType,
  53874. /** "Slot" or index that device is referenced in */
  53875. deviceSlot?: number);
  53876. /**
  53877. * Get input for specific input
  53878. * @param inputIndex index of specific input on device
  53879. * @returns Input value from DeviceInputSystem
  53880. */
  53881. getInput(inputIndex: DeviceInput<T>): number;
  53882. }
  53883. /**
  53884. * Class to keep track of devices
  53885. */
  53886. export class DeviceSourceManager implements IDisposable {
  53887. /**
  53888. * Observable to be triggered when before a device is connected
  53889. */
  53890. readonly onBeforeDeviceConnectedObservable: Observable<{
  53891. deviceType: DeviceType;
  53892. deviceSlot: number;
  53893. }>;
  53894. /**
  53895. * Observable to be triggered when before a device is disconnected
  53896. */
  53897. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  53898. deviceType: DeviceType;
  53899. deviceSlot: number;
  53900. }>;
  53901. /**
  53902. * Observable to be triggered when after a device is connected
  53903. */
  53904. readonly onAfterDeviceConnectedObservable: Observable<{
  53905. deviceType: DeviceType;
  53906. deviceSlot: number;
  53907. }>;
  53908. /**
  53909. * Observable to be triggered when after a device is disconnected
  53910. */
  53911. readonly onAfterDeviceDisconnectedObservable: Observable<{
  53912. deviceType: DeviceType;
  53913. deviceSlot: number;
  53914. }>;
  53915. private readonly _devices;
  53916. private readonly _firstDevice;
  53917. private readonly _deviceInputSystem;
  53918. /**
  53919. * Default Constructor
  53920. * @param engine engine to pull input element from
  53921. */
  53922. constructor(engine: Engine);
  53923. /**
  53924. * Gets a DeviceSource, given a type and slot
  53925. * @param deviceType Enum specifying device type
  53926. * @param deviceSlot "Slot" or index that device is referenced in
  53927. * @returns DeviceSource object
  53928. */
  53929. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  53930. /**
  53931. * Gets an array of DeviceSource objects for a given device type
  53932. * @param deviceType Enum specifying device type
  53933. * @returns Array of DeviceSource objects
  53934. */
  53935. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  53936. /**
  53937. * Dispose of DeviceInputSystem and other parts
  53938. */
  53939. dispose(): void;
  53940. /**
  53941. * Function to add device name to device list
  53942. * @param deviceType Enum specifying device type
  53943. * @param deviceSlot "Slot" or index that device is referenced in
  53944. */
  53945. private _addDevice;
  53946. /**
  53947. * Function to remove device name to device list
  53948. * @param deviceType Enum specifying device type
  53949. * @param deviceSlot "Slot" or index that device is referenced in
  53950. */
  53951. private _removeDevice;
  53952. /**
  53953. * Updates array storing first connected device of each type
  53954. * @param type Type of Device
  53955. */
  53956. private _updateFirstDevices;
  53957. }
  53958. }
  53959. declare module "babylonjs/DeviceInput/index" {
  53960. export * from "babylonjs/DeviceInput/deviceInputSystem";
  53961. export * from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53962. export * from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53963. import "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53964. export * from "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53965. }
  53966. declare module "babylonjs/Engines/nullEngine" {
  53967. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  53968. import { Engine } from "babylonjs/Engines/engine";
  53969. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  53970. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  53971. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53972. import { Effect } from "babylonjs/Materials/effect";
  53973. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  53974. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  53975. import { IColor4Like, IViewportLike } from "babylonjs/Maths/math.like";
  53976. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  53977. /**
  53978. * Options to create the null engine
  53979. */
  53980. export class NullEngineOptions {
  53981. /**
  53982. * Render width (Default: 512)
  53983. */
  53984. renderWidth: number;
  53985. /**
  53986. * Render height (Default: 256)
  53987. */
  53988. renderHeight: number;
  53989. /**
  53990. * Texture size (Default: 512)
  53991. */
  53992. textureSize: number;
  53993. /**
  53994. * If delta time between frames should be constant
  53995. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53996. */
  53997. deterministicLockstep: boolean;
  53998. /**
  53999. * Maximum about of steps between frames (Default: 4)
  54000. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  54001. */
  54002. lockstepMaxSteps: number;
  54003. /**
  54004. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  54005. */
  54006. useHighPrecisionMatrix?: boolean;
  54007. }
  54008. /**
  54009. * The null engine class provides support for headless version of babylon.js.
  54010. * This can be used in server side scenario or for testing purposes
  54011. */
  54012. export class NullEngine extends Engine {
  54013. private _options;
  54014. /**
  54015. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  54016. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  54017. * @returns true if engine is in deterministic lock step mode
  54018. */
  54019. isDeterministicLockStep(): boolean;
  54020. /**
  54021. * Gets the max steps when engine is running in deterministic lock step
  54022. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  54023. * @returns the max steps
  54024. */
  54025. getLockstepMaxSteps(): number;
  54026. /**
  54027. * Gets the current hardware scaling level.
  54028. * By default the hardware scaling level is computed from the window device ratio.
  54029. * 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.
  54030. * @returns a number indicating the current hardware scaling level
  54031. */
  54032. getHardwareScalingLevel(): number;
  54033. constructor(options?: NullEngineOptions);
  54034. /**
  54035. * Creates a vertex buffer
  54036. * @param vertices the data for the vertex buffer
  54037. * @returns the new WebGL static buffer
  54038. */
  54039. createVertexBuffer(vertices: FloatArray): DataBuffer;
  54040. /**
  54041. * Creates a new index buffer
  54042. * @param indices defines the content of the index buffer
  54043. * @param updatable defines if the index buffer must be updatable
  54044. * @returns a new webGL buffer
  54045. */
  54046. createIndexBuffer(indices: IndicesArray): DataBuffer;
  54047. /**
  54048. * Clear the current render buffer or the current render target (if any is set up)
  54049. * @param color defines the color to use
  54050. * @param backBuffer defines if the back buffer must be cleared
  54051. * @param depth defines if the depth buffer must be cleared
  54052. * @param stencil defines if the stencil buffer must be cleared
  54053. */
  54054. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  54055. /**
  54056. * Gets the current render width
  54057. * @param useScreen defines if screen size must be used (or the current render target if any)
  54058. * @returns a number defining the current render width
  54059. */
  54060. getRenderWidth(useScreen?: boolean): number;
  54061. /**
  54062. * Gets the current render height
  54063. * @param useScreen defines if screen size must be used (or the current render target if any)
  54064. * @returns a number defining the current render height
  54065. */
  54066. getRenderHeight(useScreen?: boolean): number;
  54067. /**
  54068. * Set the WebGL's viewport
  54069. * @param viewport defines the viewport element to be used
  54070. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  54071. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  54072. */
  54073. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  54074. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  54075. /**
  54076. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  54077. * @param pipelineContext defines the pipeline context to use
  54078. * @param uniformsNames defines the list of uniform names
  54079. * @returns an array of webGL uniform locations
  54080. */
  54081. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  54082. /**
  54083. * Gets the lsit of active attributes for a given webGL program
  54084. * @param pipelineContext defines the pipeline context to use
  54085. * @param attributesNames defines the list of attribute names to get
  54086. * @returns an array of indices indicating the offset of each attribute
  54087. */
  54088. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  54089. /**
  54090. * Binds an effect to the webGL context
  54091. * @param effect defines the effect to bind
  54092. */
  54093. bindSamplers(effect: Effect): void;
  54094. /**
  54095. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  54096. * @param effect defines the effect to activate
  54097. */
  54098. enableEffect(effect: Effect): void;
  54099. /**
  54100. * Set various states to the webGL context
  54101. * @param culling defines backface culling state
  54102. * @param zOffset defines the value to apply to zOffset (0 by default)
  54103. * @param force defines if states must be applied even if cache is up to date
  54104. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  54105. */
  54106. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  54107. /**
  54108. * Set the value of an uniform to an array of int32
  54109. * @param uniform defines the webGL uniform location where to store the value
  54110. * @param array defines the array of int32 to store
  54111. * @returns true if value was set
  54112. */
  54113. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  54114. /**
  54115. * Set the value of an uniform to an array of int32 (stored as vec2)
  54116. * @param uniform defines the webGL uniform location where to store the value
  54117. * @param array defines the array of int32 to store
  54118. * @returns true if value was set
  54119. */
  54120. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  54121. /**
  54122. * Set the value of an uniform to an array of int32 (stored as vec3)
  54123. * @param uniform defines the webGL uniform location where to store the value
  54124. * @param array defines the array of int32 to store
  54125. * @returns true if value was set
  54126. */
  54127. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  54128. /**
  54129. * Set the value of an uniform to an array of int32 (stored as vec4)
  54130. * @param uniform defines the webGL uniform location where to store the value
  54131. * @param array defines the array of int32 to store
  54132. * @returns true if value was set
  54133. */
  54134. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  54135. /**
  54136. * Set the value of an uniform to an array of float32
  54137. * @param uniform defines the webGL uniform location where to store the value
  54138. * @param array defines the array of float32 to store
  54139. * @returns true if value was set
  54140. */
  54141. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  54142. /**
  54143. * Set the value of an uniform to an array of float32 (stored as vec2)
  54144. * @param uniform defines the webGL uniform location where to store the value
  54145. * @param array defines the array of float32 to store
  54146. * @returns true if value was set
  54147. */
  54148. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  54149. /**
  54150. * Set the value of an uniform to an array of float32 (stored as vec3)
  54151. * @param uniform defines the webGL uniform location where to store the value
  54152. * @param array defines the array of float32 to store
  54153. * @returns true if value was set
  54154. */
  54155. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  54156. /**
  54157. * Set the value of an uniform to an array of float32 (stored as vec4)
  54158. * @param uniform defines the webGL uniform location where to store the value
  54159. * @param array defines the array of float32 to store
  54160. * @returns true if value was set
  54161. */
  54162. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  54163. /**
  54164. * Set the value of an uniform to an array of number
  54165. * @param uniform defines the webGL uniform location where to store the value
  54166. * @param array defines the array of number to store
  54167. * @returns true if value was set
  54168. */
  54169. setArray(uniform: WebGLUniformLocation, array: number[]): boolean;
  54170. /**
  54171. * Set the value of an uniform to an array of number (stored as vec2)
  54172. * @param uniform defines the webGL uniform location where to store the value
  54173. * @param array defines the array of number to store
  54174. * @returns true if value was set
  54175. */
  54176. setArray2(uniform: WebGLUniformLocation, array: number[]): boolean;
  54177. /**
  54178. * Set the value of an uniform to an array of number (stored as vec3)
  54179. * @param uniform defines the webGL uniform location where to store the value
  54180. * @param array defines the array of number to store
  54181. * @returns true if value was set
  54182. */
  54183. setArray3(uniform: WebGLUniformLocation, array: number[]): boolean;
  54184. /**
  54185. * Set the value of an uniform to an array of number (stored as vec4)
  54186. * @param uniform defines the webGL uniform location where to store the value
  54187. * @param array defines the array of number to store
  54188. * @returns true if value was set
  54189. */
  54190. setArray4(uniform: WebGLUniformLocation, array: number[]): boolean;
  54191. /**
  54192. * Set the value of an uniform to an array of float32 (stored as matrices)
  54193. * @param uniform defines the webGL uniform location where to store the value
  54194. * @param matrices defines the array of float32 to store
  54195. * @returns true if value was set
  54196. */
  54197. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): boolean;
  54198. /**
  54199. * Set the value of an uniform to a matrix (3x3)
  54200. * @param uniform defines the webGL uniform location where to store the value
  54201. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  54202. * @returns true if value was set
  54203. */
  54204. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  54205. /**
  54206. * Set the value of an uniform to a matrix (2x2)
  54207. * @param uniform defines the webGL uniform location where to store the value
  54208. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  54209. * @returns true if value was set
  54210. */
  54211. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  54212. /**
  54213. * Set the value of an uniform to a number (float)
  54214. * @param uniform defines the webGL uniform location where to store the value
  54215. * @param value defines the float number to store
  54216. * @returns true if value was set
  54217. */
  54218. setFloat(uniform: WebGLUniformLocation, value: number): boolean;
  54219. /**
  54220. * Set the value of an uniform to a vec2
  54221. * @param uniform defines the webGL uniform location where to store the value
  54222. * @param x defines the 1st component of the value
  54223. * @param y defines the 2nd component of the value
  54224. * @returns true if value was set
  54225. */
  54226. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): boolean;
  54227. /**
  54228. * Set the value of an uniform to a vec3
  54229. * @param uniform defines the webGL uniform location where to store the value
  54230. * @param x defines the 1st component of the value
  54231. * @param y defines the 2nd component of the value
  54232. * @param z defines the 3rd component of the value
  54233. * @returns true if value was set
  54234. */
  54235. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): boolean;
  54236. /**
  54237. * Set the value of an uniform to a boolean
  54238. * @param uniform defines the webGL uniform location where to store the value
  54239. * @param bool defines the boolean to store
  54240. * @returns true if value was set
  54241. */
  54242. setBool(uniform: WebGLUniformLocation, bool: number): boolean;
  54243. /**
  54244. * Set the value of an uniform to a vec4
  54245. * @param uniform defines the webGL uniform location where to store the value
  54246. * @param x defines the 1st component of the value
  54247. * @param y defines the 2nd component of the value
  54248. * @param z defines the 3rd component of the value
  54249. * @param w defines the 4th component of the value
  54250. * @returns true if value was set
  54251. */
  54252. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): boolean;
  54253. /**
  54254. * Sets the current alpha mode
  54255. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  54256. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  54257. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  54258. */
  54259. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  54260. /**
  54261. * Bind webGl buffers directly to the webGL context
  54262. * @param vertexBuffers defines the vertex buffer to bind
  54263. * @param indexBuffer defines the index buffer to bind
  54264. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  54265. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  54266. * @param effect defines the effect associated with the vertex buffer
  54267. */
  54268. bindBuffers(vertexBuffers: {
  54269. [key: string]: VertexBuffer;
  54270. }, indexBuffer: DataBuffer, effect: Effect): void;
  54271. /**
  54272. * Force the entire cache to be cleared
  54273. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  54274. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  54275. */
  54276. wipeCaches(bruteForce?: boolean): void;
  54277. /**
  54278. * Send a draw order
  54279. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  54280. * @param indexStart defines the starting index
  54281. * @param indexCount defines the number of index to draw
  54282. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54283. */
  54284. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  54285. /**
  54286. * Draw a list of indexed primitives
  54287. * @param fillMode defines the primitive to use
  54288. * @param indexStart defines the starting index
  54289. * @param indexCount defines the number of index to draw
  54290. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54291. */
  54292. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  54293. /**
  54294. * Draw a list of unindexed primitives
  54295. * @param fillMode defines the primitive to use
  54296. * @param verticesStart defines the index of first vertex to draw
  54297. * @param verticesCount defines the count of vertices to draw
  54298. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54299. */
  54300. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  54301. /** @hidden */
  54302. _createTexture(): WebGLTexture;
  54303. /** @hidden */
  54304. _releaseTexture(texture: InternalTexture): void;
  54305. /**
  54306. * Usually called from Texture.ts.
  54307. * Passed information to create a WebGLTexture
  54308. * @param urlArg defines a value which contains one of the following:
  54309. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  54310. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  54311. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  54312. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  54313. * @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)
  54314. * @param scene needed for loading to the correct scene
  54315. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  54316. * @param onLoad optional callback to be called upon successful completion
  54317. * @param onError optional callback to be called upon failure
  54318. * @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
  54319. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  54320. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  54321. * @param forcedExtension defines the extension to use to pick the right loader
  54322. * @param mimeType defines an optional mime type
  54323. * @returns a InternalTexture for assignment back into BABYLON.Texture
  54324. */
  54325. 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;
  54326. /**
  54327. * Creates a new render target texture
  54328. * @param size defines the size of the texture
  54329. * @param options defines the options used to create the texture
  54330. * @returns a new render target texture stored in an InternalTexture
  54331. */
  54332. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  54333. /**
  54334. * Update the sampling mode of a given texture
  54335. * @param samplingMode defines the required sampling mode
  54336. * @param texture defines the texture to update
  54337. */
  54338. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  54339. /**
  54340. * Binds the frame buffer to the specified texture.
  54341. * @param texture The texture to render to or null for the default canvas
  54342. * @param faceIndex The face of the texture to render to in case of cube texture
  54343. * @param requiredWidth The width of the target to render to
  54344. * @param requiredHeight The height of the target to render to
  54345. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  54346. * @param lodLevel defines le lod level to bind to the frame buffer
  54347. */
  54348. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  54349. /**
  54350. * Unbind the current render target texture from the webGL context
  54351. * @param texture defines the render target texture to unbind
  54352. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  54353. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  54354. */
  54355. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  54356. /**
  54357. * Creates a dynamic vertex buffer
  54358. * @param vertices the data for the dynamic vertex buffer
  54359. * @returns the new WebGL dynamic buffer
  54360. */
  54361. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  54362. /**
  54363. * Update the content of a dynamic texture
  54364. * @param texture defines the texture to update
  54365. * @param canvas defines the canvas containing the source
  54366. * @param invertY defines if data must be stored with Y axis inverted
  54367. * @param premulAlpha defines if alpha is stored as premultiplied
  54368. * @param format defines the format of the data
  54369. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  54370. */
  54371. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  54372. /**
  54373. * Gets a boolean indicating if all created effects are ready
  54374. * @returns true if all effects are ready
  54375. */
  54376. areAllEffectsReady(): boolean;
  54377. /**
  54378. * @hidden
  54379. * Get the current error code of the webGL context
  54380. * @returns the error code
  54381. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  54382. */
  54383. getError(): number;
  54384. /** @hidden */
  54385. _getUnpackAlignement(): number;
  54386. /** @hidden */
  54387. _unpackFlipY(value: boolean): void;
  54388. /**
  54389. * Update a dynamic index buffer
  54390. * @param indexBuffer defines the target index buffer
  54391. * @param indices defines the data to update
  54392. * @param offset defines the offset in the target index buffer where update should start
  54393. */
  54394. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  54395. /**
  54396. * Updates a dynamic vertex buffer.
  54397. * @param vertexBuffer the vertex buffer to update
  54398. * @param vertices the data used to update the vertex buffer
  54399. * @param byteOffset the byte offset of the data (optional)
  54400. * @param byteLength the byte length of the data (optional)
  54401. */
  54402. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  54403. /** @hidden */
  54404. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  54405. /** @hidden */
  54406. _bindTexture(channel: number, texture: InternalTexture): void;
  54407. protected _deleteBuffer(buffer: WebGLBuffer): void;
  54408. /**
  54409. * 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
  54410. */
  54411. releaseEffects(): void;
  54412. displayLoadingUI(): void;
  54413. hideLoadingUI(): void;
  54414. /** @hidden */
  54415. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54416. /** @hidden */
  54417. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54418. /** @hidden */
  54419. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54420. /** @hidden */
  54421. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  54422. }
  54423. }
  54424. declare module "babylonjs/Instrumentation/timeToken" {
  54425. import { Nullable } from "babylonjs/types";
  54426. /**
  54427. * @hidden
  54428. **/
  54429. export class _TimeToken {
  54430. _startTimeQuery: Nullable<WebGLQuery>;
  54431. _endTimeQuery: Nullable<WebGLQuery>;
  54432. _timeElapsedQuery: Nullable<WebGLQuery>;
  54433. _timeElapsedQueryEnded: boolean;
  54434. }
  54435. }
  54436. declare module "babylonjs/Engines/Extensions/engine.occlusionQuery" {
  54437. import { Nullable, int } from "babylonjs/types";
  54438. import { _TimeToken } from "babylonjs/Instrumentation/timeToken";
  54439. /** @hidden */
  54440. export class _OcclusionDataStorage {
  54441. /** @hidden */
  54442. occlusionInternalRetryCounter: number;
  54443. /** @hidden */
  54444. isOcclusionQueryInProgress: boolean;
  54445. /** @hidden */
  54446. isOccluded: boolean;
  54447. /** @hidden */
  54448. occlusionRetryCount: number;
  54449. /** @hidden */
  54450. occlusionType: number;
  54451. /** @hidden */
  54452. occlusionQueryAlgorithmType: number;
  54453. }
  54454. module "babylonjs/Engines/engine" {
  54455. interface Engine {
  54456. /**
  54457. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  54458. * @return the new query
  54459. */
  54460. createQuery(): WebGLQuery;
  54461. /**
  54462. * Delete and release a webGL query
  54463. * @param query defines the query to delete
  54464. * @return the current engine
  54465. */
  54466. deleteQuery(query: WebGLQuery): Engine;
  54467. /**
  54468. * Check if a given query has resolved and got its value
  54469. * @param query defines the query to check
  54470. * @returns true if the query got its value
  54471. */
  54472. isQueryResultAvailable(query: WebGLQuery): boolean;
  54473. /**
  54474. * Gets the value of a given query
  54475. * @param query defines the query to check
  54476. * @returns the value of the query
  54477. */
  54478. getQueryResult(query: WebGLQuery): number;
  54479. /**
  54480. * Initiates an occlusion query
  54481. * @param algorithmType defines the algorithm to use
  54482. * @param query defines the query to use
  54483. * @returns the current engine
  54484. * @see https://doc.babylonjs.com/features/occlusionquery
  54485. */
  54486. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  54487. /**
  54488. * Ends an occlusion query
  54489. * @see https://doc.babylonjs.com/features/occlusionquery
  54490. * @param algorithmType defines the algorithm to use
  54491. * @returns the current engine
  54492. */
  54493. endOcclusionQuery(algorithmType: number): Engine;
  54494. /**
  54495. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  54496. * Please note that only one query can be issued at a time
  54497. * @returns a time token used to track the time span
  54498. */
  54499. startTimeQuery(): Nullable<_TimeToken>;
  54500. /**
  54501. * Ends a time query
  54502. * @param token defines the token used to measure the time span
  54503. * @returns the time spent (in ns)
  54504. */
  54505. endTimeQuery(token: _TimeToken): int;
  54506. /** @hidden */
  54507. _currentNonTimestampToken: Nullable<_TimeToken>;
  54508. /** @hidden */
  54509. _createTimeQuery(): WebGLQuery;
  54510. /** @hidden */
  54511. _deleteTimeQuery(query: WebGLQuery): void;
  54512. /** @hidden */
  54513. _getGlAlgorithmType(algorithmType: number): number;
  54514. /** @hidden */
  54515. _getTimeQueryResult(query: WebGLQuery): any;
  54516. /** @hidden */
  54517. _getTimeQueryAvailability(query: WebGLQuery): any;
  54518. }
  54519. }
  54520. module "babylonjs/Meshes/abstractMesh" {
  54521. interface AbstractMesh {
  54522. /**
  54523. * Backing filed
  54524. * @hidden
  54525. */
  54526. __occlusionDataStorage: _OcclusionDataStorage;
  54527. /**
  54528. * Access property
  54529. * @hidden
  54530. */
  54531. _occlusionDataStorage: _OcclusionDataStorage;
  54532. /**
  54533. * 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.
  54534. * The default value is -1 which means don't break the query and wait till the result
  54535. * @see https://doc.babylonjs.com/features/occlusionquery
  54536. */
  54537. occlusionRetryCount: number;
  54538. /**
  54539. * 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:
  54540. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  54541. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  54542. * * 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.
  54543. * @see https://doc.babylonjs.com/features/occlusionquery
  54544. */
  54545. occlusionType: number;
  54546. /**
  54547. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  54548. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  54549. * * 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.
  54550. * @see https://doc.babylonjs.com/features/occlusionquery
  54551. */
  54552. occlusionQueryAlgorithmType: number;
  54553. /**
  54554. * 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
  54555. * @see https://doc.babylonjs.com/features/occlusionquery
  54556. */
  54557. isOccluded: boolean;
  54558. /**
  54559. * Flag to check the progress status of the query
  54560. * @see https://doc.babylonjs.com/features/occlusionquery
  54561. */
  54562. isOcclusionQueryInProgress: boolean;
  54563. }
  54564. }
  54565. }
  54566. declare module "babylonjs/Engines/Extensions/engine.transformFeedback" {
  54567. import { Nullable } from "babylonjs/types";
  54568. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  54569. /** @hidden */
  54570. export var _forceTransformFeedbackToBundle: boolean;
  54571. module "babylonjs/Engines/engine" {
  54572. interface Engine {
  54573. /**
  54574. * Creates a webGL transform feedback object
  54575. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  54576. * @returns the webGL transform feedback object
  54577. */
  54578. createTransformFeedback(): WebGLTransformFeedback;
  54579. /**
  54580. * Delete a webGL transform feedback object
  54581. * @param value defines the webGL transform feedback object to delete
  54582. */
  54583. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  54584. /**
  54585. * Bind a webGL transform feedback object to the webgl context
  54586. * @param value defines the webGL transform feedback object to bind
  54587. */
  54588. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  54589. /**
  54590. * Begins a transform feedback operation
  54591. * @param usePoints defines if points or triangles must be used
  54592. */
  54593. beginTransformFeedback(usePoints: boolean): void;
  54594. /**
  54595. * Ends a transform feedback operation
  54596. */
  54597. endTransformFeedback(): void;
  54598. /**
  54599. * Specify the varyings to use with transform feedback
  54600. * @param program defines the associated webGL program
  54601. * @param value defines the list of strings representing the varying names
  54602. */
  54603. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  54604. /**
  54605. * Bind a webGL buffer for a transform feedback operation
  54606. * @param value defines the webGL buffer to bind
  54607. */
  54608. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  54609. }
  54610. }
  54611. }
  54612. declare module "babylonjs/Engines/Extensions/engine.views" {
  54613. import { Camera } from "babylonjs/Cameras/camera";
  54614. import { Nullable } from "babylonjs/types";
  54615. /**
  54616. * Class used to define an additional view for the engine
  54617. * @see https://doc.babylonjs.com/how_to/multi_canvases
  54618. */
  54619. export class EngineView {
  54620. /** Defines the canvas where to render the view */
  54621. target: HTMLCanvasElement;
  54622. /** Defines an optional camera used to render the view (will use active camera else) */
  54623. camera?: Camera;
  54624. }
  54625. module "babylonjs/Engines/engine" {
  54626. interface Engine {
  54627. /**
  54628. * Gets or sets the HTML element to use for attaching events
  54629. */
  54630. inputElement: Nullable<HTMLElement>;
  54631. /**
  54632. * Gets the current engine view
  54633. * @see https://doc.babylonjs.com/how_to/multi_canvases
  54634. */
  54635. activeView: Nullable<EngineView>;
  54636. /** Gets or sets the list of views */
  54637. views: EngineView[];
  54638. /**
  54639. * Register a new child canvas
  54640. * @param canvas defines the canvas to register
  54641. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  54642. * @returns the associated view
  54643. */
  54644. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  54645. /**
  54646. * Remove a registered child canvas
  54647. * @param canvas defines the canvas to remove
  54648. * @returns the current engine
  54649. */
  54650. unRegisterView(canvas: HTMLCanvasElement): Engine;
  54651. }
  54652. }
  54653. }
  54654. declare module "babylonjs/Engines/Extensions/engine.textureSelector" {
  54655. import { Nullable } from "babylonjs/types";
  54656. module "babylonjs/Engines/engine" {
  54657. interface Engine {
  54658. /** @hidden */
  54659. _excludedCompressedTextures: string[];
  54660. /** @hidden */
  54661. _textureFormatInUse: string;
  54662. /**
  54663. * Gets the list of texture formats supported
  54664. */
  54665. readonly texturesSupported: Array<string>;
  54666. /**
  54667. * Gets the texture format in use
  54668. */
  54669. readonly textureFormatInUse: Nullable<string>;
  54670. /**
  54671. * Set the compressed texture extensions or file names to skip.
  54672. *
  54673. * @param skippedFiles defines the list of those texture files you want to skip
  54674. * Example: [".dds", ".env", "myfile.png"]
  54675. */
  54676. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  54677. /**
  54678. * Set the compressed texture format to use, based on the formats you have, and the formats
  54679. * supported by the hardware / browser.
  54680. *
  54681. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  54682. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  54683. * to API arguments needed to compressed textures. This puts the burden on the container
  54684. * generator to house the arcane code for determining these for current & future formats.
  54685. *
  54686. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  54687. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  54688. *
  54689. * Note: The result of this call is not taken into account when a texture is base64.
  54690. *
  54691. * @param formatsAvailable defines the list of those format families you have created
  54692. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  54693. *
  54694. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  54695. * @returns The extension selected.
  54696. */
  54697. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  54698. }
  54699. }
  54700. }
  54701. declare module "babylonjs/Engines/Extensions/index" {
  54702. export * from "babylonjs/Engines/Extensions/engine.alpha";
  54703. export * from "babylonjs/Engines/Extensions/engine.occlusionQuery";
  54704. export * from "babylonjs/Engines/Extensions/engine.transformFeedback";
  54705. export * from "babylonjs/Engines/Extensions/engine.multiview";
  54706. export * from "babylonjs/Engines/Extensions/engine.rawTexture";
  54707. export * from "babylonjs/Engines/Extensions/engine.dynamicTexture";
  54708. export * from "babylonjs/Engines/Extensions/engine.videoTexture";
  54709. export * from "babylonjs/Engines/Extensions/engine.multiRender";
  54710. export * from "babylonjs/Engines/Extensions/engine.cubeTexture";
  54711. export * from "babylonjs/Engines/Extensions/engine.renderTarget";
  54712. export * from "babylonjs/Engines/Extensions/engine.renderTargetCube";
  54713. export * from "babylonjs/Engines/Extensions/engine.webVR";
  54714. export * from "babylonjs/Engines/Extensions/engine.uniformBuffer";
  54715. export * from "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  54716. export * from "babylonjs/Engines/Extensions/engine.views";
  54717. export * from "babylonjs/Engines/Extensions/engine.readTexture";
  54718. import "babylonjs/Engines/Extensions/engine.textureSelector";
  54719. export * from "babylonjs/Engines/Extensions/engine.textureSelector";
  54720. }
  54721. declare module "babylonjs/Misc/HighDynamicRange/panoramaToCubemap" {
  54722. import { Nullable } from "babylonjs/types";
  54723. /**
  54724. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  54725. */
  54726. export interface CubeMapInfo {
  54727. /**
  54728. * The pixel array for the front face.
  54729. * This is stored in format, left to right, up to down format.
  54730. */
  54731. front: Nullable<ArrayBufferView>;
  54732. /**
  54733. * The pixel array for the back face.
  54734. * This is stored in format, left to right, up to down format.
  54735. */
  54736. back: Nullable<ArrayBufferView>;
  54737. /**
  54738. * The pixel array for the left face.
  54739. * This is stored in format, left to right, up to down format.
  54740. */
  54741. left: Nullable<ArrayBufferView>;
  54742. /**
  54743. * The pixel array for the right face.
  54744. * This is stored in format, left to right, up to down format.
  54745. */
  54746. right: Nullable<ArrayBufferView>;
  54747. /**
  54748. * The pixel array for the up face.
  54749. * This is stored in format, left to right, up to down format.
  54750. */
  54751. up: Nullable<ArrayBufferView>;
  54752. /**
  54753. * The pixel array for the down face.
  54754. * This is stored in format, left to right, up to down format.
  54755. */
  54756. down: Nullable<ArrayBufferView>;
  54757. /**
  54758. * The size of the cubemap stored.
  54759. *
  54760. * Each faces will be size * size pixels.
  54761. */
  54762. size: number;
  54763. /**
  54764. * The format of the texture.
  54765. *
  54766. * RGBA, RGB.
  54767. */
  54768. format: number;
  54769. /**
  54770. * The type of the texture data.
  54771. *
  54772. * UNSIGNED_INT, FLOAT.
  54773. */
  54774. type: number;
  54775. /**
  54776. * Specifies whether the texture is in gamma space.
  54777. */
  54778. gammaSpace: boolean;
  54779. }
  54780. /**
  54781. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  54782. */
  54783. export class PanoramaToCubeMapTools {
  54784. private static FACE_LEFT;
  54785. private static FACE_RIGHT;
  54786. private static FACE_FRONT;
  54787. private static FACE_BACK;
  54788. private static FACE_DOWN;
  54789. private static FACE_UP;
  54790. /**
  54791. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  54792. *
  54793. * @param float32Array The source data.
  54794. * @param inputWidth The width of the input panorama.
  54795. * @param inputHeight The height of the input panorama.
  54796. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  54797. * @return The cubemap data
  54798. */
  54799. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  54800. private static CreateCubemapTexture;
  54801. private static CalcProjectionSpherical;
  54802. }
  54803. }
  54804. declare module "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial" {
  54805. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54806. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54807. import { Nullable } from "babylonjs/types";
  54808. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  54809. /**
  54810. * Helper class dealing with the extraction of spherical polynomial dataArray
  54811. * from a cube map.
  54812. */
  54813. export class CubeMapToSphericalPolynomialTools {
  54814. private static FileFaces;
  54815. /**
  54816. * Converts a texture to the according Spherical Polynomial data.
  54817. * This extracts the first 3 orders only as they are the only one used in the lighting.
  54818. *
  54819. * @param texture The texture to extract the information from.
  54820. * @return The Spherical Polynomial data.
  54821. */
  54822. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  54823. /**
  54824. * Converts a cubemap to the according Spherical Polynomial data.
  54825. * This extracts the first 3 orders only as they are the only one used in the lighting.
  54826. *
  54827. * @param cubeInfo The Cube map to extract the information from.
  54828. * @return The Spherical Polynomial data.
  54829. */
  54830. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  54831. }
  54832. }
  54833. declare module "babylonjs/Materials/Textures/baseTexture.polynomial" {
  54834. import { Nullable } from "babylonjs/types";
  54835. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54836. module "babylonjs/Materials/Textures/baseTexture" {
  54837. interface BaseTexture {
  54838. /**
  54839. * Get the polynomial representation of the texture data.
  54840. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  54841. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  54842. */
  54843. sphericalPolynomial: Nullable<SphericalPolynomial>;
  54844. }
  54845. }
  54846. }
  54847. declare module "babylonjs/Shaders/rgbdEncode.fragment" {
  54848. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  54849. /** @hidden */
  54850. export var rgbdEncodePixelShader: {
  54851. name: string;
  54852. shader: string;
  54853. };
  54854. }
  54855. declare module "babylonjs/Shaders/rgbdDecode.fragment" {
  54856. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  54857. /** @hidden */
  54858. export var rgbdDecodePixelShader: {
  54859. name: string;
  54860. shader: string;
  54861. };
  54862. }
  54863. declare module "babylonjs/Misc/environmentTextureTools" {
  54864. import { Nullable } from "babylonjs/types";
  54865. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54866. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54867. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54868. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  54869. import "babylonjs/Engines/Extensions/engine.readTexture";
  54870. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  54871. import "babylonjs/Shaders/rgbdEncode.fragment";
  54872. import "babylonjs/Shaders/rgbdDecode.fragment";
  54873. /**
  54874. * Raw texture data and descriptor sufficient for WebGL texture upload
  54875. */
  54876. export interface EnvironmentTextureInfo {
  54877. /**
  54878. * Version of the environment map
  54879. */
  54880. version: number;
  54881. /**
  54882. * Width of image
  54883. */
  54884. width: number;
  54885. /**
  54886. * Irradiance information stored in the file.
  54887. */
  54888. irradiance: any;
  54889. /**
  54890. * Specular information stored in the file.
  54891. */
  54892. specular: any;
  54893. }
  54894. /**
  54895. * Defines One Image in the file. It requires only the position in the file
  54896. * as well as the length.
  54897. */
  54898. interface BufferImageData {
  54899. /**
  54900. * Length of the image data.
  54901. */
  54902. length: number;
  54903. /**
  54904. * Position of the data from the null terminator delimiting the end of the JSON.
  54905. */
  54906. position: number;
  54907. }
  54908. /**
  54909. * Defines the specular data enclosed in the file.
  54910. * This corresponds to the version 1 of the data.
  54911. */
  54912. export interface EnvironmentTextureSpecularInfoV1 {
  54913. /**
  54914. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  54915. */
  54916. specularDataPosition?: number;
  54917. /**
  54918. * This contains all the images data needed to reconstruct the cubemap.
  54919. */
  54920. mipmaps: Array<BufferImageData>;
  54921. /**
  54922. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  54923. */
  54924. lodGenerationScale: number;
  54925. }
  54926. /**
  54927. * Sets of helpers addressing the serialization and deserialization of environment texture
  54928. * stored in a BabylonJS env file.
  54929. * Those files are usually stored as .env files.
  54930. */
  54931. export class EnvironmentTextureTools {
  54932. /**
  54933. * Magic number identifying the env file.
  54934. */
  54935. private static _MagicBytes;
  54936. /**
  54937. * Gets the environment info from an env file.
  54938. * @param data The array buffer containing the .env bytes.
  54939. * @returns the environment file info (the json header) if successfully parsed.
  54940. */
  54941. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  54942. /**
  54943. * Creates an environment texture from a loaded cube texture.
  54944. * @param texture defines the cube texture to convert in env file
  54945. * @return a promise containing the environment data if succesfull.
  54946. */
  54947. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  54948. /**
  54949. * Creates a JSON representation of the spherical data.
  54950. * @param texture defines the texture containing the polynomials
  54951. * @return the JSON representation of the spherical info
  54952. */
  54953. private static _CreateEnvTextureIrradiance;
  54954. /**
  54955. * Creates the ArrayBufferViews used for initializing environment texture image data.
  54956. * @param data the image data
  54957. * @param info parameters that determine what views will be created for accessing the underlying buffer
  54958. * @return the views described by info providing access to the underlying buffer
  54959. */
  54960. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  54961. /**
  54962. * Uploads the texture info contained in the env file to the GPU.
  54963. * @param texture defines the internal texture to upload to
  54964. * @param data defines the data to load
  54965. * @param info defines the texture info retrieved through the GetEnvInfo method
  54966. * @returns a promise
  54967. */
  54968. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  54969. private static _OnImageReadyAsync;
  54970. /**
  54971. * Uploads the levels of image data to the GPU.
  54972. * @param texture defines the internal texture to upload to
  54973. * @param imageData defines the array buffer views of image data [mipmap][face]
  54974. * @returns a promise
  54975. */
  54976. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  54977. /**
  54978. * Uploads spherical polynomials information to the texture.
  54979. * @param texture defines the texture we are trying to upload the information to
  54980. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  54981. */
  54982. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  54983. /** @hidden */
  54984. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  54985. }
  54986. }
  54987. declare module "babylonjs/Engines/Processors/shaderCodeInliner" {
  54988. /**
  54989. * Class used to inline functions in shader code
  54990. */
  54991. export class ShaderCodeInliner {
  54992. private static readonly _RegexpFindFunctionNameAndType;
  54993. private _sourceCode;
  54994. private _functionDescr;
  54995. private _numMaxIterations;
  54996. /** Gets or sets the token used to mark the functions to inline */
  54997. inlineToken: string;
  54998. /** Gets or sets the debug mode */
  54999. debug: boolean;
  55000. /** Gets the code after the inlining process */
  55001. get code(): string;
  55002. /**
  55003. * Initializes the inliner
  55004. * @param sourceCode shader code source to inline
  55005. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  55006. */
  55007. constructor(sourceCode: string, numMaxIterations?: number);
  55008. /**
  55009. * Start the processing of the shader code
  55010. */
  55011. processCode(): void;
  55012. private _collectFunctions;
  55013. private _processInlining;
  55014. private _extractBetweenMarkers;
  55015. private _skipWhitespaces;
  55016. private _removeComments;
  55017. private _replaceFunctionCallsByCode;
  55018. private _findBackward;
  55019. private _escapeRegExp;
  55020. private _replaceNames;
  55021. }
  55022. }
  55023. declare module "babylonjs/Engines/nativeEngine" {
  55024. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  55025. import { Engine } from "babylonjs/Engines/engine";
  55026. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  55027. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  55028. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  55029. import { Effect } from "babylonjs/Materials/effect";
  55030. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  55031. import { Matrix, Viewport, Color3 } from "babylonjs/Maths/math";
  55032. import { IColor4Like } from "babylonjs/Maths/math.like";
  55033. import { Scene } from "babylonjs/scene";
  55034. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  55035. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  55036. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  55037. /**
  55038. * Container for accessors for natively-stored mesh data buffers.
  55039. */
  55040. class NativeDataBuffer extends DataBuffer {
  55041. /**
  55042. * Accessor value used to identify/retrieve a natively-stored index buffer.
  55043. */
  55044. nativeIndexBuffer?: any;
  55045. /**
  55046. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  55047. */
  55048. nativeVertexBuffer?: any;
  55049. }
  55050. /** @hidden */
  55051. class NativeTexture extends InternalTexture {
  55052. getInternalTexture(): InternalTexture;
  55053. getViewCount(): number;
  55054. }
  55055. /** @hidden */
  55056. export class NativeEngine extends Engine {
  55057. private readonly _native;
  55058. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  55059. private readonly INVALID_HANDLE;
  55060. private _boundBuffersVertexArray;
  55061. private _currentDepthTest;
  55062. getHardwareScalingLevel(): number;
  55063. constructor();
  55064. dispose(): void;
  55065. /**
  55066. * Can be used to override the current requestAnimationFrame requester.
  55067. * @hidden
  55068. */
  55069. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  55070. /**
  55071. * Override default engine behavior.
  55072. * @param color
  55073. * @param backBuffer
  55074. * @param depth
  55075. * @param stencil
  55076. */
  55077. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  55078. /**
  55079. * Gets host document
  55080. * @returns the host document object
  55081. */
  55082. getHostDocument(): Nullable<Document>;
  55083. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  55084. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  55085. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  55086. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  55087. [key: string]: VertexBuffer;
  55088. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  55089. bindBuffers(vertexBuffers: {
  55090. [key: string]: VertexBuffer;
  55091. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  55092. recordVertexArrayObject(vertexBuffers: {
  55093. [key: string]: VertexBuffer;
  55094. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  55095. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  55096. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  55097. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  55098. /**
  55099. * Draw a list of indexed primitives
  55100. * @param fillMode defines the primitive to use
  55101. * @param indexStart defines the starting index
  55102. * @param indexCount defines the number of index to draw
  55103. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  55104. */
  55105. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  55106. /**
  55107. * Draw a list of unindexed primitives
  55108. * @param fillMode defines the primitive to use
  55109. * @param verticesStart defines the index of first vertex to draw
  55110. * @param verticesCount defines the count of vertices to draw
  55111. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  55112. */
  55113. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  55114. createPipelineContext(): IPipelineContext;
  55115. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  55116. /** @hidden */
  55117. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  55118. /** @hidden */
  55119. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  55120. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  55121. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  55122. protected _setProgram(program: WebGLProgram): void;
  55123. _releaseEffect(effect: Effect): void;
  55124. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  55125. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  55126. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  55127. bindSamplers(effect: Effect): void;
  55128. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  55129. getRenderWidth(useScreen?: boolean): number;
  55130. getRenderHeight(useScreen?: boolean): number;
  55131. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  55132. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  55133. /**
  55134. * Set the z offset to apply to current rendering
  55135. * @param value defines the offset to apply
  55136. */
  55137. setZOffset(value: number): void;
  55138. /**
  55139. * Gets the current value of the zOffset
  55140. * @returns the current zOffset state
  55141. */
  55142. getZOffset(): number;
  55143. /**
  55144. * Enable or disable depth buffering
  55145. * @param enable defines the state to set
  55146. */
  55147. setDepthBuffer(enable: boolean): void;
  55148. /**
  55149. * Gets a boolean indicating if depth writing is enabled
  55150. * @returns the current depth writing state
  55151. */
  55152. getDepthWrite(): boolean;
  55153. setDepthFunctionToGreater(): void;
  55154. setDepthFunctionToGreaterOrEqual(): void;
  55155. setDepthFunctionToLess(): void;
  55156. setDepthFunctionToLessOrEqual(): void;
  55157. /**
  55158. * Enable or disable depth writing
  55159. * @param enable defines the state to set
  55160. */
  55161. setDepthWrite(enable: boolean): void;
  55162. /**
  55163. * Enable or disable color writing
  55164. * @param enable defines the state to set
  55165. */
  55166. setColorWrite(enable: boolean): void;
  55167. /**
  55168. * Gets a boolean indicating if color writing is enabled
  55169. * @returns the current color writing state
  55170. */
  55171. getColorWrite(): boolean;
  55172. /**
  55173. * Sets alpha constants used by some alpha blending modes
  55174. * @param r defines the red component
  55175. * @param g defines the green component
  55176. * @param b defines the blue component
  55177. * @param a defines the alpha component
  55178. */
  55179. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  55180. /**
  55181. * Sets the current alpha mode
  55182. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  55183. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  55184. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  55185. */
  55186. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  55187. /**
  55188. * Gets the current alpha mode
  55189. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  55190. * @returns the current alpha mode
  55191. */
  55192. getAlphaMode(): number;
  55193. setInt(uniform: WebGLUniformLocation, int: number): boolean;
  55194. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  55195. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  55196. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  55197. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  55198. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  55199. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  55200. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  55201. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  55202. setArray(uniform: WebGLUniformLocation, array: number[]): boolean;
  55203. setArray2(uniform: WebGLUniformLocation, array: number[]): boolean;
  55204. setArray3(uniform: WebGLUniformLocation, array: number[]): boolean;
  55205. setArray4(uniform: WebGLUniformLocation, array: number[]): boolean;
  55206. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): boolean;
  55207. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  55208. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  55209. setFloat(uniform: WebGLUniformLocation, value: number): boolean;
  55210. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): boolean;
  55211. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): boolean;
  55212. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): boolean;
  55213. setColor3(uniform: WebGLUniformLocation, color3: Color3): boolean;
  55214. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): boolean;
  55215. wipeCaches(bruteForce?: boolean): void;
  55216. _createTexture(): WebGLTexture;
  55217. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  55218. /**
  55219. * Usually called from Texture.ts.
  55220. * Passed information to create a WebGLTexture
  55221. * @param url defines a value which contains one of the following:
  55222. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  55223. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  55224. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  55225. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  55226. * @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)
  55227. * @param scene needed for loading to the correct scene
  55228. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  55229. * @param onLoad optional callback to be called upon successful completion
  55230. * @param onError optional callback to be called upon failure
  55231. * @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
  55232. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  55233. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  55234. * @param forcedExtension defines the extension to use to pick the right loader
  55235. * @param mimeType defines an optional mime type
  55236. * @returns a InternalTexture for assignment back into BABYLON.Texture
  55237. */
  55238. 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;
  55239. /**
  55240. * Creates a cube texture
  55241. * @param rootUrl defines the url where the files to load is located
  55242. * @param scene defines the current scene
  55243. * @param files defines the list of files to load (1 per face)
  55244. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  55245. * @param onLoad defines an optional callback raised when the texture is loaded
  55246. * @param onError defines an optional callback raised if there is an issue to load the texture
  55247. * @param format defines the format of the data
  55248. * @param forcedExtension defines the extension to use to pick the right loader
  55249. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  55250. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  55251. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  55252. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  55253. * @returns the cube texture as an InternalTexture
  55254. */
  55255. 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;
  55256. private _getSamplingFilter;
  55257. private static _GetNativeTextureFormat;
  55258. createRenderTargetTexture(size: number | {
  55259. width: number;
  55260. height: number;
  55261. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  55262. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  55263. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  55264. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  55265. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  55266. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  55267. /**
  55268. * Updates a dynamic vertex buffer.
  55269. * @param vertexBuffer the vertex buffer to update
  55270. * @param data the data used to update the vertex buffer
  55271. * @param byteOffset the byte offset of the data (optional)
  55272. * @param byteLength the byte length of the data (optional)
  55273. */
  55274. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  55275. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  55276. private _updateAnisotropicLevel;
  55277. private _getAddressMode;
  55278. /** @hidden */
  55279. _bindTexture(channel: number, texture: InternalTexture): void;
  55280. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  55281. releaseEffects(): void;
  55282. /** @hidden */
  55283. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55284. /** @hidden */
  55285. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55286. /** @hidden */
  55287. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55288. /** @hidden */
  55289. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  55290. }
  55291. }
  55292. declare module "babylonjs/Engines/index" {
  55293. export * from "babylonjs/Engines/constants";
  55294. export * from "babylonjs/Engines/engineCapabilities";
  55295. export * from "babylonjs/Engines/instancingAttributeInfo";
  55296. export * from "babylonjs/Engines/thinEngine";
  55297. export * from "babylonjs/Engines/engine";
  55298. export * from "babylonjs/Engines/engineStore";
  55299. export * from "babylonjs/Engines/nullEngine";
  55300. export * from "babylonjs/Engines/Extensions/index";
  55301. export * from "babylonjs/Engines/IPipelineContext";
  55302. export * from "babylonjs/Engines/WebGL/webGLPipelineContext";
  55303. export * from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  55304. export * from "babylonjs/Engines/nativeEngine";
  55305. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  55306. export * from "babylonjs/Engines/performanceConfigurator";
  55307. }
  55308. declare module "babylonjs/Events/clipboardEvents" {
  55309. /**
  55310. * Gather the list of clipboard event types as constants.
  55311. */
  55312. export class ClipboardEventTypes {
  55313. /**
  55314. * The clipboard event is fired when a copy command is active (pressed).
  55315. */
  55316. static readonly COPY: number;
  55317. /**
  55318. * The clipboard event is fired when a cut command is active (pressed).
  55319. */
  55320. static readonly CUT: number;
  55321. /**
  55322. * The clipboard event is fired when a paste command is active (pressed).
  55323. */
  55324. static readonly PASTE: number;
  55325. }
  55326. /**
  55327. * This class is used to store clipboard related info for the onClipboardObservable event.
  55328. */
  55329. export class ClipboardInfo {
  55330. /**
  55331. * Defines the type of event (BABYLON.ClipboardEventTypes)
  55332. */
  55333. type: number;
  55334. /**
  55335. * Defines the related dom event
  55336. */
  55337. event: ClipboardEvent;
  55338. /**
  55339. *Creates an instance of ClipboardInfo.
  55340. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  55341. * @param event Defines the related dom event
  55342. */
  55343. constructor(
  55344. /**
  55345. * Defines the type of event (BABYLON.ClipboardEventTypes)
  55346. */
  55347. type: number,
  55348. /**
  55349. * Defines the related dom event
  55350. */
  55351. event: ClipboardEvent);
  55352. /**
  55353. * Get the clipboard event's type from the keycode.
  55354. * @param keyCode Defines the keyCode for the current keyboard event.
  55355. * @return {number}
  55356. */
  55357. static GetTypeFromCharacter(keyCode: number): number;
  55358. }
  55359. }
  55360. declare module "babylonjs/Events/index" {
  55361. export * from "babylonjs/Events/keyboardEvents";
  55362. export * from "babylonjs/Events/pointerEvents";
  55363. export * from "babylonjs/Events/clipboardEvents";
  55364. }
  55365. declare module "babylonjs/Gamepads/Controllers/daydreamController" {
  55366. import { Scene } from "babylonjs/scene";
  55367. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55368. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55369. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55370. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55371. /**
  55372. * Google Daydream controller
  55373. */
  55374. export class DaydreamController extends WebVRController {
  55375. /**
  55376. * Base Url for the controller model.
  55377. */
  55378. static MODEL_BASE_URL: string;
  55379. /**
  55380. * File name for the controller model.
  55381. */
  55382. static MODEL_FILENAME: string;
  55383. /**
  55384. * Gamepad Id prefix used to identify Daydream Controller.
  55385. */
  55386. static readonly GAMEPAD_ID_PREFIX: string;
  55387. /**
  55388. * Creates a new DaydreamController from a gamepad
  55389. * @param vrGamepad the gamepad that the controller should be created from
  55390. */
  55391. constructor(vrGamepad: any);
  55392. /**
  55393. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55394. * @param scene scene in which to add meshes
  55395. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55396. */
  55397. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55398. /**
  55399. * Called once for each button that changed state since the last frame
  55400. * @param buttonIdx Which button index changed
  55401. * @param state New state of the button
  55402. * @param changes Which properties on the state changed since last frame
  55403. */
  55404. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55405. }
  55406. }
  55407. declare module "babylonjs/Gamepads/Controllers/gearVRController" {
  55408. import { Scene } from "babylonjs/scene";
  55409. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55410. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55411. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55412. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55413. /**
  55414. * Gear VR Controller
  55415. */
  55416. export class GearVRController extends WebVRController {
  55417. /**
  55418. * Base Url for the controller model.
  55419. */
  55420. static MODEL_BASE_URL: string;
  55421. /**
  55422. * File name for the controller model.
  55423. */
  55424. static MODEL_FILENAME: string;
  55425. /**
  55426. * Gamepad Id prefix used to identify this controller.
  55427. */
  55428. static readonly GAMEPAD_ID_PREFIX: string;
  55429. private readonly _buttonIndexToObservableNameMap;
  55430. /**
  55431. * Creates a new GearVRController from a gamepad
  55432. * @param vrGamepad the gamepad that the controller should be created from
  55433. */
  55434. constructor(vrGamepad: any);
  55435. /**
  55436. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55437. * @param scene scene in which to add meshes
  55438. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55439. */
  55440. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55441. /**
  55442. * Called once for each button that changed state since the last frame
  55443. * @param buttonIdx Which button index changed
  55444. * @param state New state of the button
  55445. * @param changes Which properties on the state changed since last frame
  55446. */
  55447. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55448. }
  55449. }
  55450. declare module "babylonjs/Gamepads/Controllers/genericController" {
  55451. import { Scene } from "babylonjs/scene";
  55452. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55453. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55454. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55455. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55456. /**
  55457. * Generic Controller
  55458. */
  55459. export class GenericController extends WebVRController {
  55460. /**
  55461. * Base Url for the controller model.
  55462. */
  55463. static readonly MODEL_BASE_URL: string;
  55464. /**
  55465. * File name for the controller model.
  55466. */
  55467. static readonly MODEL_FILENAME: string;
  55468. /**
  55469. * Creates a new GenericController from a gamepad
  55470. * @param vrGamepad the gamepad that the controller should be created from
  55471. */
  55472. constructor(vrGamepad: any);
  55473. /**
  55474. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55475. * @param scene scene in which to add meshes
  55476. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55477. */
  55478. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55479. /**
  55480. * Called once for each button that changed state since the last frame
  55481. * @param buttonIdx Which button index changed
  55482. * @param state New state of the button
  55483. * @param changes Which properties on the state changed since last frame
  55484. */
  55485. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55486. }
  55487. }
  55488. declare module "babylonjs/Gamepads/Controllers/oculusTouchController" {
  55489. import { Observable } from "babylonjs/Misc/observable";
  55490. import { Scene } from "babylonjs/scene";
  55491. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55492. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55493. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55494. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55495. /**
  55496. * Oculus Touch Controller
  55497. */
  55498. export class OculusTouchController extends WebVRController {
  55499. /**
  55500. * Base Url for the controller model.
  55501. */
  55502. static MODEL_BASE_URL: string;
  55503. /**
  55504. * File name for the left controller model.
  55505. */
  55506. static MODEL_LEFT_FILENAME: string;
  55507. /**
  55508. * File name for the right controller model.
  55509. */
  55510. static MODEL_RIGHT_FILENAME: string;
  55511. /**
  55512. * Base Url for the Quest controller model.
  55513. */
  55514. static QUEST_MODEL_BASE_URL: string;
  55515. /**
  55516. * @hidden
  55517. * If the controllers are running on a device that needs the updated Quest controller models
  55518. */
  55519. static _IsQuest: boolean;
  55520. /**
  55521. * Fired when the secondary trigger on this controller is modified
  55522. */
  55523. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  55524. /**
  55525. * Fired when the thumb rest on this controller is modified
  55526. */
  55527. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  55528. /**
  55529. * Creates a new OculusTouchController from a gamepad
  55530. * @param vrGamepad the gamepad that the controller should be created from
  55531. */
  55532. constructor(vrGamepad: any);
  55533. /**
  55534. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55535. * @param scene scene in which to add meshes
  55536. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55537. */
  55538. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55539. /**
  55540. * Fired when the A button on this controller is modified
  55541. */
  55542. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55543. /**
  55544. * Fired when the B button on this controller is modified
  55545. */
  55546. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55547. /**
  55548. * Fired when the X button on this controller is modified
  55549. */
  55550. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55551. /**
  55552. * Fired when the Y button on this controller is modified
  55553. */
  55554. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55555. /**
  55556. * Called once for each button that changed state since the last frame
  55557. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  55558. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  55559. * 2) secondary trigger (same)
  55560. * 3) A (right) X (left), touch, pressed = value
  55561. * 4) B / Y
  55562. * 5) thumb rest
  55563. * @param buttonIdx Which button index changed
  55564. * @param state New state of the button
  55565. * @param changes Which properties on the state changed since last frame
  55566. */
  55567. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55568. }
  55569. }
  55570. declare module "babylonjs/Gamepads/Controllers/viveController" {
  55571. import { Scene } from "babylonjs/scene";
  55572. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55573. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55574. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55575. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55576. import { Observable } from "babylonjs/Misc/observable";
  55577. /**
  55578. * Vive Controller
  55579. */
  55580. export class ViveController extends WebVRController {
  55581. /**
  55582. * Base Url for the controller model.
  55583. */
  55584. static MODEL_BASE_URL: string;
  55585. /**
  55586. * File name for the controller model.
  55587. */
  55588. static MODEL_FILENAME: string;
  55589. /**
  55590. * Creates a new ViveController from a gamepad
  55591. * @param vrGamepad the gamepad that the controller should be created from
  55592. */
  55593. constructor(vrGamepad: any);
  55594. /**
  55595. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55596. * @param scene scene in which to add meshes
  55597. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55598. */
  55599. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55600. /**
  55601. * Fired when the left button on this controller is modified
  55602. */
  55603. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55604. /**
  55605. * Fired when the right button on this controller is modified
  55606. */
  55607. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55608. /**
  55609. * Fired when the menu button on this controller is modified
  55610. */
  55611. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55612. /**
  55613. * Called once for each button that changed state since the last frame
  55614. * Vive mapping:
  55615. * 0: touchpad
  55616. * 1: trigger
  55617. * 2: left AND right buttons
  55618. * 3: menu button
  55619. * @param buttonIdx Which button index changed
  55620. * @param state New state of the button
  55621. * @param changes Which properties on the state changed since last frame
  55622. */
  55623. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55624. }
  55625. }
  55626. declare module "babylonjs/Gamepads/Controllers/windowsMotionController" {
  55627. import { Observable } from "babylonjs/Misc/observable";
  55628. import { Scene } from "babylonjs/scene";
  55629. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55630. import { Ray } from "babylonjs/Culling/ray";
  55631. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55632. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55633. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55634. /**
  55635. * Defines the WindowsMotionController object that the state of the windows motion controller
  55636. */
  55637. export class WindowsMotionController extends WebVRController {
  55638. /**
  55639. * The base url used to load the left and right controller models
  55640. */
  55641. static MODEL_BASE_URL: string;
  55642. /**
  55643. * The name of the left controller model file
  55644. */
  55645. static MODEL_LEFT_FILENAME: string;
  55646. /**
  55647. * The name of the right controller model file
  55648. */
  55649. static MODEL_RIGHT_FILENAME: string;
  55650. /**
  55651. * The controller name prefix for this controller type
  55652. */
  55653. static readonly GAMEPAD_ID_PREFIX: string;
  55654. /**
  55655. * The controller id pattern for this controller type
  55656. */
  55657. private static readonly GAMEPAD_ID_PATTERN;
  55658. private _loadedMeshInfo;
  55659. protected readonly _mapping: {
  55660. buttons: string[];
  55661. buttonMeshNames: {
  55662. trigger: string;
  55663. menu: string;
  55664. grip: string;
  55665. thumbstick: string;
  55666. trackpad: string;
  55667. };
  55668. buttonObservableNames: {
  55669. trigger: string;
  55670. menu: string;
  55671. grip: string;
  55672. thumbstick: string;
  55673. trackpad: string;
  55674. };
  55675. axisMeshNames: string[];
  55676. pointingPoseMeshName: string;
  55677. };
  55678. /**
  55679. * Fired when the trackpad on this controller is clicked
  55680. */
  55681. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  55682. /**
  55683. * Fired when the trackpad on this controller is modified
  55684. */
  55685. onTrackpadValuesChangedObservable: Observable<StickValues>;
  55686. /**
  55687. * The current x and y values of this controller's trackpad
  55688. */
  55689. trackpad: StickValues;
  55690. /**
  55691. * Creates a new WindowsMotionController from a gamepad
  55692. * @param vrGamepad the gamepad that the controller should be created from
  55693. */
  55694. constructor(vrGamepad: any);
  55695. /**
  55696. * Fired when the trigger on this controller is modified
  55697. */
  55698. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55699. /**
  55700. * Fired when the menu button on this controller is modified
  55701. */
  55702. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55703. /**
  55704. * Fired when the grip button on this controller is modified
  55705. */
  55706. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55707. /**
  55708. * Fired when the thumbstick button on this controller is modified
  55709. */
  55710. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55711. /**
  55712. * Fired when the touchpad button on this controller is modified
  55713. */
  55714. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55715. /**
  55716. * Fired when the touchpad values on this controller are modified
  55717. */
  55718. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  55719. protected _updateTrackpad(): void;
  55720. /**
  55721. * Called once per frame by the engine.
  55722. */
  55723. update(): void;
  55724. /**
  55725. * Called once for each button that changed state since the last frame
  55726. * @param buttonIdx Which button index changed
  55727. * @param state New state of the button
  55728. * @param changes Which properties on the state changed since last frame
  55729. */
  55730. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55731. /**
  55732. * Moves the buttons on the controller mesh based on their current state
  55733. * @param buttonName the name of the button to move
  55734. * @param buttonValue the value of the button which determines the buttons new position
  55735. */
  55736. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  55737. /**
  55738. * Moves the axis on the controller mesh based on its current state
  55739. * @param axis the index of the axis
  55740. * @param axisValue the value of the axis which determines the meshes new position
  55741. * @hidden
  55742. */
  55743. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  55744. /**
  55745. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55746. * @param scene scene in which to add meshes
  55747. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55748. */
  55749. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  55750. /**
  55751. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  55752. * can be transformed by button presses and axes values, based on this._mapping.
  55753. *
  55754. * @param scene scene in which the meshes exist
  55755. * @param meshes list of meshes that make up the controller model to process
  55756. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  55757. */
  55758. private processModel;
  55759. private createMeshInfo;
  55760. /**
  55761. * Gets the ray of the controller in the direction the controller is pointing
  55762. * @param length the length the resulting ray should be
  55763. * @returns a ray in the direction the controller is pointing
  55764. */
  55765. getForwardRay(length?: number): Ray;
  55766. /**
  55767. * Disposes of the controller
  55768. */
  55769. dispose(): void;
  55770. }
  55771. /**
  55772. * This class represents a new windows motion controller in XR.
  55773. */
  55774. export class XRWindowsMotionController extends WindowsMotionController {
  55775. /**
  55776. * Changing the original WIndowsMotionController mapping to fir the new mapping
  55777. */
  55778. protected readonly _mapping: {
  55779. buttons: string[];
  55780. buttonMeshNames: {
  55781. trigger: string;
  55782. menu: string;
  55783. grip: string;
  55784. thumbstick: string;
  55785. trackpad: string;
  55786. };
  55787. buttonObservableNames: {
  55788. trigger: string;
  55789. menu: string;
  55790. grip: string;
  55791. thumbstick: string;
  55792. trackpad: string;
  55793. };
  55794. axisMeshNames: string[];
  55795. pointingPoseMeshName: string;
  55796. };
  55797. /**
  55798. * Construct a new XR-Based windows motion controller
  55799. *
  55800. * @param gamepadInfo the gamepad object from the browser
  55801. */
  55802. constructor(gamepadInfo: any);
  55803. /**
  55804. * holds the thumbstick values (X,Y)
  55805. */
  55806. thumbstickValues: StickValues;
  55807. /**
  55808. * Fired when the thumbstick on this controller is clicked
  55809. */
  55810. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  55811. /**
  55812. * Fired when the thumbstick on this controller is modified
  55813. */
  55814. onThumbstickValuesChangedObservable: Observable<StickValues>;
  55815. /**
  55816. * Fired when the touchpad button on this controller is modified
  55817. */
  55818. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  55819. /**
  55820. * Fired when the touchpad values on this controller are modified
  55821. */
  55822. onTrackpadValuesChangedObservable: Observable<StickValues>;
  55823. /**
  55824. * Fired when the thumbstick button on this controller is modified
  55825. * here to prevent breaking changes
  55826. */
  55827. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55828. /**
  55829. * updating the thumbstick(!) and not the trackpad.
  55830. * This is named this way due to the difference between WebVR and XR and to avoid
  55831. * changing the parent class.
  55832. */
  55833. protected _updateTrackpad(): void;
  55834. /**
  55835. * Disposes the class with joy
  55836. */
  55837. dispose(): void;
  55838. }
  55839. }
  55840. declare module "babylonjs/Gamepads/Controllers/index" {
  55841. export * from "babylonjs/Gamepads/Controllers/daydreamController";
  55842. export * from "babylonjs/Gamepads/Controllers/gearVRController";
  55843. export * from "babylonjs/Gamepads/Controllers/genericController";
  55844. export * from "babylonjs/Gamepads/Controllers/oculusTouchController";
  55845. export * from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55846. export * from "babylonjs/Gamepads/Controllers/viveController";
  55847. export * from "babylonjs/Gamepads/Controllers/webVRController";
  55848. export * from "babylonjs/Gamepads/Controllers/windowsMotionController";
  55849. }
  55850. declare module "babylonjs/Gamepads/index" {
  55851. export * from "babylonjs/Gamepads/Controllers/index";
  55852. export * from "babylonjs/Gamepads/gamepad";
  55853. export * from "babylonjs/Gamepads/gamepadManager";
  55854. export * from "babylonjs/Gamepads/gamepadSceneComponent";
  55855. export * from "babylonjs/Gamepads/xboxGamepad";
  55856. export * from "babylonjs/Gamepads/dualShockGamepad";
  55857. }
  55858. declare module "babylonjs/Meshes/Builders/polyhedronBuilder" {
  55859. import { Scene } from "babylonjs/scene";
  55860. import { Vector4 } from "babylonjs/Maths/math.vector";
  55861. import { Color4 } from "babylonjs/Maths/math.color";
  55862. import { Mesh } from "babylonjs/Meshes/mesh";
  55863. import { Nullable } from "babylonjs/types";
  55864. /**
  55865. * Class containing static functions to help procedurally build meshes
  55866. */
  55867. export class PolyhedronBuilder {
  55868. /**
  55869. * Creates a polyhedron mesh
  55870. * * 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
  55871. * * The parameter `size` (positive float, default 1) sets the polygon size
  55872. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  55873. * * 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`
  55874. * * 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
  55875. * * 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)`)
  55876. * * 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
  55877. * * 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
  55878. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  55879. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  55880. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  55881. * @param name defines the name of the mesh
  55882. * @param options defines the options used to create the mesh
  55883. * @param scene defines the hosting scene
  55884. * @returns the polyhedron mesh
  55885. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  55886. */
  55887. static CreatePolyhedron(name: string, options: {
  55888. type?: number;
  55889. size?: number;
  55890. sizeX?: number;
  55891. sizeY?: number;
  55892. sizeZ?: number;
  55893. custom?: any;
  55894. faceUV?: Vector4[];
  55895. faceColors?: Color4[];
  55896. flat?: boolean;
  55897. updatable?: boolean;
  55898. sideOrientation?: number;
  55899. frontUVs?: Vector4;
  55900. backUVs?: Vector4;
  55901. }, scene?: Nullable<Scene>): Mesh;
  55902. }
  55903. }
  55904. declare module "babylonjs/Gizmos/scaleGizmo" {
  55905. import { Observable } from "babylonjs/Misc/observable";
  55906. import { Nullable } from "babylonjs/types";
  55907. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55908. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55909. import { AxisScaleGizmo } from "babylonjs/Gizmos/axisScaleGizmo";
  55910. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55911. import { Node } from "babylonjs/node";
  55912. /**
  55913. * Gizmo that enables scaling a mesh along 3 axis
  55914. */
  55915. export class ScaleGizmo extends Gizmo {
  55916. /**
  55917. * Internal gizmo used for interactions on the x axis
  55918. */
  55919. xGizmo: AxisScaleGizmo;
  55920. /**
  55921. * Internal gizmo used for interactions on the y axis
  55922. */
  55923. yGizmo: AxisScaleGizmo;
  55924. /**
  55925. * Internal gizmo used for interactions on the z axis
  55926. */
  55927. zGizmo: AxisScaleGizmo;
  55928. /**
  55929. * Internal gizmo used to scale all axis equally
  55930. */
  55931. uniformScaleGizmo: AxisScaleGizmo;
  55932. private _meshAttached;
  55933. private _nodeAttached;
  55934. private _snapDistance;
  55935. private _uniformScalingMesh;
  55936. private _octahedron;
  55937. private _sensitivity;
  55938. /** Fires an event when any of it's sub gizmos are dragged */
  55939. onDragStartObservable: Observable<unknown>;
  55940. /** Fires an event when any of it's sub gizmos are released from dragging */
  55941. onDragEndObservable: Observable<unknown>;
  55942. get attachedMesh(): Nullable<AbstractMesh>;
  55943. set attachedMesh(mesh: Nullable<AbstractMesh>);
  55944. get attachedNode(): Nullable<Node>;
  55945. set attachedNode(node: Nullable<Node>);
  55946. /**
  55947. * True when the mouse pointer is hovering a gizmo mesh
  55948. */
  55949. get isHovered(): boolean;
  55950. /**
  55951. * Creates a ScaleGizmo
  55952. * @param gizmoLayer The utility layer the gizmo will be added to
  55953. * @param thickness display gizmo axis thickness
  55954. */
  55955. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  55956. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  55957. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  55958. /**
  55959. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55960. */
  55961. set snapDistance(value: number);
  55962. get snapDistance(): number;
  55963. /**
  55964. * Ratio for the scale of the gizmo (Default: 1)
  55965. */
  55966. set scaleRatio(value: number);
  55967. get scaleRatio(): number;
  55968. /**
  55969. * Sensitivity factor for dragging (Default: 1)
  55970. */
  55971. set sensitivity(value: number);
  55972. get sensitivity(): number;
  55973. /**
  55974. * Disposes of the gizmo
  55975. */
  55976. dispose(): void;
  55977. }
  55978. }
  55979. declare module "babylonjs/Gizmos/axisScaleGizmo" {
  55980. import { Observable } from "babylonjs/Misc/observable";
  55981. import { Nullable } from "babylonjs/types";
  55982. import { Vector3 } from "babylonjs/Maths/math.vector";
  55983. import { Node } from "babylonjs/node";
  55984. import { Mesh } from "babylonjs/Meshes/mesh";
  55985. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  55986. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55987. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55988. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  55989. import { Color3 } from "babylonjs/Maths/math.color";
  55990. /**
  55991. * Single axis scale gizmo
  55992. */
  55993. export class AxisScaleGizmo extends Gizmo {
  55994. /**
  55995. * Drag behavior responsible for the gizmos dragging interactions
  55996. */
  55997. dragBehavior: PointerDragBehavior;
  55998. private _pointerObserver;
  55999. /**
  56000. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  56001. */
  56002. snapDistance: number;
  56003. /**
  56004. * Event that fires each time the gizmo snaps to a new location.
  56005. * * snapDistance is the the change in distance
  56006. */
  56007. onSnapObservable: Observable<{
  56008. snapDistance: number;
  56009. }>;
  56010. /**
  56011. * If the scaling operation should be done on all axis (default: false)
  56012. */
  56013. uniformScaling: boolean;
  56014. /**
  56015. * Custom sensitivity value for the drag strength
  56016. */
  56017. sensitivity: number;
  56018. private _isEnabled;
  56019. private _parent;
  56020. private _arrow;
  56021. private _coloredMaterial;
  56022. private _hoverMaterial;
  56023. /**
  56024. * Creates an AxisScaleGizmo
  56025. * @param gizmoLayer The utility layer the gizmo will be added to
  56026. * @param dragAxis The axis which the gizmo will be able to scale on
  56027. * @param color The color of the gizmo
  56028. * @param thickness display gizmo axis thickness
  56029. */
  56030. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  56031. protected _attachedNodeChanged(value: Nullable<Node>): void;
  56032. /**
  56033. * If the gizmo is enabled
  56034. */
  56035. set isEnabled(value: boolean);
  56036. get isEnabled(): boolean;
  56037. /**
  56038. * Disposes of the gizmo
  56039. */
  56040. dispose(): void;
  56041. /**
  56042. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  56043. * @param mesh The mesh to replace the default mesh of the gizmo
  56044. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  56045. */
  56046. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  56047. }
  56048. }
  56049. declare module "babylonjs/Gizmos/boundingBoxGizmo" {
  56050. import { Observable } from "babylonjs/Misc/observable";
  56051. import { Nullable } from "babylonjs/types";
  56052. import { Vector3 } from "babylonjs/Maths/math.vector";
  56053. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56054. import { Mesh } from "babylonjs/Meshes/mesh";
  56055. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56056. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56057. import { Color3 } from "babylonjs/Maths/math.color";
  56058. import "babylonjs/Meshes/Builders/boxBuilder";
  56059. /**
  56060. * Bounding box gizmo
  56061. */
  56062. export class BoundingBoxGizmo extends Gizmo {
  56063. private _lineBoundingBox;
  56064. private _rotateSpheresParent;
  56065. private _scaleBoxesParent;
  56066. private _boundingDimensions;
  56067. private _renderObserver;
  56068. private _pointerObserver;
  56069. private _scaleDragSpeed;
  56070. private _tmpQuaternion;
  56071. private _tmpVector;
  56072. private _tmpRotationMatrix;
  56073. /**
  56074. * 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)
  56075. */
  56076. ignoreChildren: boolean;
  56077. /**
  56078. * 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)
  56079. */
  56080. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  56081. /**
  56082. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  56083. */
  56084. rotationSphereSize: number;
  56085. /**
  56086. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  56087. */
  56088. scaleBoxSize: number;
  56089. /**
  56090. * 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)
  56091. */
  56092. fixedDragMeshScreenSize: boolean;
  56093. /**
  56094. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  56095. */
  56096. fixedDragMeshScreenSizeDistanceFactor: number;
  56097. /**
  56098. * Fired when a rotation sphere or scale box is dragged
  56099. */
  56100. onDragStartObservable: Observable<{}>;
  56101. /**
  56102. * Fired when a scale box is dragged
  56103. */
  56104. onScaleBoxDragObservable: Observable<{}>;
  56105. /**
  56106. * Fired when a scale box drag is ended
  56107. */
  56108. onScaleBoxDragEndObservable: Observable<{}>;
  56109. /**
  56110. * Fired when a rotation sphere is dragged
  56111. */
  56112. onRotationSphereDragObservable: Observable<{}>;
  56113. /**
  56114. * Fired when a rotation sphere drag is ended
  56115. */
  56116. onRotationSphereDragEndObservable: Observable<{}>;
  56117. /**
  56118. * 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)
  56119. */
  56120. scalePivot: Nullable<Vector3>;
  56121. /**
  56122. * Mesh used as a pivot to rotate the attached node
  56123. */
  56124. private _anchorMesh;
  56125. private _existingMeshScale;
  56126. private _dragMesh;
  56127. private pointerDragBehavior;
  56128. private coloredMaterial;
  56129. private hoverColoredMaterial;
  56130. /**
  56131. * Sets the color of the bounding box gizmo
  56132. * @param color the color to set
  56133. */
  56134. setColor(color: Color3): void;
  56135. /**
  56136. * Creates an BoundingBoxGizmo
  56137. * @param gizmoLayer The utility layer the gizmo will be added to
  56138. * @param color The color of the gizmo
  56139. */
  56140. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  56141. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  56142. private _selectNode;
  56143. /**
  56144. * Updates the bounding box information for the Gizmo
  56145. */
  56146. updateBoundingBox(): void;
  56147. private _updateRotationSpheres;
  56148. private _updateScaleBoxes;
  56149. /**
  56150. * Enables rotation on the specified axis and disables rotation on the others
  56151. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  56152. */
  56153. setEnabledRotationAxis(axis: string): void;
  56154. /**
  56155. * Enables/disables scaling
  56156. * @param enable if scaling should be enabled
  56157. * @param homogeneousScaling defines if scaling should only be homogeneous
  56158. */
  56159. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  56160. private _updateDummy;
  56161. /**
  56162. * Enables a pointer drag behavior on the bounding box of the gizmo
  56163. */
  56164. enableDragBehavior(): void;
  56165. /**
  56166. * Disposes of the gizmo
  56167. */
  56168. dispose(): void;
  56169. /**
  56170. * 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)
  56171. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  56172. * @returns the bounding box mesh with the passed in mesh as a child
  56173. */
  56174. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  56175. /**
  56176. * CustomMeshes are not supported by this gizmo
  56177. * @param mesh The mesh to replace the default mesh of the gizmo
  56178. */
  56179. setCustomMesh(mesh: Mesh): void;
  56180. }
  56181. }
  56182. declare module "babylonjs/Gizmos/planeRotationGizmo" {
  56183. import { Observable } from "babylonjs/Misc/observable";
  56184. import { Nullable } from "babylonjs/types";
  56185. import { Vector3 } from "babylonjs/Maths/math.vector";
  56186. import { Color3 } from "babylonjs/Maths/math.color";
  56187. import { Node } from "babylonjs/node";
  56188. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  56189. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56190. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56191. import "babylonjs/Meshes/Builders/linesBuilder";
  56192. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  56193. /**
  56194. * Single plane rotation gizmo
  56195. */
  56196. export class PlaneRotationGizmo extends Gizmo {
  56197. /**
  56198. * Drag behavior responsible for the gizmos dragging interactions
  56199. */
  56200. dragBehavior: PointerDragBehavior;
  56201. private _pointerObserver;
  56202. /**
  56203. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  56204. */
  56205. snapDistance: number;
  56206. /**
  56207. * Event that fires each time the gizmo snaps to a new location.
  56208. * * snapDistance is the the change in distance
  56209. */
  56210. onSnapObservable: Observable<{
  56211. snapDistance: number;
  56212. }>;
  56213. private _isEnabled;
  56214. private _parent;
  56215. /**
  56216. * Creates a PlaneRotationGizmo
  56217. * @param gizmoLayer The utility layer the gizmo will be added to
  56218. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  56219. * @param color The color of the gizmo
  56220. * @param tessellation Amount of tessellation to be used when creating rotation circles
  56221. * @param useEulerRotation Use and update Euler angle instead of quaternion
  56222. * @param thickness display gizmo axis thickness
  56223. */
  56224. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  56225. protected _attachedNodeChanged(value: Nullable<Node>): void;
  56226. /**
  56227. * If the gizmo is enabled
  56228. */
  56229. set isEnabled(value: boolean);
  56230. get isEnabled(): boolean;
  56231. /**
  56232. * Disposes of the gizmo
  56233. */
  56234. dispose(): void;
  56235. }
  56236. }
  56237. declare module "babylonjs/Gizmos/rotationGizmo" {
  56238. import { Observable } from "babylonjs/Misc/observable";
  56239. import { Nullable } from "babylonjs/types";
  56240. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56241. import { Mesh } from "babylonjs/Meshes/mesh";
  56242. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56243. import { PlaneRotationGizmo } from "babylonjs/Gizmos/planeRotationGizmo";
  56244. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56245. import { Node } from "babylonjs/node";
  56246. /**
  56247. * Gizmo that enables rotating a mesh along 3 axis
  56248. */
  56249. export class RotationGizmo extends Gizmo {
  56250. /**
  56251. * Internal gizmo used for interactions on the x axis
  56252. */
  56253. xGizmo: PlaneRotationGizmo;
  56254. /**
  56255. * Internal gizmo used for interactions on the y axis
  56256. */
  56257. yGizmo: PlaneRotationGizmo;
  56258. /**
  56259. * Internal gizmo used for interactions on the z axis
  56260. */
  56261. zGizmo: PlaneRotationGizmo;
  56262. /** Fires an event when any of it's sub gizmos are dragged */
  56263. onDragStartObservable: Observable<unknown>;
  56264. /** Fires an event when any of it's sub gizmos are released from dragging */
  56265. onDragEndObservable: Observable<unknown>;
  56266. private _meshAttached;
  56267. private _nodeAttached;
  56268. get attachedMesh(): Nullable<AbstractMesh>;
  56269. set attachedMesh(mesh: Nullable<AbstractMesh>);
  56270. get attachedNode(): Nullable<Node>;
  56271. set attachedNode(node: Nullable<Node>);
  56272. /**
  56273. * True when the mouse pointer is hovering a gizmo mesh
  56274. */
  56275. get isHovered(): boolean;
  56276. /**
  56277. * Creates a RotationGizmo
  56278. * @param gizmoLayer The utility layer the gizmo will be added to
  56279. * @param tessellation Amount of tessellation to be used when creating rotation circles
  56280. * @param useEulerRotation Use and update Euler angle instead of quaternion
  56281. * @param thickness display gizmo axis thickness
  56282. */
  56283. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  56284. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  56285. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  56286. /**
  56287. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  56288. */
  56289. set snapDistance(value: number);
  56290. get snapDistance(): number;
  56291. /**
  56292. * Ratio for the scale of the gizmo (Default: 1)
  56293. */
  56294. set scaleRatio(value: number);
  56295. get scaleRatio(): number;
  56296. /**
  56297. * Disposes of the gizmo
  56298. */
  56299. dispose(): void;
  56300. /**
  56301. * CustomMeshes are not supported by this gizmo
  56302. * @param mesh The mesh to replace the default mesh of the gizmo
  56303. */
  56304. setCustomMesh(mesh: Mesh): void;
  56305. }
  56306. }
  56307. declare module "babylonjs/Gizmos/gizmoManager" {
  56308. import { Observable } from "babylonjs/Misc/observable";
  56309. import { Nullable } from "babylonjs/types";
  56310. import { Scene, IDisposable } from "babylonjs/scene";
  56311. import { Node } from "babylonjs/node";
  56312. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56313. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56314. import { SixDofDragBehavior } from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  56315. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  56316. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  56317. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  56318. import { BoundingBoxGizmo } from "babylonjs/Gizmos/boundingBoxGizmo";
  56319. /**
  56320. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  56321. */
  56322. export class GizmoManager implements IDisposable {
  56323. private scene;
  56324. /**
  56325. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  56326. */
  56327. gizmos: {
  56328. positionGizmo: Nullable<PositionGizmo>;
  56329. rotationGizmo: Nullable<RotationGizmo>;
  56330. scaleGizmo: Nullable<ScaleGizmo>;
  56331. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  56332. };
  56333. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  56334. clearGizmoOnEmptyPointerEvent: boolean;
  56335. /** Fires an event when the manager is attached to a mesh */
  56336. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  56337. /** Fires an event when the manager is attached to a node */
  56338. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  56339. private _gizmosEnabled;
  56340. private _pointerObserver;
  56341. private _attachedMesh;
  56342. private _attachedNode;
  56343. private _boundingBoxColor;
  56344. private _defaultUtilityLayer;
  56345. private _defaultKeepDepthUtilityLayer;
  56346. private _thickness;
  56347. /**
  56348. * When bounding box gizmo is enabled, this can be used to track drag/end events
  56349. */
  56350. boundingBoxDragBehavior: SixDofDragBehavior;
  56351. /**
  56352. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  56353. */
  56354. attachableMeshes: Nullable<Array<AbstractMesh>>;
  56355. /**
  56356. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  56357. */
  56358. attachableNodes: Nullable<Array<Node>>;
  56359. /**
  56360. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  56361. */
  56362. usePointerToAttachGizmos: boolean;
  56363. /**
  56364. * Utility layer that the bounding box gizmo belongs to
  56365. */
  56366. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  56367. /**
  56368. * Utility layer that all gizmos besides bounding box belong to
  56369. */
  56370. get utilityLayer(): UtilityLayerRenderer;
  56371. /**
  56372. * True when the mouse pointer is hovering a gizmo mesh
  56373. */
  56374. get isHovered(): boolean;
  56375. /**
  56376. * Instatiates a gizmo manager
  56377. * @param scene the scene to overlay the gizmos on top of
  56378. * @param thickness display gizmo axis thickness
  56379. */
  56380. constructor(scene: Scene, thickness?: number);
  56381. /**
  56382. * Attaches a set of gizmos to the specified mesh
  56383. * @param mesh The mesh the gizmo's should be attached to
  56384. */
  56385. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  56386. /**
  56387. * Attaches a set of gizmos to the specified node
  56388. * @param node The node the gizmo's should be attached to
  56389. */
  56390. attachToNode(node: Nullable<Node>): void;
  56391. /**
  56392. * If the position gizmo is enabled
  56393. */
  56394. set positionGizmoEnabled(value: boolean);
  56395. get positionGizmoEnabled(): boolean;
  56396. /**
  56397. * If the rotation gizmo is enabled
  56398. */
  56399. set rotationGizmoEnabled(value: boolean);
  56400. get rotationGizmoEnabled(): boolean;
  56401. /**
  56402. * If the scale gizmo is enabled
  56403. */
  56404. set scaleGizmoEnabled(value: boolean);
  56405. get scaleGizmoEnabled(): boolean;
  56406. /**
  56407. * If the boundingBox gizmo is enabled
  56408. */
  56409. set boundingBoxGizmoEnabled(value: boolean);
  56410. get boundingBoxGizmoEnabled(): boolean;
  56411. /**
  56412. * Disposes of the gizmo manager
  56413. */
  56414. dispose(): void;
  56415. }
  56416. }
  56417. declare module "babylonjs/Lights/directionalLight" {
  56418. import { Camera } from "babylonjs/Cameras/camera";
  56419. import { Scene } from "babylonjs/scene";
  56420. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56421. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56422. import { Light } from "babylonjs/Lights/light";
  56423. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  56424. import { Effect } from "babylonjs/Materials/effect";
  56425. /**
  56426. * A directional light is defined by a direction (what a surprise!).
  56427. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  56428. * 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.
  56429. * Documentation: https://doc.babylonjs.com/babylon101/lights
  56430. */
  56431. export class DirectionalLight extends ShadowLight {
  56432. private _shadowFrustumSize;
  56433. /**
  56434. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  56435. */
  56436. get shadowFrustumSize(): number;
  56437. /**
  56438. * Specifies a fix frustum size for the shadow generation.
  56439. */
  56440. set shadowFrustumSize(value: number);
  56441. private _shadowOrthoScale;
  56442. /**
  56443. * Gets the shadow projection scale against the optimal computed one.
  56444. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  56445. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  56446. */
  56447. get shadowOrthoScale(): number;
  56448. /**
  56449. * Sets the shadow projection scale against the optimal computed one.
  56450. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  56451. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  56452. */
  56453. set shadowOrthoScale(value: number);
  56454. /**
  56455. * Automatically compute the projection matrix to best fit (including all the casters)
  56456. * on each frame.
  56457. */
  56458. autoUpdateExtends: boolean;
  56459. /**
  56460. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  56461. * on each frame. autoUpdateExtends must be set to true for this to work
  56462. */
  56463. autoCalcShadowZBounds: boolean;
  56464. private _orthoLeft;
  56465. private _orthoRight;
  56466. private _orthoTop;
  56467. private _orthoBottom;
  56468. /**
  56469. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  56470. * The directional light is emitted from everywhere in the given direction.
  56471. * It can cast shadows.
  56472. * Documentation : https://doc.babylonjs.com/babylon101/lights
  56473. * @param name The friendly name of the light
  56474. * @param direction The direction of the light
  56475. * @param scene The scene the light belongs to
  56476. */
  56477. constructor(name: string, direction: Vector3, scene: Scene);
  56478. /**
  56479. * Returns the string "DirectionalLight".
  56480. * @return The class name
  56481. */
  56482. getClassName(): string;
  56483. /**
  56484. * Returns the integer 1.
  56485. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  56486. */
  56487. getTypeID(): number;
  56488. /**
  56489. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  56490. * Returns the DirectionalLight Shadow projection matrix.
  56491. */
  56492. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56493. /**
  56494. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  56495. * Returns the DirectionalLight Shadow projection matrix.
  56496. */
  56497. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  56498. /**
  56499. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  56500. * Returns the DirectionalLight Shadow projection matrix.
  56501. */
  56502. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56503. protected _buildUniformLayout(): void;
  56504. /**
  56505. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  56506. * @param effect The effect to update
  56507. * @param lightIndex The index of the light in the effect to update
  56508. * @returns The directional light
  56509. */
  56510. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  56511. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  56512. /**
  56513. * Gets the minZ used for shadow according to both the scene and the light.
  56514. *
  56515. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  56516. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  56517. * @param activeCamera The camera we are returning the min for
  56518. * @returns the depth min z
  56519. */
  56520. getDepthMinZ(activeCamera: Camera): number;
  56521. /**
  56522. * Gets the maxZ used for shadow according to both the scene and the light.
  56523. *
  56524. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  56525. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  56526. * @param activeCamera The camera we are returning the max for
  56527. * @returns the depth max z
  56528. */
  56529. getDepthMaxZ(activeCamera: Camera): number;
  56530. /**
  56531. * Prepares the list of defines specific to the light type.
  56532. * @param defines the list of defines
  56533. * @param lightIndex defines the index of the light for the effect
  56534. */
  56535. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  56536. }
  56537. }
  56538. declare module "babylonjs/Meshes/Builders/hemisphereBuilder" {
  56539. import { Mesh } from "babylonjs/Meshes/mesh";
  56540. /**
  56541. * Class containing static functions to help procedurally build meshes
  56542. */
  56543. export class HemisphereBuilder {
  56544. /**
  56545. * Creates a hemisphere mesh
  56546. * @param name defines the name of the mesh
  56547. * @param options defines the options used to create the mesh
  56548. * @param scene defines the hosting scene
  56549. * @returns the hemisphere mesh
  56550. */
  56551. static CreateHemisphere(name: string, options: {
  56552. segments?: number;
  56553. diameter?: number;
  56554. sideOrientation?: number;
  56555. }, scene: any): Mesh;
  56556. }
  56557. }
  56558. declare module "babylonjs/Lights/spotLight" {
  56559. import { Nullable } from "babylonjs/types";
  56560. import { Scene } from "babylonjs/scene";
  56561. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56562. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56563. import { Effect } from "babylonjs/Materials/effect";
  56564. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56565. import { Light } from "babylonjs/Lights/light";
  56566. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  56567. /**
  56568. * A spot light is defined by a position, a direction, an angle, and an exponent.
  56569. * These values define a cone of light starting from the position, emitting toward the direction.
  56570. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  56571. * and the exponent defines the speed of the decay of the light with distance (reach).
  56572. * Documentation: https://doc.babylonjs.com/babylon101/lights
  56573. */
  56574. export class SpotLight extends ShadowLight {
  56575. private _angle;
  56576. private _innerAngle;
  56577. private _cosHalfAngle;
  56578. private _lightAngleScale;
  56579. private _lightAngleOffset;
  56580. /**
  56581. * Gets the cone angle of the spot light in Radians.
  56582. */
  56583. get angle(): number;
  56584. /**
  56585. * Sets the cone angle of the spot light in Radians.
  56586. */
  56587. set angle(value: number);
  56588. /**
  56589. * Only used in gltf falloff mode, this defines the angle where
  56590. * the directional falloff will start before cutting at angle which could be seen
  56591. * as outer angle.
  56592. */
  56593. get innerAngle(): number;
  56594. /**
  56595. * Only used in gltf falloff mode, this defines the angle where
  56596. * the directional falloff will start before cutting at angle which could be seen
  56597. * as outer angle.
  56598. */
  56599. set innerAngle(value: number);
  56600. private _shadowAngleScale;
  56601. /**
  56602. * Allows scaling the angle of the light for shadow generation only.
  56603. */
  56604. get shadowAngleScale(): number;
  56605. /**
  56606. * Allows scaling the angle of the light for shadow generation only.
  56607. */
  56608. set shadowAngleScale(value: number);
  56609. /**
  56610. * The light decay speed with the distance from the emission spot.
  56611. */
  56612. exponent: number;
  56613. private _projectionTextureMatrix;
  56614. /**
  56615. * Allows reading the projecton texture
  56616. */
  56617. get projectionTextureMatrix(): Matrix;
  56618. protected _projectionTextureLightNear: number;
  56619. /**
  56620. * Gets the near clip of the Spotlight for texture projection.
  56621. */
  56622. get projectionTextureLightNear(): number;
  56623. /**
  56624. * Sets the near clip of the Spotlight for texture projection.
  56625. */
  56626. set projectionTextureLightNear(value: number);
  56627. protected _projectionTextureLightFar: number;
  56628. /**
  56629. * Gets the far clip of the Spotlight for texture projection.
  56630. */
  56631. get projectionTextureLightFar(): number;
  56632. /**
  56633. * Sets the far clip of the Spotlight for texture projection.
  56634. */
  56635. set projectionTextureLightFar(value: number);
  56636. protected _projectionTextureUpDirection: Vector3;
  56637. /**
  56638. * Gets the Up vector of the Spotlight for texture projection.
  56639. */
  56640. get projectionTextureUpDirection(): Vector3;
  56641. /**
  56642. * Sets the Up vector of the Spotlight for texture projection.
  56643. */
  56644. set projectionTextureUpDirection(value: Vector3);
  56645. private _projectionTexture;
  56646. /**
  56647. * Gets the projection texture of the light.
  56648. */
  56649. get projectionTexture(): Nullable<BaseTexture>;
  56650. /**
  56651. * Sets the projection texture of the light.
  56652. */
  56653. set projectionTexture(value: Nullable<BaseTexture>);
  56654. private _projectionTextureViewLightDirty;
  56655. private _projectionTextureProjectionLightDirty;
  56656. private _projectionTextureDirty;
  56657. private _projectionTextureViewTargetVector;
  56658. private _projectionTextureViewLightMatrix;
  56659. private _projectionTextureProjectionLightMatrix;
  56660. private _projectionTextureScalingMatrix;
  56661. /**
  56662. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  56663. * It can cast shadows.
  56664. * Documentation : https://doc.babylonjs.com/babylon101/lights
  56665. * @param name The light friendly name
  56666. * @param position The position of the spot light in the scene
  56667. * @param direction The direction of the light in the scene
  56668. * @param angle The cone angle of the light in Radians
  56669. * @param exponent The light decay speed with the distance from the emission spot
  56670. * @param scene The scene the lights belongs to
  56671. */
  56672. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  56673. /**
  56674. * Returns the string "SpotLight".
  56675. * @returns the class name
  56676. */
  56677. getClassName(): string;
  56678. /**
  56679. * Returns the integer 2.
  56680. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  56681. */
  56682. getTypeID(): number;
  56683. /**
  56684. * Overrides the direction setter to recompute the projection texture view light Matrix.
  56685. */
  56686. protected _setDirection(value: Vector3): void;
  56687. /**
  56688. * Overrides the position setter to recompute the projection texture view light Matrix.
  56689. */
  56690. protected _setPosition(value: Vector3): void;
  56691. /**
  56692. * 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.
  56693. * Returns the SpotLight.
  56694. */
  56695. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56696. protected _computeProjectionTextureViewLightMatrix(): void;
  56697. protected _computeProjectionTextureProjectionLightMatrix(): void;
  56698. /**
  56699. * Main function for light texture projection matrix computing.
  56700. */
  56701. protected _computeProjectionTextureMatrix(): void;
  56702. protected _buildUniformLayout(): void;
  56703. private _computeAngleValues;
  56704. /**
  56705. * Sets the passed Effect "effect" with the Light textures.
  56706. * @param effect The effect to update
  56707. * @param lightIndex The index of the light in the effect to update
  56708. * @returns The light
  56709. */
  56710. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  56711. /**
  56712. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  56713. * @param effect The effect to update
  56714. * @param lightIndex The index of the light in the effect to update
  56715. * @returns The spot light
  56716. */
  56717. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  56718. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  56719. /**
  56720. * Disposes the light and the associated resources.
  56721. */
  56722. dispose(): void;
  56723. /**
  56724. * Prepares the list of defines specific to the light type.
  56725. * @param defines the list of defines
  56726. * @param lightIndex defines the index of the light for the effect
  56727. */
  56728. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  56729. }
  56730. }
  56731. declare module "babylonjs/Gizmos/lightGizmo" {
  56732. import { Nullable } from "babylonjs/types";
  56733. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56734. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56735. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  56736. import { Light } from "babylonjs/Lights/light";
  56737. import { Observable } from "babylonjs/Misc/observable";
  56738. /**
  56739. * Gizmo that enables viewing a light
  56740. */
  56741. export class LightGizmo extends Gizmo {
  56742. private _lightMesh;
  56743. private _material;
  56744. private _cachedPosition;
  56745. private _cachedForward;
  56746. private _attachedMeshParent;
  56747. private _pointerObserver;
  56748. /**
  56749. * Event that fires each time the gizmo is clicked
  56750. */
  56751. onClickedObservable: Observable<Light>;
  56752. /**
  56753. * Creates a LightGizmo
  56754. * @param gizmoLayer The utility layer the gizmo will be added to
  56755. */
  56756. constructor(gizmoLayer?: UtilityLayerRenderer);
  56757. private _light;
  56758. /**
  56759. * The light that the gizmo is attached to
  56760. */
  56761. set light(light: Nullable<Light>);
  56762. get light(): Nullable<Light>;
  56763. /**
  56764. * Gets the material used to render the light gizmo
  56765. */
  56766. get material(): StandardMaterial;
  56767. /**
  56768. * @hidden
  56769. * Updates the gizmo to match the attached mesh's position/rotation
  56770. */
  56771. protected _update(): void;
  56772. private static _Scale;
  56773. /**
  56774. * Creates the lines for a light mesh
  56775. */
  56776. private static _CreateLightLines;
  56777. /**
  56778. * Disposes of the light gizmo
  56779. */
  56780. dispose(): void;
  56781. private static _CreateHemisphericLightMesh;
  56782. private static _CreatePointLightMesh;
  56783. private static _CreateSpotLightMesh;
  56784. private static _CreateDirectionalLightMesh;
  56785. }
  56786. }
  56787. declare module "babylonjs/Gizmos/cameraGizmo" {
  56788. import { Nullable } from "babylonjs/types";
  56789. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56790. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56791. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  56792. import { Camera } from "babylonjs/Cameras/camera";
  56793. import { Observable } from "babylonjs/Misc/observable";
  56794. /**
  56795. * Gizmo that enables viewing a camera
  56796. */
  56797. export class CameraGizmo extends Gizmo {
  56798. private _cameraMesh;
  56799. private _cameraLinesMesh;
  56800. private _material;
  56801. private _pointerObserver;
  56802. /**
  56803. * Event that fires each time the gizmo is clicked
  56804. */
  56805. onClickedObservable: Observable<Camera>;
  56806. /**
  56807. * Creates a CameraGizmo
  56808. * @param gizmoLayer The utility layer the gizmo will be added to
  56809. */
  56810. constructor(gizmoLayer?: UtilityLayerRenderer);
  56811. private _camera;
  56812. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  56813. get displayFrustum(): boolean;
  56814. set displayFrustum(value: boolean);
  56815. /**
  56816. * The camera that the gizmo is attached to
  56817. */
  56818. set camera(camera: Nullable<Camera>);
  56819. get camera(): Nullable<Camera>;
  56820. /**
  56821. * Gets the material used to render the camera gizmo
  56822. */
  56823. get material(): StandardMaterial;
  56824. /**
  56825. * @hidden
  56826. * Updates the gizmo to match the attached mesh's position/rotation
  56827. */
  56828. protected _update(): void;
  56829. private static _Scale;
  56830. private _invProjection;
  56831. /**
  56832. * Disposes of the camera gizmo
  56833. */
  56834. dispose(): void;
  56835. private static _CreateCameraMesh;
  56836. private static _CreateCameraFrustum;
  56837. }
  56838. }
  56839. declare module "babylonjs/Gizmos/index" {
  56840. export * from "babylonjs/Gizmos/axisDragGizmo";
  56841. export * from "babylonjs/Gizmos/axisScaleGizmo";
  56842. export * from "babylonjs/Gizmos/boundingBoxGizmo";
  56843. export * from "babylonjs/Gizmos/gizmo";
  56844. export * from "babylonjs/Gizmos/gizmoManager";
  56845. export * from "babylonjs/Gizmos/planeRotationGizmo";
  56846. export * from "babylonjs/Gizmos/positionGizmo";
  56847. export * from "babylonjs/Gizmos/rotationGizmo";
  56848. export * from "babylonjs/Gizmos/scaleGizmo";
  56849. export * from "babylonjs/Gizmos/lightGizmo";
  56850. export * from "babylonjs/Gizmos/cameraGizmo";
  56851. export * from "babylonjs/Gizmos/planeDragGizmo";
  56852. }
  56853. declare module "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration" {
  56854. /** @hidden */
  56855. export var backgroundFragmentDeclaration: {
  56856. name: string;
  56857. shader: string;
  56858. };
  56859. }
  56860. declare module "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration" {
  56861. /** @hidden */
  56862. export var backgroundUboDeclaration: {
  56863. name: string;
  56864. shader: string;
  56865. };
  56866. }
  56867. declare module "babylonjs/Shaders/background.fragment" {
  56868. import "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration";
  56869. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  56870. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  56871. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  56872. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  56873. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  56874. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56875. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  56876. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  56877. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  56878. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  56879. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  56880. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  56881. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  56882. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  56883. /** @hidden */
  56884. export var backgroundPixelShader: {
  56885. name: string;
  56886. shader: string;
  56887. };
  56888. }
  56889. declare module "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration" {
  56890. /** @hidden */
  56891. export var backgroundVertexDeclaration: {
  56892. name: string;
  56893. shader: string;
  56894. };
  56895. }
  56896. declare module "babylonjs/Shaders/background.vertex" {
  56897. import "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration";
  56898. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  56899. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56900. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  56901. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  56902. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  56903. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  56904. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  56905. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  56906. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  56907. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  56908. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  56909. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  56910. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  56911. /** @hidden */
  56912. export var backgroundVertexShader: {
  56913. name: string;
  56914. shader: string;
  56915. };
  56916. }
  56917. declare module "babylonjs/Materials/Background/backgroundMaterial" {
  56918. import { Nullable, int, float } from "babylonjs/types";
  56919. import { Scene } from "babylonjs/scene";
  56920. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56921. import { SubMesh } from "babylonjs/Meshes/subMesh";
  56922. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56923. import { Mesh } from "babylonjs/Meshes/mesh";
  56924. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  56925. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  56926. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  56927. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56928. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  56929. import { Color3 } from "babylonjs/Maths/math.color";
  56930. import "babylonjs/Shaders/background.fragment";
  56931. import "babylonjs/Shaders/background.vertex";
  56932. /**
  56933. * Background material used to create an efficient environement around your scene.
  56934. */
  56935. export class BackgroundMaterial extends PushMaterial {
  56936. /**
  56937. * Standard reflectance value at parallel view angle.
  56938. */
  56939. static StandardReflectance0: number;
  56940. /**
  56941. * Standard reflectance value at grazing angle.
  56942. */
  56943. static StandardReflectance90: number;
  56944. protected _primaryColor: Color3;
  56945. /**
  56946. * Key light Color (multiply against the environement texture)
  56947. */
  56948. primaryColor: Color3;
  56949. protected __perceptualColor: Nullable<Color3>;
  56950. /**
  56951. * Experimental Internal Use Only.
  56952. *
  56953. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  56954. * This acts as a helper to set the primary color to a more "human friendly" value.
  56955. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  56956. * output color as close as possible from the chosen value.
  56957. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  56958. * part of lighting setup.)
  56959. */
  56960. get _perceptualColor(): Nullable<Color3>;
  56961. set _perceptualColor(value: Nullable<Color3>);
  56962. protected _primaryColorShadowLevel: float;
  56963. /**
  56964. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  56965. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  56966. */
  56967. get primaryColorShadowLevel(): float;
  56968. set primaryColorShadowLevel(value: float);
  56969. protected _primaryColorHighlightLevel: float;
  56970. /**
  56971. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  56972. * The primary color is used at the level chosen to define what the white area would look.
  56973. */
  56974. get primaryColorHighlightLevel(): float;
  56975. set primaryColorHighlightLevel(value: float);
  56976. protected _reflectionTexture: Nullable<BaseTexture>;
  56977. /**
  56978. * Reflection Texture used in the material.
  56979. * Should be author in a specific way for the best result (refer to the documentation).
  56980. */
  56981. reflectionTexture: Nullable<BaseTexture>;
  56982. protected _reflectionBlur: float;
  56983. /**
  56984. * Reflection Texture level of blur.
  56985. *
  56986. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  56987. * texture twice.
  56988. */
  56989. reflectionBlur: float;
  56990. protected _diffuseTexture: Nullable<BaseTexture>;
  56991. /**
  56992. * Diffuse Texture used in the material.
  56993. * Should be author in a specific way for the best result (refer to the documentation).
  56994. */
  56995. diffuseTexture: Nullable<BaseTexture>;
  56996. protected _shadowLights: Nullable<IShadowLight[]>;
  56997. /**
  56998. * Specify the list of lights casting shadow on the material.
  56999. * All scene shadow lights will be included if null.
  57000. */
  57001. shadowLights: Nullable<IShadowLight[]>;
  57002. protected _shadowLevel: float;
  57003. /**
  57004. * Helps adjusting the shadow to a softer level if required.
  57005. * 0 means black shadows and 1 means no shadows.
  57006. */
  57007. shadowLevel: float;
  57008. protected _sceneCenter: Vector3;
  57009. /**
  57010. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  57011. * It is usually zero but might be interesting to modify according to your setup.
  57012. */
  57013. sceneCenter: Vector3;
  57014. protected _opacityFresnel: boolean;
  57015. /**
  57016. * This helps specifying that the material is falling off to the sky box at grazing angle.
  57017. * This helps ensuring a nice transition when the camera goes under the ground.
  57018. */
  57019. opacityFresnel: boolean;
  57020. protected _reflectionFresnel: boolean;
  57021. /**
  57022. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  57023. * This helps adding a mirror texture on the ground.
  57024. */
  57025. reflectionFresnel: boolean;
  57026. protected _reflectionFalloffDistance: number;
  57027. /**
  57028. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  57029. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  57030. */
  57031. reflectionFalloffDistance: number;
  57032. protected _reflectionAmount: number;
  57033. /**
  57034. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  57035. */
  57036. reflectionAmount: number;
  57037. protected _reflectionReflectance0: number;
  57038. /**
  57039. * This specifies the weight of the reflection at grazing angle.
  57040. */
  57041. reflectionReflectance0: number;
  57042. protected _reflectionReflectance90: number;
  57043. /**
  57044. * This specifies the weight of the reflection at a perpendicular point of view.
  57045. */
  57046. reflectionReflectance90: number;
  57047. /**
  57048. * Sets the reflection reflectance fresnel values according to the default standard
  57049. * empirically know to work well :-)
  57050. */
  57051. set reflectionStandardFresnelWeight(value: number);
  57052. protected _useRGBColor: boolean;
  57053. /**
  57054. * Helps to directly use the maps channels instead of their level.
  57055. */
  57056. useRGBColor: boolean;
  57057. protected _enableNoise: boolean;
  57058. /**
  57059. * This helps reducing the banding effect that could occur on the background.
  57060. */
  57061. enableNoise: boolean;
  57062. /**
  57063. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  57064. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  57065. * Recommended to be keep at 1.0 except for special cases.
  57066. */
  57067. get fovMultiplier(): number;
  57068. set fovMultiplier(value: number);
  57069. private _fovMultiplier;
  57070. /**
  57071. * Enable the FOV adjustment feature controlled by fovMultiplier.
  57072. */
  57073. useEquirectangularFOV: boolean;
  57074. private _maxSimultaneousLights;
  57075. /**
  57076. * Number of Simultaneous lights allowed on the material.
  57077. */
  57078. maxSimultaneousLights: int;
  57079. private _shadowOnly;
  57080. /**
  57081. * Make the material only render shadows
  57082. */
  57083. shadowOnly: boolean;
  57084. /**
  57085. * Default configuration related to image processing available in the Background Material.
  57086. */
  57087. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  57088. /**
  57089. * Keep track of the image processing observer to allow dispose and replace.
  57090. */
  57091. private _imageProcessingObserver;
  57092. /**
  57093. * Attaches a new image processing configuration to the PBR Material.
  57094. * @param configuration (if null the scene configuration will be use)
  57095. */
  57096. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  57097. /**
  57098. * Gets the image processing configuration used either in this material.
  57099. */
  57100. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  57101. /**
  57102. * Sets the Default image processing configuration used either in the this material.
  57103. *
  57104. * If sets to null, the scene one is in use.
  57105. */
  57106. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  57107. /**
  57108. * Gets wether the color curves effect is enabled.
  57109. */
  57110. get cameraColorCurvesEnabled(): boolean;
  57111. /**
  57112. * Sets wether the color curves effect is enabled.
  57113. */
  57114. set cameraColorCurvesEnabled(value: boolean);
  57115. /**
  57116. * Gets wether the color grading effect is enabled.
  57117. */
  57118. get cameraColorGradingEnabled(): boolean;
  57119. /**
  57120. * Gets wether the color grading effect is enabled.
  57121. */
  57122. set cameraColorGradingEnabled(value: boolean);
  57123. /**
  57124. * Gets wether tonemapping is enabled or not.
  57125. */
  57126. get cameraToneMappingEnabled(): boolean;
  57127. /**
  57128. * Sets wether tonemapping is enabled or not
  57129. */
  57130. set cameraToneMappingEnabled(value: boolean);
  57131. /**
  57132. * The camera exposure used on this material.
  57133. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  57134. * This corresponds to a photographic exposure.
  57135. */
  57136. get cameraExposure(): float;
  57137. /**
  57138. * The camera exposure used on this material.
  57139. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  57140. * This corresponds to a photographic exposure.
  57141. */
  57142. set cameraExposure(value: float);
  57143. /**
  57144. * Gets The camera contrast used on this material.
  57145. */
  57146. get cameraContrast(): float;
  57147. /**
  57148. * Sets The camera contrast used on this material.
  57149. */
  57150. set cameraContrast(value: float);
  57151. /**
  57152. * Gets the Color Grading 2D Lookup Texture.
  57153. */
  57154. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  57155. /**
  57156. * Sets the Color Grading 2D Lookup Texture.
  57157. */
  57158. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  57159. /**
  57160. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  57161. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  57162. * 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;
  57163. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  57164. */
  57165. get cameraColorCurves(): Nullable<ColorCurves>;
  57166. /**
  57167. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  57168. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  57169. * 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;
  57170. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  57171. */
  57172. set cameraColorCurves(value: Nullable<ColorCurves>);
  57173. /**
  57174. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  57175. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  57176. */
  57177. switchToBGR: boolean;
  57178. private _renderTargets;
  57179. private _reflectionControls;
  57180. private _white;
  57181. private _primaryShadowColor;
  57182. private _primaryHighlightColor;
  57183. /**
  57184. * Instantiates a Background Material in the given scene
  57185. * @param name The friendly name of the material
  57186. * @param scene The scene to add the material to
  57187. */
  57188. constructor(name: string, scene: Scene);
  57189. /**
  57190. * Gets a boolean indicating that current material needs to register RTT
  57191. */
  57192. get hasRenderTargetTextures(): boolean;
  57193. /**
  57194. * The entire material has been created in order to prevent overdraw.
  57195. * @returns false
  57196. */
  57197. needAlphaTesting(): boolean;
  57198. /**
  57199. * The entire material has been created in order to prevent overdraw.
  57200. * @returns true if blending is enable
  57201. */
  57202. needAlphaBlending(): boolean;
  57203. /**
  57204. * Checks wether the material is ready to be rendered for a given mesh.
  57205. * @param mesh The mesh to render
  57206. * @param subMesh The submesh to check against
  57207. * @param useInstances Specify wether or not the material is used with instances
  57208. * @returns true if all the dependencies are ready (Textures, Effects...)
  57209. */
  57210. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  57211. /**
  57212. * Compute the primary color according to the chosen perceptual color.
  57213. */
  57214. private _computePrimaryColorFromPerceptualColor;
  57215. /**
  57216. * Compute the highlights and shadow colors according to their chosen levels.
  57217. */
  57218. private _computePrimaryColors;
  57219. /**
  57220. * Build the uniform buffer used in the material.
  57221. */
  57222. buildUniformLayout(): void;
  57223. /**
  57224. * Unbind the material.
  57225. */
  57226. unbind(): void;
  57227. /**
  57228. * Bind only the world matrix to the material.
  57229. * @param world The world matrix to bind.
  57230. */
  57231. bindOnlyWorldMatrix(world: Matrix): void;
  57232. /**
  57233. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  57234. * @param world The world matrix to bind.
  57235. * @param subMesh The submesh to bind for.
  57236. */
  57237. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  57238. /**
  57239. * Checks to see if a texture is used in the material.
  57240. * @param texture - Base texture to use.
  57241. * @returns - Boolean specifying if a texture is used in the material.
  57242. */
  57243. hasTexture(texture: BaseTexture): boolean;
  57244. /**
  57245. * Dispose the material.
  57246. * @param forceDisposeEffect Force disposal of the associated effect.
  57247. * @param forceDisposeTextures Force disposal of the associated textures.
  57248. */
  57249. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  57250. /**
  57251. * Clones the material.
  57252. * @param name The cloned name.
  57253. * @returns The cloned material.
  57254. */
  57255. clone(name: string): BackgroundMaterial;
  57256. /**
  57257. * Serializes the current material to its JSON representation.
  57258. * @returns The JSON representation.
  57259. */
  57260. serialize(): any;
  57261. /**
  57262. * Gets the class name of the material
  57263. * @returns "BackgroundMaterial"
  57264. */
  57265. getClassName(): string;
  57266. /**
  57267. * Parse a JSON input to create back a background material.
  57268. * @param source The JSON data to parse
  57269. * @param scene The scene to create the parsed material in
  57270. * @param rootUrl The root url of the assets the material depends upon
  57271. * @returns the instantiated BackgroundMaterial.
  57272. */
  57273. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  57274. }
  57275. }
  57276. declare module "babylonjs/Helpers/environmentHelper" {
  57277. import { Observable } from "babylonjs/Misc/observable";
  57278. import { Nullable } from "babylonjs/types";
  57279. import { Scene } from "babylonjs/scene";
  57280. import { Vector3 } from "babylonjs/Maths/math.vector";
  57281. import { Color3 } from "babylonjs/Maths/math.color";
  57282. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57283. import { Mesh } from "babylonjs/Meshes/mesh";
  57284. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57285. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  57286. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  57287. import "babylonjs/Meshes/Builders/planeBuilder";
  57288. import "babylonjs/Meshes/Builders/boxBuilder";
  57289. /**
  57290. * Represents the different options available during the creation of
  57291. * a Environment helper.
  57292. *
  57293. * This can control the default ground, skybox and image processing setup of your scene.
  57294. */
  57295. export interface IEnvironmentHelperOptions {
  57296. /**
  57297. * Specifies whether or not to create a ground.
  57298. * True by default.
  57299. */
  57300. createGround: boolean;
  57301. /**
  57302. * Specifies the ground size.
  57303. * 15 by default.
  57304. */
  57305. groundSize: number;
  57306. /**
  57307. * The texture used on the ground for the main color.
  57308. * Comes from the BabylonJS CDN by default.
  57309. *
  57310. * Remarks: Can be either a texture or a url.
  57311. */
  57312. groundTexture: string | BaseTexture;
  57313. /**
  57314. * The color mixed in the ground texture by default.
  57315. * BabylonJS clearColor by default.
  57316. */
  57317. groundColor: Color3;
  57318. /**
  57319. * Specifies the ground opacity.
  57320. * 1 by default.
  57321. */
  57322. groundOpacity: number;
  57323. /**
  57324. * Enables the ground to receive shadows.
  57325. * True by default.
  57326. */
  57327. enableGroundShadow: boolean;
  57328. /**
  57329. * Helps preventing the shadow to be fully black on the ground.
  57330. * 0.5 by default.
  57331. */
  57332. groundShadowLevel: number;
  57333. /**
  57334. * Creates a mirror texture attach to the ground.
  57335. * false by default.
  57336. */
  57337. enableGroundMirror: boolean;
  57338. /**
  57339. * Specifies the ground mirror size ratio.
  57340. * 0.3 by default as the default kernel is 64.
  57341. */
  57342. groundMirrorSizeRatio: number;
  57343. /**
  57344. * Specifies the ground mirror blur kernel size.
  57345. * 64 by default.
  57346. */
  57347. groundMirrorBlurKernel: number;
  57348. /**
  57349. * Specifies the ground mirror visibility amount.
  57350. * 1 by default
  57351. */
  57352. groundMirrorAmount: number;
  57353. /**
  57354. * Specifies the ground mirror reflectance weight.
  57355. * This uses the standard weight of the background material to setup the fresnel effect
  57356. * of the mirror.
  57357. * 1 by default.
  57358. */
  57359. groundMirrorFresnelWeight: number;
  57360. /**
  57361. * Specifies the ground mirror Falloff distance.
  57362. * This can helps reducing the size of the reflection.
  57363. * 0 by Default.
  57364. */
  57365. groundMirrorFallOffDistance: number;
  57366. /**
  57367. * Specifies the ground mirror texture type.
  57368. * Unsigned Int by Default.
  57369. */
  57370. groundMirrorTextureType: number;
  57371. /**
  57372. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  57373. * the shown objects.
  57374. */
  57375. groundYBias: number;
  57376. /**
  57377. * Specifies whether or not to create a skybox.
  57378. * True by default.
  57379. */
  57380. createSkybox: boolean;
  57381. /**
  57382. * Specifies the skybox size.
  57383. * 20 by default.
  57384. */
  57385. skyboxSize: number;
  57386. /**
  57387. * The texture used on the skybox for the main color.
  57388. * Comes from the BabylonJS CDN by default.
  57389. *
  57390. * Remarks: Can be either a texture or a url.
  57391. */
  57392. skyboxTexture: string | BaseTexture;
  57393. /**
  57394. * The color mixed in the skybox texture by default.
  57395. * BabylonJS clearColor by default.
  57396. */
  57397. skyboxColor: Color3;
  57398. /**
  57399. * The background rotation around the Y axis of the scene.
  57400. * This helps aligning the key lights of your scene with the background.
  57401. * 0 by default.
  57402. */
  57403. backgroundYRotation: number;
  57404. /**
  57405. * Compute automatically the size of the elements to best fit with the scene.
  57406. */
  57407. sizeAuto: boolean;
  57408. /**
  57409. * Default position of the rootMesh if autoSize is not true.
  57410. */
  57411. rootPosition: Vector3;
  57412. /**
  57413. * Sets up the image processing in the scene.
  57414. * true by default.
  57415. */
  57416. setupImageProcessing: boolean;
  57417. /**
  57418. * The texture used as your environment texture in the scene.
  57419. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  57420. *
  57421. * Remarks: Can be either a texture or a url.
  57422. */
  57423. environmentTexture: string | BaseTexture;
  57424. /**
  57425. * The value of the exposure to apply to the scene.
  57426. * 0.6 by default if setupImageProcessing is true.
  57427. */
  57428. cameraExposure: number;
  57429. /**
  57430. * The value of the contrast to apply to the scene.
  57431. * 1.6 by default if setupImageProcessing is true.
  57432. */
  57433. cameraContrast: number;
  57434. /**
  57435. * Specifies whether or not tonemapping should be enabled in the scene.
  57436. * true by default if setupImageProcessing is true.
  57437. */
  57438. toneMappingEnabled: boolean;
  57439. }
  57440. /**
  57441. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  57442. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  57443. * It also helps with the default setup of your imageProcessing configuration.
  57444. */
  57445. export class EnvironmentHelper {
  57446. /**
  57447. * Default ground texture URL.
  57448. */
  57449. private static _groundTextureCDNUrl;
  57450. /**
  57451. * Default skybox texture URL.
  57452. */
  57453. private static _skyboxTextureCDNUrl;
  57454. /**
  57455. * Default environment texture URL.
  57456. */
  57457. private static _environmentTextureCDNUrl;
  57458. /**
  57459. * Creates the default options for the helper.
  57460. */
  57461. private static _getDefaultOptions;
  57462. private _rootMesh;
  57463. /**
  57464. * Gets the root mesh created by the helper.
  57465. */
  57466. get rootMesh(): Mesh;
  57467. private _skybox;
  57468. /**
  57469. * Gets the skybox created by the helper.
  57470. */
  57471. get skybox(): Nullable<Mesh>;
  57472. private _skyboxTexture;
  57473. /**
  57474. * Gets the skybox texture created by the helper.
  57475. */
  57476. get skyboxTexture(): Nullable<BaseTexture>;
  57477. private _skyboxMaterial;
  57478. /**
  57479. * Gets the skybox material created by the helper.
  57480. */
  57481. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  57482. private _ground;
  57483. /**
  57484. * Gets the ground mesh created by the helper.
  57485. */
  57486. get ground(): Nullable<Mesh>;
  57487. private _groundTexture;
  57488. /**
  57489. * Gets the ground texture created by the helper.
  57490. */
  57491. get groundTexture(): Nullable<BaseTexture>;
  57492. private _groundMirror;
  57493. /**
  57494. * Gets the ground mirror created by the helper.
  57495. */
  57496. get groundMirror(): Nullable<MirrorTexture>;
  57497. /**
  57498. * Gets the ground mirror render list to helps pushing the meshes
  57499. * you wish in the ground reflection.
  57500. */
  57501. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  57502. private _groundMaterial;
  57503. /**
  57504. * Gets the ground material created by the helper.
  57505. */
  57506. get groundMaterial(): Nullable<BackgroundMaterial>;
  57507. /**
  57508. * Stores the creation options.
  57509. */
  57510. private readonly _scene;
  57511. private _options;
  57512. /**
  57513. * This observable will be notified with any error during the creation of the environment,
  57514. * mainly texture creation errors.
  57515. */
  57516. onErrorObservable: Observable<{
  57517. message?: string;
  57518. exception?: any;
  57519. }>;
  57520. /**
  57521. * constructor
  57522. * @param options Defines the options we want to customize the helper
  57523. * @param scene The scene to add the material to
  57524. */
  57525. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  57526. /**
  57527. * Updates the background according to the new options
  57528. * @param options
  57529. */
  57530. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  57531. /**
  57532. * Sets the primary color of all the available elements.
  57533. * @param color the main color to affect to the ground and the background
  57534. */
  57535. setMainColor(color: Color3): void;
  57536. /**
  57537. * Setup the image processing according to the specified options.
  57538. */
  57539. private _setupImageProcessing;
  57540. /**
  57541. * Setup the environment texture according to the specified options.
  57542. */
  57543. private _setupEnvironmentTexture;
  57544. /**
  57545. * Setup the background according to the specified options.
  57546. */
  57547. private _setupBackground;
  57548. /**
  57549. * Get the scene sizes according to the setup.
  57550. */
  57551. private _getSceneSize;
  57552. /**
  57553. * Setup the ground according to the specified options.
  57554. */
  57555. private _setupGround;
  57556. /**
  57557. * Setup the ground material according to the specified options.
  57558. */
  57559. private _setupGroundMaterial;
  57560. /**
  57561. * Setup the ground diffuse texture according to the specified options.
  57562. */
  57563. private _setupGroundDiffuseTexture;
  57564. /**
  57565. * Setup the ground mirror texture according to the specified options.
  57566. */
  57567. private _setupGroundMirrorTexture;
  57568. /**
  57569. * Setup the ground to receive the mirror texture.
  57570. */
  57571. private _setupMirrorInGroundMaterial;
  57572. /**
  57573. * Setup the skybox according to the specified options.
  57574. */
  57575. private _setupSkybox;
  57576. /**
  57577. * Setup the skybox material according to the specified options.
  57578. */
  57579. private _setupSkyboxMaterial;
  57580. /**
  57581. * Setup the skybox reflection texture according to the specified options.
  57582. */
  57583. private _setupSkyboxReflectionTexture;
  57584. private _errorHandler;
  57585. /**
  57586. * Dispose all the elements created by the Helper.
  57587. */
  57588. dispose(): void;
  57589. }
  57590. }
  57591. declare module "babylonjs/Helpers/textureDome" {
  57592. import { Scene } from "babylonjs/scene";
  57593. import { TransformNode } from "babylonjs/Meshes/transformNode";
  57594. import { Mesh } from "babylonjs/Meshes/mesh";
  57595. import { Texture } from "babylonjs/Materials/Textures/texture";
  57596. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  57597. import "babylonjs/Meshes/Builders/sphereBuilder";
  57598. import { Nullable } from "babylonjs/types";
  57599. import { Observable } from "babylonjs/Misc/observable";
  57600. /**
  57601. * Display a 360/180 degree texture on an approximately spherical surface, useful for VR applications or skyboxes.
  57602. * As a subclass of TransformNode, this allow parenting to the camera or multiple textures with different locations in the scene.
  57603. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  57604. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  57605. */
  57606. export abstract class TextureDome<T extends Texture> extends TransformNode {
  57607. protected onError: Nullable<(message?: string, exception?: any) => void>;
  57608. /**
  57609. * Define the source as a Monoscopic panoramic 360/180.
  57610. */
  57611. static readonly MODE_MONOSCOPIC: number;
  57612. /**
  57613. * Define the source as a Stereoscopic TopBottom/OverUnder panoramic 360/180.
  57614. */
  57615. static readonly MODE_TOPBOTTOM: number;
  57616. /**
  57617. * Define the source as a Stereoscopic Side by Side panoramic 360/180.
  57618. */
  57619. static readonly MODE_SIDEBYSIDE: number;
  57620. private _halfDome;
  57621. protected _useDirectMapping: boolean;
  57622. /**
  57623. * The texture being displayed on the sphere
  57624. */
  57625. protected _texture: T;
  57626. /**
  57627. * Gets the texture being displayed on the sphere
  57628. */
  57629. get texture(): T;
  57630. /**
  57631. * Sets the texture being displayed on the sphere
  57632. */
  57633. set texture(newTexture: T);
  57634. /**
  57635. * The skybox material
  57636. */
  57637. protected _material: BackgroundMaterial;
  57638. /**
  57639. * The surface used for the dome
  57640. */
  57641. protected _mesh: Mesh;
  57642. /**
  57643. * Gets the mesh used for the dome.
  57644. */
  57645. get mesh(): Mesh;
  57646. /**
  57647. * A mesh that will be used to mask the back of the dome in case it is a 180 degree movie.
  57648. */
  57649. private _halfDomeMask;
  57650. /**
  57651. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  57652. * Also see the options.resolution property.
  57653. */
  57654. get fovMultiplier(): number;
  57655. set fovMultiplier(value: number);
  57656. protected _textureMode: number;
  57657. /**
  57658. * Gets or set the current texture mode for the texture. It can be:
  57659. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57660. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57661. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57662. */
  57663. get textureMode(): number;
  57664. /**
  57665. * Sets the current texture mode for the texture. It can be:
  57666. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57667. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57668. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57669. */
  57670. set textureMode(value: number);
  57671. /**
  57672. * Is it a 180 degrees dome (half dome) or 360 texture (full dome)
  57673. */
  57674. get halfDome(): boolean;
  57675. /**
  57676. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  57677. */
  57678. set halfDome(enabled: boolean);
  57679. /**
  57680. * Oberserver used in Stereoscopic VR Mode.
  57681. */
  57682. private _onBeforeCameraRenderObserver;
  57683. /**
  57684. * Observable raised when an error occured while loading the 360 image
  57685. */
  57686. onLoadErrorObservable: Observable<string>;
  57687. /**
  57688. * Create an instance of this class and pass through the parameters to the relevant classes- Texture, StandardMaterial, and Mesh.
  57689. * @param name Element's name, child elements will append suffixes for their own names.
  57690. * @param textureUrlOrElement defines the url(s) or the (video) HTML element to use
  57691. * @param options An object containing optional or exposed sub element properties
  57692. */
  57693. constructor(name: string, textureUrlOrElement: string | string[] | HTMLVideoElement, options: {
  57694. resolution?: number;
  57695. clickToPlay?: boolean;
  57696. autoPlay?: boolean;
  57697. loop?: boolean;
  57698. size?: number;
  57699. poster?: string;
  57700. faceForward?: boolean;
  57701. useDirectMapping?: boolean;
  57702. halfDomeMode?: boolean;
  57703. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  57704. protected abstract _initTexture(urlsOrElement: string | string[] | HTMLElement, scene: Scene, options: any): T;
  57705. protected _changeTextureMode(value: number): void;
  57706. /**
  57707. * Releases resources associated with this node.
  57708. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  57709. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  57710. */
  57711. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  57712. }
  57713. }
  57714. declare module "babylonjs/Helpers/photoDome" {
  57715. import { Scene } from "babylonjs/scene";
  57716. import { Texture } from "babylonjs/Materials/Textures/texture";
  57717. import { TextureDome } from "babylonjs/Helpers/textureDome";
  57718. /**
  57719. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  57720. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  57721. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  57722. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  57723. */
  57724. export class PhotoDome extends TextureDome<Texture> {
  57725. /**
  57726. * Define the image as a Monoscopic panoramic 360 image.
  57727. */
  57728. static readonly MODE_MONOSCOPIC: number;
  57729. /**
  57730. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  57731. */
  57732. static readonly MODE_TOPBOTTOM: number;
  57733. /**
  57734. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  57735. */
  57736. static readonly MODE_SIDEBYSIDE: number;
  57737. /**
  57738. * Gets or sets the texture being displayed on the sphere
  57739. */
  57740. get photoTexture(): Texture;
  57741. /**
  57742. * sets the texture being displayed on the sphere
  57743. */
  57744. set photoTexture(value: Texture);
  57745. /**
  57746. * Gets the current video mode for the video. It can be:
  57747. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57748. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57749. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57750. */
  57751. get imageMode(): number;
  57752. /**
  57753. * Sets the current video mode for the video. It can be:
  57754. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57755. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57756. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57757. */
  57758. set imageMode(value: number);
  57759. protected _initTexture(urlsOrElement: string, scene: Scene, options: any): Texture;
  57760. }
  57761. }
  57762. declare module "babylonjs/Misc/rgbdTextureTools" {
  57763. import "babylonjs/Shaders/rgbdDecode.fragment";
  57764. import "babylonjs/Engines/Extensions/engine.renderTarget";
  57765. import { Texture } from "babylonjs/Materials/Textures/texture";
  57766. /**
  57767. * Class used to host RGBD texture specific utilities
  57768. */
  57769. export class RGBDTextureTools {
  57770. /**
  57771. * Expand the RGBD Texture from RGBD to Half Float if possible.
  57772. * @param texture the texture to expand.
  57773. */
  57774. static ExpandRGBDTexture(texture: Texture): void;
  57775. }
  57776. }
  57777. declare module "babylonjs/Misc/brdfTextureTools" {
  57778. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57779. import { Scene } from "babylonjs/scene";
  57780. /**
  57781. * Class used to host texture specific utilities
  57782. */
  57783. export class BRDFTextureTools {
  57784. /**
  57785. * Prevents texture cache collision
  57786. */
  57787. private static _instanceNumber;
  57788. /**
  57789. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  57790. * @param scene defines the hosting scene
  57791. * @returns the environment BRDF texture
  57792. */
  57793. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  57794. private static _environmentBRDFBase64Texture;
  57795. }
  57796. }
  57797. declare module "babylonjs/Materials/PBR/pbrClearCoatConfiguration" {
  57798. import { Nullable } from "babylonjs/types";
  57799. import { Color3 } from "babylonjs/Maths/math.color";
  57800. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57801. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57802. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57803. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57804. import { Engine } from "babylonjs/Engines/engine";
  57805. import { Scene } from "babylonjs/scene";
  57806. /**
  57807. * @hidden
  57808. */
  57809. export interface IMaterialClearCoatDefines {
  57810. CLEARCOAT: boolean;
  57811. CLEARCOAT_DEFAULTIOR: boolean;
  57812. CLEARCOAT_TEXTURE: boolean;
  57813. CLEARCOAT_TEXTUREDIRECTUV: number;
  57814. CLEARCOAT_BUMP: boolean;
  57815. CLEARCOAT_BUMPDIRECTUV: number;
  57816. CLEARCOAT_TINT: boolean;
  57817. CLEARCOAT_TINT_TEXTURE: boolean;
  57818. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  57819. /** @hidden */
  57820. _areTexturesDirty: boolean;
  57821. }
  57822. /**
  57823. * Define the code related to the clear coat parameters of the pbr material.
  57824. */
  57825. export class PBRClearCoatConfiguration {
  57826. /**
  57827. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  57828. * The default fits with a polyurethane material.
  57829. */
  57830. private static readonly _DefaultIndexOfRefraction;
  57831. private _isEnabled;
  57832. /**
  57833. * Defines if the clear coat is enabled in the material.
  57834. */
  57835. isEnabled: boolean;
  57836. /**
  57837. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  57838. */
  57839. intensity: number;
  57840. /**
  57841. * Defines the clear coat layer roughness.
  57842. */
  57843. roughness: number;
  57844. private _indexOfRefraction;
  57845. /**
  57846. * Defines the index of refraction of the clear coat.
  57847. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  57848. * The default fits with a polyurethane material.
  57849. * Changing the default value is more performance intensive.
  57850. */
  57851. indexOfRefraction: number;
  57852. private _texture;
  57853. /**
  57854. * Stores the clear coat values in a texture.
  57855. */
  57856. texture: Nullable<BaseTexture>;
  57857. private _bumpTexture;
  57858. /**
  57859. * Define the clear coat specific bump texture.
  57860. */
  57861. bumpTexture: Nullable<BaseTexture>;
  57862. private _isTintEnabled;
  57863. /**
  57864. * Defines if the clear coat tint is enabled in the material.
  57865. */
  57866. isTintEnabled: boolean;
  57867. /**
  57868. * Defines the clear coat tint of the material.
  57869. * This is only use if tint is enabled
  57870. */
  57871. tintColor: Color3;
  57872. /**
  57873. * Defines the distance at which the tint color should be found in the
  57874. * clear coat media.
  57875. * This is only use if tint is enabled
  57876. */
  57877. tintColorAtDistance: number;
  57878. /**
  57879. * Defines the clear coat layer thickness.
  57880. * This is only use if tint is enabled
  57881. */
  57882. tintThickness: number;
  57883. private _tintTexture;
  57884. /**
  57885. * Stores the clear tint values in a texture.
  57886. * rgb is tint
  57887. * a is a thickness factor
  57888. */
  57889. tintTexture: Nullable<BaseTexture>;
  57890. /** @hidden */
  57891. private _internalMarkAllSubMeshesAsTexturesDirty;
  57892. /** @hidden */
  57893. _markAllSubMeshesAsTexturesDirty(): void;
  57894. /**
  57895. * Instantiate a new istance of clear coat configuration.
  57896. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57897. */
  57898. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57899. /**
  57900. * Gets wehter the submesh is ready to be used or not.
  57901. * @param defines the list of "defines" to update.
  57902. * @param scene defines the scene the material belongs to.
  57903. * @param engine defines the engine the material belongs to.
  57904. * @param disableBumpMap defines wether the material disables bump or not.
  57905. * @returns - boolean indicating that the submesh is ready or not.
  57906. */
  57907. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  57908. /**
  57909. * Checks to see if a texture is used in the material.
  57910. * @param defines the list of "defines" to update.
  57911. * @param scene defines the scene to the material belongs to.
  57912. */
  57913. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  57914. /**
  57915. * Binds the material data.
  57916. * @param uniformBuffer defines the Uniform buffer to fill in.
  57917. * @param scene defines the scene the material belongs to.
  57918. * @param engine defines the engine the material belongs to.
  57919. * @param disableBumpMap defines wether the material disables bump or not.
  57920. * @param isFrozen defines wether the material is frozen or not.
  57921. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  57922. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  57923. */
  57924. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  57925. /**
  57926. * Checks to see if a texture is used in the material.
  57927. * @param texture - Base texture to use.
  57928. * @returns - Boolean specifying if a texture is used in the material.
  57929. */
  57930. hasTexture(texture: BaseTexture): boolean;
  57931. /**
  57932. * Returns an array of the actively used textures.
  57933. * @param activeTextures Array of BaseTextures
  57934. */
  57935. getActiveTextures(activeTextures: BaseTexture[]): void;
  57936. /**
  57937. * Returns the animatable textures.
  57938. * @param animatables Array of animatable textures.
  57939. */
  57940. getAnimatables(animatables: IAnimatable[]): void;
  57941. /**
  57942. * Disposes the resources of the material.
  57943. * @param forceDisposeTextures - Forces the disposal of all textures.
  57944. */
  57945. dispose(forceDisposeTextures?: boolean): void;
  57946. /**
  57947. * Get the current class name of the texture useful for serialization or dynamic coding.
  57948. * @returns "PBRClearCoatConfiguration"
  57949. */
  57950. getClassName(): string;
  57951. /**
  57952. * Add fallbacks to the effect fallbacks list.
  57953. * @param defines defines the Base texture to use.
  57954. * @param fallbacks defines the current fallback list.
  57955. * @param currentRank defines the current fallback rank.
  57956. * @returns the new fallback rank.
  57957. */
  57958. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57959. /**
  57960. * Add the required uniforms to the current list.
  57961. * @param uniforms defines the current uniform list.
  57962. */
  57963. static AddUniforms(uniforms: string[]): void;
  57964. /**
  57965. * Add the required samplers to the current list.
  57966. * @param samplers defines the current sampler list.
  57967. */
  57968. static AddSamplers(samplers: string[]): void;
  57969. /**
  57970. * Add the required uniforms to the current buffer.
  57971. * @param uniformBuffer defines the current uniform buffer.
  57972. */
  57973. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57974. /**
  57975. * Makes a duplicate of the current configuration into another one.
  57976. * @param clearCoatConfiguration define the config where to copy the info
  57977. */
  57978. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  57979. /**
  57980. * Serializes this clear coat configuration.
  57981. * @returns - An object with the serialized config.
  57982. */
  57983. serialize(): any;
  57984. /**
  57985. * Parses a anisotropy Configuration from a serialized object.
  57986. * @param source - Serialized object.
  57987. * @param scene Defines the scene we are parsing for
  57988. * @param rootUrl Defines the rootUrl to load from
  57989. */
  57990. parse(source: any, scene: Scene, rootUrl: string): void;
  57991. }
  57992. }
  57993. declare module "babylonjs/Materials/PBR/pbrAnisotropicConfiguration" {
  57994. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57995. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57996. import { Vector2 } from "babylonjs/Maths/math.vector";
  57997. import { Scene } from "babylonjs/scene";
  57998. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57999. import { Nullable } from "babylonjs/types";
  58000. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58001. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  58002. /**
  58003. * @hidden
  58004. */
  58005. export interface IMaterialAnisotropicDefines {
  58006. ANISOTROPIC: boolean;
  58007. ANISOTROPIC_TEXTURE: boolean;
  58008. ANISOTROPIC_TEXTUREDIRECTUV: number;
  58009. MAINUV1: boolean;
  58010. _areTexturesDirty: boolean;
  58011. _needUVs: boolean;
  58012. }
  58013. /**
  58014. * Define the code related to the anisotropic parameters of the pbr material.
  58015. */
  58016. export class PBRAnisotropicConfiguration {
  58017. private _isEnabled;
  58018. /**
  58019. * Defines if the anisotropy is enabled in the material.
  58020. */
  58021. isEnabled: boolean;
  58022. /**
  58023. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  58024. */
  58025. intensity: number;
  58026. /**
  58027. * Defines if the effect is along the tangents, bitangents or in between.
  58028. * By default, the effect is "strectching" the highlights along the tangents.
  58029. */
  58030. direction: Vector2;
  58031. private _texture;
  58032. /**
  58033. * Stores the anisotropy values in a texture.
  58034. * rg is direction (like normal from -1 to 1)
  58035. * b is a intensity
  58036. */
  58037. texture: Nullable<BaseTexture>;
  58038. /** @hidden */
  58039. private _internalMarkAllSubMeshesAsTexturesDirty;
  58040. /** @hidden */
  58041. _markAllSubMeshesAsTexturesDirty(): void;
  58042. /**
  58043. * Instantiate a new istance of anisotropy configuration.
  58044. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  58045. */
  58046. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  58047. /**
  58048. * Specifies that the submesh is ready to be used.
  58049. * @param defines the list of "defines" to update.
  58050. * @param scene defines the scene the material belongs to.
  58051. * @returns - boolean indicating that the submesh is ready or not.
  58052. */
  58053. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  58054. /**
  58055. * Checks to see if a texture is used in the material.
  58056. * @param defines the list of "defines" to update.
  58057. * @param mesh the mesh we are preparing the defines for.
  58058. * @param scene defines the scene the material belongs to.
  58059. */
  58060. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  58061. /**
  58062. * Binds the material data.
  58063. * @param uniformBuffer defines the Uniform buffer to fill in.
  58064. * @param scene defines the scene the material belongs to.
  58065. * @param isFrozen defines wether the material is frozen or not.
  58066. */
  58067. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  58068. /**
  58069. * Checks to see if a texture is used in the material.
  58070. * @param texture - Base texture to use.
  58071. * @returns - Boolean specifying if a texture is used in the material.
  58072. */
  58073. hasTexture(texture: BaseTexture): boolean;
  58074. /**
  58075. * Returns an array of the actively used textures.
  58076. * @param activeTextures Array of BaseTextures
  58077. */
  58078. getActiveTextures(activeTextures: BaseTexture[]): void;
  58079. /**
  58080. * Returns the animatable textures.
  58081. * @param animatables Array of animatable textures.
  58082. */
  58083. getAnimatables(animatables: IAnimatable[]): void;
  58084. /**
  58085. * Disposes the resources of the material.
  58086. * @param forceDisposeTextures - Forces the disposal of all textures.
  58087. */
  58088. dispose(forceDisposeTextures?: boolean): void;
  58089. /**
  58090. * Get the current class name of the texture useful for serialization or dynamic coding.
  58091. * @returns "PBRAnisotropicConfiguration"
  58092. */
  58093. getClassName(): string;
  58094. /**
  58095. * Add fallbacks to the effect fallbacks list.
  58096. * @param defines defines the Base texture to use.
  58097. * @param fallbacks defines the current fallback list.
  58098. * @param currentRank defines the current fallback rank.
  58099. * @returns the new fallback rank.
  58100. */
  58101. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  58102. /**
  58103. * Add the required uniforms to the current list.
  58104. * @param uniforms defines the current uniform list.
  58105. */
  58106. static AddUniforms(uniforms: string[]): void;
  58107. /**
  58108. * Add the required uniforms to the current buffer.
  58109. * @param uniformBuffer defines the current uniform buffer.
  58110. */
  58111. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  58112. /**
  58113. * Add the required samplers to the current list.
  58114. * @param samplers defines the current sampler list.
  58115. */
  58116. static AddSamplers(samplers: string[]): void;
  58117. /**
  58118. * Makes a duplicate of the current configuration into another one.
  58119. * @param anisotropicConfiguration define the config where to copy the info
  58120. */
  58121. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  58122. /**
  58123. * Serializes this anisotropy configuration.
  58124. * @returns - An object with the serialized config.
  58125. */
  58126. serialize(): any;
  58127. /**
  58128. * Parses a anisotropy Configuration from a serialized object.
  58129. * @param source - Serialized object.
  58130. * @param scene Defines the scene we are parsing for
  58131. * @param rootUrl Defines the rootUrl to load from
  58132. */
  58133. parse(source: any, scene: Scene, rootUrl: string): void;
  58134. }
  58135. }
  58136. declare module "babylonjs/Materials/PBR/pbrBRDFConfiguration" {
  58137. import { Scene } from "babylonjs/scene";
  58138. /**
  58139. * @hidden
  58140. */
  58141. export interface IMaterialBRDFDefines {
  58142. BRDF_V_HEIGHT_CORRELATED: boolean;
  58143. MS_BRDF_ENERGY_CONSERVATION: boolean;
  58144. SPHERICAL_HARMONICS: boolean;
  58145. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  58146. /** @hidden */
  58147. _areMiscDirty: boolean;
  58148. }
  58149. /**
  58150. * Define the code related to the BRDF parameters of the pbr material.
  58151. */
  58152. export class PBRBRDFConfiguration {
  58153. /**
  58154. * Default value used for the energy conservation.
  58155. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  58156. */
  58157. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  58158. /**
  58159. * Default value used for the Smith Visibility Height Correlated mode.
  58160. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  58161. */
  58162. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  58163. /**
  58164. * Default value used for the IBL diffuse part.
  58165. * This can help switching back to the polynomials mode globally which is a tiny bit
  58166. * less GPU intensive at the drawback of a lower quality.
  58167. */
  58168. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  58169. /**
  58170. * Default value used for activating energy conservation for the specular workflow.
  58171. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  58172. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  58173. */
  58174. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  58175. private _useEnergyConservation;
  58176. /**
  58177. * Defines if the material uses energy conservation.
  58178. */
  58179. useEnergyConservation: boolean;
  58180. private _useSmithVisibilityHeightCorrelated;
  58181. /**
  58182. * LEGACY Mode set to false
  58183. * Defines if the material uses height smith correlated visibility term.
  58184. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  58185. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  58186. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  58187. * Not relying on height correlated will also disable energy conservation.
  58188. */
  58189. useSmithVisibilityHeightCorrelated: boolean;
  58190. private _useSphericalHarmonics;
  58191. /**
  58192. * LEGACY Mode set to false
  58193. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  58194. * diffuse part of the IBL.
  58195. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  58196. * to the ground truth.
  58197. */
  58198. useSphericalHarmonics: boolean;
  58199. private _useSpecularGlossinessInputEnergyConservation;
  58200. /**
  58201. * Defines if the material uses energy conservation, when the specular workflow is active.
  58202. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  58203. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  58204. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  58205. */
  58206. useSpecularGlossinessInputEnergyConservation: boolean;
  58207. /** @hidden */
  58208. private _internalMarkAllSubMeshesAsMiscDirty;
  58209. /** @hidden */
  58210. _markAllSubMeshesAsMiscDirty(): void;
  58211. /**
  58212. * Instantiate a new istance of clear coat configuration.
  58213. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  58214. */
  58215. constructor(markAllSubMeshesAsMiscDirty: () => void);
  58216. /**
  58217. * Checks to see if a texture is used in the material.
  58218. * @param defines the list of "defines" to update.
  58219. */
  58220. prepareDefines(defines: IMaterialBRDFDefines): void;
  58221. /**
  58222. * Get the current class name of the texture useful for serialization or dynamic coding.
  58223. * @returns "PBRClearCoatConfiguration"
  58224. */
  58225. getClassName(): string;
  58226. /**
  58227. * Makes a duplicate of the current configuration into another one.
  58228. * @param brdfConfiguration define the config where to copy the info
  58229. */
  58230. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  58231. /**
  58232. * Serializes this BRDF configuration.
  58233. * @returns - An object with the serialized config.
  58234. */
  58235. serialize(): any;
  58236. /**
  58237. * Parses a anisotropy Configuration from a serialized object.
  58238. * @param source - Serialized object.
  58239. * @param scene Defines the scene we are parsing for
  58240. * @param rootUrl Defines the rootUrl to load from
  58241. */
  58242. parse(source: any, scene: Scene, rootUrl: string): void;
  58243. }
  58244. }
  58245. declare module "babylonjs/Materials/PBR/pbrSheenConfiguration" {
  58246. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  58247. import { Color3 } from "babylonjs/Maths/math.color";
  58248. import { Scene } from "babylonjs/scene";
  58249. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58250. import { Nullable } from "babylonjs/types";
  58251. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58252. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  58253. /**
  58254. * @hidden
  58255. */
  58256. export interface IMaterialSheenDefines {
  58257. SHEEN: boolean;
  58258. SHEEN_TEXTURE: boolean;
  58259. SHEEN_TEXTUREDIRECTUV: number;
  58260. SHEEN_LINKWITHALBEDO: boolean;
  58261. SHEEN_ROUGHNESS: boolean;
  58262. SHEEN_ALBEDOSCALING: boolean;
  58263. /** @hidden */
  58264. _areTexturesDirty: boolean;
  58265. }
  58266. /**
  58267. * Define the code related to the Sheen parameters of the pbr material.
  58268. */
  58269. export class PBRSheenConfiguration {
  58270. private _isEnabled;
  58271. /**
  58272. * Defines if the material uses sheen.
  58273. */
  58274. isEnabled: boolean;
  58275. private _linkSheenWithAlbedo;
  58276. /**
  58277. * Defines if the sheen is linked to the sheen color.
  58278. */
  58279. linkSheenWithAlbedo: boolean;
  58280. /**
  58281. * Defines the sheen intensity.
  58282. */
  58283. intensity: number;
  58284. /**
  58285. * Defines the sheen color.
  58286. */
  58287. color: Color3;
  58288. private _texture;
  58289. /**
  58290. * Stores the sheen tint values in a texture.
  58291. * rgb is tint
  58292. * a is a intensity or roughness if roughness has been defined
  58293. */
  58294. texture: Nullable<BaseTexture>;
  58295. private _roughness;
  58296. /**
  58297. * Defines the sheen roughness.
  58298. * It is not taken into account if linkSheenWithAlbedo is true.
  58299. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  58300. */
  58301. roughness: Nullable<number>;
  58302. private _albedoScaling;
  58303. /**
  58304. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  58305. * It allows the strength of the sheen effect to not depend on the base color of the material,
  58306. * making it easier to setup and tweak the effect
  58307. */
  58308. albedoScaling: boolean;
  58309. /** @hidden */
  58310. private _internalMarkAllSubMeshesAsTexturesDirty;
  58311. /** @hidden */
  58312. _markAllSubMeshesAsTexturesDirty(): void;
  58313. /**
  58314. * Instantiate a new istance of clear coat configuration.
  58315. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  58316. */
  58317. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  58318. /**
  58319. * Specifies that the submesh is ready to be used.
  58320. * @param defines the list of "defines" to update.
  58321. * @param scene defines the scene the material belongs to.
  58322. * @returns - boolean indicating that the submesh is ready or not.
  58323. */
  58324. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  58325. /**
  58326. * Checks to see if a texture is used in the material.
  58327. * @param defines the list of "defines" to update.
  58328. * @param scene defines the scene the material belongs to.
  58329. */
  58330. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  58331. /**
  58332. * Binds the material data.
  58333. * @param uniformBuffer defines the Uniform buffer to fill in.
  58334. * @param scene defines the scene the material belongs to.
  58335. * @param isFrozen defines wether the material is frozen or not.
  58336. */
  58337. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  58338. /**
  58339. * Checks to see if a texture is used in the material.
  58340. * @param texture - Base texture to use.
  58341. * @returns - Boolean specifying if a texture is used in the material.
  58342. */
  58343. hasTexture(texture: BaseTexture): boolean;
  58344. /**
  58345. * Returns an array of the actively used textures.
  58346. * @param activeTextures Array of BaseTextures
  58347. */
  58348. getActiveTextures(activeTextures: BaseTexture[]): void;
  58349. /**
  58350. * Returns the animatable textures.
  58351. * @param animatables Array of animatable textures.
  58352. */
  58353. getAnimatables(animatables: IAnimatable[]): void;
  58354. /**
  58355. * Disposes the resources of the material.
  58356. * @param forceDisposeTextures - Forces the disposal of all textures.
  58357. */
  58358. dispose(forceDisposeTextures?: boolean): void;
  58359. /**
  58360. * Get the current class name of the texture useful for serialization or dynamic coding.
  58361. * @returns "PBRSheenConfiguration"
  58362. */
  58363. getClassName(): string;
  58364. /**
  58365. * Add fallbacks to the effect fallbacks list.
  58366. * @param defines defines the Base texture to use.
  58367. * @param fallbacks defines the current fallback list.
  58368. * @param currentRank defines the current fallback rank.
  58369. * @returns the new fallback rank.
  58370. */
  58371. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  58372. /**
  58373. * Add the required uniforms to the current list.
  58374. * @param uniforms defines the current uniform list.
  58375. */
  58376. static AddUniforms(uniforms: string[]): void;
  58377. /**
  58378. * Add the required uniforms to the current buffer.
  58379. * @param uniformBuffer defines the current uniform buffer.
  58380. */
  58381. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  58382. /**
  58383. * Add the required samplers to the current list.
  58384. * @param samplers defines the current sampler list.
  58385. */
  58386. static AddSamplers(samplers: string[]): void;
  58387. /**
  58388. * Makes a duplicate of the current configuration into another one.
  58389. * @param sheenConfiguration define the config where to copy the info
  58390. */
  58391. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  58392. /**
  58393. * Serializes this BRDF configuration.
  58394. * @returns - An object with the serialized config.
  58395. */
  58396. serialize(): any;
  58397. /**
  58398. * Parses a anisotropy Configuration from a serialized object.
  58399. * @param source - Serialized object.
  58400. * @param scene Defines the scene we are parsing for
  58401. * @param rootUrl Defines the rootUrl to load from
  58402. */
  58403. parse(source: any, scene: Scene, rootUrl: string): void;
  58404. }
  58405. }
  58406. declare module "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration" {
  58407. import { Nullable } from "babylonjs/types";
  58408. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58409. import { Color3 } from "babylonjs/Maths/math.color";
  58410. import { SmartArray } from "babylonjs/Misc/smartArray";
  58411. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58412. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  58413. import { Effect } from "babylonjs/Materials/effect";
  58414. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  58415. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  58416. import { Engine } from "babylonjs/Engines/engine";
  58417. import { Scene } from "babylonjs/scene";
  58418. /**
  58419. * @hidden
  58420. */
  58421. export interface IMaterialSubSurfaceDefines {
  58422. SUBSURFACE: boolean;
  58423. SS_REFRACTION: boolean;
  58424. SS_TRANSLUCENCY: boolean;
  58425. SS_SCATTERING: boolean;
  58426. SS_THICKNESSANDMASK_TEXTURE: boolean;
  58427. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  58428. SS_REFRACTIONMAP_3D: boolean;
  58429. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  58430. SS_LODINREFRACTIONALPHA: boolean;
  58431. SS_GAMMAREFRACTION: boolean;
  58432. SS_RGBDREFRACTION: boolean;
  58433. SS_LINEARSPECULARREFRACTION: boolean;
  58434. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  58435. SS_ALBEDOFORREFRACTIONTINT: boolean;
  58436. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  58437. /** @hidden */
  58438. _areTexturesDirty: boolean;
  58439. }
  58440. /**
  58441. * Define the code related to the sub surface parameters of the pbr material.
  58442. */
  58443. export class PBRSubSurfaceConfiguration {
  58444. private _isRefractionEnabled;
  58445. /**
  58446. * Defines if the refraction is enabled in the material.
  58447. */
  58448. isRefractionEnabled: boolean;
  58449. private _isTranslucencyEnabled;
  58450. /**
  58451. * Defines if the translucency is enabled in the material.
  58452. */
  58453. isTranslucencyEnabled: boolean;
  58454. private _isScatteringEnabled;
  58455. /**
  58456. * Defines if the sub surface scattering is enabled in the material.
  58457. */
  58458. isScatteringEnabled: boolean;
  58459. private _scatteringDiffusionProfileIndex;
  58460. /**
  58461. * Diffusion profile for subsurface scattering.
  58462. * Useful for better scattering in the skins or foliages.
  58463. */
  58464. get scatteringDiffusionProfile(): Nullable<Color3>;
  58465. set scatteringDiffusionProfile(c: Nullable<Color3>);
  58466. /**
  58467. * Defines the refraction intensity of the material.
  58468. * The refraction when enabled replaces the Diffuse part of the material.
  58469. * The intensity helps transitionning between diffuse and refraction.
  58470. */
  58471. refractionIntensity: number;
  58472. /**
  58473. * Defines the translucency intensity of the material.
  58474. * When translucency has been enabled, this defines how much of the "translucency"
  58475. * is addded to the diffuse part of the material.
  58476. */
  58477. translucencyIntensity: number;
  58478. /**
  58479. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  58480. */
  58481. useAlbedoToTintRefraction: boolean;
  58482. private _thicknessTexture;
  58483. /**
  58484. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  58485. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  58486. * 0 would mean minimumThickness
  58487. * 1 would mean maximumThickness
  58488. * The other channels might be use as a mask to vary the different effects intensity.
  58489. */
  58490. thicknessTexture: Nullable<BaseTexture>;
  58491. private _refractionTexture;
  58492. /**
  58493. * Defines the texture to use for refraction.
  58494. */
  58495. refractionTexture: Nullable<BaseTexture>;
  58496. private _indexOfRefraction;
  58497. /**
  58498. * Index of refraction of the material base layer.
  58499. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  58500. *
  58501. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  58502. *
  58503. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  58504. */
  58505. indexOfRefraction: number;
  58506. private _volumeIndexOfRefraction;
  58507. /**
  58508. * Index of refraction of the material's volume.
  58509. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  58510. *
  58511. * This ONLY impacts refraction. If not provided or given a non-valid value,
  58512. * the volume will use the same IOR as the surface.
  58513. */
  58514. get volumeIndexOfRefraction(): number;
  58515. set volumeIndexOfRefraction(value: number);
  58516. private _invertRefractionY;
  58517. /**
  58518. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  58519. */
  58520. invertRefractionY: boolean;
  58521. private _linkRefractionWithTransparency;
  58522. /**
  58523. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  58524. * Materials half opaque for instance using refraction could benefit from this control.
  58525. */
  58526. linkRefractionWithTransparency: boolean;
  58527. /**
  58528. * Defines the minimum thickness stored in the thickness map.
  58529. * If no thickness map is defined, this value will be used to simulate thickness.
  58530. */
  58531. minimumThickness: number;
  58532. /**
  58533. * Defines the maximum thickness stored in the thickness map.
  58534. */
  58535. maximumThickness: number;
  58536. /**
  58537. * Defines the volume tint of the material.
  58538. * This is used for both translucency and scattering.
  58539. */
  58540. tintColor: Color3;
  58541. /**
  58542. * Defines the distance at which the tint color should be found in the media.
  58543. * This is used for refraction only.
  58544. */
  58545. tintColorAtDistance: number;
  58546. /**
  58547. * Defines how far each channel transmit through the media.
  58548. * It is defined as a color to simplify it selection.
  58549. */
  58550. diffusionDistance: Color3;
  58551. private _useMaskFromThicknessTexture;
  58552. /**
  58553. * Stores the intensity of the different subsurface effects in the thickness texture.
  58554. * * the green channel is the translucency intensity.
  58555. * * the blue channel is the scattering intensity.
  58556. * * the alpha channel is the refraction intensity.
  58557. */
  58558. useMaskFromThicknessTexture: boolean;
  58559. private _scene;
  58560. /** @hidden */
  58561. private _internalMarkAllSubMeshesAsTexturesDirty;
  58562. private _internalMarkScenePrePassDirty;
  58563. /** @hidden */
  58564. _markAllSubMeshesAsTexturesDirty(): void;
  58565. /** @hidden */
  58566. _markScenePrePassDirty(): void;
  58567. /**
  58568. * Instantiate a new istance of sub surface configuration.
  58569. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  58570. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  58571. * @param scene The scene
  58572. */
  58573. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  58574. /**
  58575. * Gets wehter the submesh is ready to be used or not.
  58576. * @param defines the list of "defines" to update.
  58577. * @param scene defines the scene the material belongs to.
  58578. * @returns - boolean indicating that the submesh is ready or not.
  58579. */
  58580. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  58581. /**
  58582. * Checks to see if a texture is used in the material.
  58583. * @param defines the list of "defines" to update.
  58584. * @param scene defines the scene to the material belongs to.
  58585. */
  58586. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  58587. /**
  58588. * Binds the material data.
  58589. * @param uniformBuffer defines the Uniform buffer to fill in.
  58590. * @param scene defines the scene the material belongs to.
  58591. * @param engine defines the engine the material belongs to.
  58592. * @param isFrozen defines whether the material is frozen or not.
  58593. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  58594. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  58595. */
  58596. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  58597. /**
  58598. * Unbinds the material from the mesh.
  58599. * @param activeEffect defines the effect that should be unbound from.
  58600. * @returns true if unbound, otherwise false
  58601. */
  58602. unbind(activeEffect: Effect): boolean;
  58603. /**
  58604. * Returns the texture used for refraction or null if none is used.
  58605. * @param scene defines the scene the material belongs to.
  58606. * @returns - Refraction texture if present. If no refraction texture and refraction
  58607. * is linked with transparency, returns environment texture. Otherwise, returns null.
  58608. */
  58609. private _getRefractionTexture;
  58610. /**
  58611. * Returns true if alpha blending should be disabled.
  58612. */
  58613. get disableAlphaBlending(): boolean;
  58614. /**
  58615. * Fills the list of render target textures.
  58616. * @param renderTargets the list of render targets to update
  58617. */
  58618. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  58619. /**
  58620. * Checks to see if a texture is used in the material.
  58621. * @param texture - Base texture to use.
  58622. * @returns - Boolean specifying if a texture is used in the material.
  58623. */
  58624. hasTexture(texture: BaseTexture): boolean;
  58625. /**
  58626. * Gets a boolean indicating that current material needs to register RTT
  58627. * @returns true if this uses a render target otherwise false.
  58628. */
  58629. hasRenderTargetTextures(): boolean;
  58630. /**
  58631. * Returns an array of the actively used textures.
  58632. * @param activeTextures Array of BaseTextures
  58633. */
  58634. getActiveTextures(activeTextures: BaseTexture[]): void;
  58635. /**
  58636. * Returns the animatable textures.
  58637. * @param animatables Array of animatable textures.
  58638. */
  58639. getAnimatables(animatables: IAnimatable[]): void;
  58640. /**
  58641. * Disposes the resources of the material.
  58642. * @param forceDisposeTextures - Forces the disposal of all textures.
  58643. */
  58644. dispose(forceDisposeTextures?: boolean): void;
  58645. /**
  58646. * Get the current class name of the texture useful for serialization or dynamic coding.
  58647. * @returns "PBRSubSurfaceConfiguration"
  58648. */
  58649. getClassName(): string;
  58650. /**
  58651. * Add fallbacks to the effect fallbacks list.
  58652. * @param defines defines the Base texture to use.
  58653. * @param fallbacks defines the current fallback list.
  58654. * @param currentRank defines the current fallback rank.
  58655. * @returns the new fallback rank.
  58656. */
  58657. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  58658. /**
  58659. * Add the required uniforms to the current list.
  58660. * @param uniforms defines the current uniform list.
  58661. */
  58662. static AddUniforms(uniforms: string[]): void;
  58663. /**
  58664. * Add the required samplers to the current list.
  58665. * @param samplers defines the current sampler list.
  58666. */
  58667. static AddSamplers(samplers: string[]): void;
  58668. /**
  58669. * Add the required uniforms to the current buffer.
  58670. * @param uniformBuffer defines the current uniform buffer.
  58671. */
  58672. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  58673. /**
  58674. * Makes a duplicate of the current configuration into another one.
  58675. * @param configuration define the config where to copy the info
  58676. */
  58677. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  58678. /**
  58679. * Serializes this Sub Surface configuration.
  58680. * @returns - An object with the serialized config.
  58681. */
  58682. serialize(): any;
  58683. /**
  58684. * Parses a anisotropy Configuration from a serialized object.
  58685. * @param source - Serialized object.
  58686. * @param scene Defines the scene we are parsing for
  58687. * @param rootUrl Defines the rootUrl to load from
  58688. */
  58689. parse(source: any, scene: Scene, rootUrl: string): void;
  58690. }
  58691. }
  58692. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration" {
  58693. /** @hidden */
  58694. export var pbrFragmentDeclaration: {
  58695. name: string;
  58696. shader: string;
  58697. };
  58698. }
  58699. declare module "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration" {
  58700. /** @hidden */
  58701. export var pbrUboDeclaration: {
  58702. name: string;
  58703. shader: string;
  58704. };
  58705. }
  58706. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration" {
  58707. /** @hidden */
  58708. export var pbrFragmentExtraDeclaration: {
  58709. name: string;
  58710. shader: string;
  58711. };
  58712. }
  58713. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration" {
  58714. /** @hidden */
  58715. export var pbrFragmentSamplersDeclaration: {
  58716. name: string;
  58717. shader: string;
  58718. };
  58719. }
  58720. declare module "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions" {
  58721. /** @hidden */
  58722. export var subSurfaceScatteringFunctions: {
  58723. name: string;
  58724. shader: string;
  58725. };
  58726. }
  58727. declare module "babylonjs/Shaders/ShadersInclude/importanceSampling" {
  58728. /** @hidden */
  58729. export var importanceSampling: {
  58730. name: string;
  58731. shader: string;
  58732. };
  58733. }
  58734. declare module "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions" {
  58735. /** @hidden */
  58736. export var pbrHelperFunctions: {
  58737. name: string;
  58738. shader: string;
  58739. };
  58740. }
  58741. declare module "babylonjs/Shaders/ShadersInclude/harmonicsFunctions" {
  58742. /** @hidden */
  58743. export var harmonicsFunctions: {
  58744. name: string;
  58745. shader: string;
  58746. };
  58747. }
  58748. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions" {
  58749. /** @hidden */
  58750. export var pbrDirectLightingSetupFunctions: {
  58751. name: string;
  58752. shader: string;
  58753. };
  58754. }
  58755. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions" {
  58756. /** @hidden */
  58757. export var pbrDirectLightingFalloffFunctions: {
  58758. name: string;
  58759. shader: string;
  58760. };
  58761. }
  58762. declare module "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions" {
  58763. /** @hidden */
  58764. export var pbrBRDFFunctions: {
  58765. name: string;
  58766. shader: string;
  58767. };
  58768. }
  58769. declare module "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions" {
  58770. /** @hidden */
  58771. export var hdrFilteringFunctions: {
  58772. name: string;
  58773. shader: string;
  58774. };
  58775. }
  58776. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions" {
  58777. /** @hidden */
  58778. export var pbrDirectLightingFunctions: {
  58779. name: string;
  58780. shader: string;
  58781. };
  58782. }
  58783. declare module "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions" {
  58784. /** @hidden */
  58785. export var pbrIBLFunctions: {
  58786. name: string;
  58787. shader: string;
  58788. };
  58789. }
  58790. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity" {
  58791. /** @hidden */
  58792. export var pbrBlockAlbedoOpacity: {
  58793. name: string;
  58794. shader: string;
  58795. };
  58796. }
  58797. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity" {
  58798. /** @hidden */
  58799. export var pbrBlockReflectivity: {
  58800. name: string;
  58801. shader: string;
  58802. };
  58803. }
  58804. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion" {
  58805. /** @hidden */
  58806. export var pbrBlockAmbientOcclusion: {
  58807. name: string;
  58808. shader: string;
  58809. };
  58810. }
  58811. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel" {
  58812. /** @hidden */
  58813. export var pbrBlockAlphaFresnel: {
  58814. name: string;
  58815. shader: string;
  58816. };
  58817. }
  58818. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic" {
  58819. /** @hidden */
  58820. export var pbrBlockAnisotropic: {
  58821. name: string;
  58822. shader: string;
  58823. };
  58824. }
  58825. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflection" {
  58826. /** @hidden */
  58827. export var pbrBlockReflection: {
  58828. name: string;
  58829. shader: string;
  58830. };
  58831. }
  58832. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSheen" {
  58833. /** @hidden */
  58834. export var pbrBlockSheen: {
  58835. name: string;
  58836. shader: string;
  58837. };
  58838. }
  58839. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat" {
  58840. /** @hidden */
  58841. export var pbrBlockClearcoat: {
  58842. name: string;
  58843. shader: string;
  58844. };
  58845. }
  58846. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface" {
  58847. /** @hidden */
  58848. export var pbrBlockSubSurface: {
  58849. name: string;
  58850. shader: string;
  58851. };
  58852. }
  58853. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric" {
  58854. /** @hidden */
  58855. export var pbrBlockNormalGeometric: {
  58856. name: string;
  58857. shader: string;
  58858. };
  58859. }
  58860. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal" {
  58861. /** @hidden */
  58862. export var pbrBlockNormalFinal: {
  58863. name: string;
  58864. shader: string;
  58865. };
  58866. }
  58867. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit" {
  58868. /** @hidden */
  58869. export var pbrBlockLightmapInit: {
  58870. name: string;
  58871. shader: string;
  58872. };
  58873. }
  58874. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo" {
  58875. /** @hidden */
  58876. export var pbrBlockGeometryInfo: {
  58877. name: string;
  58878. shader: string;
  58879. };
  58880. }
  58881. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0" {
  58882. /** @hidden */
  58883. export var pbrBlockReflectance0: {
  58884. name: string;
  58885. shader: string;
  58886. };
  58887. }
  58888. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance" {
  58889. /** @hidden */
  58890. export var pbrBlockReflectance: {
  58891. name: string;
  58892. shader: string;
  58893. };
  58894. }
  58895. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting" {
  58896. /** @hidden */
  58897. export var pbrBlockDirectLighting: {
  58898. name: string;
  58899. shader: string;
  58900. };
  58901. }
  58902. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents" {
  58903. /** @hidden */
  58904. export var pbrBlockFinalLitComponents: {
  58905. name: string;
  58906. shader: string;
  58907. };
  58908. }
  58909. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents" {
  58910. /** @hidden */
  58911. export var pbrBlockFinalUnlitComponents: {
  58912. name: string;
  58913. shader: string;
  58914. };
  58915. }
  58916. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition" {
  58917. /** @hidden */
  58918. export var pbrBlockFinalColorComposition: {
  58919. name: string;
  58920. shader: string;
  58921. };
  58922. }
  58923. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing" {
  58924. /** @hidden */
  58925. export var pbrBlockImageProcessing: {
  58926. name: string;
  58927. shader: string;
  58928. };
  58929. }
  58930. declare module "babylonjs/Shaders/ShadersInclude/pbrDebug" {
  58931. /** @hidden */
  58932. export var pbrDebug: {
  58933. name: string;
  58934. shader: string;
  58935. };
  58936. }
  58937. declare module "babylonjs/Shaders/pbr.fragment" {
  58938. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  58939. import "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration";
  58940. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  58941. import "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration";
  58942. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  58943. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  58944. import "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration";
  58945. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  58946. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  58947. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  58948. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  58949. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58950. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  58951. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  58952. import "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions";
  58953. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  58954. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  58955. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  58956. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions";
  58957. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions";
  58958. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  58959. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  58960. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions";
  58961. import "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions";
  58962. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  58963. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  58964. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  58965. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity";
  58966. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity";
  58967. import "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion";
  58968. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel";
  58969. import "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic";
  58970. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflection";
  58971. import "babylonjs/Shaders/ShadersInclude/pbrBlockSheen";
  58972. import "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat";
  58973. import "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface";
  58974. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  58975. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric";
  58976. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  58977. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal";
  58978. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  58979. import "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit";
  58980. import "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo";
  58981. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0";
  58982. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance";
  58983. import "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting";
  58984. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  58985. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents";
  58986. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents";
  58987. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition";
  58988. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  58989. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  58990. import "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing";
  58991. import "babylonjs/Shaders/ShadersInclude/pbrDebug";
  58992. /** @hidden */
  58993. export var pbrPixelShader: {
  58994. name: string;
  58995. shader: string;
  58996. };
  58997. }
  58998. declare module "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration" {
  58999. /** @hidden */
  59000. export var pbrVertexDeclaration: {
  59001. name: string;
  59002. shader: string;
  59003. };
  59004. }
  59005. declare module "babylonjs/Shaders/pbr.vertex" {
  59006. import "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration";
  59007. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  59008. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  59009. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  59010. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  59011. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  59012. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  59013. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  59014. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  59015. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  59016. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  59017. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  59018. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  59019. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  59020. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  59021. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  59022. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  59023. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  59024. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  59025. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  59026. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  59027. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  59028. /** @hidden */
  59029. export var pbrVertexShader: {
  59030. name: string;
  59031. shader: string;
  59032. };
  59033. }
  59034. declare module "babylonjs/Materials/PBR/pbrBaseMaterial" {
  59035. import { Nullable } from "babylonjs/types";
  59036. import { Scene } from "babylonjs/scene";
  59037. import { Matrix } from "babylonjs/Maths/math.vector";
  59038. import { SubMesh } from "babylonjs/Meshes/subMesh";
  59039. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  59040. import { Mesh } from "babylonjs/Meshes/mesh";
  59041. import { IMaterialClearCoatDefines, PBRClearCoatConfiguration } from "babylonjs/Materials/PBR/pbrClearCoatConfiguration";
  59042. import { IMaterialAnisotropicDefines, PBRAnisotropicConfiguration } from "babylonjs/Materials/PBR/pbrAnisotropicConfiguration";
  59043. import { IMaterialBRDFDefines, PBRBRDFConfiguration } from "babylonjs/Materials/PBR/pbrBRDFConfiguration";
  59044. import { IMaterialSheenDefines, PBRSheenConfiguration } from "babylonjs/Materials/PBR/pbrSheenConfiguration";
  59045. import { IMaterialSubSurfaceDefines, PBRSubSurfaceConfiguration } from "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration";
  59046. import { Color3 } from "babylonjs/Maths/math.color";
  59047. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  59048. import { Material, IMaterialCompilationOptions } from "babylonjs/Materials/material";
  59049. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  59050. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  59051. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  59052. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  59053. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  59054. import "babylonjs/Shaders/pbr.fragment";
  59055. import "babylonjs/Shaders/pbr.vertex";
  59056. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  59057. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  59058. /**
  59059. * Manages the defines for the PBR Material.
  59060. * @hidden
  59061. */
  59062. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  59063. PBR: boolean;
  59064. NUM_SAMPLES: string;
  59065. REALTIME_FILTERING: boolean;
  59066. MAINUV1: boolean;
  59067. MAINUV2: boolean;
  59068. UV1: boolean;
  59069. UV2: boolean;
  59070. ALBEDO: boolean;
  59071. GAMMAALBEDO: boolean;
  59072. ALBEDODIRECTUV: number;
  59073. VERTEXCOLOR: boolean;
  59074. DETAIL: boolean;
  59075. DETAILDIRECTUV: number;
  59076. DETAIL_NORMALBLENDMETHOD: number;
  59077. AMBIENT: boolean;
  59078. AMBIENTDIRECTUV: number;
  59079. AMBIENTINGRAYSCALE: boolean;
  59080. OPACITY: boolean;
  59081. VERTEXALPHA: boolean;
  59082. OPACITYDIRECTUV: number;
  59083. OPACITYRGB: boolean;
  59084. ALPHATEST: boolean;
  59085. DEPTHPREPASS: boolean;
  59086. ALPHABLEND: boolean;
  59087. ALPHAFROMALBEDO: boolean;
  59088. ALPHATESTVALUE: string;
  59089. SPECULAROVERALPHA: boolean;
  59090. RADIANCEOVERALPHA: boolean;
  59091. ALPHAFRESNEL: boolean;
  59092. LINEARALPHAFRESNEL: boolean;
  59093. PREMULTIPLYALPHA: boolean;
  59094. EMISSIVE: boolean;
  59095. EMISSIVEDIRECTUV: number;
  59096. REFLECTIVITY: boolean;
  59097. REFLECTIVITYDIRECTUV: number;
  59098. SPECULARTERM: boolean;
  59099. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  59100. MICROSURFACEAUTOMATIC: boolean;
  59101. LODBASEDMICROSFURACE: boolean;
  59102. MICROSURFACEMAP: boolean;
  59103. MICROSURFACEMAPDIRECTUV: number;
  59104. METALLICWORKFLOW: boolean;
  59105. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  59106. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  59107. METALLNESSSTOREINMETALMAPBLUE: boolean;
  59108. AOSTOREINMETALMAPRED: boolean;
  59109. METALLIC_REFLECTANCE: boolean;
  59110. METALLIC_REFLECTANCEDIRECTUV: number;
  59111. ENVIRONMENTBRDF: boolean;
  59112. ENVIRONMENTBRDF_RGBD: boolean;
  59113. NORMAL: boolean;
  59114. TANGENT: boolean;
  59115. BUMP: boolean;
  59116. BUMPDIRECTUV: number;
  59117. OBJECTSPACE_NORMALMAP: boolean;
  59118. PARALLAX: boolean;
  59119. PARALLAXOCCLUSION: boolean;
  59120. NORMALXYSCALE: boolean;
  59121. LIGHTMAP: boolean;
  59122. LIGHTMAPDIRECTUV: number;
  59123. USELIGHTMAPASSHADOWMAP: boolean;
  59124. GAMMALIGHTMAP: boolean;
  59125. RGBDLIGHTMAP: boolean;
  59126. REFLECTION: boolean;
  59127. REFLECTIONMAP_3D: boolean;
  59128. REFLECTIONMAP_SPHERICAL: boolean;
  59129. REFLECTIONMAP_PLANAR: boolean;
  59130. REFLECTIONMAP_CUBIC: boolean;
  59131. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  59132. REFLECTIONMAP_PROJECTION: boolean;
  59133. REFLECTIONMAP_SKYBOX: boolean;
  59134. REFLECTIONMAP_EXPLICIT: boolean;
  59135. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  59136. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  59137. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  59138. INVERTCUBICMAP: boolean;
  59139. USESPHERICALFROMREFLECTIONMAP: boolean;
  59140. USEIRRADIANCEMAP: boolean;
  59141. SPHERICAL_HARMONICS: boolean;
  59142. USESPHERICALINVERTEX: boolean;
  59143. REFLECTIONMAP_OPPOSITEZ: boolean;
  59144. LODINREFLECTIONALPHA: boolean;
  59145. GAMMAREFLECTION: boolean;
  59146. RGBDREFLECTION: boolean;
  59147. LINEARSPECULARREFLECTION: boolean;
  59148. RADIANCEOCCLUSION: boolean;
  59149. HORIZONOCCLUSION: boolean;
  59150. INSTANCES: boolean;
  59151. THIN_INSTANCES: boolean;
  59152. PREPASS: boolean;
  59153. PREPASS_IRRADIANCE: boolean;
  59154. PREPASS_IRRADIANCE_INDEX: number;
  59155. PREPASS_ALBEDO: boolean;
  59156. PREPASS_ALBEDO_INDEX: number;
  59157. PREPASS_DEPTHNORMAL: boolean;
  59158. PREPASS_DEPTHNORMAL_INDEX: number;
  59159. SCENE_MRT_COUNT: number;
  59160. NUM_BONE_INFLUENCERS: number;
  59161. BonesPerMesh: number;
  59162. BONETEXTURE: boolean;
  59163. NONUNIFORMSCALING: boolean;
  59164. MORPHTARGETS: boolean;
  59165. MORPHTARGETS_NORMAL: boolean;
  59166. MORPHTARGETS_TANGENT: boolean;
  59167. MORPHTARGETS_UV: boolean;
  59168. NUM_MORPH_INFLUENCERS: number;
  59169. IMAGEPROCESSING: boolean;
  59170. VIGNETTE: boolean;
  59171. VIGNETTEBLENDMODEMULTIPLY: boolean;
  59172. VIGNETTEBLENDMODEOPAQUE: boolean;
  59173. TONEMAPPING: boolean;
  59174. TONEMAPPING_ACES: boolean;
  59175. CONTRAST: boolean;
  59176. COLORCURVES: boolean;
  59177. COLORGRADING: boolean;
  59178. COLORGRADING3D: boolean;
  59179. SAMPLER3DGREENDEPTH: boolean;
  59180. SAMPLER3DBGRMAP: boolean;
  59181. IMAGEPROCESSINGPOSTPROCESS: boolean;
  59182. EXPOSURE: boolean;
  59183. MULTIVIEW: boolean;
  59184. USEPHYSICALLIGHTFALLOFF: boolean;
  59185. USEGLTFLIGHTFALLOFF: boolean;
  59186. TWOSIDEDLIGHTING: boolean;
  59187. SHADOWFLOAT: boolean;
  59188. CLIPPLANE: boolean;
  59189. CLIPPLANE2: boolean;
  59190. CLIPPLANE3: boolean;
  59191. CLIPPLANE4: boolean;
  59192. CLIPPLANE5: boolean;
  59193. CLIPPLANE6: boolean;
  59194. POINTSIZE: boolean;
  59195. FOG: boolean;
  59196. LOGARITHMICDEPTH: boolean;
  59197. FORCENORMALFORWARD: boolean;
  59198. SPECULARAA: boolean;
  59199. CLEARCOAT: boolean;
  59200. CLEARCOAT_DEFAULTIOR: boolean;
  59201. CLEARCOAT_TEXTURE: boolean;
  59202. CLEARCOAT_TEXTUREDIRECTUV: number;
  59203. CLEARCOAT_BUMP: boolean;
  59204. CLEARCOAT_BUMPDIRECTUV: number;
  59205. CLEARCOAT_TINT: boolean;
  59206. CLEARCOAT_TINT_TEXTURE: boolean;
  59207. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  59208. ANISOTROPIC: boolean;
  59209. ANISOTROPIC_TEXTURE: boolean;
  59210. ANISOTROPIC_TEXTUREDIRECTUV: number;
  59211. BRDF_V_HEIGHT_CORRELATED: boolean;
  59212. MS_BRDF_ENERGY_CONSERVATION: boolean;
  59213. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  59214. SHEEN: boolean;
  59215. SHEEN_TEXTURE: boolean;
  59216. SHEEN_TEXTUREDIRECTUV: number;
  59217. SHEEN_LINKWITHALBEDO: boolean;
  59218. SHEEN_ROUGHNESS: boolean;
  59219. SHEEN_ALBEDOSCALING: boolean;
  59220. SUBSURFACE: boolean;
  59221. SS_REFRACTION: boolean;
  59222. SS_TRANSLUCENCY: boolean;
  59223. SS_SCATTERING: boolean;
  59224. SS_THICKNESSANDMASK_TEXTURE: boolean;
  59225. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  59226. SS_REFRACTIONMAP_3D: boolean;
  59227. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  59228. SS_LODINREFRACTIONALPHA: boolean;
  59229. SS_GAMMAREFRACTION: boolean;
  59230. SS_RGBDREFRACTION: boolean;
  59231. SS_LINEARSPECULARREFRACTION: boolean;
  59232. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  59233. SS_ALBEDOFORREFRACTIONTINT: boolean;
  59234. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  59235. UNLIT: boolean;
  59236. DEBUGMODE: number;
  59237. /**
  59238. * Initializes the PBR Material defines.
  59239. */
  59240. constructor();
  59241. /**
  59242. * Resets the PBR Material defines.
  59243. */
  59244. reset(): void;
  59245. }
  59246. /**
  59247. * The Physically based material base class of BJS.
  59248. *
  59249. * This offers the main features of a standard PBR material.
  59250. * For more information, please refer to the documentation :
  59251. * https://doc.babylonjs.com/how_to/physically_based_rendering
  59252. */
  59253. export abstract class PBRBaseMaterial extends PushMaterial {
  59254. /**
  59255. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  59256. */
  59257. static readonly PBRMATERIAL_OPAQUE: number;
  59258. /**
  59259. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  59260. */
  59261. static readonly PBRMATERIAL_ALPHATEST: number;
  59262. /**
  59263. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59264. */
  59265. static readonly PBRMATERIAL_ALPHABLEND: number;
  59266. /**
  59267. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59268. * They are also discarded below the alpha cutoff threshold to improve performances.
  59269. */
  59270. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  59271. /**
  59272. * Defines the default value of how much AO map is occluding the analytical lights
  59273. * (point spot...).
  59274. */
  59275. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  59276. /**
  59277. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  59278. */
  59279. static readonly LIGHTFALLOFF_PHYSICAL: number;
  59280. /**
  59281. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  59282. * to enhance interoperability with other engines.
  59283. */
  59284. static readonly LIGHTFALLOFF_GLTF: number;
  59285. /**
  59286. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  59287. * to enhance interoperability with other materials.
  59288. */
  59289. static readonly LIGHTFALLOFF_STANDARD: number;
  59290. /**
  59291. * Intensity of the direct lights e.g. the four lights available in your scene.
  59292. * This impacts both the direct diffuse and specular highlights.
  59293. */
  59294. protected _directIntensity: number;
  59295. /**
  59296. * Intensity of the emissive part of the material.
  59297. * This helps controlling the emissive effect without modifying the emissive color.
  59298. */
  59299. protected _emissiveIntensity: number;
  59300. /**
  59301. * Intensity of the environment e.g. how much the environment will light the object
  59302. * either through harmonics for rough material or through the refelction for shiny ones.
  59303. */
  59304. protected _environmentIntensity: number;
  59305. /**
  59306. * This is a special control allowing the reduction of the specular highlights coming from the
  59307. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  59308. */
  59309. protected _specularIntensity: number;
  59310. /**
  59311. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  59312. */
  59313. private _lightingInfos;
  59314. /**
  59315. * Debug Control allowing disabling the bump map on this material.
  59316. */
  59317. protected _disableBumpMap: boolean;
  59318. /**
  59319. * AKA Diffuse Texture in standard nomenclature.
  59320. */
  59321. protected _albedoTexture: Nullable<BaseTexture>;
  59322. /**
  59323. * AKA Occlusion Texture in other nomenclature.
  59324. */
  59325. protected _ambientTexture: Nullable<BaseTexture>;
  59326. /**
  59327. * AKA Occlusion Texture Intensity in other nomenclature.
  59328. */
  59329. protected _ambientTextureStrength: number;
  59330. /**
  59331. * Defines how much the AO map is occluding the analytical lights (point spot...).
  59332. * 1 means it completely occludes it
  59333. * 0 mean it has no impact
  59334. */
  59335. protected _ambientTextureImpactOnAnalyticalLights: number;
  59336. /**
  59337. * Stores the alpha values in a texture.
  59338. */
  59339. protected _opacityTexture: Nullable<BaseTexture>;
  59340. /**
  59341. * Stores the reflection values in a texture.
  59342. */
  59343. protected _reflectionTexture: Nullable<BaseTexture>;
  59344. /**
  59345. * Stores the emissive values in a texture.
  59346. */
  59347. protected _emissiveTexture: Nullable<BaseTexture>;
  59348. /**
  59349. * AKA Specular texture in other nomenclature.
  59350. */
  59351. protected _reflectivityTexture: Nullable<BaseTexture>;
  59352. /**
  59353. * Used to switch from specular/glossiness to metallic/roughness workflow.
  59354. */
  59355. protected _metallicTexture: Nullable<BaseTexture>;
  59356. /**
  59357. * Specifies the metallic scalar of the metallic/roughness workflow.
  59358. * Can also be used to scale the metalness values of the metallic texture.
  59359. */
  59360. protected _metallic: Nullable<number>;
  59361. /**
  59362. * Specifies the roughness scalar of the metallic/roughness workflow.
  59363. * Can also be used to scale the roughness values of the metallic texture.
  59364. */
  59365. protected _roughness: Nullable<number>;
  59366. /**
  59367. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  59368. * By default the indexOfrefraction is used to compute F0;
  59369. *
  59370. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  59371. *
  59372. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  59373. * F90 = metallicReflectanceColor;
  59374. */
  59375. protected _metallicF0Factor: number;
  59376. /**
  59377. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  59378. * By default the F90 is always 1;
  59379. *
  59380. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  59381. *
  59382. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  59383. * F90 = metallicReflectanceColor;
  59384. */
  59385. protected _metallicReflectanceColor: Color3;
  59386. /**
  59387. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  59388. * This is multiply against the scalar values defined in the material.
  59389. */
  59390. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  59391. /**
  59392. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  59393. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  59394. */
  59395. protected _microSurfaceTexture: Nullable<BaseTexture>;
  59396. /**
  59397. * Stores surface normal data used to displace a mesh in a texture.
  59398. */
  59399. protected _bumpTexture: Nullable<BaseTexture>;
  59400. /**
  59401. * Stores the pre-calculated light information of a mesh in a texture.
  59402. */
  59403. protected _lightmapTexture: Nullable<BaseTexture>;
  59404. /**
  59405. * The color of a material in ambient lighting.
  59406. */
  59407. protected _ambientColor: Color3;
  59408. /**
  59409. * AKA Diffuse Color in other nomenclature.
  59410. */
  59411. protected _albedoColor: Color3;
  59412. /**
  59413. * AKA Specular Color in other nomenclature.
  59414. */
  59415. protected _reflectivityColor: Color3;
  59416. /**
  59417. * The color applied when light is reflected from a material.
  59418. */
  59419. protected _reflectionColor: Color3;
  59420. /**
  59421. * The color applied when light is emitted from a material.
  59422. */
  59423. protected _emissiveColor: Color3;
  59424. /**
  59425. * AKA Glossiness in other nomenclature.
  59426. */
  59427. protected _microSurface: number;
  59428. /**
  59429. * Specifies that the material will use the light map as a show map.
  59430. */
  59431. protected _useLightmapAsShadowmap: boolean;
  59432. /**
  59433. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  59434. * makes the reflect vector face the model (under horizon).
  59435. */
  59436. protected _useHorizonOcclusion: boolean;
  59437. /**
  59438. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  59439. * too much the area relying on ambient texture to define their ambient occlusion.
  59440. */
  59441. protected _useRadianceOcclusion: boolean;
  59442. /**
  59443. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  59444. */
  59445. protected _useAlphaFromAlbedoTexture: boolean;
  59446. /**
  59447. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  59448. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  59449. */
  59450. protected _useSpecularOverAlpha: boolean;
  59451. /**
  59452. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  59453. */
  59454. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  59455. /**
  59456. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  59457. */
  59458. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  59459. /**
  59460. * Specifies if the metallic texture contains the roughness information in its green channel.
  59461. */
  59462. protected _useRoughnessFromMetallicTextureGreen: boolean;
  59463. /**
  59464. * Specifies if the metallic texture contains the metallness information in its blue channel.
  59465. */
  59466. protected _useMetallnessFromMetallicTextureBlue: boolean;
  59467. /**
  59468. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  59469. */
  59470. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  59471. /**
  59472. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  59473. */
  59474. protected _useAmbientInGrayScale: boolean;
  59475. /**
  59476. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  59477. * The material will try to infer what glossiness each pixel should be.
  59478. */
  59479. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  59480. /**
  59481. * Defines the falloff type used in this material.
  59482. * It by default is Physical.
  59483. */
  59484. protected _lightFalloff: number;
  59485. /**
  59486. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  59487. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  59488. */
  59489. protected _useRadianceOverAlpha: boolean;
  59490. /**
  59491. * Allows using an object space normal map (instead of tangent space).
  59492. */
  59493. protected _useObjectSpaceNormalMap: boolean;
  59494. /**
  59495. * Allows using the bump map in parallax mode.
  59496. */
  59497. protected _useParallax: boolean;
  59498. /**
  59499. * Allows using the bump map in parallax occlusion mode.
  59500. */
  59501. protected _useParallaxOcclusion: boolean;
  59502. /**
  59503. * Controls the scale bias of the parallax mode.
  59504. */
  59505. protected _parallaxScaleBias: number;
  59506. /**
  59507. * If sets to true, disables all the lights affecting the material.
  59508. */
  59509. protected _disableLighting: boolean;
  59510. /**
  59511. * Number of Simultaneous lights allowed on the material.
  59512. */
  59513. protected _maxSimultaneousLights: number;
  59514. /**
  59515. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  59516. */
  59517. protected _invertNormalMapX: boolean;
  59518. /**
  59519. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  59520. */
  59521. protected _invertNormalMapY: boolean;
  59522. /**
  59523. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  59524. */
  59525. protected _twoSidedLighting: boolean;
  59526. /**
  59527. * Defines the alpha limits in alpha test mode.
  59528. */
  59529. protected _alphaCutOff: number;
  59530. /**
  59531. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  59532. */
  59533. protected _forceAlphaTest: boolean;
  59534. /**
  59535. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59536. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  59537. */
  59538. protected _useAlphaFresnel: boolean;
  59539. /**
  59540. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59541. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  59542. */
  59543. protected _useLinearAlphaFresnel: boolean;
  59544. /**
  59545. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  59546. * from cos thetav and roughness:
  59547. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  59548. */
  59549. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  59550. /**
  59551. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  59552. */
  59553. protected _forceIrradianceInFragment: boolean;
  59554. private _realTimeFiltering;
  59555. /**
  59556. * Enables realtime filtering on the texture.
  59557. */
  59558. get realTimeFiltering(): boolean;
  59559. set realTimeFiltering(b: boolean);
  59560. private _realTimeFilteringQuality;
  59561. /**
  59562. * Quality switch for realtime filtering
  59563. */
  59564. get realTimeFilteringQuality(): number;
  59565. set realTimeFilteringQuality(n: number);
  59566. /**
  59567. * Can this material render to several textures at once
  59568. */
  59569. get canRenderToMRT(): boolean;
  59570. /**
  59571. * Force normal to face away from face.
  59572. */
  59573. protected _forceNormalForward: boolean;
  59574. /**
  59575. * Enables specular anti aliasing in the PBR shader.
  59576. * It will both interacts on the Geometry for analytical and IBL lighting.
  59577. * It also prefilter the roughness map based on the bump values.
  59578. */
  59579. protected _enableSpecularAntiAliasing: boolean;
  59580. /**
  59581. * Default configuration related to image processing available in the PBR Material.
  59582. */
  59583. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  59584. /**
  59585. * Keep track of the image processing observer to allow dispose and replace.
  59586. */
  59587. private _imageProcessingObserver;
  59588. /**
  59589. * Attaches a new image processing configuration to the PBR Material.
  59590. * @param configuration
  59591. */
  59592. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  59593. /**
  59594. * Stores the available render targets.
  59595. */
  59596. private _renderTargets;
  59597. /**
  59598. * Sets the global ambient color for the material used in lighting calculations.
  59599. */
  59600. private _globalAmbientColor;
  59601. /**
  59602. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  59603. */
  59604. private _useLogarithmicDepth;
  59605. /**
  59606. * If set to true, no lighting calculations will be applied.
  59607. */
  59608. private _unlit;
  59609. private _debugMode;
  59610. /**
  59611. * @hidden
  59612. * This is reserved for the inspector.
  59613. * Defines the material debug mode.
  59614. * It helps seeing only some components of the material while troubleshooting.
  59615. */
  59616. debugMode: number;
  59617. /**
  59618. * @hidden
  59619. * This is reserved for the inspector.
  59620. * Specify from where on screen the debug mode should start.
  59621. * The value goes from -1 (full screen) to 1 (not visible)
  59622. * It helps with side by side comparison against the final render
  59623. * This defaults to -1
  59624. */
  59625. private debugLimit;
  59626. /**
  59627. * @hidden
  59628. * This is reserved for the inspector.
  59629. * As the default viewing range might not be enough (if the ambient is really small for instance)
  59630. * You can use the factor to better multiply the final value.
  59631. */
  59632. private debugFactor;
  59633. /**
  59634. * Defines the clear coat layer parameters for the material.
  59635. */
  59636. readonly clearCoat: PBRClearCoatConfiguration;
  59637. /**
  59638. * Defines the anisotropic parameters for the material.
  59639. */
  59640. readonly anisotropy: PBRAnisotropicConfiguration;
  59641. /**
  59642. * Defines the BRDF parameters for the material.
  59643. */
  59644. readonly brdf: PBRBRDFConfiguration;
  59645. /**
  59646. * Defines the Sheen parameters for the material.
  59647. */
  59648. readonly sheen: PBRSheenConfiguration;
  59649. /**
  59650. * Defines the SubSurface parameters for the material.
  59651. */
  59652. readonly subSurface: PBRSubSurfaceConfiguration;
  59653. /**
  59654. * Defines the detail map parameters for the material.
  59655. */
  59656. readonly detailMap: DetailMapConfiguration;
  59657. protected _rebuildInParallel: boolean;
  59658. /**
  59659. * Instantiates a new PBRMaterial instance.
  59660. *
  59661. * @param name The material name
  59662. * @param scene The scene the material will be use in.
  59663. */
  59664. constructor(name: string, scene: Scene);
  59665. /**
  59666. * Gets a boolean indicating that current material needs to register RTT
  59667. */
  59668. get hasRenderTargetTextures(): boolean;
  59669. /**
  59670. * Gets the name of the material class.
  59671. */
  59672. getClassName(): string;
  59673. /**
  59674. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  59675. */
  59676. get useLogarithmicDepth(): boolean;
  59677. /**
  59678. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  59679. */
  59680. set useLogarithmicDepth(value: boolean);
  59681. /**
  59682. * Returns true if alpha blending should be disabled.
  59683. */
  59684. protected get _disableAlphaBlending(): boolean;
  59685. /**
  59686. * Specifies whether or not this material should be rendered in alpha blend mode.
  59687. */
  59688. needAlphaBlending(): boolean;
  59689. /**
  59690. * Specifies whether or not this material should be rendered in alpha test mode.
  59691. */
  59692. needAlphaTesting(): boolean;
  59693. /**
  59694. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  59695. */
  59696. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  59697. /**
  59698. * Gets the texture used for the alpha test.
  59699. */
  59700. getAlphaTestTexture(): Nullable<BaseTexture>;
  59701. /**
  59702. * Specifies that the submesh is ready to be used.
  59703. * @param mesh - BJS mesh.
  59704. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  59705. * @param useInstances - Specifies that instances should be used.
  59706. * @returns - boolean indicating that the submesh is ready or not.
  59707. */
  59708. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  59709. /**
  59710. * Specifies if the material uses metallic roughness workflow.
  59711. * @returns boolean specifiying if the material uses metallic roughness workflow.
  59712. */
  59713. isMetallicWorkflow(): boolean;
  59714. private _prepareEffect;
  59715. private _prepareDefines;
  59716. /**
  59717. * Force shader compilation
  59718. */
  59719. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  59720. /**
  59721. * Initializes the uniform buffer layout for the shader.
  59722. */
  59723. buildUniformLayout(): void;
  59724. /**
  59725. * Unbinds the material from the mesh
  59726. */
  59727. unbind(): void;
  59728. /**
  59729. * Binds the submesh data.
  59730. * @param world - The world matrix.
  59731. * @param mesh - The BJS mesh.
  59732. * @param subMesh - A submesh of the BJS mesh.
  59733. */
  59734. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  59735. /**
  59736. * Returns the animatable textures.
  59737. * @returns - Array of animatable textures.
  59738. */
  59739. getAnimatables(): IAnimatable[];
  59740. /**
  59741. * Returns the texture used for reflections.
  59742. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  59743. */
  59744. private _getReflectionTexture;
  59745. /**
  59746. * Returns an array of the actively used textures.
  59747. * @returns - Array of BaseTextures
  59748. */
  59749. getActiveTextures(): BaseTexture[];
  59750. /**
  59751. * Checks to see if a texture is used in the material.
  59752. * @param texture - Base texture to use.
  59753. * @returns - Boolean specifying if a texture is used in the material.
  59754. */
  59755. hasTexture(texture: BaseTexture): boolean;
  59756. /**
  59757. * Sets the required values to the prepass renderer.
  59758. * @param prePassRenderer defines the prepass renderer to setup
  59759. */
  59760. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  59761. /**
  59762. * Disposes the resources of the material.
  59763. * @param forceDisposeEffect - Forces the disposal of effects.
  59764. * @param forceDisposeTextures - Forces the disposal of all textures.
  59765. */
  59766. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  59767. }
  59768. }
  59769. declare module "babylonjs/Materials/PBR/pbrMaterial" {
  59770. import { Nullable } from "babylonjs/types";
  59771. import { Scene } from "babylonjs/scene";
  59772. import { Color3 } from "babylonjs/Maths/math.color";
  59773. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  59774. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  59775. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  59776. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  59777. /**
  59778. * The Physically based material of BJS.
  59779. *
  59780. * This offers the main features of a standard PBR material.
  59781. * For more information, please refer to the documentation :
  59782. * https://doc.babylonjs.com/how_to/physically_based_rendering
  59783. */
  59784. export class PBRMaterial extends PBRBaseMaterial {
  59785. /**
  59786. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  59787. */
  59788. static readonly PBRMATERIAL_OPAQUE: number;
  59789. /**
  59790. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  59791. */
  59792. static readonly PBRMATERIAL_ALPHATEST: number;
  59793. /**
  59794. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59795. */
  59796. static readonly PBRMATERIAL_ALPHABLEND: number;
  59797. /**
  59798. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59799. * They are also discarded below the alpha cutoff threshold to improve performances.
  59800. */
  59801. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  59802. /**
  59803. * Defines the default value of how much AO map is occluding the analytical lights
  59804. * (point spot...).
  59805. */
  59806. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  59807. /**
  59808. * Intensity of the direct lights e.g. the four lights available in your scene.
  59809. * This impacts both the direct diffuse and specular highlights.
  59810. */
  59811. directIntensity: number;
  59812. /**
  59813. * Intensity of the emissive part of the material.
  59814. * This helps controlling the emissive effect without modifying the emissive color.
  59815. */
  59816. emissiveIntensity: number;
  59817. /**
  59818. * Intensity of the environment e.g. how much the environment will light the object
  59819. * either through harmonics for rough material or through the refelction for shiny ones.
  59820. */
  59821. environmentIntensity: number;
  59822. /**
  59823. * This is a special control allowing the reduction of the specular highlights coming from the
  59824. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  59825. */
  59826. specularIntensity: number;
  59827. /**
  59828. * Debug Control allowing disabling the bump map on this material.
  59829. */
  59830. disableBumpMap: boolean;
  59831. /**
  59832. * AKA Diffuse Texture in standard nomenclature.
  59833. */
  59834. albedoTexture: BaseTexture;
  59835. /**
  59836. * AKA Occlusion Texture in other nomenclature.
  59837. */
  59838. ambientTexture: BaseTexture;
  59839. /**
  59840. * AKA Occlusion Texture Intensity in other nomenclature.
  59841. */
  59842. ambientTextureStrength: number;
  59843. /**
  59844. * Defines how much the AO map is occluding the analytical lights (point spot...).
  59845. * 1 means it completely occludes it
  59846. * 0 mean it has no impact
  59847. */
  59848. ambientTextureImpactOnAnalyticalLights: number;
  59849. /**
  59850. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  59851. */
  59852. opacityTexture: BaseTexture;
  59853. /**
  59854. * Stores the reflection values in a texture.
  59855. */
  59856. reflectionTexture: Nullable<BaseTexture>;
  59857. /**
  59858. * Stores the emissive values in a texture.
  59859. */
  59860. emissiveTexture: BaseTexture;
  59861. /**
  59862. * AKA Specular texture in other nomenclature.
  59863. */
  59864. reflectivityTexture: BaseTexture;
  59865. /**
  59866. * Used to switch from specular/glossiness to metallic/roughness workflow.
  59867. */
  59868. metallicTexture: BaseTexture;
  59869. /**
  59870. * Specifies the metallic scalar of the metallic/roughness workflow.
  59871. * Can also be used to scale the metalness values of the metallic texture.
  59872. */
  59873. metallic: Nullable<number>;
  59874. /**
  59875. * Specifies the roughness scalar of the metallic/roughness workflow.
  59876. * Can also be used to scale the roughness values of the metallic texture.
  59877. */
  59878. roughness: Nullable<number>;
  59879. /**
  59880. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  59881. * By default the indexOfrefraction is used to compute F0;
  59882. *
  59883. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  59884. *
  59885. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  59886. * F90 = metallicReflectanceColor;
  59887. */
  59888. metallicF0Factor: number;
  59889. /**
  59890. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  59891. * By default the F90 is always 1;
  59892. *
  59893. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  59894. *
  59895. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  59896. * F90 = metallicReflectanceColor;
  59897. */
  59898. metallicReflectanceColor: Color3;
  59899. /**
  59900. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  59901. * This is multiply against the scalar values defined in the material.
  59902. */
  59903. metallicReflectanceTexture: Nullable<BaseTexture>;
  59904. /**
  59905. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  59906. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  59907. */
  59908. microSurfaceTexture: BaseTexture;
  59909. /**
  59910. * Stores surface normal data used to displace a mesh in a texture.
  59911. */
  59912. bumpTexture: BaseTexture;
  59913. /**
  59914. * Stores the pre-calculated light information of a mesh in a texture.
  59915. */
  59916. lightmapTexture: BaseTexture;
  59917. /**
  59918. * Stores the refracted light information in a texture.
  59919. */
  59920. get refractionTexture(): Nullable<BaseTexture>;
  59921. set refractionTexture(value: Nullable<BaseTexture>);
  59922. /**
  59923. * The color of a material in ambient lighting.
  59924. */
  59925. ambientColor: Color3;
  59926. /**
  59927. * AKA Diffuse Color in other nomenclature.
  59928. */
  59929. albedoColor: Color3;
  59930. /**
  59931. * AKA Specular Color in other nomenclature.
  59932. */
  59933. reflectivityColor: Color3;
  59934. /**
  59935. * The color reflected from the material.
  59936. */
  59937. reflectionColor: Color3;
  59938. /**
  59939. * The color emitted from the material.
  59940. */
  59941. emissiveColor: Color3;
  59942. /**
  59943. * AKA Glossiness in other nomenclature.
  59944. */
  59945. microSurface: number;
  59946. /**
  59947. * Index of refraction of the material base layer.
  59948. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  59949. *
  59950. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  59951. *
  59952. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  59953. */
  59954. get indexOfRefraction(): number;
  59955. set indexOfRefraction(value: number);
  59956. /**
  59957. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  59958. */
  59959. get invertRefractionY(): boolean;
  59960. set invertRefractionY(value: boolean);
  59961. /**
  59962. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  59963. * Materials half opaque for instance using refraction could benefit from this control.
  59964. */
  59965. get linkRefractionWithTransparency(): boolean;
  59966. set linkRefractionWithTransparency(value: boolean);
  59967. /**
  59968. * If true, the light map contains occlusion information instead of lighting info.
  59969. */
  59970. useLightmapAsShadowmap: boolean;
  59971. /**
  59972. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  59973. */
  59974. useAlphaFromAlbedoTexture: boolean;
  59975. /**
  59976. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  59977. */
  59978. forceAlphaTest: boolean;
  59979. /**
  59980. * Defines the alpha limits in alpha test mode.
  59981. */
  59982. alphaCutOff: number;
  59983. /**
  59984. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  59985. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  59986. */
  59987. useSpecularOverAlpha: boolean;
  59988. /**
  59989. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  59990. */
  59991. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  59992. /**
  59993. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  59994. */
  59995. useRoughnessFromMetallicTextureAlpha: boolean;
  59996. /**
  59997. * Specifies if the metallic texture contains the roughness information in its green channel.
  59998. */
  59999. useRoughnessFromMetallicTextureGreen: boolean;
  60000. /**
  60001. * Specifies if the metallic texture contains the metallness information in its blue channel.
  60002. */
  60003. useMetallnessFromMetallicTextureBlue: boolean;
  60004. /**
  60005. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  60006. */
  60007. useAmbientOcclusionFromMetallicTextureRed: boolean;
  60008. /**
  60009. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  60010. */
  60011. useAmbientInGrayScale: boolean;
  60012. /**
  60013. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  60014. * The material will try to infer what glossiness each pixel should be.
  60015. */
  60016. useAutoMicroSurfaceFromReflectivityMap: boolean;
  60017. /**
  60018. * BJS is using an harcoded light falloff based on a manually sets up range.
  60019. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  60020. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  60021. */
  60022. get usePhysicalLightFalloff(): boolean;
  60023. /**
  60024. * BJS is using an harcoded light falloff based on a manually sets up range.
  60025. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  60026. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  60027. */
  60028. set usePhysicalLightFalloff(value: boolean);
  60029. /**
  60030. * In order to support the falloff compatibility with gltf, a special mode has been added
  60031. * to reproduce the gltf light falloff.
  60032. */
  60033. get useGLTFLightFalloff(): boolean;
  60034. /**
  60035. * In order to support the falloff compatibility with gltf, a special mode has been added
  60036. * to reproduce the gltf light falloff.
  60037. */
  60038. set useGLTFLightFalloff(value: boolean);
  60039. /**
  60040. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  60041. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  60042. */
  60043. useRadianceOverAlpha: boolean;
  60044. /**
  60045. * Allows using an object space normal map (instead of tangent space).
  60046. */
  60047. useObjectSpaceNormalMap: boolean;
  60048. /**
  60049. * Allows using the bump map in parallax mode.
  60050. */
  60051. useParallax: boolean;
  60052. /**
  60053. * Allows using the bump map in parallax occlusion mode.
  60054. */
  60055. useParallaxOcclusion: boolean;
  60056. /**
  60057. * Controls the scale bias of the parallax mode.
  60058. */
  60059. parallaxScaleBias: number;
  60060. /**
  60061. * If sets to true, disables all the lights affecting the material.
  60062. */
  60063. disableLighting: boolean;
  60064. /**
  60065. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  60066. */
  60067. forceIrradianceInFragment: boolean;
  60068. /**
  60069. * Number of Simultaneous lights allowed on the material.
  60070. */
  60071. maxSimultaneousLights: number;
  60072. /**
  60073. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  60074. */
  60075. invertNormalMapX: boolean;
  60076. /**
  60077. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  60078. */
  60079. invertNormalMapY: boolean;
  60080. /**
  60081. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  60082. */
  60083. twoSidedLighting: boolean;
  60084. /**
  60085. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  60086. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  60087. */
  60088. useAlphaFresnel: boolean;
  60089. /**
  60090. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  60091. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  60092. */
  60093. useLinearAlphaFresnel: boolean;
  60094. /**
  60095. * Let user defines the brdf lookup texture used for IBL.
  60096. * A default 8bit version is embedded but you could point at :
  60097. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  60098. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  60099. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  60100. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  60101. */
  60102. environmentBRDFTexture: Nullable<BaseTexture>;
  60103. /**
  60104. * Force normal to face away from face.
  60105. */
  60106. forceNormalForward: boolean;
  60107. /**
  60108. * Enables specular anti aliasing in the PBR shader.
  60109. * It will both interacts on the Geometry for analytical and IBL lighting.
  60110. * It also prefilter the roughness map based on the bump values.
  60111. */
  60112. enableSpecularAntiAliasing: boolean;
  60113. /**
  60114. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  60115. * makes the reflect vector face the model (under horizon).
  60116. */
  60117. useHorizonOcclusion: boolean;
  60118. /**
  60119. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  60120. * too much the area relying on ambient texture to define their ambient occlusion.
  60121. */
  60122. useRadianceOcclusion: boolean;
  60123. /**
  60124. * If set to true, no lighting calculations will be applied.
  60125. */
  60126. unlit: boolean;
  60127. /**
  60128. * Gets the image processing configuration used either in this material.
  60129. */
  60130. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  60131. /**
  60132. * Sets the Default image processing configuration used either in the this material.
  60133. *
  60134. * If sets to null, the scene one is in use.
  60135. */
  60136. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  60137. /**
  60138. * Gets wether the color curves effect is enabled.
  60139. */
  60140. get cameraColorCurvesEnabled(): boolean;
  60141. /**
  60142. * Sets wether the color curves effect is enabled.
  60143. */
  60144. set cameraColorCurvesEnabled(value: boolean);
  60145. /**
  60146. * Gets wether the color grading effect is enabled.
  60147. */
  60148. get cameraColorGradingEnabled(): boolean;
  60149. /**
  60150. * Gets wether the color grading effect is enabled.
  60151. */
  60152. set cameraColorGradingEnabled(value: boolean);
  60153. /**
  60154. * Gets wether tonemapping is enabled or not.
  60155. */
  60156. get cameraToneMappingEnabled(): boolean;
  60157. /**
  60158. * Sets wether tonemapping is enabled or not
  60159. */
  60160. set cameraToneMappingEnabled(value: boolean);
  60161. /**
  60162. * The camera exposure used on this material.
  60163. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  60164. * This corresponds to a photographic exposure.
  60165. */
  60166. get cameraExposure(): number;
  60167. /**
  60168. * The camera exposure used on this material.
  60169. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  60170. * This corresponds to a photographic exposure.
  60171. */
  60172. set cameraExposure(value: number);
  60173. /**
  60174. * Gets The camera contrast used on this material.
  60175. */
  60176. get cameraContrast(): number;
  60177. /**
  60178. * Sets The camera contrast used on this material.
  60179. */
  60180. set cameraContrast(value: number);
  60181. /**
  60182. * Gets the Color Grading 2D Lookup Texture.
  60183. */
  60184. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  60185. /**
  60186. * Sets the Color Grading 2D Lookup Texture.
  60187. */
  60188. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  60189. /**
  60190. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  60191. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  60192. * 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;
  60193. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  60194. */
  60195. get cameraColorCurves(): Nullable<ColorCurves>;
  60196. /**
  60197. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  60198. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  60199. * 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;
  60200. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  60201. */
  60202. set cameraColorCurves(value: Nullable<ColorCurves>);
  60203. /**
  60204. * Instantiates a new PBRMaterial instance.
  60205. *
  60206. * @param name The material name
  60207. * @param scene The scene the material will be use in.
  60208. */
  60209. constructor(name: string, scene: Scene);
  60210. /**
  60211. * Returns the name of this material class.
  60212. */
  60213. getClassName(): string;
  60214. /**
  60215. * Makes a duplicate of the current material.
  60216. * @param name - name to use for the new material.
  60217. */
  60218. clone(name: string): PBRMaterial;
  60219. /**
  60220. * Serializes this PBR Material.
  60221. * @returns - An object with the serialized material.
  60222. */
  60223. serialize(): any;
  60224. /**
  60225. * Parses a PBR Material from a serialized object.
  60226. * @param source - Serialized object.
  60227. * @param scene - BJS scene instance.
  60228. * @param rootUrl - url for the scene object
  60229. * @returns - PBRMaterial
  60230. */
  60231. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  60232. }
  60233. }
  60234. declare module "babylonjs/Misc/dds" {
  60235. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  60236. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60237. import { Nullable } from "babylonjs/types";
  60238. import { Scene } from "babylonjs/scene";
  60239. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  60240. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  60241. /**
  60242. * Direct draw surface info
  60243. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  60244. */
  60245. export interface DDSInfo {
  60246. /**
  60247. * Width of the texture
  60248. */
  60249. width: number;
  60250. /**
  60251. * Width of the texture
  60252. */
  60253. height: number;
  60254. /**
  60255. * Number of Mipmaps for the texture
  60256. * @see https://en.wikipedia.org/wiki/Mipmap
  60257. */
  60258. mipmapCount: number;
  60259. /**
  60260. * If the textures format is a known fourCC format
  60261. * @see https://www.fourcc.org/
  60262. */
  60263. isFourCC: boolean;
  60264. /**
  60265. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  60266. */
  60267. isRGB: boolean;
  60268. /**
  60269. * If the texture is a lumincance format
  60270. */
  60271. isLuminance: boolean;
  60272. /**
  60273. * If this is a cube texture
  60274. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  60275. */
  60276. isCube: boolean;
  60277. /**
  60278. * If the texture is a compressed format eg. FOURCC_DXT1
  60279. */
  60280. isCompressed: boolean;
  60281. /**
  60282. * The dxgiFormat of the texture
  60283. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  60284. */
  60285. dxgiFormat: number;
  60286. /**
  60287. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  60288. */
  60289. textureType: number;
  60290. /**
  60291. * Sphericle polynomial created for the dds texture
  60292. */
  60293. sphericalPolynomial?: SphericalPolynomial;
  60294. }
  60295. /**
  60296. * Class used to provide DDS decompression tools
  60297. */
  60298. export class DDSTools {
  60299. /**
  60300. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  60301. */
  60302. static StoreLODInAlphaChannel: boolean;
  60303. /**
  60304. * Gets DDS information from an array buffer
  60305. * @param data defines the array buffer view to read data from
  60306. * @returns the DDS information
  60307. */
  60308. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  60309. private static _FloatView;
  60310. private static _Int32View;
  60311. private static _ToHalfFloat;
  60312. private static _FromHalfFloat;
  60313. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  60314. private static _GetHalfFloatRGBAArrayBuffer;
  60315. private static _GetFloatRGBAArrayBuffer;
  60316. private static _GetFloatAsUIntRGBAArrayBuffer;
  60317. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  60318. private static _GetRGBAArrayBuffer;
  60319. private static _ExtractLongWordOrder;
  60320. private static _GetRGBArrayBuffer;
  60321. private static _GetLuminanceArrayBuffer;
  60322. /**
  60323. * Uploads DDS Levels to a Babylon Texture
  60324. * @hidden
  60325. */
  60326. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  60327. }
  60328. module "babylonjs/Engines/thinEngine" {
  60329. interface ThinEngine {
  60330. /**
  60331. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  60332. * @param rootUrl defines the url where the file to load is located
  60333. * @param scene defines the current scene
  60334. * @param lodScale defines scale to apply to the mip map selection
  60335. * @param lodOffset defines offset to apply to the mip map selection
  60336. * @param onLoad defines an optional callback raised when the texture is loaded
  60337. * @param onError defines an optional callback raised if there is an issue to load the texture
  60338. * @param format defines the format of the data
  60339. * @param forcedExtension defines the extension to use to pick the right loader
  60340. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  60341. * @returns the cube texture as an InternalTexture
  60342. */
  60343. 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;
  60344. }
  60345. }
  60346. }
  60347. declare module "babylonjs/Materials/Textures/Loaders/ddsTextureLoader" {
  60348. import { Nullable } from "babylonjs/types";
  60349. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60350. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60351. /**
  60352. * Implementation of the DDS Texture Loader.
  60353. * @hidden
  60354. */
  60355. export class _DDSTextureLoader implements IInternalTextureLoader {
  60356. /**
  60357. * Defines wether the loader supports cascade loading the different faces.
  60358. */
  60359. readonly supportCascades: boolean;
  60360. /**
  60361. * This returns if the loader support the current file information.
  60362. * @param extension defines the file extension of the file being loaded
  60363. * @returns true if the loader can load the specified file
  60364. */
  60365. canLoad(extension: string): boolean;
  60366. /**
  60367. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60368. * @param data contains the texture data
  60369. * @param texture defines the BabylonJS internal texture
  60370. * @param createPolynomials will be true if polynomials have been requested
  60371. * @param onLoad defines the callback to trigger once the texture is ready
  60372. * @param onError defines the callback to trigger in case of error
  60373. */
  60374. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60375. /**
  60376. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60377. * @param data contains the texture data
  60378. * @param texture defines the BabylonJS internal texture
  60379. * @param callback defines the method to call once ready to upload
  60380. */
  60381. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  60382. }
  60383. }
  60384. declare module "babylonjs/Materials/Textures/Loaders/envTextureLoader" {
  60385. import { Nullable } from "babylonjs/types";
  60386. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60387. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60388. /**
  60389. * Implementation of the ENV Texture Loader.
  60390. * @hidden
  60391. */
  60392. export class _ENVTextureLoader implements IInternalTextureLoader {
  60393. /**
  60394. * Defines wether the loader supports cascade loading the different faces.
  60395. */
  60396. readonly supportCascades: boolean;
  60397. /**
  60398. * This returns if the loader support the current file information.
  60399. * @param extension defines the file extension of the file being loaded
  60400. * @returns true if the loader can load the specified file
  60401. */
  60402. canLoad(extension: string): boolean;
  60403. /**
  60404. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60405. * @param data contains the texture data
  60406. * @param texture defines the BabylonJS internal texture
  60407. * @param createPolynomials will be true if polynomials have been requested
  60408. * @param onLoad defines the callback to trigger once the texture is ready
  60409. * @param onError defines the callback to trigger in case of error
  60410. */
  60411. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60412. /**
  60413. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60414. * @param data contains the texture data
  60415. * @param texture defines the BabylonJS internal texture
  60416. * @param callback defines the method to call once ready to upload
  60417. */
  60418. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  60419. }
  60420. }
  60421. declare module "babylonjs/Misc/khronosTextureContainer" {
  60422. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60423. /**
  60424. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  60425. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  60426. */
  60427. export class KhronosTextureContainer {
  60428. /** contents of the KTX container file */
  60429. data: ArrayBufferView;
  60430. private static HEADER_LEN;
  60431. private static COMPRESSED_2D;
  60432. private static COMPRESSED_3D;
  60433. private static TEX_2D;
  60434. private static TEX_3D;
  60435. /**
  60436. * Gets the openGL type
  60437. */
  60438. glType: number;
  60439. /**
  60440. * Gets the openGL type size
  60441. */
  60442. glTypeSize: number;
  60443. /**
  60444. * Gets the openGL format
  60445. */
  60446. glFormat: number;
  60447. /**
  60448. * Gets the openGL internal format
  60449. */
  60450. glInternalFormat: number;
  60451. /**
  60452. * Gets the base internal format
  60453. */
  60454. glBaseInternalFormat: number;
  60455. /**
  60456. * Gets image width in pixel
  60457. */
  60458. pixelWidth: number;
  60459. /**
  60460. * Gets image height in pixel
  60461. */
  60462. pixelHeight: number;
  60463. /**
  60464. * Gets image depth in pixels
  60465. */
  60466. pixelDepth: number;
  60467. /**
  60468. * Gets the number of array elements
  60469. */
  60470. numberOfArrayElements: number;
  60471. /**
  60472. * Gets the number of faces
  60473. */
  60474. numberOfFaces: number;
  60475. /**
  60476. * Gets the number of mipmap levels
  60477. */
  60478. numberOfMipmapLevels: number;
  60479. /**
  60480. * Gets the bytes of key value data
  60481. */
  60482. bytesOfKeyValueData: number;
  60483. /**
  60484. * Gets the load type
  60485. */
  60486. loadType: number;
  60487. /**
  60488. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  60489. */
  60490. isInvalid: boolean;
  60491. /**
  60492. * Creates a new KhronosTextureContainer
  60493. * @param data contents of the KTX container file
  60494. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  60495. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  60496. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  60497. */
  60498. constructor(
  60499. /** contents of the KTX container file */
  60500. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  60501. /**
  60502. * Uploads KTX content to a Babylon Texture.
  60503. * It is assumed that the texture has already been created & is currently bound
  60504. * @hidden
  60505. */
  60506. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  60507. private _upload2DCompressedLevels;
  60508. /**
  60509. * Checks if the given data starts with a KTX file identifier.
  60510. * @param data the data to check
  60511. * @returns true if the data is a KTX file or false otherwise
  60512. */
  60513. static IsValid(data: ArrayBufferView): boolean;
  60514. }
  60515. }
  60516. declare module "babylonjs/Misc/workerPool" {
  60517. import { IDisposable } from "babylonjs/scene";
  60518. /**
  60519. * Helper class to push actions to a pool of workers.
  60520. */
  60521. export class WorkerPool implements IDisposable {
  60522. private _workerInfos;
  60523. private _pendingActions;
  60524. /**
  60525. * Constructor
  60526. * @param workers Array of workers to use for actions
  60527. */
  60528. constructor(workers: Array<Worker>);
  60529. /**
  60530. * Terminates all workers and clears any pending actions.
  60531. */
  60532. dispose(): void;
  60533. /**
  60534. * Pushes an action to the worker pool. If all the workers are active, the action will be
  60535. * pended until a worker has completed its action.
  60536. * @param action The action to perform. Call onComplete when the action is complete.
  60537. */
  60538. push(action: (worker: Worker, onComplete: () => void) => void): void;
  60539. private _execute;
  60540. }
  60541. }
  60542. declare module "babylonjs/Misc/khronosTextureContainer2" {
  60543. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60544. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  60545. /**
  60546. * Class for loading KTX2 files
  60547. * @hidden
  60548. */
  60549. export class KhronosTextureContainer2 {
  60550. private static _WorkerPoolPromise?;
  60551. private static _Initialized;
  60552. private static _Ktx2Decoder;
  60553. /**
  60554. * URL to use when loading the KTX2 decoder module
  60555. */
  60556. static JSModuleURL: string;
  60557. /**
  60558. * Default number of workers used to handle data decoding
  60559. */
  60560. static DefaultNumWorkers: number;
  60561. private static GetDefaultNumWorkers;
  60562. private _engine;
  60563. private static _CreateWorkerPool;
  60564. /**
  60565. * Constructor
  60566. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  60567. */
  60568. constructor(engine: ThinEngine, numWorkers?: number);
  60569. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  60570. /**
  60571. * Stop all async operations and release resources.
  60572. */
  60573. dispose(): void;
  60574. protected _createTexture(data: any, internalTexture: InternalTexture): void;
  60575. /**
  60576. * Checks if the given data starts with a KTX2 file identifier.
  60577. * @param data the data to check
  60578. * @returns true if the data is a KTX2 file or false otherwise
  60579. */
  60580. static IsValid(data: ArrayBufferView): boolean;
  60581. }
  60582. export function workerFunc(): void;
  60583. }
  60584. declare module "babylonjs/Materials/Textures/Loaders/ktxTextureLoader" {
  60585. import { Nullable } from "babylonjs/types";
  60586. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60587. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60588. /**
  60589. * Implementation of the KTX Texture Loader.
  60590. * @hidden
  60591. */
  60592. export class _KTXTextureLoader implements IInternalTextureLoader {
  60593. /**
  60594. * Defines wether the loader supports cascade loading the different faces.
  60595. */
  60596. readonly supportCascades: boolean;
  60597. /**
  60598. * This returns if the loader support the current file information.
  60599. * @param extension defines the file extension of the file being loaded
  60600. * @param mimeType defines the optional mime type of the file being loaded
  60601. * @returns true if the loader can load the specified file
  60602. */
  60603. canLoad(extension: string, mimeType?: string): boolean;
  60604. /**
  60605. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60606. * @param data contains the texture data
  60607. * @param texture defines the BabylonJS internal texture
  60608. * @param createPolynomials will be true if polynomials have been requested
  60609. * @param onLoad defines the callback to trigger once the texture is ready
  60610. * @param onError defines the callback to trigger in case of error
  60611. */
  60612. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60613. /**
  60614. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60615. * @param data contains the texture data
  60616. * @param texture defines the BabylonJS internal texture
  60617. * @param callback defines the method to call once ready to upload
  60618. */
  60619. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  60620. }
  60621. }
  60622. declare module "babylonjs/Helpers/sceneHelpers" {
  60623. import { Nullable } from "babylonjs/types";
  60624. import { Mesh } from "babylonjs/Meshes/mesh";
  60625. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  60626. import { IEnvironmentHelperOptions, EnvironmentHelper } from "babylonjs/Helpers/environmentHelper";
  60627. import { VRExperienceHelperOptions, VRExperienceHelper } from "babylonjs/Cameras/VR/vrExperienceHelper";
  60628. import "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  60629. import "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  60630. import "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  60631. import "babylonjs/Meshes/Builders/boxBuilder";
  60632. import { WebXRDefaultExperience, WebXRDefaultExperienceOptions } from "babylonjs/XR/webXRDefaultExperience";
  60633. /** @hidden */
  60634. export var _forceSceneHelpersToBundle: boolean;
  60635. module "babylonjs/scene" {
  60636. interface Scene {
  60637. /**
  60638. * Creates a default light for the scene.
  60639. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  60640. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  60641. */
  60642. createDefaultLight(replace?: boolean): void;
  60643. /**
  60644. * Creates a default camera for the scene.
  60645. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  60646. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  60647. * @param replace has default false, when true replaces the active camera in the scene
  60648. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  60649. */
  60650. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  60651. /**
  60652. * Creates a default camera and a default light.
  60653. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  60654. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  60655. * @param replace has the default false, when true replaces the active camera/light in the scene
  60656. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  60657. */
  60658. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  60659. /**
  60660. * Creates a new sky box
  60661. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  60662. * @param environmentTexture defines the texture to use as environment texture
  60663. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  60664. * @param scale defines the overall scale of the skybox
  60665. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  60666. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  60667. * @returns a new mesh holding the sky box
  60668. */
  60669. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  60670. /**
  60671. * Creates a new environment
  60672. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  60673. * @param options defines the options you can use to configure the environment
  60674. * @returns the new EnvironmentHelper
  60675. */
  60676. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  60677. /**
  60678. * Creates a new VREXperienceHelper
  60679. * @see https://doc.babylonjs.com/how_to/webvr_helper
  60680. * @param webVROptions defines the options used to create the new VREXperienceHelper
  60681. * @returns a new VREXperienceHelper
  60682. */
  60683. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  60684. /**
  60685. * Creates a new WebXRDefaultExperience
  60686. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  60687. * @param options experience options
  60688. * @returns a promise for a new WebXRDefaultExperience
  60689. */
  60690. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  60691. }
  60692. }
  60693. }
  60694. declare module "babylonjs/Helpers/videoDome" {
  60695. import { Scene } from "babylonjs/scene";
  60696. import { VideoTexture } from "babylonjs/Materials/Textures/videoTexture";
  60697. import { TextureDome } from "babylonjs/Helpers/textureDome";
  60698. /**
  60699. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  60700. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  60701. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  60702. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  60703. */
  60704. export class VideoDome extends TextureDome<VideoTexture> {
  60705. /**
  60706. * Define the video source as a Monoscopic panoramic 360 video.
  60707. */
  60708. static readonly MODE_MONOSCOPIC: number;
  60709. /**
  60710. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  60711. */
  60712. static readonly MODE_TOPBOTTOM: number;
  60713. /**
  60714. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  60715. */
  60716. static readonly MODE_SIDEBYSIDE: number;
  60717. /**
  60718. * Get the video texture associated with this video dome
  60719. */
  60720. get videoTexture(): VideoTexture;
  60721. /**
  60722. * Get the video mode of this dome
  60723. */
  60724. get videoMode(): number;
  60725. /**
  60726. * Set the video mode of this dome.
  60727. * @see textureMode
  60728. */
  60729. set videoMode(value: number);
  60730. protected _initTexture(urlsOrElement: string | string[] | HTMLVideoElement, scene: Scene, options: any): VideoTexture;
  60731. }
  60732. }
  60733. declare module "babylonjs/Helpers/index" {
  60734. export * from "babylonjs/Helpers/environmentHelper";
  60735. export * from "babylonjs/Helpers/photoDome";
  60736. export * from "babylonjs/Helpers/sceneHelpers";
  60737. export * from "babylonjs/Helpers/videoDome";
  60738. }
  60739. declare module "babylonjs/Instrumentation/engineInstrumentation" {
  60740. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  60741. import { IDisposable } from "babylonjs/scene";
  60742. import { Engine } from "babylonjs/Engines/engine";
  60743. /**
  60744. * This class can be used to get instrumentation data from a Babylon engine
  60745. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  60746. */
  60747. export class EngineInstrumentation implements IDisposable {
  60748. /**
  60749. * Define the instrumented engine.
  60750. */
  60751. engine: Engine;
  60752. private _captureGPUFrameTime;
  60753. private _gpuFrameTimeToken;
  60754. private _gpuFrameTime;
  60755. private _captureShaderCompilationTime;
  60756. private _shaderCompilationTime;
  60757. private _onBeginFrameObserver;
  60758. private _onEndFrameObserver;
  60759. private _onBeforeShaderCompilationObserver;
  60760. private _onAfterShaderCompilationObserver;
  60761. /**
  60762. * Gets the perf counter used for GPU frame time
  60763. */
  60764. get gpuFrameTimeCounter(): PerfCounter;
  60765. /**
  60766. * Gets the GPU frame time capture status
  60767. */
  60768. get captureGPUFrameTime(): boolean;
  60769. /**
  60770. * Enable or disable the GPU frame time capture
  60771. */
  60772. set captureGPUFrameTime(value: boolean);
  60773. /**
  60774. * Gets the perf counter used for shader compilation time
  60775. */
  60776. get shaderCompilationTimeCounter(): PerfCounter;
  60777. /**
  60778. * Gets the shader compilation time capture status
  60779. */
  60780. get captureShaderCompilationTime(): boolean;
  60781. /**
  60782. * Enable or disable the shader compilation time capture
  60783. */
  60784. set captureShaderCompilationTime(value: boolean);
  60785. /**
  60786. * Instantiates a new engine instrumentation.
  60787. * This class can be used to get instrumentation data from a Babylon engine
  60788. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  60789. * @param engine Defines the engine to instrument
  60790. */
  60791. constructor(
  60792. /**
  60793. * Define the instrumented engine.
  60794. */
  60795. engine: Engine);
  60796. /**
  60797. * Dispose and release associated resources.
  60798. */
  60799. dispose(): void;
  60800. }
  60801. }
  60802. declare module "babylonjs/Instrumentation/sceneInstrumentation" {
  60803. import { Scene, IDisposable } from "babylonjs/scene";
  60804. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  60805. /**
  60806. * This class can be used to get instrumentation data from a Babylon engine
  60807. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  60808. */
  60809. export class SceneInstrumentation implements IDisposable {
  60810. /**
  60811. * Defines the scene to instrument
  60812. */
  60813. scene: Scene;
  60814. private _captureActiveMeshesEvaluationTime;
  60815. private _activeMeshesEvaluationTime;
  60816. private _captureRenderTargetsRenderTime;
  60817. private _renderTargetsRenderTime;
  60818. private _captureFrameTime;
  60819. private _frameTime;
  60820. private _captureRenderTime;
  60821. private _renderTime;
  60822. private _captureInterFrameTime;
  60823. private _interFrameTime;
  60824. private _captureParticlesRenderTime;
  60825. private _particlesRenderTime;
  60826. private _captureSpritesRenderTime;
  60827. private _spritesRenderTime;
  60828. private _capturePhysicsTime;
  60829. private _physicsTime;
  60830. private _captureAnimationsTime;
  60831. private _animationsTime;
  60832. private _captureCameraRenderTime;
  60833. private _cameraRenderTime;
  60834. private _onBeforeActiveMeshesEvaluationObserver;
  60835. private _onAfterActiveMeshesEvaluationObserver;
  60836. private _onBeforeRenderTargetsRenderObserver;
  60837. private _onAfterRenderTargetsRenderObserver;
  60838. private _onAfterRenderObserver;
  60839. private _onBeforeDrawPhaseObserver;
  60840. private _onAfterDrawPhaseObserver;
  60841. private _onBeforeAnimationsObserver;
  60842. private _onBeforeParticlesRenderingObserver;
  60843. private _onAfterParticlesRenderingObserver;
  60844. private _onBeforeSpritesRenderingObserver;
  60845. private _onAfterSpritesRenderingObserver;
  60846. private _onBeforePhysicsObserver;
  60847. private _onAfterPhysicsObserver;
  60848. private _onAfterAnimationsObserver;
  60849. private _onBeforeCameraRenderObserver;
  60850. private _onAfterCameraRenderObserver;
  60851. /**
  60852. * Gets the perf counter used for active meshes evaluation time
  60853. */
  60854. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  60855. /**
  60856. * Gets the active meshes evaluation time capture status
  60857. */
  60858. get captureActiveMeshesEvaluationTime(): boolean;
  60859. /**
  60860. * Enable or disable the active meshes evaluation time capture
  60861. */
  60862. set captureActiveMeshesEvaluationTime(value: boolean);
  60863. /**
  60864. * Gets the perf counter used for render targets render time
  60865. */
  60866. get renderTargetsRenderTimeCounter(): PerfCounter;
  60867. /**
  60868. * Gets the render targets render time capture status
  60869. */
  60870. get captureRenderTargetsRenderTime(): boolean;
  60871. /**
  60872. * Enable or disable the render targets render time capture
  60873. */
  60874. set captureRenderTargetsRenderTime(value: boolean);
  60875. /**
  60876. * Gets the perf counter used for particles render time
  60877. */
  60878. get particlesRenderTimeCounter(): PerfCounter;
  60879. /**
  60880. * Gets the particles render time capture status
  60881. */
  60882. get captureParticlesRenderTime(): boolean;
  60883. /**
  60884. * Enable or disable the particles render time capture
  60885. */
  60886. set captureParticlesRenderTime(value: boolean);
  60887. /**
  60888. * Gets the perf counter used for sprites render time
  60889. */
  60890. get spritesRenderTimeCounter(): PerfCounter;
  60891. /**
  60892. * Gets the sprites render time capture status
  60893. */
  60894. get captureSpritesRenderTime(): boolean;
  60895. /**
  60896. * Enable or disable the sprites render time capture
  60897. */
  60898. set captureSpritesRenderTime(value: boolean);
  60899. /**
  60900. * Gets the perf counter used for physics time
  60901. */
  60902. get physicsTimeCounter(): PerfCounter;
  60903. /**
  60904. * Gets the physics time capture status
  60905. */
  60906. get capturePhysicsTime(): boolean;
  60907. /**
  60908. * Enable or disable the physics time capture
  60909. */
  60910. set capturePhysicsTime(value: boolean);
  60911. /**
  60912. * Gets the perf counter used for animations time
  60913. */
  60914. get animationsTimeCounter(): PerfCounter;
  60915. /**
  60916. * Gets the animations time capture status
  60917. */
  60918. get captureAnimationsTime(): boolean;
  60919. /**
  60920. * Enable or disable the animations time capture
  60921. */
  60922. set captureAnimationsTime(value: boolean);
  60923. /**
  60924. * Gets the perf counter used for frame time capture
  60925. */
  60926. get frameTimeCounter(): PerfCounter;
  60927. /**
  60928. * Gets the frame time capture status
  60929. */
  60930. get captureFrameTime(): boolean;
  60931. /**
  60932. * Enable or disable the frame time capture
  60933. */
  60934. set captureFrameTime(value: boolean);
  60935. /**
  60936. * Gets the perf counter used for inter-frames time capture
  60937. */
  60938. get interFrameTimeCounter(): PerfCounter;
  60939. /**
  60940. * Gets the inter-frames time capture status
  60941. */
  60942. get captureInterFrameTime(): boolean;
  60943. /**
  60944. * Enable or disable the inter-frames time capture
  60945. */
  60946. set captureInterFrameTime(value: boolean);
  60947. /**
  60948. * Gets the perf counter used for render time capture
  60949. */
  60950. get renderTimeCounter(): PerfCounter;
  60951. /**
  60952. * Gets the render time capture status
  60953. */
  60954. get captureRenderTime(): boolean;
  60955. /**
  60956. * Enable or disable the render time capture
  60957. */
  60958. set captureRenderTime(value: boolean);
  60959. /**
  60960. * Gets the perf counter used for camera render time capture
  60961. */
  60962. get cameraRenderTimeCounter(): PerfCounter;
  60963. /**
  60964. * Gets the camera render time capture status
  60965. */
  60966. get captureCameraRenderTime(): boolean;
  60967. /**
  60968. * Enable or disable the camera render time capture
  60969. */
  60970. set captureCameraRenderTime(value: boolean);
  60971. /**
  60972. * Gets the perf counter used for draw calls
  60973. */
  60974. get drawCallsCounter(): PerfCounter;
  60975. /**
  60976. * Instantiates a new scene instrumentation.
  60977. * This class can be used to get instrumentation data from a Babylon engine
  60978. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  60979. * @param scene Defines the scene to instrument
  60980. */
  60981. constructor(
  60982. /**
  60983. * Defines the scene to instrument
  60984. */
  60985. scene: Scene);
  60986. /**
  60987. * Dispose and release associated resources.
  60988. */
  60989. dispose(): void;
  60990. }
  60991. }
  60992. declare module "babylonjs/Instrumentation/index" {
  60993. export * from "babylonjs/Instrumentation/engineInstrumentation";
  60994. export * from "babylonjs/Instrumentation/sceneInstrumentation";
  60995. export * from "babylonjs/Instrumentation/timeToken";
  60996. }
  60997. declare module "babylonjs/Shaders/glowMapGeneration.fragment" {
  60998. /** @hidden */
  60999. export var glowMapGenerationPixelShader: {
  61000. name: string;
  61001. shader: string;
  61002. };
  61003. }
  61004. declare module "babylonjs/Shaders/glowMapGeneration.vertex" {
  61005. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  61006. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  61007. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  61008. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  61009. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  61010. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  61011. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  61012. /** @hidden */
  61013. export var glowMapGenerationVertexShader: {
  61014. name: string;
  61015. shader: string;
  61016. };
  61017. }
  61018. declare module "babylonjs/Layers/effectLayer" {
  61019. import { Observable } from "babylonjs/Misc/observable";
  61020. import { Nullable } from "babylonjs/types";
  61021. import { Camera } from "babylonjs/Cameras/camera";
  61022. import { Scene } from "babylonjs/scene";
  61023. import { ISize } from "babylonjs/Maths/math.size";
  61024. import { Color4 } from "babylonjs/Maths/math.color";
  61025. import { Engine } from "babylonjs/Engines/engine";
  61026. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61027. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61028. import { Mesh } from "babylonjs/Meshes/mesh";
  61029. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  61030. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  61031. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  61032. import { Effect } from "babylonjs/Materials/effect";
  61033. import { Material } from "babylonjs/Materials/material";
  61034. import "babylonjs/Shaders/glowMapGeneration.fragment";
  61035. import "babylonjs/Shaders/glowMapGeneration.vertex";
  61036. /**
  61037. * Effect layer options. This helps customizing the behaviour
  61038. * of the effect layer.
  61039. */
  61040. export interface IEffectLayerOptions {
  61041. /**
  61042. * Multiplication factor apply to the canvas size to compute the render target size
  61043. * used to generated the objects (the smaller the faster).
  61044. */
  61045. mainTextureRatio: number;
  61046. /**
  61047. * Enforces a fixed size texture to ensure effect stability across devices.
  61048. */
  61049. mainTextureFixedSize?: number;
  61050. /**
  61051. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  61052. */
  61053. alphaBlendingMode: number;
  61054. /**
  61055. * The camera attached to the layer.
  61056. */
  61057. camera: Nullable<Camera>;
  61058. /**
  61059. * The rendering group to draw the layer in.
  61060. */
  61061. renderingGroupId: number;
  61062. }
  61063. /**
  61064. * The effect layer Helps adding post process effect blended with the main pass.
  61065. *
  61066. * This can be for instance use to generate glow or higlight effects on the scene.
  61067. *
  61068. * The effect layer class can not be used directly and is intented to inherited from to be
  61069. * customized per effects.
  61070. */
  61071. export abstract class EffectLayer {
  61072. private _vertexBuffers;
  61073. private _indexBuffer;
  61074. private _cachedDefines;
  61075. private _effectLayerMapGenerationEffect;
  61076. private _effectLayerOptions;
  61077. private _mergeEffect;
  61078. protected _scene: Scene;
  61079. protected _engine: Engine;
  61080. protected _maxSize: number;
  61081. protected _mainTextureDesiredSize: ISize;
  61082. protected _mainTexture: RenderTargetTexture;
  61083. protected _shouldRender: boolean;
  61084. protected _postProcesses: PostProcess[];
  61085. protected _textures: BaseTexture[];
  61086. protected _emissiveTextureAndColor: {
  61087. texture: Nullable<BaseTexture>;
  61088. color: Color4;
  61089. };
  61090. /**
  61091. * The name of the layer
  61092. */
  61093. name: string;
  61094. /**
  61095. * The clear color of the texture used to generate the glow map.
  61096. */
  61097. neutralColor: Color4;
  61098. /**
  61099. * Specifies whether the highlight layer is enabled or not.
  61100. */
  61101. isEnabled: boolean;
  61102. /**
  61103. * Gets the camera attached to the layer.
  61104. */
  61105. get camera(): Nullable<Camera>;
  61106. /**
  61107. * Gets the rendering group id the layer should render in.
  61108. */
  61109. get renderingGroupId(): number;
  61110. set renderingGroupId(renderingGroupId: number);
  61111. /**
  61112. * An event triggered when the effect layer has been disposed.
  61113. */
  61114. onDisposeObservable: Observable<EffectLayer>;
  61115. /**
  61116. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  61117. */
  61118. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  61119. /**
  61120. * An event triggered when the generated texture is being merged in the scene.
  61121. */
  61122. onBeforeComposeObservable: Observable<EffectLayer>;
  61123. /**
  61124. * An event triggered when the mesh is rendered into the effect render target.
  61125. */
  61126. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  61127. /**
  61128. * An event triggered after the mesh has been rendered into the effect render target.
  61129. */
  61130. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  61131. /**
  61132. * An event triggered when the generated texture has been merged in the scene.
  61133. */
  61134. onAfterComposeObservable: Observable<EffectLayer>;
  61135. /**
  61136. * An event triggered when the efffect layer changes its size.
  61137. */
  61138. onSizeChangedObservable: Observable<EffectLayer>;
  61139. /** @hidden */
  61140. static _SceneComponentInitialization: (scene: Scene) => void;
  61141. /**
  61142. * Instantiates a new effect Layer and references it in the scene.
  61143. * @param name The name of the layer
  61144. * @param scene The scene to use the layer in
  61145. */
  61146. constructor(
  61147. /** The Friendly of the effect in the scene */
  61148. name: string, scene: Scene);
  61149. /**
  61150. * Get the effect name of the layer.
  61151. * @return The effect name
  61152. */
  61153. abstract getEffectName(): string;
  61154. /**
  61155. * Checks for the readiness of the element composing the layer.
  61156. * @param subMesh the mesh to check for
  61157. * @param useInstances specify whether or not to use instances to render the mesh
  61158. * @return true if ready otherwise, false
  61159. */
  61160. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61161. /**
  61162. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  61163. * @returns true if the effect requires stencil during the main canvas render pass.
  61164. */
  61165. abstract needStencil(): boolean;
  61166. /**
  61167. * Create the merge effect. This is the shader use to blit the information back
  61168. * to the main canvas at the end of the scene rendering.
  61169. * @returns The effect containing the shader used to merge the effect on the main canvas
  61170. */
  61171. protected abstract _createMergeEffect(): Effect;
  61172. /**
  61173. * Creates the render target textures and post processes used in the effect layer.
  61174. */
  61175. protected abstract _createTextureAndPostProcesses(): void;
  61176. /**
  61177. * Implementation specific of rendering the generating effect on the main canvas.
  61178. * @param effect The effect used to render through
  61179. */
  61180. protected abstract _internalRender(effect: Effect): void;
  61181. /**
  61182. * Sets the required values for both the emissive texture and and the main color.
  61183. */
  61184. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61185. /**
  61186. * Free any resources and references associated to a mesh.
  61187. * Internal use
  61188. * @param mesh The mesh to free.
  61189. */
  61190. abstract _disposeMesh(mesh: Mesh): void;
  61191. /**
  61192. * Serializes this layer (Glow or Highlight for example)
  61193. * @returns a serialized layer object
  61194. */
  61195. abstract serialize?(): any;
  61196. /**
  61197. * Initializes the effect layer with the required options.
  61198. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  61199. */
  61200. protected _init(options: Partial<IEffectLayerOptions>): void;
  61201. /**
  61202. * Generates the index buffer of the full screen quad blending to the main canvas.
  61203. */
  61204. private _generateIndexBuffer;
  61205. /**
  61206. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  61207. */
  61208. private _generateVertexBuffer;
  61209. /**
  61210. * Sets the main texture desired size which is the closest power of two
  61211. * of the engine canvas size.
  61212. */
  61213. private _setMainTextureSize;
  61214. /**
  61215. * Creates the main texture for the effect layer.
  61216. */
  61217. protected _createMainTexture(): void;
  61218. /**
  61219. * Adds specific effects defines.
  61220. * @param defines The defines to add specifics to.
  61221. */
  61222. protected _addCustomEffectDefines(defines: string[]): void;
  61223. /**
  61224. * Checks for the readiness of the element composing the layer.
  61225. * @param subMesh the mesh to check for
  61226. * @param useInstances specify whether or not to use instances to render the mesh
  61227. * @param emissiveTexture the associated emissive texture used to generate the glow
  61228. * @return true if ready otherwise, false
  61229. */
  61230. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  61231. /**
  61232. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  61233. */
  61234. render(): void;
  61235. /**
  61236. * Determine if a given mesh will be used in the current effect.
  61237. * @param mesh mesh to test
  61238. * @returns true if the mesh will be used
  61239. */
  61240. hasMesh(mesh: AbstractMesh): boolean;
  61241. /**
  61242. * Returns true if the layer contains information to display, otherwise false.
  61243. * @returns true if the glow layer should be rendered
  61244. */
  61245. shouldRender(): boolean;
  61246. /**
  61247. * Returns true if the mesh should render, otherwise false.
  61248. * @param mesh The mesh to render
  61249. * @returns true if it should render otherwise false
  61250. */
  61251. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  61252. /**
  61253. * Returns true if the mesh can be rendered, otherwise false.
  61254. * @param mesh The mesh to render
  61255. * @param material The material used on the mesh
  61256. * @returns true if it can be rendered otherwise false
  61257. */
  61258. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61259. /**
  61260. * Returns true if the mesh should render, otherwise false.
  61261. * @param mesh The mesh to render
  61262. * @returns true if it should render otherwise false
  61263. */
  61264. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  61265. /**
  61266. * Renders the submesh passed in parameter to the generation map.
  61267. */
  61268. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  61269. /**
  61270. * Defines whether the current material of the mesh should be use to render the effect.
  61271. * @param mesh defines the current mesh to render
  61272. */
  61273. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  61274. /**
  61275. * Rebuild the required buffers.
  61276. * @hidden Internal use only.
  61277. */
  61278. _rebuild(): void;
  61279. /**
  61280. * Dispose only the render target textures and post process.
  61281. */
  61282. private _disposeTextureAndPostProcesses;
  61283. /**
  61284. * Dispose the highlight layer and free resources.
  61285. */
  61286. dispose(): void;
  61287. /**
  61288. * Gets the class name of the effect layer
  61289. * @returns the string with the class name of the effect layer
  61290. */
  61291. getClassName(): string;
  61292. /**
  61293. * Creates an effect layer from parsed effect layer data
  61294. * @param parsedEffectLayer defines effect layer data
  61295. * @param scene defines the current scene
  61296. * @param rootUrl defines the root URL containing the effect layer information
  61297. * @returns a parsed effect Layer
  61298. */
  61299. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  61300. }
  61301. }
  61302. declare module "babylonjs/Layers/effectLayerSceneComponent" {
  61303. import { Scene } from "babylonjs/scene";
  61304. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  61305. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61306. import { AbstractScene } from "babylonjs/abstractScene";
  61307. module "babylonjs/abstractScene" {
  61308. interface AbstractScene {
  61309. /**
  61310. * The list of effect layers (highlights/glow) added to the scene
  61311. * @see https://doc.babylonjs.com/how_to/highlight_layer
  61312. * @see https://doc.babylonjs.com/how_to/glow_layer
  61313. */
  61314. effectLayers: Array<EffectLayer>;
  61315. /**
  61316. * Removes the given effect layer from this scene.
  61317. * @param toRemove defines the effect layer to remove
  61318. * @returns the index of the removed effect layer
  61319. */
  61320. removeEffectLayer(toRemove: EffectLayer): number;
  61321. /**
  61322. * Adds the given effect layer to this scene
  61323. * @param newEffectLayer defines the effect layer to add
  61324. */
  61325. addEffectLayer(newEffectLayer: EffectLayer): void;
  61326. }
  61327. }
  61328. /**
  61329. * Defines the layer scene component responsible to manage any effect layers
  61330. * in a given scene.
  61331. */
  61332. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  61333. /**
  61334. * The component name helpfull to identify the component in the list of scene components.
  61335. */
  61336. readonly name: string;
  61337. /**
  61338. * The scene the component belongs to.
  61339. */
  61340. scene: Scene;
  61341. private _engine;
  61342. private _renderEffects;
  61343. private _needStencil;
  61344. private _previousStencilState;
  61345. /**
  61346. * Creates a new instance of the component for the given scene
  61347. * @param scene Defines the scene to register the component in
  61348. */
  61349. constructor(scene: Scene);
  61350. /**
  61351. * Registers the component in a given scene
  61352. */
  61353. register(): void;
  61354. /**
  61355. * Rebuilds the elements related to this component in case of
  61356. * context lost for instance.
  61357. */
  61358. rebuild(): void;
  61359. /**
  61360. * Serializes the component data to the specified json object
  61361. * @param serializationObject The object to serialize to
  61362. */
  61363. serialize(serializationObject: any): void;
  61364. /**
  61365. * Adds all the elements from the container to the scene
  61366. * @param container the container holding the elements
  61367. */
  61368. addFromContainer(container: AbstractScene): void;
  61369. /**
  61370. * Removes all the elements in the container from the scene
  61371. * @param container contains the elements to remove
  61372. * @param dispose if the removed element should be disposed (default: false)
  61373. */
  61374. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61375. /**
  61376. * Disposes the component and the associated ressources.
  61377. */
  61378. dispose(): void;
  61379. private _isReadyForMesh;
  61380. private _renderMainTexture;
  61381. private _setStencil;
  61382. private _setStencilBack;
  61383. private _draw;
  61384. private _drawCamera;
  61385. private _drawRenderingGroup;
  61386. }
  61387. }
  61388. declare module "babylonjs/Shaders/glowMapMerge.fragment" {
  61389. /** @hidden */
  61390. export var glowMapMergePixelShader: {
  61391. name: string;
  61392. shader: string;
  61393. };
  61394. }
  61395. declare module "babylonjs/Shaders/glowMapMerge.vertex" {
  61396. /** @hidden */
  61397. export var glowMapMergeVertexShader: {
  61398. name: string;
  61399. shader: string;
  61400. };
  61401. }
  61402. declare module "babylonjs/Layers/glowLayer" {
  61403. import { Nullable } from "babylonjs/types";
  61404. import { Camera } from "babylonjs/Cameras/camera";
  61405. import { Scene } from "babylonjs/scene";
  61406. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61407. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61408. import { Mesh } from "babylonjs/Meshes/mesh";
  61409. import { Texture } from "babylonjs/Materials/Textures/texture";
  61410. import { Effect } from "babylonjs/Materials/effect";
  61411. import { Material } from "babylonjs/Materials/material";
  61412. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61413. import { Color4 } from "babylonjs/Maths/math.color";
  61414. import "babylonjs/Shaders/glowMapMerge.fragment";
  61415. import "babylonjs/Shaders/glowMapMerge.vertex";
  61416. import "babylonjs/Layers/effectLayerSceneComponent";
  61417. module "babylonjs/abstractScene" {
  61418. interface AbstractScene {
  61419. /**
  61420. * Return a the first highlight layer of the scene with a given name.
  61421. * @param name The name of the highlight layer to look for.
  61422. * @return The highlight layer if found otherwise null.
  61423. */
  61424. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  61425. }
  61426. }
  61427. /**
  61428. * Glow layer options. This helps customizing the behaviour
  61429. * of the glow layer.
  61430. */
  61431. export interface IGlowLayerOptions {
  61432. /**
  61433. * Multiplication factor apply to the canvas size to compute the render target size
  61434. * used to generated the glowing objects (the smaller the faster).
  61435. */
  61436. mainTextureRatio: number;
  61437. /**
  61438. * Enforces a fixed size texture to ensure resize independant blur.
  61439. */
  61440. mainTextureFixedSize?: number;
  61441. /**
  61442. * How big is the kernel of the blur texture.
  61443. */
  61444. blurKernelSize: number;
  61445. /**
  61446. * The camera attached to the layer.
  61447. */
  61448. camera: Nullable<Camera>;
  61449. /**
  61450. * Enable MSAA by chosing the number of samples.
  61451. */
  61452. mainTextureSamples?: number;
  61453. /**
  61454. * The rendering group to draw the layer in.
  61455. */
  61456. renderingGroupId: number;
  61457. }
  61458. /**
  61459. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  61460. *
  61461. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  61462. *
  61463. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  61464. */
  61465. export class GlowLayer extends EffectLayer {
  61466. /**
  61467. * Effect Name of the layer.
  61468. */
  61469. static readonly EffectName: string;
  61470. /**
  61471. * The default blur kernel size used for the glow.
  61472. */
  61473. static DefaultBlurKernelSize: number;
  61474. /**
  61475. * The default texture size ratio used for the glow.
  61476. */
  61477. static DefaultTextureRatio: number;
  61478. /**
  61479. * Sets the kernel size of the blur.
  61480. */
  61481. set blurKernelSize(value: number);
  61482. /**
  61483. * Gets the kernel size of the blur.
  61484. */
  61485. get blurKernelSize(): number;
  61486. /**
  61487. * Sets the glow intensity.
  61488. */
  61489. set intensity(value: number);
  61490. /**
  61491. * Gets the glow intensity.
  61492. */
  61493. get intensity(): number;
  61494. private _options;
  61495. private _intensity;
  61496. private _horizontalBlurPostprocess1;
  61497. private _verticalBlurPostprocess1;
  61498. private _horizontalBlurPostprocess2;
  61499. private _verticalBlurPostprocess2;
  61500. private _blurTexture1;
  61501. private _blurTexture2;
  61502. private _postProcesses1;
  61503. private _postProcesses2;
  61504. private _includedOnlyMeshes;
  61505. private _excludedMeshes;
  61506. private _meshesUsingTheirOwnMaterials;
  61507. /**
  61508. * Callback used to let the user override the color selection on a per mesh basis
  61509. */
  61510. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  61511. /**
  61512. * Callback used to let the user override the texture selection on a per mesh basis
  61513. */
  61514. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  61515. /**
  61516. * Instantiates a new glow Layer and references it to the scene.
  61517. * @param name The name of the layer
  61518. * @param scene The scene to use the layer in
  61519. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  61520. */
  61521. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  61522. /**
  61523. * Get the effect name of the layer.
  61524. * @return The effect name
  61525. */
  61526. getEffectName(): string;
  61527. /**
  61528. * Create the merge effect. This is the shader use to blit the information back
  61529. * to the main canvas at the end of the scene rendering.
  61530. */
  61531. protected _createMergeEffect(): Effect;
  61532. /**
  61533. * Creates the render target textures and post processes used in the glow layer.
  61534. */
  61535. protected _createTextureAndPostProcesses(): void;
  61536. /**
  61537. * Checks for the readiness of the element composing the layer.
  61538. * @param subMesh the mesh to check for
  61539. * @param useInstances specify wether or not to use instances to render the mesh
  61540. * @param emissiveTexture the associated emissive texture used to generate the glow
  61541. * @return true if ready otherwise, false
  61542. */
  61543. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61544. /**
  61545. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  61546. */
  61547. needStencil(): boolean;
  61548. /**
  61549. * Returns true if the mesh can be rendered, otherwise false.
  61550. * @param mesh The mesh to render
  61551. * @param material The material used on the mesh
  61552. * @returns true if it can be rendered otherwise false
  61553. */
  61554. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61555. /**
  61556. * Implementation specific of rendering the generating effect on the main canvas.
  61557. * @param effect The effect used to render through
  61558. */
  61559. protected _internalRender(effect: Effect): void;
  61560. /**
  61561. * Sets the required values for both the emissive texture and and the main color.
  61562. */
  61563. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61564. /**
  61565. * Returns true if the mesh should render, otherwise false.
  61566. * @param mesh The mesh to render
  61567. * @returns true if it should render otherwise false
  61568. */
  61569. protected _shouldRenderMesh(mesh: Mesh): boolean;
  61570. /**
  61571. * Adds specific effects defines.
  61572. * @param defines The defines to add specifics to.
  61573. */
  61574. protected _addCustomEffectDefines(defines: string[]): void;
  61575. /**
  61576. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  61577. * @param mesh The mesh to exclude from the glow layer
  61578. */
  61579. addExcludedMesh(mesh: Mesh): void;
  61580. /**
  61581. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  61582. * @param mesh The mesh to remove
  61583. */
  61584. removeExcludedMesh(mesh: Mesh): void;
  61585. /**
  61586. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  61587. * @param mesh The mesh to include in the glow layer
  61588. */
  61589. addIncludedOnlyMesh(mesh: Mesh): void;
  61590. /**
  61591. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  61592. * @param mesh The mesh to remove
  61593. */
  61594. removeIncludedOnlyMesh(mesh: Mesh): void;
  61595. /**
  61596. * Determine if a given mesh will be used in the glow layer
  61597. * @param mesh The mesh to test
  61598. * @returns true if the mesh will be highlighted by the current glow layer
  61599. */
  61600. hasMesh(mesh: AbstractMesh): boolean;
  61601. /**
  61602. * Defines whether the current material of the mesh should be use to render the effect.
  61603. * @param mesh defines the current mesh to render
  61604. */
  61605. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  61606. /**
  61607. * Add a mesh to be rendered through its own material and not with emissive only.
  61608. * @param mesh The mesh for which we need to use its material
  61609. */
  61610. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  61611. /**
  61612. * Remove a mesh from being rendered through its own material and not with emissive only.
  61613. * @param mesh The mesh for which we need to not use its material
  61614. */
  61615. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  61616. /**
  61617. * Free any resources and references associated to a mesh.
  61618. * Internal use
  61619. * @param mesh The mesh to free.
  61620. * @hidden
  61621. */
  61622. _disposeMesh(mesh: Mesh): void;
  61623. /**
  61624. * Gets the class name of the effect layer
  61625. * @returns the string with the class name of the effect layer
  61626. */
  61627. getClassName(): string;
  61628. /**
  61629. * Serializes this glow layer
  61630. * @returns a serialized glow layer object
  61631. */
  61632. serialize(): any;
  61633. /**
  61634. * Creates a Glow Layer from parsed glow layer data
  61635. * @param parsedGlowLayer defines glow layer data
  61636. * @param scene defines the current scene
  61637. * @param rootUrl defines the root URL containing the glow layer information
  61638. * @returns a parsed Glow Layer
  61639. */
  61640. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  61641. }
  61642. }
  61643. declare module "babylonjs/Shaders/glowBlurPostProcess.fragment" {
  61644. /** @hidden */
  61645. export var glowBlurPostProcessPixelShader: {
  61646. name: string;
  61647. shader: string;
  61648. };
  61649. }
  61650. declare module "babylonjs/Layers/highlightLayer" {
  61651. import { Observable } from "babylonjs/Misc/observable";
  61652. import { Nullable } from "babylonjs/types";
  61653. import { Camera } from "babylonjs/Cameras/camera";
  61654. import { Scene } from "babylonjs/scene";
  61655. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61656. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61657. import { Mesh } from "babylonjs/Meshes/mesh";
  61658. import { Effect } from "babylonjs/Materials/effect";
  61659. import { Material } from "babylonjs/Materials/material";
  61660. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61661. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  61662. import "babylonjs/Shaders/glowMapMerge.fragment";
  61663. import "babylonjs/Shaders/glowMapMerge.vertex";
  61664. import "babylonjs/Shaders/glowBlurPostProcess.fragment";
  61665. module "babylonjs/abstractScene" {
  61666. interface AbstractScene {
  61667. /**
  61668. * Return a the first highlight layer of the scene with a given name.
  61669. * @param name The name of the highlight layer to look for.
  61670. * @return The highlight layer if found otherwise null.
  61671. */
  61672. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  61673. }
  61674. }
  61675. /**
  61676. * Highlight layer options. This helps customizing the behaviour
  61677. * of the highlight layer.
  61678. */
  61679. export interface IHighlightLayerOptions {
  61680. /**
  61681. * Multiplication factor apply to the canvas size to compute the render target size
  61682. * used to generated the glowing objects (the smaller the faster).
  61683. */
  61684. mainTextureRatio: number;
  61685. /**
  61686. * Enforces a fixed size texture to ensure resize independant blur.
  61687. */
  61688. mainTextureFixedSize?: number;
  61689. /**
  61690. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  61691. * of the picture to blur (the smaller the faster).
  61692. */
  61693. blurTextureSizeRatio: number;
  61694. /**
  61695. * How big in texel of the blur texture is the vertical blur.
  61696. */
  61697. blurVerticalSize: number;
  61698. /**
  61699. * How big in texel of the blur texture is the horizontal blur.
  61700. */
  61701. blurHorizontalSize: number;
  61702. /**
  61703. * Alpha blending mode used to apply the blur. Default is combine.
  61704. */
  61705. alphaBlendingMode: number;
  61706. /**
  61707. * The camera attached to the layer.
  61708. */
  61709. camera: Nullable<Camera>;
  61710. /**
  61711. * Should we display highlight as a solid stroke?
  61712. */
  61713. isStroke?: boolean;
  61714. /**
  61715. * The rendering group to draw the layer in.
  61716. */
  61717. renderingGroupId: number;
  61718. }
  61719. /**
  61720. * The highlight layer Helps adding a glow effect around a mesh.
  61721. *
  61722. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  61723. * glowy meshes to your scene.
  61724. *
  61725. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  61726. */
  61727. export class HighlightLayer extends EffectLayer {
  61728. name: string;
  61729. /**
  61730. * Effect Name of the highlight layer.
  61731. */
  61732. static readonly EffectName: string;
  61733. /**
  61734. * The neutral color used during the preparation of the glow effect.
  61735. * This is black by default as the blend operation is a blend operation.
  61736. */
  61737. static NeutralColor: Color4;
  61738. /**
  61739. * Stencil value used for glowing meshes.
  61740. */
  61741. static GlowingMeshStencilReference: number;
  61742. /**
  61743. * Stencil value used for the other meshes in the scene.
  61744. */
  61745. static NormalMeshStencilReference: number;
  61746. /**
  61747. * Specifies whether or not the inner glow is ACTIVE in the layer.
  61748. */
  61749. innerGlow: boolean;
  61750. /**
  61751. * Specifies whether or not the outer glow is ACTIVE in the layer.
  61752. */
  61753. outerGlow: boolean;
  61754. /**
  61755. * Specifies the horizontal size of the blur.
  61756. */
  61757. set blurHorizontalSize(value: number);
  61758. /**
  61759. * Specifies the vertical size of the blur.
  61760. */
  61761. set blurVerticalSize(value: number);
  61762. /**
  61763. * Gets the horizontal size of the blur.
  61764. */
  61765. get blurHorizontalSize(): number;
  61766. /**
  61767. * Gets the vertical size of the blur.
  61768. */
  61769. get blurVerticalSize(): number;
  61770. /**
  61771. * An event triggered when the highlight layer is being blurred.
  61772. */
  61773. onBeforeBlurObservable: Observable<HighlightLayer>;
  61774. /**
  61775. * An event triggered when the highlight layer has been blurred.
  61776. */
  61777. onAfterBlurObservable: Observable<HighlightLayer>;
  61778. private _instanceGlowingMeshStencilReference;
  61779. private _options;
  61780. private _downSamplePostprocess;
  61781. private _horizontalBlurPostprocess;
  61782. private _verticalBlurPostprocess;
  61783. private _blurTexture;
  61784. private _meshes;
  61785. private _excludedMeshes;
  61786. /**
  61787. * Instantiates a new highlight Layer and references it to the scene..
  61788. * @param name The name of the layer
  61789. * @param scene The scene to use the layer in
  61790. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  61791. */
  61792. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  61793. /**
  61794. * Get the effect name of the layer.
  61795. * @return The effect name
  61796. */
  61797. getEffectName(): string;
  61798. /**
  61799. * Create the merge effect. This is the shader use to blit the information back
  61800. * to the main canvas at the end of the scene rendering.
  61801. */
  61802. protected _createMergeEffect(): Effect;
  61803. /**
  61804. * Creates the render target textures and post processes used in the highlight layer.
  61805. */
  61806. protected _createTextureAndPostProcesses(): void;
  61807. /**
  61808. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  61809. */
  61810. needStencil(): boolean;
  61811. /**
  61812. * Checks for the readiness of the element composing the layer.
  61813. * @param subMesh the mesh to check for
  61814. * @param useInstances specify wether or not to use instances to render the mesh
  61815. * @param emissiveTexture the associated emissive texture used to generate the glow
  61816. * @return true if ready otherwise, false
  61817. */
  61818. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61819. /**
  61820. * Implementation specific of rendering the generating effect on the main canvas.
  61821. * @param effect The effect used to render through
  61822. */
  61823. protected _internalRender(effect: Effect): void;
  61824. /**
  61825. * Returns true if the layer contains information to display, otherwise false.
  61826. */
  61827. shouldRender(): boolean;
  61828. /**
  61829. * Returns true if the mesh should render, otherwise false.
  61830. * @param mesh The mesh to render
  61831. * @returns true if it should render otherwise false
  61832. */
  61833. protected _shouldRenderMesh(mesh: Mesh): boolean;
  61834. /**
  61835. * Returns true if the mesh can be rendered, otherwise false.
  61836. * @param mesh The mesh to render
  61837. * @param material The material used on the mesh
  61838. * @returns true if it can be rendered otherwise false
  61839. */
  61840. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61841. /**
  61842. * Adds specific effects defines.
  61843. * @param defines The defines to add specifics to.
  61844. */
  61845. protected _addCustomEffectDefines(defines: string[]): void;
  61846. /**
  61847. * Sets the required values for both the emissive texture and and the main color.
  61848. */
  61849. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61850. /**
  61851. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  61852. * @param mesh The mesh to exclude from the highlight layer
  61853. */
  61854. addExcludedMesh(mesh: Mesh): void;
  61855. /**
  61856. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  61857. * @param mesh The mesh to highlight
  61858. */
  61859. removeExcludedMesh(mesh: Mesh): void;
  61860. /**
  61861. * Determine if a given mesh will be highlighted by the current HighlightLayer
  61862. * @param mesh mesh to test
  61863. * @returns true if the mesh will be highlighted by the current HighlightLayer
  61864. */
  61865. hasMesh(mesh: AbstractMesh): boolean;
  61866. /**
  61867. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  61868. * @param mesh The mesh to highlight
  61869. * @param color The color of the highlight
  61870. * @param glowEmissiveOnly Extract the glow from the emissive texture
  61871. */
  61872. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  61873. /**
  61874. * Remove a mesh from the highlight layer in order to make it stop glowing.
  61875. * @param mesh The mesh to highlight
  61876. */
  61877. removeMesh(mesh: Mesh): void;
  61878. /**
  61879. * Remove all the meshes currently referenced in the highlight layer
  61880. */
  61881. removeAllMeshes(): void;
  61882. /**
  61883. * Force the stencil to the normal expected value for none glowing parts
  61884. */
  61885. private _defaultStencilReference;
  61886. /**
  61887. * Free any resources and references associated to a mesh.
  61888. * Internal use
  61889. * @param mesh The mesh to free.
  61890. * @hidden
  61891. */
  61892. _disposeMesh(mesh: Mesh): void;
  61893. /**
  61894. * Dispose the highlight layer and free resources.
  61895. */
  61896. dispose(): void;
  61897. /**
  61898. * Gets the class name of the effect layer
  61899. * @returns the string with the class name of the effect layer
  61900. */
  61901. getClassName(): string;
  61902. /**
  61903. * Serializes this Highlight layer
  61904. * @returns a serialized Highlight layer object
  61905. */
  61906. serialize(): any;
  61907. /**
  61908. * Creates a Highlight layer from parsed Highlight layer data
  61909. * @param parsedHightlightLayer defines the Highlight layer data
  61910. * @param scene defines the current scene
  61911. * @param rootUrl defines the root URL containing the Highlight layer information
  61912. * @returns a parsed Highlight layer
  61913. */
  61914. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  61915. }
  61916. }
  61917. declare module "babylonjs/Layers/layerSceneComponent" {
  61918. import { Scene } from "babylonjs/scene";
  61919. import { ISceneComponent } from "babylonjs/sceneComponent";
  61920. import { Layer } from "babylonjs/Layers/layer";
  61921. import { AbstractScene } from "babylonjs/abstractScene";
  61922. module "babylonjs/abstractScene" {
  61923. interface AbstractScene {
  61924. /**
  61925. * The list of layers (background and foreground) of the scene
  61926. */
  61927. layers: Array<Layer>;
  61928. }
  61929. }
  61930. /**
  61931. * Defines the layer scene component responsible to manage any layers
  61932. * in a given scene.
  61933. */
  61934. export class LayerSceneComponent implements ISceneComponent {
  61935. /**
  61936. * The component name helpfull to identify the component in the list of scene components.
  61937. */
  61938. readonly name: string;
  61939. /**
  61940. * The scene the component belongs to.
  61941. */
  61942. scene: Scene;
  61943. private _engine;
  61944. /**
  61945. * Creates a new instance of the component for the given scene
  61946. * @param scene Defines the scene to register the component in
  61947. */
  61948. constructor(scene: Scene);
  61949. /**
  61950. * Registers the component in a given scene
  61951. */
  61952. register(): void;
  61953. /**
  61954. * Rebuilds the elements related to this component in case of
  61955. * context lost for instance.
  61956. */
  61957. rebuild(): void;
  61958. /**
  61959. * Disposes the component and the associated ressources.
  61960. */
  61961. dispose(): void;
  61962. private _draw;
  61963. private _drawCameraPredicate;
  61964. private _drawCameraBackground;
  61965. private _drawCameraForeground;
  61966. private _drawRenderTargetPredicate;
  61967. private _drawRenderTargetBackground;
  61968. private _drawRenderTargetForeground;
  61969. /**
  61970. * Adds all the elements from the container to the scene
  61971. * @param container the container holding the elements
  61972. */
  61973. addFromContainer(container: AbstractScene): void;
  61974. /**
  61975. * Removes all the elements in the container from the scene
  61976. * @param container contains the elements to remove
  61977. * @param dispose if the removed element should be disposed (default: false)
  61978. */
  61979. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61980. }
  61981. }
  61982. declare module "babylonjs/Shaders/layer.fragment" {
  61983. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  61984. /** @hidden */
  61985. export var layerPixelShader: {
  61986. name: string;
  61987. shader: string;
  61988. };
  61989. }
  61990. declare module "babylonjs/Shaders/layer.vertex" {
  61991. /** @hidden */
  61992. export var layerVertexShader: {
  61993. name: string;
  61994. shader: string;
  61995. };
  61996. }
  61997. declare module "babylonjs/Layers/layer" {
  61998. import { Observable } from "babylonjs/Misc/observable";
  61999. import { Nullable } from "babylonjs/types";
  62000. import { Scene } from "babylonjs/scene";
  62001. import { Vector2 } from "babylonjs/Maths/math.vector";
  62002. import { Color4 } from "babylonjs/Maths/math.color";
  62003. import { Texture } from "babylonjs/Materials/Textures/texture";
  62004. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62005. import "babylonjs/Shaders/layer.fragment";
  62006. import "babylonjs/Shaders/layer.vertex";
  62007. /**
  62008. * This represents a full screen 2d layer.
  62009. * This can be useful to display a picture in the background of your scene for instance.
  62010. * @see https://www.babylonjs-playground.com/#08A2BS#1
  62011. */
  62012. export class Layer {
  62013. /**
  62014. * Define the name of the layer.
  62015. */
  62016. name: string;
  62017. /**
  62018. * Define the texture the layer should display.
  62019. */
  62020. texture: Nullable<Texture>;
  62021. /**
  62022. * Is the layer in background or foreground.
  62023. */
  62024. isBackground: boolean;
  62025. /**
  62026. * Define the color of the layer (instead of texture).
  62027. */
  62028. color: Color4;
  62029. /**
  62030. * Define the scale of the layer in order to zoom in out of the texture.
  62031. */
  62032. scale: Vector2;
  62033. /**
  62034. * Define an offset for the layer in order to shift the texture.
  62035. */
  62036. offset: Vector2;
  62037. /**
  62038. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  62039. */
  62040. alphaBlendingMode: number;
  62041. /**
  62042. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  62043. * Alpha test will not mix with the background color in case of transparency.
  62044. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  62045. */
  62046. alphaTest: boolean;
  62047. /**
  62048. * Define a mask to restrict the layer to only some of the scene cameras.
  62049. */
  62050. layerMask: number;
  62051. /**
  62052. * Define the list of render target the layer is visible into.
  62053. */
  62054. renderTargetTextures: RenderTargetTexture[];
  62055. /**
  62056. * Define if the layer is only used in renderTarget or if it also
  62057. * renders in the main frame buffer of the canvas.
  62058. */
  62059. renderOnlyInRenderTargetTextures: boolean;
  62060. private _scene;
  62061. private _vertexBuffers;
  62062. private _indexBuffer;
  62063. private _effect;
  62064. private _previousDefines;
  62065. /**
  62066. * An event triggered when the layer is disposed.
  62067. */
  62068. onDisposeObservable: Observable<Layer>;
  62069. private _onDisposeObserver;
  62070. /**
  62071. * Back compatibility with callback before the onDisposeObservable existed.
  62072. * The set callback will be triggered when the layer has been disposed.
  62073. */
  62074. set onDispose(callback: () => void);
  62075. /**
  62076. * An event triggered before rendering the scene
  62077. */
  62078. onBeforeRenderObservable: Observable<Layer>;
  62079. private _onBeforeRenderObserver;
  62080. /**
  62081. * Back compatibility with callback before the onBeforeRenderObservable existed.
  62082. * The set callback will be triggered just before rendering the layer.
  62083. */
  62084. set onBeforeRender(callback: () => void);
  62085. /**
  62086. * An event triggered after rendering the scene
  62087. */
  62088. onAfterRenderObservable: Observable<Layer>;
  62089. private _onAfterRenderObserver;
  62090. /**
  62091. * Back compatibility with callback before the onAfterRenderObservable existed.
  62092. * The set callback will be triggered just after rendering the layer.
  62093. */
  62094. set onAfterRender(callback: () => void);
  62095. /**
  62096. * Instantiates a new layer.
  62097. * This represents a full screen 2d layer.
  62098. * This can be useful to display a picture in the background of your scene for instance.
  62099. * @see https://www.babylonjs-playground.com/#08A2BS#1
  62100. * @param name Define the name of the layer in the scene
  62101. * @param imgUrl Define the url of the texture to display in the layer
  62102. * @param scene Define the scene the layer belongs to
  62103. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  62104. * @param color Defines a color for the layer
  62105. */
  62106. constructor(
  62107. /**
  62108. * Define the name of the layer.
  62109. */
  62110. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  62111. private _createIndexBuffer;
  62112. /** @hidden */
  62113. _rebuild(): void;
  62114. /**
  62115. * Renders the layer in the scene.
  62116. */
  62117. render(): void;
  62118. /**
  62119. * Disposes and releases the associated ressources.
  62120. */
  62121. dispose(): void;
  62122. }
  62123. }
  62124. declare module "babylonjs/Layers/index" {
  62125. export * from "babylonjs/Layers/effectLayer";
  62126. export * from "babylonjs/Layers/effectLayerSceneComponent";
  62127. export * from "babylonjs/Layers/glowLayer";
  62128. export * from "babylonjs/Layers/highlightLayer";
  62129. export * from "babylonjs/Layers/layer";
  62130. export * from "babylonjs/Layers/layerSceneComponent";
  62131. }
  62132. declare module "babylonjs/Shaders/lensFlare.fragment" {
  62133. /** @hidden */
  62134. export var lensFlarePixelShader: {
  62135. name: string;
  62136. shader: string;
  62137. };
  62138. }
  62139. declare module "babylonjs/Shaders/lensFlare.vertex" {
  62140. /** @hidden */
  62141. export var lensFlareVertexShader: {
  62142. name: string;
  62143. shader: string;
  62144. };
  62145. }
  62146. declare module "babylonjs/LensFlares/lensFlareSystem" {
  62147. import { Scene } from "babylonjs/scene";
  62148. import { Vector3 } from "babylonjs/Maths/math.vector";
  62149. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62150. import { LensFlare } from "babylonjs/LensFlares/lensFlare";
  62151. import "babylonjs/Shaders/lensFlare.fragment";
  62152. import "babylonjs/Shaders/lensFlare.vertex";
  62153. import { Viewport } from "babylonjs/Maths/math.viewport";
  62154. /**
  62155. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  62156. * It is usually composed of several `lensFlare`.
  62157. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62158. */
  62159. export class LensFlareSystem {
  62160. /**
  62161. * Define the name of the lens flare system
  62162. */
  62163. name: string;
  62164. /**
  62165. * List of lens flares used in this system.
  62166. */
  62167. lensFlares: LensFlare[];
  62168. /**
  62169. * Define a limit from the border the lens flare can be visible.
  62170. */
  62171. borderLimit: number;
  62172. /**
  62173. * Define a viewport border we do not want to see the lens flare in.
  62174. */
  62175. viewportBorder: number;
  62176. /**
  62177. * Define a predicate which could limit the list of meshes able to occlude the effect.
  62178. */
  62179. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  62180. /**
  62181. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  62182. */
  62183. layerMask: number;
  62184. /**
  62185. * Define the id of the lens flare system in the scene.
  62186. * (equal to name by default)
  62187. */
  62188. id: string;
  62189. private _scene;
  62190. private _emitter;
  62191. private _vertexBuffers;
  62192. private _indexBuffer;
  62193. private _effect;
  62194. private _positionX;
  62195. private _positionY;
  62196. private _isEnabled;
  62197. /** @hidden */
  62198. static _SceneComponentInitialization: (scene: Scene) => void;
  62199. /**
  62200. * Instantiates a lens flare system.
  62201. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  62202. * It is usually composed of several `lensFlare`.
  62203. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62204. * @param name Define the name of the lens flare system in the scene
  62205. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  62206. * @param scene Define the scene the lens flare system belongs to
  62207. */
  62208. constructor(
  62209. /**
  62210. * Define the name of the lens flare system
  62211. */
  62212. name: string, emitter: any, scene: Scene);
  62213. /**
  62214. * Define if the lens flare system is enabled.
  62215. */
  62216. get isEnabled(): boolean;
  62217. set isEnabled(value: boolean);
  62218. /**
  62219. * Get the scene the effects belongs to.
  62220. * @returns the scene holding the lens flare system
  62221. */
  62222. getScene(): Scene;
  62223. /**
  62224. * Get the emitter of the lens flare system.
  62225. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  62226. * @returns the emitter of the lens flare system
  62227. */
  62228. getEmitter(): any;
  62229. /**
  62230. * Set the emitter of the lens flare system.
  62231. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  62232. * @param newEmitter Define the new emitter of the system
  62233. */
  62234. setEmitter(newEmitter: any): void;
  62235. /**
  62236. * Get the lens flare system emitter position.
  62237. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  62238. * @returns the position
  62239. */
  62240. getEmitterPosition(): Vector3;
  62241. /**
  62242. * @hidden
  62243. */
  62244. computeEffectivePosition(globalViewport: Viewport): boolean;
  62245. /** @hidden */
  62246. _isVisible(): boolean;
  62247. /**
  62248. * @hidden
  62249. */
  62250. render(): boolean;
  62251. /**
  62252. * Dispose and release the lens flare with its associated resources.
  62253. */
  62254. dispose(): void;
  62255. /**
  62256. * Parse a lens flare system from a JSON repressentation
  62257. * @param parsedLensFlareSystem Define the JSON to parse
  62258. * @param scene Define the scene the parsed system should be instantiated in
  62259. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  62260. * @returns the parsed system
  62261. */
  62262. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  62263. /**
  62264. * Serialize the current Lens Flare System into a JSON representation.
  62265. * @returns the serialized JSON
  62266. */
  62267. serialize(): any;
  62268. }
  62269. }
  62270. declare module "babylonjs/LensFlares/lensFlare" {
  62271. import { Nullable } from "babylonjs/types";
  62272. import { Color3 } from "babylonjs/Maths/math.color";
  62273. import { Texture } from "babylonjs/Materials/Textures/texture";
  62274. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  62275. /**
  62276. * This represents one of the lens effect in a `lensFlareSystem`.
  62277. * It controls one of the indiviual texture used in the effect.
  62278. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62279. */
  62280. export class LensFlare {
  62281. /**
  62282. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  62283. */
  62284. size: number;
  62285. /**
  62286. * 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.
  62287. */
  62288. position: number;
  62289. /**
  62290. * Define the lens color.
  62291. */
  62292. color: Color3;
  62293. /**
  62294. * Define the lens texture.
  62295. */
  62296. texture: Nullable<Texture>;
  62297. /**
  62298. * Define the alpha mode to render this particular lens.
  62299. */
  62300. alphaMode: number;
  62301. private _system;
  62302. /**
  62303. * Creates a new Lens Flare.
  62304. * This represents one of the lens effect in a `lensFlareSystem`.
  62305. * It controls one of the indiviual texture used in the effect.
  62306. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62307. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  62308. * @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.
  62309. * @param color Define the lens color
  62310. * @param imgUrl Define the lens texture url
  62311. * @param system Define the `lensFlareSystem` this flare is part of
  62312. * @returns The newly created Lens Flare
  62313. */
  62314. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  62315. /**
  62316. * Instantiates a new Lens Flare.
  62317. * This represents one of the lens effect in a `lensFlareSystem`.
  62318. * It controls one of the indiviual texture used in the effect.
  62319. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62320. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  62321. * @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.
  62322. * @param color Define the lens color
  62323. * @param imgUrl Define the lens texture url
  62324. * @param system Define the `lensFlareSystem` this flare is part of
  62325. */
  62326. constructor(
  62327. /**
  62328. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  62329. */
  62330. size: number,
  62331. /**
  62332. * 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.
  62333. */
  62334. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  62335. /**
  62336. * Dispose and release the lens flare with its associated resources.
  62337. */
  62338. dispose(): void;
  62339. }
  62340. }
  62341. declare module "babylonjs/LensFlares/lensFlareSystemSceneComponent" {
  62342. import { Nullable } from "babylonjs/types";
  62343. import { Scene } from "babylonjs/scene";
  62344. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  62345. import { AbstractScene } from "babylonjs/abstractScene";
  62346. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  62347. module "babylonjs/abstractScene" {
  62348. interface AbstractScene {
  62349. /**
  62350. * The list of lens flare system added to the scene
  62351. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  62352. */
  62353. lensFlareSystems: Array<LensFlareSystem>;
  62354. /**
  62355. * Removes the given lens flare system from this scene.
  62356. * @param toRemove The lens flare system to remove
  62357. * @returns The index of the removed lens flare system
  62358. */
  62359. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  62360. /**
  62361. * Adds the given lens flare system to this scene
  62362. * @param newLensFlareSystem The lens flare system to add
  62363. */
  62364. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  62365. /**
  62366. * Gets a lens flare system using its name
  62367. * @param name defines the name to look for
  62368. * @returns the lens flare system or null if not found
  62369. */
  62370. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  62371. /**
  62372. * Gets a lens flare system using its id
  62373. * @param id defines the id to look for
  62374. * @returns the lens flare system or null if not found
  62375. */
  62376. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  62377. }
  62378. }
  62379. /**
  62380. * Defines the lens flare scene component responsible to manage any lens flares
  62381. * in a given scene.
  62382. */
  62383. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  62384. /**
  62385. * The component name helpfull to identify the component in the list of scene components.
  62386. */
  62387. readonly name: string;
  62388. /**
  62389. * The scene the component belongs to.
  62390. */
  62391. scene: Scene;
  62392. /**
  62393. * Creates a new instance of the component for the given scene
  62394. * @param scene Defines the scene to register the component in
  62395. */
  62396. constructor(scene: Scene);
  62397. /**
  62398. * Registers the component in a given scene
  62399. */
  62400. register(): void;
  62401. /**
  62402. * Rebuilds the elements related to this component in case of
  62403. * context lost for instance.
  62404. */
  62405. rebuild(): void;
  62406. /**
  62407. * Adds all the elements from the container to the scene
  62408. * @param container the container holding the elements
  62409. */
  62410. addFromContainer(container: AbstractScene): void;
  62411. /**
  62412. * Removes all the elements in the container from the scene
  62413. * @param container contains the elements to remove
  62414. * @param dispose if the removed element should be disposed (default: false)
  62415. */
  62416. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62417. /**
  62418. * Serializes the component data to the specified json object
  62419. * @param serializationObject The object to serialize to
  62420. */
  62421. serialize(serializationObject: any): void;
  62422. /**
  62423. * Disposes the component and the associated ressources.
  62424. */
  62425. dispose(): void;
  62426. private _draw;
  62427. }
  62428. }
  62429. declare module "babylonjs/LensFlares/index" {
  62430. export * from "babylonjs/LensFlares/lensFlare";
  62431. export * from "babylonjs/LensFlares/lensFlareSystem";
  62432. export * from "babylonjs/LensFlares/lensFlareSystemSceneComponent";
  62433. }
  62434. declare module "babylonjs/Shaders/depth.fragment" {
  62435. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  62436. /** @hidden */
  62437. export var depthPixelShader: {
  62438. name: string;
  62439. shader: string;
  62440. };
  62441. }
  62442. declare module "babylonjs/Shaders/depth.vertex" {
  62443. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  62444. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  62445. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  62446. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  62447. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  62448. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  62449. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  62450. /** @hidden */
  62451. export var depthVertexShader: {
  62452. name: string;
  62453. shader: string;
  62454. };
  62455. }
  62456. declare module "babylonjs/Rendering/depthRenderer" {
  62457. import { Nullable } from "babylonjs/types";
  62458. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62459. import { Scene } from "babylonjs/scene";
  62460. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62461. import { Camera } from "babylonjs/Cameras/camera";
  62462. import "babylonjs/Shaders/depth.fragment";
  62463. import "babylonjs/Shaders/depth.vertex";
  62464. /**
  62465. * This represents a depth renderer in Babylon.
  62466. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  62467. */
  62468. export class DepthRenderer {
  62469. private _scene;
  62470. private _depthMap;
  62471. private _effect;
  62472. private readonly _storeNonLinearDepth;
  62473. private readonly _clearColor;
  62474. /** Get if the depth renderer is using packed depth or not */
  62475. readonly isPacked: boolean;
  62476. private _cachedDefines;
  62477. private _camera;
  62478. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  62479. enabled: boolean;
  62480. /**
  62481. * Specifiess that the depth renderer will only be used within
  62482. * the camera it is created for.
  62483. * This can help forcing its rendering during the camera processing.
  62484. */
  62485. useOnlyInActiveCamera: boolean;
  62486. /** @hidden */
  62487. static _SceneComponentInitialization: (scene: Scene) => void;
  62488. /**
  62489. * Instantiates a depth renderer
  62490. * @param scene The scene the renderer belongs to
  62491. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  62492. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  62493. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  62494. */
  62495. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  62496. /**
  62497. * Creates the depth rendering effect and checks if the effect is ready.
  62498. * @param subMesh The submesh to be used to render the depth map of
  62499. * @param useInstances If multiple world instances should be used
  62500. * @returns if the depth renderer is ready to render the depth map
  62501. */
  62502. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  62503. /**
  62504. * Gets the texture which the depth map will be written to.
  62505. * @returns The depth map texture
  62506. */
  62507. getDepthMap(): RenderTargetTexture;
  62508. /**
  62509. * Disposes of the depth renderer.
  62510. */
  62511. dispose(): void;
  62512. }
  62513. }
  62514. declare module "babylonjs/Shaders/minmaxRedux.fragment" {
  62515. /** @hidden */
  62516. export var minmaxReduxPixelShader: {
  62517. name: string;
  62518. shader: string;
  62519. };
  62520. }
  62521. declare module "babylonjs/Misc/minMaxReducer" {
  62522. import { Nullable } from "babylonjs/types";
  62523. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62524. import { Camera } from "babylonjs/Cameras/camera";
  62525. import { Observer } from "babylonjs/Misc/observable";
  62526. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  62527. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  62528. import { Observable } from "babylonjs/Misc/observable";
  62529. import "babylonjs/Shaders/minmaxRedux.fragment";
  62530. /**
  62531. * This class computes a min/max reduction from a texture: it means it computes the minimum
  62532. * and maximum values from all values of the texture.
  62533. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  62534. * The source values are read from the red channel of the texture.
  62535. */
  62536. export class MinMaxReducer {
  62537. /**
  62538. * Observable triggered when the computation has been performed
  62539. */
  62540. onAfterReductionPerformed: Observable<{
  62541. min: number;
  62542. max: number;
  62543. }>;
  62544. protected _camera: Camera;
  62545. protected _sourceTexture: Nullable<RenderTargetTexture>;
  62546. protected _reductionSteps: Nullable<Array<PostProcess>>;
  62547. protected _postProcessManager: PostProcessManager;
  62548. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  62549. protected _forceFullscreenViewport: boolean;
  62550. /**
  62551. * Creates a min/max reducer
  62552. * @param camera The camera to use for the post processes
  62553. */
  62554. constructor(camera: Camera);
  62555. /**
  62556. * Gets the texture used to read the values from.
  62557. */
  62558. get sourceTexture(): Nullable<RenderTargetTexture>;
  62559. /**
  62560. * Sets the source texture to read the values from.
  62561. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  62562. * because in such textures '1' value must not be taken into account to compute the maximum
  62563. * as this value is used to clear the texture.
  62564. * Note that the computation is not activated by calling this function, you must call activate() for that!
  62565. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  62566. * @param depthRedux Indicates if the texture is a depth texture or not
  62567. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  62568. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  62569. */
  62570. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  62571. /**
  62572. * Defines the refresh rate of the computation.
  62573. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  62574. */
  62575. get refreshRate(): number;
  62576. set refreshRate(value: number);
  62577. protected _activated: boolean;
  62578. /**
  62579. * Gets the activation status of the reducer
  62580. */
  62581. get activated(): boolean;
  62582. /**
  62583. * Activates the reduction computation.
  62584. * When activated, the observers registered in onAfterReductionPerformed are
  62585. * called after the compuation is performed
  62586. */
  62587. activate(): void;
  62588. /**
  62589. * Deactivates the reduction computation.
  62590. */
  62591. deactivate(): void;
  62592. /**
  62593. * Disposes the min/max reducer
  62594. * @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.
  62595. */
  62596. dispose(disposeAll?: boolean): void;
  62597. }
  62598. }
  62599. declare module "babylonjs/Misc/depthReducer" {
  62600. import { Nullable } from "babylonjs/types";
  62601. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62602. import { Camera } from "babylonjs/Cameras/camera";
  62603. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  62604. import { MinMaxReducer } from "babylonjs/Misc/minMaxReducer";
  62605. /**
  62606. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  62607. */
  62608. export class DepthReducer extends MinMaxReducer {
  62609. private _depthRenderer;
  62610. private _depthRendererId;
  62611. /**
  62612. * Gets the depth renderer used for the computation.
  62613. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  62614. */
  62615. get depthRenderer(): Nullable<DepthRenderer>;
  62616. /**
  62617. * Creates a depth reducer
  62618. * @param camera The camera used to render the depth texture
  62619. */
  62620. constructor(camera: Camera);
  62621. /**
  62622. * Sets the depth renderer to use to generate the depth map
  62623. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  62624. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  62625. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  62626. */
  62627. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  62628. /** @hidden */
  62629. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  62630. /**
  62631. * Activates the reduction computation.
  62632. * When activated, the observers registered in onAfterReductionPerformed are
  62633. * called after the compuation is performed
  62634. */
  62635. activate(): void;
  62636. /**
  62637. * Deactivates the reduction computation.
  62638. */
  62639. deactivate(): void;
  62640. /**
  62641. * Disposes the depth reducer
  62642. * @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.
  62643. */
  62644. dispose(disposeAll?: boolean): void;
  62645. }
  62646. }
  62647. declare module "babylonjs/Lights/Shadows/cascadedShadowGenerator" {
  62648. import { Nullable } from "babylonjs/types";
  62649. import { Scene } from "babylonjs/scene";
  62650. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62651. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62652. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62653. import { Effect } from "babylonjs/Materials/effect";
  62654. import "babylonjs/Shaders/shadowMap.fragment";
  62655. import "babylonjs/Shaders/shadowMap.vertex";
  62656. import "babylonjs/Shaders/depthBoxBlur.fragment";
  62657. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  62658. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  62659. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  62660. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  62661. /**
  62662. * A CSM implementation allowing casting shadows on large scenes.
  62663. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  62664. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  62665. */
  62666. export class CascadedShadowGenerator extends ShadowGenerator {
  62667. private static readonly frustumCornersNDCSpace;
  62668. /**
  62669. * Name of the CSM class
  62670. */
  62671. static CLASSNAME: string;
  62672. /**
  62673. * Defines the default number of cascades used by the CSM.
  62674. */
  62675. static readonly DEFAULT_CASCADES_COUNT: number;
  62676. /**
  62677. * Defines the minimum number of cascades used by the CSM.
  62678. */
  62679. static readonly MIN_CASCADES_COUNT: number;
  62680. /**
  62681. * Defines the maximum number of cascades used by the CSM.
  62682. */
  62683. static readonly MAX_CASCADES_COUNT: number;
  62684. protected _validateFilter(filter: number): number;
  62685. /**
  62686. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  62687. */
  62688. penumbraDarkness: number;
  62689. private _numCascades;
  62690. /**
  62691. * Gets or set the number of cascades used by the CSM.
  62692. */
  62693. get numCascades(): number;
  62694. set numCascades(value: number);
  62695. /**
  62696. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  62697. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  62698. */
  62699. stabilizeCascades: boolean;
  62700. private _freezeShadowCastersBoundingInfo;
  62701. private _freezeShadowCastersBoundingInfoObservable;
  62702. /**
  62703. * Enables or disables the shadow casters bounding info computation.
  62704. * If your shadow casters don't move, you can disable this feature.
  62705. * If it is enabled, the bounding box computation is done every frame.
  62706. */
  62707. get freezeShadowCastersBoundingInfo(): boolean;
  62708. set freezeShadowCastersBoundingInfo(freeze: boolean);
  62709. private _scbiMin;
  62710. private _scbiMax;
  62711. protected _computeShadowCastersBoundingInfo(): void;
  62712. protected _shadowCastersBoundingInfo: BoundingInfo;
  62713. /**
  62714. * Gets or sets the shadow casters bounding info.
  62715. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  62716. * so that the system won't overwrite the bounds you provide
  62717. */
  62718. get shadowCastersBoundingInfo(): BoundingInfo;
  62719. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  62720. protected _breaksAreDirty: boolean;
  62721. protected _minDistance: number;
  62722. protected _maxDistance: number;
  62723. /**
  62724. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  62725. *
  62726. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  62727. * If you don't know these values, simply leave them to their defaults and don't call this function.
  62728. * @param min minimal distance for the breaks (default to 0.)
  62729. * @param max maximal distance for the breaks (default to 1.)
  62730. */
  62731. setMinMaxDistance(min: number, max: number): void;
  62732. /** Gets the minimal distance used in the cascade break computation */
  62733. get minDistance(): number;
  62734. /** Gets the maximal distance used in the cascade break computation */
  62735. get maxDistance(): number;
  62736. /**
  62737. * Gets the class name of that object
  62738. * @returns "CascadedShadowGenerator"
  62739. */
  62740. getClassName(): string;
  62741. private _cascadeMinExtents;
  62742. private _cascadeMaxExtents;
  62743. /**
  62744. * Gets a cascade minimum extents
  62745. * @param cascadeIndex index of the cascade
  62746. * @returns the minimum cascade extents
  62747. */
  62748. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  62749. /**
  62750. * Gets a cascade maximum extents
  62751. * @param cascadeIndex index of the cascade
  62752. * @returns the maximum cascade extents
  62753. */
  62754. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  62755. private _cascades;
  62756. private _currentLayer;
  62757. private _viewSpaceFrustumsZ;
  62758. private _viewMatrices;
  62759. private _projectionMatrices;
  62760. private _transformMatrices;
  62761. private _transformMatricesAsArray;
  62762. private _frustumLengths;
  62763. private _lightSizeUVCorrection;
  62764. private _depthCorrection;
  62765. private _frustumCornersWorldSpace;
  62766. private _frustumCenter;
  62767. private _shadowCameraPos;
  62768. private _shadowMaxZ;
  62769. /**
  62770. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  62771. * It defaults to camera.maxZ
  62772. */
  62773. get shadowMaxZ(): number;
  62774. /**
  62775. * Sets the shadow max z distance.
  62776. */
  62777. set shadowMaxZ(value: number);
  62778. protected _debug: boolean;
  62779. /**
  62780. * Gets or sets the debug flag.
  62781. * When enabled, the cascades are materialized by different colors on the screen.
  62782. */
  62783. get debug(): boolean;
  62784. set debug(dbg: boolean);
  62785. private _depthClamp;
  62786. /**
  62787. * Gets or sets the depth clamping value.
  62788. *
  62789. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  62790. * to account for the shadow casters far away.
  62791. *
  62792. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  62793. */
  62794. get depthClamp(): boolean;
  62795. set depthClamp(value: boolean);
  62796. private _cascadeBlendPercentage;
  62797. /**
  62798. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  62799. * It defaults to 0.1 (10% blending).
  62800. */
  62801. get cascadeBlendPercentage(): number;
  62802. set cascadeBlendPercentage(value: number);
  62803. private _lambda;
  62804. /**
  62805. * Gets or set the lambda parameter.
  62806. * This parameter is used to split the camera frustum and create the cascades.
  62807. * 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.
  62808. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  62809. */
  62810. get lambda(): number;
  62811. set lambda(value: number);
  62812. /**
  62813. * Gets the view matrix corresponding to a given cascade
  62814. * @param cascadeNum cascade to retrieve the view matrix from
  62815. * @returns the cascade view matrix
  62816. */
  62817. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  62818. /**
  62819. * Gets the projection matrix corresponding to a given cascade
  62820. * @param cascadeNum cascade to retrieve the projection matrix from
  62821. * @returns the cascade projection matrix
  62822. */
  62823. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  62824. /**
  62825. * Gets the transformation matrix corresponding to a given cascade
  62826. * @param cascadeNum cascade to retrieve the transformation matrix from
  62827. * @returns the cascade transformation matrix
  62828. */
  62829. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  62830. private _depthRenderer;
  62831. /**
  62832. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  62833. *
  62834. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  62835. *
  62836. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  62837. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  62838. * @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
  62839. */
  62840. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  62841. private _depthReducer;
  62842. private _autoCalcDepthBounds;
  62843. /**
  62844. * Gets or sets the autoCalcDepthBounds property.
  62845. *
  62846. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  62847. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  62848. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  62849. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  62850. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  62851. */
  62852. get autoCalcDepthBounds(): boolean;
  62853. set autoCalcDepthBounds(value: boolean);
  62854. /**
  62855. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  62856. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  62857. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  62858. * for setting the refresh rate on the renderer yourself!
  62859. */
  62860. get autoCalcDepthBoundsRefreshRate(): number;
  62861. set autoCalcDepthBoundsRefreshRate(value: number);
  62862. /**
  62863. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  62864. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  62865. * you change the camera near/far planes!
  62866. */
  62867. splitFrustum(): void;
  62868. private _splitFrustum;
  62869. private _computeMatrices;
  62870. private _computeFrustumInWorldSpace;
  62871. private _computeCascadeFrustum;
  62872. /**
  62873. * Support test.
  62874. */
  62875. static get IsSupported(): boolean;
  62876. /** @hidden */
  62877. static _SceneComponentInitialization: (scene: Scene) => void;
  62878. /**
  62879. * Creates a Cascaded Shadow Generator object.
  62880. * A ShadowGenerator is the required tool to use the shadows.
  62881. * Each directional light casting shadows needs to use its own ShadowGenerator.
  62882. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  62883. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  62884. * @param light The directional light object generating the shadows.
  62885. * @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.
  62886. */
  62887. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  62888. protected _initializeGenerator(): void;
  62889. protected _createTargetRenderTexture(): void;
  62890. protected _initializeShadowMap(): void;
  62891. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  62892. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  62893. /**
  62894. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  62895. * @param defines Defines of the material we want to update
  62896. * @param lightIndex Index of the light in the enabled light list of the material
  62897. */
  62898. prepareDefines(defines: any, lightIndex: number): void;
  62899. /**
  62900. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  62901. * defined in the generator but impacting the effect).
  62902. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  62903. * @param effect The effect we are binfing the information for
  62904. */
  62905. bindShadowLight(lightIndex: string, effect: Effect): void;
  62906. /**
  62907. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  62908. * (eq to view projection * shadow projection matrices)
  62909. * @returns The transform matrix used to create the shadow map
  62910. */
  62911. getTransformMatrix(): Matrix;
  62912. /**
  62913. * Disposes the ShadowGenerator.
  62914. * Returns nothing.
  62915. */
  62916. dispose(): void;
  62917. /**
  62918. * Serializes the shadow generator setup to a json object.
  62919. * @returns The serialized JSON object
  62920. */
  62921. serialize(): any;
  62922. /**
  62923. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  62924. * @param parsedShadowGenerator The JSON object to parse
  62925. * @param scene The scene to create the shadow map for
  62926. * @returns The parsed shadow generator
  62927. */
  62928. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  62929. }
  62930. }
  62931. declare module "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent" {
  62932. import { Scene } from "babylonjs/scene";
  62933. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  62934. import { AbstractScene } from "babylonjs/abstractScene";
  62935. /**
  62936. * Defines the shadow generator component responsible to manage any shadow generators
  62937. * in a given scene.
  62938. */
  62939. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  62940. /**
  62941. * The component name helpfull to identify the component in the list of scene components.
  62942. */
  62943. readonly name: string;
  62944. /**
  62945. * The scene the component belongs to.
  62946. */
  62947. scene: Scene;
  62948. /**
  62949. * Creates a new instance of the component for the given scene
  62950. * @param scene Defines the scene to register the component in
  62951. */
  62952. constructor(scene: Scene);
  62953. /**
  62954. * Registers the component in a given scene
  62955. */
  62956. register(): void;
  62957. /**
  62958. * Rebuilds the elements related to this component in case of
  62959. * context lost for instance.
  62960. */
  62961. rebuild(): void;
  62962. /**
  62963. * Serializes the component data to the specified json object
  62964. * @param serializationObject The object to serialize to
  62965. */
  62966. serialize(serializationObject: any): void;
  62967. /**
  62968. * Adds all the elements from the container to the scene
  62969. * @param container the container holding the elements
  62970. */
  62971. addFromContainer(container: AbstractScene): void;
  62972. /**
  62973. * Removes all the elements in the container from the scene
  62974. * @param container contains the elements to remove
  62975. * @param dispose if the removed element should be disposed (default: false)
  62976. */
  62977. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62978. /**
  62979. * Rebuilds the elements related to this component in case of
  62980. * context lost for instance.
  62981. */
  62982. dispose(): void;
  62983. private _gatherRenderTargets;
  62984. }
  62985. }
  62986. declare module "babylonjs/Lights/Shadows/index" {
  62987. export * from "babylonjs/Lights/Shadows/shadowGenerator";
  62988. export * from "babylonjs/Lights/Shadows/cascadedShadowGenerator";
  62989. export * from "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent";
  62990. }
  62991. declare module "babylonjs/Lights/pointLight" {
  62992. import { Scene } from "babylonjs/scene";
  62993. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62994. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62995. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  62996. import { Effect } from "babylonjs/Materials/effect";
  62997. /**
  62998. * A point light is a light defined by an unique point in world space.
  62999. * The light is emitted in every direction from this point.
  63000. * A good example of a point light is a standard light bulb.
  63001. * Documentation: https://doc.babylonjs.com/babylon101/lights
  63002. */
  63003. export class PointLight extends ShadowLight {
  63004. private _shadowAngle;
  63005. /**
  63006. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  63007. * This specifies what angle the shadow will use to be created.
  63008. *
  63009. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  63010. */
  63011. get shadowAngle(): number;
  63012. /**
  63013. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  63014. * This specifies what angle the shadow will use to be created.
  63015. *
  63016. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  63017. */
  63018. set shadowAngle(value: number);
  63019. /**
  63020. * Gets the direction if it has been set.
  63021. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  63022. */
  63023. get direction(): Vector3;
  63024. /**
  63025. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  63026. */
  63027. set direction(value: Vector3);
  63028. /**
  63029. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  63030. * A PointLight emits the light in every direction.
  63031. * It can cast shadows.
  63032. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  63033. * ```javascript
  63034. * var pointLight = new PointLight("pl", camera.position, scene);
  63035. * ```
  63036. * Documentation : https://doc.babylonjs.com/babylon101/lights
  63037. * @param name The light friendly name
  63038. * @param position The position of the point light in the scene
  63039. * @param scene The scene the lights belongs to
  63040. */
  63041. constructor(name: string, position: Vector3, scene: Scene);
  63042. /**
  63043. * Returns the string "PointLight"
  63044. * @returns the class name
  63045. */
  63046. getClassName(): string;
  63047. /**
  63048. * Returns the integer 0.
  63049. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  63050. */
  63051. getTypeID(): number;
  63052. /**
  63053. * Specifies wether or not the shadowmap should be a cube texture.
  63054. * @returns true if the shadowmap needs to be a cube texture.
  63055. */
  63056. needCube(): boolean;
  63057. /**
  63058. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  63059. * @param faceIndex The index of the face we are computed the direction to generate shadow
  63060. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  63061. */
  63062. getShadowDirection(faceIndex?: number): Vector3;
  63063. /**
  63064. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  63065. * - fov = PI / 2
  63066. * - aspect ratio : 1.0
  63067. * - z-near and far equal to the active camera minZ and maxZ.
  63068. * Returns the PointLight.
  63069. */
  63070. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  63071. protected _buildUniformLayout(): void;
  63072. /**
  63073. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  63074. * @param effect The effect to update
  63075. * @param lightIndex The index of the light in the effect to update
  63076. * @returns The point light
  63077. */
  63078. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  63079. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  63080. /**
  63081. * Prepares the list of defines specific to the light type.
  63082. * @param defines the list of defines
  63083. * @param lightIndex defines the index of the light for the effect
  63084. */
  63085. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  63086. }
  63087. }
  63088. declare module "babylonjs/Lights/index" {
  63089. export * from "babylonjs/Lights/light";
  63090. export * from "babylonjs/Lights/shadowLight";
  63091. export * from "babylonjs/Lights/Shadows/index";
  63092. export * from "babylonjs/Lights/directionalLight";
  63093. export * from "babylonjs/Lights/hemisphericLight";
  63094. export * from "babylonjs/Lights/pointLight";
  63095. export * from "babylonjs/Lights/spotLight";
  63096. }
  63097. declare module "babylonjs/Misc/HighDynamicRange/hdr" {
  63098. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  63099. /**
  63100. * Header information of HDR texture files.
  63101. */
  63102. export interface HDRInfo {
  63103. /**
  63104. * The height of the texture in pixels.
  63105. */
  63106. height: number;
  63107. /**
  63108. * The width of the texture in pixels.
  63109. */
  63110. width: number;
  63111. /**
  63112. * The index of the beginning of the data in the binary file.
  63113. */
  63114. dataPosition: number;
  63115. }
  63116. /**
  63117. * This groups tools to convert HDR texture to native colors array.
  63118. */
  63119. export class HDRTools {
  63120. private static Ldexp;
  63121. private static Rgbe2float;
  63122. private static readStringLine;
  63123. /**
  63124. * Reads header information from an RGBE texture stored in a native array.
  63125. * More information on this format are available here:
  63126. * https://en.wikipedia.org/wiki/RGBE_image_format
  63127. *
  63128. * @param uint8array The binary file stored in native array.
  63129. * @return The header information.
  63130. */
  63131. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  63132. /**
  63133. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  63134. * This RGBE texture needs to store the information as a panorama.
  63135. *
  63136. * More information on this format are available here:
  63137. * https://en.wikipedia.org/wiki/RGBE_image_format
  63138. *
  63139. * @param buffer The binary file stored in an array buffer.
  63140. * @param size The expected size of the extracted cubemap.
  63141. * @return The Cube Map information.
  63142. */
  63143. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  63144. /**
  63145. * Returns the pixels data extracted from an RGBE texture.
  63146. * This pixels will be stored left to right up to down in the R G B order in one array.
  63147. *
  63148. * More information on this format are available here:
  63149. * https://en.wikipedia.org/wiki/RGBE_image_format
  63150. *
  63151. * @param uint8array The binary file stored in an array buffer.
  63152. * @param hdrInfo The header information of the file.
  63153. * @return The pixels data in RGB right to left up to down order.
  63154. */
  63155. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  63156. private static RGBE_ReadPixels_RLE;
  63157. private static RGBE_ReadPixels_NOT_RLE;
  63158. }
  63159. }
  63160. declare module "babylonjs/Materials/effectRenderer" {
  63161. import { Nullable } from "babylonjs/types";
  63162. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  63163. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63164. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  63165. import { Viewport } from "babylonjs/Maths/math.viewport";
  63166. import { Observable } from "babylonjs/Misc/observable";
  63167. import { Effect } from "babylonjs/Materials/effect";
  63168. import "babylonjs/Shaders/postprocess.vertex";
  63169. /**
  63170. * Effect Render Options
  63171. */
  63172. export interface IEffectRendererOptions {
  63173. /**
  63174. * Defines the vertices positions.
  63175. */
  63176. positions?: number[];
  63177. /**
  63178. * Defines the indices.
  63179. */
  63180. indices?: number[];
  63181. }
  63182. /**
  63183. * Helper class to render one or more effects.
  63184. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  63185. */
  63186. export class EffectRenderer {
  63187. private engine;
  63188. private static _DefaultOptions;
  63189. private _vertexBuffers;
  63190. private _indexBuffer;
  63191. private _fullscreenViewport;
  63192. /**
  63193. * Creates an effect renderer
  63194. * @param engine the engine to use for rendering
  63195. * @param options defines the options of the effect renderer
  63196. */
  63197. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  63198. /**
  63199. * Sets the current viewport in normalized coordinates 0-1
  63200. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  63201. */
  63202. setViewport(viewport?: Viewport): void;
  63203. /**
  63204. * Binds the embedded attributes buffer to the effect.
  63205. * @param effect Defines the effect to bind the attributes for
  63206. */
  63207. bindBuffers(effect: Effect): void;
  63208. /**
  63209. * Sets the current effect wrapper to use during draw.
  63210. * The effect needs to be ready before calling this api.
  63211. * This also sets the default full screen position attribute.
  63212. * @param effectWrapper Defines the effect to draw with
  63213. */
  63214. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  63215. /**
  63216. * Restores engine states
  63217. */
  63218. restoreStates(): void;
  63219. /**
  63220. * Draws a full screen quad.
  63221. */
  63222. draw(): void;
  63223. private isRenderTargetTexture;
  63224. /**
  63225. * renders one or more effects to a specified texture
  63226. * @param effectWrapper the effect to renderer
  63227. * @param outputTexture texture to draw to, if null it will render to the screen.
  63228. */
  63229. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  63230. /**
  63231. * Disposes of the effect renderer
  63232. */
  63233. dispose(): void;
  63234. }
  63235. /**
  63236. * Options to create an EffectWrapper
  63237. */
  63238. interface EffectWrapperCreationOptions {
  63239. /**
  63240. * Engine to use to create the effect
  63241. */
  63242. engine: ThinEngine;
  63243. /**
  63244. * Fragment shader for the effect
  63245. */
  63246. fragmentShader: string;
  63247. /**
  63248. * Use the shader store instead of direct source code
  63249. */
  63250. useShaderStore?: boolean;
  63251. /**
  63252. * Vertex shader for the effect
  63253. */
  63254. vertexShader?: string;
  63255. /**
  63256. * Attributes to use in the shader
  63257. */
  63258. attributeNames?: Array<string>;
  63259. /**
  63260. * Uniforms to use in the shader
  63261. */
  63262. uniformNames?: Array<string>;
  63263. /**
  63264. * Texture sampler names to use in the shader
  63265. */
  63266. samplerNames?: Array<string>;
  63267. /**
  63268. * Defines to use in the shader
  63269. */
  63270. defines?: Array<string>;
  63271. /**
  63272. * Callback when effect is compiled
  63273. */
  63274. onCompiled?: Nullable<(effect: Effect) => void>;
  63275. /**
  63276. * The friendly name of the effect displayed in Spector.
  63277. */
  63278. name?: string;
  63279. }
  63280. /**
  63281. * Wraps an effect to be used for rendering
  63282. */
  63283. export class EffectWrapper {
  63284. /**
  63285. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  63286. */
  63287. onApplyObservable: Observable<{}>;
  63288. /**
  63289. * The underlying effect
  63290. */
  63291. effect: Effect;
  63292. /**
  63293. * Creates an effect to be renderer
  63294. * @param creationOptions options to create the effect
  63295. */
  63296. constructor(creationOptions: EffectWrapperCreationOptions);
  63297. /**
  63298. * Disposes of the effect wrapper
  63299. */
  63300. dispose(): void;
  63301. }
  63302. }
  63303. declare module "babylonjs/Shaders/hdrFiltering.vertex" {
  63304. /** @hidden */
  63305. export var hdrFilteringVertexShader: {
  63306. name: string;
  63307. shader: string;
  63308. };
  63309. }
  63310. declare module "babylonjs/Shaders/hdrFiltering.fragment" {
  63311. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  63312. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  63313. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  63314. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  63315. /** @hidden */
  63316. export var hdrFilteringPixelShader: {
  63317. name: string;
  63318. shader: string;
  63319. };
  63320. }
  63321. declare module "babylonjs/Materials/Textures/Filtering/hdrFiltering" {
  63322. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63323. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  63324. import { Nullable } from "babylonjs/types";
  63325. import "babylonjs/Shaders/hdrFiltering.vertex";
  63326. import "babylonjs/Shaders/hdrFiltering.fragment";
  63327. /**
  63328. * Options for texture filtering
  63329. */
  63330. interface IHDRFilteringOptions {
  63331. /**
  63332. * Scales pixel intensity for the input HDR map.
  63333. */
  63334. hdrScale?: number;
  63335. /**
  63336. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  63337. */
  63338. quality?: number;
  63339. }
  63340. /**
  63341. * Filters HDR maps to get correct renderings of PBR reflections
  63342. */
  63343. export class HDRFiltering {
  63344. private _engine;
  63345. private _effectRenderer;
  63346. private _effectWrapper;
  63347. private _lodGenerationOffset;
  63348. private _lodGenerationScale;
  63349. /**
  63350. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  63351. * you care about baking speed.
  63352. */
  63353. quality: number;
  63354. /**
  63355. * Scales pixel intensity for the input HDR map.
  63356. */
  63357. hdrScale: number;
  63358. /**
  63359. * Instantiates HDR filter for reflection maps
  63360. *
  63361. * @param engine Thin engine
  63362. * @param options Options
  63363. */
  63364. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  63365. private _createRenderTarget;
  63366. private _prefilterInternal;
  63367. private _createEffect;
  63368. /**
  63369. * Get a value indicating if the filter is ready to be used
  63370. * @param texture Texture to filter
  63371. * @returns true if the filter is ready
  63372. */
  63373. isReady(texture: BaseTexture): boolean;
  63374. /**
  63375. * Prefilters a cube texture to have mipmap levels representing roughness values.
  63376. * Prefiltering will be invoked at the end of next rendering pass.
  63377. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  63378. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  63379. * @param texture Texture to filter
  63380. * @param onFinished Callback when filtering is done
  63381. * @return Promise called when prefiltering is done
  63382. */
  63383. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  63384. }
  63385. }
  63386. declare module "babylonjs/Materials/Textures/hdrCubeTexture" {
  63387. import { Nullable } from "babylonjs/types";
  63388. import { Scene } from "babylonjs/scene";
  63389. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  63390. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63391. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  63392. import "babylonjs/Engines/Extensions/engine.rawTexture";
  63393. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  63394. /**
  63395. * This represents a texture coming from an HDR input.
  63396. *
  63397. * The only supported format is currently panorama picture stored in RGBE format.
  63398. * Example of such files can be found on HDRLib: http://hdrlib.com/
  63399. */
  63400. export class HDRCubeTexture extends BaseTexture {
  63401. private static _facesMapping;
  63402. private _generateHarmonics;
  63403. private _noMipmap;
  63404. private _prefilterOnLoad;
  63405. private _textureMatrix;
  63406. private _size;
  63407. private _onLoad;
  63408. private _onError;
  63409. /**
  63410. * The texture URL.
  63411. */
  63412. url: string;
  63413. protected _isBlocking: boolean;
  63414. /**
  63415. * Sets wether or not the texture is blocking during loading.
  63416. */
  63417. set isBlocking(value: boolean);
  63418. /**
  63419. * Gets wether or not the texture is blocking during loading.
  63420. */
  63421. get isBlocking(): boolean;
  63422. protected _rotationY: number;
  63423. /**
  63424. * Sets texture matrix rotation angle around Y axis in radians.
  63425. */
  63426. set rotationY(value: number);
  63427. /**
  63428. * Gets texture matrix rotation angle around Y axis radians.
  63429. */
  63430. get rotationY(): number;
  63431. /**
  63432. * Gets or sets the center of the bounding box associated with the cube texture
  63433. * It must define where the camera used to render the texture was set
  63434. */
  63435. boundingBoxPosition: Vector3;
  63436. private _boundingBoxSize;
  63437. /**
  63438. * Gets or sets the size of the bounding box associated with the cube texture
  63439. * When defined, the cubemap will switch to local mode
  63440. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  63441. * @example https://www.babylonjs-playground.com/#RNASML
  63442. */
  63443. set boundingBoxSize(value: Vector3);
  63444. get boundingBoxSize(): Vector3;
  63445. /**
  63446. * Instantiates an HDRTexture from the following parameters.
  63447. *
  63448. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  63449. * @param sceneOrEngine The scene or engine the texture will be used in
  63450. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  63451. * @param noMipmap Forces to not generate the mipmap if true
  63452. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  63453. * @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)
  63454. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  63455. */
  63456. 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>);
  63457. /**
  63458. * Get the current class name of the texture useful for serialization or dynamic coding.
  63459. * @returns "HDRCubeTexture"
  63460. */
  63461. getClassName(): string;
  63462. /**
  63463. * Occurs when the file is raw .hdr file.
  63464. */
  63465. private loadTexture;
  63466. clone(): HDRCubeTexture;
  63467. delayLoad(): void;
  63468. /**
  63469. * Get the texture reflection matrix used to rotate/transform the reflection.
  63470. * @returns the reflection matrix
  63471. */
  63472. getReflectionTextureMatrix(): Matrix;
  63473. /**
  63474. * Set the texture reflection matrix used to rotate/transform the reflection.
  63475. * @param value Define the reflection matrix to set
  63476. */
  63477. setReflectionTextureMatrix(value: Matrix): void;
  63478. /**
  63479. * Parses a JSON representation of an HDR Texture in order to create the texture
  63480. * @param parsedTexture Define the JSON representation
  63481. * @param scene Define the scene the texture should be created in
  63482. * @param rootUrl Define the root url in case we need to load relative dependencies
  63483. * @returns the newly created texture after parsing
  63484. */
  63485. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  63486. serialize(): any;
  63487. }
  63488. }
  63489. declare module "babylonjs/Physics/physicsEngine" {
  63490. import { Nullable } from "babylonjs/types";
  63491. import { Vector3 } from "babylonjs/Maths/math.vector";
  63492. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  63493. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  63494. import { PhysicsJoint } from "babylonjs/Physics/physicsJoint";
  63495. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63496. /**
  63497. * Class used to control physics engine
  63498. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  63499. */
  63500. export class PhysicsEngine implements IPhysicsEngine {
  63501. private _physicsPlugin;
  63502. /**
  63503. * Global value used to control the smallest number supported by the simulation
  63504. */
  63505. static Epsilon: number;
  63506. private _impostors;
  63507. private _joints;
  63508. private _subTimeStep;
  63509. /**
  63510. * Gets the gravity vector used by the simulation
  63511. */
  63512. gravity: Vector3;
  63513. /**
  63514. * Factory used to create the default physics plugin.
  63515. * @returns The default physics plugin
  63516. */
  63517. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  63518. /**
  63519. * Creates a new Physics Engine
  63520. * @param gravity defines the gravity vector used by the simulation
  63521. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  63522. */
  63523. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  63524. /**
  63525. * Sets the gravity vector used by the simulation
  63526. * @param gravity defines the gravity vector to use
  63527. */
  63528. setGravity(gravity: Vector3): void;
  63529. /**
  63530. * Set the time step of the physics engine.
  63531. * Default is 1/60.
  63532. * To slow it down, enter 1/600 for example.
  63533. * To speed it up, 1/30
  63534. * @param newTimeStep defines the new timestep to apply to this world.
  63535. */
  63536. setTimeStep(newTimeStep?: number): void;
  63537. /**
  63538. * Get the time step of the physics engine.
  63539. * @returns the current time step
  63540. */
  63541. getTimeStep(): number;
  63542. /**
  63543. * Set the sub time step of the physics engine.
  63544. * Default is 0 meaning there is no sub steps
  63545. * To increase physics resolution precision, set a small value (like 1 ms)
  63546. * @param subTimeStep defines the new sub timestep used for physics resolution.
  63547. */
  63548. setSubTimeStep(subTimeStep?: number): void;
  63549. /**
  63550. * Get the sub time step of the physics engine.
  63551. * @returns the current sub time step
  63552. */
  63553. getSubTimeStep(): number;
  63554. /**
  63555. * Release all resources
  63556. */
  63557. dispose(): void;
  63558. /**
  63559. * Gets the name of the current physics plugin
  63560. * @returns the name of the plugin
  63561. */
  63562. getPhysicsPluginName(): string;
  63563. /**
  63564. * Adding a new impostor for the impostor tracking.
  63565. * This will be done by the impostor itself.
  63566. * @param impostor the impostor to add
  63567. */
  63568. addImpostor(impostor: PhysicsImpostor): void;
  63569. /**
  63570. * Remove an impostor from the engine.
  63571. * This impostor and its mesh will not longer be updated by the physics engine.
  63572. * @param impostor the impostor to remove
  63573. */
  63574. removeImpostor(impostor: PhysicsImpostor): void;
  63575. /**
  63576. * Add a joint to the physics engine
  63577. * @param mainImpostor defines the main impostor to which the joint is added.
  63578. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  63579. * @param joint defines the joint that will connect both impostors.
  63580. */
  63581. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  63582. /**
  63583. * Removes a joint from the simulation
  63584. * @param mainImpostor defines the impostor used with the joint
  63585. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  63586. * @param joint defines the joint to remove
  63587. */
  63588. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  63589. /**
  63590. * Called by the scene. No need to call it.
  63591. * @param delta defines the timespam between frames
  63592. */
  63593. _step(delta: number): void;
  63594. /**
  63595. * Gets the current plugin used to run the simulation
  63596. * @returns current plugin
  63597. */
  63598. getPhysicsPlugin(): IPhysicsEnginePlugin;
  63599. /**
  63600. * Gets the list of physic impostors
  63601. * @returns an array of PhysicsImpostor
  63602. */
  63603. getImpostors(): Array<PhysicsImpostor>;
  63604. /**
  63605. * Gets the impostor for a physics enabled object
  63606. * @param object defines the object impersonated by the impostor
  63607. * @returns the PhysicsImpostor or null if not found
  63608. */
  63609. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  63610. /**
  63611. * Gets the impostor for a physics body object
  63612. * @param body defines physics body used by the impostor
  63613. * @returns the PhysicsImpostor or null if not found
  63614. */
  63615. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  63616. /**
  63617. * Does a raycast in the physics world
  63618. * @param from when should the ray start?
  63619. * @param to when should the ray end?
  63620. * @returns PhysicsRaycastResult
  63621. */
  63622. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63623. }
  63624. }
  63625. declare module "babylonjs/Physics/Plugins/cannonJSPlugin" {
  63626. import { Nullable } from "babylonjs/types";
  63627. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  63628. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63629. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63630. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63631. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63632. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63633. /** @hidden */
  63634. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  63635. private _useDeltaForWorldStep;
  63636. world: any;
  63637. name: string;
  63638. private _physicsMaterials;
  63639. private _fixedTimeStep;
  63640. private _cannonRaycastResult;
  63641. private _raycastResult;
  63642. private _physicsBodysToRemoveAfterStep;
  63643. private _firstFrame;
  63644. BJSCANNON: any;
  63645. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  63646. setGravity(gravity: Vector3): void;
  63647. setTimeStep(timeStep: number): void;
  63648. getTimeStep(): number;
  63649. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63650. private _removeMarkedPhysicsBodiesFromWorld;
  63651. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63652. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63653. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63654. private _processChildMeshes;
  63655. removePhysicsBody(impostor: PhysicsImpostor): void;
  63656. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63657. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63658. private _addMaterial;
  63659. private _checkWithEpsilon;
  63660. private _createShape;
  63661. private _createHeightmap;
  63662. private _minus90X;
  63663. private _plus90X;
  63664. private _tmpPosition;
  63665. private _tmpDeltaPosition;
  63666. private _tmpUnityRotation;
  63667. private _updatePhysicsBodyTransformation;
  63668. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63669. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63670. isSupported(): boolean;
  63671. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63672. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63673. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63674. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63675. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63676. getBodyMass(impostor: PhysicsImpostor): number;
  63677. getBodyFriction(impostor: PhysicsImpostor): number;
  63678. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63679. getBodyRestitution(impostor: PhysicsImpostor): number;
  63680. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63681. sleepBody(impostor: PhysicsImpostor): void;
  63682. wakeUpBody(impostor: PhysicsImpostor): void;
  63683. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  63684. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  63685. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  63686. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63687. getRadius(impostor: PhysicsImpostor): number;
  63688. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63689. dispose(): void;
  63690. private _extendNamespace;
  63691. /**
  63692. * Does a raycast in the physics world
  63693. * @param from when should the ray start?
  63694. * @param to when should the ray end?
  63695. * @returns PhysicsRaycastResult
  63696. */
  63697. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63698. }
  63699. }
  63700. declare module "babylonjs/Physics/Plugins/oimoJSPlugin" {
  63701. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63702. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63703. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63704. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63705. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  63706. import { Nullable } from "babylonjs/types";
  63707. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63708. /** @hidden */
  63709. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  63710. private _useDeltaForWorldStep;
  63711. world: any;
  63712. name: string;
  63713. BJSOIMO: any;
  63714. private _raycastResult;
  63715. private _fixedTimeStep;
  63716. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  63717. setGravity(gravity: Vector3): void;
  63718. setTimeStep(timeStep: number): void;
  63719. getTimeStep(): number;
  63720. private _tmpImpostorsArray;
  63721. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63722. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63723. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63724. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63725. private _tmpPositionVector;
  63726. removePhysicsBody(impostor: PhysicsImpostor): void;
  63727. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63728. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63729. isSupported(): boolean;
  63730. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63731. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63732. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63733. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63734. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63735. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63736. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63737. getBodyMass(impostor: PhysicsImpostor): number;
  63738. getBodyFriction(impostor: PhysicsImpostor): number;
  63739. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63740. getBodyRestitution(impostor: PhysicsImpostor): number;
  63741. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63742. sleepBody(impostor: PhysicsImpostor): void;
  63743. wakeUpBody(impostor: PhysicsImpostor): void;
  63744. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  63745. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  63746. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  63747. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63748. getRadius(impostor: PhysicsImpostor): number;
  63749. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63750. dispose(): void;
  63751. /**
  63752. * Does a raycast in the physics world
  63753. * @param from when should the ray start?
  63754. * @param to when should the ray end?
  63755. * @returns PhysicsRaycastResult
  63756. */
  63757. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63758. }
  63759. }
  63760. declare module "babylonjs/Physics/Plugins/ammoJSPlugin" {
  63761. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  63762. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63763. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63764. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63765. import { Nullable } from "babylonjs/types";
  63766. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63767. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63768. /**
  63769. * AmmoJS Physics plugin
  63770. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  63771. * @see https://github.com/kripken/ammo.js/
  63772. */
  63773. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  63774. private _useDeltaForWorldStep;
  63775. /**
  63776. * Reference to the Ammo library
  63777. */
  63778. bjsAMMO: any;
  63779. /**
  63780. * Created ammoJS world which physics bodies are added to
  63781. */
  63782. world: any;
  63783. /**
  63784. * Name of the plugin
  63785. */
  63786. name: string;
  63787. private _timeStep;
  63788. private _fixedTimeStep;
  63789. private _maxSteps;
  63790. private _tmpQuaternion;
  63791. private _tmpAmmoTransform;
  63792. private _tmpAmmoQuaternion;
  63793. private _tmpAmmoConcreteContactResultCallback;
  63794. private _collisionConfiguration;
  63795. private _dispatcher;
  63796. private _overlappingPairCache;
  63797. private _solver;
  63798. private _softBodySolver;
  63799. private _tmpAmmoVectorA;
  63800. private _tmpAmmoVectorB;
  63801. private _tmpAmmoVectorC;
  63802. private _tmpAmmoVectorD;
  63803. private _tmpContactCallbackResult;
  63804. private _tmpAmmoVectorRCA;
  63805. private _tmpAmmoVectorRCB;
  63806. private _raycastResult;
  63807. private static readonly DISABLE_COLLISION_FLAG;
  63808. private static readonly KINEMATIC_FLAG;
  63809. private static readonly DISABLE_DEACTIVATION_FLAG;
  63810. /**
  63811. * Initializes the ammoJS plugin
  63812. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  63813. * @param ammoInjection can be used to inject your own ammo reference
  63814. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  63815. */
  63816. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  63817. /**
  63818. * Sets the gravity of the physics world (m/(s^2))
  63819. * @param gravity Gravity to set
  63820. */
  63821. setGravity(gravity: Vector3): void;
  63822. /**
  63823. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  63824. * @param timeStep timestep to use in seconds
  63825. */
  63826. setTimeStep(timeStep: number): void;
  63827. /**
  63828. * 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)
  63829. * @param fixedTimeStep fixedTimeStep to use in seconds
  63830. */
  63831. setFixedTimeStep(fixedTimeStep: number): void;
  63832. /**
  63833. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  63834. * @param maxSteps the maximum number of steps by the physics engine per frame
  63835. */
  63836. setMaxSteps(maxSteps: number): void;
  63837. /**
  63838. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  63839. * @returns the current timestep in seconds
  63840. */
  63841. getTimeStep(): number;
  63842. /**
  63843. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  63844. */
  63845. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  63846. private _isImpostorInContact;
  63847. private _isImpostorPairInContact;
  63848. private _stepSimulation;
  63849. /**
  63850. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  63851. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  63852. * After the step the babylon meshes are set to the position of the physics imposters
  63853. * @param delta amount of time to step forward
  63854. * @param impostors array of imposters to update before/after the step
  63855. */
  63856. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63857. /**
  63858. * Update babylon mesh to match physics world object
  63859. * @param impostor imposter to match
  63860. */
  63861. private _afterSoftStep;
  63862. /**
  63863. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  63864. * @param impostor imposter to match
  63865. */
  63866. private _ropeStep;
  63867. /**
  63868. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  63869. * @param impostor imposter to match
  63870. */
  63871. private _softbodyOrClothStep;
  63872. private _tmpMatrix;
  63873. /**
  63874. * Applies an impulse on the imposter
  63875. * @param impostor imposter to apply impulse to
  63876. * @param force amount of force to be applied to the imposter
  63877. * @param contactPoint the location to apply the impulse on the imposter
  63878. */
  63879. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63880. /**
  63881. * Applies a force on the imposter
  63882. * @param impostor imposter to apply force
  63883. * @param force amount of force to be applied to the imposter
  63884. * @param contactPoint the location to apply the force on the imposter
  63885. */
  63886. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63887. /**
  63888. * Creates a physics body using the plugin
  63889. * @param impostor the imposter to create the physics body on
  63890. */
  63891. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63892. /**
  63893. * Removes the physics body from the imposter and disposes of the body's memory
  63894. * @param impostor imposter to remove the physics body from
  63895. */
  63896. removePhysicsBody(impostor: PhysicsImpostor): void;
  63897. /**
  63898. * Generates a joint
  63899. * @param impostorJoint the imposter joint to create the joint with
  63900. */
  63901. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63902. /**
  63903. * Removes a joint
  63904. * @param impostorJoint the imposter joint to remove the joint from
  63905. */
  63906. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63907. private _addMeshVerts;
  63908. /**
  63909. * Initialise the soft body vertices to match its object's (mesh) vertices
  63910. * Softbody vertices (nodes) are in world space and to match this
  63911. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  63912. * @param impostor to create the softbody for
  63913. */
  63914. private _softVertexData;
  63915. /**
  63916. * Create an impostor's soft body
  63917. * @param impostor to create the softbody for
  63918. */
  63919. private _createSoftbody;
  63920. /**
  63921. * Create cloth for an impostor
  63922. * @param impostor to create the softbody for
  63923. */
  63924. private _createCloth;
  63925. /**
  63926. * Create rope for an impostor
  63927. * @param impostor to create the softbody for
  63928. */
  63929. private _createRope;
  63930. /**
  63931. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  63932. * @param impostor to create the custom physics shape for
  63933. */
  63934. private _createCustom;
  63935. private _addHullVerts;
  63936. private _createShape;
  63937. /**
  63938. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  63939. * @param impostor imposter containing the physics body and babylon object
  63940. */
  63941. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63942. /**
  63943. * Sets the babylon object's position/rotation from the physics body's position/rotation
  63944. * @param impostor imposter containing the physics body and babylon object
  63945. * @param newPosition new position
  63946. * @param newRotation new rotation
  63947. */
  63948. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63949. /**
  63950. * If this plugin is supported
  63951. * @returns true if its supported
  63952. */
  63953. isSupported(): boolean;
  63954. /**
  63955. * Sets the linear velocity of the physics body
  63956. * @param impostor imposter to set the velocity on
  63957. * @param velocity velocity to set
  63958. */
  63959. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63960. /**
  63961. * Sets the angular velocity of the physics body
  63962. * @param impostor imposter to set the velocity on
  63963. * @param velocity velocity to set
  63964. */
  63965. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63966. /**
  63967. * gets the linear velocity
  63968. * @param impostor imposter to get linear velocity from
  63969. * @returns linear velocity
  63970. */
  63971. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63972. /**
  63973. * gets the angular velocity
  63974. * @param impostor imposter to get angular velocity from
  63975. * @returns angular velocity
  63976. */
  63977. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63978. /**
  63979. * Sets the mass of physics body
  63980. * @param impostor imposter to set the mass on
  63981. * @param mass mass to set
  63982. */
  63983. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63984. /**
  63985. * Gets the mass of the physics body
  63986. * @param impostor imposter to get the mass from
  63987. * @returns mass
  63988. */
  63989. getBodyMass(impostor: PhysicsImpostor): number;
  63990. /**
  63991. * Gets friction of the impostor
  63992. * @param impostor impostor to get friction from
  63993. * @returns friction value
  63994. */
  63995. getBodyFriction(impostor: PhysicsImpostor): number;
  63996. /**
  63997. * Sets friction of the impostor
  63998. * @param impostor impostor to set friction on
  63999. * @param friction friction value
  64000. */
  64001. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  64002. /**
  64003. * Gets restitution of the impostor
  64004. * @param impostor impostor to get restitution from
  64005. * @returns restitution value
  64006. */
  64007. getBodyRestitution(impostor: PhysicsImpostor): number;
  64008. /**
  64009. * Sets resitution of the impostor
  64010. * @param impostor impostor to set resitution on
  64011. * @param restitution resitution value
  64012. */
  64013. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  64014. /**
  64015. * Gets pressure inside the impostor
  64016. * @param impostor impostor to get pressure from
  64017. * @returns pressure value
  64018. */
  64019. getBodyPressure(impostor: PhysicsImpostor): number;
  64020. /**
  64021. * Sets pressure inside a soft body impostor
  64022. * Cloth and rope must remain 0 pressure
  64023. * @param impostor impostor to set pressure on
  64024. * @param pressure pressure value
  64025. */
  64026. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  64027. /**
  64028. * Gets stiffness of the impostor
  64029. * @param impostor impostor to get stiffness from
  64030. * @returns pressure value
  64031. */
  64032. getBodyStiffness(impostor: PhysicsImpostor): number;
  64033. /**
  64034. * Sets stiffness of the impostor
  64035. * @param impostor impostor to set stiffness on
  64036. * @param stiffness stiffness value from 0 to 1
  64037. */
  64038. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  64039. /**
  64040. * Gets velocityIterations of the impostor
  64041. * @param impostor impostor to get velocity iterations from
  64042. * @returns velocityIterations value
  64043. */
  64044. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  64045. /**
  64046. * Sets velocityIterations of the impostor
  64047. * @param impostor impostor to set velocity iterations on
  64048. * @param velocityIterations velocityIterations value
  64049. */
  64050. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  64051. /**
  64052. * Gets positionIterations of the impostor
  64053. * @param impostor impostor to get position iterations from
  64054. * @returns positionIterations value
  64055. */
  64056. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  64057. /**
  64058. * Sets positionIterations of the impostor
  64059. * @param impostor impostor to set position on
  64060. * @param positionIterations positionIterations value
  64061. */
  64062. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  64063. /**
  64064. * Append an anchor to a cloth object
  64065. * @param impostor is the cloth impostor to add anchor to
  64066. * @param otherImpostor is the rigid impostor to anchor to
  64067. * @param width ratio across width from 0 to 1
  64068. * @param height ratio up height from 0 to 1
  64069. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  64070. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  64071. */
  64072. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  64073. /**
  64074. * Append an hook to a rope object
  64075. * @param impostor is the rope impostor to add hook to
  64076. * @param otherImpostor is the rigid impostor to hook to
  64077. * @param length ratio along the rope from 0 to 1
  64078. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  64079. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  64080. */
  64081. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  64082. /**
  64083. * Sleeps the physics body and stops it from being active
  64084. * @param impostor impostor to sleep
  64085. */
  64086. sleepBody(impostor: PhysicsImpostor): void;
  64087. /**
  64088. * Activates the physics body
  64089. * @param impostor impostor to activate
  64090. */
  64091. wakeUpBody(impostor: PhysicsImpostor): void;
  64092. /**
  64093. * Updates the distance parameters of the joint
  64094. * @param joint joint to update
  64095. * @param maxDistance maximum distance of the joint
  64096. * @param minDistance minimum distance of the joint
  64097. */
  64098. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  64099. /**
  64100. * Sets a motor on the joint
  64101. * @param joint joint to set motor on
  64102. * @param speed speed of the motor
  64103. * @param maxForce maximum force of the motor
  64104. * @param motorIndex index of the motor
  64105. */
  64106. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  64107. /**
  64108. * Sets the motors limit
  64109. * @param joint joint to set limit on
  64110. * @param upperLimit upper limit
  64111. * @param lowerLimit lower limit
  64112. */
  64113. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  64114. /**
  64115. * Syncs the position and rotation of a mesh with the impostor
  64116. * @param mesh mesh to sync
  64117. * @param impostor impostor to update the mesh with
  64118. */
  64119. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  64120. /**
  64121. * Gets the radius of the impostor
  64122. * @param impostor impostor to get radius from
  64123. * @returns the radius
  64124. */
  64125. getRadius(impostor: PhysicsImpostor): number;
  64126. /**
  64127. * Gets the box size of the impostor
  64128. * @param impostor impostor to get box size from
  64129. * @param result the resulting box size
  64130. */
  64131. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  64132. /**
  64133. * Disposes of the impostor
  64134. */
  64135. dispose(): void;
  64136. /**
  64137. * Does a raycast in the physics world
  64138. * @param from when should the ray start?
  64139. * @param to when should the ray end?
  64140. * @returns PhysicsRaycastResult
  64141. */
  64142. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  64143. }
  64144. }
  64145. declare module "babylonjs/Probes/reflectionProbe" {
  64146. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  64147. import { Vector3 } from "babylonjs/Maths/math.vector";
  64148. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64149. import { Nullable } from "babylonjs/types";
  64150. import { Scene } from "babylonjs/scene";
  64151. module "babylonjs/abstractScene" {
  64152. interface AbstractScene {
  64153. /**
  64154. * The list of reflection probes added to the scene
  64155. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  64156. */
  64157. reflectionProbes: Array<ReflectionProbe>;
  64158. /**
  64159. * Removes the given reflection probe from this scene.
  64160. * @param toRemove The reflection probe to remove
  64161. * @returns The index of the removed reflection probe
  64162. */
  64163. removeReflectionProbe(toRemove: ReflectionProbe): number;
  64164. /**
  64165. * Adds the given reflection probe to this scene.
  64166. * @param newReflectionProbe The reflection probe to add
  64167. */
  64168. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  64169. }
  64170. }
  64171. /**
  64172. * Class used to generate realtime reflection / refraction cube textures
  64173. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  64174. */
  64175. export class ReflectionProbe {
  64176. /** defines the name of the probe */
  64177. name: string;
  64178. private _scene;
  64179. private _renderTargetTexture;
  64180. private _projectionMatrix;
  64181. private _viewMatrix;
  64182. private _target;
  64183. private _add;
  64184. private _attachedMesh;
  64185. private _invertYAxis;
  64186. /** Gets or sets probe position (center of the cube map) */
  64187. position: Vector3;
  64188. /**
  64189. * Creates a new reflection probe
  64190. * @param name defines the name of the probe
  64191. * @param size defines the texture resolution (for each face)
  64192. * @param scene defines the hosting scene
  64193. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  64194. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  64195. */
  64196. constructor(
  64197. /** defines the name of the probe */
  64198. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  64199. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  64200. get samples(): number;
  64201. set samples(value: number);
  64202. /** Gets or sets the refresh rate to use (on every frame by default) */
  64203. get refreshRate(): number;
  64204. set refreshRate(value: number);
  64205. /**
  64206. * Gets the hosting scene
  64207. * @returns a Scene
  64208. */
  64209. getScene(): Scene;
  64210. /** Gets the internal CubeTexture used to render to */
  64211. get cubeTexture(): RenderTargetTexture;
  64212. /** Gets the list of meshes to render */
  64213. get renderList(): Nullable<AbstractMesh[]>;
  64214. /**
  64215. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  64216. * @param mesh defines the mesh to attach to
  64217. */
  64218. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  64219. /**
  64220. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  64221. * @param renderingGroupId The rendering group id corresponding to its index
  64222. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  64223. */
  64224. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  64225. /**
  64226. * Clean all associated resources
  64227. */
  64228. dispose(): void;
  64229. /**
  64230. * Converts the reflection probe information to a readable string for debug purpose.
  64231. * @param fullDetails Supports for multiple levels of logging within scene loading
  64232. * @returns the human readable reflection probe info
  64233. */
  64234. toString(fullDetails?: boolean): string;
  64235. /**
  64236. * Get the class name of the relfection probe.
  64237. * @returns "ReflectionProbe"
  64238. */
  64239. getClassName(): string;
  64240. /**
  64241. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  64242. * @returns The JSON representation of the texture
  64243. */
  64244. serialize(): any;
  64245. /**
  64246. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  64247. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  64248. * @param scene Define the scene the parsed reflection probe should be instantiated in
  64249. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  64250. * @returns The parsed reflection probe if successful
  64251. */
  64252. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  64253. }
  64254. }
  64255. declare module "babylonjs/Loading/Plugins/babylonFileLoader" {
  64256. /** @hidden */
  64257. export var _BabylonLoaderRegistered: boolean;
  64258. /**
  64259. * Helps setting up some configuration for the babylon file loader.
  64260. */
  64261. export class BabylonFileLoaderConfiguration {
  64262. /**
  64263. * The loader does not allow injecting custom physix engine into the plugins.
  64264. * Unfortunately in ES6, we need to manually inject them into the plugin.
  64265. * So you could set this variable to your engine import to make it work.
  64266. */
  64267. static LoaderInjectedPhysicsEngine: any;
  64268. }
  64269. }
  64270. declare module "babylonjs/Loading/Plugins/index" {
  64271. export * from "babylonjs/Loading/Plugins/babylonFileLoader";
  64272. }
  64273. declare module "babylonjs/Loading/index" {
  64274. export * from "babylonjs/Loading/loadingScreen";
  64275. export * from "babylonjs/Loading/Plugins/index";
  64276. export * from "babylonjs/Loading/sceneLoader";
  64277. export * from "babylonjs/Loading/sceneLoaderFlags";
  64278. }
  64279. declare module "babylonjs/Materials/Background/index" {
  64280. export * from "babylonjs/Materials/Background/backgroundMaterial";
  64281. }
  64282. declare module "babylonjs/Materials/PBR/pbrBaseSimpleMaterial" {
  64283. import { Scene } from "babylonjs/scene";
  64284. import { Color3 } from "babylonjs/Maths/math.color";
  64285. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  64286. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64287. /**
  64288. * The Physically based simple base material of BJS.
  64289. *
  64290. * This enables better naming and convention enforcements on top of the pbrMaterial.
  64291. * It is used as the base class for both the specGloss and metalRough conventions.
  64292. */
  64293. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  64294. /**
  64295. * Number of Simultaneous lights allowed on the material.
  64296. */
  64297. maxSimultaneousLights: number;
  64298. /**
  64299. * If sets to true, disables all the lights affecting the material.
  64300. */
  64301. disableLighting: boolean;
  64302. /**
  64303. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  64304. */
  64305. environmentTexture: BaseTexture;
  64306. /**
  64307. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  64308. */
  64309. invertNormalMapX: boolean;
  64310. /**
  64311. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  64312. */
  64313. invertNormalMapY: boolean;
  64314. /**
  64315. * Normal map used in the model.
  64316. */
  64317. normalTexture: BaseTexture;
  64318. /**
  64319. * Emissivie color used to self-illuminate the model.
  64320. */
  64321. emissiveColor: Color3;
  64322. /**
  64323. * Emissivie texture used to self-illuminate the model.
  64324. */
  64325. emissiveTexture: BaseTexture;
  64326. /**
  64327. * Occlusion Channel Strenght.
  64328. */
  64329. occlusionStrength: number;
  64330. /**
  64331. * Occlusion Texture of the material (adding extra occlusion effects).
  64332. */
  64333. occlusionTexture: BaseTexture;
  64334. /**
  64335. * Defines the alpha limits in alpha test mode.
  64336. */
  64337. alphaCutOff: number;
  64338. /**
  64339. * Gets the current double sided mode.
  64340. */
  64341. get doubleSided(): boolean;
  64342. /**
  64343. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  64344. */
  64345. set doubleSided(value: boolean);
  64346. /**
  64347. * Stores the pre-calculated light information of a mesh in a texture.
  64348. */
  64349. lightmapTexture: BaseTexture;
  64350. /**
  64351. * If true, the light map contains occlusion information instead of lighting info.
  64352. */
  64353. useLightmapAsShadowmap: boolean;
  64354. /**
  64355. * Instantiates a new PBRMaterial instance.
  64356. *
  64357. * @param name The material name
  64358. * @param scene The scene the material will be use in.
  64359. */
  64360. constructor(name: string, scene: Scene);
  64361. getClassName(): string;
  64362. }
  64363. }
  64364. declare module "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial" {
  64365. import { Scene } from "babylonjs/scene";
  64366. import { Color3 } from "babylonjs/Maths/math.color";
  64367. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64368. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64369. /**
  64370. * The PBR material of BJS following the metal roughness convention.
  64371. *
  64372. * This fits to the PBR convention in the GLTF definition:
  64373. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  64374. */
  64375. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  64376. /**
  64377. * The base color has two different interpretations depending on the value of metalness.
  64378. * When the material is a metal, the base color is the specific measured reflectance value
  64379. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  64380. * of the material.
  64381. */
  64382. baseColor: Color3;
  64383. /**
  64384. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  64385. * well as opacity information in the alpha channel.
  64386. */
  64387. baseTexture: BaseTexture;
  64388. /**
  64389. * Specifies the metallic scalar value of the material.
  64390. * Can also be used to scale the metalness values of the metallic texture.
  64391. */
  64392. metallic: number;
  64393. /**
  64394. * Specifies the roughness scalar value of the material.
  64395. * Can also be used to scale the roughness values of the metallic texture.
  64396. */
  64397. roughness: number;
  64398. /**
  64399. * Texture containing both the metallic value in the B channel and the
  64400. * roughness value in the G channel to keep better precision.
  64401. */
  64402. metallicRoughnessTexture: BaseTexture;
  64403. /**
  64404. * Instantiates a new PBRMetalRoughnessMaterial instance.
  64405. *
  64406. * @param name The material name
  64407. * @param scene The scene the material will be use in.
  64408. */
  64409. constructor(name: string, scene: Scene);
  64410. /**
  64411. * Return the currrent class name of the material.
  64412. */
  64413. getClassName(): string;
  64414. /**
  64415. * Makes a duplicate of the current material.
  64416. * @param name - name to use for the new material.
  64417. */
  64418. clone(name: string): PBRMetallicRoughnessMaterial;
  64419. /**
  64420. * Serialize the material to a parsable JSON object.
  64421. */
  64422. serialize(): any;
  64423. /**
  64424. * Parses a JSON object correponding to the serialize function.
  64425. */
  64426. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  64427. }
  64428. }
  64429. declare module "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial" {
  64430. import { Scene } from "babylonjs/scene";
  64431. import { Color3 } from "babylonjs/Maths/math.color";
  64432. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64433. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64434. /**
  64435. * The PBR material of BJS following the specular glossiness convention.
  64436. *
  64437. * This fits to the PBR convention in the GLTF definition:
  64438. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  64439. */
  64440. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  64441. /**
  64442. * Specifies the diffuse color of the material.
  64443. */
  64444. diffuseColor: Color3;
  64445. /**
  64446. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  64447. * channel.
  64448. */
  64449. diffuseTexture: BaseTexture;
  64450. /**
  64451. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  64452. */
  64453. specularColor: Color3;
  64454. /**
  64455. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  64456. */
  64457. glossiness: number;
  64458. /**
  64459. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  64460. */
  64461. specularGlossinessTexture: BaseTexture;
  64462. /**
  64463. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  64464. *
  64465. * @param name The material name
  64466. * @param scene The scene the material will be use in.
  64467. */
  64468. constructor(name: string, scene: Scene);
  64469. /**
  64470. * Return the currrent class name of the material.
  64471. */
  64472. getClassName(): string;
  64473. /**
  64474. * Makes a duplicate of the current material.
  64475. * @param name - name to use for the new material.
  64476. */
  64477. clone(name: string): PBRSpecularGlossinessMaterial;
  64478. /**
  64479. * Serialize the material to a parsable JSON object.
  64480. */
  64481. serialize(): any;
  64482. /**
  64483. * Parses a JSON object correponding to the serialize function.
  64484. */
  64485. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  64486. }
  64487. }
  64488. declare module "babylonjs/Materials/PBR/index" {
  64489. export * from "babylonjs/Materials/PBR/pbrBaseMaterial";
  64490. export * from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64491. export * from "babylonjs/Materials/PBR/pbrMaterial";
  64492. export * from "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial";
  64493. export * from "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial";
  64494. }
  64495. declare module "babylonjs/Materials/Textures/colorGradingTexture" {
  64496. import { Nullable } from "babylonjs/types";
  64497. import { Scene } from "babylonjs/scene";
  64498. import { Matrix } from "babylonjs/Maths/math.vector";
  64499. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64500. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  64501. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64502. /**
  64503. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  64504. * It can help converting any input color in a desired output one. This can then be used to create effects
  64505. * from sepia, black and white to sixties or futuristic rendering...
  64506. *
  64507. * The only supported format is currently 3dl.
  64508. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  64509. */
  64510. export class ColorGradingTexture extends BaseTexture {
  64511. /**
  64512. * The texture URL.
  64513. */
  64514. url: string;
  64515. /**
  64516. * Empty line regex stored for GC.
  64517. */
  64518. private static _noneEmptyLineRegex;
  64519. private _textureMatrix;
  64520. private _onLoad;
  64521. /**
  64522. * Instantiates a ColorGradingTexture from the following parameters.
  64523. *
  64524. * @param url The location of the color gradind data (currently only supporting 3dl)
  64525. * @param sceneOrEngine The scene or engine the texture will be used in
  64526. * @param onLoad defines a callback triggered when the texture has been loaded
  64527. */
  64528. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  64529. /**
  64530. * Fires the onload event from the constructor if requested.
  64531. */
  64532. private _triggerOnLoad;
  64533. /**
  64534. * Returns the texture matrix used in most of the material.
  64535. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  64536. */
  64537. getTextureMatrix(): Matrix;
  64538. /**
  64539. * Occurs when the file being loaded is a .3dl LUT file.
  64540. */
  64541. private load3dlTexture;
  64542. /**
  64543. * Starts the loading process of the texture.
  64544. */
  64545. private loadTexture;
  64546. /**
  64547. * Clones the color gradind texture.
  64548. */
  64549. clone(): ColorGradingTexture;
  64550. /**
  64551. * Called during delayed load for textures.
  64552. */
  64553. delayLoad(): void;
  64554. /**
  64555. * Parses a color grading texture serialized by Babylon.
  64556. * @param parsedTexture The texture information being parsedTexture
  64557. * @param scene The scene to load the texture in
  64558. * @param rootUrl The root url of the data assets to load
  64559. * @return A color gradind texture
  64560. */
  64561. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  64562. /**
  64563. * Serializes the LUT texture to json format.
  64564. */
  64565. serialize(): any;
  64566. }
  64567. }
  64568. declare module "babylonjs/Materials/Textures/equiRectangularCubeTexture" {
  64569. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64570. import { Scene } from "babylonjs/scene";
  64571. import { Nullable } from "babylonjs/types";
  64572. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64573. /**
  64574. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  64575. */
  64576. export class EquiRectangularCubeTexture extends BaseTexture {
  64577. /** The six faces of the cube. */
  64578. private static _FacesMapping;
  64579. private _noMipmap;
  64580. private _onLoad;
  64581. private _onError;
  64582. /** The size of the cubemap. */
  64583. private _size;
  64584. /** The buffer of the image. */
  64585. private _buffer;
  64586. /** The width of the input image. */
  64587. private _width;
  64588. /** The height of the input image. */
  64589. private _height;
  64590. /** The URL to the image. */
  64591. url: string;
  64592. /**
  64593. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  64594. * @param url The location of the image
  64595. * @param scene The scene the texture will be used in
  64596. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  64597. * @param noMipmap Forces to not generate the mipmap if true
  64598. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  64599. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  64600. * @param onLoad — defines a callback called when texture is loaded
  64601. * @param onError — defines a callback called if there is an error
  64602. */
  64603. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  64604. /**
  64605. * Load the image data, by putting the image on a canvas and extracting its buffer.
  64606. */
  64607. private loadImage;
  64608. /**
  64609. * Convert the image buffer into a cubemap and create a CubeTexture.
  64610. */
  64611. private loadTexture;
  64612. /**
  64613. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  64614. * @param buffer The ArrayBuffer that should be converted.
  64615. * @returns The buffer as Float32Array.
  64616. */
  64617. private getFloat32ArrayFromArrayBuffer;
  64618. /**
  64619. * Get the current class name of the texture useful for serialization or dynamic coding.
  64620. * @returns "EquiRectangularCubeTexture"
  64621. */
  64622. getClassName(): string;
  64623. /**
  64624. * Create a clone of the current EquiRectangularCubeTexture and return it.
  64625. * @returns A clone of the current EquiRectangularCubeTexture.
  64626. */
  64627. clone(): EquiRectangularCubeTexture;
  64628. }
  64629. }
  64630. declare module "babylonjs/Materials/Textures/htmlElementTexture" {
  64631. import { Nullable } from "babylonjs/types";
  64632. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64633. import { Matrix } from "babylonjs/Maths/math.vector";
  64634. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  64635. import "babylonjs/Engines/Extensions/engine.videoTexture";
  64636. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  64637. import { Scene } from "babylonjs/scene";
  64638. /**
  64639. * Defines the options related to the creation of an HtmlElementTexture
  64640. */
  64641. export interface IHtmlElementTextureOptions {
  64642. /**
  64643. * Defines wether mip maps should be created or not.
  64644. */
  64645. generateMipMaps?: boolean;
  64646. /**
  64647. * Defines the sampling mode of the texture.
  64648. */
  64649. samplingMode?: number;
  64650. /**
  64651. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  64652. */
  64653. engine: Nullable<ThinEngine>;
  64654. /**
  64655. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  64656. */
  64657. scene: Nullable<Scene>;
  64658. }
  64659. /**
  64660. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  64661. * To be as efficient as possible depending on your constraints nothing aside the first upload
  64662. * is automatically managed.
  64663. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  64664. * in your application.
  64665. *
  64666. * As the update is not automatic, you need to call them manually.
  64667. */
  64668. export class HtmlElementTexture extends BaseTexture {
  64669. /**
  64670. * The texture URL.
  64671. */
  64672. element: HTMLVideoElement | HTMLCanvasElement;
  64673. private static readonly DefaultOptions;
  64674. private _textureMatrix;
  64675. private _isVideo;
  64676. private _generateMipMaps;
  64677. private _samplingMode;
  64678. /**
  64679. * Instantiates a HtmlElementTexture from the following parameters.
  64680. *
  64681. * @param name Defines the name of the texture
  64682. * @param element Defines the video or canvas the texture is filled with
  64683. * @param options Defines the other none mandatory texture creation options
  64684. */
  64685. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  64686. private _createInternalTexture;
  64687. /**
  64688. * Returns the texture matrix used in most of the material.
  64689. */
  64690. getTextureMatrix(): Matrix;
  64691. /**
  64692. * Updates the content of the texture.
  64693. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  64694. */
  64695. update(invertY?: Nullable<boolean>): void;
  64696. }
  64697. }
  64698. declare module "babylonjs/Misc/tga" {
  64699. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64700. /**
  64701. * Based on jsTGALoader - Javascript loader for TGA file
  64702. * By Vincent Thibault
  64703. * @see http://blog.robrowser.com/javascript-tga-loader.html
  64704. */
  64705. export class TGATools {
  64706. private static _TYPE_INDEXED;
  64707. private static _TYPE_RGB;
  64708. private static _TYPE_GREY;
  64709. private static _TYPE_RLE_INDEXED;
  64710. private static _TYPE_RLE_RGB;
  64711. private static _TYPE_RLE_GREY;
  64712. private static _ORIGIN_MASK;
  64713. private static _ORIGIN_SHIFT;
  64714. private static _ORIGIN_BL;
  64715. private static _ORIGIN_BR;
  64716. private static _ORIGIN_UL;
  64717. private static _ORIGIN_UR;
  64718. /**
  64719. * Gets the header of a TGA file
  64720. * @param data defines the TGA data
  64721. * @returns the header
  64722. */
  64723. static GetTGAHeader(data: Uint8Array): any;
  64724. /**
  64725. * Uploads TGA content to a Babylon Texture
  64726. * @hidden
  64727. */
  64728. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  64729. /** @hidden */
  64730. 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;
  64731. /** @hidden */
  64732. 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;
  64733. /** @hidden */
  64734. 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;
  64735. /** @hidden */
  64736. 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;
  64737. /** @hidden */
  64738. 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;
  64739. /** @hidden */
  64740. 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;
  64741. }
  64742. }
  64743. declare module "babylonjs/Materials/Textures/Loaders/tgaTextureLoader" {
  64744. import { Nullable } from "babylonjs/types";
  64745. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64746. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  64747. /**
  64748. * Implementation of the TGA Texture Loader.
  64749. * @hidden
  64750. */
  64751. export class _TGATextureLoader implements IInternalTextureLoader {
  64752. /**
  64753. * Defines wether the loader supports cascade loading the different faces.
  64754. */
  64755. readonly supportCascades: boolean;
  64756. /**
  64757. * This returns if the loader support the current file information.
  64758. * @param extension defines the file extension of the file being loaded
  64759. * @returns true if the loader can load the specified file
  64760. */
  64761. canLoad(extension: string): boolean;
  64762. /**
  64763. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  64764. * @param data contains the texture data
  64765. * @param texture defines the BabylonJS internal texture
  64766. * @param createPolynomials will be true if polynomials have been requested
  64767. * @param onLoad defines the callback to trigger once the texture is ready
  64768. * @param onError defines the callback to trigger in case of error
  64769. */
  64770. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64771. /**
  64772. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64773. * @param data contains the texture data
  64774. * @param texture defines the BabylonJS internal texture
  64775. * @param callback defines the method to call once ready to upload
  64776. */
  64777. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64778. }
  64779. }
  64780. declare module "babylonjs/Misc/basis" {
  64781. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64782. /**
  64783. * Info about the .basis files
  64784. */
  64785. class BasisFileInfo {
  64786. /**
  64787. * If the file has alpha
  64788. */
  64789. hasAlpha: boolean;
  64790. /**
  64791. * Info about each image of the basis file
  64792. */
  64793. images: Array<{
  64794. levels: Array<{
  64795. width: number;
  64796. height: number;
  64797. transcodedPixels: ArrayBufferView;
  64798. }>;
  64799. }>;
  64800. }
  64801. /**
  64802. * Result of transcoding a basis file
  64803. */
  64804. class TranscodeResult {
  64805. /**
  64806. * Info about the .basis file
  64807. */
  64808. fileInfo: BasisFileInfo;
  64809. /**
  64810. * Format to use when loading the file
  64811. */
  64812. format: number;
  64813. }
  64814. /**
  64815. * Configuration options for the Basis transcoder
  64816. */
  64817. export class BasisTranscodeConfiguration {
  64818. /**
  64819. * Supported compression formats used to determine the supported output format of the transcoder
  64820. */
  64821. supportedCompressionFormats?: {
  64822. /**
  64823. * etc1 compression format
  64824. */
  64825. etc1?: boolean;
  64826. /**
  64827. * s3tc compression format
  64828. */
  64829. s3tc?: boolean;
  64830. /**
  64831. * pvrtc compression format
  64832. */
  64833. pvrtc?: boolean;
  64834. /**
  64835. * etc2 compression format
  64836. */
  64837. etc2?: boolean;
  64838. };
  64839. /**
  64840. * If mipmap levels should be loaded for transcoded images (Default: true)
  64841. */
  64842. loadMipmapLevels?: boolean;
  64843. /**
  64844. * Index of a single image to load (Default: all images)
  64845. */
  64846. loadSingleImage?: number;
  64847. }
  64848. /**
  64849. * Used to load .Basis files
  64850. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  64851. */
  64852. export class BasisTools {
  64853. private static _IgnoreSupportedFormats;
  64854. /**
  64855. * URL to use when loading the basis transcoder
  64856. */
  64857. static JSModuleURL: string;
  64858. /**
  64859. * URL to use when loading the wasm module for the transcoder
  64860. */
  64861. static WasmModuleURL: string;
  64862. /**
  64863. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  64864. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  64865. * @returns internal format corresponding to the Basis format
  64866. */
  64867. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  64868. private static _WorkerPromise;
  64869. private static _Worker;
  64870. private static _actionId;
  64871. private static _CreateWorkerAsync;
  64872. /**
  64873. * Transcodes a loaded image file to compressed pixel data
  64874. * @param data image data to transcode
  64875. * @param config configuration options for the transcoding
  64876. * @returns a promise resulting in the transcoded image
  64877. */
  64878. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  64879. /**
  64880. * Loads a texture from the transcode result
  64881. * @param texture texture load to
  64882. * @param transcodeResult the result of transcoding the basis file to load from
  64883. */
  64884. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  64885. }
  64886. }
  64887. declare module "babylonjs/Materials/Textures/Loaders/basisTextureLoader" {
  64888. import { Nullable } from "babylonjs/types";
  64889. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64890. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  64891. /**
  64892. * Loader for .basis file format
  64893. */
  64894. export class _BasisTextureLoader implements IInternalTextureLoader {
  64895. /**
  64896. * Defines whether the loader supports cascade loading the different faces.
  64897. */
  64898. readonly supportCascades: boolean;
  64899. /**
  64900. * This returns if the loader support the current file information.
  64901. * @param extension defines the file extension of the file being loaded
  64902. * @returns true if the loader can load the specified file
  64903. */
  64904. canLoad(extension: string): boolean;
  64905. /**
  64906. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  64907. * @param data contains the texture data
  64908. * @param texture defines the BabylonJS internal texture
  64909. * @param createPolynomials will be true if polynomials have been requested
  64910. * @param onLoad defines the callback to trigger once the texture is ready
  64911. * @param onError defines the callback to trigger in case of error
  64912. */
  64913. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64914. /**
  64915. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64916. * @param data contains the texture data
  64917. * @param texture defines the BabylonJS internal texture
  64918. * @param callback defines the method to call once ready to upload
  64919. */
  64920. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64921. }
  64922. }
  64923. declare module "babylonjs/Materials/Textures/Loaders/index" {
  64924. export * from "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  64925. export * from "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  64926. export * from "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  64927. export * from "babylonjs/Materials/Textures/Loaders/tgaTextureLoader";
  64928. export * from "babylonjs/Materials/Textures/Loaders/basisTextureLoader";
  64929. }
  64930. declare module "babylonjs/Materials/Textures/Packer/frame" {
  64931. import { Vector2 } from "babylonjs/Maths/math.vector";
  64932. /**
  64933. * Defines the basic options interface of a TexturePacker Frame
  64934. */
  64935. export interface ITexturePackerFrame {
  64936. /**
  64937. * The frame ID
  64938. */
  64939. id: number;
  64940. /**
  64941. * The frames Scale
  64942. */
  64943. scale: Vector2;
  64944. /**
  64945. * The Frames offset
  64946. */
  64947. offset: Vector2;
  64948. }
  64949. /**
  64950. * This is a support class for frame Data on texture packer sets.
  64951. */
  64952. export class TexturePackerFrame implements ITexturePackerFrame {
  64953. /**
  64954. * The frame ID
  64955. */
  64956. id: number;
  64957. /**
  64958. * The frames Scale
  64959. */
  64960. scale: Vector2;
  64961. /**
  64962. * The Frames offset
  64963. */
  64964. offset: Vector2;
  64965. /**
  64966. * Initializes a texture package frame.
  64967. * @param id The numerical frame identifier
  64968. * @param scale Scalar Vector2 for UV frame
  64969. * @param offset Vector2 for the frame position in UV units.
  64970. * @returns TexturePackerFrame
  64971. */
  64972. constructor(id: number, scale: Vector2, offset: Vector2);
  64973. }
  64974. }
  64975. declare module "babylonjs/Materials/Textures/Packer/packer" {
  64976. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64977. import { Scene } from "babylonjs/scene";
  64978. import { Nullable } from "babylonjs/types";
  64979. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  64980. import { TexturePackerFrame } from "babylonjs/Materials/Textures/Packer/frame";
  64981. /**
  64982. * Defines the basic options interface of a TexturePacker
  64983. */
  64984. export interface ITexturePackerOptions {
  64985. /**
  64986. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  64987. */
  64988. map?: string[];
  64989. /**
  64990. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64991. */
  64992. uvsIn?: string;
  64993. /**
  64994. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64995. */
  64996. uvsOut?: string;
  64997. /**
  64998. * number representing the layout style. Defaults to LAYOUT_STRIP
  64999. */
  65000. layout?: number;
  65001. /**
  65002. * number of columns if using custom column count layout(2). This defaults to 4.
  65003. */
  65004. colnum?: number;
  65005. /**
  65006. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  65007. */
  65008. updateInputMeshes?: boolean;
  65009. /**
  65010. * boolean flag to dispose all the source textures. Defaults to true.
  65011. */
  65012. disposeSources?: boolean;
  65013. /**
  65014. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  65015. */
  65016. fillBlanks?: boolean;
  65017. /**
  65018. * string value representing the context fill style color. Defaults to 'black'.
  65019. */
  65020. customFillColor?: string;
  65021. /**
  65022. * Width and Height Value of each Frame in the TexturePacker Sets
  65023. */
  65024. frameSize?: number;
  65025. /**
  65026. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  65027. */
  65028. paddingRatio?: number;
  65029. /**
  65030. * Number that declares the fill method for the padding gutter.
  65031. */
  65032. paddingMode?: number;
  65033. /**
  65034. * If in SUBUV_COLOR padding mode what color to use.
  65035. */
  65036. paddingColor?: Color3 | Color4;
  65037. }
  65038. /**
  65039. * Defines the basic interface of a TexturePacker JSON File
  65040. */
  65041. export interface ITexturePackerJSON {
  65042. /**
  65043. * The frame ID
  65044. */
  65045. name: string;
  65046. /**
  65047. * The base64 channel data
  65048. */
  65049. sets: any;
  65050. /**
  65051. * The options of the Packer
  65052. */
  65053. options: ITexturePackerOptions;
  65054. /**
  65055. * The frame data of the Packer
  65056. */
  65057. frames: Array<number>;
  65058. }
  65059. /**
  65060. * This is a support class that generates a series of packed texture sets.
  65061. * @see https://doc.babylonjs.com/babylon101/materials
  65062. */
  65063. export class TexturePacker {
  65064. /** Packer Layout Constant 0 */
  65065. static readonly LAYOUT_STRIP: number;
  65066. /** Packer Layout Constant 1 */
  65067. static readonly LAYOUT_POWER2: number;
  65068. /** Packer Layout Constant 2 */
  65069. static readonly LAYOUT_COLNUM: number;
  65070. /** Packer Layout Constant 0 */
  65071. static readonly SUBUV_WRAP: number;
  65072. /** Packer Layout Constant 1 */
  65073. static readonly SUBUV_EXTEND: number;
  65074. /** Packer Layout Constant 2 */
  65075. static readonly SUBUV_COLOR: number;
  65076. /** The Name of the Texture Package */
  65077. name: string;
  65078. /** The scene scope of the TexturePacker */
  65079. scene: Scene;
  65080. /** The Meshes to target */
  65081. meshes: AbstractMesh[];
  65082. /** Arguments passed with the Constructor */
  65083. options: ITexturePackerOptions;
  65084. /** The promise that is started upon initialization */
  65085. promise: Nullable<Promise<TexturePacker | string>>;
  65086. /** The Container object for the channel sets that are generated */
  65087. sets: object;
  65088. /** The Container array for the frames that are generated */
  65089. frames: TexturePackerFrame[];
  65090. /** The expected number of textures the system is parsing. */
  65091. private _expecting;
  65092. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  65093. private _paddingValue;
  65094. /**
  65095. * Initializes a texture package series from an array of meshes or a single mesh.
  65096. * @param name The name of the package
  65097. * @param meshes The target meshes to compose the package from
  65098. * @param options The arguments that texture packer should follow while building.
  65099. * @param scene The scene which the textures are scoped to.
  65100. * @returns TexturePacker
  65101. */
  65102. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  65103. /**
  65104. * Starts the package process
  65105. * @param resolve The promises resolution function
  65106. * @returns TexturePacker
  65107. */
  65108. private _createFrames;
  65109. /**
  65110. * Calculates the Size of the Channel Sets
  65111. * @returns Vector2
  65112. */
  65113. private _calculateSize;
  65114. /**
  65115. * Calculates the UV data for the frames.
  65116. * @param baseSize the base frameSize
  65117. * @param padding the base frame padding
  65118. * @param dtSize size of the Dynamic Texture for that channel
  65119. * @param dtUnits is 1/dtSize
  65120. * @param update flag to update the input meshes
  65121. */
  65122. private _calculateMeshUVFrames;
  65123. /**
  65124. * Calculates the frames Offset.
  65125. * @param index of the frame
  65126. * @returns Vector2
  65127. */
  65128. private _getFrameOffset;
  65129. /**
  65130. * Updates a Mesh to the frame data
  65131. * @param mesh that is the target
  65132. * @param frameID or the frame index
  65133. */
  65134. private _updateMeshUV;
  65135. /**
  65136. * Updates a Meshes materials to use the texture packer channels
  65137. * @param m is the mesh to target
  65138. * @param force all channels on the packer to be set.
  65139. */
  65140. private _updateTextureReferences;
  65141. /**
  65142. * Public method to set a Mesh to a frame
  65143. * @param m that is the target
  65144. * @param frameID or the frame index
  65145. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  65146. */
  65147. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  65148. /**
  65149. * Starts the async promise to compile the texture packer.
  65150. * @returns Promise<void>
  65151. */
  65152. processAsync(): Promise<void>;
  65153. /**
  65154. * Disposes all textures associated with this packer
  65155. */
  65156. dispose(): void;
  65157. /**
  65158. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  65159. * @param imageType is the image type to use.
  65160. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  65161. */
  65162. download(imageType?: string, quality?: number): void;
  65163. /**
  65164. * Public method to load a texturePacker JSON file.
  65165. * @param data of the JSON file in string format.
  65166. */
  65167. updateFromJSON(data: string): void;
  65168. }
  65169. }
  65170. declare module "babylonjs/Materials/Textures/Packer/index" {
  65171. export * from "babylonjs/Materials/Textures/Packer/packer";
  65172. export * from "babylonjs/Materials/Textures/Packer/frame";
  65173. }
  65174. declare module "babylonjs/Materials/Textures/Procedurals/customProceduralTexture" {
  65175. import { Scene } from "babylonjs/scene";
  65176. import { Texture } from "babylonjs/Materials/Textures/texture";
  65177. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  65178. /**
  65179. * 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.
  65180. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  65181. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  65182. */
  65183. export class CustomProceduralTexture extends ProceduralTexture {
  65184. private _animate;
  65185. private _time;
  65186. private _config;
  65187. private _texturePath;
  65188. /**
  65189. * Instantiates a new Custom Procedural Texture.
  65190. * 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.
  65191. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  65192. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  65193. * @param name Define the name of the texture
  65194. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  65195. * @param size Define the size of the texture to create
  65196. * @param scene Define the scene the texture belongs to
  65197. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  65198. * @param generateMipMaps Define if the texture should creates mip maps or not
  65199. */
  65200. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  65201. private _loadJson;
  65202. /**
  65203. * Is the texture ready to be used ? (rendered at least once)
  65204. * @returns true if ready, otherwise, false.
  65205. */
  65206. isReady(): boolean;
  65207. /**
  65208. * Render the texture to its associated render target.
  65209. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  65210. */
  65211. render(useCameraPostProcess?: boolean): void;
  65212. /**
  65213. * Update the list of dependant textures samplers in the shader.
  65214. */
  65215. updateTextures(): void;
  65216. /**
  65217. * Update the uniform values of the procedural texture in the shader.
  65218. */
  65219. updateShaderUniforms(): void;
  65220. /**
  65221. * Define if the texture animates or not.
  65222. */
  65223. get animate(): boolean;
  65224. set animate(value: boolean);
  65225. }
  65226. }
  65227. declare module "babylonjs/Shaders/noise.fragment" {
  65228. /** @hidden */
  65229. export var noisePixelShader: {
  65230. name: string;
  65231. shader: string;
  65232. };
  65233. }
  65234. declare module "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture" {
  65235. import { Nullable } from "babylonjs/types";
  65236. import { Scene } from "babylonjs/scene";
  65237. import { Texture } from "babylonjs/Materials/Textures/texture";
  65238. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  65239. import "babylonjs/Shaders/noise.fragment";
  65240. /**
  65241. * Class used to generate noise procedural textures
  65242. */
  65243. export class NoiseProceduralTexture extends ProceduralTexture {
  65244. /** Gets or sets the start time (default is 0) */
  65245. time: number;
  65246. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  65247. brightness: number;
  65248. /** Defines the number of octaves to process */
  65249. octaves: number;
  65250. /** Defines the level of persistence (0.8 by default) */
  65251. persistence: number;
  65252. /** Gets or sets animation speed factor (default is 1) */
  65253. animationSpeedFactor: number;
  65254. /**
  65255. * Creates a new NoiseProceduralTexture
  65256. * @param name defines the name fo the texture
  65257. * @param size defines the size of the texture (default is 256)
  65258. * @param scene defines the hosting scene
  65259. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  65260. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  65261. */
  65262. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  65263. private _updateShaderUniforms;
  65264. protected _getDefines(): string;
  65265. /** Generate the current state of the procedural texture */
  65266. render(useCameraPostProcess?: boolean): void;
  65267. /**
  65268. * Serializes this noise procedural texture
  65269. * @returns a serialized noise procedural texture object
  65270. */
  65271. serialize(): any;
  65272. /**
  65273. * Clone the texture.
  65274. * @returns the cloned texture
  65275. */
  65276. clone(): NoiseProceduralTexture;
  65277. /**
  65278. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  65279. * @param parsedTexture defines parsed texture data
  65280. * @param scene defines the current scene
  65281. * @param rootUrl defines the root URL containing noise procedural texture information
  65282. * @returns a parsed NoiseProceduralTexture
  65283. */
  65284. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  65285. }
  65286. }
  65287. declare module "babylonjs/Materials/Textures/Procedurals/index" {
  65288. export * from "babylonjs/Materials/Textures/Procedurals/customProceduralTexture";
  65289. export * from "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture";
  65290. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  65291. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent";
  65292. }
  65293. declare module "babylonjs/Materials/Textures/rawCubeTexture" {
  65294. import { Nullable } from "babylonjs/types";
  65295. import { Scene } from "babylonjs/scene";
  65296. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  65297. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  65298. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  65299. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65300. /**
  65301. * Raw cube texture where the raw buffers are passed in
  65302. */
  65303. export class RawCubeTexture extends CubeTexture {
  65304. /**
  65305. * Creates a cube texture where the raw buffers are passed in.
  65306. * @param scene defines the scene the texture is attached to
  65307. * @param data defines the array of data to use to create each face
  65308. * @param size defines the size of the textures
  65309. * @param format defines the format of the data
  65310. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  65311. * @param generateMipMaps defines if the engine should generate the mip levels
  65312. * @param invertY defines if data must be stored with Y axis inverted
  65313. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  65314. * @param compression defines the compression used (null by default)
  65315. */
  65316. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  65317. /**
  65318. * Updates the raw cube texture.
  65319. * @param data defines the data to store
  65320. * @param format defines the data format
  65321. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  65322. * @param invertY defines if data must be stored with Y axis inverted
  65323. * @param compression defines the compression used (null by default)
  65324. * @param level defines which level of the texture to update
  65325. */
  65326. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  65327. /**
  65328. * Updates a raw cube texture with RGBD encoded data.
  65329. * @param data defines the array of data [mipmap][face] to use to create each face
  65330. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  65331. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  65332. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  65333. * @returns a promsie that resolves when the operation is complete
  65334. */
  65335. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  65336. /**
  65337. * Clones the raw cube texture.
  65338. * @return a new cube texture
  65339. */
  65340. clone(): CubeTexture;
  65341. /** @hidden */
  65342. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  65343. }
  65344. }
  65345. declare module "babylonjs/Materials/Textures/rawTexture2DArray" {
  65346. import { Scene } from "babylonjs/scene";
  65347. import { Texture } from "babylonjs/Materials/Textures/texture";
  65348. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65349. /**
  65350. * Class used to store 2D array textures containing user data
  65351. */
  65352. export class RawTexture2DArray extends Texture {
  65353. /** Gets or sets the texture format to use */
  65354. format: number;
  65355. /**
  65356. * Create a new RawTexture2DArray
  65357. * @param data defines the data of the texture
  65358. * @param width defines the width of the texture
  65359. * @param height defines the height of the texture
  65360. * @param depth defines the number of layers of the texture
  65361. * @param format defines the texture format to use
  65362. * @param scene defines the hosting scene
  65363. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  65364. * @param invertY defines if texture must be stored with Y axis inverted
  65365. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  65366. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  65367. */
  65368. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  65369. /** Gets or sets the texture format to use */
  65370. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  65371. /**
  65372. * Update the texture with new data
  65373. * @param data defines the data to store in the texture
  65374. */
  65375. update(data: ArrayBufferView): void;
  65376. }
  65377. }
  65378. declare module "babylonjs/Materials/Textures/rawTexture3D" {
  65379. import { Scene } from "babylonjs/scene";
  65380. import { Texture } from "babylonjs/Materials/Textures/texture";
  65381. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65382. /**
  65383. * Class used to store 3D textures containing user data
  65384. */
  65385. export class RawTexture3D extends Texture {
  65386. /** Gets or sets the texture format to use */
  65387. format: number;
  65388. /**
  65389. * Create a new RawTexture3D
  65390. * @param data defines the data of the texture
  65391. * @param width defines the width of the texture
  65392. * @param height defines the height of the texture
  65393. * @param depth defines the depth of the texture
  65394. * @param format defines the texture format to use
  65395. * @param scene defines the hosting scene
  65396. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  65397. * @param invertY defines if texture must be stored with Y axis inverted
  65398. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  65399. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  65400. */
  65401. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  65402. /** Gets or sets the texture format to use */
  65403. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  65404. /**
  65405. * Update the texture with new data
  65406. * @param data defines the data to store in the texture
  65407. */
  65408. update(data: ArrayBufferView): void;
  65409. }
  65410. }
  65411. declare module "babylonjs/Materials/Textures/refractionTexture" {
  65412. import { Scene } from "babylonjs/scene";
  65413. import { Plane } from "babylonjs/Maths/math.plane";
  65414. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  65415. /**
  65416. * Creates a refraction texture used by refraction channel of the standard material.
  65417. * It is like a mirror but to see through a material.
  65418. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65419. */
  65420. export class RefractionTexture extends RenderTargetTexture {
  65421. /**
  65422. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  65423. * 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.
  65424. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65425. */
  65426. refractionPlane: Plane;
  65427. /**
  65428. * Define how deep under the surface we should see.
  65429. */
  65430. depth: number;
  65431. /**
  65432. * Creates a refraction texture used by refraction channel of the standard material.
  65433. * It is like a mirror but to see through a material.
  65434. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65435. * @param name Define the texture name
  65436. * @param size Define the size of the underlying texture
  65437. * @param scene Define the scene the refraction belongs to
  65438. * @param generateMipMaps Define if we need to generate mips level for the refraction
  65439. */
  65440. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  65441. /**
  65442. * Clone the refraction texture.
  65443. * @returns the cloned texture
  65444. */
  65445. clone(): RefractionTexture;
  65446. /**
  65447. * Serialize the texture to a JSON representation you could use in Parse later on
  65448. * @returns the serialized JSON representation
  65449. */
  65450. serialize(): any;
  65451. }
  65452. }
  65453. declare module "babylonjs/Materials/Textures/index" {
  65454. export * from "babylonjs/Materials/Textures/baseTexture";
  65455. export * from "babylonjs/Materials/Textures/baseTexture.polynomial";
  65456. export * from "babylonjs/Materials/Textures/colorGradingTexture";
  65457. export * from "babylonjs/Materials/Textures/cubeTexture";
  65458. export * from "babylonjs/Materials/Textures/dynamicTexture";
  65459. export * from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  65460. export * from "babylonjs/Materials/Textures/Filtering/hdrFiltering";
  65461. export * from "babylonjs/Materials/Textures/hdrCubeTexture";
  65462. export * from "babylonjs/Materials/Textures/htmlElementTexture";
  65463. export * from "babylonjs/Materials/Textures/internalTexture";
  65464. export * from "babylonjs/Materials/Textures/internalTextureLoader";
  65465. export * from "babylonjs/Materials/Textures/Loaders/index";
  65466. export * from "babylonjs/Materials/Textures/mirrorTexture";
  65467. export * from "babylonjs/Materials/Textures/multiRenderTarget";
  65468. export * from "babylonjs/Materials/Textures/Packer/index";
  65469. export * from "babylonjs/Materials/Textures/Procedurals/index";
  65470. export * from "babylonjs/Materials/Textures/rawCubeTexture";
  65471. export * from "babylonjs/Materials/Textures/rawTexture";
  65472. export * from "babylonjs/Materials/Textures/rawTexture2DArray";
  65473. export * from "babylonjs/Materials/Textures/rawTexture3D";
  65474. export * from "babylonjs/Materials/Textures/refractionTexture";
  65475. export * from "babylonjs/Materials/Textures/renderTargetTexture";
  65476. export * from "babylonjs/Materials/Textures/texture";
  65477. export * from "babylonjs/Materials/Textures/videoTexture";
  65478. }
  65479. declare module "babylonjs/Materials/Node/Enums/index" {
  65480. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  65481. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  65482. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode";
  65483. export * from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  65484. export * from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  65485. }
  65486. declare module "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock" {
  65487. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65488. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65489. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65490. import { Mesh } from "babylonjs/Meshes/mesh";
  65491. import { Effect } from "babylonjs/Materials/effect";
  65492. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65493. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65494. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  65495. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  65496. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  65497. /**
  65498. * Block used to add support for vertex skinning (bones)
  65499. */
  65500. export class BonesBlock extends NodeMaterialBlock {
  65501. /**
  65502. * Creates a new BonesBlock
  65503. * @param name defines the block name
  65504. */
  65505. constructor(name: string);
  65506. /**
  65507. * Initialize the block and prepare the context for build
  65508. * @param state defines the state that will be used for the build
  65509. */
  65510. initialize(state: NodeMaterialBuildState): void;
  65511. /**
  65512. * Gets the current class name
  65513. * @returns the class name
  65514. */
  65515. getClassName(): string;
  65516. /**
  65517. * Gets the matrix indices input component
  65518. */
  65519. get matricesIndices(): NodeMaterialConnectionPoint;
  65520. /**
  65521. * Gets the matrix weights input component
  65522. */
  65523. get matricesWeights(): NodeMaterialConnectionPoint;
  65524. /**
  65525. * Gets the extra matrix indices input component
  65526. */
  65527. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  65528. /**
  65529. * Gets the extra matrix weights input component
  65530. */
  65531. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  65532. /**
  65533. * Gets the world input component
  65534. */
  65535. get world(): NodeMaterialConnectionPoint;
  65536. /**
  65537. * Gets the output component
  65538. */
  65539. get output(): NodeMaterialConnectionPoint;
  65540. autoConfigure(material: NodeMaterial): void;
  65541. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  65542. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65543. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65544. protected _buildBlock(state: NodeMaterialBuildState): this;
  65545. }
  65546. }
  65547. declare module "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock" {
  65548. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65549. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65550. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65551. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65552. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65553. import { SubMesh } from "babylonjs/Meshes/subMesh";
  65554. /**
  65555. * Block used to add support for instances
  65556. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  65557. */
  65558. export class InstancesBlock extends NodeMaterialBlock {
  65559. /**
  65560. * Creates a new InstancesBlock
  65561. * @param name defines the block name
  65562. */
  65563. constructor(name: string);
  65564. /**
  65565. * Gets the current class name
  65566. * @returns the class name
  65567. */
  65568. getClassName(): string;
  65569. /**
  65570. * Gets the first world row input component
  65571. */
  65572. get world0(): NodeMaterialConnectionPoint;
  65573. /**
  65574. * Gets the second world row input component
  65575. */
  65576. get world1(): NodeMaterialConnectionPoint;
  65577. /**
  65578. * Gets the third world row input component
  65579. */
  65580. get world2(): NodeMaterialConnectionPoint;
  65581. /**
  65582. * Gets the forth world row input component
  65583. */
  65584. get world3(): NodeMaterialConnectionPoint;
  65585. /**
  65586. * Gets the world input component
  65587. */
  65588. get world(): NodeMaterialConnectionPoint;
  65589. /**
  65590. * Gets the output component
  65591. */
  65592. get output(): NodeMaterialConnectionPoint;
  65593. /**
  65594. * Gets the isntanceID component
  65595. */
  65596. get instanceID(): NodeMaterialConnectionPoint;
  65597. autoConfigure(material: NodeMaterial): void;
  65598. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  65599. protected _buildBlock(state: NodeMaterialBuildState): this;
  65600. }
  65601. }
  65602. declare module "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock" {
  65603. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65604. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65605. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65606. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65607. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65608. import { Effect } from "babylonjs/Materials/effect";
  65609. import { Mesh } from "babylonjs/Meshes/mesh";
  65610. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  65611. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  65612. /**
  65613. * Block used to add morph targets support to vertex shader
  65614. */
  65615. export class MorphTargetsBlock extends NodeMaterialBlock {
  65616. private _repeatableContentAnchor;
  65617. /**
  65618. * Create a new MorphTargetsBlock
  65619. * @param name defines the block name
  65620. */
  65621. constructor(name: string);
  65622. /**
  65623. * Gets the current class name
  65624. * @returns the class name
  65625. */
  65626. getClassName(): string;
  65627. /**
  65628. * Gets the position input component
  65629. */
  65630. get position(): NodeMaterialConnectionPoint;
  65631. /**
  65632. * Gets the normal input component
  65633. */
  65634. get normal(): NodeMaterialConnectionPoint;
  65635. /**
  65636. * Gets the tangent input component
  65637. */
  65638. get tangent(): NodeMaterialConnectionPoint;
  65639. /**
  65640. * Gets the tangent input component
  65641. */
  65642. get uv(): NodeMaterialConnectionPoint;
  65643. /**
  65644. * Gets the position output component
  65645. */
  65646. get positionOutput(): NodeMaterialConnectionPoint;
  65647. /**
  65648. * Gets the normal output component
  65649. */
  65650. get normalOutput(): NodeMaterialConnectionPoint;
  65651. /**
  65652. * Gets the tangent output component
  65653. */
  65654. get tangentOutput(): NodeMaterialConnectionPoint;
  65655. /**
  65656. * Gets the tangent output component
  65657. */
  65658. get uvOutput(): NodeMaterialConnectionPoint;
  65659. initialize(state: NodeMaterialBuildState): void;
  65660. autoConfigure(material: NodeMaterial): void;
  65661. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65662. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65663. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  65664. protected _buildBlock(state: NodeMaterialBuildState): this;
  65665. }
  65666. }
  65667. declare module "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock" {
  65668. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65669. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65670. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65671. import { Nullable } from "babylonjs/types";
  65672. import { Scene } from "babylonjs/scene";
  65673. import { Effect } from "babylonjs/Materials/effect";
  65674. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65675. import { Mesh } from "babylonjs/Meshes/mesh";
  65676. import { Light } from "babylonjs/Lights/light";
  65677. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65678. /**
  65679. * Block used to get data information from a light
  65680. */
  65681. export class LightInformationBlock extends NodeMaterialBlock {
  65682. private _lightDataUniformName;
  65683. private _lightColorUniformName;
  65684. private _lightTypeDefineName;
  65685. /**
  65686. * Gets or sets the light associated with this block
  65687. */
  65688. light: Nullable<Light>;
  65689. /**
  65690. * Creates a new LightInformationBlock
  65691. * @param name defines the block name
  65692. */
  65693. constructor(name: string);
  65694. /**
  65695. * Gets the current class name
  65696. * @returns the class name
  65697. */
  65698. getClassName(): string;
  65699. /**
  65700. * Gets the world position input component
  65701. */
  65702. get worldPosition(): NodeMaterialConnectionPoint;
  65703. /**
  65704. * Gets the direction output component
  65705. */
  65706. get direction(): NodeMaterialConnectionPoint;
  65707. /**
  65708. * Gets the direction output component
  65709. */
  65710. get color(): NodeMaterialConnectionPoint;
  65711. /**
  65712. * Gets the direction output component
  65713. */
  65714. get intensity(): NodeMaterialConnectionPoint;
  65715. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65716. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65717. protected _buildBlock(state: NodeMaterialBuildState): this;
  65718. serialize(): any;
  65719. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65720. }
  65721. }
  65722. declare module "babylonjs/Materials/Node/Blocks/Vertex/index" {
  65723. export * from "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock";
  65724. export * from "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock";
  65725. export * from "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock";
  65726. export * from "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock";
  65727. export * from "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock";
  65728. }
  65729. declare module "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock" {
  65730. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65731. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65732. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65733. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65734. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65735. import { Effect } from "babylonjs/Materials/effect";
  65736. import { Mesh } from "babylonjs/Meshes/mesh";
  65737. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65738. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  65739. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  65740. /**
  65741. * Block used to add image processing support to fragment shader
  65742. */
  65743. export class ImageProcessingBlock extends NodeMaterialBlock {
  65744. /**
  65745. * Create a new ImageProcessingBlock
  65746. * @param name defines the block name
  65747. */
  65748. constructor(name: string);
  65749. /**
  65750. * Gets the current class name
  65751. * @returns the class name
  65752. */
  65753. getClassName(): string;
  65754. /**
  65755. * Gets the color input component
  65756. */
  65757. get color(): NodeMaterialConnectionPoint;
  65758. /**
  65759. * Gets the output component
  65760. */
  65761. get output(): NodeMaterialConnectionPoint;
  65762. /**
  65763. * Initialize the block and prepare the context for build
  65764. * @param state defines the state that will be used for the build
  65765. */
  65766. initialize(state: NodeMaterialBuildState): void;
  65767. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  65768. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65769. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65770. protected _buildBlock(state: NodeMaterialBuildState): this;
  65771. }
  65772. }
  65773. declare module "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock" {
  65774. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65775. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65776. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65777. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65778. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65779. import { Effect } from "babylonjs/Materials/effect";
  65780. import { Mesh } from "babylonjs/Meshes/mesh";
  65781. import { Scene } from "babylonjs/scene";
  65782. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  65783. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  65784. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  65785. /**
  65786. * Block used to pertub normals based on a normal map
  65787. */
  65788. export class PerturbNormalBlock extends NodeMaterialBlock {
  65789. private _tangentSpaceParameterName;
  65790. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  65791. invertX: boolean;
  65792. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  65793. invertY: boolean;
  65794. /**
  65795. * Create a new PerturbNormalBlock
  65796. * @param name defines the block name
  65797. */
  65798. constructor(name: string);
  65799. /**
  65800. * Gets the current class name
  65801. * @returns the class name
  65802. */
  65803. getClassName(): string;
  65804. /**
  65805. * Gets the world position input component
  65806. */
  65807. get worldPosition(): NodeMaterialConnectionPoint;
  65808. /**
  65809. * Gets the world normal input component
  65810. */
  65811. get worldNormal(): NodeMaterialConnectionPoint;
  65812. /**
  65813. * Gets the world tangent input component
  65814. */
  65815. get worldTangent(): NodeMaterialConnectionPoint;
  65816. /**
  65817. * Gets the uv input component
  65818. */
  65819. get uv(): NodeMaterialConnectionPoint;
  65820. /**
  65821. * Gets the normal map color input component
  65822. */
  65823. get normalMapColor(): NodeMaterialConnectionPoint;
  65824. /**
  65825. * Gets the strength input component
  65826. */
  65827. get strength(): NodeMaterialConnectionPoint;
  65828. /**
  65829. * Gets the output component
  65830. */
  65831. get output(): NodeMaterialConnectionPoint;
  65832. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65833. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65834. autoConfigure(material: NodeMaterial): void;
  65835. protected _buildBlock(state: NodeMaterialBuildState): this;
  65836. protected _dumpPropertiesCode(): string;
  65837. serialize(): any;
  65838. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65839. }
  65840. }
  65841. declare module "babylonjs/Materials/Node/Blocks/Fragment/discardBlock" {
  65842. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65843. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65844. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65845. /**
  65846. * Block used to discard a pixel if a value is smaller than a cutoff
  65847. */
  65848. export class DiscardBlock extends NodeMaterialBlock {
  65849. /**
  65850. * Create a new DiscardBlock
  65851. * @param name defines the block name
  65852. */
  65853. constructor(name: string);
  65854. /**
  65855. * Gets the current class name
  65856. * @returns the class name
  65857. */
  65858. getClassName(): string;
  65859. /**
  65860. * Gets the color input component
  65861. */
  65862. get value(): NodeMaterialConnectionPoint;
  65863. /**
  65864. * Gets the cutoff input component
  65865. */
  65866. get cutoff(): NodeMaterialConnectionPoint;
  65867. protected _buildBlock(state: NodeMaterialBuildState): this;
  65868. }
  65869. }
  65870. declare module "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock" {
  65871. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65872. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65873. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65874. /**
  65875. * Block used to test if the fragment shader is front facing
  65876. */
  65877. export class FrontFacingBlock extends NodeMaterialBlock {
  65878. /**
  65879. * Creates a new FrontFacingBlock
  65880. * @param name defines the block name
  65881. */
  65882. constructor(name: string);
  65883. /**
  65884. * Gets the current class name
  65885. * @returns the class name
  65886. */
  65887. getClassName(): string;
  65888. /**
  65889. * Gets the output component
  65890. */
  65891. get output(): NodeMaterialConnectionPoint;
  65892. protected _buildBlock(state: NodeMaterialBuildState): this;
  65893. }
  65894. }
  65895. declare module "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock" {
  65896. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65897. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65898. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65899. /**
  65900. * Block used to get the derivative value on x and y of a given input
  65901. */
  65902. export class DerivativeBlock extends NodeMaterialBlock {
  65903. /**
  65904. * Create a new DerivativeBlock
  65905. * @param name defines the block name
  65906. */
  65907. constructor(name: string);
  65908. /**
  65909. * Gets the current class name
  65910. * @returns the class name
  65911. */
  65912. getClassName(): string;
  65913. /**
  65914. * Gets the input component
  65915. */
  65916. get input(): NodeMaterialConnectionPoint;
  65917. /**
  65918. * Gets the derivative output on x
  65919. */
  65920. get dx(): NodeMaterialConnectionPoint;
  65921. /**
  65922. * Gets the derivative output on y
  65923. */
  65924. get dy(): NodeMaterialConnectionPoint;
  65925. protected _buildBlock(state: NodeMaterialBuildState): this;
  65926. }
  65927. }
  65928. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock" {
  65929. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65930. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65931. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65932. /**
  65933. * Block used to make gl_FragCoord available
  65934. */
  65935. export class FragCoordBlock extends NodeMaterialBlock {
  65936. /**
  65937. * Creates a new FragCoordBlock
  65938. * @param name defines the block name
  65939. */
  65940. constructor(name: string);
  65941. /**
  65942. * Gets the current class name
  65943. * @returns the class name
  65944. */
  65945. getClassName(): string;
  65946. /**
  65947. * Gets the xy component
  65948. */
  65949. get xy(): NodeMaterialConnectionPoint;
  65950. /**
  65951. * Gets the xyz component
  65952. */
  65953. get xyz(): NodeMaterialConnectionPoint;
  65954. /**
  65955. * Gets the xyzw component
  65956. */
  65957. get xyzw(): NodeMaterialConnectionPoint;
  65958. /**
  65959. * Gets the x component
  65960. */
  65961. get x(): NodeMaterialConnectionPoint;
  65962. /**
  65963. * Gets the y component
  65964. */
  65965. get y(): NodeMaterialConnectionPoint;
  65966. /**
  65967. * Gets the z component
  65968. */
  65969. get z(): NodeMaterialConnectionPoint;
  65970. /**
  65971. * Gets the w component
  65972. */
  65973. get output(): NodeMaterialConnectionPoint;
  65974. protected writeOutputs(state: NodeMaterialBuildState): string;
  65975. protected _buildBlock(state: NodeMaterialBuildState): this;
  65976. }
  65977. }
  65978. declare module "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock" {
  65979. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65980. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65981. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65982. import { Effect } from "babylonjs/Materials/effect";
  65983. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65984. import { Mesh } from "babylonjs/Meshes/mesh";
  65985. /**
  65986. * Block used to get the screen sizes
  65987. */
  65988. export class ScreenSizeBlock extends NodeMaterialBlock {
  65989. private _varName;
  65990. private _scene;
  65991. /**
  65992. * Creates a new ScreenSizeBlock
  65993. * @param name defines the block name
  65994. */
  65995. constructor(name: string);
  65996. /**
  65997. * Gets the current class name
  65998. * @returns the class name
  65999. */
  66000. getClassName(): string;
  66001. /**
  66002. * Gets the xy component
  66003. */
  66004. get xy(): NodeMaterialConnectionPoint;
  66005. /**
  66006. * Gets the x component
  66007. */
  66008. get x(): NodeMaterialConnectionPoint;
  66009. /**
  66010. * Gets the y component
  66011. */
  66012. get y(): NodeMaterialConnectionPoint;
  66013. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  66014. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  66015. protected _buildBlock(state: NodeMaterialBuildState): this;
  66016. }
  66017. }
  66018. declare module "babylonjs/Materials/Node/Blocks/Fragment/index" {
  66019. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock";
  66020. export * from "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock";
  66021. export * from "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock";
  66022. export * from "babylonjs/Materials/Node/Blocks/Fragment/discardBlock";
  66023. export * from "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock";
  66024. export * from "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock";
  66025. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock";
  66026. export * from "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock";
  66027. }
  66028. declare module "babylonjs/Materials/Node/Blocks/Dual/fogBlock" {
  66029. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66030. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66031. import { Mesh } from "babylonjs/Meshes/mesh";
  66032. import { Effect } from "babylonjs/Materials/effect";
  66033. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66034. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66035. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66036. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  66037. /**
  66038. * Block used to add support for scene fog
  66039. */
  66040. export class FogBlock extends NodeMaterialBlock {
  66041. private _fogDistanceName;
  66042. private _fogParameters;
  66043. /**
  66044. * Create a new FogBlock
  66045. * @param name defines the block name
  66046. */
  66047. constructor(name: string);
  66048. /**
  66049. * Gets the current class name
  66050. * @returns the class name
  66051. */
  66052. getClassName(): string;
  66053. /**
  66054. * Gets the world position input component
  66055. */
  66056. get worldPosition(): NodeMaterialConnectionPoint;
  66057. /**
  66058. * Gets the view input component
  66059. */
  66060. get view(): NodeMaterialConnectionPoint;
  66061. /**
  66062. * Gets the color input component
  66063. */
  66064. get input(): NodeMaterialConnectionPoint;
  66065. /**
  66066. * Gets the fog color input component
  66067. */
  66068. get fogColor(): NodeMaterialConnectionPoint;
  66069. /**
  66070. * Gets the output component
  66071. */
  66072. get output(): NodeMaterialConnectionPoint;
  66073. autoConfigure(material: NodeMaterial): void;
  66074. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  66075. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  66076. protected _buildBlock(state: NodeMaterialBuildState): this;
  66077. }
  66078. }
  66079. declare module "babylonjs/Materials/Node/Blocks/Dual/lightBlock" {
  66080. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66081. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66082. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66083. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66084. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66085. import { Effect } from "babylonjs/Materials/effect";
  66086. import { Mesh } from "babylonjs/Meshes/mesh";
  66087. import { Light } from "babylonjs/Lights/light";
  66088. import { Nullable } from "babylonjs/types";
  66089. import { Scene } from "babylonjs/scene";
  66090. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  66091. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  66092. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  66093. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  66094. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  66095. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  66096. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  66097. /**
  66098. * Block used to add light in the fragment shader
  66099. */
  66100. export class LightBlock extends NodeMaterialBlock {
  66101. private _lightId;
  66102. /**
  66103. * Gets or sets the light associated with this block
  66104. */
  66105. light: Nullable<Light>;
  66106. /**
  66107. * Create a new LightBlock
  66108. * @param name defines the block name
  66109. */
  66110. constructor(name: string);
  66111. /**
  66112. * Gets the current class name
  66113. * @returns the class name
  66114. */
  66115. getClassName(): string;
  66116. /**
  66117. * Gets the world position input component
  66118. */
  66119. get worldPosition(): NodeMaterialConnectionPoint;
  66120. /**
  66121. * Gets the world normal input component
  66122. */
  66123. get worldNormal(): NodeMaterialConnectionPoint;
  66124. /**
  66125. * Gets the camera (or eye) position component
  66126. */
  66127. get cameraPosition(): NodeMaterialConnectionPoint;
  66128. /**
  66129. * Gets the glossiness component
  66130. */
  66131. get glossiness(): NodeMaterialConnectionPoint;
  66132. /**
  66133. * Gets the glossinness power component
  66134. */
  66135. get glossPower(): NodeMaterialConnectionPoint;
  66136. /**
  66137. * Gets the diffuse color component
  66138. */
  66139. get diffuseColor(): NodeMaterialConnectionPoint;
  66140. /**
  66141. * Gets the specular color component
  66142. */
  66143. get specularColor(): NodeMaterialConnectionPoint;
  66144. /**
  66145. * Gets the diffuse output component
  66146. */
  66147. get diffuseOutput(): NodeMaterialConnectionPoint;
  66148. /**
  66149. * Gets the specular output component
  66150. */
  66151. get specularOutput(): NodeMaterialConnectionPoint;
  66152. /**
  66153. * Gets the shadow output component
  66154. */
  66155. get shadow(): NodeMaterialConnectionPoint;
  66156. autoConfigure(material: NodeMaterial): void;
  66157. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  66158. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  66159. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  66160. private _injectVertexCode;
  66161. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  66162. serialize(): any;
  66163. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66164. }
  66165. }
  66166. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock" {
  66167. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66168. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66169. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66170. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  66171. /**
  66172. * Block used to read a reflection texture from a sampler
  66173. */
  66174. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  66175. /**
  66176. * Create a new ReflectionTextureBlock
  66177. * @param name defines the block name
  66178. */
  66179. constructor(name: string);
  66180. /**
  66181. * Gets the current class name
  66182. * @returns the class name
  66183. */
  66184. getClassName(): string;
  66185. /**
  66186. * Gets the world position input component
  66187. */
  66188. get position(): NodeMaterialConnectionPoint;
  66189. /**
  66190. * Gets the world position input component
  66191. */
  66192. get worldPosition(): NodeMaterialConnectionPoint;
  66193. /**
  66194. * Gets the world normal input component
  66195. */
  66196. get worldNormal(): NodeMaterialConnectionPoint;
  66197. /**
  66198. * Gets the world input component
  66199. */
  66200. get world(): NodeMaterialConnectionPoint;
  66201. /**
  66202. * Gets the camera (or eye) position component
  66203. */
  66204. get cameraPosition(): NodeMaterialConnectionPoint;
  66205. /**
  66206. * Gets the view input component
  66207. */
  66208. get view(): NodeMaterialConnectionPoint;
  66209. /**
  66210. * Gets the rgb output component
  66211. */
  66212. get rgb(): NodeMaterialConnectionPoint;
  66213. /**
  66214. * Gets the rgba output component
  66215. */
  66216. get rgba(): NodeMaterialConnectionPoint;
  66217. /**
  66218. * Gets the r output component
  66219. */
  66220. get r(): NodeMaterialConnectionPoint;
  66221. /**
  66222. * Gets the g output component
  66223. */
  66224. get g(): NodeMaterialConnectionPoint;
  66225. /**
  66226. * Gets the b output component
  66227. */
  66228. get b(): NodeMaterialConnectionPoint;
  66229. /**
  66230. * Gets the a output component
  66231. */
  66232. get a(): NodeMaterialConnectionPoint;
  66233. autoConfigure(material: NodeMaterial): void;
  66234. protected _buildBlock(state: NodeMaterialBuildState): this;
  66235. }
  66236. }
  66237. declare module "babylonjs/Materials/Node/Blocks/Dual/index" {
  66238. export * from "babylonjs/Materials/Node/Blocks/Dual/fogBlock";
  66239. export * from "babylonjs/Materials/Node/Blocks/Dual/lightBlock";
  66240. export * from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  66241. export * from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  66242. export * from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  66243. }
  66244. declare module "babylonjs/Materials/Node/Blocks/Input/index" {
  66245. export * from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  66246. export * from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  66247. }
  66248. declare module "babylonjs/Materials/Node/Blocks/addBlock" {
  66249. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66250. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66251. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66252. /**
  66253. * Block used to add 2 vectors
  66254. */
  66255. export class AddBlock extends NodeMaterialBlock {
  66256. /**
  66257. * Creates a new AddBlock
  66258. * @param name defines the block name
  66259. */
  66260. constructor(name: string);
  66261. /**
  66262. * Gets the current class name
  66263. * @returns the class name
  66264. */
  66265. getClassName(): string;
  66266. /**
  66267. * Gets the left operand input component
  66268. */
  66269. get left(): NodeMaterialConnectionPoint;
  66270. /**
  66271. * Gets the right operand input component
  66272. */
  66273. get right(): NodeMaterialConnectionPoint;
  66274. /**
  66275. * Gets the output component
  66276. */
  66277. get output(): NodeMaterialConnectionPoint;
  66278. protected _buildBlock(state: NodeMaterialBuildState): this;
  66279. }
  66280. }
  66281. declare module "babylonjs/Materials/Node/Blocks/scaleBlock" {
  66282. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66283. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66284. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66285. /**
  66286. * Block used to scale a vector by a float
  66287. */
  66288. export class ScaleBlock extends NodeMaterialBlock {
  66289. /**
  66290. * Creates a new ScaleBlock
  66291. * @param name defines the block name
  66292. */
  66293. constructor(name: string);
  66294. /**
  66295. * Gets the current class name
  66296. * @returns the class name
  66297. */
  66298. getClassName(): string;
  66299. /**
  66300. * Gets the input component
  66301. */
  66302. get input(): NodeMaterialConnectionPoint;
  66303. /**
  66304. * Gets the factor input component
  66305. */
  66306. get factor(): NodeMaterialConnectionPoint;
  66307. /**
  66308. * Gets the output component
  66309. */
  66310. get output(): NodeMaterialConnectionPoint;
  66311. protected _buildBlock(state: NodeMaterialBuildState): this;
  66312. }
  66313. }
  66314. declare module "babylonjs/Materials/Node/Blocks/clampBlock" {
  66315. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66316. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66317. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66318. import { Scene } from "babylonjs/scene";
  66319. /**
  66320. * Block used to clamp a float
  66321. */
  66322. export class ClampBlock extends NodeMaterialBlock {
  66323. /** Gets or sets the minimum range */
  66324. minimum: number;
  66325. /** Gets or sets the maximum range */
  66326. maximum: number;
  66327. /**
  66328. * Creates a new ClampBlock
  66329. * @param name defines the block name
  66330. */
  66331. constructor(name: string);
  66332. /**
  66333. * Gets the current class name
  66334. * @returns the class name
  66335. */
  66336. getClassName(): string;
  66337. /**
  66338. * Gets the value input component
  66339. */
  66340. get value(): NodeMaterialConnectionPoint;
  66341. /**
  66342. * Gets the output component
  66343. */
  66344. get output(): NodeMaterialConnectionPoint;
  66345. protected _buildBlock(state: NodeMaterialBuildState): this;
  66346. protected _dumpPropertiesCode(): string;
  66347. serialize(): any;
  66348. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66349. }
  66350. }
  66351. declare module "babylonjs/Materials/Node/Blocks/crossBlock" {
  66352. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66353. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66354. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66355. /**
  66356. * Block used to apply a cross product between 2 vectors
  66357. */
  66358. export class CrossBlock extends NodeMaterialBlock {
  66359. /**
  66360. * Creates a new CrossBlock
  66361. * @param name defines the block name
  66362. */
  66363. constructor(name: string);
  66364. /**
  66365. * Gets the current class name
  66366. * @returns the class name
  66367. */
  66368. getClassName(): string;
  66369. /**
  66370. * Gets the left operand input component
  66371. */
  66372. get left(): NodeMaterialConnectionPoint;
  66373. /**
  66374. * Gets the right operand input component
  66375. */
  66376. get right(): NodeMaterialConnectionPoint;
  66377. /**
  66378. * Gets the output component
  66379. */
  66380. get output(): NodeMaterialConnectionPoint;
  66381. protected _buildBlock(state: NodeMaterialBuildState): this;
  66382. }
  66383. }
  66384. declare module "babylonjs/Materials/Node/Blocks/dotBlock" {
  66385. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66386. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66387. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66388. /**
  66389. * Block used to apply a dot product between 2 vectors
  66390. */
  66391. export class DotBlock extends NodeMaterialBlock {
  66392. /**
  66393. * Creates a new DotBlock
  66394. * @param name defines the block name
  66395. */
  66396. constructor(name: string);
  66397. /**
  66398. * Gets the current class name
  66399. * @returns the class name
  66400. */
  66401. getClassName(): string;
  66402. /**
  66403. * Gets the left operand input component
  66404. */
  66405. get left(): NodeMaterialConnectionPoint;
  66406. /**
  66407. * Gets the right operand input component
  66408. */
  66409. get right(): NodeMaterialConnectionPoint;
  66410. /**
  66411. * Gets the output component
  66412. */
  66413. get output(): NodeMaterialConnectionPoint;
  66414. protected _buildBlock(state: NodeMaterialBuildState): this;
  66415. }
  66416. }
  66417. declare module "babylonjs/Materials/Node/Blocks/normalizeBlock" {
  66418. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66419. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66420. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66421. /**
  66422. * Block used to normalize a vector
  66423. */
  66424. export class NormalizeBlock extends NodeMaterialBlock {
  66425. /**
  66426. * Creates a new NormalizeBlock
  66427. * @param name defines the block name
  66428. */
  66429. constructor(name: string);
  66430. /**
  66431. * Gets the current class name
  66432. * @returns the class name
  66433. */
  66434. getClassName(): string;
  66435. /**
  66436. * Gets the input component
  66437. */
  66438. get input(): NodeMaterialConnectionPoint;
  66439. /**
  66440. * Gets the output component
  66441. */
  66442. get output(): NodeMaterialConnectionPoint;
  66443. protected _buildBlock(state: NodeMaterialBuildState): this;
  66444. }
  66445. }
  66446. declare module "babylonjs/Materials/Node/Blocks/colorMergerBlock" {
  66447. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66448. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66449. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66450. /**
  66451. * Block used to create a Color3/4 out of individual inputs (one for each component)
  66452. */
  66453. export class ColorMergerBlock extends NodeMaterialBlock {
  66454. /**
  66455. * Create a new ColorMergerBlock
  66456. * @param name defines the block name
  66457. */
  66458. constructor(name: string);
  66459. /**
  66460. * Gets the current class name
  66461. * @returns the class name
  66462. */
  66463. getClassName(): string;
  66464. /**
  66465. * Gets the rgb component (input)
  66466. */
  66467. get rgbIn(): NodeMaterialConnectionPoint;
  66468. /**
  66469. * Gets the r component (input)
  66470. */
  66471. get r(): NodeMaterialConnectionPoint;
  66472. /**
  66473. * Gets the g component (input)
  66474. */
  66475. get g(): NodeMaterialConnectionPoint;
  66476. /**
  66477. * Gets the b component (input)
  66478. */
  66479. get b(): NodeMaterialConnectionPoint;
  66480. /**
  66481. * Gets the a component (input)
  66482. */
  66483. get a(): NodeMaterialConnectionPoint;
  66484. /**
  66485. * Gets the rgba component (output)
  66486. */
  66487. get rgba(): NodeMaterialConnectionPoint;
  66488. /**
  66489. * Gets the rgb component (output)
  66490. */
  66491. get rgbOut(): NodeMaterialConnectionPoint;
  66492. /**
  66493. * Gets the rgb component (output)
  66494. * @deprecated Please use rgbOut instead.
  66495. */
  66496. get rgb(): NodeMaterialConnectionPoint;
  66497. protected _buildBlock(state: NodeMaterialBuildState): this;
  66498. }
  66499. }
  66500. declare module "babylonjs/Materials/Node/Blocks/vectorSplitterBlock" {
  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 expand a Vector3/4 into 4 outputs (one for each component)
  66506. */
  66507. export class VectorSplitterBlock extends NodeMaterialBlock {
  66508. /**
  66509. * Create a new VectorSplitterBlock
  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 xyzw component (input)
  66520. */
  66521. get xyzw(): NodeMaterialConnectionPoint;
  66522. /**
  66523. * Gets the xyz component (input)
  66524. */
  66525. get xyzIn(): NodeMaterialConnectionPoint;
  66526. /**
  66527. * Gets the xy component (input)
  66528. */
  66529. get xyIn(): NodeMaterialConnectionPoint;
  66530. /**
  66531. * Gets the xyz component (output)
  66532. */
  66533. get xyzOut(): NodeMaterialConnectionPoint;
  66534. /**
  66535. * Gets the xy component (output)
  66536. */
  66537. get xyOut(): NodeMaterialConnectionPoint;
  66538. /**
  66539. * Gets the x component (output)
  66540. */
  66541. get x(): NodeMaterialConnectionPoint;
  66542. /**
  66543. * Gets the y component (output)
  66544. */
  66545. get y(): NodeMaterialConnectionPoint;
  66546. /**
  66547. * Gets the z component (output)
  66548. */
  66549. get z(): NodeMaterialConnectionPoint;
  66550. /**
  66551. * Gets the w component (output)
  66552. */
  66553. get w(): NodeMaterialConnectionPoint;
  66554. protected _inputRename(name: string): string;
  66555. protected _outputRename(name: string): string;
  66556. protected _buildBlock(state: NodeMaterialBuildState): this;
  66557. }
  66558. }
  66559. declare module "babylonjs/Materials/Node/Blocks/lerpBlock" {
  66560. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66561. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66562. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66563. /**
  66564. * Block used to lerp between 2 values
  66565. */
  66566. export class LerpBlock extends NodeMaterialBlock {
  66567. /**
  66568. * Creates a new LerpBlock
  66569. * @param name defines the block name
  66570. */
  66571. constructor(name: string);
  66572. /**
  66573. * Gets the current class name
  66574. * @returns the class name
  66575. */
  66576. getClassName(): string;
  66577. /**
  66578. * Gets the left operand input component
  66579. */
  66580. get left(): NodeMaterialConnectionPoint;
  66581. /**
  66582. * Gets the right operand input component
  66583. */
  66584. get right(): NodeMaterialConnectionPoint;
  66585. /**
  66586. * Gets the gradient operand input component
  66587. */
  66588. get gradient(): NodeMaterialConnectionPoint;
  66589. /**
  66590. * Gets the output component
  66591. */
  66592. get output(): NodeMaterialConnectionPoint;
  66593. protected _buildBlock(state: NodeMaterialBuildState): this;
  66594. }
  66595. }
  66596. declare module "babylonjs/Materials/Node/Blocks/divideBlock" {
  66597. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66598. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66599. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66600. /**
  66601. * Block used to divide 2 vectors
  66602. */
  66603. export class DivideBlock extends NodeMaterialBlock {
  66604. /**
  66605. * Creates a new DivideBlock
  66606. * @param name defines the block name
  66607. */
  66608. constructor(name: string);
  66609. /**
  66610. * Gets the current class name
  66611. * @returns the class name
  66612. */
  66613. getClassName(): string;
  66614. /**
  66615. * Gets the left operand input component
  66616. */
  66617. get left(): NodeMaterialConnectionPoint;
  66618. /**
  66619. * Gets the right operand input component
  66620. */
  66621. get right(): NodeMaterialConnectionPoint;
  66622. /**
  66623. * Gets the output component
  66624. */
  66625. get output(): NodeMaterialConnectionPoint;
  66626. protected _buildBlock(state: NodeMaterialBuildState): this;
  66627. }
  66628. }
  66629. declare module "babylonjs/Materials/Node/Blocks/subtractBlock" {
  66630. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66631. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66632. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66633. /**
  66634. * Block used to subtract 2 vectors
  66635. */
  66636. export class SubtractBlock extends NodeMaterialBlock {
  66637. /**
  66638. * Creates a new SubtractBlock
  66639. * @param name defines the block name
  66640. */
  66641. constructor(name: string);
  66642. /**
  66643. * Gets the current class name
  66644. * @returns the class name
  66645. */
  66646. getClassName(): string;
  66647. /**
  66648. * Gets the left operand input component
  66649. */
  66650. get left(): NodeMaterialConnectionPoint;
  66651. /**
  66652. * Gets the right operand input component
  66653. */
  66654. get right(): NodeMaterialConnectionPoint;
  66655. /**
  66656. * Gets the output component
  66657. */
  66658. get output(): NodeMaterialConnectionPoint;
  66659. protected _buildBlock(state: NodeMaterialBuildState): this;
  66660. }
  66661. }
  66662. declare module "babylonjs/Materials/Node/Blocks/stepBlock" {
  66663. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66664. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66665. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66666. /**
  66667. * Block used to step a value
  66668. */
  66669. export class StepBlock extends NodeMaterialBlock {
  66670. /**
  66671. * Creates a new StepBlock
  66672. * @param name defines the block name
  66673. */
  66674. constructor(name: string);
  66675. /**
  66676. * Gets the current class name
  66677. * @returns the class name
  66678. */
  66679. getClassName(): string;
  66680. /**
  66681. * Gets the value operand input component
  66682. */
  66683. get value(): NodeMaterialConnectionPoint;
  66684. /**
  66685. * Gets the edge operand input component
  66686. */
  66687. get edge(): NodeMaterialConnectionPoint;
  66688. /**
  66689. * Gets the output component
  66690. */
  66691. get output(): NodeMaterialConnectionPoint;
  66692. protected _buildBlock(state: NodeMaterialBuildState): this;
  66693. }
  66694. }
  66695. declare module "babylonjs/Materials/Node/Blocks/oneMinusBlock" {
  66696. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66697. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66698. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66699. /**
  66700. * Block used to get the opposite (1 - x) of a value
  66701. */
  66702. export class OneMinusBlock extends NodeMaterialBlock {
  66703. /**
  66704. * Creates a new OneMinusBlock
  66705. * @param name defines the block name
  66706. */
  66707. constructor(name: string);
  66708. /**
  66709. * Gets the current class name
  66710. * @returns the class name
  66711. */
  66712. getClassName(): string;
  66713. /**
  66714. * Gets the input component
  66715. */
  66716. get input(): NodeMaterialConnectionPoint;
  66717. /**
  66718. * Gets the output component
  66719. */
  66720. get output(): NodeMaterialConnectionPoint;
  66721. protected _buildBlock(state: NodeMaterialBuildState): this;
  66722. }
  66723. }
  66724. declare module "babylonjs/Materials/Node/Blocks/viewDirectionBlock" {
  66725. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66726. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66727. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66728. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66729. /**
  66730. * Block used to get the view direction
  66731. */
  66732. export class ViewDirectionBlock extends NodeMaterialBlock {
  66733. /**
  66734. * Creates a new ViewDirectionBlock
  66735. * @param name defines the block name
  66736. */
  66737. constructor(name: string);
  66738. /**
  66739. * Gets the current class name
  66740. * @returns the class name
  66741. */
  66742. getClassName(): string;
  66743. /**
  66744. * Gets the world position component
  66745. */
  66746. get worldPosition(): NodeMaterialConnectionPoint;
  66747. /**
  66748. * Gets the camera position component
  66749. */
  66750. get cameraPosition(): NodeMaterialConnectionPoint;
  66751. /**
  66752. * Gets the output component
  66753. */
  66754. get output(): NodeMaterialConnectionPoint;
  66755. autoConfigure(material: NodeMaterial): void;
  66756. protected _buildBlock(state: NodeMaterialBuildState): this;
  66757. }
  66758. }
  66759. declare module "babylonjs/Materials/Node/Blocks/fresnelBlock" {
  66760. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66761. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66762. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66763. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66764. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  66765. /**
  66766. * Block used to compute fresnel value
  66767. */
  66768. export class FresnelBlock extends NodeMaterialBlock {
  66769. /**
  66770. * Create a new FresnelBlock
  66771. * @param name defines the block name
  66772. */
  66773. constructor(name: string);
  66774. /**
  66775. * Gets the current class name
  66776. * @returns the class name
  66777. */
  66778. getClassName(): string;
  66779. /**
  66780. * Gets the world normal input component
  66781. */
  66782. get worldNormal(): NodeMaterialConnectionPoint;
  66783. /**
  66784. * Gets the view direction input component
  66785. */
  66786. get viewDirection(): NodeMaterialConnectionPoint;
  66787. /**
  66788. * Gets the bias input component
  66789. */
  66790. get bias(): NodeMaterialConnectionPoint;
  66791. /**
  66792. * Gets the camera (or eye) position component
  66793. */
  66794. get power(): NodeMaterialConnectionPoint;
  66795. /**
  66796. * Gets the fresnel output component
  66797. */
  66798. get fresnel(): NodeMaterialConnectionPoint;
  66799. autoConfigure(material: NodeMaterial): void;
  66800. protected _buildBlock(state: NodeMaterialBuildState): this;
  66801. }
  66802. }
  66803. declare module "babylonjs/Materials/Node/Blocks/maxBlock" {
  66804. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66805. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66806. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66807. /**
  66808. * Block used to get the max of 2 values
  66809. */
  66810. export class MaxBlock extends NodeMaterialBlock {
  66811. /**
  66812. * Creates a new MaxBlock
  66813. * @param name defines the block name
  66814. */
  66815. constructor(name: string);
  66816. /**
  66817. * Gets the current class name
  66818. * @returns the class name
  66819. */
  66820. getClassName(): string;
  66821. /**
  66822. * Gets the left operand input component
  66823. */
  66824. get left(): NodeMaterialConnectionPoint;
  66825. /**
  66826. * Gets the right operand input component
  66827. */
  66828. get right(): NodeMaterialConnectionPoint;
  66829. /**
  66830. * Gets the output component
  66831. */
  66832. get output(): NodeMaterialConnectionPoint;
  66833. protected _buildBlock(state: NodeMaterialBuildState): this;
  66834. }
  66835. }
  66836. declare module "babylonjs/Materials/Node/Blocks/minBlock" {
  66837. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66838. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66839. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66840. /**
  66841. * Block used to get the min of 2 values
  66842. */
  66843. export class MinBlock extends NodeMaterialBlock {
  66844. /**
  66845. * Creates a new MinBlock
  66846. * @param name defines the block name
  66847. */
  66848. constructor(name: string);
  66849. /**
  66850. * Gets the current class name
  66851. * @returns the class name
  66852. */
  66853. getClassName(): string;
  66854. /**
  66855. * Gets the left operand input component
  66856. */
  66857. get left(): NodeMaterialConnectionPoint;
  66858. /**
  66859. * Gets the right operand input component
  66860. */
  66861. get right(): NodeMaterialConnectionPoint;
  66862. /**
  66863. * Gets the output component
  66864. */
  66865. get output(): NodeMaterialConnectionPoint;
  66866. protected _buildBlock(state: NodeMaterialBuildState): this;
  66867. }
  66868. }
  66869. declare module "babylonjs/Materials/Node/Blocks/distanceBlock" {
  66870. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66871. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66872. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66873. /**
  66874. * Block used to get the distance between 2 values
  66875. */
  66876. export class DistanceBlock extends NodeMaterialBlock {
  66877. /**
  66878. * Creates a new DistanceBlock
  66879. * @param name defines the block name
  66880. */
  66881. constructor(name: string);
  66882. /**
  66883. * Gets the current class name
  66884. * @returns the class name
  66885. */
  66886. getClassName(): string;
  66887. /**
  66888. * Gets the left operand input component
  66889. */
  66890. get left(): NodeMaterialConnectionPoint;
  66891. /**
  66892. * Gets the right operand input component
  66893. */
  66894. get right(): NodeMaterialConnectionPoint;
  66895. /**
  66896. * Gets the output component
  66897. */
  66898. get output(): NodeMaterialConnectionPoint;
  66899. protected _buildBlock(state: NodeMaterialBuildState): this;
  66900. }
  66901. }
  66902. declare module "babylonjs/Materials/Node/Blocks/lengthBlock" {
  66903. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66904. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66905. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66906. /**
  66907. * Block used to get the length of a vector
  66908. */
  66909. export class LengthBlock extends NodeMaterialBlock {
  66910. /**
  66911. * Creates a new LengthBlock
  66912. * @param name defines the block name
  66913. */
  66914. constructor(name: string);
  66915. /**
  66916. * Gets the current class name
  66917. * @returns the class name
  66918. */
  66919. getClassName(): string;
  66920. /**
  66921. * Gets the value input component
  66922. */
  66923. get value(): NodeMaterialConnectionPoint;
  66924. /**
  66925. * Gets the output component
  66926. */
  66927. get output(): NodeMaterialConnectionPoint;
  66928. protected _buildBlock(state: NodeMaterialBuildState): this;
  66929. }
  66930. }
  66931. declare module "babylonjs/Materials/Node/Blocks/negateBlock" {
  66932. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66933. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66934. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66935. /**
  66936. * Block used to get negative version of a value (i.e. x * -1)
  66937. */
  66938. export class NegateBlock extends NodeMaterialBlock {
  66939. /**
  66940. * Creates a new NegateBlock
  66941. * @param name defines the block name
  66942. */
  66943. constructor(name: string);
  66944. /**
  66945. * Gets the current class name
  66946. * @returns the class name
  66947. */
  66948. getClassName(): string;
  66949. /**
  66950. * Gets the value input component
  66951. */
  66952. get value(): NodeMaterialConnectionPoint;
  66953. /**
  66954. * Gets the output component
  66955. */
  66956. get output(): NodeMaterialConnectionPoint;
  66957. protected _buildBlock(state: NodeMaterialBuildState): this;
  66958. }
  66959. }
  66960. declare module "babylonjs/Materials/Node/Blocks/powBlock" {
  66961. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66962. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66963. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66964. /**
  66965. * Block used to get the value of the first parameter raised to the power of the second
  66966. */
  66967. export class PowBlock extends NodeMaterialBlock {
  66968. /**
  66969. * Creates a new PowBlock
  66970. * @param name defines the block name
  66971. */
  66972. constructor(name: string);
  66973. /**
  66974. * Gets the current class name
  66975. * @returns the class name
  66976. */
  66977. getClassName(): string;
  66978. /**
  66979. * Gets the value operand input component
  66980. */
  66981. get value(): NodeMaterialConnectionPoint;
  66982. /**
  66983. * Gets the power operand input component
  66984. */
  66985. get power(): NodeMaterialConnectionPoint;
  66986. /**
  66987. * Gets the output component
  66988. */
  66989. get output(): NodeMaterialConnectionPoint;
  66990. protected _buildBlock(state: NodeMaterialBuildState): this;
  66991. }
  66992. }
  66993. declare module "babylonjs/Materials/Node/Blocks/randomNumberBlock" {
  66994. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66995. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66996. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66997. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  66998. /**
  66999. * Block used to get a random number
  67000. */
  67001. export class RandomNumberBlock extends NodeMaterialBlock {
  67002. /**
  67003. * Creates a new RandomNumberBlock
  67004. * @param name defines the block name
  67005. */
  67006. constructor(name: string);
  67007. /**
  67008. * Gets the current class name
  67009. * @returns the class name
  67010. */
  67011. getClassName(): string;
  67012. /**
  67013. * Gets the seed input component
  67014. */
  67015. get seed(): NodeMaterialConnectionPoint;
  67016. /**
  67017. * Gets the output component
  67018. */
  67019. get output(): NodeMaterialConnectionPoint;
  67020. protected _buildBlock(state: NodeMaterialBuildState): this;
  67021. }
  67022. }
  67023. declare module "babylonjs/Materials/Node/Blocks/arcTan2Block" {
  67024. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67025. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67026. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67027. /**
  67028. * Block used to compute arc tangent of 2 values
  67029. */
  67030. export class ArcTan2Block extends NodeMaterialBlock {
  67031. /**
  67032. * Creates a new ArcTan2Block
  67033. * @param name defines the block name
  67034. */
  67035. constructor(name: string);
  67036. /**
  67037. * Gets the current class name
  67038. * @returns the class name
  67039. */
  67040. getClassName(): string;
  67041. /**
  67042. * Gets the x operand input component
  67043. */
  67044. get x(): NodeMaterialConnectionPoint;
  67045. /**
  67046. * Gets the y operand input component
  67047. */
  67048. get y(): NodeMaterialConnectionPoint;
  67049. /**
  67050. * Gets the output component
  67051. */
  67052. get output(): NodeMaterialConnectionPoint;
  67053. protected _buildBlock(state: NodeMaterialBuildState): this;
  67054. }
  67055. }
  67056. declare module "babylonjs/Materials/Node/Blocks/smoothStepBlock" {
  67057. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67058. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67059. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67060. /**
  67061. * Block used to smooth step a value
  67062. */
  67063. export class SmoothStepBlock extends NodeMaterialBlock {
  67064. /**
  67065. * Creates a new SmoothStepBlock
  67066. * @param name defines the block name
  67067. */
  67068. constructor(name: string);
  67069. /**
  67070. * Gets the current class name
  67071. * @returns the class name
  67072. */
  67073. getClassName(): string;
  67074. /**
  67075. * Gets the value operand input component
  67076. */
  67077. get value(): NodeMaterialConnectionPoint;
  67078. /**
  67079. * Gets the first edge operand input component
  67080. */
  67081. get edge0(): NodeMaterialConnectionPoint;
  67082. /**
  67083. * Gets the second edge operand input component
  67084. */
  67085. get edge1(): NodeMaterialConnectionPoint;
  67086. /**
  67087. * Gets the output component
  67088. */
  67089. get output(): NodeMaterialConnectionPoint;
  67090. protected _buildBlock(state: NodeMaterialBuildState): this;
  67091. }
  67092. }
  67093. declare module "babylonjs/Materials/Node/Blocks/reciprocalBlock" {
  67094. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67095. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67096. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67097. /**
  67098. * Block used to get the reciprocal (1 / x) of a value
  67099. */
  67100. export class ReciprocalBlock extends NodeMaterialBlock {
  67101. /**
  67102. * Creates a new ReciprocalBlock
  67103. * @param name defines the block name
  67104. */
  67105. constructor(name: string);
  67106. /**
  67107. * Gets the current class name
  67108. * @returns the class name
  67109. */
  67110. getClassName(): string;
  67111. /**
  67112. * Gets the input component
  67113. */
  67114. get input(): NodeMaterialConnectionPoint;
  67115. /**
  67116. * Gets the output component
  67117. */
  67118. get output(): NodeMaterialConnectionPoint;
  67119. protected _buildBlock(state: NodeMaterialBuildState): this;
  67120. }
  67121. }
  67122. declare module "babylonjs/Materials/Node/Blocks/replaceColorBlock" {
  67123. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67124. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67125. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67126. /**
  67127. * Block used to replace a color by another one
  67128. */
  67129. export class ReplaceColorBlock extends NodeMaterialBlock {
  67130. /**
  67131. * Creates a new ReplaceColorBlock
  67132. * @param name defines the block name
  67133. */
  67134. constructor(name: string);
  67135. /**
  67136. * Gets the current class name
  67137. * @returns the class name
  67138. */
  67139. getClassName(): string;
  67140. /**
  67141. * Gets the value input component
  67142. */
  67143. get value(): NodeMaterialConnectionPoint;
  67144. /**
  67145. * Gets the reference input component
  67146. */
  67147. get reference(): NodeMaterialConnectionPoint;
  67148. /**
  67149. * Gets the distance input component
  67150. */
  67151. get distance(): NodeMaterialConnectionPoint;
  67152. /**
  67153. * Gets the replacement input component
  67154. */
  67155. get replacement(): NodeMaterialConnectionPoint;
  67156. /**
  67157. * Gets the output component
  67158. */
  67159. get output(): NodeMaterialConnectionPoint;
  67160. protected _buildBlock(state: NodeMaterialBuildState): this;
  67161. }
  67162. }
  67163. declare module "babylonjs/Materials/Node/Blocks/posterizeBlock" {
  67164. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67165. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67166. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67167. /**
  67168. * Block used to posterize a value
  67169. * @see https://en.wikipedia.org/wiki/Posterization
  67170. */
  67171. export class PosterizeBlock extends NodeMaterialBlock {
  67172. /**
  67173. * Creates a new PosterizeBlock
  67174. * @param name defines the block name
  67175. */
  67176. constructor(name: string);
  67177. /**
  67178. * Gets the current class name
  67179. * @returns the class name
  67180. */
  67181. getClassName(): string;
  67182. /**
  67183. * Gets the value input component
  67184. */
  67185. get value(): NodeMaterialConnectionPoint;
  67186. /**
  67187. * Gets the steps input component
  67188. */
  67189. get steps(): NodeMaterialConnectionPoint;
  67190. /**
  67191. * Gets the output component
  67192. */
  67193. get output(): NodeMaterialConnectionPoint;
  67194. protected _buildBlock(state: NodeMaterialBuildState): this;
  67195. }
  67196. }
  67197. declare module "babylonjs/Materials/Node/Blocks/waveBlock" {
  67198. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67199. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67200. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67201. import { Scene } from "babylonjs/scene";
  67202. /**
  67203. * Operations supported by the Wave block
  67204. */
  67205. export enum WaveBlockKind {
  67206. /** SawTooth */
  67207. SawTooth = 0,
  67208. /** Square */
  67209. Square = 1,
  67210. /** Triangle */
  67211. Triangle = 2
  67212. }
  67213. /**
  67214. * Block used to apply wave operation to floats
  67215. */
  67216. export class WaveBlock extends NodeMaterialBlock {
  67217. /**
  67218. * Gets or sets the kibnd of wave to be applied by the block
  67219. */
  67220. kind: WaveBlockKind;
  67221. /**
  67222. * Creates a new WaveBlock
  67223. * @param name defines the block name
  67224. */
  67225. constructor(name: string);
  67226. /**
  67227. * Gets the current class name
  67228. * @returns the class name
  67229. */
  67230. getClassName(): string;
  67231. /**
  67232. * Gets the input component
  67233. */
  67234. get input(): NodeMaterialConnectionPoint;
  67235. /**
  67236. * Gets the output component
  67237. */
  67238. get output(): NodeMaterialConnectionPoint;
  67239. protected _buildBlock(state: NodeMaterialBuildState): this;
  67240. serialize(): any;
  67241. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67242. }
  67243. }
  67244. declare module "babylonjs/Materials/Node/Blocks/gradientBlock" {
  67245. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67246. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67247. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67248. import { Color3 } from "babylonjs/Maths/math.color";
  67249. import { Scene } from "babylonjs/scene";
  67250. import { Observable } from "babylonjs/Misc/observable";
  67251. /**
  67252. * Class used to store a color step for the GradientBlock
  67253. */
  67254. export class GradientBlockColorStep {
  67255. private _step;
  67256. /**
  67257. * Gets value indicating which step this color is associated with (between 0 and 1)
  67258. */
  67259. get step(): number;
  67260. /**
  67261. * Sets a value indicating which step this color is associated with (between 0 and 1)
  67262. */
  67263. set step(val: number);
  67264. private _color;
  67265. /**
  67266. * Gets the color associated with this step
  67267. */
  67268. get color(): Color3;
  67269. /**
  67270. * Sets the color associated with this step
  67271. */
  67272. set color(val: Color3);
  67273. /**
  67274. * Creates a new GradientBlockColorStep
  67275. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  67276. * @param color defines the color associated with this step
  67277. */
  67278. constructor(step: number, color: Color3);
  67279. }
  67280. /**
  67281. * Block used to return a color from a gradient based on an input value between 0 and 1
  67282. */
  67283. export class GradientBlock extends NodeMaterialBlock {
  67284. /**
  67285. * Gets or sets the list of color steps
  67286. */
  67287. colorSteps: GradientBlockColorStep[];
  67288. /** Gets an observable raised when the value is changed */
  67289. onValueChangedObservable: Observable<GradientBlock>;
  67290. /** calls observable when the value is changed*/
  67291. colorStepsUpdated(): void;
  67292. /**
  67293. * Creates a new GradientBlock
  67294. * @param name defines the block name
  67295. */
  67296. constructor(name: string);
  67297. /**
  67298. * Gets the current class name
  67299. * @returns the class name
  67300. */
  67301. getClassName(): string;
  67302. /**
  67303. * Gets the gradient input component
  67304. */
  67305. get gradient(): NodeMaterialConnectionPoint;
  67306. /**
  67307. * Gets the output component
  67308. */
  67309. get output(): NodeMaterialConnectionPoint;
  67310. private _writeColorConstant;
  67311. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67312. serialize(): any;
  67313. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67314. protected _dumpPropertiesCode(): string;
  67315. }
  67316. }
  67317. declare module "babylonjs/Materials/Node/Blocks/nLerpBlock" {
  67318. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67319. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67320. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67321. /**
  67322. * Block used to normalize lerp between 2 values
  67323. */
  67324. export class NLerpBlock extends NodeMaterialBlock {
  67325. /**
  67326. * Creates a new NLerpBlock
  67327. * @param name defines the block name
  67328. */
  67329. constructor(name: string);
  67330. /**
  67331. * Gets the current class name
  67332. * @returns the class name
  67333. */
  67334. getClassName(): string;
  67335. /**
  67336. * Gets the left operand input component
  67337. */
  67338. get left(): NodeMaterialConnectionPoint;
  67339. /**
  67340. * Gets the right operand input component
  67341. */
  67342. get right(): NodeMaterialConnectionPoint;
  67343. /**
  67344. * Gets the gradient operand input component
  67345. */
  67346. get gradient(): 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/worleyNoise3DBlock" {
  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 { Scene } from "babylonjs/scene";
  67359. /**
  67360. * block used to Generate a Worley Noise 3D Noise Pattern
  67361. */
  67362. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  67363. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  67364. manhattanDistance: boolean;
  67365. /**
  67366. * Creates a new WorleyNoise3DBlock
  67367. * @param name defines the block name
  67368. */
  67369. constructor(name: string);
  67370. /**
  67371. * Gets the current class name
  67372. * @returns the class name
  67373. */
  67374. getClassName(): string;
  67375. /**
  67376. * Gets the seed input component
  67377. */
  67378. get seed(): NodeMaterialConnectionPoint;
  67379. /**
  67380. * Gets the jitter input component
  67381. */
  67382. get jitter(): NodeMaterialConnectionPoint;
  67383. /**
  67384. * Gets the output component
  67385. */
  67386. get output(): NodeMaterialConnectionPoint;
  67387. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67388. /**
  67389. * Exposes the properties to the UI?
  67390. */
  67391. protected _dumpPropertiesCode(): string;
  67392. /**
  67393. * Exposes the properties to the Seralize?
  67394. */
  67395. serialize(): any;
  67396. /**
  67397. * Exposes the properties to the deseralize?
  67398. */
  67399. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67400. }
  67401. }
  67402. declare module "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock" {
  67403. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67404. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67405. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67406. /**
  67407. * block used to Generate a Simplex Perlin 3d Noise Pattern
  67408. */
  67409. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  67410. /**
  67411. * Creates a new SimplexPerlin3DBlock
  67412. * @param name defines the block name
  67413. */
  67414. constructor(name: string);
  67415. /**
  67416. * Gets the current class name
  67417. * @returns the class name
  67418. */
  67419. getClassName(): string;
  67420. /**
  67421. * Gets the seed operand input component
  67422. */
  67423. get seed(): NodeMaterialConnectionPoint;
  67424. /**
  67425. * Gets the output component
  67426. */
  67427. get output(): NodeMaterialConnectionPoint;
  67428. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67429. }
  67430. }
  67431. declare module "babylonjs/Materials/Node/Blocks/normalBlendBlock" {
  67432. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67433. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67434. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67435. /**
  67436. * Block used to blend normals
  67437. */
  67438. export class NormalBlendBlock extends NodeMaterialBlock {
  67439. /**
  67440. * Creates a new NormalBlendBlock
  67441. * @param name defines the block name
  67442. */
  67443. constructor(name: string);
  67444. /**
  67445. * Gets the current class name
  67446. * @returns the class name
  67447. */
  67448. getClassName(): string;
  67449. /**
  67450. * Gets the first input component
  67451. */
  67452. get normalMap0(): NodeMaterialConnectionPoint;
  67453. /**
  67454. * Gets the second input component
  67455. */
  67456. get normalMap1(): NodeMaterialConnectionPoint;
  67457. /**
  67458. * Gets the output component
  67459. */
  67460. get output(): NodeMaterialConnectionPoint;
  67461. protected _buildBlock(state: NodeMaterialBuildState): this;
  67462. }
  67463. }
  67464. declare module "babylonjs/Materials/Node/Blocks/rotate2dBlock" {
  67465. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67466. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67467. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67468. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  67469. /**
  67470. * Block used to rotate a 2d vector by a given angle
  67471. */
  67472. export class Rotate2dBlock extends NodeMaterialBlock {
  67473. /**
  67474. * Creates a new Rotate2dBlock
  67475. * @param name defines the block name
  67476. */
  67477. constructor(name: string);
  67478. /**
  67479. * Gets the current class name
  67480. * @returns the class name
  67481. */
  67482. getClassName(): string;
  67483. /**
  67484. * Gets the input vector
  67485. */
  67486. get input(): NodeMaterialConnectionPoint;
  67487. /**
  67488. * Gets the input angle
  67489. */
  67490. get angle(): NodeMaterialConnectionPoint;
  67491. /**
  67492. * Gets the output component
  67493. */
  67494. get output(): NodeMaterialConnectionPoint;
  67495. autoConfigure(material: NodeMaterial): void;
  67496. protected _buildBlock(state: NodeMaterialBuildState): this;
  67497. }
  67498. }
  67499. declare module "babylonjs/Materials/Node/Blocks/reflectBlock" {
  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 reflected vector from a direction and a normal
  67505. */
  67506. export class ReflectBlock extends NodeMaterialBlock {
  67507. /**
  67508. * Creates a new ReflectBlock
  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 incident component
  67519. */
  67520. get incident(): NodeMaterialConnectionPoint;
  67521. /**
  67522. * Gets the normal component
  67523. */
  67524. get normal(): 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/refractBlock" {
  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 refracted vector from a direction and a normal
  67538. */
  67539. export class RefractBlock extends NodeMaterialBlock {
  67540. /**
  67541. * Creates a new RefractBlock
  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 incident component
  67552. */
  67553. get incident(): NodeMaterialConnectionPoint;
  67554. /**
  67555. * Gets the normal component
  67556. */
  67557. get normal(): NodeMaterialConnectionPoint;
  67558. /**
  67559. * Gets the index of refraction component
  67560. */
  67561. get ior(): NodeMaterialConnectionPoint;
  67562. /**
  67563. * Gets the output component
  67564. */
  67565. get output(): NodeMaterialConnectionPoint;
  67566. protected _buildBlock(state: NodeMaterialBuildState): this;
  67567. }
  67568. }
  67569. declare module "babylonjs/Materials/Node/Blocks/desaturateBlock" {
  67570. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67571. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67572. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67573. /**
  67574. * Block used to desaturate a color
  67575. */
  67576. export class DesaturateBlock extends NodeMaterialBlock {
  67577. /**
  67578. * Creates a new DesaturateBlock
  67579. * @param name defines the block name
  67580. */
  67581. constructor(name: string);
  67582. /**
  67583. * Gets the current class name
  67584. * @returns the class name
  67585. */
  67586. getClassName(): string;
  67587. /**
  67588. * Gets the color operand input component
  67589. */
  67590. get color(): NodeMaterialConnectionPoint;
  67591. /**
  67592. * Gets the level operand input component
  67593. */
  67594. get level(): NodeMaterialConnectionPoint;
  67595. /**
  67596. * Gets the output component
  67597. */
  67598. get output(): NodeMaterialConnectionPoint;
  67599. protected _buildBlock(state: NodeMaterialBuildState): this;
  67600. }
  67601. }
  67602. declare module "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock" {
  67603. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67604. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67605. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67606. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67607. import { Nullable } from "babylonjs/types";
  67608. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67609. import { Scene } from "babylonjs/scene";
  67610. /**
  67611. * Block used to implement the ambient occlusion module of the PBR material
  67612. */
  67613. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  67614. /**
  67615. * Create a new AmbientOcclusionBlock
  67616. * @param name defines the block name
  67617. */
  67618. constructor(name: string);
  67619. /**
  67620. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  67621. */
  67622. useAmbientInGrayScale: boolean;
  67623. /**
  67624. * Initialize the block and prepare the context for build
  67625. * @param state defines the state that will be used for the build
  67626. */
  67627. initialize(state: NodeMaterialBuildState): void;
  67628. /**
  67629. * Gets the current class name
  67630. * @returns the class name
  67631. */
  67632. getClassName(): string;
  67633. /**
  67634. * Gets the texture input component
  67635. */
  67636. get texture(): NodeMaterialConnectionPoint;
  67637. /**
  67638. * Gets the texture intensity component
  67639. */
  67640. get intensity(): NodeMaterialConnectionPoint;
  67641. /**
  67642. * Gets the direct light intensity input component
  67643. */
  67644. get directLightIntensity(): NodeMaterialConnectionPoint;
  67645. /**
  67646. * Gets the ambient occlusion object output component
  67647. */
  67648. get ambientOcclusion(): NodeMaterialConnectionPoint;
  67649. /**
  67650. * Gets the main code of the block (fragment side)
  67651. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  67652. * @returns the shader code
  67653. */
  67654. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  67655. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67656. protected _buildBlock(state: NodeMaterialBuildState): this;
  67657. protected _dumpPropertiesCode(): string;
  67658. serialize(): any;
  67659. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67660. }
  67661. }
  67662. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock" {
  67663. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67664. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67665. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67666. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  67667. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67668. import { Nullable } from "babylonjs/types";
  67669. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  67670. import { Mesh } from "babylonjs/Meshes/mesh";
  67671. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67672. import { Effect } from "babylonjs/Materials/effect";
  67673. import { Scene } from "babylonjs/scene";
  67674. /**
  67675. * Block used to implement the reflection module of the PBR material
  67676. */
  67677. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  67678. /** @hidden */
  67679. _defineLODReflectionAlpha: string;
  67680. /** @hidden */
  67681. _defineLinearSpecularReflection: string;
  67682. private _vEnvironmentIrradianceName;
  67683. /** @hidden */
  67684. _vReflectionMicrosurfaceInfosName: string;
  67685. /** @hidden */
  67686. _vReflectionInfosName: string;
  67687. /** @hidden */
  67688. _vReflectionFilteringInfoName: string;
  67689. private _scene;
  67690. /**
  67691. * The three properties below are set by the main PBR block prior to calling methods of this class.
  67692. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67693. * It's less burden on the user side in the editor part.
  67694. */
  67695. /** @hidden */
  67696. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67697. /** @hidden */
  67698. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67699. /** @hidden */
  67700. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  67701. /**
  67702. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  67703. * diffuse part of the IBL.
  67704. */
  67705. useSphericalHarmonics: boolean;
  67706. /**
  67707. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  67708. */
  67709. forceIrradianceInFragment: boolean;
  67710. /**
  67711. * Create a new ReflectionBlock
  67712. * @param name defines the block name
  67713. */
  67714. constructor(name: string);
  67715. /**
  67716. * Gets the current class name
  67717. * @returns the class name
  67718. */
  67719. getClassName(): string;
  67720. /**
  67721. * Gets the position input component
  67722. */
  67723. get position(): NodeMaterialConnectionPoint;
  67724. /**
  67725. * Gets the world position input component
  67726. */
  67727. get worldPosition(): NodeMaterialConnectionPoint;
  67728. /**
  67729. * Gets the world normal input component
  67730. */
  67731. get worldNormal(): NodeMaterialConnectionPoint;
  67732. /**
  67733. * Gets the world input component
  67734. */
  67735. get world(): NodeMaterialConnectionPoint;
  67736. /**
  67737. * Gets the camera (or eye) position component
  67738. */
  67739. get cameraPosition(): NodeMaterialConnectionPoint;
  67740. /**
  67741. * Gets the view input component
  67742. */
  67743. get view(): NodeMaterialConnectionPoint;
  67744. /**
  67745. * Gets the color input component
  67746. */
  67747. get color(): NodeMaterialConnectionPoint;
  67748. /**
  67749. * Gets the reflection object output component
  67750. */
  67751. get reflection(): NodeMaterialConnectionPoint;
  67752. /**
  67753. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  67754. */
  67755. get hasTexture(): boolean;
  67756. /**
  67757. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  67758. */
  67759. get reflectionColor(): string;
  67760. protected _getTexture(): Nullable<BaseTexture>;
  67761. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67762. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67763. /**
  67764. * Gets the code to inject in the vertex shader
  67765. * @param state current state of the node material building
  67766. * @returns the shader code
  67767. */
  67768. handleVertexSide(state: NodeMaterialBuildState): string;
  67769. /**
  67770. * Gets the main code of the block (fragment side)
  67771. * @param state current state of the node material building
  67772. * @param normalVarName name of the existing variable corresponding to the normal
  67773. * @returns the shader code
  67774. */
  67775. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  67776. protected _buildBlock(state: NodeMaterialBuildState): this;
  67777. protected _dumpPropertiesCode(): string;
  67778. serialize(): any;
  67779. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67780. }
  67781. }
  67782. declare module "babylonjs/Materials/Node/Blocks/PBR/sheenBlock" {
  67783. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67784. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67785. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67786. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67787. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67788. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67789. import { Scene } from "babylonjs/scene";
  67790. import { Nullable } from "babylonjs/types";
  67791. /**
  67792. * Block used to implement the sheen module of the PBR material
  67793. */
  67794. export class SheenBlock extends NodeMaterialBlock {
  67795. /**
  67796. * Create a new SheenBlock
  67797. * @param name defines the block name
  67798. */
  67799. constructor(name: string);
  67800. /**
  67801. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  67802. * It allows the strength of the sheen effect to not depend on the base color of the material,
  67803. * making it easier to setup and tweak the effect
  67804. */
  67805. albedoScaling: boolean;
  67806. /**
  67807. * Defines if the sheen is linked to the sheen color.
  67808. */
  67809. linkSheenWithAlbedo: boolean;
  67810. /**
  67811. * Initialize the block and prepare the context for build
  67812. * @param state defines the state that will be used for the build
  67813. */
  67814. initialize(state: NodeMaterialBuildState): void;
  67815. /**
  67816. * Gets the current class name
  67817. * @returns the class name
  67818. */
  67819. getClassName(): string;
  67820. /**
  67821. * Gets the intensity input component
  67822. */
  67823. get intensity(): NodeMaterialConnectionPoint;
  67824. /**
  67825. * Gets the color input component
  67826. */
  67827. get color(): NodeMaterialConnectionPoint;
  67828. /**
  67829. * Gets the roughness input component
  67830. */
  67831. get roughness(): NodeMaterialConnectionPoint;
  67832. /**
  67833. * Gets the sheen object output component
  67834. */
  67835. get sheen(): NodeMaterialConnectionPoint;
  67836. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67837. /**
  67838. * Gets the main code of the block (fragment side)
  67839. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67840. * @returns the shader code
  67841. */
  67842. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  67843. protected _buildBlock(state: NodeMaterialBuildState): this;
  67844. protected _dumpPropertiesCode(): string;
  67845. serialize(): any;
  67846. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67847. }
  67848. }
  67849. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock" {
  67850. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67851. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67852. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67853. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67854. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67855. import { Scene } from "babylonjs/scene";
  67856. import { Nullable } from "babylonjs/types";
  67857. import { Mesh } from "babylonjs/Meshes/mesh";
  67858. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67859. import { Effect } from "babylonjs/Materials/effect";
  67860. /**
  67861. * Block used to implement the reflectivity module of the PBR material
  67862. */
  67863. export class ReflectivityBlock extends NodeMaterialBlock {
  67864. private _metallicReflectanceColor;
  67865. private _metallicF0Factor;
  67866. /** @hidden */
  67867. _vMetallicReflectanceFactorsName: string;
  67868. /**
  67869. * The property below is set by the main PBR block prior to calling methods of this class.
  67870. */
  67871. /** @hidden */
  67872. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  67873. /**
  67874. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  67875. */
  67876. useAmbientOcclusionFromMetallicTextureRed: boolean;
  67877. /**
  67878. * Specifies if the metallic texture contains the metallness information in its blue channel.
  67879. */
  67880. useMetallnessFromMetallicTextureBlue: boolean;
  67881. /**
  67882. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  67883. */
  67884. useRoughnessFromMetallicTextureAlpha: boolean;
  67885. /**
  67886. * Specifies if the metallic texture contains the roughness information in its green channel.
  67887. */
  67888. useRoughnessFromMetallicTextureGreen: boolean;
  67889. /**
  67890. * Create a new ReflectivityBlock
  67891. * @param name defines the block name
  67892. */
  67893. constructor(name: string);
  67894. /**
  67895. * Initialize the block and prepare the context for build
  67896. * @param state defines the state that will be used for the build
  67897. */
  67898. initialize(state: NodeMaterialBuildState): void;
  67899. /**
  67900. * Gets the current class name
  67901. * @returns the class name
  67902. */
  67903. getClassName(): string;
  67904. /**
  67905. * Gets the metallic input component
  67906. */
  67907. get metallic(): NodeMaterialConnectionPoint;
  67908. /**
  67909. * Gets the roughness input component
  67910. */
  67911. get roughness(): NodeMaterialConnectionPoint;
  67912. /**
  67913. * Gets the texture input component
  67914. */
  67915. get texture(): NodeMaterialConnectionPoint;
  67916. /**
  67917. * Gets the reflectivity object output component
  67918. */
  67919. get reflectivity(): NodeMaterialConnectionPoint;
  67920. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67921. /**
  67922. * Gets the main code of the block (fragment side)
  67923. * @param state current state of the node material building
  67924. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  67925. * @returns the shader code
  67926. */
  67927. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  67928. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67929. protected _buildBlock(state: NodeMaterialBuildState): this;
  67930. protected _dumpPropertiesCode(): string;
  67931. serialize(): any;
  67932. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67933. }
  67934. }
  67935. declare module "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock" {
  67936. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67937. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67938. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67939. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67940. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67941. /**
  67942. * Block used to implement the anisotropy module of the PBR material
  67943. */
  67944. export class AnisotropyBlock extends NodeMaterialBlock {
  67945. /**
  67946. * The two properties below are set by the main PBR block prior to calling methods of this class.
  67947. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67948. * It's less burden on the user side in the editor part.
  67949. */
  67950. /** @hidden */
  67951. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67952. /** @hidden */
  67953. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67954. /**
  67955. * Create a new AnisotropyBlock
  67956. * @param name defines the block name
  67957. */
  67958. constructor(name: string);
  67959. /**
  67960. * Initialize the block and prepare the context for build
  67961. * @param state defines the state that will be used for the build
  67962. */
  67963. initialize(state: NodeMaterialBuildState): void;
  67964. /**
  67965. * Gets the current class name
  67966. * @returns the class name
  67967. */
  67968. getClassName(): string;
  67969. /**
  67970. * Gets the intensity input component
  67971. */
  67972. get intensity(): NodeMaterialConnectionPoint;
  67973. /**
  67974. * Gets the direction input component
  67975. */
  67976. get direction(): NodeMaterialConnectionPoint;
  67977. /**
  67978. * Gets the texture input component
  67979. */
  67980. get texture(): NodeMaterialConnectionPoint;
  67981. /**
  67982. * Gets the uv input component
  67983. */
  67984. get uv(): NodeMaterialConnectionPoint;
  67985. /**
  67986. * Gets the worldTangent input component
  67987. */
  67988. get worldTangent(): NodeMaterialConnectionPoint;
  67989. /**
  67990. * Gets the anisotropy object output component
  67991. */
  67992. get anisotropy(): NodeMaterialConnectionPoint;
  67993. private _generateTBNSpace;
  67994. /**
  67995. * Gets the main code of the block (fragment side)
  67996. * @param state current state of the node material building
  67997. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67998. * @returns the shader code
  67999. */
  68000. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  68001. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68002. protected _buildBlock(state: NodeMaterialBuildState): this;
  68003. }
  68004. }
  68005. declare module "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock" {
  68006. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68007. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68008. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68009. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  68010. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  68011. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  68012. import { Nullable } from "babylonjs/types";
  68013. import { Mesh } from "babylonjs/Meshes/mesh";
  68014. import { SubMesh } from "babylonjs/Meshes/subMesh";
  68015. import { Effect } from "babylonjs/Materials/effect";
  68016. /**
  68017. * Block used to implement the clear coat module of the PBR material
  68018. */
  68019. export class ClearCoatBlock extends NodeMaterialBlock {
  68020. private _scene;
  68021. /**
  68022. * Create a new ClearCoatBlock
  68023. * @param name defines the block name
  68024. */
  68025. constructor(name: string);
  68026. /**
  68027. * Initialize the block and prepare the context for build
  68028. * @param state defines the state that will be used for the build
  68029. */
  68030. initialize(state: NodeMaterialBuildState): void;
  68031. /**
  68032. * Gets the current class name
  68033. * @returns the class name
  68034. */
  68035. getClassName(): string;
  68036. /**
  68037. * Gets the intensity input component
  68038. */
  68039. get intensity(): NodeMaterialConnectionPoint;
  68040. /**
  68041. * Gets the roughness input component
  68042. */
  68043. get roughness(): NodeMaterialConnectionPoint;
  68044. /**
  68045. * Gets the ior input component
  68046. */
  68047. get ior(): NodeMaterialConnectionPoint;
  68048. /**
  68049. * Gets the texture input component
  68050. */
  68051. get texture(): NodeMaterialConnectionPoint;
  68052. /**
  68053. * Gets the bump texture input component
  68054. */
  68055. get bumpTexture(): NodeMaterialConnectionPoint;
  68056. /**
  68057. * Gets the uv input component
  68058. */
  68059. get uv(): NodeMaterialConnectionPoint;
  68060. /**
  68061. * Gets the tint color input component
  68062. */
  68063. get tintColor(): NodeMaterialConnectionPoint;
  68064. /**
  68065. * Gets the tint "at distance" input component
  68066. */
  68067. get tintAtDistance(): NodeMaterialConnectionPoint;
  68068. /**
  68069. * Gets the tint thickness input component
  68070. */
  68071. get tintThickness(): NodeMaterialConnectionPoint;
  68072. /**
  68073. * Gets the world tangent input component
  68074. */
  68075. get worldTangent(): NodeMaterialConnectionPoint;
  68076. /**
  68077. * Gets the clear coat object output component
  68078. */
  68079. get clearcoat(): NodeMaterialConnectionPoint;
  68080. autoConfigure(material: NodeMaterial): void;
  68081. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68082. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  68083. private _generateTBNSpace;
  68084. /**
  68085. * Gets the main code of the block (fragment side)
  68086. * @param state current state of the node material building
  68087. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  68088. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  68089. * @param worldPosVarName name of the variable holding the world position
  68090. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  68091. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  68092. * @param worldNormalVarName name of the variable holding the world normal
  68093. * @returns the shader code
  68094. */
  68095. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  68096. protected _buildBlock(state: NodeMaterialBuildState): this;
  68097. }
  68098. }
  68099. declare module "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock" {
  68100. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68101. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68102. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68103. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  68104. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  68105. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  68106. import { Nullable } from "babylonjs/types";
  68107. /**
  68108. * Block used to implement the sub surface module of the PBR material
  68109. */
  68110. export class SubSurfaceBlock extends NodeMaterialBlock {
  68111. /**
  68112. * Create a new SubSurfaceBlock
  68113. * @param name defines the block name
  68114. */
  68115. constructor(name: string);
  68116. /**
  68117. * Stores the intensity of the different subsurface effects in the thickness texture.
  68118. * * the green channel is the translucency intensity.
  68119. * * the blue channel is the scattering intensity.
  68120. * * the alpha channel is the refraction intensity.
  68121. */
  68122. useMaskFromThicknessTexture: boolean;
  68123. /**
  68124. * Initialize the block and prepare the context for build
  68125. * @param state defines the state that will be used for the build
  68126. */
  68127. initialize(state: NodeMaterialBuildState): void;
  68128. /**
  68129. * Gets the current class name
  68130. * @returns the class name
  68131. */
  68132. getClassName(): string;
  68133. /**
  68134. * Gets the min thickness input component
  68135. */
  68136. get minThickness(): NodeMaterialConnectionPoint;
  68137. /**
  68138. * Gets the max thickness input component
  68139. */
  68140. get maxThickness(): NodeMaterialConnectionPoint;
  68141. /**
  68142. * Gets the thickness texture component
  68143. */
  68144. get thicknessTexture(): NodeMaterialConnectionPoint;
  68145. /**
  68146. * Gets the tint color input component
  68147. */
  68148. get tintColor(): NodeMaterialConnectionPoint;
  68149. /**
  68150. * Gets the translucency intensity input component
  68151. */
  68152. get translucencyIntensity(): NodeMaterialConnectionPoint;
  68153. /**
  68154. * Gets the translucency diffusion distance input component
  68155. */
  68156. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  68157. /**
  68158. * Gets the refraction object parameters
  68159. */
  68160. get refraction(): NodeMaterialConnectionPoint;
  68161. /**
  68162. * Gets the sub surface object output component
  68163. */
  68164. get subsurface(): NodeMaterialConnectionPoint;
  68165. autoConfigure(material: NodeMaterial): void;
  68166. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68167. /**
  68168. * Gets the main code of the block (fragment side)
  68169. * @param state current state of the node material building
  68170. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  68171. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  68172. * @param worldPosVarName name of the variable holding the world position
  68173. * @returns the shader code
  68174. */
  68175. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  68176. protected _buildBlock(state: NodeMaterialBuildState): this;
  68177. }
  68178. }
  68179. declare module "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock" {
  68180. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68181. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68182. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68183. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  68184. import { Light } from "babylonjs/Lights/light";
  68185. import { Nullable } from "babylonjs/types";
  68186. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  68187. import { Effect } from "babylonjs/Materials/effect";
  68188. import { Mesh } from "babylonjs/Meshes/mesh";
  68189. import { Scene } from "babylonjs/scene";
  68190. /**
  68191. * Block used to implement the PBR metallic/roughness model
  68192. */
  68193. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  68194. /**
  68195. * Gets or sets the light associated with this block
  68196. */
  68197. light: Nullable<Light>;
  68198. private _lightId;
  68199. private _scene;
  68200. private _environmentBRDFTexture;
  68201. private _environmentBrdfSamplerName;
  68202. private _vNormalWName;
  68203. private _invertNormalName;
  68204. /**
  68205. * Create a new ReflectionBlock
  68206. * @param name defines the block name
  68207. */
  68208. constructor(name: string);
  68209. /**
  68210. * Intensity of the direct lights e.g. the four lights available in your scene.
  68211. * This impacts both the direct diffuse and specular highlights.
  68212. */
  68213. directIntensity: number;
  68214. /**
  68215. * Intensity of the environment e.g. how much the environment will light the object
  68216. * either through harmonics for rough material or through the refelction for shiny ones.
  68217. */
  68218. environmentIntensity: number;
  68219. /**
  68220. * This is a special control allowing the reduction of the specular highlights coming from the
  68221. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  68222. */
  68223. specularIntensity: number;
  68224. /**
  68225. * Defines the falloff type used in this material.
  68226. * It by default is Physical.
  68227. */
  68228. lightFalloff: number;
  68229. /**
  68230. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  68231. */
  68232. useAlphaFromAlbedoTexture: boolean;
  68233. /**
  68234. * Specifies that alpha test should be used
  68235. */
  68236. useAlphaTest: boolean;
  68237. /**
  68238. * Defines the alpha limits in alpha test mode.
  68239. */
  68240. alphaTestCutoff: number;
  68241. /**
  68242. * Specifies that alpha blending should be used
  68243. */
  68244. useAlphaBlending: boolean;
  68245. /**
  68246. * Defines if the alpha value should be determined via the rgb values.
  68247. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  68248. */
  68249. opacityRGB: boolean;
  68250. /**
  68251. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  68252. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  68253. */
  68254. useRadianceOverAlpha: boolean;
  68255. /**
  68256. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  68257. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  68258. */
  68259. useSpecularOverAlpha: boolean;
  68260. /**
  68261. * Enables specular anti aliasing in the PBR shader.
  68262. * It will both interacts on the Geometry for analytical and IBL lighting.
  68263. * It also prefilter the roughness map based on the bump values.
  68264. */
  68265. enableSpecularAntiAliasing: boolean;
  68266. /**
  68267. * Enables realtime filtering on the texture.
  68268. */
  68269. realTimeFiltering: boolean;
  68270. /**
  68271. * Quality switch for realtime filtering
  68272. */
  68273. realTimeFilteringQuality: number;
  68274. /**
  68275. * Defines if the material uses energy conservation.
  68276. */
  68277. useEnergyConservation: boolean;
  68278. /**
  68279. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  68280. * too much the area relying on ambient texture to define their ambient occlusion.
  68281. */
  68282. useRadianceOcclusion: boolean;
  68283. /**
  68284. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  68285. * makes the reflect vector face the model (under horizon).
  68286. */
  68287. useHorizonOcclusion: boolean;
  68288. /**
  68289. * If set to true, no lighting calculations will be applied.
  68290. */
  68291. unlit: boolean;
  68292. /**
  68293. * Force normal to face away from face.
  68294. */
  68295. forceNormalForward: boolean;
  68296. /**
  68297. * Defines the material debug mode.
  68298. * It helps seeing only some components of the material while troubleshooting.
  68299. */
  68300. debugMode: number;
  68301. /**
  68302. * Specify from where on screen the debug mode should start.
  68303. * The value goes from -1 (full screen) to 1 (not visible)
  68304. * It helps with side by side comparison against the final render
  68305. * This defaults to 0
  68306. */
  68307. debugLimit: number;
  68308. /**
  68309. * As the default viewing range might not be enough (if the ambient is really small for instance)
  68310. * You can use the factor to better multiply the final value.
  68311. */
  68312. debugFactor: number;
  68313. /**
  68314. * Initialize the block and prepare the context for build
  68315. * @param state defines the state that will be used for the build
  68316. */
  68317. initialize(state: NodeMaterialBuildState): void;
  68318. /**
  68319. * Gets the current class name
  68320. * @returns the class name
  68321. */
  68322. getClassName(): string;
  68323. /**
  68324. * Gets the world position input component
  68325. */
  68326. get worldPosition(): NodeMaterialConnectionPoint;
  68327. /**
  68328. * Gets the world normal input component
  68329. */
  68330. get worldNormal(): NodeMaterialConnectionPoint;
  68331. /**
  68332. * Gets the perturbed normal input component
  68333. */
  68334. get perturbedNormal(): NodeMaterialConnectionPoint;
  68335. /**
  68336. * Gets the camera position input component
  68337. */
  68338. get cameraPosition(): NodeMaterialConnectionPoint;
  68339. /**
  68340. * Gets the base color input component
  68341. */
  68342. get baseColor(): NodeMaterialConnectionPoint;
  68343. /**
  68344. * Gets the opacity texture input component
  68345. */
  68346. get opacityTexture(): NodeMaterialConnectionPoint;
  68347. /**
  68348. * Gets the ambient color input component
  68349. */
  68350. get ambientColor(): NodeMaterialConnectionPoint;
  68351. /**
  68352. * Gets the reflectivity object parameters
  68353. */
  68354. get reflectivity(): NodeMaterialConnectionPoint;
  68355. /**
  68356. * Gets the ambient occlusion object parameters
  68357. */
  68358. get ambientOcclusion(): NodeMaterialConnectionPoint;
  68359. /**
  68360. * Gets the reflection object parameters
  68361. */
  68362. get reflection(): NodeMaterialConnectionPoint;
  68363. /**
  68364. * Gets the sheen object parameters
  68365. */
  68366. get sheen(): NodeMaterialConnectionPoint;
  68367. /**
  68368. * Gets the clear coat object parameters
  68369. */
  68370. get clearcoat(): NodeMaterialConnectionPoint;
  68371. /**
  68372. * Gets the sub surface object parameters
  68373. */
  68374. get subsurface(): NodeMaterialConnectionPoint;
  68375. /**
  68376. * Gets the anisotropy object parameters
  68377. */
  68378. get anisotropy(): NodeMaterialConnectionPoint;
  68379. /**
  68380. * Gets the ambient output component
  68381. */
  68382. get ambient(): NodeMaterialConnectionPoint;
  68383. /**
  68384. * Gets the diffuse output component
  68385. */
  68386. get diffuse(): NodeMaterialConnectionPoint;
  68387. /**
  68388. * Gets the specular output component
  68389. */
  68390. get specular(): NodeMaterialConnectionPoint;
  68391. /**
  68392. * Gets the sheen output component
  68393. */
  68394. get sheenDir(): NodeMaterialConnectionPoint;
  68395. /**
  68396. * Gets the clear coat output component
  68397. */
  68398. get clearcoatDir(): NodeMaterialConnectionPoint;
  68399. /**
  68400. * Gets the indirect diffuse output component
  68401. */
  68402. get diffuseIndirect(): NodeMaterialConnectionPoint;
  68403. /**
  68404. * Gets the indirect specular output component
  68405. */
  68406. get specularIndirect(): NodeMaterialConnectionPoint;
  68407. /**
  68408. * Gets the indirect sheen output component
  68409. */
  68410. get sheenIndirect(): NodeMaterialConnectionPoint;
  68411. /**
  68412. * Gets the indirect clear coat output component
  68413. */
  68414. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  68415. /**
  68416. * Gets the refraction output component
  68417. */
  68418. get refraction(): NodeMaterialConnectionPoint;
  68419. /**
  68420. * Gets the global lighting output component
  68421. */
  68422. get lighting(): NodeMaterialConnectionPoint;
  68423. /**
  68424. * Gets the shadow output component
  68425. */
  68426. get shadow(): NodeMaterialConnectionPoint;
  68427. /**
  68428. * Gets the alpha output component
  68429. */
  68430. get alpha(): NodeMaterialConnectionPoint;
  68431. autoConfigure(material: NodeMaterial): void;
  68432. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68433. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  68434. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  68435. private _injectVertexCode;
  68436. /**
  68437. * Gets the code corresponding to the albedo/opacity module
  68438. * @returns the shader code
  68439. */
  68440. getAlbedoOpacityCode(): string;
  68441. protected _buildBlock(state: NodeMaterialBuildState): this;
  68442. protected _dumpPropertiesCode(): string;
  68443. serialize(): any;
  68444. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  68445. }
  68446. }
  68447. declare module "babylonjs/Materials/Node/Blocks/PBR/index" {
  68448. export * from "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock";
  68449. export * from "babylonjs/Materials/Node/Blocks/PBR/sheenBlock";
  68450. export * from "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock";
  68451. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock";
  68452. export * from "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock";
  68453. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  68454. export * from "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock";
  68455. export * from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  68456. export * from "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock";
  68457. }
  68458. declare module "babylonjs/Materials/Node/Blocks/Particle/index" {
  68459. export * from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  68460. export * from "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock";
  68461. export * from "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock";
  68462. }
  68463. declare module "babylonjs/Materials/Node/Blocks/modBlock" {
  68464. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68465. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68466. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68467. /**
  68468. * Block used to compute value of one parameter modulo another
  68469. */
  68470. export class ModBlock extends NodeMaterialBlock {
  68471. /**
  68472. * Creates a new ModBlock
  68473. * @param name defines the block name
  68474. */
  68475. constructor(name: string);
  68476. /**
  68477. * Gets the current class name
  68478. * @returns the class name
  68479. */
  68480. getClassName(): string;
  68481. /**
  68482. * Gets the left operand input component
  68483. */
  68484. get left(): NodeMaterialConnectionPoint;
  68485. /**
  68486. * Gets the right operand input component
  68487. */
  68488. get right(): NodeMaterialConnectionPoint;
  68489. /**
  68490. * Gets the output component
  68491. */
  68492. get output(): NodeMaterialConnectionPoint;
  68493. protected _buildBlock(state: NodeMaterialBuildState): this;
  68494. }
  68495. }
  68496. declare module "babylonjs/Materials/Node/Blocks/index" {
  68497. export * from "babylonjs/Materials/Node/Blocks/Vertex/index";
  68498. export * from "babylonjs/Materials/Node/Blocks/Fragment/index";
  68499. export * from "babylonjs/Materials/Node/Blocks/Dual/index";
  68500. export * from "babylonjs/Materials/Node/Blocks/Input/index";
  68501. export * from "babylonjs/Materials/Node/Blocks/multiplyBlock";
  68502. export * from "babylonjs/Materials/Node/Blocks/addBlock";
  68503. export * from "babylonjs/Materials/Node/Blocks/scaleBlock";
  68504. export * from "babylonjs/Materials/Node/Blocks/clampBlock";
  68505. export * from "babylonjs/Materials/Node/Blocks/crossBlock";
  68506. export * from "babylonjs/Materials/Node/Blocks/dotBlock";
  68507. export * from "babylonjs/Materials/Node/Blocks/transformBlock";
  68508. export * from "babylonjs/Materials/Node/Blocks/remapBlock";
  68509. export * from "babylonjs/Materials/Node/Blocks/normalizeBlock";
  68510. export * from "babylonjs/Materials/Node/Blocks/trigonometryBlock";
  68511. export * from "babylonjs/Materials/Node/Blocks/colorMergerBlock";
  68512. export * from "babylonjs/Materials/Node/Blocks/vectorMergerBlock";
  68513. export * from "babylonjs/Materials/Node/Blocks/colorSplitterBlock";
  68514. export * from "babylonjs/Materials/Node/Blocks/vectorSplitterBlock";
  68515. export * from "babylonjs/Materials/Node/Blocks/lerpBlock";
  68516. export * from "babylonjs/Materials/Node/Blocks/divideBlock";
  68517. export * from "babylonjs/Materials/Node/Blocks/subtractBlock";
  68518. export * from "babylonjs/Materials/Node/Blocks/stepBlock";
  68519. export * from "babylonjs/Materials/Node/Blocks/oneMinusBlock";
  68520. export * from "babylonjs/Materials/Node/Blocks/viewDirectionBlock";
  68521. export * from "babylonjs/Materials/Node/Blocks/fresnelBlock";
  68522. export * from "babylonjs/Materials/Node/Blocks/maxBlock";
  68523. export * from "babylonjs/Materials/Node/Blocks/minBlock";
  68524. export * from "babylonjs/Materials/Node/Blocks/distanceBlock";
  68525. export * from "babylonjs/Materials/Node/Blocks/lengthBlock";
  68526. export * from "babylonjs/Materials/Node/Blocks/negateBlock";
  68527. export * from "babylonjs/Materials/Node/Blocks/powBlock";
  68528. export * from "babylonjs/Materials/Node/Blocks/randomNumberBlock";
  68529. export * from "babylonjs/Materials/Node/Blocks/arcTan2Block";
  68530. export * from "babylonjs/Materials/Node/Blocks/smoothStepBlock";
  68531. export * from "babylonjs/Materials/Node/Blocks/reciprocalBlock";
  68532. export * from "babylonjs/Materials/Node/Blocks/replaceColorBlock";
  68533. export * from "babylonjs/Materials/Node/Blocks/posterizeBlock";
  68534. export * from "babylonjs/Materials/Node/Blocks/waveBlock";
  68535. export * from "babylonjs/Materials/Node/Blocks/gradientBlock";
  68536. export * from "babylonjs/Materials/Node/Blocks/nLerpBlock";
  68537. export * from "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock";
  68538. export * from "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock";
  68539. export * from "babylonjs/Materials/Node/Blocks/normalBlendBlock";
  68540. export * from "babylonjs/Materials/Node/Blocks/rotate2dBlock";
  68541. export * from "babylonjs/Materials/Node/Blocks/reflectBlock";
  68542. export * from "babylonjs/Materials/Node/Blocks/refractBlock";
  68543. export * from "babylonjs/Materials/Node/Blocks/desaturateBlock";
  68544. export * from "babylonjs/Materials/Node/Blocks/PBR/index";
  68545. export * from "babylonjs/Materials/Node/Blocks/Particle/index";
  68546. export * from "babylonjs/Materials/Node/Blocks/modBlock";
  68547. }
  68548. declare module "babylonjs/Materials/Node/Optimizers/index" {
  68549. export * from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  68550. }
  68551. declare module "babylonjs/Materials/Node/index" {
  68552. export * from "babylonjs/Materials/Node/Enums/index";
  68553. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68554. export * from "babylonjs/Materials/Node/nodeMaterialBlock";
  68555. export * from "babylonjs/Materials/Node/nodeMaterial";
  68556. export * from "babylonjs/Materials/Node/Blocks/index";
  68557. export * from "babylonjs/Materials/Node/Optimizers/index";
  68558. export * from "babylonjs/Materials/Node/nodeMaterialDecorator";
  68559. }
  68560. declare module "babylonjs/Materials/index" {
  68561. export * from "babylonjs/Materials/Background/index";
  68562. export * from "babylonjs/Materials/colorCurves";
  68563. export * from "babylonjs/Materials/iEffectFallbacks";
  68564. export * from "babylonjs/Materials/effectFallbacks";
  68565. export * from "babylonjs/Materials/effect";
  68566. export * from "babylonjs/Materials/fresnelParameters";
  68567. export * from "babylonjs/Materials/imageProcessingConfiguration";
  68568. export * from "babylonjs/Materials/material";
  68569. export * from "babylonjs/Materials/materialDefines";
  68570. export * from "babylonjs/Materials/thinMaterialHelper";
  68571. export * from "babylonjs/Materials/materialHelper";
  68572. export * from "babylonjs/Materials/multiMaterial";
  68573. export * from "babylonjs/Materials/PBR/index";
  68574. export * from "babylonjs/Materials/pushMaterial";
  68575. export * from "babylonjs/Materials/shaderMaterial";
  68576. export * from "babylonjs/Materials/standardMaterial";
  68577. export * from "babylonjs/Materials/Textures/index";
  68578. export * from "babylonjs/Materials/uniformBuffer";
  68579. export * from "babylonjs/Materials/materialFlags";
  68580. export * from "babylonjs/Materials/Node/index";
  68581. export * from "babylonjs/Materials/effectRenderer";
  68582. export * from "babylonjs/Materials/shadowDepthWrapper";
  68583. }
  68584. declare module "babylonjs/Maths/index" {
  68585. export * from "babylonjs/Maths/math.scalar";
  68586. export * from "babylonjs/Maths/math";
  68587. export * from "babylonjs/Maths/sphericalPolynomial";
  68588. }
  68589. declare module "babylonjs/Meshes/Compression/dracoCompression" {
  68590. import { IDisposable } from "babylonjs/scene";
  68591. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68592. /**
  68593. * Configuration for Draco compression
  68594. */
  68595. export interface IDracoCompressionConfiguration {
  68596. /**
  68597. * Configuration for the decoder.
  68598. */
  68599. decoder: {
  68600. /**
  68601. * The url to the WebAssembly module.
  68602. */
  68603. wasmUrl?: string;
  68604. /**
  68605. * The url to the WebAssembly binary.
  68606. */
  68607. wasmBinaryUrl?: string;
  68608. /**
  68609. * The url to the fallback JavaScript module.
  68610. */
  68611. fallbackUrl?: string;
  68612. };
  68613. }
  68614. /**
  68615. * Draco compression (https://google.github.io/draco/)
  68616. *
  68617. * This class wraps the Draco module.
  68618. *
  68619. * **Encoder**
  68620. *
  68621. * The encoder is not currently implemented.
  68622. *
  68623. * **Decoder**
  68624. *
  68625. * 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.
  68626. *
  68627. * To update the configuration, use the following code:
  68628. * ```javascript
  68629. * DracoCompression.Configuration = {
  68630. * decoder: {
  68631. * wasmUrl: "<url to the WebAssembly library>",
  68632. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  68633. * fallbackUrl: "<url to the fallback JavaScript library>",
  68634. * }
  68635. * };
  68636. * ```
  68637. *
  68638. * 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.
  68639. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  68640. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  68641. *
  68642. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  68643. * ```javascript
  68644. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  68645. * ```
  68646. *
  68647. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  68648. */
  68649. export class DracoCompression implements IDisposable {
  68650. private _workerPoolPromise?;
  68651. private _decoderModulePromise?;
  68652. /**
  68653. * The configuration. Defaults to the following urls:
  68654. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  68655. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  68656. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  68657. */
  68658. static Configuration: IDracoCompressionConfiguration;
  68659. /**
  68660. * Returns true if the decoder configuration is available.
  68661. */
  68662. static get DecoderAvailable(): boolean;
  68663. /**
  68664. * Default number of workers to create when creating the draco compression object.
  68665. */
  68666. static DefaultNumWorkers: number;
  68667. private static GetDefaultNumWorkers;
  68668. private static _Default;
  68669. /**
  68670. * Default instance for the draco compression object.
  68671. */
  68672. static get Default(): DracoCompression;
  68673. /**
  68674. * Constructor
  68675. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  68676. */
  68677. constructor(numWorkers?: number);
  68678. /**
  68679. * Stop all async operations and release resources.
  68680. */
  68681. dispose(): void;
  68682. /**
  68683. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  68684. * @returns a promise that resolves when ready
  68685. */
  68686. whenReadyAsync(): Promise<void>;
  68687. /**
  68688. * Decode Draco compressed mesh data to vertex data.
  68689. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  68690. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  68691. * @returns A promise that resolves with the decoded vertex data
  68692. */
  68693. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  68694. [kind: string]: number;
  68695. }): Promise<VertexData>;
  68696. }
  68697. }
  68698. declare module "babylonjs/Meshes/Compression/index" {
  68699. export * from "babylonjs/Meshes/Compression/dracoCompression";
  68700. }
  68701. declare module "babylonjs/Meshes/csg" {
  68702. import { Nullable } from "babylonjs/types";
  68703. import { Scene } from "babylonjs/scene";
  68704. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  68705. import { Mesh } from "babylonjs/Meshes/mesh";
  68706. import { Material } from "babylonjs/Materials/material";
  68707. /**
  68708. * Class for building Constructive Solid Geometry
  68709. */
  68710. export class CSG {
  68711. private polygons;
  68712. /**
  68713. * The world matrix
  68714. */
  68715. matrix: Matrix;
  68716. /**
  68717. * Stores the position
  68718. */
  68719. position: Vector3;
  68720. /**
  68721. * Stores the rotation
  68722. */
  68723. rotation: Vector3;
  68724. /**
  68725. * Stores the rotation quaternion
  68726. */
  68727. rotationQuaternion: Nullable<Quaternion>;
  68728. /**
  68729. * Stores the scaling vector
  68730. */
  68731. scaling: Vector3;
  68732. /**
  68733. * Convert the Mesh to CSG
  68734. * @param mesh The Mesh to convert to CSG
  68735. * @returns A new CSG from the Mesh
  68736. */
  68737. static FromMesh(mesh: Mesh): CSG;
  68738. /**
  68739. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  68740. * @param polygons Polygons used to construct a CSG solid
  68741. */
  68742. private static FromPolygons;
  68743. /**
  68744. * Clones, or makes a deep copy, of the CSG
  68745. * @returns A new CSG
  68746. */
  68747. clone(): CSG;
  68748. /**
  68749. * Unions this CSG with another CSG
  68750. * @param csg The CSG to union against this CSG
  68751. * @returns The unioned CSG
  68752. */
  68753. union(csg: CSG): CSG;
  68754. /**
  68755. * Unions this CSG with another CSG in place
  68756. * @param csg The CSG to union against this CSG
  68757. */
  68758. unionInPlace(csg: CSG): void;
  68759. /**
  68760. * Subtracts this CSG with another CSG
  68761. * @param csg The CSG to subtract against this CSG
  68762. * @returns A new CSG
  68763. */
  68764. subtract(csg: CSG): CSG;
  68765. /**
  68766. * Subtracts this CSG with another CSG in place
  68767. * @param csg The CSG to subtact against this CSG
  68768. */
  68769. subtractInPlace(csg: CSG): void;
  68770. /**
  68771. * Intersect this CSG with another CSG
  68772. * @param csg The CSG to intersect against this CSG
  68773. * @returns A new CSG
  68774. */
  68775. intersect(csg: CSG): CSG;
  68776. /**
  68777. * Intersects this CSG with another CSG in place
  68778. * @param csg The CSG to intersect against this CSG
  68779. */
  68780. intersectInPlace(csg: CSG): void;
  68781. /**
  68782. * Return a new CSG solid with solid and empty space switched. This solid is
  68783. * not modified.
  68784. * @returns A new CSG solid with solid and empty space switched
  68785. */
  68786. inverse(): CSG;
  68787. /**
  68788. * Inverses the CSG in place
  68789. */
  68790. inverseInPlace(): void;
  68791. /**
  68792. * This is used to keep meshes transformations so they can be restored
  68793. * when we build back a Babylon Mesh
  68794. * NB : All CSG operations are performed in world coordinates
  68795. * @param csg The CSG to copy the transform attributes from
  68796. * @returns This CSG
  68797. */
  68798. copyTransformAttributes(csg: CSG): CSG;
  68799. /**
  68800. * Build Raw mesh from CSG
  68801. * Coordinates here are in world space
  68802. * @param name The name of the mesh geometry
  68803. * @param scene The Scene
  68804. * @param keepSubMeshes Specifies if the submeshes should be kept
  68805. * @returns A new Mesh
  68806. */
  68807. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68808. /**
  68809. * Build Mesh from CSG taking material and transforms into account
  68810. * @param name The name of the Mesh
  68811. * @param material The material of the Mesh
  68812. * @param scene The Scene
  68813. * @param keepSubMeshes Specifies if submeshes should be kept
  68814. * @returns The new Mesh
  68815. */
  68816. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68817. }
  68818. }
  68819. declare module "babylonjs/Meshes/trailMesh" {
  68820. import { Mesh } from "babylonjs/Meshes/mesh";
  68821. import { Scene } from "babylonjs/scene";
  68822. import { TransformNode } from "babylonjs/Meshes/transformNode";
  68823. /**
  68824. * Class used to create a trail following a mesh
  68825. */
  68826. export class TrailMesh extends Mesh {
  68827. private _generator;
  68828. private _autoStart;
  68829. private _running;
  68830. private _diameter;
  68831. private _length;
  68832. private _sectionPolygonPointsCount;
  68833. private _sectionVectors;
  68834. private _sectionNormalVectors;
  68835. private _beforeRenderObserver;
  68836. /**
  68837. * @constructor
  68838. * @param name The value used by scene.getMeshByName() to do a lookup.
  68839. * @param generator The mesh or transform node to generate a trail.
  68840. * @param scene The scene to add this mesh to.
  68841. * @param diameter Diameter of trailing mesh. Default is 1.
  68842. * @param length Length of trailing mesh. Default is 60.
  68843. * @param autoStart Automatically start trailing mesh. Default true.
  68844. */
  68845. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  68846. /**
  68847. * "TrailMesh"
  68848. * @returns "TrailMesh"
  68849. */
  68850. getClassName(): string;
  68851. private _createMesh;
  68852. /**
  68853. * Start trailing mesh.
  68854. */
  68855. start(): void;
  68856. /**
  68857. * Stop trailing mesh.
  68858. */
  68859. stop(): void;
  68860. /**
  68861. * Update trailing mesh geometry.
  68862. */
  68863. update(): void;
  68864. /**
  68865. * Returns a new TrailMesh object.
  68866. * @param name is a string, the name given to the new mesh
  68867. * @param newGenerator use new generator object for cloned trail mesh
  68868. * @returns a new mesh
  68869. */
  68870. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  68871. /**
  68872. * Serializes this trail mesh
  68873. * @param serializationObject object to write serialization to
  68874. */
  68875. serialize(serializationObject: any): void;
  68876. /**
  68877. * Parses a serialized trail mesh
  68878. * @param parsedMesh the serialized mesh
  68879. * @param scene the scene to create the trail mesh in
  68880. * @returns the created trail mesh
  68881. */
  68882. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  68883. }
  68884. }
  68885. declare module "babylonjs/Meshes/Builders/tiledBoxBuilder" {
  68886. import { Nullable } from "babylonjs/types";
  68887. import { Scene } from "babylonjs/scene";
  68888. import { Vector4 } from "babylonjs/Maths/math.vector";
  68889. import { Color4 } from "babylonjs/Maths/math.color";
  68890. import { Mesh } from "babylonjs/Meshes/mesh";
  68891. /**
  68892. * Class containing static functions to help procedurally build meshes
  68893. */
  68894. export class TiledBoxBuilder {
  68895. /**
  68896. * Creates a box mesh
  68897. * 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)
  68898. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68899. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68900. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68901. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68902. * @param name defines the name of the mesh
  68903. * @param options defines the options used to create the mesh
  68904. * @param scene defines the hosting scene
  68905. * @returns the box mesh
  68906. */
  68907. static CreateTiledBox(name: string, options: {
  68908. pattern?: number;
  68909. width?: number;
  68910. height?: number;
  68911. depth?: number;
  68912. tileSize?: number;
  68913. tileWidth?: number;
  68914. tileHeight?: number;
  68915. alignHorizontal?: number;
  68916. alignVertical?: number;
  68917. faceUV?: Vector4[];
  68918. faceColors?: Color4[];
  68919. sideOrientation?: number;
  68920. updatable?: boolean;
  68921. }, scene?: Nullable<Scene>): Mesh;
  68922. }
  68923. }
  68924. declare module "babylonjs/Meshes/Builders/torusKnotBuilder" {
  68925. import { Vector4 } from "babylonjs/Maths/math.vector";
  68926. import { Mesh } from "babylonjs/Meshes/mesh";
  68927. /**
  68928. * Class containing static functions to help procedurally build meshes
  68929. */
  68930. export class TorusKnotBuilder {
  68931. /**
  68932. * Creates a torus knot mesh
  68933. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  68934. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  68935. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  68936. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  68937. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68938. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68939. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68940. * @param name defines the name of the mesh
  68941. * @param options defines the options used to create the mesh
  68942. * @param scene defines the hosting scene
  68943. * @returns the torus knot mesh
  68944. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  68945. */
  68946. static CreateTorusKnot(name: string, options: {
  68947. radius?: number;
  68948. tube?: number;
  68949. radialSegments?: number;
  68950. tubularSegments?: number;
  68951. p?: number;
  68952. q?: number;
  68953. updatable?: boolean;
  68954. sideOrientation?: number;
  68955. frontUVs?: Vector4;
  68956. backUVs?: Vector4;
  68957. }, scene: any): Mesh;
  68958. }
  68959. }
  68960. declare module "babylonjs/Meshes/polygonMesh" {
  68961. import { Scene } from "babylonjs/scene";
  68962. import { Vector2 } from "babylonjs/Maths/math.vector";
  68963. import { Mesh } from "babylonjs/Meshes/mesh";
  68964. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68965. import { Path2 } from "babylonjs/Maths/math.path";
  68966. /**
  68967. * Polygon
  68968. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  68969. */
  68970. export class Polygon {
  68971. /**
  68972. * Creates a rectangle
  68973. * @param xmin bottom X coord
  68974. * @param ymin bottom Y coord
  68975. * @param xmax top X coord
  68976. * @param ymax top Y coord
  68977. * @returns points that make the resulting rectation
  68978. */
  68979. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  68980. /**
  68981. * Creates a circle
  68982. * @param radius radius of circle
  68983. * @param cx scale in x
  68984. * @param cy scale in y
  68985. * @param numberOfSides number of sides that make up the circle
  68986. * @returns points that make the resulting circle
  68987. */
  68988. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  68989. /**
  68990. * Creates a polygon from input string
  68991. * @param input Input polygon data
  68992. * @returns the parsed points
  68993. */
  68994. static Parse(input: string): Vector2[];
  68995. /**
  68996. * Starts building a polygon from x and y coordinates
  68997. * @param x x coordinate
  68998. * @param y y coordinate
  68999. * @returns the started path2
  69000. */
  69001. static StartingAt(x: number, y: number): Path2;
  69002. }
  69003. /**
  69004. * Builds a polygon
  69005. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  69006. */
  69007. export class PolygonMeshBuilder {
  69008. private _points;
  69009. private _outlinepoints;
  69010. private _holes;
  69011. private _name;
  69012. private _scene;
  69013. private _epoints;
  69014. private _eholes;
  69015. private _addToepoint;
  69016. /**
  69017. * Babylon reference to the earcut plugin.
  69018. */
  69019. bjsEarcut: any;
  69020. /**
  69021. * Creates a PolygonMeshBuilder
  69022. * @param name name of the builder
  69023. * @param contours Path of the polygon
  69024. * @param scene scene to add to when creating the mesh
  69025. * @param earcutInjection can be used to inject your own earcut reference
  69026. */
  69027. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  69028. /**
  69029. * Adds a whole within the polygon
  69030. * @param hole Array of points defining the hole
  69031. * @returns this
  69032. */
  69033. addHole(hole: Vector2[]): PolygonMeshBuilder;
  69034. /**
  69035. * Creates the polygon
  69036. * @param updatable If the mesh should be updatable
  69037. * @param depth The depth of the mesh created
  69038. * @returns the created mesh
  69039. */
  69040. build(updatable?: boolean, depth?: number): Mesh;
  69041. /**
  69042. * Creates the polygon
  69043. * @param depth The depth of the mesh created
  69044. * @returns the created VertexData
  69045. */
  69046. buildVertexData(depth?: number): VertexData;
  69047. /**
  69048. * Adds a side to the polygon
  69049. * @param positions points that make the polygon
  69050. * @param normals normals of the polygon
  69051. * @param uvs uvs of the polygon
  69052. * @param indices indices of the polygon
  69053. * @param bounds bounds of the polygon
  69054. * @param points points of the polygon
  69055. * @param depth depth of the polygon
  69056. * @param flip flip of the polygon
  69057. */
  69058. private addSide;
  69059. }
  69060. }
  69061. declare module "babylonjs/Meshes/Builders/polygonBuilder" {
  69062. import { Scene } from "babylonjs/scene";
  69063. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  69064. import { Color4 } from "babylonjs/Maths/math.color";
  69065. import { Mesh } from "babylonjs/Meshes/mesh";
  69066. import { Nullable } from "babylonjs/types";
  69067. /**
  69068. * Class containing static functions to help procedurally build meshes
  69069. */
  69070. export class PolygonBuilder {
  69071. /**
  69072. * Creates a polygon mesh
  69073. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  69074. * * 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
  69075. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  69076. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69077. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  69078. * * Remember you can only change the shape positions, not their number when updating a polygon
  69079. * @param name defines the name of the mesh
  69080. * @param options defines the options used to create the mesh
  69081. * @param scene defines the hosting scene
  69082. * @param earcutInjection can be used to inject your own earcut reference
  69083. * @returns the polygon mesh
  69084. */
  69085. static CreatePolygon(name: string, options: {
  69086. shape: Vector3[];
  69087. holes?: Vector3[][];
  69088. depth?: number;
  69089. faceUV?: Vector4[];
  69090. faceColors?: Color4[];
  69091. updatable?: boolean;
  69092. sideOrientation?: number;
  69093. frontUVs?: Vector4;
  69094. backUVs?: Vector4;
  69095. wrap?: boolean;
  69096. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69097. /**
  69098. * Creates an extruded polygon mesh, with depth in the Y direction.
  69099. * * 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)
  69100. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69101. * @param name defines the name of the mesh
  69102. * @param options defines the options used to create the mesh
  69103. * @param scene defines the hosting scene
  69104. * @param earcutInjection can be used to inject your own earcut reference
  69105. * @returns the polygon mesh
  69106. */
  69107. static ExtrudePolygon(name: string, options: {
  69108. shape: Vector3[];
  69109. holes?: Vector3[][];
  69110. depth?: number;
  69111. faceUV?: Vector4[];
  69112. faceColors?: Color4[];
  69113. updatable?: boolean;
  69114. sideOrientation?: number;
  69115. frontUVs?: Vector4;
  69116. backUVs?: Vector4;
  69117. wrap?: boolean;
  69118. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69119. }
  69120. }
  69121. declare module "babylonjs/Meshes/Builders/latheBuilder" {
  69122. import { Scene } from "babylonjs/scene";
  69123. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  69124. import { Mesh } from "babylonjs/Meshes/mesh";
  69125. import { Nullable } from "babylonjs/types";
  69126. /**
  69127. * Class containing static functions to help procedurally build meshes
  69128. */
  69129. export class LatheBuilder {
  69130. /**
  69131. * Creates lathe mesh.
  69132. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  69133. * * 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
  69134. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  69135. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  69136. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  69137. * * 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
  69138. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  69139. * * 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
  69140. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69141. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69142. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69143. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69144. * @param name defines the name of the mesh
  69145. * @param options defines the options used to create the mesh
  69146. * @param scene defines the hosting scene
  69147. * @returns the lathe mesh
  69148. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  69149. */
  69150. static CreateLathe(name: string, options: {
  69151. shape: Vector3[];
  69152. radius?: number;
  69153. tessellation?: number;
  69154. clip?: number;
  69155. arc?: number;
  69156. closed?: boolean;
  69157. updatable?: boolean;
  69158. sideOrientation?: number;
  69159. frontUVs?: Vector4;
  69160. backUVs?: Vector4;
  69161. cap?: number;
  69162. invertUV?: boolean;
  69163. }, scene?: Nullable<Scene>): Mesh;
  69164. }
  69165. }
  69166. declare module "babylonjs/Meshes/Builders/tiledPlaneBuilder" {
  69167. import { Nullable } from "babylonjs/types";
  69168. import { Scene } from "babylonjs/scene";
  69169. import { Vector4 } from "babylonjs/Maths/math.vector";
  69170. import { Mesh } from "babylonjs/Meshes/mesh";
  69171. /**
  69172. * Class containing static functions to help procedurally build meshes
  69173. */
  69174. export class TiledPlaneBuilder {
  69175. /**
  69176. * Creates a tiled plane mesh
  69177. * * The parameter `pattern` will, depending on value, do nothing or
  69178. * * * flip (reflect about central vertical) alternate tiles across and up
  69179. * * * flip every tile on alternate rows
  69180. * * * rotate (180 degs) alternate tiles across and up
  69181. * * * rotate every tile on alternate rows
  69182. * * * flip and rotate alternate tiles across and up
  69183. * * * flip and rotate every tile on alternate rows
  69184. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  69185. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  69186. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69187. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  69188. * * 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)
  69189. * * 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)
  69190. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  69191. * @param name defines the name of the mesh
  69192. * @param options defines the options used to create the mesh
  69193. * @param scene defines the hosting scene
  69194. * @returns the box mesh
  69195. */
  69196. static CreateTiledPlane(name: string, options: {
  69197. pattern?: number;
  69198. tileSize?: number;
  69199. tileWidth?: number;
  69200. tileHeight?: number;
  69201. size?: number;
  69202. width?: number;
  69203. height?: number;
  69204. alignHorizontal?: number;
  69205. alignVertical?: number;
  69206. sideOrientation?: number;
  69207. frontUVs?: Vector4;
  69208. backUVs?: Vector4;
  69209. updatable?: boolean;
  69210. }, scene?: Nullable<Scene>): Mesh;
  69211. }
  69212. }
  69213. declare module "babylonjs/Meshes/Builders/tubeBuilder" {
  69214. import { Nullable } from "babylonjs/types";
  69215. import { Scene } from "babylonjs/scene";
  69216. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  69217. import { Mesh } from "babylonjs/Meshes/mesh";
  69218. /**
  69219. * Class containing static functions to help procedurally build meshes
  69220. */
  69221. export class TubeBuilder {
  69222. /**
  69223. * Creates a tube mesh.
  69224. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69225. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  69226. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  69227. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  69228. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  69229. * * 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)
  69230. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  69231. * * 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
  69232. * * 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
  69233. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69234. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69235. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69236. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69237. * @param name defines the name of the mesh
  69238. * @param options defines the options used to create the mesh
  69239. * @param scene defines the hosting scene
  69240. * @returns the tube mesh
  69241. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69242. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  69243. */
  69244. static CreateTube(name: string, options: {
  69245. path: Vector3[];
  69246. radius?: number;
  69247. tessellation?: number;
  69248. radiusFunction?: {
  69249. (i: number, distance: number): number;
  69250. };
  69251. cap?: number;
  69252. arc?: number;
  69253. updatable?: boolean;
  69254. sideOrientation?: number;
  69255. frontUVs?: Vector4;
  69256. backUVs?: Vector4;
  69257. instance?: Mesh;
  69258. invertUV?: boolean;
  69259. }, scene?: Nullable<Scene>): Mesh;
  69260. }
  69261. }
  69262. declare module "babylonjs/Meshes/Builders/icoSphereBuilder" {
  69263. import { Scene } from "babylonjs/scene";
  69264. import { Vector4 } from "babylonjs/Maths/math.vector";
  69265. import { Mesh } from "babylonjs/Meshes/mesh";
  69266. import { Nullable } from "babylonjs/types";
  69267. /**
  69268. * Class containing static functions to help procedurally build meshes
  69269. */
  69270. export class IcoSphereBuilder {
  69271. /**
  69272. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  69273. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  69274. * * 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`)
  69275. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  69276. * * 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
  69277. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69278. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69279. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69280. * @param name defines the name of the mesh
  69281. * @param options defines the options used to create the mesh
  69282. * @param scene defines the hosting scene
  69283. * @returns the icosahedron mesh
  69284. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  69285. */
  69286. static CreateIcoSphere(name: string, options: {
  69287. radius?: number;
  69288. radiusX?: number;
  69289. radiusY?: number;
  69290. radiusZ?: number;
  69291. flat?: boolean;
  69292. subdivisions?: number;
  69293. sideOrientation?: number;
  69294. frontUVs?: Vector4;
  69295. backUVs?: Vector4;
  69296. updatable?: boolean;
  69297. }, scene?: Nullable<Scene>): Mesh;
  69298. }
  69299. }
  69300. declare module "babylonjs/Meshes/Builders/decalBuilder" {
  69301. import { Vector3 } from "babylonjs/Maths/math.vector";
  69302. import { Mesh } from "babylonjs/Meshes/mesh";
  69303. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69304. /**
  69305. * Class containing static functions to help procedurally build meshes
  69306. */
  69307. export class DecalBuilder {
  69308. /**
  69309. * Creates a decal mesh.
  69310. * 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
  69311. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69312. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69313. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69314. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69315. * @param name defines the name of the mesh
  69316. * @param sourceMesh defines the mesh where the decal must be applied
  69317. * @param options defines the options used to create the mesh
  69318. * @param scene defines the hosting scene
  69319. * @returns the decal mesh
  69320. * @see https://doc.babylonjs.com/how_to/decals
  69321. */
  69322. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69323. position?: Vector3;
  69324. normal?: Vector3;
  69325. size?: Vector3;
  69326. angle?: number;
  69327. }): Mesh;
  69328. }
  69329. }
  69330. declare module "babylonjs/Meshes/meshBuilder" {
  69331. import { ICreateCapsuleOptions } from "babylonjs/Meshes/Builders/capsuleBuilder";
  69332. import { Vector4, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  69333. import { Nullable } from "babylonjs/types";
  69334. import { Scene } from "babylonjs/scene";
  69335. import { Mesh } from "babylonjs/Meshes/mesh";
  69336. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  69337. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  69338. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69339. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  69340. import { Plane } from "babylonjs/Maths/math.plane";
  69341. /**
  69342. * Class containing static functions to help procedurally build meshes
  69343. */
  69344. export class MeshBuilder {
  69345. /**
  69346. * Creates a box mesh
  69347. * * The parameter `size` sets the size (float) of each box side (default 1)
  69348. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  69349. * * 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)
  69350. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69351. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69352. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69353. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69354. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  69355. * @param name defines the name of the mesh
  69356. * @param options defines the options used to create the mesh
  69357. * @param scene defines the hosting scene
  69358. * @returns the box mesh
  69359. */
  69360. static CreateBox(name: string, options: {
  69361. size?: number;
  69362. width?: number;
  69363. height?: number;
  69364. depth?: number;
  69365. faceUV?: Vector4[];
  69366. faceColors?: Color4[];
  69367. sideOrientation?: number;
  69368. frontUVs?: Vector4;
  69369. backUVs?: Vector4;
  69370. wrap?: boolean;
  69371. topBaseAt?: number;
  69372. bottomBaseAt?: number;
  69373. updatable?: boolean;
  69374. }, scene?: Nullable<Scene>): Mesh;
  69375. /**
  69376. * Creates a tiled box mesh
  69377. * * faceTiles sets the pattern, tile size and number of tiles for a face
  69378. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69379. * @param name defines the name of the mesh
  69380. * @param options defines the options used to create the mesh
  69381. * @param scene defines the hosting scene
  69382. * @returns the tiled box mesh
  69383. */
  69384. static CreateTiledBox(name: string, options: {
  69385. pattern?: number;
  69386. size?: number;
  69387. width?: number;
  69388. height?: number;
  69389. depth: number;
  69390. tileSize?: number;
  69391. tileWidth?: number;
  69392. tileHeight?: number;
  69393. faceUV?: Vector4[];
  69394. faceColors?: Color4[];
  69395. alignHorizontal?: number;
  69396. alignVertical?: number;
  69397. sideOrientation?: number;
  69398. updatable?: boolean;
  69399. }, scene?: Nullable<Scene>): Mesh;
  69400. /**
  69401. * Creates a sphere mesh
  69402. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  69403. * * 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`)
  69404. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  69405. * * 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
  69406. * * 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)
  69407. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69408. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69409. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69410. * @param name defines the name of the mesh
  69411. * @param options defines the options used to create the mesh
  69412. * @param scene defines the hosting scene
  69413. * @returns the sphere mesh
  69414. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  69415. */
  69416. static CreateSphere(name: string, options: {
  69417. segments?: number;
  69418. diameter?: number;
  69419. diameterX?: number;
  69420. diameterY?: number;
  69421. diameterZ?: number;
  69422. arc?: number;
  69423. slice?: number;
  69424. sideOrientation?: number;
  69425. frontUVs?: Vector4;
  69426. backUVs?: Vector4;
  69427. updatable?: boolean;
  69428. }, scene?: Nullable<Scene>): Mesh;
  69429. /**
  69430. * Creates a plane polygonal mesh. By default, this is a disc
  69431. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  69432. * * 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
  69433. * * 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
  69434. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69435. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69436. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69437. * @param name defines the name of the mesh
  69438. * @param options defines the options used to create the mesh
  69439. * @param scene defines the hosting scene
  69440. * @returns the plane polygonal mesh
  69441. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  69442. */
  69443. static CreateDisc(name: string, options: {
  69444. radius?: number;
  69445. tessellation?: number;
  69446. arc?: number;
  69447. updatable?: boolean;
  69448. sideOrientation?: number;
  69449. frontUVs?: Vector4;
  69450. backUVs?: Vector4;
  69451. }, scene?: Nullable<Scene>): Mesh;
  69452. /**
  69453. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  69454. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  69455. * * 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`)
  69456. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  69457. * * 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
  69458. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69459. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69460. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69461. * @param name defines the name of the mesh
  69462. * @param options defines the options used to create the mesh
  69463. * @param scene defines the hosting scene
  69464. * @returns the icosahedron mesh
  69465. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  69466. */
  69467. static CreateIcoSphere(name: string, options: {
  69468. radius?: number;
  69469. radiusX?: number;
  69470. radiusY?: number;
  69471. radiusZ?: number;
  69472. flat?: boolean;
  69473. subdivisions?: number;
  69474. sideOrientation?: number;
  69475. frontUVs?: Vector4;
  69476. backUVs?: Vector4;
  69477. updatable?: boolean;
  69478. }, scene?: Nullable<Scene>): Mesh;
  69479. /**
  69480. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69481. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  69482. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  69483. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  69484. * * 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
  69485. * * 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
  69486. * * 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
  69487. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69488. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69489. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69490. * * 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
  69491. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  69492. * * 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
  69493. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  69494. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69495. * @param name defines the name of the mesh
  69496. * @param options defines the options used to create the mesh
  69497. * @param scene defines the hosting scene
  69498. * @returns the ribbon mesh
  69499. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  69500. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69501. */
  69502. static CreateRibbon(name: string, options: {
  69503. pathArray: Vector3[][];
  69504. closeArray?: boolean;
  69505. closePath?: boolean;
  69506. offset?: number;
  69507. updatable?: boolean;
  69508. sideOrientation?: number;
  69509. frontUVs?: Vector4;
  69510. backUVs?: Vector4;
  69511. instance?: Mesh;
  69512. invertUV?: boolean;
  69513. uvs?: Vector2[];
  69514. colors?: Color4[];
  69515. }, scene?: Nullable<Scene>): Mesh;
  69516. /**
  69517. * Creates a cylinder or a cone mesh
  69518. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  69519. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  69520. * * 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.
  69521. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  69522. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  69523. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  69524. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  69525. * * 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).
  69526. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  69527. * * 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).
  69528. * * 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
  69529. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  69530. * * 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
  69531. * * 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.
  69532. * * If `enclose` is false, a ring surface is one element.
  69533. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  69534. * * 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
  69535. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69536. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69537. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69538. * @param name defines the name of the mesh
  69539. * @param options defines the options used to create the mesh
  69540. * @param scene defines the hosting scene
  69541. * @returns the cylinder mesh
  69542. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  69543. */
  69544. static CreateCylinder(name: string, options: {
  69545. height?: number;
  69546. diameterTop?: number;
  69547. diameterBottom?: number;
  69548. diameter?: number;
  69549. tessellation?: number;
  69550. subdivisions?: number;
  69551. arc?: number;
  69552. faceColors?: Color4[];
  69553. faceUV?: Vector4[];
  69554. updatable?: boolean;
  69555. hasRings?: boolean;
  69556. enclose?: boolean;
  69557. cap?: number;
  69558. sideOrientation?: number;
  69559. frontUVs?: Vector4;
  69560. backUVs?: Vector4;
  69561. }, scene?: Nullable<Scene>): Mesh;
  69562. /**
  69563. * Creates a torus mesh
  69564. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  69565. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  69566. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  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 mesh
  69574. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  69575. */
  69576. static CreateTorus(name: string, options: {
  69577. diameter?: number;
  69578. thickness?: number;
  69579. tessellation?: number;
  69580. updatable?: boolean;
  69581. sideOrientation?: number;
  69582. frontUVs?: Vector4;
  69583. backUVs?: Vector4;
  69584. }, scene?: Nullable<Scene>): Mesh;
  69585. /**
  69586. * Creates a torus knot mesh
  69587. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  69588. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  69589. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  69590. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  69591. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69592. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69593. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69594. * @param name defines the name of the mesh
  69595. * @param options defines the options used to create the mesh
  69596. * @param scene defines the hosting scene
  69597. * @returns the torus knot mesh
  69598. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  69599. */
  69600. static CreateTorusKnot(name: string, options: {
  69601. radius?: number;
  69602. tube?: number;
  69603. radialSegments?: number;
  69604. tubularSegments?: number;
  69605. p?: number;
  69606. q?: number;
  69607. updatable?: boolean;
  69608. sideOrientation?: number;
  69609. frontUVs?: Vector4;
  69610. backUVs?: Vector4;
  69611. }, scene?: Nullable<Scene>): Mesh;
  69612. /**
  69613. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  69614. * * 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
  69615. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  69616. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  69617. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  69618. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  69619. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  69620. * * 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
  69621. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  69622. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69623. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  69624. * @param name defines the name of the new line system
  69625. * @param options defines the options used to create the line system
  69626. * @param scene defines the hosting scene
  69627. * @returns a new line system mesh
  69628. */
  69629. static CreateLineSystem(name: string, options: {
  69630. lines: Vector3[][];
  69631. updatable?: boolean;
  69632. instance?: Nullable<LinesMesh>;
  69633. colors?: Nullable<Color4[][]>;
  69634. useVertexAlpha?: boolean;
  69635. }, scene: Nullable<Scene>): LinesMesh;
  69636. /**
  69637. * Creates a line mesh
  69638. * 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
  69639. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  69640. * * The parameter `points` is an array successive Vector3
  69641. * * 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
  69642. * * The optional parameter `colors` is an array of successive Color4, one per line point
  69643. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  69644. * * When updating an instance, remember that only point positions can change, not the number of points
  69645. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69646. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  69647. * @param name defines the name of the new line system
  69648. * @param options defines the options used to create the line system
  69649. * @param scene defines the hosting scene
  69650. * @returns a new line mesh
  69651. */
  69652. static CreateLines(name: string, options: {
  69653. points: Vector3[];
  69654. updatable?: boolean;
  69655. instance?: Nullable<LinesMesh>;
  69656. colors?: Color4[];
  69657. useVertexAlpha?: boolean;
  69658. }, scene?: Nullable<Scene>): LinesMesh;
  69659. /**
  69660. * Creates a dashed line mesh
  69661. * * 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
  69662. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  69663. * * The parameter `points` is an array successive Vector3
  69664. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  69665. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  69666. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  69667. * * 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
  69668. * * When updating an instance, remember that only point positions can change, not the number of points
  69669. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69670. * @param name defines the name of the mesh
  69671. * @param options defines the options used to create the mesh
  69672. * @param scene defines the hosting scene
  69673. * @returns the dashed line mesh
  69674. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  69675. */
  69676. static CreateDashedLines(name: string, options: {
  69677. points: Vector3[];
  69678. dashSize?: number;
  69679. gapSize?: number;
  69680. dashNb?: number;
  69681. updatable?: boolean;
  69682. instance?: LinesMesh;
  69683. }, scene?: Nullable<Scene>): LinesMesh;
  69684. /**
  69685. * 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.
  69686. * * 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.
  69687. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69688. * * 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.
  69689. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  69690. * * 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
  69691. * * 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
  69692. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  69693. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69694. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69695. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  69696. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69697. * @param name defines the name of the mesh
  69698. * @param options defines the options used to create the mesh
  69699. * @param scene defines the hosting scene
  69700. * @returns the extruded shape mesh
  69701. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69702. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69703. */
  69704. static ExtrudeShape(name: string, options: {
  69705. shape: Vector3[];
  69706. path: Vector3[];
  69707. scale?: number;
  69708. rotation?: number;
  69709. cap?: number;
  69710. updatable?: boolean;
  69711. sideOrientation?: number;
  69712. frontUVs?: Vector4;
  69713. backUVs?: Vector4;
  69714. instance?: Mesh;
  69715. invertUV?: boolean;
  69716. }, scene?: Nullable<Scene>): Mesh;
  69717. /**
  69718. * Creates an custom extruded shape mesh.
  69719. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  69720. * * 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.
  69721. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69722. * * 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
  69723. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  69724. * * 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
  69725. * * It must returns a float value that will be the scale value applied to the shape on each path point
  69726. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  69727. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  69728. * * 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
  69729. * * 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
  69730. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  69731. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69732. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69733. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69734. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69735. * @param name defines the name of the mesh
  69736. * @param options defines the options used to create the mesh
  69737. * @param scene defines the hosting scene
  69738. * @returns the custom extruded shape mesh
  69739. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  69740. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69741. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69742. */
  69743. static ExtrudeShapeCustom(name: string, options: {
  69744. shape: Vector3[];
  69745. path: Vector3[];
  69746. scaleFunction?: any;
  69747. rotationFunction?: any;
  69748. ribbonCloseArray?: boolean;
  69749. ribbonClosePath?: boolean;
  69750. cap?: number;
  69751. updatable?: boolean;
  69752. sideOrientation?: number;
  69753. frontUVs?: Vector4;
  69754. backUVs?: Vector4;
  69755. instance?: Mesh;
  69756. invertUV?: boolean;
  69757. }, scene?: Nullable<Scene>): Mesh;
  69758. /**
  69759. * Creates lathe mesh.
  69760. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  69761. * * 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
  69762. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  69763. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  69764. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  69765. * * 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
  69766. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  69767. * * 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
  69768. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69769. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69770. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69771. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69772. * @param name defines the name of the mesh
  69773. * @param options defines the options used to create the mesh
  69774. * @param scene defines the hosting scene
  69775. * @returns the lathe mesh
  69776. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  69777. */
  69778. static CreateLathe(name: string, options: {
  69779. shape: Vector3[];
  69780. radius?: number;
  69781. tessellation?: number;
  69782. clip?: number;
  69783. arc?: number;
  69784. closed?: boolean;
  69785. updatable?: boolean;
  69786. sideOrientation?: number;
  69787. frontUVs?: Vector4;
  69788. backUVs?: Vector4;
  69789. cap?: number;
  69790. invertUV?: boolean;
  69791. }, scene?: Nullable<Scene>): Mesh;
  69792. /**
  69793. * Creates a tiled plane mesh
  69794. * * You can set a limited pattern arrangement with the tiles
  69795. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69796. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69797. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69798. * @param name defines the name of the mesh
  69799. * @param options defines the options used to create the mesh
  69800. * @param scene defines the hosting scene
  69801. * @returns the plane mesh
  69802. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69803. */
  69804. static CreateTiledPlane(name: string, options: {
  69805. pattern?: number;
  69806. tileSize?: number;
  69807. tileWidth?: number;
  69808. tileHeight?: number;
  69809. size?: number;
  69810. width?: number;
  69811. height?: number;
  69812. alignHorizontal?: number;
  69813. alignVertical?: number;
  69814. sideOrientation?: number;
  69815. frontUVs?: Vector4;
  69816. backUVs?: Vector4;
  69817. updatable?: boolean;
  69818. }, scene?: Nullable<Scene>): Mesh;
  69819. /**
  69820. * Creates a plane mesh
  69821. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  69822. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  69823. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  69824. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69825. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69826. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69827. * @param name defines the name of the mesh
  69828. * @param options defines the options used to create the mesh
  69829. * @param scene defines the hosting scene
  69830. * @returns the plane mesh
  69831. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69832. */
  69833. static CreatePlane(name: string, options: {
  69834. size?: number;
  69835. width?: number;
  69836. height?: number;
  69837. sideOrientation?: number;
  69838. frontUVs?: Vector4;
  69839. backUVs?: Vector4;
  69840. updatable?: boolean;
  69841. sourcePlane?: Plane;
  69842. }, scene?: Nullable<Scene>): Mesh;
  69843. /**
  69844. * Creates a ground mesh
  69845. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  69846. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  69847. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69848. * @param name defines the name of the mesh
  69849. * @param options defines the options used to create the mesh
  69850. * @param scene defines the hosting scene
  69851. * @returns the ground mesh
  69852. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  69853. */
  69854. static CreateGround(name: string, options: {
  69855. width?: number;
  69856. height?: number;
  69857. subdivisions?: number;
  69858. subdivisionsX?: number;
  69859. subdivisionsY?: number;
  69860. updatable?: boolean;
  69861. }, scene?: Nullable<Scene>): Mesh;
  69862. /**
  69863. * Creates a tiled ground mesh
  69864. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  69865. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  69866. * * 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
  69867. * * 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
  69868. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69869. * @param name defines the name of the mesh
  69870. * @param options defines the options used to create the mesh
  69871. * @param scene defines the hosting scene
  69872. * @returns the tiled ground mesh
  69873. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  69874. */
  69875. static CreateTiledGround(name: string, options: {
  69876. xmin: number;
  69877. zmin: number;
  69878. xmax: number;
  69879. zmax: number;
  69880. subdivisions?: {
  69881. w: number;
  69882. h: number;
  69883. };
  69884. precision?: {
  69885. w: number;
  69886. h: number;
  69887. };
  69888. updatable?: boolean;
  69889. }, scene?: Nullable<Scene>): Mesh;
  69890. /**
  69891. * Creates a ground mesh from a height map
  69892. * * The parameter `url` sets the URL of the height map image resource.
  69893. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  69894. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  69895. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  69896. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  69897. * * 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.
  69898. * * 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).
  69899. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  69900. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69901. * @param name defines the name of the mesh
  69902. * @param url defines the url to the height map
  69903. * @param options defines the options used to create the mesh
  69904. * @param scene defines the hosting scene
  69905. * @returns the ground mesh
  69906. * @see https://doc.babylonjs.com/babylon101/height_map
  69907. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  69908. */
  69909. static CreateGroundFromHeightMap(name: string, url: string, options: {
  69910. width?: number;
  69911. height?: number;
  69912. subdivisions?: number;
  69913. minHeight?: number;
  69914. maxHeight?: number;
  69915. colorFilter?: Color3;
  69916. alphaFilter?: number;
  69917. updatable?: boolean;
  69918. onReady?: (mesh: GroundMesh) => void;
  69919. }, scene?: Nullable<Scene>): GroundMesh;
  69920. /**
  69921. * Creates a polygon mesh
  69922. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  69923. * * 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
  69924. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  69925. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69926. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  69927. * * Remember you can only change the shape positions, not their number when updating a polygon
  69928. * @param name defines the name of the mesh
  69929. * @param options defines the options used to create the mesh
  69930. * @param scene defines the hosting scene
  69931. * @param earcutInjection can be used to inject your own earcut reference
  69932. * @returns the polygon mesh
  69933. */
  69934. static CreatePolygon(name: string, options: {
  69935. shape: Vector3[];
  69936. holes?: Vector3[][];
  69937. depth?: number;
  69938. faceUV?: Vector4[];
  69939. faceColors?: Color4[];
  69940. updatable?: boolean;
  69941. sideOrientation?: number;
  69942. frontUVs?: Vector4;
  69943. backUVs?: Vector4;
  69944. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69945. /**
  69946. * Creates an extruded polygon mesh, with depth in the Y direction.
  69947. * * 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)
  69948. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69949. * @param name defines the name of the mesh
  69950. * @param options defines the options used to create the mesh
  69951. * @param scene defines the hosting scene
  69952. * @param earcutInjection can be used to inject your own earcut reference
  69953. * @returns the polygon mesh
  69954. */
  69955. static ExtrudePolygon(name: string, options: {
  69956. shape: Vector3[];
  69957. holes?: Vector3[][];
  69958. depth?: number;
  69959. faceUV?: Vector4[];
  69960. faceColors?: Color4[];
  69961. updatable?: boolean;
  69962. sideOrientation?: number;
  69963. frontUVs?: Vector4;
  69964. backUVs?: Vector4;
  69965. wrap?: boolean;
  69966. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69967. /**
  69968. * Creates a tube mesh.
  69969. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69970. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  69971. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  69972. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  69973. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  69974. * * 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)
  69975. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  69976. * * 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
  69977. * * 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
  69978. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69979. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69980. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69981. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69982. * @param name defines the name of the mesh
  69983. * @param options defines the options used to create the mesh
  69984. * @param scene defines the hosting scene
  69985. * @returns the tube mesh
  69986. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69987. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  69988. */
  69989. static CreateTube(name: string, options: {
  69990. path: Vector3[];
  69991. radius?: number;
  69992. tessellation?: number;
  69993. radiusFunction?: {
  69994. (i: number, distance: number): number;
  69995. };
  69996. cap?: number;
  69997. arc?: number;
  69998. updatable?: boolean;
  69999. sideOrientation?: number;
  70000. frontUVs?: Vector4;
  70001. backUVs?: Vector4;
  70002. instance?: Mesh;
  70003. invertUV?: boolean;
  70004. }, scene?: Nullable<Scene>): Mesh;
  70005. /**
  70006. * Creates a polyhedron mesh
  70007. * * 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
  70008. * * The parameter `size` (positive float, default 1) sets the polygon size
  70009. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  70010. * * 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`
  70011. * * 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
  70012. * * 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)`)
  70013. * * 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
  70014. * * 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
  70015. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  70016. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  70017. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  70018. * @param name defines the name of the mesh
  70019. * @param options defines the options used to create the mesh
  70020. * @param scene defines the hosting scene
  70021. * @returns the polyhedron mesh
  70022. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  70023. */
  70024. static CreatePolyhedron(name: string, options: {
  70025. type?: number;
  70026. size?: number;
  70027. sizeX?: number;
  70028. sizeY?: number;
  70029. sizeZ?: number;
  70030. custom?: any;
  70031. faceUV?: Vector4[];
  70032. faceColors?: Color4[];
  70033. flat?: boolean;
  70034. updatable?: boolean;
  70035. sideOrientation?: number;
  70036. frontUVs?: Vector4;
  70037. backUVs?: Vector4;
  70038. }, scene?: Nullable<Scene>): Mesh;
  70039. /**
  70040. * Creates a decal mesh.
  70041. * 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
  70042. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  70043. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  70044. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  70045. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  70046. * @param name defines the name of the mesh
  70047. * @param sourceMesh defines the mesh where the decal must be applied
  70048. * @param options defines the options used to create the mesh
  70049. * @param scene defines the hosting scene
  70050. * @returns the decal mesh
  70051. * @see https://doc.babylonjs.com/how_to/decals
  70052. */
  70053. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  70054. position?: Vector3;
  70055. normal?: Vector3;
  70056. size?: Vector3;
  70057. angle?: number;
  70058. }): Mesh;
  70059. /**
  70060. * Creates a Capsule Mesh
  70061. * @param name defines the name of the mesh.
  70062. * @param options the constructors options used to shape the mesh.
  70063. * @param scene defines the scene the mesh is scoped to.
  70064. * @returns the capsule mesh
  70065. * @see https://doc.babylonjs.com/how_to/capsule_shape
  70066. */
  70067. static CreateCapsule(name: string, options?: ICreateCapsuleOptions, scene?: Nullable<Scene>): Mesh;
  70068. }
  70069. }
  70070. declare module "babylonjs/Meshes/meshSimplification" {
  70071. import { Mesh } from "babylonjs/Meshes/mesh";
  70072. /**
  70073. * A simplifier interface for future simplification implementations
  70074. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70075. */
  70076. export interface ISimplifier {
  70077. /**
  70078. * Simplification of a given mesh according to the given settings.
  70079. * Since this requires computation, it is assumed that the function runs async.
  70080. * @param settings The settings of the simplification, including quality and distance
  70081. * @param successCallback A callback that will be called after the mesh was simplified.
  70082. * @param errorCallback in case of an error, this callback will be called. optional.
  70083. */
  70084. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  70085. }
  70086. /**
  70087. * Expected simplification settings.
  70088. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  70089. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70090. */
  70091. export interface ISimplificationSettings {
  70092. /**
  70093. * Gets or sets the expected quality
  70094. */
  70095. quality: number;
  70096. /**
  70097. * Gets or sets the distance when this optimized version should be used
  70098. */
  70099. distance: number;
  70100. /**
  70101. * Gets an already optimized mesh
  70102. */
  70103. optimizeMesh?: boolean;
  70104. }
  70105. /**
  70106. * Class used to specify simplification options
  70107. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70108. */
  70109. export class SimplificationSettings implements ISimplificationSettings {
  70110. /** expected quality */
  70111. quality: number;
  70112. /** distance when this optimized version should be used */
  70113. distance: number;
  70114. /** already optimized mesh */
  70115. optimizeMesh?: boolean | undefined;
  70116. /**
  70117. * Creates a SimplificationSettings
  70118. * @param quality expected quality
  70119. * @param distance distance when this optimized version should be used
  70120. * @param optimizeMesh already optimized mesh
  70121. */
  70122. constructor(
  70123. /** expected quality */
  70124. quality: number,
  70125. /** distance when this optimized version should be used */
  70126. distance: number,
  70127. /** already optimized mesh */
  70128. optimizeMesh?: boolean | undefined);
  70129. }
  70130. /**
  70131. * Interface used to define a simplification task
  70132. */
  70133. export interface ISimplificationTask {
  70134. /**
  70135. * Array of settings
  70136. */
  70137. settings: Array<ISimplificationSettings>;
  70138. /**
  70139. * Simplification type
  70140. */
  70141. simplificationType: SimplificationType;
  70142. /**
  70143. * Mesh to simplify
  70144. */
  70145. mesh: Mesh;
  70146. /**
  70147. * Callback called on success
  70148. */
  70149. successCallback?: () => void;
  70150. /**
  70151. * Defines if parallel processing can be used
  70152. */
  70153. parallelProcessing: boolean;
  70154. }
  70155. /**
  70156. * Queue used to order the simplification tasks
  70157. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70158. */
  70159. export class SimplificationQueue {
  70160. private _simplificationArray;
  70161. /**
  70162. * Gets a boolean indicating that the process is still running
  70163. */
  70164. running: boolean;
  70165. /**
  70166. * Creates a new queue
  70167. */
  70168. constructor();
  70169. /**
  70170. * Adds a new simplification task
  70171. * @param task defines a task to add
  70172. */
  70173. addTask(task: ISimplificationTask): void;
  70174. /**
  70175. * Execute next task
  70176. */
  70177. executeNext(): void;
  70178. /**
  70179. * Execute a simplification task
  70180. * @param task defines the task to run
  70181. */
  70182. runSimplification(task: ISimplificationTask): void;
  70183. private getSimplifier;
  70184. }
  70185. /**
  70186. * The implemented types of simplification
  70187. * At the moment only Quadratic Error Decimation is implemented
  70188. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70189. */
  70190. export enum SimplificationType {
  70191. /** Quadratic error decimation */
  70192. QUADRATIC = 0
  70193. }
  70194. /**
  70195. * An implementation of the Quadratic Error simplification algorithm.
  70196. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  70197. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  70198. * @author RaananW
  70199. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70200. */
  70201. export class QuadraticErrorSimplification implements ISimplifier {
  70202. private _mesh;
  70203. private triangles;
  70204. private vertices;
  70205. private references;
  70206. private _reconstructedMesh;
  70207. /** Gets or sets the number pf sync interations */
  70208. syncIterations: number;
  70209. /** Gets or sets the aggressiveness of the simplifier */
  70210. aggressiveness: number;
  70211. /** Gets or sets the number of allowed iterations for decimation */
  70212. decimationIterations: number;
  70213. /** Gets or sets the espilon to use for bounding box computation */
  70214. boundingBoxEpsilon: number;
  70215. /**
  70216. * Creates a new QuadraticErrorSimplification
  70217. * @param _mesh defines the target mesh
  70218. */
  70219. constructor(_mesh: Mesh);
  70220. /**
  70221. * Simplification of a given mesh according to the given settings.
  70222. * Since this requires computation, it is assumed that the function runs async.
  70223. * @param settings The settings of the simplification, including quality and distance
  70224. * @param successCallback A callback that will be called after the mesh was simplified.
  70225. */
  70226. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  70227. private runDecimation;
  70228. private initWithMesh;
  70229. private init;
  70230. private reconstructMesh;
  70231. private initDecimatedMesh;
  70232. private isFlipped;
  70233. private updateTriangles;
  70234. private identifyBorder;
  70235. private updateMesh;
  70236. private vertexError;
  70237. private calculateError;
  70238. }
  70239. }
  70240. declare module "babylonjs/Meshes/meshSimplificationSceneComponent" {
  70241. import { Scene } from "babylonjs/scene";
  70242. import { SimplificationQueue, ISimplificationSettings, SimplificationType } from "babylonjs/Meshes/meshSimplification";
  70243. import { ISceneComponent } from "babylonjs/sceneComponent";
  70244. module "babylonjs/scene" {
  70245. interface Scene {
  70246. /** @hidden (Backing field) */
  70247. _simplificationQueue: SimplificationQueue;
  70248. /**
  70249. * Gets or sets the simplification queue attached to the scene
  70250. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  70251. */
  70252. simplificationQueue: SimplificationQueue;
  70253. }
  70254. }
  70255. module "babylonjs/Meshes/mesh" {
  70256. interface Mesh {
  70257. /**
  70258. * Simplify the mesh according to the given array of settings.
  70259. * Function will return immediately and will simplify async
  70260. * @param settings a collection of simplification settings
  70261. * @param parallelProcessing should all levels calculate parallel or one after the other
  70262. * @param simplificationType the type of simplification to run
  70263. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  70264. * @returns the current mesh
  70265. */
  70266. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  70267. }
  70268. }
  70269. /**
  70270. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  70271. * created in a scene
  70272. */
  70273. export class SimplicationQueueSceneComponent implements ISceneComponent {
  70274. /**
  70275. * The component name helpfull to identify the component in the list of scene components.
  70276. */
  70277. readonly name: string;
  70278. /**
  70279. * The scene the component belongs to.
  70280. */
  70281. scene: Scene;
  70282. /**
  70283. * Creates a new instance of the component for the given scene
  70284. * @param scene Defines the scene to register the component in
  70285. */
  70286. constructor(scene: Scene);
  70287. /**
  70288. * Registers the component in a given scene
  70289. */
  70290. register(): void;
  70291. /**
  70292. * Rebuilds the elements related to this component in case of
  70293. * context lost for instance.
  70294. */
  70295. rebuild(): void;
  70296. /**
  70297. * Disposes the component and the associated ressources
  70298. */
  70299. dispose(): void;
  70300. private _beforeCameraUpdate;
  70301. }
  70302. }
  70303. declare module "babylonjs/Meshes/Builders/index" {
  70304. export * from "babylonjs/Meshes/Builders/boxBuilder";
  70305. export * from "babylonjs/Meshes/Builders/tiledBoxBuilder";
  70306. export * from "babylonjs/Meshes/Builders/discBuilder";
  70307. export * from "babylonjs/Meshes/Builders/ribbonBuilder";
  70308. export * from "babylonjs/Meshes/Builders/sphereBuilder";
  70309. export * from "babylonjs/Meshes/Builders/hemisphereBuilder";
  70310. export * from "babylonjs/Meshes/Builders/cylinderBuilder";
  70311. export * from "babylonjs/Meshes/Builders/torusBuilder";
  70312. export * from "babylonjs/Meshes/Builders/torusKnotBuilder";
  70313. export * from "babylonjs/Meshes/Builders/linesBuilder";
  70314. export * from "babylonjs/Meshes/Builders/polygonBuilder";
  70315. export * from "babylonjs/Meshes/Builders/shapeBuilder";
  70316. export * from "babylonjs/Meshes/Builders/latheBuilder";
  70317. export * from "babylonjs/Meshes/Builders/planeBuilder";
  70318. export * from "babylonjs/Meshes/Builders/tiledPlaneBuilder";
  70319. export * from "babylonjs/Meshes/Builders/groundBuilder";
  70320. export * from "babylonjs/Meshes/Builders/tubeBuilder";
  70321. export * from "babylonjs/Meshes/Builders/polyhedronBuilder";
  70322. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  70323. export * from "babylonjs/Meshes/Builders/decalBuilder";
  70324. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  70325. export * from "babylonjs/Meshes/Builders/capsuleBuilder";
  70326. }
  70327. declare module "babylonjs/Meshes/thinInstanceMesh" {
  70328. import { Nullable, DeepImmutableObject } from "babylonjs/types";
  70329. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  70330. import { Matrix } from "babylonjs/Maths/math.vector";
  70331. module "babylonjs/Meshes/mesh" {
  70332. interface Mesh {
  70333. /**
  70334. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  70335. */
  70336. thinInstanceEnablePicking: boolean;
  70337. /**
  70338. * Creates a new thin instance
  70339. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  70340. * @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
  70341. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  70342. */
  70343. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  70344. /**
  70345. * Adds the transformation (matrix) of the current mesh as a thin instance
  70346. * @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
  70347. * @returns the thin instance index number
  70348. */
  70349. thinInstanceAddSelf(refresh: boolean): number;
  70350. /**
  70351. * Registers a custom attribute to be used with thin instances
  70352. * @param kind name of the attribute
  70353. * @param stride size in floats of the attribute
  70354. */
  70355. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  70356. /**
  70357. * Sets the matrix of a thin instance
  70358. * @param index index of the thin instance
  70359. * @param matrix matrix to set
  70360. * @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
  70361. */
  70362. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  70363. /**
  70364. * Sets the value of a custom attribute for a thin instance
  70365. * @param kind name of the attribute
  70366. * @param index index of the thin instance
  70367. * @param value value to set
  70368. * @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
  70369. */
  70370. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  70371. /**
  70372. * 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.
  70373. */
  70374. thinInstanceCount: number;
  70375. /**
  70376. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  70377. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  70378. * @param buffer buffer to set
  70379. * @param stride size in floats of each value of the buffer
  70380. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  70381. */
  70382. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  70383. /**
  70384. * Gets the list of world matrices
  70385. * @return an array containing all the world matrices from the thin instances
  70386. */
  70387. thinInstanceGetWorldMatrices(): Matrix[];
  70388. /**
  70389. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  70390. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  70391. */
  70392. thinInstanceBufferUpdated(kind: string): void;
  70393. /**
  70394. * Applies a partial update to a buffer directly on the GPU
  70395. * 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
  70396. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  70397. * @param data the data to set in the GPU buffer
  70398. * @param offset the offset in the GPU buffer where to update the data
  70399. */
  70400. thinInstancePartialBufferUpdate(kind: string, data: Float32Array, offset: number): void;
  70401. /**
  70402. * Refreshes the bounding info, taking into account all the thin instances defined
  70403. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  70404. */
  70405. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  70406. /** @hidden */
  70407. _thinInstanceInitializeUserStorage(): void;
  70408. /** @hidden */
  70409. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  70410. /** @hidden */
  70411. _userThinInstanceBuffersStorage: {
  70412. data: {
  70413. [key: string]: Float32Array;
  70414. };
  70415. sizes: {
  70416. [key: string]: number;
  70417. };
  70418. vertexBuffers: {
  70419. [key: string]: Nullable<VertexBuffer>;
  70420. };
  70421. strides: {
  70422. [key: string]: number;
  70423. };
  70424. };
  70425. }
  70426. }
  70427. }
  70428. declare module "babylonjs/Meshes/index" {
  70429. export * from "babylonjs/Meshes/abstractMesh";
  70430. export * from "babylonjs/Meshes/buffer";
  70431. export * from "babylonjs/Meshes/Compression/index";
  70432. export * from "babylonjs/Meshes/csg";
  70433. export * from "babylonjs/Meshes/geometry";
  70434. export * from "babylonjs/Meshes/groundMesh";
  70435. export * from "babylonjs/Meshes/trailMesh";
  70436. export * from "babylonjs/Meshes/instancedMesh";
  70437. export * from "babylonjs/Meshes/linesMesh";
  70438. export * from "babylonjs/Meshes/mesh";
  70439. export * from "babylonjs/Meshes/mesh.vertexData";
  70440. export * from "babylonjs/Meshes/meshBuilder";
  70441. export * from "babylonjs/Meshes/meshSimplification";
  70442. export * from "babylonjs/Meshes/meshSimplificationSceneComponent";
  70443. export * from "babylonjs/Meshes/polygonMesh";
  70444. export * from "babylonjs/Meshes/subMesh";
  70445. export * from "babylonjs/Meshes/meshLODLevel";
  70446. export * from "babylonjs/Meshes/transformNode";
  70447. export * from "babylonjs/Meshes/Builders/index";
  70448. export * from "babylonjs/Meshes/dataBuffer";
  70449. export * from "babylonjs/Meshes/WebGL/webGLDataBuffer";
  70450. import "babylonjs/Meshes/thinInstanceMesh";
  70451. export * from "babylonjs/Meshes/thinInstanceMesh";
  70452. }
  70453. declare module "babylonjs/Morph/index" {
  70454. export * from "babylonjs/Morph/morphTarget";
  70455. export * from "babylonjs/Morph/morphTargetManager";
  70456. }
  70457. declare module "babylonjs/Navigation/INavigationEngine" {
  70458. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70459. import { Vector3 } from "babylonjs/Maths/math";
  70460. import { Mesh } from "babylonjs/Meshes/mesh";
  70461. import { Scene } from "babylonjs/scene";
  70462. /**
  70463. * Navigation plugin interface to add navigation constrained by a navigation mesh
  70464. */
  70465. export interface INavigationEnginePlugin {
  70466. /**
  70467. * plugin name
  70468. */
  70469. name: string;
  70470. /**
  70471. * Creates a navigation mesh
  70472. * @param meshes array of all the geometry used to compute the navigatio mesh
  70473. * @param parameters bunch of parameters used to filter geometry
  70474. */
  70475. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70476. /**
  70477. * Create a navigation mesh debug mesh
  70478. * @param scene is where the mesh will be added
  70479. * @returns debug display mesh
  70480. */
  70481. createDebugNavMesh(scene: Scene): Mesh;
  70482. /**
  70483. * Get a navigation mesh constrained position, closest to the parameter position
  70484. * @param position world position
  70485. * @returns the closest point to position constrained by the navigation mesh
  70486. */
  70487. getClosestPoint(position: Vector3): Vector3;
  70488. /**
  70489. * Get a navigation mesh constrained position, closest to the parameter position
  70490. * @param position world position
  70491. * @param result output the closest point to position constrained by the navigation mesh
  70492. */
  70493. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70494. /**
  70495. * Get a navigation mesh constrained position, within a particular radius
  70496. * @param position world position
  70497. * @param maxRadius the maximum distance to the constrained world position
  70498. * @returns the closest point to position constrained by the navigation mesh
  70499. */
  70500. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70501. /**
  70502. * Get a navigation mesh constrained position, within a particular radius
  70503. * @param position world position
  70504. * @param maxRadius the maximum distance to the constrained world position
  70505. * @param result output the closest point to position constrained by the navigation mesh
  70506. */
  70507. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70508. /**
  70509. * Compute the final position from a segment made of destination-position
  70510. * @param position world position
  70511. * @param destination world position
  70512. * @returns the resulting point along the navmesh
  70513. */
  70514. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70515. /**
  70516. * Compute the final position from a segment made of destination-position
  70517. * @param position world position
  70518. * @param destination world position
  70519. * @param result output the resulting point along the navmesh
  70520. */
  70521. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70522. /**
  70523. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70524. * @param start world position
  70525. * @param end world position
  70526. * @returns array containing world position composing the path
  70527. */
  70528. computePath(start: Vector3, end: Vector3): Vector3[];
  70529. /**
  70530. * If this plugin is supported
  70531. * @returns true if plugin is supported
  70532. */
  70533. isSupported(): boolean;
  70534. /**
  70535. * Create a new Crowd so you can add agents
  70536. * @param maxAgents the maximum agent count in the crowd
  70537. * @param maxAgentRadius the maximum radius an agent can have
  70538. * @param scene to attach the crowd to
  70539. * @returns the crowd you can add agents to
  70540. */
  70541. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70542. /**
  70543. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70544. * The queries will try to find a solution within those bounds
  70545. * default is (1,1,1)
  70546. * @param extent x,y,z value that define the extent around the queries point of reference
  70547. */
  70548. setDefaultQueryExtent(extent: Vector3): void;
  70549. /**
  70550. * Get the Bounding box extent specified by setDefaultQueryExtent
  70551. * @returns the box extent values
  70552. */
  70553. getDefaultQueryExtent(): Vector3;
  70554. /**
  70555. * build the navmesh from a previously saved state using getNavmeshData
  70556. * @param data the Uint8Array returned by getNavmeshData
  70557. */
  70558. buildFromNavmeshData(data: Uint8Array): void;
  70559. /**
  70560. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70561. * @returns data the Uint8Array that can be saved and reused
  70562. */
  70563. getNavmeshData(): Uint8Array;
  70564. /**
  70565. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70566. * @param result output the box extent values
  70567. */
  70568. getDefaultQueryExtentToRef(result: Vector3): void;
  70569. /**
  70570. * Release all resources
  70571. */
  70572. dispose(): void;
  70573. }
  70574. /**
  70575. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  70576. */
  70577. export interface ICrowd {
  70578. /**
  70579. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70580. * You can attach anything to that node. The node position is updated in the scene update tick.
  70581. * @param pos world position that will be constrained by the navigation mesh
  70582. * @param parameters agent parameters
  70583. * @param transform hooked to the agent that will be update by the scene
  70584. * @returns agent index
  70585. */
  70586. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70587. /**
  70588. * Returns the agent position in world space
  70589. * @param index agent index returned by addAgent
  70590. * @returns world space position
  70591. */
  70592. getAgentPosition(index: number): Vector3;
  70593. /**
  70594. * Gets the agent position result in world space
  70595. * @param index agent index returned by addAgent
  70596. * @param result output world space position
  70597. */
  70598. getAgentPositionToRef(index: number, result: Vector3): void;
  70599. /**
  70600. * Gets the agent velocity in world space
  70601. * @param index agent index returned by addAgent
  70602. * @returns world space velocity
  70603. */
  70604. getAgentVelocity(index: number): Vector3;
  70605. /**
  70606. * Gets the agent velocity result in world space
  70607. * @param index agent index returned by addAgent
  70608. * @param result output world space velocity
  70609. */
  70610. getAgentVelocityToRef(index: number, result: Vector3): void;
  70611. /**
  70612. * remove a particular agent previously created
  70613. * @param index agent index returned by addAgent
  70614. */
  70615. removeAgent(index: number): void;
  70616. /**
  70617. * get the list of all agents attached to this crowd
  70618. * @returns list of agent indices
  70619. */
  70620. getAgents(): number[];
  70621. /**
  70622. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70623. * @param deltaTime in seconds
  70624. */
  70625. update(deltaTime: number): void;
  70626. /**
  70627. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70628. * @param index agent index returned by addAgent
  70629. * @param destination targeted world position
  70630. */
  70631. agentGoto(index: number, destination: Vector3): void;
  70632. /**
  70633. * Teleport the agent to a new position
  70634. * @param index agent index returned by addAgent
  70635. * @param destination targeted world position
  70636. */
  70637. agentTeleport(index: number, destination: Vector3): void;
  70638. /**
  70639. * Update agent parameters
  70640. * @param index agent index returned by addAgent
  70641. * @param parameters agent parameters
  70642. */
  70643. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70644. /**
  70645. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70646. * The queries will try to find a solution within those bounds
  70647. * default is (1,1,1)
  70648. * @param extent x,y,z value that define the extent around the queries point of reference
  70649. */
  70650. setDefaultQueryExtent(extent: Vector3): void;
  70651. /**
  70652. * Get the Bounding box extent specified by setDefaultQueryExtent
  70653. * @returns the box extent values
  70654. */
  70655. getDefaultQueryExtent(): Vector3;
  70656. /**
  70657. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70658. * @param result output the box extent values
  70659. */
  70660. getDefaultQueryExtentToRef(result: Vector3): void;
  70661. /**
  70662. * Release all resources
  70663. */
  70664. dispose(): void;
  70665. }
  70666. /**
  70667. * Configures an agent
  70668. */
  70669. export interface IAgentParameters {
  70670. /**
  70671. * Agent radius. [Limit: >= 0]
  70672. */
  70673. radius: number;
  70674. /**
  70675. * Agent height. [Limit: > 0]
  70676. */
  70677. height: number;
  70678. /**
  70679. * Maximum allowed acceleration. [Limit: >= 0]
  70680. */
  70681. maxAcceleration: number;
  70682. /**
  70683. * Maximum allowed speed. [Limit: >= 0]
  70684. */
  70685. maxSpeed: number;
  70686. /**
  70687. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  70688. */
  70689. collisionQueryRange: number;
  70690. /**
  70691. * The path visibility optimization range. [Limit: > 0]
  70692. */
  70693. pathOptimizationRange: number;
  70694. /**
  70695. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  70696. */
  70697. separationWeight: number;
  70698. }
  70699. /**
  70700. * Configures the navigation mesh creation
  70701. */
  70702. export interface INavMeshParameters {
  70703. /**
  70704. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  70705. */
  70706. cs: number;
  70707. /**
  70708. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  70709. */
  70710. ch: number;
  70711. /**
  70712. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  70713. */
  70714. walkableSlopeAngle: number;
  70715. /**
  70716. * Minimum floor to 'ceiling' height that will still allow the floor area to
  70717. * be considered walkable. [Limit: >= 3] [Units: vx]
  70718. */
  70719. walkableHeight: number;
  70720. /**
  70721. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  70722. */
  70723. walkableClimb: number;
  70724. /**
  70725. * The distance to erode/shrink the walkable area of the heightfield away from
  70726. * obstructions. [Limit: >=0] [Units: vx]
  70727. */
  70728. walkableRadius: number;
  70729. /**
  70730. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  70731. */
  70732. maxEdgeLen: number;
  70733. /**
  70734. * The maximum distance a simplfied contour's border edges should deviate
  70735. * the original raw contour. [Limit: >=0] [Units: vx]
  70736. */
  70737. maxSimplificationError: number;
  70738. /**
  70739. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  70740. */
  70741. minRegionArea: number;
  70742. /**
  70743. * Any regions with a span count smaller than this value will, if possible,
  70744. * be merged with larger regions. [Limit: >=0] [Units: vx]
  70745. */
  70746. mergeRegionArea: number;
  70747. /**
  70748. * The maximum number of vertices allowed for polygons generated during the
  70749. * contour to polygon conversion process. [Limit: >= 3]
  70750. */
  70751. maxVertsPerPoly: number;
  70752. /**
  70753. * Sets the sampling distance to use when generating the detail mesh.
  70754. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  70755. */
  70756. detailSampleDist: number;
  70757. /**
  70758. * The maximum distance the detail mesh surface should deviate from heightfield
  70759. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  70760. */
  70761. detailSampleMaxError: number;
  70762. }
  70763. }
  70764. declare module "babylonjs/Navigation/Plugins/recastJSPlugin" {
  70765. import { INavigationEnginePlugin, ICrowd, IAgentParameters, INavMeshParameters } from "babylonjs/Navigation/INavigationEngine";
  70766. import { Mesh } from "babylonjs/Meshes/mesh";
  70767. import { Scene } from "babylonjs/scene";
  70768. import { Vector3 } from "babylonjs/Maths/math";
  70769. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70770. /**
  70771. * RecastJS navigation plugin
  70772. */
  70773. export class RecastJSPlugin implements INavigationEnginePlugin {
  70774. /**
  70775. * Reference to the Recast library
  70776. */
  70777. bjsRECAST: any;
  70778. /**
  70779. * plugin name
  70780. */
  70781. name: string;
  70782. /**
  70783. * the first navmesh created. We might extend this to support multiple navmeshes
  70784. */
  70785. navMesh: any;
  70786. /**
  70787. * Initializes the recastJS plugin
  70788. * @param recastInjection can be used to inject your own recast reference
  70789. */
  70790. constructor(recastInjection?: any);
  70791. /**
  70792. * Creates a navigation mesh
  70793. * @param meshes array of all the geometry used to compute the navigatio mesh
  70794. * @param parameters bunch of parameters used to filter geometry
  70795. */
  70796. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70797. /**
  70798. * Create a navigation mesh debug mesh
  70799. * @param scene is where the mesh will be added
  70800. * @returns debug display mesh
  70801. */
  70802. createDebugNavMesh(scene: Scene): Mesh;
  70803. /**
  70804. * Get a navigation mesh constrained position, closest to the parameter position
  70805. * @param position world position
  70806. * @returns the closest point to position constrained by the navigation mesh
  70807. */
  70808. getClosestPoint(position: Vector3): Vector3;
  70809. /**
  70810. * Get a navigation mesh constrained position, closest to the parameter position
  70811. * @param position world position
  70812. * @param result output the closest point to position constrained by the navigation mesh
  70813. */
  70814. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70815. /**
  70816. * Get a navigation mesh constrained position, within a particular radius
  70817. * @param position world position
  70818. * @param maxRadius the maximum distance to the constrained world position
  70819. * @returns the closest point to position constrained by the navigation mesh
  70820. */
  70821. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70822. /**
  70823. * Get a navigation mesh constrained position, within a particular radius
  70824. * @param position world position
  70825. * @param maxRadius the maximum distance to the constrained world position
  70826. * @param result output the closest point to position constrained by the navigation mesh
  70827. */
  70828. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70829. /**
  70830. * Compute the final position from a segment made of destination-position
  70831. * @param position world position
  70832. * @param destination world position
  70833. * @returns the resulting point along the navmesh
  70834. */
  70835. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70836. /**
  70837. * Compute the final position from a segment made of destination-position
  70838. * @param position world position
  70839. * @param destination world position
  70840. * @param result output the resulting point along the navmesh
  70841. */
  70842. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70843. /**
  70844. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70845. * @param start world position
  70846. * @param end world position
  70847. * @returns array containing world position composing the path
  70848. */
  70849. computePath(start: Vector3, end: Vector3): Vector3[];
  70850. /**
  70851. * Create a new Crowd so you can add agents
  70852. * @param maxAgents the maximum agent count in the crowd
  70853. * @param maxAgentRadius the maximum radius an agent can have
  70854. * @param scene to attach the crowd to
  70855. * @returns the crowd you can add agents to
  70856. */
  70857. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70858. /**
  70859. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70860. * The queries will try to find a solution within those bounds
  70861. * default is (1,1,1)
  70862. * @param extent x,y,z value that define the extent around the queries point of reference
  70863. */
  70864. setDefaultQueryExtent(extent: Vector3): void;
  70865. /**
  70866. * Get the Bounding box extent specified by setDefaultQueryExtent
  70867. * @returns the box extent values
  70868. */
  70869. getDefaultQueryExtent(): Vector3;
  70870. /**
  70871. * build the navmesh from a previously saved state using getNavmeshData
  70872. * @param data the Uint8Array returned by getNavmeshData
  70873. */
  70874. buildFromNavmeshData(data: Uint8Array): void;
  70875. /**
  70876. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70877. * @returns data the Uint8Array that can be saved and reused
  70878. */
  70879. getNavmeshData(): Uint8Array;
  70880. /**
  70881. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70882. * @param result output the box extent values
  70883. */
  70884. getDefaultQueryExtentToRef(result: Vector3): void;
  70885. /**
  70886. * Disposes
  70887. */
  70888. dispose(): void;
  70889. /**
  70890. * If this plugin is supported
  70891. * @returns true if plugin is supported
  70892. */
  70893. isSupported(): boolean;
  70894. }
  70895. /**
  70896. * Recast detour crowd implementation
  70897. */
  70898. export class RecastJSCrowd implements ICrowd {
  70899. /**
  70900. * Recast/detour plugin
  70901. */
  70902. bjsRECASTPlugin: RecastJSPlugin;
  70903. /**
  70904. * Link to the detour crowd
  70905. */
  70906. recastCrowd: any;
  70907. /**
  70908. * One transform per agent
  70909. */
  70910. transforms: TransformNode[];
  70911. /**
  70912. * All agents created
  70913. */
  70914. agents: number[];
  70915. /**
  70916. * Link to the scene is kept to unregister the crowd from the scene
  70917. */
  70918. private _scene;
  70919. /**
  70920. * Observer for crowd updates
  70921. */
  70922. private _onBeforeAnimationsObserver;
  70923. /**
  70924. * Constructor
  70925. * @param plugin recastJS plugin
  70926. * @param maxAgents the maximum agent count in the crowd
  70927. * @param maxAgentRadius the maximum radius an agent can have
  70928. * @param scene to attach the crowd to
  70929. * @returns the crowd you can add agents to
  70930. */
  70931. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  70932. /**
  70933. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70934. * You can attach anything to that node. The node position is updated in the scene update tick.
  70935. * @param pos world position that will be constrained by the navigation mesh
  70936. * @param parameters agent parameters
  70937. * @param transform hooked to the agent that will be update by the scene
  70938. * @returns agent index
  70939. */
  70940. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70941. /**
  70942. * Returns the agent position in world space
  70943. * @param index agent index returned by addAgent
  70944. * @returns world space position
  70945. */
  70946. getAgentPosition(index: number): Vector3;
  70947. /**
  70948. * Returns the agent position result in world space
  70949. * @param index agent index returned by addAgent
  70950. * @param result output world space position
  70951. */
  70952. getAgentPositionToRef(index: number, result: Vector3): void;
  70953. /**
  70954. * Returns the agent velocity in world space
  70955. * @param index agent index returned by addAgent
  70956. * @returns world space velocity
  70957. */
  70958. getAgentVelocity(index: number): Vector3;
  70959. /**
  70960. * Returns the agent velocity result in world space
  70961. * @param index agent index returned by addAgent
  70962. * @param result output world space velocity
  70963. */
  70964. getAgentVelocityToRef(index: number, result: Vector3): void;
  70965. /**
  70966. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70967. * @param index agent index returned by addAgent
  70968. * @param destination targeted world position
  70969. */
  70970. agentGoto(index: number, destination: Vector3): void;
  70971. /**
  70972. * Teleport the agent to a new position
  70973. * @param index agent index returned by addAgent
  70974. * @param destination targeted world position
  70975. */
  70976. agentTeleport(index: number, destination: Vector3): void;
  70977. /**
  70978. * Update agent parameters
  70979. * @param index agent index returned by addAgent
  70980. * @param parameters agent parameters
  70981. */
  70982. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70983. /**
  70984. * remove a particular agent previously created
  70985. * @param index agent index returned by addAgent
  70986. */
  70987. removeAgent(index: number): void;
  70988. /**
  70989. * get the list of all agents attached to this crowd
  70990. * @returns list of agent indices
  70991. */
  70992. getAgents(): number[];
  70993. /**
  70994. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70995. * @param deltaTime in seconds
  70996. */
  70997. update(deltaTime: number): void;
  70998. /**
  70999. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  71000. * The queries will try to find a solution within those bounds
  71001. * default is (1,1,1)
  71002. * @param extent x,y,z value that define the extent around the queries point of reference
  71003. */
  71004. setDefaultQueryExtent(extent: Vector3): void;
  71005. /**
  71006. * Get the Bounding box extent specified by setDefaultQueryExtent
  71007. * @returns the box extent values
  71008. */
  71009. getDefaultQueryExtent(): Vector3;
  71010. /**
  71011. * Get the Bounding box extent result specified by setDefaultQueryExtent
  71012. * @param result output the box extent values
  71013. */
  71014. getDefaultQueryExtentToRef(result: Vector3): void;
  71015. /**
  71016. * Release all resources
  71017. */
  71018. dispose(): void;
  71019. }
  71020. }
  71021. declare module "babylonjs/Navigation/Plugins/index" {
  71022. export * from "babylonjs/Navigation/Plugins/recastJSPlugin";
  71023. }
  71024. declare module "babylonjs/Navigation/index" {
  71025. export * from "babylonjs/Navigation/INavigationEngine";
  71026. export * from "babylonjs/Navigation/Plugins/index";
  71027. }
  71028. declare module "babylonjs/Offline/database" {
  71029. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  71030. /**
  71031. * Class used to enable access to IndexedDB
  71032. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  71033. */
  71034. export class Database implements IOfflineProvider {
  71035. private _callbackManifestChecked;
  71036. private _currentSceneUrl;
  71037. private _db;
  71038. private _enableSceneOffline;
  71039. private _enableTexturesOffline;
  71040. private _manifestVersionFound;
  71041. private _mustUpdateRessources;
  71042. private _hasReachedQuota;
  71043. private _isSupported;
  71044. private _idbFactory;
  71045. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  71046. private static IsUASupportingBlobStorage;
  71047. /**
  71048. * Gets a boolean indicating if Database storate is enabled (off by default)
  71049. */
  71050. static IDBStorageEnabled: boolean;
  71051. /**
  71052. * Gets a boolean indicating if scene must be saved in the database
  71053. */
  71054. get enableSceneOffline(): boolean;
  71055. /**
  71056. * Gets a boolean indicating if textures must be saved in the database
  71057. */
  71058. get enableTexturesOffline(): boolean;
  71059. /**
  71060. * Creates a new Database
  71061. * @param urlToScene defines the url to load the scene
  71062. * @param callbackManifestChecked defines the callback to use when manifest is checked
  71063. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  71064. */
  71065. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  71066. private static _ParseURL;
  71067. private static _ReturnFullUrlLocation;
  71068. private _checkManifestFile;
  71069. /**
  71070. * Open the database and make it available
  71071. * @param successCallback defines the callback to call on success
  71072. * @param errorCallback defines the callback to call on error
  71073. */
  71074. open(successCallback: () => void, errorCallback: () => void): void;
  71075. /**
  71076. * Loads an image from the database
  71077. * @param url defines the url to load from
  71078. * @param image defines the target DOM image
  71079. */
  71080. loadImage(url: string, image: HTMLImageElement): void;
  71081. private _loadImageFromDBAsync;
  71082. private _saveImageIntoDBAsync;
  71083. private _checkVersionFromDB;
  71084. private _loadVersionFromDBAsync;
  71085. private _saveVersionIntoDBAsync;
  71086. /**
  71087. * Loads a file from database
  71088. * @param url defines the URL to load from
  71089. * @param sceneLoaded defines a callback to call on success
  71090. * @param progressCallBack defines a callback to call when progress changed
  71091. * @param errorCallback defines a callback to call on error
  71092. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  71093. */
  71094. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  71095. private _loadFileAsync;
  71096. private _saveFileAsync;
  71097. /**
  71098. * Validates if xhr data is correct
  71099. * @param xhr defines the request to validate
  71100. * @param dataType defines the expected data type
  71101. * @returns true if data is correct
  71102. */
  71103. private static _ValidateXHRData;
  71104. }
  71105. }
  71106. declare module "babylonjs/Offline/index" {
  71107. export * from "babylonjs/Offline/database";
  71108. export * from "babylonjs/Offline/IOfflineProvider";
  71109. }
  71110. declare module "babylonjs/Shaders/gpuUpdateParticles.fragment" {
  71111. /** @hidden */
  71112. export var gpuUpdateParticlesPixelShader: {
  71113. name: string;
  71114. shader: string;
  71115. };
  71116. }
  71117. declare module "babylonjs/Shaders/gpuUpdateParticles.vertex" {
  71118. /** @hidden */
  71119. export var gpuUpdateParticlesVertexShader: {
  71120. name: string;
  71121. shader: string;
  71122. };
  71123. }
  71124. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2" {
  71125. /** @hidden */
  71126. export var clipPlaneFragmentDeclaration2: {
  71127. name: string;
  71128. shader: string;
  71129. };
  71130. }
  71131. declare module "babylonjs/Shaders/gpuRenderParticles.fragment" {
  71132. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2";
  71133. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  71134. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  71135. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  71136. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  71137. /** @hidden */
  71138. export var gpuRenderParticlesPixelShader: {
  71139. name: string;
  71140. shader: string;
  71141. };
  71142. }
  71143. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2" {
  71144. /** @hidden */
  71145. export var clipPlaneVertexDeclaration2: {
  71146. name: string;
  71147. shader: string;
  71148. };
  71149. }
  71150. declare module "babylonjs/Shaders/gpuRenderParticles.vertex" {
  71151. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2";
  71152. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  71153. /** @hidden */
  71154. export var gpuRenderParticlesVertexShader: {
  71155. name: string;
  71156. shader: string;
  71157. };
  71158. }
  71159. declare module "babylonjs/Particles/gpuParticleSystem" {
  71160. import { Nullable } from "babylonjs/types";
  71161. import { Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  71162. import { Observable } from "babylonjs/Misc/observable";
  71163. import { Matrix } from "babylonjs/Maths/math.vector";
  71164. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  71165. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71166. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  71167. import { IDisposable } from "babylonjs/scene";
  71168. import { Effect } from "babylonjs/Materials/effect";
  71169. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  71170. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  71171. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  71172. import { Scene } from "babylonjs/scene";
  71173. import "babylonjs/Shaders/gpuUpdateParticles.fragment";
  71174. import "babylonjs/Shaders/gpuUpdateParticles.vertex";
  71175. import "babylonjs/Shaders/gpuRenderParticles.fragment";
  71176. import "babylonjs/Shaders/gpuRenderParticles.vertex";
  71177. /**
  71178. * This represents a GPU particle system in Babylon
  71179. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  71180. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  71181. */
  71182. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  71183. /**
  71184. * The layer mask we are rendering the particles through.
  71185. */
  71186. layerMask: number;
  71187. private _capacity;
  71188. private _activeCount;
  71189. private _currentActiveCount;
  71190. private _accumulatedCount;
  71191. private _renderEffect;
  71192. private _updateEffect;
  71193. private _buffer0;
  71194. private _buffer1;
  71195. private _spriteBuffer;
  71196. private _updateVAO;
  71197. private _renderVAO;
  71198. private _targetIndex;
  71199. private _sourceBuffer;
  71200. private _targetBuffer;
  71201. private _currentRenderId;
  71202. private _started;
  71203. private _stopped;
  71204. private _timeDelta;
  71205. private _randomTexture;
  71206. private _randomTexture2;
  71207. private _attributesStrideSize;
  71208. private _updateEffectOptions;
  71209. private _randomTextureSize;
  71210. private _actualFrame;
  71211. private _customEffect;
  71212. private readonly _rawTextureWidth;
  71213. /**
  71214. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  71215. */
  71216. static get IsSupported(): boolean;
  71217. /**
  71218. * An event triggered when the system is disposed.
  71219. */
  71220. onDisposeObservable: Observable<IParticleSystem>;
  71221. /**
  71222. * Gets the maximum number of particles active at the same time.
  71223. * @returns The max number of active particles.
  71224. */
  71225. getCapacity(): number;
  71226. /**
  71227. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  71228. * to override the particles.
  71229. */
  71230. forceDepthWrite: boolean;
  71231. /**
  71232. * Gets or set the number of active particles
  71233. */
  71234. get activeParticleCount(): number;
  71235. set activeParticleCount(value: number);
  71236. private _preWarmDone;
  71237. /**
  71238. * Specifies if the particles are updated in emitter local space or world space.
  71239. */
  71240. isLocal: boolean;
  71241. /** Gets or sets a matrix to use to compute projection */
  71242. defaultProjectionMatrix: Matrix;
  71243. /**
  71244. * Is this system ready to be used/rendered
  71245. * @return true if the system is ready
  71246. */
  71247. isReady(): boolean;
  71248. /**
  71249. * Gets if the system has been started. (Note: this will still be true after stop is called)
  71250. * @returns True if it has been started, otherwise false.
  71251. */
  71252. isStarted(): boolean;
  71253. /**
  71254. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  71255. * @returns True if it has been stopped, otherwise false.
  71256. */
  71257. isStopped(): boolean;
  71258. /**
  71259. * Gets a boolean indicating that the system is stopping
  71260. * @returns true if the system is currently stopping
  71261. */
  71262. isStopping(): boolean;
  71263. /**
  71264. * Gets the number of particles active at the same time.
  71265. * @returns The number of active particles.
  71266. */
  71267. getActiveCount(): number;
  71268. /**
  71269. * Starts the particle system and begins to emit
  71270. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  71271. */
  71272. start(delay?: number): void;
  71273. /**
  71274. * Stops the particle system.
  71275. */
  71276. stop(): void;
  71277. /**
  71278. * Remove all active particles
  71279. */
  71280. reset(): void;
  71281. /**
  71282. * Returns the string "GPUParticleSystem"
  71283. * @returns a string containing the class name
  71284. */
  71285. getClassName(): string;
  71286. /**
  71287. * Gets the custom effect used to render the particles
  71288. * @param blendMode Blend mode for which the effect should be retrieved
  71289. * @returns The effect
  71290. */
  71291. getCustomEffect(blendMode?: number): Nullable<Effect>;
  71292. /**
  71293. * Sets the custom effect used to render the particles
  71294. * @param effect The effect to set
  71295. * @param blendMode Blend mode for which the effect should be set
  71296. */
  71297. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  71298. /** @hidden */
  71299. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  71300. /**
  71301. * Observable that will be called just before the particles are drawn
  71302. */
  71303. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  71304. /**
  71305. * Gets the name of the particle vertex shader
  71306. */
  71307. get vertexShaderName(): string;
  71308. private _colorGradientsTexture;
  71309. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  71310. /**
  71311. * Adds a new color gradient
  71312. * @param gradient defines the gradient to use (between 0 and 1)
  71313. * @param color1 defines the color to affect to the specified gradient
  71314. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  71315. * @returns the current particle system
  71316. */
  71317. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  71318. private _refreshColorGradient;
  71319. /** Force the system to rebuild all gradients that need to be resync */
  71320. forceRefreshGradients(): void;
  71321. /**
  71322. * Remove a specific color gradient
  71323. * @param gradient defines the gradient to remove
  71324. * @returns the current particle system
  71325. */
  71326. removeColorGradient(gradient: number): GPUParticleSystem;
  71327. private _angularSpeedGradientsTexture;
  71328. private _sizeGradientsTexture;
  71329. private _velocityGradientsTexture;
  71330. private _limitVelocityGradientsTexture;
  71331. private _dragGradientsTexture;
  71332. private _addFactorGradient;
  71333. /**
  71334. * Adds a new size gradient
  71335. * @param gradient defines the gradient to use (between 0 and 1)
  71336. * @param factor defines the size factor to affect to the specified gradient
  71337. * @returns the current particle system
  71338. */
  71339. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  71340. /**
  71341. * Remove a specific size gradient
  71342. * @param gradient defines the gradient to remove
  71343. * @returns the current particle system
  71344. */
  71345. removeSizeGradient(gradient: number): GPUParticleSystem;
  71346. private _refreshFactorGradient;
  71347. /**
  71348. * Adds a new angular speed gradient
  71349. * @param gradient defines the gradient to use (between 0 and 1)
  71350. * @param factor defines the angular speed to affect to the specified gradient
  71351. * @returns the current particle system
  71352. */
  71353. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  71354. /**
  71355. * Remove a specific angular speed gradient
  71356. * @param gradient defines the gradient to remove
  71357. * @returns the current particle system
  71358. */
  71359. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  71360. /**
  71361. * Adds a new velocity gradient
  71362. * @param gradient defines the gradient to use (between 0 and 1)
  71363. * @param factor defines the velocity to affect to the specified gradient
  71364. * @returns the current particle system
  71365. */
  71366. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  71367. /**
  71368. * Remove a specific velocity gradient
  71369. * @param gradient defines the gradient to remove
  71370. * @returns the current particle system
  71371. */
  71372. removeVelocityGradient(gradient: number): GPUParticleSystem;
  71373. /**
  71374. * Adds a new limit velocity gradient
  71375. * @param gradient defines the gradient to use (between 0 and 1)
  71376. * @param factor defines the limit velocity value to affect to the specified gradient
  71377. * @returns the current particle system
  71378. */
  71379. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  71380. /**
  71381. * Remove a specific limit velocity gradient
  71382. * @param gradient defines the gradient to remove
  71383. * @returns the current particle system
  71384. */
  71385. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  71386. /**
  71387. * Adds a new drag gradient
  71388. * @param gradient defines the gradient to use (between 0 and 1)
  71389. * @param factor defines the drag value to affect to the specified gradient
  71390. * @returns the current particle system
  71391. */
  71392. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  71393. /**
  71394. * Remove a specific drag gradient
  71395. * @param gradient defines the gradient to remove
  71396. * @returns the current particle system
  71397. */
  71398. removeDragGradient(gradient: number): GPUParticleSystem;
  71399. /**
  71400. * Not supported by GPUParticleSystem
  71401. * @param gradient defines the gradient to use (between 0 and 1)
  71402. * @param factor defines the emit rate value to affect to the specified gradient
  71403. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71404. * @returns the current particle system
  71405. */
  71406. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71407. /**
  71408. * Not supported by GPUParticleSystem
  71409. * @param gradient defines the gradient to remove
  71410. * @returns the current particle system
  71411. */
  71412. removeEmitRateGradient(gradient: number): IParticleSystem;
  71413. /**
  71414. * Not supported by GPUParticleSystem
  71415. * @param gradient defines the gradient to use (between 0 and 1)
  71416. * @param factor defines the start size value to affect to the specified gradient
  71417. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71418. * @returns the current particle system
  71419. */
  71420. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71421. /**
  71422. * Not supported by GPUParticleSystem
  71423. * @param gradient defines the gradient to remove
  71424. * @returns the current particle system
  71425. */
  71426. removeStartSizeGradient(gradient: number): IParticleSystem;
  71427. /**
  71428. * Not supported by GPUParticleSystem
  71429. * @param gradient defines the gradient to use (between 0 and 1)
  71430. * @param min defines the color remap minimal range
  71431. * @param max defines the color remap maximal range
  71432. * @returns the current particle system
  71433. */
  71434. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  71435. /**
  71436. * Not supported by GPUParticleSystem
  71437. * @param gradient defines the gradient to remove
  71438. * @returns the current particle system
  71439. */
  71440. removeColorRemapGradient(): IParticleSystem;
  71441. /**
  71442. * Not supported by GPUParticleSystem
  71443. * @param gradient defines the gradient to use (between 0 and 1)
  71444. * @param min defines the alpha remap minimal range
  71445. * @param max defines the alpha remap maximal range
  71446. * @returns the current particle system
  71447. */
  71448. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  71449. /**
  71450. * Not supported by GPUParticleSystem
  71451. * @param gradient defines the gradient to remove
  71452. * @returns the current particle system
  71453. */
  71454. removeAlphaRemapGradient(): IParticleSystem;
  71455. /**
  71456. * Not supported by GPUParticleSystem
  71457. * @param gradient defines the gradient to use (between 0 and 1)
  71458. * @param color defines the color to affect to the specified gradient
  71459. * @returns the current particle system
  71460. */
  71461. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  71462. /**
  71463. * Not supported by GPUParticleSystem
  71464. * @param gradient defines the gradient to remove
  71465. * @returns the current particle system
  71466. */
  71467. removeRampGradient(): IParticleSystem;
  71468. /**
  71469. * Not supported by GPUParticleSystem
  71470. * @returns the list of ramp gradients
  71471. */
  71472. getRampGradients(): Nullable<Array<Color3Gradient>>;
  71473. /**
  71474. * Not supported by GPUParticleSystem
  71475. * Gets or sets a boolean indicating that ramp gradients must be used
  71476. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  71477. */
  71478. get useRampGradients(): boolean;
  71479. set useRampGradients(value: boolean);
  71480. /**
  71481. * Not supported by GPUParticleSystem
  71482. * @param gradient defines the gradient to use (between 0 and 1)
  71483. * @param factor defines the life time factor to affect to the specified gradient
  71484. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71485. * @returns the current particle system
  71486. */
  71487. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71488. /**
  71489. * Not supported by GPUParticleSystem
  71490. * @param gradient defines the gradient to remove
  71491. * @returns the current particle system
  71492. */
  71493. removeLifeTimeGradient(gradient: number): IParticleSystem;
  71494. /**
  71495. * Instantiates a GPU particle system.
  71496. * 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.
  71497. * @param name The name of the particle system
  71498. * @param options The options used to create the system
  71499. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  71500. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  71501. * @param customEffect a custom effect used to change the way particles are rendered by default
  71502. */
  71503. constructor(name: string, options: Partial<{
  71504. capacity: number;
  71505. randomTextureSize: number;
  71506. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  71507. protected _reset(): void;
  71508. private _createUpdateVAO;
  71509. private _createRenderVAO;
  71510. private _initialize;
  71511. /** @hidden */
  71512. _recreateUpdateEffect(): void;
  71513. private _getEffect;
  71514. /**
  71515. * Fill the defines array according to the current settings of the particle system
  71516. * @param defines Array to be updated
  71517. * @param blendMode blend mode to take into account when updating the array
  71518. */
  71519. fillDefines(defines: Array<string>, blendMode?: number): void;
  71520. /**
  71521. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  71522. * @param uniforms Uniforms array to fill
  71523. * @param attributes Attributes array to fill
  71524. * @param samplers Samplers array to fill
  71525. */
  71526. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  71527. /** @hidden */
  71528. _recreateRenderEffect(): Effect;
  71529. /**
  71530. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  71531. * @param preWarm defines if we are in the pre-warmimg phase
  71532. */
  71533. animate(preWarm?: boolean): void;
  71534. private _createFactorGradientTexture;
  71535. private _createSizeGradientTexture;
  71536. private _createAngularSpeedGradientTexture;
  71537. private _createVelocityGradientTexture;
  71538. private _createLimitVelocityGradientTexture;
  71539. private _createDragGradientTexture;
  71540. private _createColorGradientTexture;
  71541. /**
  71542. * Renders the particle system in its current state
  71543. * @param preWarm defines if the system should only update the particles but not render them
  71544. * @returns the current number of particles
  71545. */
  71546. render(preWarm?: boolean): number;
  71547. /**
  71548. * Rebuilds the particle system
  71549. */
  71550. rebuild(): void;
  71551. private _releaseBuffers;
  71552. private _releaseVAOs;
  71553. /**
  71554. * Disposes the particle system and free the associated resources
  71555. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  71556. */
  71557. dispose(disposeTexture?: boolean): void;
  71558. /**
  71559. * Clones the particle system.
  71560. * @param name The name of the cloned object
  71561. * @param newEmitter The new emitter to use
  71562. * @returns the cloned particle system
  71563. */
  71564. clone(name: string, newEmitter: any): GPUParticleSystem;
  71565. /**
  71566. * Serializes the particle system to a JSON object
  71567. * @param serializeTexture defines if the texture must be serialized as well
  71568. * @returns the JSON object
  71569. */
  71570. serialize(serializeTexture?: boolean): any;
  71571. /**
  71572. * Parses a JSON object to create a GPU particle system.
  71573. * @param parsedParticleSystem The JSON object to parse
  71574. * @param sceneOrEngine The scene or the engine to create the particle system in
  71575. * @param rootUrl The root url to use to load external dependencies like texture
  71576. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  71577. * @returns the parsed GPU particle system
  71578. */
  71579. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  71580. }
  71581. }
  71582. declare module "babylonjs/Particles/particleSystemSet" {
  71583. import { Nullable } from "babylonjs/types";
  71584. import { Color3 } from "babylonjs/Maths/math.color";
  71585. import { TransformNode } from "babylonjs/Meshes/transformNode";
  71586. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  71587. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71588. import { Scene, IDisposable } from "babylonjs/scene";
  71589. /**
  71590. * Represents a set of particle systems working together to create a specific effect
  71591. */
  71592. export class ParticleSystemSet implements IDisposable {
  71593. /**
  71594. * Gets or sets base Assets URL
  71595. */
  71596. static BaseAssetsUrl: string;
  71597. private _emitterCreationOptions;
  71598. private _emitterNode;
  71599. /**
  71600. * Gets the particle system list
  71601. */
  71602. systems: IParticleSystem[];
  71603. /**
  71604. * Gets the emitter node used with this set
  71605. */
  71606. get emitterNode(): Nullable<TransformNode>;
  71607. /**
  71608. * Creates a new emitter mesh as a sphere
  71609. * @param options defines the options used to create the sphere
  71610. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  71611. * @param scene defines the hosting scene
  71612. */
  71613. setEmitterAsSphere(options: {
  71614. diameter: number;
  71615. segments: number;
  71616. color: Color3;
  71617. }, renderingGroupId: number, scene: Scene): void;
  71618. /**
  71619. * Starts all particle systems of the set
  71620. * @param emitter defines an optional mesh to use as emitter for the particle systems
  71621. */
  71622. start(emitter?: AbstractMesh): void;
  71623. /**
  71624. * Release all associated resources
  71625. */
  71626. dispose(): void;
  71627. /**
  71628. * Serialize the set into a JSON compatible object
  71629. * @param serializeTexture defines if the texture must be serialized as well
  71630. * @returns a JSON compatible representation of the set
  71631. */
  71632. serialize(serializeTexture?: boolean): any;
  71633. /**
  71634. * Parse a new ParticleSystemSet from a serialized source
  71635. * @param data defines a JSON compatible representation of the set
  71636. * @param scene defines the hosting scene
  71637. * @param gpu defines if we want GPU particles or CPU particles
  71638. * @returns a new ParticleSystemSet
  71639. */
  71640. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  71641. }
  71642. }
  71643. declare module "babylonjs/Particles/particleHelper" {
  71644. import { Nullable } from "babylonjs/types";
  71645. import { Scene } from "babylonjs/scene";
  71646. import { Vector3 } from "babylonjs/Maths/math.vector";
  71647. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  71648. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71649. import { ParticleSystemSet } from "babylonjs/Particles/particleSystemSet";
  71650. /**
  71651. * This class is made for on one-liner static method to help creating particle system set.
  71652. */
  71653. export class ParticleHelper {
  71654. /**
  71655. * Gets or sets base Assets URL
  71656. */
  71657. static BaseAssetsUrl: string;
  71658. /** Define the Url to load snippets */
  71659. static SnippetUrl: string;
  71660. /**
  71661. * Create a default particle system that you can tweak
  71662. * @param emitter defines the emitter to use
  71663. * @param capacity defines the system capacity (default is 500 particles)
  71664. * @param scene defines the hosting scene
  71665. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  71666. * @returns the new Particle system
  71667. */
  71668. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  71669. /**
  71670. * This is the main static method (one-liner) of this helper to create different particle systems
  71671. * @param type This string represents the type to the particle system to create
  71672. * @param scene The scene where the particle system should live
  71673. * @param gpu If the system will use gpu
  71674. * @returns the ParticleSystemSet created
  71675. */
  71676. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  71677. /**
  71678. * Static function used to export a particle system to a ParticleSystemSet variable.
  71679. * Please note that the emitter shape is not exported
  71680. * @param systems defines the particle systems to export
  71681. * @returns the created particle system set
  71682. */
  71683. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  71684. /**
  71685. * Creates a particle system from a snippet saved in a remote file
  71686. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  71687. * @param url defines the url to load from
  71688. * @param scene defines the hosting scene
  71689. * @param gpu If the system will use gpu
  71690. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  71691. * @returns a promise that will resolve to the new particle system
  71692. */
  71693. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  71694. /**
  71695. * Creates a particle system from a snippet saved by the particle system editor
  71696. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  71697. * @param scene defines the hosting scene
  71698. * @param gpu If the system will use gpu
  71699. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  71700. * @returns a promise that will resolve to the new particle system
  71701. */
  71702. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  71703. }
  71704. }
  71705. declare module "babylonjs/Particles/particleSystemComponent" {
  71706. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71707. import { Effect } from "babylonjs/Materials/effect";
  71708. import "babylonjs/Shaders/particles.vertex";
  71709. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  71710. module "babylonjs/Engines/engine" {
  71711. interface Engine {
  71712. /**
  71713. * Create an effect to use with particle systems.
  71714. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  71715. * the particle system for which you want to create a custom effect in the last parameter
  71716. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  71717. * @param uniformsNames defines a list of attribute names
  71718. * @param samplers defines an array of string used to represent textures
  71719. * @param defines defines the string containing the defines to use to compile the shaders
  71720. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  71721. * @param onCompiled defines a function to call when the effect creation is successful
  71722. * @param onError defines a function to call when the effect creation has failed
  71723. * @param particleSystem the particle system you want to create the effect for
  71724. * @returns the new Effect
  71725. */
  71726. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  71727. }
  71728. }
  71729. module "babylonjs/Meshes/mesh" {
  71730. interface Mesh {
  71731. /**
  71732. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  71733. * @returns an array of IParticleSystem
  71734. */
  71735. getEmittedParticleSystems(): IParticleSystem[];
  71736. /**
  71737. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  71738. * @returns an array of IParticleSystem
  71739. */
  71740. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  71741. }
  71742. }
  71743. }
  71744. declare module "babylonjs/Particles/pointsCloudSystem" {
  71745. import { Color4 } from "babylonjs/Maths/math";
  71746. import { Mesh } from "babylonjs/Meshes/mesh";
  71747. import { Scene, IDisposable } from "babylonjs/scene";
  71748. import { CloudPoint } from "babylonjs/Particles/cloudPoint";
  71749. /** Defines the 4 color options */
  71750. export enum PointColor {
  71751. /** color value */
  71752. Color = 2,
  71753. /** uv value */
  71754. UV = 1,
  71755. /** random value */
  71756. Random = 0,
  71757. /** stated value */
  71758. Stated = 3
  71759. }
  71760. /**
  71761. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  71762. * 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.
  71763. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  71764. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  71765. *
  71766. * Full documentation here : TO BE ENTERED
  71767. */
  71768. export class PointsCloudSystem implements IDisposable {
  71769. /**
  71770. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  71771. * Example : var p = SPS.particles[i];
  71772. */
  71773. particles: CloudPoint[];
  71774. /**
  71775. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  71776. */
  71777. nbParticles: number;
  71778. /**
  71779. * This a counter for your own usage. It's not set by any SPS functions.
  71780. */
  71781. counter: number;
  71782. /**
  71783. * The PCS name. This name is also given to the underlying mesh.
  71784. */
  71785. name: string;
  71786. /**
  71787. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  71788. */
  71789. mesh: Mesh;
  71790. /**
  71791. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  71792. * Please read :
  71793. */
  71794. vars: any;
  71795. /**
  71796. * @hidden
  71797. */
  71798. _size: number;
  71799. private _scene;
  71800. private _promises;
  71801. private _positions;
  71802. private _indices;
  71803. private _normals;
  71804. private _colors;
  71805. private _uvs;
  71806. private _indices32;
  71807. private _positions32;
  71808. private _colors32;
  71809. private _uvs32;
  71810. private _updatable;
  71811. private _isVisibilityBoxLocked;
  71812. private _alwaysVisible;
  71813. private _groups;
  71814. private _groupCounter;
  71815. private _computeParticleColor;
  71816. private _computeParticleTexture;
  71817. private _computeParticleRotation;
  71818. private _computeBoundingBox;
  71819. private _isReady;
  71820. /**
  71821. * Creates a PCS (Points Cloud System) object
  71822. * @param name (String) is the PCS name, this will be the underlying mesh name
  71823. * @param pointSize (number) is the size for each point
  71824. * @param scene (Scene) is the scene in which the PCS is added
  71825. * @param options defines the options of the PCS e.g.
  71826. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  71827. */
  71828. constructor(name: string, pointSize: number, scene: Scene, options?: {
  71829. updatable?: boolean;
  71830. });
  71831. /**
  71832. * Builds the PCS underlying mesh. Returns a standard Mesh.
  71833. * If no points were added to the PCS, the returned mesh is just a single point.
  71834. * @returns a promise for the created mesh
  71835. */
  71836. buildMeshAsync(): Promise<Mesh>;
  71837. /**
  71838. * @hidden
  71839. */
  71840. private _buildMesh;
  71841. private _addParticle;
  71842. private _randomUnitVector;
  71843. private _getColorIndicesForCoord;
  71844. private _setPointsColorOrUV;
  71845. private _colorFromTexture;
  71846. private _calculateDensity;
  71847. /**
  71848. * Adds points to the PCS in random positions within a unit sphere
  71849. * @param nb (positive integer) the number of particles to be created from this model
  71850. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  71851. * @returns the number of groups in the system
  71852. */
  71853. addPoints(nb: number, pointFunction?: any): number;
  71854. /**
  71855. * Adds points to the PCS from the surface of the model shape
  71856. * @param mesh is any Mesh object that will be used as a surface model for the points
  71857. * @param nb (positive integer) the number of particles to be created from this model
  71858. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71859. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71860. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71861. * @returns the number of groups in the system
  71862. */
  71863. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71864. /**
  71865. * Adds points to the PCS inside the model shape
  71866. * @param mesh is any Mesh object that will be used as a surface model for the points
  71867. * @param nb (positive integer) the number of particles to be created from this model
  71868. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71869. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71870. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71871. * @returns the number of groups in the system
  71872. */
  71873. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71874. /**
  71875. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  71876. * This method calls `updateParticle()` for each particle of the SPS.
  71877. * For an animated SPS, it is usually called within the render loop.
  71878. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  71879. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  71880. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  71881. * @returns the PCS.
  71882. */
  71883. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  71884. /**
  71885. * Disposes the PCS.
  71886. */
  71887. dispose(): void;
  71888. /**
  71889. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  71890. * doc :
  71891. * @returns the PCS.
  71892. */
  71893. refreshVisibleSize(): PointsCloudSystem;
  71894. /**
  71895. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  71896. * @param size the size (float) of the visibility box
  71897. * note : this doesn't lock the PCS mesh bounding box.
  71898. * doc :
  71899. */
  71900. setVisibilityBox(size: number): void;
  71901. /**
  71902. * Gets whether the PCS is always visible or not
  71903. * doc :
  71904. */
  71905. get isAlwaysVisible(): boolean;
  71906. /**
  71907. * Sets the PCS as always visible or not
  71908. * doc :
  71909. */
  71910. set isAlwaysVisible(val: boolean);
  71911. /**
  71912. * Tells to `setParticles()` to compute the particle rotations or not
  71913. * Default value : false. The PCS is faster when it's set to false
  71914. * Note : particle rotations are only applied to parent particles
  71915. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  71916. */
  71917. set computeParticleRotation(val: boolean);
  71918. /**
  71919. * Tells to `setParticles()` to compute the particle colors or not.
  71920. * Default value : true. The PCS is faster when it's set to false.
  71921. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71922. */
  71923. set computeParticleColor(val: boolean);
  71924. set computeParticleTexture(val: boolean);
  71925. /**
  71926. * Gets if `setParticles()` computes the particle colors or not.
  71927. * Default value : false. The PCS is faster when it's set to false.
  71928. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71929. */
  71930. get computeParticleColor(): boolean;
  71931. /**
  71932. * Gets if `setParticles()` computes the particle textures or not.
  71933. * Default value : false. The PCS is faster when it's set to false.
  71934. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  71935. */
  71936. get computeParticleTexture(): boolean;
  71937. /**
  71938. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  71939. */
  71940. set computeBoundingBox(val: boolean);
  71941. /**
  71942. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  71943. */
  71944. get computeBoundingBox(): boolean;
  71945. /**
  71946. * This function does nothing. It may be overwritten to set all the particle first values.
  71947. * The PCS doesn't call this function, you may have to call it by your own.
  71948. * doc :
  71949. */
  71950. initParticles(): void;
  71951. /**
  71952. * This function does nothing. It may be overwritten to recycle a particle
  71953. * The PCS doesn't call this function, you can to call it
  71954. * doc :
  71955. * @param particle The particle to recycle
  71956. * @returns the recycled particle
  71957. */
  71958. recycleParticle(particle: CloudPoint): CloudPoint;
  71959. /**
  71960. * Updates a particle : this function should be overwritten by the user.
  71961. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  71962. * doc :
  71963. * @example : just set a particle position or velocity and recycle conditions
  71964. * @param particle The particle to update
  71965. * @returns the updated particle
  71966. */
  71967. updateParticle(particle: CloudPoint): CloudPoint;
  71968. /**
  71969. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  71970. * This does nothing and may be overwritten by the user.
  71971. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71972. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71973. * @param update the boolean update value actually passed to setParticles()
  71974. */
  71975. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71976. /**
  71977. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  71978. * This will be passed three parameters.
  71979. * This does nothing and may be overwritten by the user.
  71980. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71981. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71982. * @param update the boolean update value actually passed to setParticles()
  71983. */
  71984. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71985. }
  71986. }
  71987. declare module "babylonjs/Particles/cloudPoint" {
  71988. import { Nullable } from "babylonjs/types";
  71989. import { Color4, Vector2, Vector3, Matrix, Quaternion } from "babylonjs/Maths/math";
  71990. import { Mesh } from "babylonjs/Meshes/mesh";
  71991. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  71992. import { PointsCloudSystem } from "babylonjs/Particles/pointsCloudSystem";
  71993. /**
  71994. * Represents one particle of a points cloud system.
  71995. */
  71996. export class CloudPoint {
  71997. /**
  71998. * particle global index
  71999. */
  72000. idx: number;
  72001. /**
  72002. * The color of the particle
  72003. */
  72004. color: Nullable<Color4>;
  72005. /**
  72006. * The world space position of the particle.
  72007. */
  72008. position: Vector3;
  72009. /**
  72010. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  72011. */
  72012. rotation: Vector3;
  72013. /**
  72014. * The world space rotation quaternion of the particle.
  72015. */
  72016. rotationQuaternion: Nullable<Quaternion>;
  72017. /**
  72018. * The uv of the particle.
  72019. */
  72020. uv: Nullable<Vector2>;
  72021. /**
  72022. * The current speed of the particle.
  72023. */
  72024. velocity: Vector3;
  72025. /**
  72026. * The pivot point in the particle local space.
  72027. */
  72028. pivot: Vector3;
  72029. /**
  72030. * Must the particle be translated from its pivot point in its local space ?
  72031. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  72032. * Default : false
  72033. */
  72034. translateFromPivot: boolean;
  72035. /**
  72036. * Index of this particle in the global "positions" array (Internal use)
  72037. * @hidden
  72038. */
  72039. _pos: number;
  72040. /**
  72041. * @hidden Index of this particle in the global "indices" array (Internal use)
  72042. */
  72043. _ind: number;
  72044. /**
  72045. * Group this particle belongs to
  72046. */
  72047. _group: PointsGroup;
  72048. /**
  72049. * Group id of this particle
  72050. */
  72051. groupId: number;
  72052. /**
  72053. * Index of the particle in its group id (Internal use)
  72054. */
  72055. idxInGroup: number;
  72056. /**
  72057. * @hidden Particle BoundingInfo object (Internal use)
  72058. */
  72059. _boundingInfo: BoundingInfo;
  72060. /**
  72061. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  72062. */
  72063. _pcs: PointsCloudSystem;
  72064. /**
  72065. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  72066. */
  72067. _stillInvisible: boolean;
  72068. /**
  72069. * @hidden Last computed particle rotation matrix
  72070. */
  72071. _rotationMatrix: number[];
  72072. /**
  72073. * Parent particle Id, if any.
  72074. * Default null.
  72075. */
  72076. parentId: Nullable<number>;
  72077. /**
  72078. * @hidden Internal global position in the PCS.
  72079. */
  72080. _globalPosition: Vector3;
  72081. /**
  72082. * Creates a Point Cloud object.
  72083. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  72084. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  72085. * @param group (PointsGroup) is the group the particle belongs to
  72086. * @param groupId (integer) is the group identifier in the PCS.
  72087. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  72088. * @param pcs defines the PCS it is associated to
  72089. */
  72090. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  72091. /**
  72092. * get point size
  72093. */
  72094. get size(): Vector3;
  72095. /**
  72096. * Set point size
  72097. */
  72098. set size(scale: Vector3);
  72099. /**
  72100. * Legacy support, changed quaternion to rotationQuaternion
  72101. */
  72102. get quaternion(): Nullable<Quaternion>;
  72103. /**
  72104. * Legacy support, changed quaternion to rotationQuaternion
  72105. */
  72106. set quaternion(q: Nullable<Quaternion>);
  72107. /**
  72108. * Returns a boolean. True if the particle intersects a mesh, else false
  72109. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  72110. * @param target is the object (point or mesh) what the intersection is computed against
  72111. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  72112. * @returns true if it intersects
  72113. */
  72114. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  72115. /**
  72116. * get the rotation matrix of the particle
  72117. * @hidden
  72118. */
  72119. getRotationMatrix(m: Matrix): void;
  72120. }
  72121. /**
  72122. * Represents a group of points in a points cloud system
  72123. * * PCS internal tool, don't use it manually.
  72124. */
  72125. export class PointsGroup {
  72126. /**
  72127. * The group id
  72128. * @hidden
  72129. */
  72130. groupID: number;
  72131. /**
  72132. * image data for group (internal use)
  72133. * @hidden
  72134. */
  72135. _groupImageData: Nullable<ArrayBufferView>;
  72136. /**
  72137. * Image Width (internal use)
  72138. * @hidden
  72139. */
  72140. _groupImgWidth: number;
  72141. /**
  72142. * Image Height (internal use)
  72143. * @hidden
  72144. */
  72145. _groupImgHeight: number;
  72146. /**
  72147. * Custom position function (internal use)
  72148. * @hidden
  72149. */
  72150. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  72151. /**
  72152. * density per facet for surface points
  72153. * @hidden
  72154. */
  72155. _groupDensity: number[];
  72156. /**
  72157. * Only when points are colored by texture carries pointer to texture list array
  72158. * @hidden
  72159. */
  72160. _textureNb: number;
  72161. /**
  72162. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  72163. * PCS internal tool, don't use it manually.
  72164. * @hidden
  72165. */
  72166. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  72167. }
  72168. }
  72169. declare module "babylonjs/Particles/index" {
  72170. export * from "babylonjs/Particles/baseParticleSystem";
  72171. export * from "babylonjs/Particles/EmitterTypes/index";
  72172. export * from "babylonjs/Particles/gpuParticleSystem";
  72173. export * from "babylonjs/Particles/IParticleSystem";
  72174. export * from "babylonjs/Particles/particle";
  72175. export * from "babylonjs/Particles/particleHelper";
  72176. export * from "babylonjs/Particles/particleSystem";
  72177. import "babylonjs/Particles/particleSystemComponent";
  72178. export * from "babylonjs/Particles/particleSystemComponent";
  72179. export * from "babylonjs/Particles/particleSystemSet";
  72180. export * from "babylonjs/Particles/solidParticle";
  72181. export * from "babylonjs/Particles/solidParticleSystem";
  72182. export * from "babylonjs/Particles/cloudPoint";
  72183. export * from "babylonjs/Particles/pointsCloudSystem";
  72184. export * from "babylonjs/Particles/subEmitter";
  72185. }
  72186. declare module "babylonjs/Physics/physicsEngineComponent" {
  72187. import { Nullable } from "babylonjs/types";
  72188. import { Observable, Observer } from "babylonjs/Misc/observable";
  72189. import { Vector3 } from "babylonjs/Maths/math.vector";
  72190. import { Mesh } from "babylonjs/Meshes/mesh";
  72191. import { ISceneComponent } from "babylonjs/sceneComponent";
  72192. import { Scene } from "babylonjs/scene";
  72193. import { Node } from "babylonjs/node";
  72194. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  72195. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  72196. module "babylonjs/scene" {
  72197. interface Scene {
  72198. /** @hidden (Backing field) */
  72199. _physicsEngine: Nullable<IPhysicsEngine>;
  72200. /** @hidden */
  72201. _physicsTimeAccumulator: number;
  72202. /**
  72203. * Gets the current physics engine
  72204. * @returns a IPhysicsEngine or null if none attached
  72205. */
  72206. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  72207. /**
  72208. * Enables physics to the current scene
  72209. * @param gravity defines the scene's gravity for the physics engine
  72210. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  72211. * @return a boolean indicating if the physics engine was initialized
  72212. */
  72213. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  72214. /**
  72215. * Disables and disposes the physics engine associated with the scene
  72216. */
  72217. disablePhysicsEngine(): void;
  72218. /**
  72219. * Gets a boolean indicating if there is an active physics engine
  72220. * @returns a boolean indicating if there is an active physics engine
  72221. */
  72222. isPhysicsEnabled(): boolean;
  72223. /**
  72224. * Deletes a physics compound impostor
  72225. * @param compound defines the compound to delete
  72226. */
  72227. deleteCompoundImpostor(compound: any): void;
  72228. /**
  72229. * An event triggered when physic simulation is about to be run
  72230. */
  72231. onBeforePhysicsObservable: Observable<Scene>;
  72232. /**
  72233. * An event triggered when physic simulation has been done
  72234. */
  72235. onAfterPhysicsObservable: Observable<Scene>;
  72236. }
  72237. }
  72238. module "babylonjs/Meshes/abstractMesh" {
  72239. interface AbstractMesh {
  72240. /** @hidden */
  72241. _physicsImpostor: Nullable<PhysicsImpostor>;
  72242. /**
  72243. * Gets or sets impostor used for physic simulation
  72244. * @see https://doc.babylonjs.com/features/physics_engine
  72245. */
  72246. physicsImpostor: Nullable<PhysicsImpostor>;
  72247. /**
  72248. * Gets the current physics impostor
  72249. * @see https://doc.babylonjs.com/features/physics_engine
  72250. * @returns a physics impostor or null
  72251. */
  72252. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  72253. /** Apply a physic impulse to the mesh
  72254. * @param force defines the force to apply
  72255. * @param contactPoint defines where to apply the force
  72256. * @returns the current mesh
  72257. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  72258. */
  72259. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  72260. /**
  72261. * Creates a physic joint between two meshes
  72262. * @param otherMesh defines the other mesh to use
  72263. * @param pivot1 defines the pivot to use on this mesh
  72264. * @param pivot2 defines the pivot to use on the other mesh
  72265. * @param options defines additional options (can be plugin dependent)
  72266. * @returns the current mesh
  72267. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  72268. */
  72269. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  72270. /** @hidden */
  72271. _disposePhysicsObserver: Nullable<Observer<Node>>;
  72272. }
  72273. }
  72274. /**
  72275. * Defines the physics engine scene component responsible to manage a physics engine
  72276. */
  72277. export class PhysicsEngineSceneComponent implements ISceneComponent {
  72278. /**
  72279. * The component name helpful to identify the component in the list of scene components.
  72280. */
  72281. readonly name: string;
  72282. /**
  72283. * The scene the component belongs to.
  72284. */
  72285. scene: Scene;
  72286. /**
  72287. * Creates a new instance of the component for the given scene
  72288. * @param scene Defines the scene to register the component in
  72289. */
  72290. constructor(scene: Scene);
  72291. /**
  72292. * Registers the component in a given scene
  72293. */
  72294. register(): void;
  72295. /**
  72296. * Rebuilds the elements related to this component in case of
  72297. * context lost for instance.
  72298. */
  72299. rebuild(): void;
  72300. /**
  72301. * Disposes the component and the associated ressources
  72302. */
  72303. dispose(): void;
  72304. }
  72305. }
  72306. declare module "babylonjs/Physics/physicsHelper" {
  72307. import { Nullable } from "babylonjs/types";
  72308. import { Vector3 } from "babylonjs/Maths/math.vector";
  72309. import { Mesh } from "babylonjs/Meshes/mesh";
  72310. import { Scene } from "babylonjs/scene";
  72311. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  72312. /**
  72313. * A helper for physics simulations
  72314. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72315. */
  72316. export class PhysicsHelper {
  72317. private _scene;
  72318. private _physicsEngine;
  72319. /**
  72320. * Initializes the Physics helper
  72321. * @param scene Babylon.js scene
  72322. */
  72323. constructor(scene: Scene);
  72324. /**
  72325. * Applies a radial explosion impulse
  72326. * @param origin the origin of the explosion
  72327. * @param radiusOrEventOptions the radius or the options of radial explosion
  72328. * @param strength the explosion strength
  72329. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72330. * @returns A physics radial explosion event, or null
  72331. */
  72332. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72333. /**
  72334. * Applies a radial explosion force
  72335. * @param origin the origin of the explosion
  72336. * @param radiusOrEventOptions the radius or the options of radial explosion
  72337. * @param strength the explosion strength
  72338. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72339. * @returns A physics radial explosion event, or null
  72340. */
  72341. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72342. /**
  72343. * Creates a gravitational field
  72344. * @param origin the origin of the explosion
  72345. * @param radiusOrEventOptions the radius or the options of radial explosion
  72346. * @param strength the explosion strength
  72347. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72348. * @returns A physics gravitational field event, or null
  72349. */
  72350. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  72351. /**
  72352. * Creates a physics updraft event
  72353. * @param origin the origin of the updraft
  72354. * @param radiusOrEventOptions the radius or the options of the updraft
  72355. * @param strength the strength of the updraft
  72356. * @param height the height of the updraft
  72357. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  72358. * @returns A physics updraft event, or null
  72359. */
  72360. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  72361. /**
  72362. * Creates a physics vortex event
  72363. * @param origin the of the vortex
  72364. * @param radiusOrEventOptions the radius or the options of the vortex
  72365. * @param strength the strength of the vortex
  72366. * @param height the height of the vortex
  72367. * @returns a Physics vortex event, or null
  72368. * A physics vortex event or null
  72369. */
  72370. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  72371. }
  72372. /**
  72373. * Represents a physics radial explosion event
  72374. */
  72375. class PhysicsRadialExplosionEvent {
  72376. private _scene;
  72377. private _options;
  72378. private _sphere;
  72379. private _dataFetched;
  72380. /**
  72381. * Initializes a radial explosioin event
  72382. * @param _scene BabylonJS scene
  72383. * @param _options The options for the vortex event
  72384. */
  72385. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  72386. /**
  72387. * Returns the data related to the radial explosion event (sphere).
  72388. * @returns The radial explosion event data
  72389. */
  72390. getData(): PhysicsRadialExplosionEventData;
  72391. /**
  72392. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  72393. * @param impostor A physics imposter
  72394. * @param origin the origin of the explosion
  72395. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  72396. */
  72397. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  72398. /**
  72399. * Triggers affecterd impostors callbacks
  72400. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  72401. */
  72402. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  72403. /**
  72404. * Disposes the sphere.
  72405. * @param force Specifies if the sphere should be disposed by force
  72406. */
  72407. dispose(force?: boolean): void;
  72408. /*** Helpers ***/
  72409. private _prepareSphere;
  72410. private _intersectsWithSphere;
  72411. }
  72412. /**
  72413. * Represents a gravitational field event
  72414. */
  72415. class PhysicsGravitationalFieldEvent {
  72416. private _physicsHelper;
  72417. private _scene;
  72418. private _origin;
  72419. private _options;
  72420. private _tickCallback;
  72421. private _sphere;
  72422. private _dataFetched;
  72423. /**
  72424. * Initializes the physics gravitational field event
  72425. * @param _physicsHelper A physics helper
  72426. * @param _scene BabylonJS scene
  72427. * @param _origin The origin position of the gravitational field event
  72428. * @param _options The options for the vortex event
  72429. */
  72430. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  72431. /**
  72432. * Returns the data related to the gravitational field event (sphere).
  72433. * @returns A gravitational field event
  72434. */
  72435. getData(): PhysicsGravitationalFieldEventData;
  72436. /**
  72437. * Enables the gravitational field.
  72438. */
  72439. enable(): void;
  72440. /**
  72441. * Disables the gravitational field.
  72442. */
  72443. disable(): void;
  72444. /**
  72445. * Disposes the sphere.
  72446. * @param force The force to dispose from the gravitational field event
  72447. */
  72448. dispose(force?: boolean): void;
  72449. private _tick;
  72450. }
  72451. /**
  72452. * Represents a physics updraft event
  72453. */
  72454. class PhysicsUpdraftEvent {
  72455. private _scene;
  72456. private _origin;
  72457. private _options;
  72458. private _physicsEngine;
  72459. private _originTop;
  72460. private _originDirection;
  72461. private _tickCallback;
  72462. private _cylinder;
  72463. private _cylinderPosition;
  72464. private _dataFetched;
  72465. /**
  72466. * Initializes the physics updraft event
  72467. * @param _scene BabylonJS scene
  72468. * @param _origin The origin position of the updraft
  72469. * @param _options The options for the updraft event
  72470. */
  72471. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  72472. /**
  72473. * Returns the data related to the updraft event (cylinder).
  72474. * @returns A physics updraft event
  72475. */
  72476. getData(): PhysicsUpdraftEventData;
  72477. /**
  72478. * Enables the updraft.
  72479. */
  72480. enable(): void;
  72481. /**
  72482. * Disables the updraft.
  72483. */
  72484. disable(): void;
  72485. /**
  72486. * Disposes the cylinder.
  72487. * @param force Specifies if the updraft should be disposed by force
  72488. */
  72489. dispose(force?: boolean): void;
  72490. private getImpostorHitData;
  72491. private _tick;
  72492. /*** Helpers ***/
  72493. private _prepareCylinder;
  72494. private _intersectsWithCylinder;
  72495. }
  72496. /**
  72497. * Represents a physics vortex event
  72498. */
  72499. class PhysicsVortexEvent {
  72500. private _scene;
  72501. private _origin;
  72502. private _options;
  72503. private _physicsEngine;
  72504. private _originTop;
  72505. private _tickCallback;
  72506. private _cylinder;
  72507. private _cylinderPosition;
  72508. private _dataFetched;
  72509. /**
  72510. * Initializes the physics vortex event
  72511. * @param _scene The BabylonJS scene
  72512. * @param _origin The origin position of the vortex
  72513. * @param _options The options for the vortex event
  72514. */
  72515. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  72516. /**
  72517. * Returns the data related to the vortex event (cylinder).
  72518. * @returns The physics vortex event data
  72519. */
  72520. getData(): PhysicsVortexEventData;
  72521. /**
  72522. * Enables the vortex.
  72523. */
  72524. enable(): void;
  72525. /**
  72526. * Disables the cortex.
  72527. */
  72528. disable(): void;
  72529. /**
  72530. * Disposes the sphere.
  72531. * @param force
  72532. */
  72533. dispose(force?: boolean): void;
  72534. private getImpostorHitData;
  72535. private _tick;
  72536. /*** Helpers ***/
  72537. private _prepareCylinder;
  72538. private _intersectsWithCylinder;
  72539. }
  72540. /**
  72541. * Options fot the radial explosion event
  72542. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72543. */
  72544. export class PhysicsRadialExplosionEventOptions {
  72545. /**
  72546. * The radius of the sphere for the radial explosion.
  72547. */
  72548. radius: number;
  72549. /**
  72550. * The strenth of the explosion.
  72551. */
  72552. strength: number;
  72553. /**
  72554. * The strenght of the force in correspondence to the distance of the affected object
  72555. */
  72556. falloff: PhysicsRadialImpulseFalloff;
  72557. /**
  72558. * Sphere options for the radial explosion.
  72559. */
  72560. sphere: {
  72561. segments: number;
  72562. diameter: number;
  72563. };
  72564. /**
  72565. * Sphere options for the radial explosion.
  72566. */
  72567. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  72568. }
  72569. /**
  72570. * Options fot the updraft event
  72571. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72572. */
  72573. export class PhysicsUpdraftEventOptions {
  72574. /**
  72575. * The radius of the cylinder for the vortex
  72576. */
  72577. radius: number;
  72578. /**
  72579. * The strenth of the updraft.
  72580. */
  72581. strength: number;
  72582. /**
  72583. * The height of the cylinder for the updraft.
  72584. */
  72585. height: number;
  72586. /**
  72587. * The mode for the the updraft.
  72588. */
  72589. updraftMode: PhysicsUpdraftMode;
  72590. }
  72591. /**
  72592. * Options fot the vortex event
  72593. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72594. */
  72595. export class PhysicsVortexEventOptions {
  72596. /**
  72597. * The radius of the cylinder for the vortex
  72598. */
  72599. radius: number;
  72600. /**
  72601. * The strenth of the vortex.
  72602. */
  72603. strength: number;
  72604. /**
  72605. * The height of the cylinder for the vortex.
  72606. */
  72607. height: number;
  72608. /**
  72609. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  72610. */
  72611. centripetalForceThreshold: number;
  72612. /**
  72613. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  72614. */
  72615. centripetalForceMultiplier: number;
  72616. /**
  72617. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  72618. */
  72619. centrifugalForceMultiplier: number;
  72620. /**
  72621. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  72622. */
  72623. updraftForceMultiplier: number;
  72624. }
  72625. /**
  72626. * The strenght of the force in correspondence to the distance of the affected object
  72627. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72628. */
  72629. export enum PhysicsRadialImpulseFalloff {
  72630. /** Defines that impulse is constant in strength across it's whole radius */
  72631. Constant = 0,
  72632. /** Defines that impulse gets weaker if it's further from the origin */
  72633. Linear = 1
  72634. }
  72635. /**
  72636. * The strength of the force in correspondence to the distance of the affected object
  72637. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72638. */
  72639. export enum PhysicsUpdraftMode {
  72640. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  72641. Center = 0,
  72642. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  72643. Perpendicular = 1
  72644. }
  72645. /**
  72646. * Interface for a physics hit data
  72647. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72648. */
  72649. export interface PhysicsHitData {
  72650. /**
  72651. * The force applied at the contact point
  72652. */
  72653. force: Vector3;
  72654. /**
  72655. * The contact point
  72656. */
  72657. contactPoint: Vector3;
  72658. /**
  72659. * The distance from the origin to the contact point
  72660. */
  72661. distanceFromOrigin: number;
  72662. }
  72663. /**
  72664. * Interface for radial explosion event data
  72665. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72666. */
  72667. export interface PhysicsRadialExplosionEventData {
  72668. /**
  72669. * A sphere used for the radial explosion event
  72670. */
  72671. sphere: Mesh;
  72672. }
  72673. /**
  72674. * Interface for gravitational field event data
  72675. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72676. */
  72677. export interface PhysicsGravitationalFieldEventData {
  72678. /**
  72679. * A sphere mesh used for the gravitational field event
  72680. */
  72681. sphere: Mesh;
  72682. }
  72683. /**
  72684. * Interface for updraft event data
  72685. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72686. */
  72687. export interface PhysicsUpdraftEventData {
  72688. /**
  72689. * A cylinder used for the updraft event
  72690. */
  72691. cylinder: Mesh;
  72692. }
  72693. /**
  72694. * Interface for vortex event data
  72695. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72696. */
  72697. export interface PhysicsVortexEventData {
  72698. /**
  72699. * A cylinder used for the vortex event
  72700. */
  72701. cylinder: Mesh;
  72702. }
  72703. /**
  72704. * Interface for an affected physics impostor
  72705. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72706. */
  72707. export interface PhysicsAffectedImpostorWithData {
  72708. /**
  72709. * The impostor affected by the effect
  72710. */
  72711. impostor: PhysicsImpostor;
  72712. /**
  72713. * The data about the hit/horce from the explosion
  72714. */
  72715. hitData: PhysicsHitData;
  72716. }
  72717. }
  72718. declare module "babylonjs/Physics/Plugins/index" {
  72719. export * from "babylonjs/Physics/Plugins/cannonJSPlugin";
  72720. export * from "babylonjs/Physics/Plugins/ammoJSPlugin";
  72721. export * from "babylonjs/Physics/Plugins/oimoJSPlugin";
  72722. }
  72723. declare module "babylonjs/Physics/index" {
  72724. export * from "babylonjs/Physics/IPhysicsEngine";
  72725. export * from "babylonjs/Physics/physicsEngine";
  72726. export * from "babylonjs/Physics/physicsEngineComponent";
  72727. export * from "babylonjs/Physics/physicsHelper";
  72728. export * from "babylonjs/Physics/physicsImpostor";
  72729. export * from "babylonjs/Physics/physicsJoint";
  72730. export * from "babylonjs/Physics/Plugins/index";
  72731. }
  72732. declare module "babylonjs/Shaders/blackAndWhite.fragment" {
  72733. /** @hidden */
  72734. export var blackAndWhitePixelShader: {
  72735. name: string;
  72736. shader: string;
  72737. };
  72738. }
  72739. declare module "babylonjs/PostProcesses/blackAndWhitePostProcess" {
  72740. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72741. import { Camera } from "babylonjs/Cameras/camera";
  72742. import { Engine } from "babylonjs/Engines/engine";
  72743. import "babylonjs/Shaders/blackAndWhite.fragment";
  72744. import { Nullable } from "babylonjs/types";
  72745. import { Scene } from "babylonjs/scene";
  72746. /**
  72747. * Post process used to render in black and white
  72748. */
  72749. export class BlackAndWhitePostProcess extends PostProcess {
  72750. /**
  72751. * Linear about to convert he result to black and white (default: 1)
  72752. */
  72753. degree: number;
  72754. /**
  72755. * Gets a string identifying the name of the class
  72756. * @returns "BlackAndWhitePostProcess" string
  72757. */
  72758. getClassName(): string;
  72759. /**
  72760. * Creates a black and white post process
  72761. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  72762. * @param name The name of the effect.
  72763. * @param options The required width/height ratio to downsize to before computing the render pass.
  72764. * @param camera The camera to apply the render pass to.
  72765. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72766. * @param engine The engine which the post process will be applied. (default: current engine)
  72767. * @param reusable If the post process can be reused on the same frame. (default: false)
  72768. */
  72769. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72770. /** @hidden */
  72771. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  72772. }
  72773. }
  72774. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect" {
  72775. import { Nullable } from "babylonjs/types";
  72776. import { Camera } from "babylonjs/Cameras/camera";
  72777. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72778. import { Engine } from "babylonjs/Engines/engine";
  72779. /**
  72780. * This represents a set of one or more post processes in Babylon.
  72781. * A post process can be used to apply a shader to a texture after it is rendered.
  72782. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  72783. */
  72784. export class PostProcessRenderEffect {
  72785. private _postProcesses;
  72786. private _getPostProcesses;
  72787. private _singleInstance;
  72788. private _cameras;
  72789. private _indicesForCamera;
  72790. /**
  72791. * Name of the effect
  72792. * @hidden
  72793. */
  72794. _name: string;
  72795. /**
  72796. * Instantiates a post process render effect.
  72797. * A post process can be used to apply a shader to a texture after it is rendered.
  72798. * @param engine The engine the effect is tied to
  72799. * @param name The name of the effect
  72800. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  72801. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  72802. */
  72803. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  72804. /**
  72805. * Checks if all the post processes in the effect are supported.
  72806. */
  72807. get isSupported(): boolean;
  72808. /**
  72809. * Updates the current state of the effect
  72810. * @hidden
  72811. */
  72812. _update(): void;
  72813. /**
  72814. * Attaches the effect on cameras
  72815. * @param cameras The camera to attach to.
  72816. * @hidden
  72817. */
  72818. _attachCameras(cameras: Camera): void;
  72819. /**
  72820. * Attaches the effect on cameras
  72821. * @param cameras The camera to attach to.
  72822. * @hidden
  72823. */
  72824. _attachCameras(cameras: Camera[]): void;
  72825. /**
  72826. * Detaches the effect on cameras
  72827. * @param cameras The camera to detatch from.
  72828. * @hidden
  72829. */
  72830. _detachCameras(cameras: Camera): void;
  72831. /**
  72832. * Detatches the effect on cameras
  72833. * @param cameras The camera to detatch from.
  72834. * @hidden
  72835. */
  72836. _detachCameras(cameras: Camera[]): void;
  72837. /**
  72838. * Enables the effect on given cameras
  72839. * @param cameras The camera to enable.
  72840. * @hidden
  72841. */
  72842. _enable(cameras: Camera): void;
  72843. /**
  72844. * Enables the effect on given cameras
  72845. * @param cameras The camera to enable.
  72846. * @hidden
  72847. */
  72848. _enable(cameras: Nullable<Camera[]>): void;
  72849. /**
  72850. * Disables the effect on the given cameras
  72851. * @param cameras The camera to disable.
  72852. * @hidden
  72853. */
  72854. _disable(cameras: Camera): void;
  72855. /**
  72856. * Disables the effect on the given cameras
  72857. * @param cameras The camera to disable.
  72858. * @hidden
  72859. */
  72860. _disable(cameras: Nullable<Camera[]>): void;
  72861. /**
  72862. * Gets a list of the post processes contained in the effect.
  72863. * @param camera The camera to get the post processes on.
  72864. * @returns The list of the post processes in the effect.
  72865. */
  72866. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  72867. }
  72868. }
  72869. declare module "babylonjs/Shaders/extractHighlights.fragment" {
  72870. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  72871. /** @hidden */
  72872. export var extractHighlightsPixelShader: {
  72873. name: string;
  72874. shader: string;
  72875. };
  72876. }
  72877. declare module "babylonjs/PostProcesses/extractHighlightsPostProcess" {
  72878. import { Nullable } from "babylonjs/types";
  72879. import { Camera } from "babylonjs/Cameras/camera";
  72880. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72881. import { Engine } from "babylonjs/Engines/engine";
  72882. import "babylonjs/Shaders/extractHighlights.fragment";
  72883. /**
  72884. * 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.
  72885. */
  72886. export class ExtractHighlightsPostProcess extends PostProcess {
  72887. /**
  72888. * The luminance threshold, pixels below this value will be set to black.
  72889. */
  72890. threshold: number;
  72891. /** @hidden */
  72892. _exposure: number;
  72893. /**
  72894. * Post process which has the input texture to be used when performing highlight extraction
  72895. * @hidden
  72896. */
  72897. _inputPostProcess: Nullable<PostProcess>;
  72898. /**
  72899. * Gets a string identifying the name of the class
  72900. * @returns "ExtractHighlightsPostProcess" string
  72901. */
  72902. getClassName(): string;
  72903. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72904. }
  72905. }
  72906. declare module "babylonjs/Shaders/bloomMerge.fragment" {
  72907. /** @hidden */
  72908. export var bloomMergePixelShader: {
  72909. name: string;
  72910. shader: string;
  72911. };
  72912. }
  72913. declare module "babylonjs/PostProcesses/bloomMergePostProcess" {
  72914. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72915. import { Nullable } from "babylonjs/types";
  72916. import { Engine } from "babylonjs/Engines/engine";
  72917. import { Camera } from "babylonjs/Cameras/camera";
  72918. import "babylonjs/Shaders/bloomMerge.fragment";
  72919. /**
  72920. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  72921. */
  72922. export class BloomMergePostProcess extends PostProcess {
  72923. /** Weight of the bloom to be added to the original input. */
  72924. weight: number;
  72925. /**
  72926. * Gets a string identifying the name of the class
  72927. * @returns "BloomMergePostProcess" string
  72928. */
  72929. getClassName(): string;
  72930. /**
  72931. * Creates a new instance of @see BloomMergePostProcess
  72932. * @param name The name of the effect.
  72933. * @param originalFromInput Post process which's input will be used for the merge.
  72934. * @param blurred Blurred highlights post process which's output will be used.
  72935. * @param weight Weight of the bloom to be added to the original input.
  72936. * @param options The required width/height ratio to downsize to before computing the render pass.
  72937. * @param camera The camera to apply the render pass to.
  72938. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72939. * @param engine The engine which the post process will be applied. (default: current engine)
  72940. * @param reusable If the post process can be reused on the same frame. (default: false)
  72941. * @param textureType Type of textures used when performing the post process. (default: 0)
  72942. * @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)
  72943. */
  72944. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  72945. /** Weight of the bloom to be added to the original input. */
  72946. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72947. }
  72948. }
  72949. declare module "babylonjs/PostProcesses/bloomEffect" {
  72950. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  72951. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72952. import { ExtractHighlightsPostProcess } from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  72953. import { Camera } from "babylonjs/Cameras/camera";
  72954. import { Scene } from "babylonjs/scene";
  72955. /**
  72956. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  72957. */
  72958. export class BloomEffect extends PostProcessRenderEffect {
  72959. private bloomScale;
  72960. /**
  72961. * @hidden Internal
  72962. */
  72963. _effects: Array<PostProcess>;
  72964. /**
  72965. * @hidden Internal
  72966. */
  72967. _downscale: ExtractHighlightsPostProcess;
  72968. private _blurX;
  72969. private _blurY;
  72970. private _merge;
  72971. /**
  72972. * The luminance threshold to find bright areas of the image to bloom.
  72973. */
  72974. get threshold(): number;
  72975. set threshold(value: number);
  72976. /**
  72977. * The strength of the bloom.
  72978. */
  72979. get weight(): number;
  72980. set weight(value: number);
  72981. /**
  72982. * Specifies the size of the bloom blur kernel, relative to the final output size
  72983. */
  72984. get kernel(): number;
  72985. set kernel(value: number);
  72986. /**
  72987. * Creates a new instance of @see BloomEffect
  72988. * @param scene The scene the effect belongs to.
  72989. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  72990. * @param bloomKernel The size of the kernel to be used when applying the blur.
  72991. * @param bloomWeight The the strength of bloom.
  72992. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  72993. * @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)
  72994. */
  72995. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  72996. /**
  72997. * Disposes each of the internal effects for a given camera.
  72998. * @param camera The camera to dispose the effect on.
  72999. */
  73000. disposeEffects(camera: Camera): void;
  73001. /**
  73002. * @hidden Internal
  73003. */
  73004. _updateEffects(): void;
  73005. /**
  73006. * Internal
  73007. * @returns if all the contained post processes are ready.
  73008. * @hidden
  73009. */
  73010. _isReady(): boolean;
  73011. }
  73012. }
  73013. declare module "babylonjs/Shaders/chromaticAberration.fragment" {
  73014. /** @hidden */
  73015. export var chromaticAberrationPixelShader: {
  73016. name: string;
  73017. shader: string;
  73018. };
  73019. }
  73020. declare module "babylonjs/PostProcesses/chromaticAberrationPostProcess" {
  73021. import { Vector2 } from "babylonjs/Maths/math.vector";
  73022. import { Nullable } from "babylonjs/types";
  73023. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73024. import { Camera } from "babylonjs/Cameras/camera";
  73025. import { Engine } from "babylonjs/Engines/engine";
  73026. import "babylonjs/Shaders/chromaticAberration.fragment";
  73027. import { Scene } from "babylonjs/scene";
  73028. /**
  73029. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  73030. */
  73031. export class ChromaticAberrationPostProcess extends PostProcess {
  73032. /**
  73033. * The amount of seperation of rgb channels (default: 30)
  73034. */
  73035. aberrationAmount: number;
  73036. /**
  73037. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  73038. */
  73039. radialIntensity: number;
  73040. /**
  73041. * 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))
  73042. */
  73043. direction: Vector2;
  73044. /**
  73045. * 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))
  73046. */
  73047. centerPosition: Vector2;
  73048. /** The width of the screen to apply the effect on */
  73049. screenWidth: number;
  73050. /** The height of the screen to apply the effect on */
  73051. screenHeight: number;
  73052. /**
  73053. * Gets a string identifying the name of the class
  73054. * @returns "ChromaticAberrationPostProcess" string
  73055. */
  73056. getClassName(): string;
  73057. /**
  73058. * Creates a new instance ChromaticAberrationPostProcess
  73059. * @param name The name of the effect.
  73060. * @param screenWidth The width of the screen to apply the effect on.
  73061. * @param screenHeight The height of the screen to apply the effect on.
  73062. * @param options The required width/height ratio to downsize to before computing the render pass.
  73063. * @param camera The camera to apply the render pass to.
  73064. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73065. * @param engine The engine which the post process will be applied. (default: current engine)
  73066. * @param reusable If the post process can be reused on the same frame. (default: false)
  73067. * @param textureType Type of textures used when performing the post process. (default: 0)
  73068. * @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)
  73069. */
  73070. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73071. /** @hidden */
  73072. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  73073. }
  73074. }
  73075. declare module "babylonjs/Shaders/circleOfConfusion.fragment" {
  73076. /** @hidden */
  73077. export var circleOfConfusionPixelShader: {
  73078. name: string;
  73079. shader: string;
  73080. };
  73081. }
  73082. declare module "babylonjs/PostProcesses/circleOfConfusionPostProcess" {
  73083. import { Nullable } from "babylonjs/types";
  73084. import { Engine } from "babylonjs/Engines/engine";
  73085. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73086. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  73087. import { Camera } from "babylonjs/Cameras/camera";
  73088. import "babylonjs/Shaders/circleOfConfusion.fragment";
  73089. /**
  73090. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  73091. */
  73092. export class CircleOfConfusionPostProcess extends PostProcess {
  73093. /**
  73094. * 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.
  73095. */
  73096. lensSize: number;
  73097. /**
  73098. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  73099. */
  73100. fStop: number;
  73101. /**
  73102. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  73103. */
  73104. focusDistance: number;
  73105. /**
  73106. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  73107. */
  73108. focalLength: number;
  73109. /**
  73110. * Gets a string identifying the name of the class
  73111. * @returns "CircleOfConfusionPostProcess" string
  73112. */
  73113. getClassName(): string;
  73114. private _depthTexture;
  73115. /**
  73116. * Creates a new instance CircleOfConfusionPostProcess
  73117. * @param name The name of the effect.
  73118. * @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.
  73119. * @param options The required width/height ratio to downsize to before computing the render pass.
  73120. * @param camera The camera to apply the render pass to.
  73121. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73122. * @param engine The engine which the post process will be applied. (default: current engine)
  73123. * @param reusable If the post process can be reused on the same frame. (default: false)
  73124. * @param textureType Type of textures used when performing the post process. (default: 0)
  73125. * @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)
  73126. */
  73127. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73128. /**
  73129. * 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.
  73130. */
  73131. set depthTexture(value: RenderTargetTexture);
  73132. }
  73133. }
  73134. declare module "babylonjs/Shaders/colorCorrection.fragment" {
  73135. /** @hidden */
  73136. export var colorCorrectionPixelShader: {
  73137. name: string;
  73138. shader: string;
  73139. };
  73140. }
  73141. declare module "babylonjs/PostProcesses/colorCorrectionPostProcess" {
  73142. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73143. import { Engine } from "babylonjs/Engines/engine";
  73144. import { Camera } from "babylonjs/Cameras/camera";
  73145. import "babylonjs/Shaders/colorCorrection.fragment";
  73146. import { Nullable } from "babylonjs/types";
  73147. import { Scene } from "babylonjs/scene";
  73148. /**
  73149. *
  73150. * This post-process allows the modification of rendered colors by using
  73151. * a 'look-up table' (LUT). This effect is also called Color Grading.
  73152. *
  73153. * The object needs to be provided an url to a texture containing the color
  73154. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  73155. * Use an image editing software to tweak the LUT to match your needs.
  73156. *
  73157. * For an example of a color LUT, see here:
  73158. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  73159. * For explanations on color grading, see here:
  73160. * @see http://udn.epicgames.com/Three/ColorGrading.html
  73161. *
  73162. */
  73163. export class ColorCorrectionPostProcess extends PostProcess {
  73164. private _colorTableTexture;
  73165. /**
  73166. * Gets the color table url used to create the LUT texture
  73167. */
  73168. colorTableUrl: string;
  73169. /**
  73170. * Gets a string identifying the name of the class
  73171. * @returns "ColorCorrectionPostProcess" string
  73172. */
  73173. getClassName(): string;
  73174. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73175. /** @hidden */
  73176. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  73177. }
  73178. }
  73179. declare module "babylonjs/Shaders/convolution.fragment" {
  73180. /** @hidden */
  73181. export var convolutionPixelShader: {
  73182. name: string;
  73183. shader: string;
  73184. };
  73185. }
  73186. declare module "babylonjs/PostProcesses/convolutionPostProcess" {
  73187. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73188. import { Nullable } from "babylonjs/types";
  73189. import { Camera } from "babylonjs/Cameras/camera";
  73190. import { Engine } from "babylonjs/Engines/engine";
  73191. import "babylonjs/Shaders/convolution.fragment";
  73192. import { Scene } from "babylonjs/scene";
  73193. /**
  73194. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  73195. * input texture to perform effects such as edge detection or sharpening
  73196. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  73197. */
  73198. export class ConvolutionPostProcess extends PostProcess {
  73199. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  73200. kernel: number[];
  73201. /**
  73202. * Gets a string identifying the name of the class
  73203. * @returns "ConvolutionPostProcess" string
  73204. */
  73205. getClassName(): string;
  73206. /**
  73207. * Creates a new instance ConvolutionPostProcess
  73208. * @param name The name of the effect.
  73209. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  73210. * @param options The required width/height ratio to downsize to before computing the render pass.
  73211. * @param camera The camera to apply the render pass to.
  73212. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73213. * @param engine The engine which the post process will be applied. (default: current engine)
  73214. * @param reusable If the post process can be reused on the same frame. (default: false)
  73215. * @param textureType Type of textures used when performing the post process. (default: 0)
  73216. */
  73217. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73218. /** @hidden */
  73219. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  73220. /**
  73221. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73222. */
  73223. static EdgeDetect0Kernel: number[];
  73224. /**
  73225. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73226. */
  73227. static EdgeDetect1Kernel: number[];
  73228. /**
  73229. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73230. */
  73231. static EdgeDetect2Kernel: number[];
  73232. /**
  73233. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73234. */
  73235. static SharpenKernel: number[];
  73236. /**
  73237. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73238. */
  73239. static EmbossKernel: number[];
  73240. /**
  73241. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  73242. */
  73243. static GaussianKernel: number[];
  73244. }
  73245. }
  73246. declare module "babylonjs/PostProcesses/depthOfFieldBlurPostProcess" {
  73247. import { Nullable } from "babylonjs/types";
  73248. import { Vector2 } from "babylonjs/Maths/math.vector";
  73249. import { Camera } from "babylonjs/Cameras/camera";
  73250. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73251. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  73252. import { Engine } from "babylonjs/Engines/engine";
  73253. import { Scene } from "babylonjs/scene";
  73254. /**
  73255. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  73256. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  73257. * based on samples that have a large difference in distance than the center pixel.
  73258. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  73259. */
  73260. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  73261. /**
  73262. * The direction the blur should be applied
  73263. */
  73264. direction: Vector2;
  73265. /**
  73266. * Gets a string identifying the name of the class
  73267. * @returns "DepthOfFieldBlurPostProcess" string
  73268. */
  73269. getClassName(): string;
  73270. /**
  73271. * Creates a new instance CircleOfConfusionPostProcess
  73272. * @param name The name of the effect.
  73273. * @param scene The scene the effect belongs to.
  73274. * @param direction The direction the blur should be applied.
  73275. * @param kernel The size of the kernel used to blur.
  73276. * @param options The required width/height ratio to downsize to before computing the render pass.
  73277. * @param camera The camera to apply the render pass to.
  73278. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  73279. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  73280. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73281. * @param engine The engine which the post process will be applied. (default: current engine)
  73282. * @param reusable If the post process can be reused on the same frame. (default: false)
  73283. * @param textureType Type of textures used when performing the post process. (default: 0)
  73284. * @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)
  73285. */
  73286. 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);
  73287. }
  73288. }
  73289. declare module "babylonjs/Shaders/depthOfFieldMerge.fragment" {
  73290. /** @hidden */
  73291. export var depthOfFieldMergePixelShader: {
  73292. name: string;
  73293. shader: string;
  73294. };
  73295. }
  73296. declare module "babylonjs/PostProcesses/depthOfFieldMergePostProcess" {
  73297. import { Nullable } from "babylonjs/types";
  73298. import { Camera } from "babylonjs/Cameras/camera";
  73299. import { Effect } from "babylonjs/Materials/effect";
  73300. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73301. import { Engine } from "babylonjs/Engines/engine";
  73302. import "babylonjs/Shaders/depthOfFieldMerge.fragment";
  73303. /**
  73304. * Options to be set when merging outputs from the default pipeline.
  73305. */
  73306. export class DepthOfFieldMergePostProcessOptions {
  73307. /**
  73308. * The original image to merge on top of
  73309. */
  73310. originalFromInput: PostProcess;
  73311. /**
  73312. * Parameters to perform the merge of the depth of field effect
  73313. */
  73314. depthOfField?: {
  73315. circleOfConfusion: PostProcess;
  73316. blurSteps: Array<PostProcess>;
  73317. };
  73318. /**
  73319. * Parameters to perform the merge of bloom effect
  73320. */
  73321. bloom?: {
  73322. blurred: PostProcess;
  73323. weight: number;
  73324. };
  73325. }
  73326. /**
  73327. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  73328. */
  73329. export class DepthOfFieldMergePostProcess extends PostProcess {
  73330. private blurSteps;
  73331. /**
  73332. * Gets a string identifying the name of the class
  73333. * @returns "DepthOfFieldMergePostProcess" string
  73334. */
  73335. getClassName(): string;
  73336. /**
  73337. * Creates a new instance of DepthOfFieldMergePostProcess
  73338. * @param name The name of the effect.
  73339. * @param originalFromInput Post process which's input will be used for the merge.
  73340. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  73341. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  73342. * @param options The required width/height ratio to downsize to before computing the render pass.
  73343. * @param camera The camera to apply the render pass to.
  73344. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73345. * @param engine The engine which the post process will be applied. (default: current engine)
  73346. * @param reusable If the post process can be reused on the same frame. (default: false)
  73347. * @param textureType Type of textures used when performing the post process. (default: 0)
  73348. * @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)
  73349. */
  73350. 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);
  73351. /**
  73352. * Updates the effect with the current post process compile time values and recompiles the shader.
  73353. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  73354. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  73355. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  73356. * @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
  73357. * @param onCompiled Called when the shader has been compiled.
  73358. * @param onError Called if there is an error when compiling a shader.
  73359. */
  73360. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  73361. }
  73362. }
  73363. declare module "babylonjs/PostProcesses/depthOfFieldEffect" {
  73364. import { Nullable } from "babylonjs/types";
  73365. import { Camera } from "babylonjs/Cameras/camera";
  73366. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  73367. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  73368. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73369. import { DepthOfFieldBlurPostProcess } from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  73370. import { Scene } from "babylonjs/scene";
  73371. /**
  73372. * Specifies the level of max blur that should be applied when using the depth of field effect
  73373. */
  73374. export enum DepthOfFieldEffectBlurLevel {
  73375. /**
  73376. * Subtle blur
  73377. */
  73378. Low = 0,
  73379. /**
  73380. * Medium blur
  73381. */
  73382. Medium = 1,
  73383. /**
  73384. * Large blur
  73385. */
  73386. High = 2
  73387. }
  73388. /**
  73389. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  73390. */
  73391. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  73392. private _circleOfConfusion;
  73393. /**
  73394. * @hidden Internal, blurs from high to low
  73395. */
  73396. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  73397. private _depthOfFieldBlurY;
  73398. private _dofMerge;
  73399. /**
  73400. * @hidden Internal post processes in depth of field effect
  73401. */
  73402. _effects: Array<PostProcess>;
  73403. /**
  73404. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  73405. */
  73406. set focalLength(value: number);
  73407. get focalLength(): number;
  73408. /**
  73409. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  73410. */
  73411. set fStop(value: number);
  73412. get fStop(): number;
  73413. /**
  73414. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  73415. */
  73416. set focusDistance(value: number);
  73417. get focusDistance(): number;
  73418. /**
  73419. * 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.
  73420. */
  73421. set lensSize(value: number);
  73422. get lensSize(): number;
  73423. /**
  73424. * Creates a new instance DepthOfFieldEffect
  73425. * @param scene The scene the effect belongs to.
  73426. * @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.
  73427. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  73428. * @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)
  73429. */
  73430. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  73431. /**
  73432. * Get the current class name of the current effet
  73433. * @returns "DepthOfFieldEffect"
  73434. */
  73435. getClassName(): string;
  73436. /**
  73437. * 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.
  73438. */
  73439. set depthTexture(value: RenderTargetTexture);
  73440. /**
  73441. * Disposes each of the internal effects for a given camera.
  73442. * @param camera The camera to dispose the effect on.
  73443. */
  73444. disposeEffects(camera: Camera): void;
  73445. /**
  73446. * @hidden Internal
  73447. */
  73448. _updateEffects(): void;
  73449. /**
  73450. * Internal
  73451. * @returns if all the contained post processes are ready.
  73452. * @hidden
  73453. */
  73454. _isReady(): boolean;
  73455. }
  73456. }
  73457. declare module "babylonjs/Shaders/displayPass.fragment" {
  73458. /** @hidden */
  73459. export var displayPassPixelShader: {
  73460. name: string;
  73461. shader: string;
  73462. };
  73463. }
  73464. declare module "babylonjs/PostProcesses/displayPassPostProcess" {
  73465. import { Nullable } from "babylonjs/types";
  73466. import { Camera } from "babylonjs/Cameras/camera";
  73467. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73468. import { Engine } from "babylonjs/Engines/engine";
  73469. import "babylonjs/Shaders/displayPass.fragment";
  73470. import { Scene } from "babylonjs/scene";
  73471. /**
  73472. * DisplayPassPostProcess which produces an output the same as it's input
  73473. */
  73474. export class DisplayPassPostProcess extends PostProcess {
  73475. /**
  73476. * Gets a string identifying the name of the class
  73477. * @returns "DisplayPassPostProcess" string
  73478. */
  73479. getClassName(): string;
  73480. /**
  73481. * Creates the DisplayPassPostProcess
  73482. * @param name The name of the effect.
  73483. * @param options The required width/height ratio to downsize to before computing the render pass.
  73484. * @param camera The camera to apply the render pass to.
  73485. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73486. * @param engine The engine which the post process will be applied. (default: current engine)
  73487. * @param reusable If the post process can be reused on the same frame. (default: false)
  73488. */
  73489. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73490. /** @hidden */
  73491. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  73492. }
  73493. }
  73494. declare module "babylonjs/Shaders/filter.fragment" {
  73495. /** @hidden */
  73496. export var filterPixelShader: {
  73497. name: string;
  73498. shader: string;
  73499. };
  73500. }
  73501. declare module "babylonjs/PostProcesses/filterPostProcess" {
  73502. import { Nullable } from "babylonjs/types";
  73503. import { Matrix } from "babylonjs/Maths/math.vector";
  73504. import { Camera } from "babylonjs/Cameras/camera";
  73505. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73506. import { Engine } from "babylonjs/Engines/engine";
  73507. import "babylonjs/Shaders/filter.fragment";
  73508. import { Scene } from "babylonjs/scene";
  73509. /**
  73510. * Applies a kernel filter to the image
  73511. */
  73512. export class FilterPostProcess extends PostProcess {
  73513. /** The matrix to be applied to the image */
  73514. kernelMatrix: Matrix;
  73515. /**
  73516. * Gets a string identifying the name of the class
  73517. * @returns "FilterPostProcess" string
  73518. */
  73519. getClassName(): string;
  73520. /**
  73521. *
  73522. * @param name The name of the effect.
  73523. * @param kernelMatrix The matrix to be applied to the image
  73524. * @param options The required width/height ratio to downsize to before computing the render pass.
  73525. * @param camera The camera to apply the render pass to.
  73526. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73527. * @param engine The engine which the post process will be applied. (default: current engine)
  73528. * @param reusable If the post process can be reused on the same frame. (default: false)
  73529. */
  73530. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73531. /** @hidden */
  73532. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  73533. }
  73534. }
  73535. declare module "babylonjs/Shaders/fxaa.fragment" {
  73536. /** @hidden */
  73537. export var fxaaPixelShader: {
  73538. name: string;
  73539. shader: string;
  73540. };
  73541. }
  73542. declare module "babylonjs/Shaders/fxaa.vertex" {
  73543. /** @hidden */
  73544. export var fxaaVertexShader: {
  73545. name: string;
  73546. shader: string;
  73547. };
  73548. }
  73549. declare module "babylonjs/PostProcesses/fxaaPostProcess" {
  73550. import { Nullable } from "babylonjs/types";
  73551. import { Camera } from "babylonjs/Cameras/camera";
  73552. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73553. import { Engine } from "babylonjs/Engines/engine";
  73554. import "babylonjs/Shaders/fxaa.fragment";
  73555. import "babylonjs/Shaders/fxaa.vertex";
  73556. import { Scene } from "babylonjs/scene";
  73557. /**
  73558. * Fxaa post process
  73559. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  73560. */
  73561. export class FxaaPostProcess extends PostProcess {
  73562. /**
  73563. * Gets a string identifying the name of the class
  73564. * @returns "FxaaPostProcess" string
  73565. */
  73566. getClassName(): string;
  73567. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73568. private _getDefines;
  73569. /** @hidden */
  73570. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  73571. }
  73572. }
  73573. declare module "babylonjs/Shaders/grain.fragment" {
  73574. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  73575. /** @hidden */
  73576. export var grainPixelShader: {
  73577. name: string;
  73578. shader: string;
  73579. };
  73580. }
  73581. declare module "babylonjs/PostProcesses/grainPostProcess" {
  73582. import { Nullable } from "babylonjs/types";
  73583. import { Camera } from "babylonjs/Cameras/camera";
  73584. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73585. import { Engine } from "babylonjs/Engines/engine";
  73586. import "babylonjs/Shaders/grain.fragment";
  73587. import { Scene } from "babylonjs/scene";
  73588. /**
  73589. * The GrainPostProcess adds noise to the image at mid luminance levels
  73590. */
  73591. export class GrainPostProcess extends PostProcess {
  73592. /**
  73593. * The intensity of the grain added (default: 30)
  73594. */
  73595. intensity: number;
  73596. /**
  73597. * If the grain should be randomized on every frame
  73598. */
  73599. animated: boolean;
  73600. /**
  73601. * Gets a string identifying the name of the class
  73602. * @returns "GrainPostProcess" string
  73603. */
  73604. getClassName(): string;
  73605. /**
  73606. * Creates a new instance of @see GrainPostProcess
  73607. * @param name The name of the effect.
  73608. * @param options The required width/height ratio to downsize to before computing the render pass.
  73609. * @param camera The camera to apply the render pass to.
  73610. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73611. * @param engine The engine which the post process will be applied. (default: current engine)
  73612. * @param reusable If the post process can be reused on the same frame. (default: false)
  73613. * @param textureType Type of textures used when performing the post process. (default: 0)
  73614. * @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)
  73615. */
  73616. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73617. /** @hidden */
  73618. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  73619. }
  73620. }
  73621. declare module "babylonjs/Shaders/highlights.fragment" {
  73622. /** @hidden */
  73623. export var highlightsPixelShader: {
  73624. name: string;
  73625. shader: string;
  73626. };
  73627. }
  73628. declare module "babylonjs/PostProcesses/highlightsPostProcess" {
  73629. import { Nullable } from "babylonjs/types";
  73630. import { Camera } from "babylonjs/Cameras/camera";
  73631. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73632. import { Engine } from "babylonjs/Engines/engine";
  73633. import "babylonjs/Shaders/highlights.fragment";
  73634. /**
  73635. * Extracts highlights from the image
  73636. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  73637. */
  73638. export class HighlightsPostProcess extends PostProcess {
  73639. /**
  73640. * Gets a string identifying the name of the class
  73641. * @returns "HighlightsPostProcess" string
  73642. */
  73643. getClassName(): string;
  73644. /**
  73645. * Extracts highlights from the image
  73646. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  73647. * @param name The name of the effect.
  73648. * @param options The required width/height ratio to downsize to before computing the render pass.
  73649. * @param camera The camera to apply the render pass to.
  73650. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73651. * @param engine The engine which the post process will be applied. (default: current engine)
  73652. * @param reusable If the post process can be reused on the same frame. (default: false)
  73653. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  73654. */
  73655. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73656. }
  73657. }
  73658. declare module "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration" {
  73659. /** @hidden */
  73660. export var mrtFragmentDeclaration: {
  73661. name: string;
  73662. shader: string;
  73663. };
  73664. }
  73665. declare module "babylonjs/Shaders/geometry.fragment" {
  73666. import "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration";
  73667. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  73668. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  73669. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  73670. /** @hidden */
  73671. export var geometryPixelShader: {
  73672. name: string;
  73673. shader: string;
  73674. };
  73675. }
  73676. declare module "babylonjs/Shaders/geometry.vertex" {
  73677. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  73678. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  73679. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  73680. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  73681. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  73682. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  73683. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  73684. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  73685. /** @hidden */
  73686. export var geometryVertexShader: {
  73687. name: string;
  73688. shader: string;
  73689. };
  73690. }
  73691. declare module "babylonjs/Rendering/geometryBufferRenderer" {
  73692. import { Matrix } from "babylonjs/Maths/math.vector";
  73693. import { SubMesh } from "babylonjs/Meshes/subMesh";
  73694. import { Mesh } from "babylonjs/Meshes/mesh";
  73695. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  73696. import { Effect } from "babylonjs/Materials/effect";
  73697. import { Scene } from "babylonjs/scene";
  73698. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73699. import "babylonjs/Shaders/geometry.fragment";
  73700. import "babylonjs/Shaders/geometry.vertex";
  73701. /** @hidden */
  73702. interface ISavedTransformationMatrix {
  73703. world: Matrix;
  73704. viewProjection: Matrix;
  73705. }
  73706. /**
  73707. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  73708. */
  73709. export class GeometryBufferRenderer {
  73710. /**
  73711. * Constant used to retrieve the position texture index in the G-Buffer textures array
  73712. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  73713. */
  73714. static readonly POSITION_TEXTURE_TYPE: number;
  73715. /**
  73716. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  73717. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  73718. */
  73719. static readonly VELOCITY_TEXTURE_TYPE: number;
  73720. /**
  73721. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  73722. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  73723. */
  73724. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  73725. /**
  73726. * Dictionary used to store the previous transformation matrices of each rendered mesh
  73727. * in order to compute objects velocities when enableVelocity is set to "true"
  73728. * @hidden
  73729. */
  73730. _previousTransformationMatrices: {
  73731. [index: number]: ISavedTransformationMatrix;
  73732. };
  73733. /**
  73734. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  73735. * in order to compute objects velocities when enableVelocity is set to "true"
  73736. * @hidden
  73737. */
  73738. _previousBonesTransformationMatrices: {
  73739. [index: number]: Float32Array;
  73740. };
  73741. /**
  73742. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  73743. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  73744. */
  73745. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  73746. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  73747. renderTransparentMeshes: boolean;
  73748. private _scene;
  73749. private _resizeObserver;
  73750. private _multiRenderTarget;
  73751. private _ratio;
  73752. private _enablePosition;
  73753. private _enableVelocity;
  73754. private _enableReflectivity;
  73755. private _positionIndex;
  73756. private _velocityIndex;
  73757. private _reflectivityIndex;
  73758. protected _effect: Effect;
  73759. protected _cachedDefines: string;
  73760. /**
  73761. * Set the render list (meshes to be rendered) used in the G buffer.
  73762. */
  73763. set renderList(meshes: Mesh[]);
  73764. /**
  73765. * Gets wether or not G buffer are supported by the running hardware.
  73766. * This requires draw buffer supports
  73767. */
  73768. get isSupported(): boolean;
  73769. /**
  73770. * Returns the index of the given texture type in the G-Buffer textures array
  73771. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  73772. * @returns the index of the given texture type in the G-Buffer textures array
  73773. */
  73774. getTextureIndex(textureType: number): number;
  73775. /**
  73776. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  73777. */
  73778. get enablePosition(): boolean;
  73779. /**
  73780. * Sets whether or not objects positions are enabled for the G buffer.
  73781. */
  73782. set enablePosition(enable: boolean);
  73783. /**
  73784. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  73785. */
  73786. get enableVelocity(): boolean;
  73787. /**
  73788. * Sets wether or not objects velocities are enabled for the G buffer.
  73789. */
  73790. set enableVelocity(enable: boolean);
  73791. /**
  73792. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  73793. */
  73794. get enableReflectivity(): boolean;
  73795. /**
  73796. * Sets wether or not objects roughness are enabled for the G buffer.
  73797. */
  73798. set enableReflectivity(enable: boolean);
  73799. /**
  73800. * Gets the scene associated with the buffer.
  73801. */
  73802. get scene(): Scene;
  73803. /**
  73804. * Gets the ratio used by the buffer during its creation.
  73805. * How big is the buffer related to the main canvas.
  73806. */
  73807. get ratio(): number;
  73808. /** @hidden */
  73809. static _SceneComponentInitialization: (scene: Scene) => void;
  73810. /**
  73811. * Creates a new G Buffer for the scene
  73812. * @param scene The scene the buffer belongs to
  73813. * @param ratio How big is the buffer related to the main canvas.
  73814. */
  73815. constructor(scene: Scene, ratio?: number);
  73816. /**
  73817. * Checks wether everything is ready to render a submesh to the G buffer.
  73818. * @param subMesh the submesh to check readiness for
  73819. * @param useInstances is the mesh drawn using instance or not
  73820. * @returns true if ready otherwise false
  73821. */
  73822. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  73823. /**
  73824. * Gets the current underlying G Buffer.
  73825. * @returns the buffer
  73826. */
  73827. getGBuffer(): MultiRenderTarget;
  73828. /**
  73829. * Gets the number of samples used to render the buffer (anti aliasing).
  73830. */
  73831. get samples(): number;
  73832. /**
  73833. * Sets the number of samples used to render the buffer (anti aliasing).
  73834. */
  73835. set samples(value: number);
  73836. /**
  73837. * Disposes the renderer and frees up associated resources.
  73838. */
  73839. dispose(): void;
  73840. protected _createRenderTargets(): void;
  73841. private _copyBonesTransformationMatrices;
  73842. }
  73843. }
  73844. declare module "babylonjs/Rendering/geometryBufferRendererSceneComponent" {
  73845. import { Nullable } from "babylonjs/types";
  73846. import { Scene } from "babylonjs/scene";
  73847. import { ISceneComponent } from "babylonjs/sceneComponent";
  73848. import { GeometryBufferRenderer } from "babylonjs/Rendering/geometryBufferRenderer";
  73849. module "babylonjs/scene" {
  73850. interface Scene {
  73851. /** @hidden (Backing field) */
  73852. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73853. /**
  73854. * Gets or Sets the current geometry buffer associated to the scene.
  73855. */
  73856. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73857. /**
  73858. * Enables a GeometryBufferRender and associates it with the scene
  73859. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  73860. * @returns the GeometryBufferRenderer
  73861. */
  73862. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  73863. /**
  73864. * Disables the GeometryBufferRender associated with the scene
  73865. */
  73866. disableGeometryBufferRenderer(): void;
  73867. }
  73868. }
  73869. /**
  73870. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  73871. * in several rendering techniques.
  73872. */
  73873. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  73874. /**
  73875. * The component name helpful to identify the component in the list of scene components.
  73876. */
  73877. readonly name: string;
  73878. /**
  73879. * The scene the component belongs to.
  73880. */
  73881. scene: Scene;
  73882. /**
  73883. * Creates a new instance of the component for the given scene
  73884. * @param scene Defines the scene to register the component in
  73885. */
  73886. constructor(scene: Scene);
  73887. /**
  73888. * Registers the component in a given scene
  73889. */
  73890. register(): void;
  73891. /**
  73892. * Rebuilds the elements related to this component in case of
  73893. * context lost for instance.
  73894. */
  73895. rebuild(): void;
  73896. /**
  73897. * Disposes the component and the associated ressources
  73898. */
  73899. dispose(): void;
  73900. private _gatherRenderTargets;
  73901. }
  73902. }
  73903. declare module "babylonjs/Shaders/motionBlur.fragment" {
  73904. /** @hidden */
  73905. export var motionBlurPixelShader: {
  73906. name: string;
  73907. shader: string;
  73908. };
  73909. }
  73910. declare module "babylonjs/PostProcesses/motionBlurPostProcess" {
  73911. import { Nullable } from "babylonjs/types";
  73912. import { Camera } from "babylonjs/Cameras/camera";
  73913. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73914. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73915. import "babylonjs/Animations/animatable";
  73916. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  73917. import "babylonjs/Shaders/motionBlur.fragment";
  73918. import { Engine } from "babylonjs/Engines/engine";
  73919. import { Scene } from "babylonjs/scene";
  73920. /**
  73921. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  73922. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  73923. * As an example, all you have to do is to create the post-process:
  73924. * var mb = new BABYLON.MotionBlurPostProcess(
  73925. * 'mb', // The name of the effect.
  73926. * scene, // The scene containing the objects to blur according to their velocity.
  73927. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  73928. * camera // The camera to apply the render pass to.
  73929. * );
  73930. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  73931. */
  73932. export class MotionBlurPostProcess extends PostProcess {
  73933. /**
  73934. * Defines how much the image is blurred by the movement. Default value is equal to 1
  73935. */
  73936. motionStrength: number;
  73937. /**
  73938. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  73939. */
  73940. get motionBlurSamples(): number;
  73941. /**
  73942. * Sets the number of iterations to be used for motion blur quality
  73943. */
  73944. set motionBlurSamples(samples: number);
  73945. private _motionBlurSamples;
  73946. private _geometryBufferRenderer;
  73947. /**
  73948. * Gets a string identifying the name of the class
  73949. * @returns "MotionBlurPostProcess" string
  73950. */
  73951. getClassName(): string;
  73952. /**
  73953. * Creates a new instance MotionBlurPostProcess
  73954. * @param name The name of the effect.
  73955. * @param scene The scene containing the objects to blur according to their velocity.
  73956. * @param options The required width/height ratio to downsize to before computing the render pass.
  73957. * @param camera The camera to apply the render pass to.
  73958. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73959. * @param engine The engine which the post process will be applied. (default: current engine)
  73960. * @param reusable If the post process can be reused on the same frame. (default: false)
  73961. * @param textureType Type of textures used when performing the post process. (default: 0)
  73962. * @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)
  73963. */
  73964. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73965. /**
  73966. * Excludes the given skinned mesh from computing bones velocities.
  73967. * 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.
  73968. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  73969. */
  73970. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73971. /**
  73972. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  73973. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  73974. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  73975. */
  73976. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73977. /**
  73978. * Disposes the post process.
  73979. * @param camera The camera to dispose the post process on.
  73980. */
  73981. dispose(camera?: Camera): void;
  73982. /** @hidden */
  73983. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  73984. }
  73985. }
  73986. declare module "babylonjs/Shaders/refraction.fragment" {
  73987. /** @hidden */
  73988. export var refractionPixelShader: {
  73989. name: string;
  73990. shader: string;
  73991. };
  73992. }
  73993. declare module "babylonjs/PostProcesses/refractionPostProcess" {
  73994. import { Color3 } from "babylonjs/Maths/math.color";
  73995. import { Camera } from "babylonjs/Cameras/camera";
  73996. import { Texture } from "babylonjs/Materials/Textures/texture";
  73997. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73998. import { Engine } from "babylonjs/Engines/engine";
  73999. import "babylonjs/Shaders/refraction.fragment";
  74000. import { Scene } from "babylonjs/scene";
  74001. /**
  74002. * Post process which applies a refractin texture
  74003. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  74004. */
  74005. export class RefractionPostProcess extends PostProcess {
  74006. private _refTexture;
  74007. private _ownRefractionTexture;
  74008. /** the base color of the refraction (used to taint the rendering) */
  74009. color: Color3;
  74010. /** simulated refraction depth */
  74011. depth: number;
  74012. /** the coefficient of the base color (0 to remove base color tainting) */
  74013. colorLevel: number;
  74014. /** Gets the url used to load the refraction texture */
  74015. refractionTextureUrl: string;
  74016. /**
  74017. * Gets or sets the refraction texture
  74018. * Please note that you are responsible for disposing the texture if you set it manually
  74019. */
  74020. get refractionTexture(): Texture;
  74021. set refractionTexture(value: Texture);
  74022. /**
  74023. * Gets a string identifying the name of the class
  74024. * @returns "RefractionPostProcess" string
  74025. */
  74026. getClassName(): string;
  74027. /**
  74028. * Initializes the RefractionPostProcess
  74029. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  74030. * @param name The name of the effect.
  74031. * @param refractionTextureUrl Url of the refraction texture to use
  74032. * @param color the base color of the refraction (used to taint the rendering)
  74033. * @param depth simulated refraction depth
  74034. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  74035. * @param camera The camera to apply the render pass to.
  74036. * @param options The required width/height ratio to downsize to before computing the render pass.
  74037. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74038. * @param engine The engine which the post process will be applied. (default: current engine)
  74039. * @param reusable If the post process can be reused on the same frame. (default: false)
  74040. */
  74041. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  74042. /**
  74043. * Disposes of the post process
  74044. * @param camera Camera to dispose post process on
  74045. */
  74046. dispose(camera: Camera): void;
  74047. /** @hidden */
  74048. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  74049. }
  74050. }
  74051. declare module "babylonjs/Shaders/sharpen.fragment" {
  74052. /** @hidden */
  74053. export var sharpenPixelShader: {
  74054. name: string;
  74055. shader: string;
  74056. };
  74057. }
  74058. declare module "babylonjs/PostProcesses/sharpenPostProcess" {
  74059. import { Nullable } from "babylonjs/types";
  74060. import { Camera } from "babylonjs/Cameras/camera";
  74061. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  74062. import "babylonjs/Shaders/sharpen.fragment";
  74063. import { Engine } from "babylonjs/Engines/engine";
  74064. import { Scene } from "babylonjs/scene";
  74065. /**
  74066. * The SharpenPostProcess applies a sharpen kernel to every pixel
  74067. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  74068. */
  74069. export class SharpenPostProcess extends PostProcess {
  74070. /**
  74071. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  74072. */
  74073. colorAmount: number;
  74074. /**
  74075. * How much sharpness should be applied (default: 0.3)
  74076. */
  74077. edgeAmount: number;
  74078. /**
  74079. * Gets a string identifying the name of the class
  74080. * @returns "SharpenPostProcess" string
  74081. */
  74082. getClassName(): string;
  74083. /**
  74084. * Creates a new instance ConvolutionPostProcess
  74085. * @param name The name of the effect.
  74086. * @param options The required width/height ratio to downsize to before computing the render pass.
  74087. * @param camera The camera to apply the render pass to.
  74088. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74089. * @param engine The engine which the post process will be applied. (default: current engine)
  74090. * @param reusable If the post process can be reused on the same frame. (default: false)
  74091. * @param textureType Type of textures used when performing the post process. (default: 0)
  74092. * @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)
  74093. */
  74094. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  74095. /** @hidden */
  74096. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  74097. }
  74098. }
  74099. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline" {
  74100. import { Nullable } from "babylonjs/types";
  74101. import { Camera } from "babylonjs/Cameras/camera";
  74102. import { Engine } from "babylonjs/Engines/engine";
  74103. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  74104. import { IInspectable } from "babylonjs/Misc/iInspectable";
  74105. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  74106. /**
  74107. * PostProcessRenderPipeline
  74108. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  74109. */
  74110. export class PostProcessRenderPipeline {
  74111. private engine;
  74112. private _renderEffects;
  74113. private _renderEffectsForIsolatedPass;
  74114. /**
  74115. * List of inspectable custom properties (used by the Inspector)
  74116. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  74117. */
  74118. inspectableCustomProperties: IInspectable[];
  74119. /**
  74120. * @hidden
  74121. */
  74122. protected _cameras: Camera[];
  74123. /** @hidden */
  74124. _name: string;
  74125. /**
  74126. * Gets pipeline name
  74127. */
  74128. get name(): string;
  74129. /** Gets the list of attached cameras */
  74130. get cameras(): Camera[];
  74131. /**
  74132. * Initializes a PostProcessRenderPipeline
  74133. * @param engine engine to add the pipeline to
  74134. * @param name name of the pipeline
  74135. */
  74136. constructor(engine: Engine, name: string);
  74137. /**
  74138. * Gets the class name
  74139. * @returns "PostProcessRenderPipeline"
  74140. */
  74141. getClassName(): string;
  74142. /**
  74143. * If all the render effects in the pipeline are supported
  74144. */
  74145. get isSupported(): boolean;
  74146. /**
  74147. * Adds an effect to the pipeline
  74148. * @param renderEffect the effect to add
  74149. */
  74150. addEffect(renderEffect: PostProcessRenderEffect): void;
  74151. /** @hidden */
  74152. _rebuild(): void;
  74153. /** @hidden */
  74154. _enableEffect(renderEffectName: string, cameras: Camera): void;
  74155. /** @hidden */
  74156. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  74157. /** @hidden */
  74158. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  74159. /** @hidden */
  74160. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  74161. /** @hidden */
  74162. _attachCameras(cameras: Camera, unique: boolean): void;
  74163. /** @hidden */
  74164. _attachCameras(cameras: Camera[], unique: boolean): void;
  74165. /** @hidden */
  74166. _detachCameras(cameras: Camera): void;
  74167. /** @hidden */
  74168. _detachCameras(cameras: Nullable<Camera[]>): void;
  74169. /** @hidden */
  74170. _update(): void;
  74171. /** @hidden */
  74172. _reset(): void;
  74173. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  74174. /**
  74175. * Sets the required values to the prepass renderer.
  74176. * @param prePassRenderer defines the prepass renderer to setup.
  74177. * @returns true if the pre pass is needed.
  74178. */
  74179. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  74180. /**
  74181. * Disposes of the pipeline
  74182. */
  74183. dispose(): void;
  74184. }
  74185. }
  74186. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager" {
  74187. import { Camera } from "babylonjs/Cameras/camera";
  74188. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74189. /**
  74190. * PostProcessRenderPipelineManager class
  74191. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  74192. */
  74193. export class PostProcessRenderPipelineManager {
  74194. private _renderPipelines;
  74195. /**
  74196. * Initializes a PostProcessRenderPipelineManager
  74197. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  74198. */
  74199. constructor();
  74200. /**
  74201. * Gets the list of supported render pipelines
  74202. */
  74203. get supportedPipelines(): PostProcessRenderPipeline[];
  74204. /**
  74205. * Adds a pipeline to the manager
  74206. * @param renderPipeline The pipeline to add
  74207. */
  74208. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  74209. /**
  74210. * Attaches a camera to the pipeline
  74211. * @param renderPipelineName The name of the pipeline to attach to
  74212. * @param cameras the camera to attach
  74213. * @param unique if the camera can be attached multiple times to the pipeline
  74214. */
  74215. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  74216. /**
  74217. * Detaches a camera from the pipeline
  74218. * @param renderPipelineName The name of the pipeline to detach from
  74219. * @param cameras the camera to detach
  74220. */
  74221. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  74222. /**
  74223. * Enables an effect by name on a pipeline
  74224. * @param renderPipelineName the name of the pipeline to enable the effect in
  74225. * @param renderEffectName the name of the effect to enable
  74226. * @param cameras the cameras that the effect should be enabled on
  74227. */
  74228. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  74229. /**
  74230. * Disables an effect by name on a pipeline
  74231. * @param renderPipelineName the name of the pipeline to disable the effect in
  74232. * @param renderEffectName the name of the effect to disable
  74233. * @param cameras the cameras that the effect should be disabled on
  74234. */
  74235. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  74236. /**
  74237. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  74238. */
  74239. update(): void;
  74240. /** @hidden */
  74241. _rebuild(): void;
  74242. /**
  74243. * Disposes of the manager and pipelines
  74244. */
  74245. dispose(): void;
  74246. }
  74247. }
  74248. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent" {
  74249. import { ISceneComponent } from "babylonjs/sceneComponent";
  74250. import { PostProcessRenderPipelineManager } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  74251. import { Scene } from "babylonjs/scene";
  74252. module "babylonjs/scene" {
  74253. interface Scene {
  74254. /** @hidden (Backing field) */
  74255. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  74256. /**
  74257. * Gets the postprocess render pipeline manager
  74258. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  74259. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  74260. */
  74261. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  74262. }
  74263. }
  74264. /**
  74265. * Defines the Render Pipeline scene component responsible to rendering pipelines
  74266. */
  74267. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  74268. /**
  74269. * The component name helpfull to identify the component in the list of scene components.
  74270. */
  74271. readonly name: string;
  74272. /**
  74273. * The scene the component belongs to.
  74274. */
  74275. scene: Scene;
  74276. /**
  74277. * Creates a new instance of the component for the given scene
  74278. * @param scene Defines the scene to register the component in
  74279. */
  74280. constructor(scene: Scene);
  74281. /**
  74282. * Registers the component in a given scene
  74283. */
  74284. register(): void;
  74285. /**
  74286. * Rebuilds the elements related to this component in case of
  74287. * context lost for instance.
  74288. */
  74289. rebuild(): void;
  74290. /**
  74291. * Disposes the component and the associated ressources
  74292. */
  74293. dispose(): void;
  74294. private _gatherRenderTargets;
  74295. }
  74296. }
  74297. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline" {
  74298. import { Nullable } from "babylonjs/types";
  74299. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  74300. import { Camera } from "babylonjs/Cameras/camera";
  74301. import { IDisposable } from "babylonjs/scene";
  74302. import { GlowLayer } from "babylonjs/Layers/glowLayer";
  74303. import { Scene } from "babylonjs/scene";
  74304. import { SharpenPostProcess } from "babylonjs/PostProcesses/sharpenPostProcess";
  74305. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  74306. import { ChromaticAberrationPostProcess } from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  74307. import { GrainPostProcess } from "babylonjs/PostProcesses/grainPostProcess";
  74308. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  74309. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74310. import { DepthOfFieldEffect, DepthOfFieldEffectBlurLevel } from "babylonjs/PostProcesses/depthOfFieldEffect";
  74311. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74312. import { Animation } from "babylonjs/Animations/animation";
  74313. /**
  74314. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  74315. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  74316. */
  74317. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  74318. private _scene;
  74319. private _camerasToBeAttached;
  74320. /**
  74321. * ID of the sharpen post process,
  74322. */
  74323. private readonly SharpenPostProcessId;
  74324. /**
  74325. * @ignore
  74326. * ID of the image processing post process;
  74327. */
  74328. readonly ImageProcessingPostProcessId: string;
  74329. /**
  74330. * @ignore
  74331. * ID of the Fast Approximate Anti-Aliasing post process;
  74332. */
  74333. readonly FxaaPostProcessId: string;
  74334. /**
  74335. * ID of the chromatic aberration post process,
  74336. */
  74337. private readonly ChromaticAberrationPostProcessId;
  74338. /**
  74339. * ID of the grain post process
  74340. */
  74341. private readonly GrainPostProcessId;
  74342. /**
  74343. * Sharpen post process which will apply a sharpen convolution to enhance edges
  74344. */
  74345. sharpen: SharpenPostProcess;
  74346. private _sharpenEffect;
  74347. private bloom;
  74348. /**
  74349. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  74350. */
  74351. depthOfField: DepthOfFieldEffect;
  74352. /**
  74353. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  74354. */
  74355. fxaa: FxaaPostProcess;
  74356. /**
  74357. * Image post processing pass used to perform operations such as tone mapping or color grading.
  74358. */
  74359. imageProcessing: ImageProcessingPostProcess;
  74360. /**
  74361. * Chromatic aberration post process which will shift rgb colors in the image
  74362. */
  74363. chromaticAberration: ChromaticAberrationPostProcess;
  74364. private _chromaticAberrationEffect;
  74365. /**
  74366. * Grain post process which add noise to the image
  74367. */
  74368. grain: GrainPostProcess;
  74369. private _grainEffect;
  74370. /**
  74371. * Glow post process which adds a glow to emissive areas of the image
  74372. */
  74373. private _glowLayer;
  74374. /**
  74375. * Animations which can be used to tweak settings over a period of time
  74376. */
  74377. animations: Animation[];
  74378. private _imageProcessingConfigurationObserver;
  74379. private _sharpenEnabled;
  74380. private _bloomEnabled;
  74381. private _depthOfFieldEnabled;
  74382. private _depthOfFieldBlurLevel;
  74383. private _fxaaEnabled;
  74384. private _imageProcessingEnabled;
  74385. private _defaultPipelineTextureType;
  74386. private _bloomScale;
  74387. private _chromaticAberrationEnabled;
  74388. private _grainEnabled;
  74389. private _buildAllowed;
  74390. /**
  74391. * Gets active scene
  74392. */
  74393. get scene(): Scene;
  74394. /**
  74395. * Enable or disable the sharpen process from the pipeline
  74396. */
  74397. set sharpenEnabled(enabled: boolean);
  74398. get sharpenEnabled(): boolean;
  74399. private _resizeObserver;
  74400. private _hardwareScaleLevel;
  74401. private _bloomKernel;
  74402. /**
  74403. * Specifies the size of the bloom blur kernel, relative to the final output size
  74404. */
  74405. get bloomKernel(): number;
  74406. set bloomKernel(value: number);
  74407. /**
  74408. * Specifies the weight of the bloom in the final rendering
  74409. */
  74410. private _bloomWeight;
  74411. /**
  74412. * Specifies the luma threshold for the area that will be blurred by the bloom
  74413. */
  74414. private _bloomThreshold;
  74415. private _hdr;
  74416. /**
  74417. * The strength of the bloom.
  74418. */
  74419. set bloomWeight(value: number);
  74420. get bloomWeight(): number;
  74421. /**
  74422. * The strength of the bloom.
  74423. */
  74424. set bloomThreshold(value: number);
  74425. get bloomThreshold(): number;
  74426. /**
  74427. * The scale of the bloom, lower value will provide better performance.
  74428. */
  74429. set bloomScale(value: number);
  74430. get bloomScale(): number;
  74431. /**
  74432. * Enable or disable the bloom from the pipeline
  74433. */
  74434. set bloomEnabled(enabled: boolean);
  74435. get bloomEnabled(): boolean;
  74436. private _rebuildBloom;
  74437. /**
  74438. * If the depth of field is enabled.
  74439. */
  74440. get depthOfFieldEnabled(): boolean;
  74441. set depthOfFieldEnabled(enabled: boolean);
  74442. /**
  74443. * Blur level of the depth of field effect. (Higher blur will effect performance)
  74444. */
  74445. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  74446. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  74447. /**
  74448. * If the anti aliasing is enabled.
  74449. */
  74450. set fxaaEnabled(enabled: boolean);
  74451. get fxaaEnabled(): boolean;
  74452. private _samples;
  74453. /**
  74454. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  74455. */
  74456. set samples(sampleCount: number);
  74457. get samples(): number;
  74458. /**
  74459. * If image processing is enabled.
  74460. */
  74461. set imageProcessingEnabled(enabled: boolean);
  74462. get imageProcessingEnabled(): boolean;
  74463. /**
  74464. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  74465. */
  74466. set glowLayerEnabled(enabled: boolean);
  74467. get glowLayerEnabled(): boolean;
  74468. /**
  74469. * Gets the glow layer (or null if not defined)
  74470. */
  74471. get glowLayer(): Nullable<GlowLayer>;
  74472. /**
  74473. * Enable or disable the chromaticAberration process from the pipeline
  74474. */
  74475. set chromaticAberrationEnabled(enabled: boolean);
  74476. get chromaticAberrationEnabled(): boolean;
  74477. /**
  74478. * Enable or disable the grain process from the pipeline
  74479. */
  74480. set grainEnabled(enabled: boolean);
  74481. get grainEnabled(): boolean;
  74482. /**
  74483. * @constructor
  74484. * @param name - The rendering pipeline name (default: "")
  74485. * @param hdr - If high dynamic range textures should be used (default: true)
  74486. * @param scene - The scene linked to this pipeline (default: the last created scene)
  74487. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  74488. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  74489. */
  74490. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  74491. /**
  74492. * Get the class name
  74493. * @returns "DefaultRenderingPipeline"
  74494. */
  74495. getClassName(): string;
  74496. /**
  74497. * Force the compilation of the entire pipeline.
  74498. */
  74499. prepare(): void;
  74500. private _hasCleared;
  74501. private _prevPostProcess;
  74502. private _prevPrevPostProcess;
  74503. private _setAutoClearAndTextureSharing;
  74504. private _depthOfFieldSceneObserver;
  74505. private _buildPipeline;
  74506. private _disposePostProcesses;
  74507. /**
  74508. * Adds a camera to the pipeline
  74509. * @param camera the camera to be added
  74510. */
  74511. addCamera(camera: Camera): void;
  74512. /**
  74513. * Removes a camera from the pipeline
  74514. * @param camera the camera to remove
  74515. */
  74516. removeCamera(camera: Camera): void;
  74517. /**
  74518. * Dispose of the pipeline and stop all post processes
  74519. */
  74520. dispose(): void;
  74521. /**
  74522. * Serialize the rendering pipeline (Used when exporting)
  74523. * @returns the serialized object
  74524. */
  74525. serialize(): any;
  74526. /**
  74527. * Parse the serialized pipeline
  74528. * @param source Source pipeline.
  74529. * @param scene The scene to load the pipeline to.
  74530. * @param rootUrl The URL of the serialized pipeline.
  74531. * @returns An instantiated pipeline from the serialized object.
  74532. */
  74533. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  74534. }
  74535. }
  74536. declare module "babylonjs/Shaders/lensHighlights.fragment" {
  74537. /** @hidden */
  74538. export var lensHighlightsPixelShader: {
  74539. name: string;
  74540. shader: string;
  74541. };
  74542. }
  74543. declare module "babylonjs/Shaders/depthOfField.fragment" {
  74544. /** @hidden */
  74545. export var depthOfFieldPixelShader: {
  74546. name: string;
  74547. shader: string;
  74548. };
  74549. }
  74550. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline" {
  74551. import { Camera } from "babylonjs/Cameras/camera";
  74552. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74553. import { Scene } from "babylonjs/scene";
  74554. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74555. import "babylonjs/Shaders/chromaticAberration.fragment";
  74556. import "babylonjs/Shaders/lensHighlights.fragment";
  74557. import "babylonjs/Shaders/depthOfField.fragment";
  74558. /**
  74559. * BABYLON.JS Chromatic Aberration GLSL Shader
  74560. * Author: Olivier Guyot
  74561. * Separates very slightly R, G and B colors on the edges of the screen
  74562. * Inspired by Francois Tarlier & Martins Upitis
  74563. */
  74564. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  74565. /**
  74566. * @ignore
  74567. * The chromatic aberration PostProcess id in the pipeline
  74568. */
  74569. LensChromaticAberrationEffect: string;
  74570. /**
  74571. * @ignore
  74572. * The highlights enhancing PostProcess id in the pipeline
  74573. */
  74574. HighlightsEnhancingEffect: string;
  74575. /**
  74576. * @ignore
  74577. * The depth-of-field PostProcess id in the pipeline
  74578. */
  74579. LensDepthOfFieldEffect: string;
  74580. private _scene;
  74581. private _depthTexture;
  74582. private _grainTexture;
  74583. private _chromaticAberrationPostProcess;
  74584. private _highlightsPostProcess;
  74585. private _depthOfFieldPostProcess;
  74586. private _edgeBlur;
  74587. private _grainAmount;
  74588. private _chromaticAberration;
  74589. private _distortion;
  74590. private _highlightsGain;
  74591. private _highlightsThreshold;
  74592. private _dofDistance;
  74593. private _dofAperture;
  74594. private _dofDarken;
  74595. private _dofPentagon;
  74596. private _blurNoise;
  74597. /**
  74598. * @constructor
  74599. *
  74600. * Effect parameters are as follow:
  74601. * {
  74602. * chromatic_aberration: number; // from 0 to x (1 for realism)
  74603. * edge_blur: number; // from 0 to x (1 for realism)
  74604. * distortion: number; // from 0 to x (1 for realism)
  74605. * grain_amount: number; // from 0 to 1
  74606. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  74607. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  74608. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  74609. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  74610. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  74611. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  74612. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  74613. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  74614. * }
  74615. * Note: if an effect parameter is unset, effect is disabled
  74616. *
  74617. * @param name The rendering pipeline name
  74618. * @param parameters - An object containing all parameters (see above)
  74619. * @param scene The scene linked to this pipeline
  74620. * @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)
  74621. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74622. */
  74623. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  74624. /**
  74625. * Get the class name
  74626. * @returns "LensRenderingPipeline"
  74627. */
  74628. getClassName(): string;
  74629. /**
  74630. * Gets associated scene
  74631. */
  74632. get scene(): Scene;
  74633. /**
  74634. * Gets or sets the edge blur
  74635. */
  74636. get edgeBlur(): number;
  74637. set edgeBlur(value: number);
  74638. /**
  74639. * Gets or sets the grain amount
  74640. */
  74641. get grainAmount(): number;
  74642. set grainAmount(value: number);
  74643. /**
  74644. * Gets or sets the chromatic aberration amount
  74645. */
  74646. get chromaticAberration(): number;
  74647. set chromaticAberration(value: number);
  74648. /**
  74649. * Gets or sets the depth of field aperture
  74650. */
  74651. get dofAperture(): number;
  74652. set dofAperture(value: number);
  74653. /**
  74654. * Gets or sets the edge distortion
  74655. */
  74656. get edgeDistortion(): number;
  74657. set edgeDistortion(value: number);
  74658. /**
  74659. * Gets or sets the depth of field distortion
  74660. */
  74661. get dofDistortion(): number;
  74662. set dofDistortion(value: number);
  74663. /**
  74664. * Gets or sets the darken out of focus amount
  74665. */
  74666. get darkenOutOfFocus(): number;
  74667. set darkenOutOfFocus(value: number);
  74668. /**
  74669. * Gets or sets a boolean indicating if blur noise is enabled
  74670. */
  74671. get blurNoise(): boolean;
  74672. set blurNoise(value: boolean);
  74673. /**
  74674. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  74675. */
  74676. get pentagonBokeh(): boolean;
  74677. set pentagonBokeh(value: boolean);
  74678. /**
  74679. * Gets or sets the highlight grain amount
  74680. */
  74681. get highlightsGain(): number;
  74682. set highlightsGain(value: number);
  74683. /**
  74684. * Gets or sets the highlight threshold
  74685. */
  74686. get highlightsThreshold(): number;
  74687. set highlightsThreshold(value: number);
  74688. /**
  74689. * Sets the amount of blur at the edges
  74690. * @param amount blur amount
  74691. */
  74692. setEdgeBlur(amount: number): void;
  74693. /**
  74694. * Sets edge blur to 0
  74695. */
  74696. disableEdgeBlur(): void;
  74697. /**
  74698. * Sets the amout of grain
  74699. * @param amount Amount of grain
  74700. */
  74701. setGrainAmount(amount: number): void;
  74702. /**
  74703. * Set grain amount to 0
  74704. */
  74705. disableGrain(): void;
  74706. /**
  74707. * Sets the chromatic aberration amount
  74708. * @param amount amount of chromatic aberration
  74709. */
  74710. setChromaticAberration(amount: number): void;
  74711. /**
  74712. * Sets chromatic aberration amount to 0
  74713. */
  74714. disableChromaticAberration(): void;
  74715. /**
  74716. * Sets the EdgeDistortion amount
  74717. * @param amount amount of EdgeDistortion
  74718. */
  74719. setEdgeDistortion(amount: number): void;
  74720. /**
  74721. * Sets edge distortion to 0
  74722. */
  74723. disableEdgeDistortion(): void;
  74724. /**
  74725. * Sets the FocusDistance amount
  74726. * @param amount amount of FocusDistance
  74727. */
  74728. setFocusDistance(amount: number): void;
  74729. /**
  74730. * Disables depth of field
  74731. */
  74732. disableDepthOfField(): void;
  74733. /**
  74734. * Sets the Aperture amount
  74735. * @param amount amount of Aperture
  74736. */
  74737. setAperture(amount: number): void;
  74738. /**
  74739. * Sets the DarkenOutOfFocus amount
  74740. * @param amount amount of DarkenOutOfFocus
  74741. */
  74742. setDarkenOutOfFocus(amount: number): void;
  74743. private _pentagonBokehIsEnabled;
  74744. /**
  74745. * Creates a pentagon bokeh effect
  74746. */
  74747. enablePentagonBokeh(): void;
  74748. /**
  74749. * Disables the pentagon bokeh effect
  74750. */
  74751. disablePentagonBokeh(): void;
  74752. /**
  74753. * Enables noise blur
  74754. */
  74755. enableNoiseBlur(): void;
  74756. /**
  74757. * Disables noise blur
  74758. */
  74759. disableNoiseBlur(): void;
  74760. /**
  74761. * Sets the HighlightsGain amount
  74762. * @param amount amount of HighlightsGain
  74763. */
  74764. setHighlightsGain(amount: number): void;
  74765. /**
  74766. * Sets the HighlightsThreshold amount
  74767. * @param amount amount of HighlightsThreshold
  74768. */
  74769. setHighlightsThreshold(amount: number): void;
  74770. /**
  74771. * Disables highlights
  74772. */
  74773. disableHighlights(): void;
  74774. /**
  74775. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  74776. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  74777. */
  74778. dispose(disableDepthRender?: boolean): void;
  74779. private _createChromaticAberrationPostProcess;
  74780. private _createHighlightsPostProcess;
  74781. private _createDepthOfFieldPostProcess;
  74782. private _createGrainTexture;
  74783. }
  74784. }
  74785. declare module "babylonjs/Rendering/ssao2Configuration" {
  74786. import { PrePassEffectConfiguration } from "babylonjs/Rendering/prePassEffectConfiguration";
  74787. /**
  74788. * Contains all parameters needed for the prepass to perform
  74789. * screen space subsurface scattering
  74790. */
  74791. export class SSAO2Configuration implements PrePassEffectConfiguration {
  74792. /**
  74793. * Is subsurface enabled
  74794. */
  74795. enabled: boolean;
  74796. /**
  74797. * Name of the configuration
  74798. */
  74799. name: string;
  74800. /**
  74801. * Textures that should be present in the MRT for this effect to work
  74802. */
  74803. readonly texturesRequired: number[];
  74804. /**
  74805. * Builds a ssao2 configuration object
  74806. * @param scene The scene
  74807. */
  74808. constructor();
  74809. /**
  74810. * Disposes the configuration
  74811. */
  74812. dispose(): void;
  74813. }
  74814. }
  74815. declare module "babylonjs/Shaders/ssao2.fragment" {
  74816. /** @hidden */
  74817. export var ssao2PixelShader: {
  74818. name: string;
  74819. shader: string;
  74820. };
  74821. }
  74822. declare module "babylonjs/Shaders/ssaoCombine.fragment" {
  74823. /** @hidden */
  74824. export var ssaoCombinePixelShader: {
  74825. name: string;
  74826. shader: string;
  74827. };
  74828. }
  74829. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline" {
  74830. import { Camera } from "babylonjs/Cameras/camera";
  74831. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74832. import { Scene } from "babylonjs/scene";
  74833. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  74834. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74835. import "babylonjs/Shaders/ssao2.fragment";
  74836. import "babylonjs/Shaders/ssaoCombine.fragment";
  74837. /**
  74838. * Render pipeline to produce ssao effect
  74839. */
  74840. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  74841. /**
  74842. * @ignore
  74843. * The PassPostProcess id in the pipeline that contains the original scene color
  74844. */
  74845. SSAOOriginalSceneColorEffect: string;
  74846. /**
  74847. * @ignore
  74848. * The SSAO PostProcess id in the pipeline
  74849. */
  74850. SSAORenderEffect: string;
  74851. /**
  74852. * @ignore
  74853. * The horizontal blur PostProcess id in the pipeline
  74854. */
  74855. SSAOBlurHRenderEffect: string;
  74856. /**
  74857. * @ignore
  74858. * The vertical blur PostProcess id in the pipeline
  74859. */
  74860. SSAOBlurVRenderEffect: string;
  74861. /**
  74862. * @ignore
  74863. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74864. */
  74865. SSAOCombineRenderEffect: string;
  74866. /**
  74867. * The output strength of the SSAO post-process. Default value is 1.0.
  74868. */
  74869. totalStrength: number;
  74870. /**
  74871. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  74872. */
  74873. maxZ: number;
  74874. /**
  74875. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  74876. */
  74877. minZAspect: number;
  74878. private _samples;
  74879. /**
  74880. * Number of samples used for the SSAO calculations. Default value is 8
  74881. */
  74882. set samples(n: number);
  74883. get samples(): number;
  74884. private _textureSamples;
  74885. /**
  74886. * Number of samples to use for antialiasing
  74887. */
  74888. set textureSamples(n: number);
  74889. get textureSamples(): number;
  74890. /**
  74891. * Force rendering the geometry through geometry buffer
  74892. */
  74893. private _forceGeometryBuffer;
  74894. /**
  74895. * Ratio object used for SSAO ratio and blur ratio
  74896. */
  74897. private _ratio;
  74898. /**
  74899. * Dynamically generated sphere sampler.
  74900. */
  74901. private _sampleSphere;
  74902. private _ssao2PrePassConfiguration;
  74903. /**
  74904. * Blur filter offsets
  74905. */
  74906. private _samplerOffsets;
  74907. private _expensiveBlur;
  74908. /**
  74909. * If bilateral blur should be used
  74910. */
  74911. set expensiveBlur(b: boolean);
  74912. get expensiveBlur(): boolean;
  74913. /**
  74914. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  74915. */
  74916. radius: number;
  74917. /**
  74918. * The base color of the SSAO post-process
  74919. * The final result is "base + ssao" between [0, 1]
  74920. */
  74921. base: number;
  74922. /**
  74923. * Support test.
  74924. */
  74925. static get IsSupported(): boolean;
  74926. private _scene;
  74927. private _randomTexture;
  74928. private _originalColorPostProcess;
  74929. private _ssaoPostProcess;
  74930. private _blurHPostProcess;
  74931. private _blurVPostProcess;
  74932. private _ssaoCombinePostProcess;
  74933. private _prePassRenderer;
  74934. /**
  74935. * Gets active scene
  74936. */
  74937. get scene(): Scene;
  74938. /**
  74939. * @constructor
  74940. * @param name The rendering pipeline name
  74941. * @param scene The scene linked to this pipeline
  74942. * @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 }
  74943. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74944. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  74945. */
  74946. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  74947. /**
  74948. * Get the class name
  74949. * @returns "SSAO2RenderingPipeline"
  74950. */
  74951. getClassName(): string;
  74952. /**
  74953. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74954. */
  74955. dispose(disableGeometryBufferRenderer?: boolean): void;
  74956. private _createBlurPostProcess;
  74957. /** @hidden */
  74958. _rebuild(): void;
  74959. private _bits;
  74960. private _radicalInverse_VdC;
  74961. private _hammersley;
  74962. private _hemisphereSample_uniform;
  74963. private _generateHemisphere;
  74964. private _getDefinesForSSAO;
  74965. private _createSSAOPostProcess;
  74966. private _createSSAOCombinePostProcess;
  74967. private _createRandomTexture;
  74968. /**
  74969. * Serialize the rendering pipeline (Used when exporting)
  74970. * @returns the serialized object
  74971. */
  74972. serialize(): any;
  74973. /**
  74974. * Parse the serialized pipeline
  74975. * @param source Source pipeline.
  74976. * @param scene The scene to load the pipeline to.
  74977. * @param rootUrl The URL of the serialized pipeline.
  74978. * @returns An instantiated pipeline from the serialized object.
  74979. */
  74980. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  74981. /**
  74982. * Sets the required values to the prepass renderer.
  74983. * @param prePassRenderer defines the prepass renderer to setup
  74984. * @returns true if the pre pass is needed.
  74985. */
  74986. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  74987. }
  74988. }
  74989. declare module "babylonjs/Shaders/ssao.fragment" {
  74990. /** @hidden */
  74991. export var ssaoPixelShader: {
  74992. name: string;
  74993. shader: string;
  74994. };
  74995. }
  74996. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline" {
  74997. import { Camera } from "babylonjs/Cameras/camera";
  74998. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74999. import { Scene } from "babylonjs/scene";
  75000. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  75001. import "babylonjs/Shaders/ssao.fragment";
  75002. import "babylonjs/Shaders/ssaoCombine.fragment";
  75003. /**
  75004. * Render pipeline to produce ssao effect
  75005. */
  75006. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  75007. /**
  75008. * @ignore
  75009. * The PassPostProcess id in the pipeline that contains the original scene color
  75010. */
  75011. SSAOOriginalSceneColorEffect: string;
  75012. /**
  75013. * @ignore
  75014. * The SSAO PostProcess id in the pipeline
  75015. */
  75016. SSAORenderEffect: string;
  75017. /**
  75018. * @ignore
  75019. * The horizontal blur PostProcess id in the pipeline
  75020. */
  75021. SSAOBlurHRenderEffect: string;
  75022. /**
  75023. * @ignore
  75024. * The vertical blur PostProcess id in the pipeline
  75025. */
  75026. SSAOBlurVRenderEffect: string;
  75027. /**
  75028. * @ignore
  75029. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  75030. */
  75031. SSAOCombineRenderEffect: string;
  75032. /**
  75033. * The output strength of the SSAO post-process. Default value is 1.0.
  75034. */
  75035. totalStrength: number;
  75036. /**
  75037. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  75038. */
  75039. radius: number;
  75040. /**
  75041. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  75042. * Must not be equal to fallOff and superior to fallOff.
  75043. * Default value is 0.0075
  75044. */
  75045. area: number;
  75046. /**
  75047. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  75048. * Must not be equal to area and inferior to area.
  75049. * Default value is 0.000001
  75050. */
  75051. fallOff: number;
  75052. /**
  75053. * The base color of the SSAO post-process
  75054. * The final result is "base + ssao" between [0, 1]
  75055. */
  75056. base: number;
  75057. private _scene;
  75058. private _depthTexture;
  75059. private _randomTexture;
  75060. private _originalColorPostProcess;
  75061. private _ssaoPostProcess;
  75062. private _blurHPostProcess;
  75063. private _blurVPostProcess;
  75064. private _ssaoCombinePostProcess;
  75065. private _firstUpdate;
  75066. /**
  75067. * Gets active scene
  75068. */
  75069. get scene(): Scene;
  75070. /**
  75071. * @constructor
  75072. * @param name - The rendering pipeline name
  75073. * @param scene - The scene linked to this pipeline
  75074. * @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 }
  75075. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  75076. */
  75077. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  75078. /**
  75079. * Get the class name
  75080. * @returns "SSAORenderingPipeline"
  75081. */
  75082. getClassName(): string;
  75083. /**
  75084. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  75085. */
  75086. dispose(disableDepthRender?: boolean): void;
  75087. private _createBlurPostProcess;
  75088. /** @hidden */
  75089. _rebuild(): void;
  75090. private _createSSAOPostProcess;
  75091. private _createSSAOCombinePostProcess;
  75092. private _createRandomTexture;
  75093. }
  75094. }
  75095. declare module "babylonjs/Shaders/screenSpaceReflection.fragment" {
  75096. /** @hidden */
  75097. export var screenSpaceReflectionPixelShader: {
  75098. name: string;
  75099. shader: string;
  75100. };
  75101. }
  75102. declare module "babylonjs/PostProcesses/screenSpaceReflectionPostProcess" {
  75103. import { Nullable } from "babylonjs/types";
  75104. import { Camera } from "babylonjs/Cameras/camera";
  75105. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  75106. import "babylonjs/Shaders/screenSpaceReflection.fragment";
  75107. import { Engine } from "babylonjs/Engines/engine";
  75108. import { Scene } from "babylonjs/scene";
  75109. /**
  75110. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  75111. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  75112. */
  75113. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  75114. /**
  75115. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  75116. */
  75117. threshold: number;
  75118. /**
  75119. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  75120. */
  75121. strength: number;
  75122. /**
  75123. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  75124. */
  75125. reflectionSpecularFalloffExponent: number;
  75126. /**
  75127. * 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]
  75128. */
  75129. step: number;
  75130. /**
  75131. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  75132. */
  75133. roughnessFactor: number;
  75134. private _geometryBufferRenderer;
  75135. private _enableSmoothReflections;
  75136. private _reflectionSamples;
  75137. private _smoothSteps;
  75138. /**
  75139. * Gets a string identifying the name of the class
  75140. * @returns "ScreenSpaceReflectionPostProcess" string
  75141. */
  75142. getClassName(): string;
  75143. /**
  75144. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  75145. * @param name The name of the effect.
  75146. * @param scene The scene containing the objects to calculate reflections.
  75147. * @param options The required width/height ratio to downsize to before computing the render pass.
  75148. * @param camera The camera to apply the render pass to.
  75149. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75150. * @param engine The engine which the post process will be applied. (default: current engine)
  75151. * @param reusable If the post process can be reused on the same frame. (default: false)
  75152. * @param textureType Type of textures used when performing the post process. (default: 0)
  75153. * @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)
  75154. */
  75155. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  75156. /**
  75157. * Gets wether or not smoothing reflections is enabled.
  75158. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  75159. */
  75160. get enableSmoothReflections(): boolean;
  75161. /**
  75162. * Sets wether or not smoothing reflections is enabled.
  75163. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  75164. */
  75165. set enableSmoothReflections(enabled: boolean);
  75166. /**
  75167. * Gets the number of samples taken while computing reflections. More samples count is high,
  75168. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  75169. */
  75170. get reflectionSamples(): number;
  75171. /**
  75172. * Sets the number of samples taken while computing reflections. More samples count is high,
  75173. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  75174. */
  75175. set reflectionSamples(samples: number);
  75176. /**
  75177. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  75178. * more the post-process will require GPU power and can generate a drop in FPS.
  75179. * Default value (5.0) work pretty well in all cases but can be adjusted.
  75180. */
  75181. get smoothSteps(): number;
  75182. set smoothSteps(steps: number);
  75183. private _updateEffectDefines;
  75184. /** @hidden */
  75185. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  75186. }
  75187. }
  75188. declare module "babylonjs/Shaders/standard.fragment" {
  75189. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  75190. /** @hidden */
  75191. export var standardPixelShader: {
  75192. name: string;
  75193. shader: string;
  75194. };
  75195. }
  75196. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline" {
  75197. import { Nullable } from "babylonjs/types";
  75198. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  75199. import { Camera } from "babylonjs/Cameras/camera";
  75200. import { Texture } from "babylonjs/Materials/Textures/texture";
  75201. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75202. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  75203. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  75204. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  75205. import { IDisposable } from "babylonjs/scene";
  75206. import { SpotLight } from "babylonjs/Lights/spotLight";
  75207. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  75208. import { Scene } from "babylonjs/scene";
  75209. import { ScreenSpaceReflectionPostProcess } from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  75210. import { Animation } from "babylonjs/Animations/animation";
  75211. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  75212. import "babylonjs/Shaders/standard.fragment";
  75213. /**
  75214. * Standard rendering pipeline
  75215. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  75216. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  75217. */
  75218. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  75219. /**
  75220. * Public members
  75221. */
  75222. /**
  75223. * Post-process which contains the original scene color before the pipeline applies all the effects
  75224. */
  75225. originalPostProcess: Nullable<PostProcess>;
  75226. /**
  75227. * Post-process used to down scale an image x4
  75228. */
  75229. downSampleX4PostProcess: Nullable<PostProcess>;
  75230. /**
  75231. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  75232. */
  75233. brightPassPostProcess: Nullable<PostProcess>;
  75234. /**
  75235. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  75236. */
  75237. blurHPostProcesses: PostProcess[];
  75238. /**
  75239. * Post-process array storing all the vertical blur post-processes used by the pipeline
  75240. */
  75241. blurVPostProcesses: PostProcess[];
  75242. /**
  75243. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  75244. */
  75245. textureAdderPostProcess: Nullable<PostProcess>;
  75246. /**
  75247. * Post-process used to create volumetric lighting effect
  75248. */
  75249. volumetricLightPostProcess: Nullable<PostProcess>;
  75250. /**
  75251. * Post-process used to smooth the previous volumetric light post-process on the X axis
  75252. */
  75253. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  75254. /**
  75255. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  75256. */
  75257. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  75258. /**
  75259. * Post-process used to merge the volumetric light effect and the real scene color
  75260. */
  75261. volumetricLightMergePostProces: Nullable<PostProcess>;
  75262. /**
  75263. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  75264. */
  75265. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  75266. /**
  75267. * Base post-process used to calculate the average luminance of the final image for HDR
  75268. */
  75269. luminancePostProcess: Nullable<PostProcess>;
  75270. /**
  75271. * Post-processes used to create down sample post-processes in order to get
  75272. * the average luminance of the final image for HDR
  75273. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  75274. */
  75275. luminanceDownSamplePostProcesses: PostProcess[];
  75276. /**
  75277. * Post-process used to create a HDR effect (light adaptation)
  75278. */
  75279. hdrPostProcess: Nullable<PostProcess>;
  75280. /**
  75281. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  75282. */
  75283. textureAdderFinalPostProcess: Nullable<PostProcess>;
  75284. /**
  75285. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  75286. */
  75287. lensFlareFinalPostProcess: Nullable<PostProcess>;
  75288. /**
  75289. * Post-process used to merge the final HDR post-process and the real scene color
  75290. */
  75291. hdrFinalPostProcess: Nullable<PostProcess>;
  75292. /**
  75293. * Post-process used to create a lens flare effect
  75294. */
  75295. lensFlarePostProcess: Nullable<PostProcess>;
  75296. /**
  75297. * Post-process that merges the result of the lens flare post-process and the real scene color
  75298. */
  75299. lensFlareComposePostProcess: Nullable<PostProcess>;
  75300. /**
  75301. * Post-process used to create a motion blur effect
  75302. */
  75303. motionBlurPostProcess: Nullable<PostProcess>;
  75304. /**
  75305. * Post-process used to create a depth of field effect
  75306. */
  75307. depthOfFieldPostProcess: Nullable<PostProcess>;
  75308. /**
  75309. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  75310. */
  75311. fxaaPostProcess: Nullable<FxaaPostProcess>;
  75312. /**
  75313. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  75314. */
  75315. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  75316. /**
  75317. * Represents the brightness threshold in order to configure the illuminated surfaces
  75318. */
  75319. brightThreshold: number;
  75320. /**
  75321. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  75322. */
  75323. blurWidth: number;
  75324. /**
  75325. * Sets if the blur for highlighted surfaces must be only horizontal
  75326. */
  75327. horizontalBlur: boolean;
  75328. /**
  75329. * Gets the overall exposure used by the pipeline
  75330. */
  75331. get exposure(): number;
  75332. /**
  75333. * Sets the overall exposure used by the pipeline
  75334. */
  75335. set exposure(value: number);
  75336. /**
  75337. * Texture used typically to simulate "dirty" on camera lens
  75338. */
  75339. lensTexture: Nullable<Texture>;
  75340. /**
  75341. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  75342. */
  75343. volumetricLightCoefficient: number;
  75344. /**
  75345. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  75346. */
  75347. volumetricLightPower: number;
  75348. /**
  75349. * Used the set the blur intensity to smooth the volumetric lights
  75350. */
  75351. volumetricLightBlurScale: number;
  75352. /**
  75353. * Light (spot or directional) used to generate the volumetric lights rays
  75354. * The source light must have a shadow generate so the pipeline can get its
  75355. * depth map
  75356. */
  75357. sourceLight: Nullable<SpotLight | DirectionalLight>;
  75358. /**
  75359. * For eye adaptation, represents the minimum luminance the eye can see
  75360. */
  75361. hdrMinimumLuminance: number;
  75362. /**
  75363. * For eye adaptation, represents the decrease luminance speed
  75364. */
  75365. hdrDecreaseRate: number;
  75366. /**
  75367. * For eye adaptation, represents the increase luminance speed
  75368. */
  75369. hdrIncreaseRate: number;
  75370. /**
  75371. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75372. */
  75373. get hdrAutoExposure(): boolean;
  75374. /**
  75375. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75376. */
  75377. set hdrAutoExposure(value: boolean);
  75378. /**
  75379. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  75380. */
  75381. lensColorTexture: Nullable<Texture>;
  75382. /**
  75383. * The overall strengh for the lens flare effect
  75384. */
  75385. lensFlareStrength: number;
  75386. /**
  75387. * Dispersion coefficient for lens flare ghosts
  75388. */
  75389. lensFlareGhostDispersal: number;
  75390. /**
  75391. * Main lens flare halo width
  75392. */
  75393. lensFlareHaloWidth: number;
  75394. /**
  75395. * Based on the lens distortion effect, defines how much the lens flare result
  75396. * is distorted
  75397. */
  75398. lensFlareDistortionStrength: number;
  75399. /**
  75400. * Configures the blur intensity used for for lens flare (halo)
  75401. */
  75402. lensFlareBlurWidth: number;
  75403. /**
  75404. * Lens star texture must be used to simulate rays on the flares and is available
  75405. * in the documentation
  75406. */
  75407. lensStarTexture: Nullable<Texture>;
  75408. /**
  75409. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  75410. * flare effect by taking account of the dirt texture
  75411. */
  75412. lensFlareDirtTexture: Nullable<Texture>;
  75413. /**
  75414. * Represents the focal length for the depth of field effect
  75415. */
  75416. depthOfFieldDistance: number;
  75417. /**
  75418. * Represents the blur intensity for the blurred part of the depth of field effect
  75419. */
  75420. depthOfFieldBlurWidth: number;
  75421. /**
  75422. * Gets how much the image is blurred by the movement while using the motion blur post-process
  75423. */
  75424. get motionStrength(): number;
  75425. /**
  75426. * Sets how much the image is blurred by the movement while using the motion blur post-process
  75427. */
  75428. set motionStrength(strength: number);
  75429. /**
  75430. * Gets wether or not the motion blur post-process is object based or screen based.
  75431. */
  75432. get objectBasedMotionBlur(): boolean;
  75433. /**
  75434. * Sets wether or not the motion blur post-process should be object based or screen based
  75435. */
  75436. set objectBasedMotionBlur(value: boolean);
  75437. /**
  75438. * List of animations for the pipeline (IAnimatable implementation)
  75439. */
  75440. animations: Animation[];
  75441. /**
  75442. * Private members
  75443. */
  75444. private _scene;
  75445. private _currentDepthOfFieldSource;
  75446. private _basePostProcess;
  75447. private _fixedExposure;
  75448. private _currentExposure;
  75449. private _hdrAutoExposure;
  75450. private _hdrCurrentLuminance;
  75451. private _motionStrength;
  75452. private _isObjectBasedMotionBlur;
  75453. private _floatTextureType;
  75454. private _camerasToBeAttached;
  75455. private _ratio;
  75456. private _bloomEnabled;
  75457. private _depthOfFieldEnabled;
  75458. private _vlsEnabled;
  75459. private _lensFlareEnabled;
  75460. private _hdrEnabled;
  75461. private _motionBlurEnabled;
  75462. private _fxaaEnabled;
  75463. private _screenSpaceReflectionsEnabled;
  75464. private _motionBlurSamples;
  75465. private _volumetricLightStepsCount;
  75466. private _samples;
  75467. /**
  75468. * @ignore
  75469. * Specifies if the bloom pipeline is enabled
  75470. */
  75471. get BloomEnabled(): boolean;
  75472. set BloomEnabled(enabled: boolean);
  75473. /**
  75474. * @ignore
  75475. * Specifies if the depth of field pipeline is enabed
  75476. */
  75477. get DepthOfFieldEnabled(): boolean;
  75478. set DepthOfFieldEnabled(enabled: boolean);
  75479. /**
  75480. * @ignore
  75481. * Specifies if the lens flare pipeline is enabed
  75482. */
  75483. get LensFlareEnabled(): boolean;
  75484. set LensFlareEnabled(enabled: boolean);
  75485. /**
  75486. * @ignore
  75487. * Specifies if the HDR pipeline is enabled
  75488. */
  75489. get HDREnabled(): boolean;
  75490. set HDREnabled(enabled: boolean);
  75491. /**
  75492. * @ignore
  75493. * Specifies if the volumetric lights scattering effect is enabled
  75494. */
  75495. get VLSEnabled(): boolean;
  75496. set VLSEnabled(enabled: boolean);
  75497. /**
  75498. * @ignore
  75499. * Specifies if the motion blur effect is enabled
  75500. */
  75501. get MotionBlurEnabled(): boolean;
  75502. set MotionBlurEnabled(enabled: boolean);
  75503. /**
  75504. * Specifies if anti-aliasing is enabled
  75505. */
  75506. get fxaaEnabled(): boolean;
  75507. set fxaaEnabled(enabled: boolean);
  75508. /**
  75509. * Specifies if screen space reflections are enabled.
  75510. */
  75511. get screenSpaceReflectionsEnabled(): boolean;
  75512. set screenSpaceReflectionsEnabled(enabled: boolean);
  75513. /**
  75514. * Specifies the number of steps used to calculate the volumetric lights
  75515. * Typically in interval [50, 200]
  75516. */
  75517. get volumetricLightStepsCount(): number;
  75518. set volumetricLightStepsCount(count: number);
  75519. /**
  75520. * Specifies the number of samples used for the motion blur effect
  75521. * Typically in interval [16, 64]
  75522. */
  75523. get motionBlurSamples(): number;
  75524. set motionBlurSamples(samples: number);
  75525. /**
  75526. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  75527. */
  75528. get samples(): number;
  75529. set samples(sampleCount: number);
  75530. /**
  75531. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  75532. * @constructor
  75533. * @param name The rendering pipeline name
  75534. * @param scene The scene linked to this pipeline
  75535. * @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)
  75536. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  75537. * @param cameras The array of cameras that the rendering pipeline will be attached to
  75538. */
  75539. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  75540. private _buildPipeline;
  75541. private _createDownSampleX4PostProcess;
  75542. private _createBrightPassPostProcess;
  75543. private _createBlurPostProcesses;
  75544. private _createTextureAdderPostProcess;
  75545. private _createVolumetricLightPostProcess;
  75546. private _createLuminancePostProcesses;
  75547. private _createHdrPostProcess;
  75548. private _createLensFlarePostProcess;
  75549. private _createDepthOfFieldPostProcess;
  75550. private _createMotionBlurPostProcess;
  75551. private _getDepthTexture;
  75552. private _disposePostProcesses;
  75553. /**
  75554. * Dispose of the pipeline and stop all post processes
  75555. */
  75556. dispose(): void;
  75557. /**
  75558. * Serialize the rendering pipeline (Used when exporting)
  75559. * @returns the serialized object
  75560. */
  75561. serialize(): any;
  75562. /**
  75563. * Parse the serialized pipeline
  75564. * @param source Source pipeline.
  75565. * @param scene The scene to load the pipeline to.
  75566. * @param rootUrl The URL of the serialized pipeline.
  75567. * @returns An instantiated pipeline from the serialized object.
  75568. */
  75569. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  75570. /**
  75571. * Luminance steps
  75572. */
  75573. static LuminanceSteps: number;
  75574. }
  75575. }
  75576. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/index" {
  75577. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline";
  75578. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline";
  75579. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline";
  75580. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline";
  75581. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline";
  75582. }
  75583. declare module "babylonjs/PostProcesses/RenderPipeline/index" {
  75584. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/index";
  75585. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  75586. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  75587. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  75588. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  75589. }
  75590. declare module "babylonjs/Shaders/stereoscopicInterlace.fragment" {
  75591. /** @hidden */
  75592. export var stereoscopicInterlacePixelShader: {
  75593. name: string;
  75594. shader: string;
  75595. };
  75596. }
  75597. declare module "babylonjs/PostProcesses/stereoscopicInterlacePostProcess" {
  75598. import { Camera } from "babylonjs/Cameras/camera";
  75599. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75600. import { Engine } from "babylonjs/Engines/engine";
  75601. import "babylonjs/Shaders/stereoscopicInterlace.fragment";
  75602. /**
  75603. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  75604. */
  75605. export class StereoscopicInterlacePostProcessI extends PostProcess {
  75606. private _stepSize;
  75607. private _passedProcess;
  75608. /**
  75609. * Gets a string identifying the name of the class
  75610. * @returns "StereoscopicInterlacePostProcessI" string
  75611. */
  75612. getClassName(): string;
  75613. /**
  75614. * Initializes a StereoscopicInterlacePostProcessI
  75615. * @param name The name of the effect.
  75616. * @param rigCameras The rig cameras to be appled to the post process
  75617. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  75618. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  75619. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75620. * @param engine The engine which the post process will be applied. (default: current engine)
  75621. * @param reusable If the post process can be reused on the same frame. (default: false)
  75622. */
  75623. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  75624. }
  75625. /**
  75626. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  75627. */
  75628. export class StereoscopicInterlacePostProcess extends PostProcess {
  75629. private _stepSize;
  75630. private _passedProcess;
  75631. /**
  75632. * Gets a string identifying the name of the class
  75633. * @returns "StereoscopicInterlacePostProcess" string
  75634. */
  75635. getClassName(): string;
  75636. /**
  75637. * Initializes a StereoscopicInterlacePostProcess
  75638. * @param name The name of the effect.
  75639. * @param rigCameras The rig cameras to be appled to the post process
  75640. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  75641. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75642. * @param engine The engine which the post process will be applied. (default: current engine)
  75643. * @param reusable If the post process can be reused on the same frame. (default: false)
  75644. */
  75645. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  75646. }
  75647. }
  75648. declare module "babylonjs/Shaders/tonemap.fragment" {
  75649. /** @hidden */
  75650. export var tonemapPixelShader: {
  75651. name: string;
  75652. shader: string;
  75653. };
  75654. }
  75655. declare module "babylonjs/PostProcesses/tonemapPostProcess" {
  75656. import { Camera } from "babylonjs/Cameras/camera";
  75657. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75658. import "babylonjs/Shaders/tonemap.fragment";
  75659. import { Engine } from "babylonjs/Engines/engine";
  75660. /** Defines operator used for tonemapping */
  75661. export enum TonemappingOperator {
  75662. /** Hable */
  75663. Hable = 0,
  75664. /** Reinhard */
  75665. Reinhard = 1,
  75666. /** HejiDawson */
  75667. HejiDawson = 2,
  75668. /** Photographic */
  75669. Photographic = 3
  75670. }
  75671. /**
  75672. * Defines a post process to apply tone mapping
  75673. */
  75674. export class TonemapPostProcess extends PostProcess {
  75675. private _operator;
  75676. /** Defines the required exposure adjustement */
  75677. exposureAdjustment: number;
  75678. /**
  75679. * Gets a string identifying the name of the class
  75680. * @returns "TonemapPostProcess" string
  75681. */
  75682. getClassName(): string;
  75683. /**
  75684. * Creates a new TonemapPostProcess
  75685. * @param name defines the name of the postprocess
  75686. * @param _operator defines the operator to use
  75687. * @param exposureAdjustment defines the required exposure adjustement
  75688. * @param camera defines the camera to use (can be null)
  75689. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  75690. * @param engine defines the hosting engine (can be ignore if camera is set)
  75691. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  75692. */
  75693. constructor(name: string, _operator: TonemappingOperator,
  75694. /** Defines the required exposure adjustement */
  75695. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  75696. }
  75697. }
  75698. declare module "babylonjs/Shaders/volumetricLightScattering.fragment" {
  75699. /** @hidden */
  75700. export var volumetricLightScatteringPixelShader: {
  75701. name: string;
  75702. shader: string;
  75703. };
  75704. }
  75705. declare module "babylonjs/Shaders/volumetricLightScatteringPass.vertex" {
  75706. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  75707. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  75708. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  75709. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  75710. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  75711. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  75712. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  75713. /** @hidden */
  75714. export var volumetricLightScatteringPassVertexShader: {
  75715. name: string;
  75716. shader: string;
  75717. };
  75718. }
  75719. declare module "babylonjs/Shaders/volumetricLightScatteringPass.fragment" {
  75720. /** @hidden */
  75721. export var volumetricLightScatteringPassPixelShader: {
  75722. name: string;
  75723. shader: string;
  75724. };
  75725. }
  75726. declare module "babylonjs/PostProcesses/volumetricLightScatteringPostProcess" {
  75727. import { Vector3 } from "babylonjs/Maths/math.vector";
  75728. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75729. import { Mesh } from "babylonjs/Meshes/mesh";
  75730. import { Camera } from "babylonjs/Cameras/camera";
  75731. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  75732. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75733. import { Scene } from "babylonjs/scene";
  75734. import "babylonjs/Meshes/Builders/planeBuilder";
  75735. import "babylonjs/Shaders/depth.vertex";
  75736. import "babylonjs/Shaders/volumetricLightScattering.fragment";
  75737. import "babylonjs/Shaders/volumetricLightScatteringPass.vertex";
  75738. import "babylonjs/Shaders/volumetricLightScatteringPass.fragment";
  75739. import { Engine } from "babylonjs/Engines/engine";
  75740. /**
  75741. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  75742. */
  75743. export class VolumetricLightScatteringPostProcess extends PostProcess {
  75744. private _volumetricLightScatteringPass;
  75745. private _volumetricLightScatteringRTT;
  75746. private _viewPort;
  75747. private _screenCoordinates;
  75748. private _cachedDefines;
  75749. /**
  75750. * If not undefined, the mesh position is computed from the attached node position
  75751. */
  75752. attachedNode: {
  75753. position: Vector3;
  75754. };
  75755. /**
  75756. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  75757. */
  75758. customMeshPosition: Vector3;
  75759. /**
  75760. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  75761. */
  75762. useCustomMeshPosition: boolean;
  75763. /**
  75764. * If the post-process should inverse the light scattering direction
  75765. */
  75766. invert: boolean;
  75767. /**
  75768. * The internal mesh used by the post-process
  75769. */
  75770. mesh: Mesh;
  75771. /**
  75772. * @hidden
  75773. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  75774. */
  75775. get useDiffuseColor(): boolean;
  75776. set useDiffuseColor(useDiffuseColor: boolean);
  75777. /**
  75778. * Array containing the excluded meshes not rendered in the internal pass
  75779. */
  75780. excludedMeshes: AbstractMesh[];
  75781. /**
  75782. * Controls the overall intensity of the post-process
  75783. */
  75784. exposure: number;
  75785. /**
  75786. * Dissipates each sample's contribution in range [0, 1]
  75787. */
  75788. decay: number;
  75789. /**
  75790. * Controls the overall intensity of each sample
  75791. */
  75792. weight: number;
  75793. /**
  75794. * Controls the density of each sample
  75795. */
  75796. density: number;
  75797. /**
  75798. * @constructor
  75799. * @param name The post-process name
  75800. * @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)
  75801. * @param camera The camera that the post-process will be attached to
  75802. * @param mesh The mesh used to create the light scattering
  75803. * @param samples The post-process quality, default 100
  75804. * @param samplingModeThe post-process filtering mode
  75805. * @param engine The babylon engine
  75806. * @param reusable If the post-process is reusable
  75807. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  75808. */
  75809. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  75810. /**
  75811. * Returns the string "VolumetricLightScatteringPostProcess"
  75812. * @returns "VolumetricLightScatteringPostProcess"
  75813. */
  75814. getClassName(): string;
  75815. private _isReady;
  75816. /**
  75817. * Sets the new light position for light scattering effect
  75818. * @param position The new custom light position
  75819. */
  75820. setCustomMeshPosition(position: Vector3): void;
  75821. /**
  75822. * Returns the light position for light scattering effect
  75823. * @return Vector3 The custom light position
  75824. */
  75825. getCustomMeshPosition(): Vector3;
  75826. /**
  75827. * Disposes the internal assets and detaches the post-process from the camera
  75828. */
  75829. dispose(camera: Camera): void;
  75830. /**
  75831. * Returns the render target texture used by the post-process
  75832. * @return the render target texture used by the post-process
  75833. */
  75834. getPass(): RenderTargetTexture;
  75835. private _meshExcluded;
  75836. private _createPass;
  75837. private _updateMeshScreenCoordinates;
  75838. /**
  75839. * Creates a default mesh for the Volumeric Light Scattering post-process
  75840. * @param name The mesh name
  75841. * @param scene The scene where to create the mesh
  75842. * @return the default mesh
  75843. */
  75844. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  75845. }
  75846. }
  75847. declare module "babylonjs/Shaders/screenSpaceCurvature.fragment" {
  75848. /** @hidden */
  75849. export var screenSpaceCurvaturePixelShader: {
  75850. name: string;
  75851. shader: string;
  75852. };
  75853. }
  75854. declare module "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess" {
  75855. import { Nullable } from "babylonjs/types";
  75856. import { Camera } from "babylonjs/Cameras/camera";
  75857. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  75858. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  75859. import "babylonjs/Shaders/screenSpaceCurvature.fragment";
  75860. import { Engine } from "babylonjs/Engines/engine";
  75861. import { Scene } from "babylonjs/scene";
  75862. /**
  75863. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  75864. */
  75865. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  75866. /**
  75867. * Defines how much ridge the curvature effect displays.
  75868. */
  75869. ridge: number;
  75870. /**
  75871. * Defines how much valley the curvature effect displays.
  75872. */
  75873. valley: number;
  75874. private _geometryBufferRenderer;
  75875. /**
  75876. * Gets a string identifying the name of the class
  75877. * @returns "ScreenSpaceCurvaturePostProcess" string
  75878. */
  75879. getClassName(): string;
  75880. /**
  75881. * Creates a new instance ScreenSpaceCurvaturePostProcess
  75882. * @param name The name of the effect.
  75883. * @param scene The scene containing the objects to blur according to their velocity.
  75884. * @param options The required width/height ratio to downsize to before computing the render pass.
  75885. * @param camera The camera to apply the render pass to.
  75886. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75887. * @param engine The engine which the post process will be applied. (default: current engine)
  75888. * @param reusable If the post process can be reused on the same frame. (default: false)
  75889. * @param textureType Type of textures used when performing the post process. (default: 0)
  75890. * @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)
  75891. */
  75892. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  75893. /**
  75894. * Support test.
  75895. */
  75896. static get IsSupported(): boolean;
  75897. /** @hidden */
  75898. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  75899. }
  75900. }
  75901. declare module "babylonjs/PostProcesses/index" {
  75902. export * from "babylonjs/PostProcesses/anaglyphPostProcess";
  75903. export * from "babylonjs/PostProcesses/blackAndWhitePostProcess";
  75904. export * from "babylonjs/PostProcesses/bloomEffect";
  75905. export * from "babylonjs/PostProcesses/bloomMergePostProcess";
  75906. export * from "babylonjs/PostProcesses/blurPostProcess";
  75907. export * from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  75908. export * from "babylonjs/PostProcesses/circleOfConfusionPostProcess";
  75909. export * from "babylonjs/PostProcesses/colorCorrectionPostProcess";
  75910. export * from "babylonjs/PostProcesses/convolutionPostProcess";
  75911. export * from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  75912. export * from "babylonjs/PostProcesses/depthOfFieldEffect";
  75913. export * from "babylonjs/PostProcesses/depthOfFieldMergePostProcess";
  75914. export * from "babylonjs/PostProcesses/displayPassPostProcess";
  75915. export * from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  75916. export * from "babylonjs/PostProcesses/filterPostProcess";
  75917. export * from "babylonjs/PostProcesses/fxaaPostProcess";
  75918. export * from "babylonjs/PostProcesses/grainPostProcess";
  75919. export * from "babylonjs/PostProcesses/highlightsPostProcess";
  75920. export * from "babylonjs/PostProcesses/imageProcessingPostProcess";
  75921. export * from "babylonjs/PostProcesses/motionBlurPostProcess";
  75922. export * from "babylonjs/PostProcesses/passPostProcess";
  75923. export * from "babylonjs/PostProcesses/postProcess";
  75924. export * from "babylonjs/PostProcesses/postProcessManager";
  75925. export * from "babylonjs/PostProcesses/refractionPostProcess";
  75926. export * from "babylonjs/PostProcesses/RenderPipeline/index";
  75927. export * from "babylonjs/PostProcesses/sharpenPostProcess";
  75928. export * from "babylonjs/PostProcesses/stereoscopicInterlacePostProcess";
  75929. export * from "babylonjs/PostProcesses/tonemapPostProcess";
  75930. export * from "babylonjs/PostProcesses/volumetricLightScatteringPostProcess";
  75931. export * from "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess";
  75932. export * from "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess";
  75933. export * from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  75934. export * from "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess";
  75935. }
  75936. declare module "babylonjs/Probes/index" {
  75937. export * from "babylonjs/Probes/reflectionProbe";
  75938. }
  75939. declare module "babylonjs/Rendering/boundingBoxRenderer" {
  75940. import { Scene } from "babylonjs/scene";
  75941. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75942. import { SmartArray } from "babylonjs/Misc/smartArray";
  75943. import { ISceneComponent } from "babylonjs/sceneComponent";
  75944. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  75945. import "babylonjs/Meshes/Builders/boxBuilder";
  75946. import "babylonjs/Shaders/color.fragment";
  75947. import "babylonjs/Shaders/color.vertex";
  75948. import { Color3 } from "babylonjs/Maths/math.color";
  75949. import { Observable } from "babylonjs/Misc/observable";
  75950. module "babylonjs/scene" {
  75951. interface Scene {
  75952. /** @hidden (Backing field) */
  75953. _boundingBoxRenderer: BoundingBoxRenderer;
  75954. /** @hidden (Backing field) */
  75955. _forceShowBoundingBoxes: boolean;
  75956. /**
  75957. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  75958. */
  75959. forceShowBoundingBoxes: boolean;
  75960. /**
  75961. * Gets the bounding box renderer associated with the scene
  75962. * @returns a BoundingBoxRenderer
  75963. */
  75964. getBoundingBoxRenderer(): BoundingBoxRenderer;
  75965. }
  75966. }
  75967. module "babylonjs/Meshes/abstractMesh" {
  75968. interface AbstractMesh {
  75969. /** @hidden (Backing field) */
  75970. _showBoundingBox: boolean;
  75971. /**
  75972. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  75973. */
  75974. showBoundingBox: boolean;
  75975. }
  75976. }
  75977. /**
  75978. * Component responsible of rendering the bounding box of the meshes in a scene.
  75979. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  75980. */
  75981. export class BoundingBoxRenderer implements ISceneComponent {
  75982. /**
  75983. * The component name helpfull to identify the component in the list of scene components.
  75984. */
  75985. readonly name: string;
  75986. /**
  75987. * The scene the component belongs to.
  75988. */
  75989. scene: Scene;
  75990. /**
  75991. * Color of the bounding box lines placed in front of an object
  75992. */
  75993. frontColor: Color3;
  75994. /**
  75995. * Color of the bounding box lines placed behind an object
  75996. */
  75997. backColor: Color3;
  75998. /**
  75999. * Defines if the renderer should show the back lines or not
  76000. */
  76001. showBackLines: boolean;
  76002. /**
  76003. * Observable raised before rendering a bounding box
  76004. */
  76005. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  76006. /**
  76007. * Observable raised after rendering a bounding box
  76008. */
  76009. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  76010. /**
  76011. * @hidden
  76012. */
  76013. renderList: SmartArray<BoundingBox>;
  76014. private _colorShader;
  76015. private _vertexBuffers;
  76016. private _indexBuffer;
  76017. private _fillIndexBuffer;
  76018. private _fillIndexData;
  76019. /**
  76020. * Instantiates a new bounding box renderer in a scene.
  76021. * @param scene the scene the renderer renders in
  76022. */
  76023. constructor(scene: Scene);
  76024. /**
  76025. * Registers the component in a given scene
  76026. */
  76027. register(): void;
  76028. private _evaluateSubMesh;
  76029. private _activeMesh;
  76030. private _prepareRessources;
  76031. private _createIndexBuffer;
  76032. /**
  76033. * Rebuilds the elements related to this component in case of
  76034. * context lost for instance.
  76035. */
  76036. rebuild(): void;
  76037. /**
  76038. * @hidden
  76039. */
  76040. reset(): void;
  76041. /**
  76042. * Render the bounding boxes of a specific rendering group
  76043. * @param renderingGroupId defines the rendering group to render
  76044. */
  76045. render(renderingGroupId: number): void;
  76046. /**
  76047. * In case of occlusion queries, we can render the occlusion bounding box through this method
  76048. * @param mesh Define the mesh to render the occlusion bounding box for
  76049. */
  76050. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  76051. /**
  76052. * Dispose and release the resources attached to this renderer.
  76053. */
  76054. dispose(): void;
  76055. }
  76056. }
  76057. declare module "babylonjs/Rendering/depthRendererSceneComponent" {
  76058. import { Nullable } from "babylonjs/types";
  76059. import { Scene } from "babylonjs/scene";
  76060. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  76061. import { Camera } from "babylonjs/Cameras/camera";
  76062. import { ISceneComponent } from "babylonjs/sceneComponent";
  76063. module "babylonjs/scene" {
  76064. interface Scene {
  76065. /** @hidden (Backing field) */
  76066. _depthRenderer: {
  76067. [id: string]: DepthRenderer;
  76068. };
  76069. /**
  76070. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  76071. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  76072. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  76073. * @param force32bitsFloat Forces 32 bits float when supported (else 16 bits float is prioritized over 32 bits float if supported)
  76074. * @returns the created depth renderer
  76075. */
  76076. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean, force32bitsFloat?: boolean): DepthRenderer;
  76077. /**
  76078. * Disables a depth renderer for a given camera
  76079. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  76080. */
  76081. disableDepthRenderer(camera?: Nullable<Camera>): void;
  76082. }
  76083. }
  76084. /**
  76085. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  76086. * in several rendering techniques.
  76087. */
  76088. export class DepthRendererSceneComponent implements ISceneComponent {
  76089. /**
  76090. * The component name helpfull to identify the component in the list of scene components.
  76091. */
  76092. readonly name: string;
  76093. /**
  76094. * The scene the component belongs to.
  76095. */
  76096. scene: Scene;
  76097. /**
  76098. * Creates a new instance of the component for the given scene
  76099. * @param scene Defines the scene to register the component in
  76100. */
  76101. constructor(scene: Scene);
  76102. /**
  76103. * Registers the component in a given scene
  76104. */
  76105. register(): void;
  76106. /**
  76107. * Rebuilds the elements related to this component in case of
  76108. * context lost for instance.
  76109. */
  76110. rebuild(): void;
  76111. /**
  76112. * Disposes the component and the associated ressources
  76113. */
  76114. dispose(): void;
  76115. private _gatherRenderTargets;
  76116. private _gatherActiveCameraRenderTargets;
  76117. }
  76118. }
  76119. declare module "babylonjs/Rendering/prePassRendererSceneComponent" {
  76120. import { Nullable } from "babylonjs/types";
  76121. import { Scene } from "babylonjs/scene";
  76122. import { ISceneComponent } from "babylonjs/sceneComponent";
  76123. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  76124. module "babylonjs/abstractScene" {
  76125. interface AbstractScene {
  76126. /** @hidden (Backing field) */
  76127. _prePassRenderer: Nullable<PrePassRenderer>;
  76128. /**
  76129. * Gets or Sets the current prepass renderer associated to the scene.
  76130. */
  76131. prePassRenderer: Nullable<PrePassRenderer>;
  76132. /**
  76133. * Enables the prepass and associates it with the scene
  76134. * @returns the PrePassRenderer
  76135. */
  76136. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  76137. /**
  76138. * Disables the prepass associated with the scene
  76139. */
  76140. disablePrePassRenderer(): void;
  76141. }
  76142. }
  76143. /**
  76144. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  76145. * in several rendering techniques.
  76146. */
  76147. export class PrePassRendererSceneComponent implements ISceneComponent {
  76148. /**
  76149. * The component name helpful to identify the component in the list of scene components.
  76150. */
  76151. readonly name: string;
  76152. /**
  76153. * The scene the component belongs to.
  76154. */
  76155. scene: Scene;
  76156. /**
  76157. * Creates a new instance of the component for the given scene
  76158. * @param scene Defines the scene to register the component in
  76159. */
  76160. constructor(scene: Scene);
  76161. /**
  76162. * Registers the component in a given scene
  76163. */
  76164. register(): void;
  76165. private _beforeCameraDraw;
  76166. private _afterCameraDraw;
  76167. private _beforeClearStage;
  76168. /**
  76169. * Rebuilds the elements related to this component in case of
  76170. * context lost for instance.
  76171. */
  76172. rebuild(): void;
  76173. /**
  76174. * Disposes the component and the associated ressources
  76175. */
  76176. dispose(): void;
  76177. }
  76178. }
  76179. declare module "babylonjs/Shaders/ShadersInclude/fibonacci" {
  76180. /** @hidden */
  76181. export var fibonacci: {
  76182. name: string;
  76183. shader: string;
  76184. };
  76185. }
  76186. declare module "babylonjs/Shaders/ShadersInclude/diffusionProfile" {
  76187. /** @hidden */
  76188. export var diffusionProfile: {
  76189. name: string;
  76190. shader: string;
  76191. };
  76192. }
  76193. declare module "babylonjs/Shaders/subSurfaceScattering.fragment" {
  76194. import "babylonjs/Shaders/ShadersInclude/fibonacci";
  76195. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  76196. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  76197. import "babylonjs/Shaders/ShadersInclude/diffusionProfile";
  76198. /** @hidden */
  76199. export var subSurfaceScatteringPixelShader: {
  76200. name: string;
  76201. shader: string;
  76202. };
  76203. }
  76204. declare module "babylonjs/PostProcesses/subSurfaceScatteringPostProcess" {
  76205. import { Nullable } from "babylonjs/types";
  76206. import { Camera } from "babylonjs/Cameras/camera";
  76207. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  76208. import { Engine } from "babylonjs/Engines/engine";
  76209. import { Scene } from "babylonjs/scene";
  76210. import "babylonjs/Shaders/imageProcessing.fragment";
  76211. import "babylonjs/Shaders/subSurfaceScattering.fragment";
  76212. import "babylonjs/Shaders/postprocess.vertex";
  76213. /**
  76214. * Sub surface scattering post process
  76215. */
  76216. export class SubSurfaceScatteringPostProcess extends PostProcess {
  76217. /**
  76218. * Gets a string identifying the name of the class
  76219. * @returns "SubSurfaceScatteringPostProcess" string
  76220. */
  76221. getClassName(): string;
  76222. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  76223. }
  76224. }
  76225. declare module "babylonjs/Rendering/subSurfaceConfiguration" {
  76226. import { Scene } from "babylonjs/scene";
  76227. import { Color3 } from "babylonjs/Maths/math.color";
  76228. import { SubSurfaceScatteringPostProcess } from "babylonjs/PostProcesses/subSurfaceScatteringPostProcess";
  76229. import { PrePassEffectConfiguration } from "babylonjs/Rendering/prePassEffectConfiguration";
  76230. /**
  76231. * Contains all parameters needed for the prepass to perform
  76232. * screen space subsurface scattering
  76233. */
  76234. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  76235. /** @hidden */
  76236. static _SceneComponentInitialization: (scene: Scene) => void;
  76237. private _ssDiffusionS;
  76238. private _ssFilterRadii;
  76239. private _ssDiffusionD;
  76240. /**
  76241. * Post process to attach for screen space subsurface scattering
  76242. */
  76243. postProcess: SubSurfaceScatteringPostProcess;
  76244. /**
  76245. * Diffusion profile color for subsurface scattering
  76246. */
  76247. get ssDiffusionS(): number[];
  76248. /**
  76249. * Diffusion profile max color channel value for subsurface scattering
  76250. */
  76251. get ssDiffusionD(): number[];
  76252. /**
  76253. * Diffusion profile filter radius for subsurface scattering
  76254. */
  76255. get ssFilterRadii(): number[];
  76256. /**
  76257. * Is subsurface enabled
  76258. */
  76259. enabled: boolean;
  76260. /**
  76261. * Name of the configuration
  76262. */
  76263. name: string;
  76264. /**
  76265. * Diffusion profile colors for subsurface scattering
  76266. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  76267. * See ...
  76268. * Note that you can only store up to 5 of them
  76269. */
  76270. ssDiffusionProfileColors: Color3[];
  76271. /**
  76272. * Defines the ratio real world => scene units.
  76273. * Used for subsurface scattering
  76274. */
  76275. metersPerUnit: number;
  76276. /**
  76277. * Textures that should be present in the MRT for this effect to work
  76278. */
  76279. readonly texturesRequired: number[];
  76280. private _scene;
  76281. /**
  76282. * Builds a subsurface configuration object
  76283. * @param scene The scene
  76284. */
  76285. constructor(scene: Scene);
  76286. /**
  76287. * Adds a new diffusion profile.
  76288. * Useful for more realistic subsurface scattering on diverse materials.
  76289. * @param color The color of the diffusion profile. Should be the average color of the material.
  76290. * @return The index of the diffusion profile for the material subsurface configuration
  76291. */
  76292. addDiffusionProfile(color: Color3): number;
  76293. /**
  76294. * Creates the sss post process
  76295. * @return The created post process
  76296. */
  76297. createPostProcess(): SubSurfaceScatteringPostProcess;
  76298. /**
  76299. * Deletes all diffusion profiles.
  76300. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  76301. */
  76302. clearAllDiffusionProfiles(): void;
  76303. /**
  76304. * Disposes this object
  76305. */
  76306. dispose(): void;
  76307. /**
  76308. * @hidden
  76309. * https://zero-radiance.github.io/post/sampling-diffusion/
  76310. *
  76311. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  76312. * ------------------------------------------------------------------------------------
  76313. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  76314. * PDF[r, phi, s] = r * R[r, phi, s]
  76315. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  76316. * ------------------------------------------------------------------------------------
  76317. * We importance sample the color channel with the widest scattering distance.
  76318. */
  76319. getDiffusionProfileParameters(color: Color3): number;
  76320. /**
  76321. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  76322. * 'u' is the random number (the value of the CDF): [0, 1).
  76323. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  76324. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  76325. */
  76326. private _sampleBurleyDiffusionProfile;
  76327. }
  76328. }
  76329. declare module "babylonjs/Rendering/subSurfaceSceneComponent" {
  76330. import { Nullable } from "babylonjs/types";
  76331. import { Scene } from "babylonjs/scene";
  76332. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  76333. import { SubSurfaceConfiguration } from "babylonjs/Rendering/subSurfaceConfiguration";
  76334. import { AbstractScene } from "babylonjs/abstractScene";
  76335. module "babylonjs/abstractScene" {
  76336. interface AbstractScene {
  76337. /** @hidden (Backing field) */
  76338. _subSurfaceConfiguration: Nullable<SubSurfaceConfiguration>;
  76339. /**
  76340. * Gets or Sets the current prepass renderer associated to the scene.
  76341. */
  76342. subSurfaceConfiguration: Nullable<SubSurfaceConfiguration>;
  76343. /**
  76344. * Enables the subsurface effect for prepass
  76345. * @returns the SubSurfaceConfiguration
  76346. */
  76347. enableSubSurfaceForPrePass(): Nullable<SubSurfaceConfiguration>;
  76348. /**
  76349. * Disables the subsurface effect for prepass
  76350. */
  76351. disableSubSurfaceForPrePass(): void;
  76352. }
  76353. }
  76354. /**
  76355. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  76356. * in several rendering techniques.
  76357. */
  76358. export class SubSurfaceSceneComponent implements ISceneSerializableComponent {
  76359. /**
  76360. * The component name helpful to identify the component in the list of scene components.
  76361. */
  76362. readonly name: string;
  76363. /**
  76364. * The scene the component belongs to.
  76365. */
  76366. scene: Scene;
  76367. /**
  76368. * Creates a new instance of the component for the given scene
  76369. * @param scene Defines the scene to register the component in
  76370. */
  76371. constructor(scene: Scene);
  76372. /**
  76373. * Registers the component in a given scene
  76374. */
  76375. register(): void;
  76376. /**
  76377. * Serializes the component data to the specified json object
  76378. * @param serializationObject The object to serialize to
  76379. */
  76380. serialize(serializationObject: any): void;
  76381. /**
  76382. * Adds all the elements from the container to the scene
  76383. * @param container the container holding the elements
  76384. */
  76385. addFromContainer(container: AbstractScene): void;
  76386. /**
  76387. * Removes all the elements in the container from the scene
  76388. * @param container contains the elements to remove
  76389. * @param dispose if the removed element should be disposed (default: false)
  76390. */
  76391. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  76392. /**
  76393. * Rebuilds the elements related to this component in case of
  76394. * context lost for instance.
  76395. */
  76396. rebuild(): void;
  76397. /**
  76398. * Disposes the component and the associated ressources
  76399. */
  76400. dispose(): void;
  76401. }
  76402. }
  76403. declare module "babylonjs/Shaders/outline.fragment" {
  76404. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  76405. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  76406. /** @hidden */
  76407. export var outlinePixelShader: {
  76408. name: string;
  76409. shader: string;
  76410. };
  76411. }
  76412. declare module "babylonjs/Shaders/outline.vertex" {
  76413. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  76414. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  76415. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  76416. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  76417. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  76418. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  76419. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  76420. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  76421. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  76422. /** @hidden */
  76423. export var outlineVertexShader: {
  76424. name: string;
  76425. shader: string;
  76426. };
  76427. }
  76428. declare module "babylonjs/Rendering/outlineRenderer" {
  76429. import { SubMesh } from "babylonjs/Meshes/subMesh";
  76430. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  76431. import { Scene } from "babylonjs/scene";
  76432. import { ISceneComponent } from "babylonjs/sceneComponent";
  76433. import "babylonjs/Shaders/outline.fragment";
  76434. import "babylonjs/Shaders/outline.vertex";
  76435. module "babylonjs/scene" {
  76436. interface Scene {
  76437. /** @hidden */
  76438. _outlineRenderer: OutlineRenderer;
  76439. /**
  76440. * Gets the outline renderer associated with the scene
  76441. * @returns a OutlineRenderer
  76442. */
  76443. getOutlineRenderer(): OutlineRenderer;
  76444. }
  76445. }
  76446. module "babylonjs/Meshes/abstractMesh" {
  76447. interface AbstractMesh {
  76448. /** @hidden (Backing field) */
  76449. _renderOutline: boolean;
  76450. /**
  76451. * Gets or sets a boolean indicating if the outline must be rendered as well
  76452. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  76453. */
  76454. renderOutline: boolean;
  76455. /** @hidden (Backing field) */
  76456. _renderOverlay: boolean;
  76457. /**
  76458. * Gets or sets a boolean indicating if the overlay must be rendered as well
  76459. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  76460. */
  76461. renderOverlay: boolean;
  76462. }
  76463. }
  76464. /**
  76465. * This class is responsible to draw bothe outline/overlay of meshes.
  76466. * It should not be used directly but through the available method on mesh.
  76467. */
  76468. export class OutlineRenderer implements ISceneComponent {
  76469. /**
  76470. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  76471. */
  76472. private static _StencilReference;
  76473. /**
  76474. * The name of the component. Each component must have a unique name.
  76475. */
  76476. name: string;
  76477. /**
  76478. * The scene the component belongs to.
  76479. */
  76480. scene: Scene;
  76481. /**
  76482. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  76483. */
  76484. zOffset: number;
  76485. private _engine;
  76486. private _effect;
  76487. private _cachedDefines;
  76488. private _savedDepthWrite;
  76489. /**
  76490. * Instantiates a new outline renderer. (There could be only one per scene).
  76491. * @param scene Defines the scene it belongs to
  76492. */
  76493. constructor(scene: Scene);
  76494. /**
  76495. * Register the component to one instance of a scene.
  76496. */
  76497. register(): void;
  76498. /**
  76499. * Rebuilds the elements related to this component in case of
  76500. * context lost for instance.
  76501. */
  76502. rebuild(): void;
  76503. /**
  76504. * Disposes the component and the associated ressources.
  76505. */
  76506. dispose(): void;
  76507. /**
  76508. * Renders the outline in the canvas.
  76509. * @param subMesh Defines the sumesh to render
  76510. * @param batch Defines the batch of meshes in case of instances
  76511. * @param useOverlay Defines if the rendering is for the overlay or the outline
  76512. */
  76513. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  76514. /**
  76515. * Returns whether or not the outline renderer is ready for a given submesh.
  76516. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  76517. * @param subMesh Defines the submesh to check readyness for
  76518. * @param useInstances Defines wheter wee are trying to render instances or not
  76519. * @returns true if ready otherwise false
  76520. */
  76521. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  76522. private _beforeRenderingMesh;
  76523. private _afterRenderingMesh;
  76524. }
  76525. }
  76526. declare module "babylonjs/Rendering/index" {
  76527. export * from "babylonjs/Rendering/boundingBoxRenderer";
  76528. export * from "babylonjs/Rendering/depthRenderer";
  76529. export * from "babylonjs/Rendering/depthRendererSceneComponent";
  76530. export * from "babylonjs/Rendering/edgesRenderer";
  76531. export * from "babylonjs/Rendering/geometryBufferRenderer";
  76532. export * from "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  76533. export * from "babylonjs/Rendering/prePassRenderer";
  76534. export * from "babylonjs/Rendering/prePassRendererSceneComponent";
  76535. export * from "babylonjs/Rendering/subSurfaceSceneComponent";
  76536. export * from "babylonjs/Rendering/outlineRenderer";
  76537. export * from "babylonjs/Rendering/renderingGroup";
  76538. export * from "babylonjs/Rendering/renderingManager";
  76539. export * from "babylonjs/Rendering/utilityLayerRenderer";
  76540. }
  76541. declare module "babylonjs/Sprites/ISprites" {
  76542. /**
  76543. * Defines the basic options interface of a Sprite Frame Source Size.
  76544. */
  76545. export interface ISpriteJSONSpriteSourceSize {
  76546. /**
  76547. * number of the original width of the Frame
  76548. */
  76549. w: number;
  76550. /**
  76551. * number of the original height of the Frame
  76552. */
  76553. h: number;
  76554. }
  76555. /**
  76556. * Defines the basic options interface of a Sprite Frame Data.
  76557. */
  76558. export interface ISpriteJSONSpriteFrameData {
  76559. /**
  76560. * number of the x offset of the Frame
  76561. */
  76562. x: number;
  76563. /**
  76564. * number of the y offset of the Frame
  76565. */
  76566. y: number;
  76567. /**
  76568. * number of the width of the Frame
  76569. */
  76570. w: number;
  76571. /**
  76572. * number of the height of the Frame
  76573. */
  76574. h: number;
  76575. }
  76576. /**
  76577. * Defines the basic options interface of a JSON Sprite.
  76578. */
  76579. export interface ISpriteJSONSprite {
  76580. /**
  76581. * string name of the Frame
  76582. */
  76583. filename: string;
  76584. /**
  76585. * ISpriteJSONSpriteFrame basic object of the frame data
  76586. */
  76587. frame: ISpriteJSONSpriteFrameData;
  76588. /**
  76589. * boolean to flag is the frame was rotated.
  76590. */
  76591. rotated: boolean;
  76592. /**
  76593. * boolean to flag is the frame was trimmed.
  76594. */
  76595. trimmed: boolean;
  76596. /**
  76597. * ISpriteJSONSpriteFrame basic object of the source data
  76598. */
  76599. spriteSourceSize: ISpriteJSONSpriteFrameData;
  76600. /**
  76601. * ISpriteJSONSpriteFrame basic object of the source data
  76602. */
  76603. sourceSize: ISpriteJSONSpriteSourceSize;
  76604. }
  76605. /**
  76606. * Defines the basic options interface of a JSON atlas.
  76607. */
  76608. export interface ISpriteJSONAtlas {
  76609. /**
  76610. * Array of objects that contain the frame data.
  76611. */
  76612. frames: Array<ISpriteJSONSprite>;
  76613. /**
  76614. * object basic object containing the sprite meta data.
  76615. */
  76616. meta?: object;
  76617. }
  76618. }
  76619. declare module "babylonjs/Shaders/spriteMap.fragment" {
  76620. /** @hidden */
  76621. export var spriteMapPixelShader: {
  76622. name: string;
  76623. shader: string;
  76624. };
  76625. }
  76626. declare module "babylonjs/Shaders/spriteMap.vertex" {
  76627. /** @hidden */
  76628. export var spriteMapVertexShader: {
  76629. name: string;
  76630. shader: string;
  76631. };
  76632. }
  76633. declare module "babylonjs/Sprites/spriteMap" {
  76634. import { IDisposable, Scene } from "babylonjs/scene";
  76635. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  76636. import { Texture } from "babylonjs/Materials/Textures/texture";
  76637. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  76638. import { ISpriteJSONSprite, ISpriteJSONAtlas } from "babylonjs/Sprites/ISprites";
  76639. import "babylonjs/Meshes/Builders/planeBuilder";
  76640. import "babylonjs/Shaders/spriteMap.fragment";
  76641. import "babylonjs/Shaders/spriteMap.vertex";
  76642. /**
  76643. * Defines the basic options interface of a SpriteMap
  76644. */
  76645. export interface ISpriteMapOptions {
  76646. /**
  76647. * Vector2 of the number of cells in the grid.
  76648. */
  76649. stageSize?: Vector2;
  76650. /**
  76651. * Vector2 of the size of the output plane in World Units.
  76652. */
  76653. outputSize?: Vector2;
  76654. /**
  76655. * Vector3 of the position of the output plane in World Units.
  76656. */
  76657. outputPosition?: Vector3;
  76658. /**
  76659. * Vector3 of the rotation of the output plane.
  76660. */
  76661. outputRotation?: Vector3;
  76662. /**
  76663. * number of layers that the system will reserve in resources.
  76664. */
  76665. layerCount?: number;
  76666. /**
  76667. * number of max animation frames a single cell will reserve in resources.
  76668. */
  76669. maxAnimationFrames?: number;
  76670. /**
  76671. * number cell index of the base tile when the system compiles.
  76672. */
  76673. baseTile?: number;
  76674. /**
  76675. * boolean flip the sprite after its been repositioned by the framing data.
  76676. */
  76677. flipU?: boolean;
  76678. /**
  76679. * Vector3 scalar of the global RGB values of the SpriteMap.
  76680. */
  76681. colorMultiply?: Vector3;
  76682. }
  76683. /**
  76684. * Defines the IDisposable interface in order to be cleanable from resources.
  76685. */
  76686. export interface ISpriteMap extends IDisposable {
  76687. /**
  76688. * String name of the SpriteMap.
  76689. */
  76690. name: string;
  76691. /**
  76692. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  76693. */
  76694. atlasJSON: ISpriteJSONAtlas;
  76695. /**
  76696. * Texture of the SpriteMap.
  76697. */
  76698. spriteSheet: Texture;
  76699. /**
  76700. * The parameters to initialize the SpriteMap with.
  76701. */
  76702. options: ISpriteMapOptions;
  76703. }
  76704. /**
  76705. * Class used to manage a grid restricted sprite deployment on an Output plane.
  76706. */
  76707. export class SpriteMap implements ISpriteMap {
  76708. /** The Name of the spriteMap */
  76709. name: string;
  76710. /** The JSON file with the frame and meta data */
  76711. atlasJSON: ISpriteJSONAtlas;
  76712. /** The systems Sprite Sheet Texture */
  76713. spriteSheet: Texture;
  76714. /** Arguments passed with the Constructor */
  76715. options: ISpriteMapOptions;
  76716. /** Public Sprite Storage array, parsed from atlasJSON */
  76717. sprites: Array<ISpriteJSONSprite>;
  76718. /** Returns the Number of Sprites in the System */
  76719. get spriteCount(): number;
  76720. /** Returns the Position of Output Plane*/
  76721. get position(): Vector3;
  76722. /** Returns the Position of Output Plane*/
  76723. set position(v: Vector3);
  76724. /** Returns the Rotation of Output Plane*/
  76725. get rotation(): Vector3;
  76726. /** Returns the Rotation of Output Plane*/
  76727. set rotation(v: Vector3);
  76728. /** Sets the AnimationMap*/
  76729. get animationMap(): RawTexture;
  76730. /** Sets the AnimationMap*/
  76731. set animationMap(v: RawTexture);
  76732. /** Scene that the SpriteMap was created in */
  76733. private _scene;
  76734. /** Texture Buffer of Float32 that holds tile frame data*/
  76735. private _frameMap;
  76736. /** Texture Buffers of Float32 that holds tileMap data*/
  76737. private _tileMaps;
  76738. /** Texture Buffer of Float32 that holds Animation Data*/
  76739. private _animationMap;
  76740. /** Custom ShaderMaterial Central to the System*/
  76741. private _material;
  76742. /** Custom ShaderMaterial Central to the System*/
  76743. private _output;
  76744. /** Systems Time Ticker*/
  76745. private _time;
  76746. /**
  76747. * Creates a new SpriteMap
  76748. * @param name defines the SpriteMaps Name
  76749. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  76750. * @param spriteSheet is the Texture that the Sprites are on.
  76751. * @param options a basic deployment configuration
  76752. * @param scene The Scene that the map is deployed on
  76753. */
  76754. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  76755. /**
  76756. * Returns tileID location
  76757. * @returns Vector2 the cell position ID
  76758. */
  76759. getTileID(): Vector2;
  76760. /**
  76761. * Gets the UV location of the mouse over the SpriteMap.
  76762. * @returns Vector2 the UV position of the mouse interaction
  76763. */
  76764. getMousePosition(): Vector2;
  76765. /**
  76766. * Creates the "frame" texture Buffer
  76767. * -------------------------------------
  76768. * Structure of frames
  76769. * "filename": "Falling-Water-2.png",
  76770. * "frame": {"x":69,"y":103,"w":24,"h":32},
  76771. * "rotated": true,
  76772. * "trimmed": true,
  76773. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  76774. * "sourceSize": {"w":32,"h":32}
  76775. * @returns RawTexture of the frameMap
  76776. */
  76777. private _createFrameBuffer;
  76778. /**
  76779. * Creates the tileMap texture Buffer
  76780. * @param buffer normally and array of numbers, or a false to generate from scratch
  76781. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  76782. * @returns RawTexture of the tileMap
  76783. */
  76784. private _createTileBuffer;
  76785. /**
  76786. * Modifies the data of the tileMaps
  76787. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  76788. * @param pos is the iVector2 Coordinates of the Tile
  76789. * @param tile The SpriteIndex of the new Tile
  76790. */
  76791. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  76792. /**
  76793. * Creates the animationMap texture Buffer
  76794. * @param buffer normally and array of numbers, or a false to generate from scratch
  76795. * @returns RawTexture of the animationMap
  76796. */
  76797. private _createTileAnimationBuffer;
  76798. /**
  76799. * Modifies the data of the animationMap
  76800. * @param cellID is the Index of the Sprite
  76801. * @param _frame is the target Animation frame
  76802. * @param toCell is the Target Index of the next frame of the animation
  76803. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  76804. * @param speed is a global scalar of the time variable on the map.
  76805. */
  76806. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  76807. /**
  76808. * Exports the .tilemaps file
  76809. */
  76810. saveTileMaps(): void;
  76811. /**
  76812. * Imports the .tilemaps file
  76813. * @param url of the .tilemaps file
  76814. */
  76815. loadTileMaps(url: string): void;
  76816. /**
  76817. * Release associated resources
  76818. */
  76819. dispose(): void;
  76820. }
  76821. }
  76822. declare module "babylonjs/Sprites/spritePackedManager" {
  76823. import { SpriteManager } from "babylonjs/Sprites/spriteManager";
  76824. import { Scene } from "babylonjs/scene";
  76825. /**
  76826. * Class used to manage multiple sprites of different sizes on the same spritesheet
  76827. * @see https://doc.babylonjs.com/babylon101/sprites
  76828. */
  76829. export class SpritePackedManager extends SpriteManager {
  76830. /** defines the packed manager's name */
  76831. name: string;
  76832. /**
  76833. * Creates a new sprite manager from a packed sprite sheet
  76834. * @param name defines the manager's name
  76835. * @param imgUrl defines the sprite sheet url
  76836. * @param capacity defines the maximum allowed number of sprites
  76837. * @param scene defines the hosting scene
  76838. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  76839. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  76840. * @param samplingMode defines the smapling mode to use with spritesheet
  76841. * @param fromPacked set to true; do not alter
  76842. */
  76843. constructor(
  76844. /** defines the packed manager's name */
  76845. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  76846. }
  76847. }
  76848. declare module "babylonjs/Sprites/index" {
  76849. export * from "babylonjs/Sprites/sprite";
  76850. export * from "babylonjs/Sprites/ISprites";
  76851. export * from "babylonjs/Sprites/spriteManager";
  76852. export * from "babylonjs/Sprites/spriteMap";
  76853. export * from "babylonjs/Sprites/spritePackedManager";
  76854. export * from "babylonjs/Sprites/spriteSceneComponent";
  76855. }
  76856. declare module "babylonjs/States/index" {
  76857. export * from "babylonjs/States/alphaCullingState";
  76858. export * from "babylonjs/States/depthCullingState";
  76859. export * from "babylonjs/States/stencilState";
  76860. }
  76861. declare module "babylonjs/Misc/assetsManager" {
  76862. import { Scene } from "babylonjs/scene";
  76863. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  76864. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  76865. import { Skeleton } from "babylonjs/Bones/skeleton";
  76866. import { Observable } from "babylonjs/Misc/observable";
  76867. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  76868. import { Texture } from "babylonjs/Materials/Textures/texture";
  76869. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  76870. import { HDRCubeTexture } from "babylonjs/Materials/Textures/hdrCubeTexture";
  76871. import { EquiRectangularCubeTexture } from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  76872. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  76873. import { AssetContainer } from "babylonjs/assetContainer";
  76874. /**
  76875. * Defines the list of states available for a task inside a AssetsManager
  76876. */
  76877. export enum AssetTaskState {
  76878. /**
  76879. * Initialization
  76880. */
  76881. INIT = 0,
  76882. /**
  76883. * Running
  76884. */
  76885. RUNNING = 1,
  76886. /**
  76887. * Done
  76888. */
  76889. DONE = 2,
  76890. /**
  76891. * Error
  76892. */
  76893. ERROR = 3
  76894. }
  76895. /**
  76896. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  76897. */
  76898. export abstract class AbstractAssetTask {
  76899. /**
  76900. * Task name
  76901. */ name: string;
  76902. /**
  76903. * Callback called when the task is successful
  76904. */
  76905. onSuccess: (task: any) => void;
  76906. /**
  76907. * Callback called when the task is not successful
  76908. */
  76909. onError: (task: any, message?: string, exception?: any) => void;
  76910. /**
  76911. * Creates a new AssetsManager
  76912. * @param name defines the name of the task
  76913. */
  76914. constructor(
  76915. /**
  76916. * Task name
  76917. */ name: string);
  76918. private _isCompleted;
  76919. private _taskState;
  76920. private _errorObject;
  76921. /**
  76922. * Get if the task is completed
  76923. */
  76924. get isCompleted(): boolean;
  76925. /**
  76926. * Gets the current state of the task
  76927. */
  76928. get taskState(): AssetTaskState;
  76929. /**
  76930. * Gets the current error object (if task is in error)
  76931. */
  76932. get errorObject(): {
  76933. message?: string;
  76934. exception?: any;
  76935. };
  76936. /**
  76937. * Internal only
  76938. * @hidden
  76939. */
  76940. _setErrorObject(message?: string, exception?: any): void;
  76941. /**
  76942. * Execute the current task
  76943. * @param scene defines the scene where you want your assets to be loaded
  76944. * @param onSuccess is a callback called when the task is successfully executed
  76945. * @param onError is a callback called if an error occurs
  76946. */
  76947. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76948. /**
  76949. * Execute the current task
  76950. * @param scene defines the scene where you want your assets to be loaded
  76951. * @param onSuccess is a callback called when the task is successfully executed
  76952. * @param onError is a callback called if an error occurs
  76953. */
  76954. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76955. /**
  76956. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  76957. * This can be used with failed tasks that have the reason for failure fixed.
  76958. */
  76959. reset(): void;
  76960. private onErrorCallback;
  76961. private onDoneCallback;
  76962. }
  76963. /**
  76964. * Define the interface used by progress events raised during assets loading
  76965. */
  76966. export interface IAssetsProgressEvent {
  76967. /**
  76968. * Defines the number of remaining tasks to process
  76969. */
  76970. remainingCount: number;
  76971. /**
  76972. * Defines the total number of tasks
  76973. */
  76974. totalCount: number;
  76975. /**
  76976. * Defines the task that was just processed
  76977. */
  76978. task: AbstractAssetTask;
  76979. }
  76980. /**
  76981. * Class used to share progress information about assets loading
  76982. */
  76983. export class AssetsProgressEvent implements IAssetsProgressEvent {
  76984. /**
  76985. * Defines the number of remaining tasks to process
  76986. */
  76987. remainingCount: number;
  76988. /**
  76989. * Defines the total number of tasks
  76990. */
  76991. totalCount: number;
  76992. /**
  76993. * Defines the task that was just processed
  76994. */
  76995. task: AbstractAssetTask;
  76996. /**
  76997. * Creates a AssetsProgressEvent
  76998. * @param remainingCount defines the number of remaining tasks to process
  76999. * @param totalCount defines the total number of tasks
  77000. * @param task defines the task that was just processed
  77001. */
  77002. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  77003. }
  77004. /**
  77005. * Define a task used by AssetsManager to load assets into a container
  77006. */
  77007. export class ContainerAssetTask extends AbstractAssetTask {
  77008. /**
  77009. * Defines the name of the task
  77010. */
  77011. name: string;
  77012. /**
  77013. * Defines the list of mesh's names you want to load
  77014. */
  77015. meshesNames: any;
  77016. /**
  77017. * Defines the root url to use as a base to load your meshes and associated resources
  77018. */
  77019. rootUrl: string;
  77020. /**
  77021. * Defines the filename or File of the scene to load from
  77022. */
  77023. sceneFilename: string | File;
  77024. /**
  77025. * Get the loaded asset container
  77026. */
  77027. loadedContainer: AssetContainer;
  77028. /**
  77029. * Gets the list of loaded meshes
  77030. */
  77031. loadedMeshes: Array<AbstractMesh>;
  77032. /**
  77033. * Gets the list of loaded particle systems
  77034. */
  77035. loadedParticleSystems: Array<IParticleSystem>;
  77036. /**
  77037. * Gets the list of loaded skeletons
  77038. */
  77039. loadedSkeletons: Array<Skeleton>;
  77040. /**
  77041. * Gets the list of loaded animation groups
  77042. */
  77043. loadedAnimationGroups: Array<AnimationGroup>;
  77044. /**
  77045. * Callback called when the task is successful
  77046. */
  77047. onSuccess: (task: ContainerAssetTask) => void;
  77048. /**
  77049. * Callback called when the task is successful
  77050. */
  77051. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  77052. /**
  77053. * Creates a new ContainerAssetTask
  77054. * @param name defines the name of the task
  77055. * @param meshesNames defines the list of mesh's names you want to load
  77056. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  77057. * @param sceneFilename defines the filename or File of the scene to load from
  77058. */
  77059. constructor(
  77060. /**
  77061. * Defines the name of the task
  77062. */
  77063. name: string,
  77064. /**
  77065. * Defines the list of mesh's names you want to load
  77066. */
  77067. meshesNames: any,
  77068. /**
  77069. * Defines the root url to use as a base to load your meshes and associated resources
  77070. */
  77071. rootUrl: string,
  77072. /**
  77073. * Defines the filename or File of the scene to load from
  77074. */
  77075. sceneFilename: string | File);
  77076. /**
  77077. * Execute the current task
  77078. * @param scene defines the scene where you want your assets to be loaded
  77079. * @param onSuccess is a callback called when the task is successfully executed
  77080. * @param onError is a callback called if an error occurs
  77081. */
  77082. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77083. }
  77084. /**
  77085. * Define a task used by AssetsManager to load meshes
  77086. */
  77087. export class MeshAssetTask extends AbstractAssetTask {
  77088. /**
  77089. * Defines the name of the task
  77090. */
  77091. name: string;
  77092. /**
  77093. * Defines the list of mesh's names you want to load
  77094. */
  77095. meshesNames: any;
  77096. /**
  77097. * Defines the root url to use as a base to load your meshes and associated resources
  77098. */
  77099. rootUrl: string;
  77100. /**
  77101. * Defines the filename or File of the scene to load from
  77102. */
  77103. sceneFilename: string | File;
  77104. /**
  77105. * Gets the list of loaded meshes
  77106. */
  77107. loadedMeshes: Array<AbstractMesh>;
  77108. /**
  77109. * Gets the list of loaded particle systems
  77110. */
  77111. loadedParticleSystems: Array<IParticleSystem>;
  77112. /**
  77113. * Gets the list of loaded skeletons
  77114. */
  77115. loadedSkeletons: Array<Skeleton>;
  77116. /**
  77117. * Gets the list of loaded animation groups
  77118. */
  77119. loadedAnimationGroups: Array<AnimationGroup>;
  77120. /**
  77121. * Callback called when the task is successful
  77122. */
  77123. onSuccess: (task: MeshAssetTask) => void;
  77124. /**
  77125. * Callback called when the task is successful
  77126. */
  77127. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  77128. /**
  77129. * Creates a new MeshAssetTask
  77130. * @param name defines the name of the task
  77131. * @param meshesNames defines the list of mesh's names you want to load
  77132. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  77133. * @param sceneFilename defines the filename or File of the scene to load from
  77134. */
  77135. constructor(
  77136. /**
  77137. * Defines the name of the task
  77138. */
  77139. name: string,
  77140. /**
  77141. * Defines the list of mesh's names you want to load
  77142. */
  77143. meshesNames: any,
  77144. /**
  77145. * Defines the root url to use as a base to load your meshes and associated resources
  77146. */
  77147. rootUrl: string,
  77148. /**
  77149. * Defines the filename or File of the scene to load from
  77150. */
  77151. sceneFilename: string | File);
  77152. /**
  77153. * Execute the current task
  77154. * @param scene defines the scene where you want your assets to be loaded
  77155. * @param onSuccess is a callback called when the task is successfully executed
  77156. * @param onError is a callback called if an error occurs
  77157. */
  77158. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77159. }
  77160. /**
  77161. * Define a task used by AssetsManager to load text content
  77162. */
  77163. export class TextFileAssetTask extends AbstractAssetTask {
  77164. /**
  77165. * Defines the name of the task
  77166. */
  77167. name: string;
  77168. /**
  77169. * Defines the location of the file to load
  77170. */
  77171. url: string;
  77172. /**
  77173. * Gets the loaded text string
  77174. */
  77175. text: string;
  77176. /**
  77177. * Callback called when the task is successful
  77178. */
  77179. onSuccess: (task: TextFileAssetTask) => void;
  77180. /**
  77181. * Callback called when the task is successful
  77182. */
  77183. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  77184. /**
  77185. * Creates a new TextFileAssetTask object
  77186. * @param name defines the name of the task
  77187. * @param url defines the location of the file to load
  77188. */
  77189. constructor(
  77190. /**
  77191. * Defines the name of the task
  77192. */
  77193. name: string,
  77194. /**
  77195. * Defines the location of the file to load
  77196. */
  77197. url: string);
  77198. /**
  77199. * Execute the current task
  77200. * @param scene defines the scene where you want your assets to be loaded
  77201. * @param onSuccess is a callback called when the task is successfully executed
  77202. * @param onError is a callback called if an error occurs
  77203. */
  77204. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77205. }
  77206. /**
  77207. * Define a task used by AssetsManager to load binary data
  77208. */
  77209. export class BinaryFileAssetTask extends AbstractAssetTask {
  77210. /**
  77211. * Defines the name of the task
  77212. */
  77213. name: string;
  77214. /**
  77215. * Defines the location of the file to load
  77216. */
  77217. url: string;
  77218. /**
  77219. * Gets the lodaded data (as an array buffer)
  77220. */
  77221. data: ArrayBuffer;
  77222. /**
  77223. * Callback called when the task is successful
  77224. */
  77225. onSuccess: (task: BinaryFileAssetTask) => void;
  77226. /**
  77227. * Callback called when the task is successful
  77228. */
  77229. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  77230. /**
  77231. * Creates a new BinaryFileAssetTask object
  77232. * @param name defines the name of the new task
  77233. * @param url defines the location of the file to load
  77234. */
  77235. constructor(
  77236. /**
  77237. * Defines the name of the task
  77238. */
  77239. name: string,
  77240. /**
  77241. * Defines the location of the file to load
  77242. */
  77243. url: string);
  77244. /**
  77245. * Execute the current task
  77246. * @param scene defines the scene where you want your assets to be loaded
  77247. * @param onSuccess is a callback called when the task is successfully executed
  77248. * @param onError is a callback called if an error occurs
  77249. */
  77250. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77251. }
  77252. /**
  77253. * Define a task used by AssetsManager to load images
  77254. */
  77255. export class ImageAssetTask extends AbstractAssetTask {
  77256. /**
  77257. * Defines the name of the task
  77258. */
  77259. name: string;
  77260. /**
  77261. * Defines the location of the image to load
  77262. */
  77263. url: string;
  77264. /**
  77265. * Gets the loaded images
  77266. */
  77267. image: HTMLImageElement;
  77268. /**
  77269. * Callback called when the task is successful
  77270. */
  77271. onSuccess: (task: ImageAssetTask) => void;
  77272. /**
  77273. * Callback called when the task is successful
  77274. */
  77275. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  77276. /**
  77277. * Creates a new ImageAssetTask
  77278. * @param name defines the name of the task
  77279. * @param url defines the location of the image to load
  77280. */
  77281. constructor(
  77282. /**
  77283. * Defines the name of the task
  77284. */
  77285. name: string,
  77286. /**
  77287. * Defines the location of the image to load
  77288. */
  77289. url: string);
  77290. /**
  77291. * Execute the current task
  77292. * @param scene defines the scene where you want your assets to be loaded
  77293. * @param onSuccess is a callback called when the task is successfully executed
  77294. * @param onError is a callback called if an error occurs
  77295. */
  77296. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77297. }
  77298. /**
  77299. * Defines the interface used by texture loading tasks
  77300. */
  77301. export interface ITextureAssetTask<TEX extends BaseTexture> {
  77302. /**
  77303. * Gets the loaded texture
  77304. */
  77305. texture: TEX;
  77306. }
  77307. /**
  77308. * Define a task used by AssetsManager to load 2D textures
  77309. */
  77310. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  77311. /**
  77312. * Defines the name of the task
  77313. */
  77314. name: string;
  77315. /**
  77316. * Defines the location of the file to load
  77317. */
  77318. url: string;
  77319. /**
  77320. * Defines if mipmap should not be generated (default is false)
  77321. */
  77322. noMipmap?: boolean | undefined;
  77323. /**
  77324. * Defines if texture must be inverted on Y axis (default is true)
  77325. */
  77326. invertY: boolean;
  77327. /**
  77328. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  77329. */
  77330. samplingMode: number;
  77331. /**
  77332. * Gets the loaded texture
  77333. */
  77334. texture: Texture;
  77335. /**
  77336. * Callback called when the task is successful
  77337. */
  77338. onSuccess: (task: TextureAssetTask) => void;
  77339. /**
  77340. * Callback called when the task is successful
  77341. */
  77342. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  77343. /**
  77344. * Creates a new TextureAssetTask object
  77345. * @param name defines the name of the task
  77346. * @param url defines the location of the file to load
  77347. * @param noMipmap defines if mipmap should not be generated (default is false)
  77348. * @param invertY defines if texture must be inverted on Y axis (default is true)
  77349. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  77350. */
  77351. constructor(
  77352. /**
  77353. * Defines the name of the task
  77354. */
  77355. name: string,
  77356. /**
  77357. * Defines the location of the file to load
  77358. */
  77359. url: string,
  77360. /**
  77361. * Defines if mipmap should not be generated (default is false)
  77362. */
  77363. noMipmap?: boolean | undefined,
  77364. /**
  77365. * Defines if texture must be inverted on Y axis (default is true)
  77366. */
  77367. invertY?: boolean,
  77368. /**
  77369. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  77370. */
  77371. samplingMode?: number);
  77372. /**
  77373. * Execute the current task
  77374. * @param scene defines the scene where you want your assets to be loaded
  77375. * @param onSuccess is a callback called when the task is successfully executed
  77376. * @param onError is a callback called if an error occurs
  77377. */
  77378. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77379. }
  77380. /**
  77381. * Define a task used by AssetsManager to load cube textures
  77382. */
  77383. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  77384. /**
  77385. * Defines the name of the task
  77386. */
  77387. name: string;
  77388. /**
  77389. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  77390. */
  77391. url: string;
  77392. /**
  77393. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  77394. */
  77395. extensions?: string[] | undefined;
  77396. /**
  77397. * Defines if mipmaps should not be generated (default is false)
  77398. */
  77399. noMipmap?: boolean | undefined;
  77400. /**
  77401. * Defines the explicit list of files (undefined by default)
  77402. */
  77403. files?: string[] | undefined;
  77404. /**
  77405. * Gets the loaded texture
  77406. */
  77407. texture: CubeTexture;
  77408. /**
  77409. * Callback called when the task is successful
  77410. */
  77411. onSuccess: (task: CubeTextureAssetTask) => void;
  77412. /**
  77413. * Callback called when the task is successful
  77414. */
  77415. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  77416. /**
  77417. * Creates a new CubeTextureAssetTask
  77418. * @param name defines the name of the task
  77419. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  77420. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  77421. * @param noMipmap defines if mipmaps should not be generated (default is false)
  77422. * @param files defines the explicit list of files (undefined by default)
  77423. */
  77424. constructor(
  77425. /**
  77426. * Defines the name of the task
  77427. */
  77428. name: string,
  77429. /**
  77430. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  77431. */
  77432. url: string,
  77433. /**
  77434. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  77435. */
  77436. extensions?: string[] | undefined,
  77437. /**
  77438. * Defines if mipmaps should not be generated (default is false)
  77439. */
  77440. noMipmap?: boolean | undefined,
  77441. /**
  77442. * Defines the explicit list of files (undefined by default)
  77443. */
  77444. files?: string[] | undefined);
  77445. /**
  77446. * Execute the current task
  77447. * @param scene defines the scene where you want your assets to be loaded
  77448. * @param onSuccess is a callback called when the task is successfully executed
  77449. * @param onError is a callback called if an error occurs
  77450. */
  77451. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77452. }
  77453. /**
  77454. * Define a task used by AssetsManager to load HDR cube textures
  77455. */
  77456. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  77457. /**
  77458. * Defines the name of the task
  77459. */
  77460. name: string;
  77461. /**
  77462. * Defines the location of the file to load
  77463. */
  77464. url: string;
  77465. /**
  77466. * Defines the desired size (the more it increases the longer the generation will be)
  77467. */
  77468. size: number;
  77469. /**
  77470. * Defines if mipmaps should not be generated (default is false)
  77471. */
  77472. noMipmap: boolean;
  77473. /**
  77474. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  77475. */
  77476. generateHarmonics: boolean;
  77477. /**
  77478. * 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)
  77479. */
  77480. gammaSpace: boolean;
  77481. /**
  77482. * Internal Use Only
  77483. */
  77484. reserved: boolean;
  77485. /**
  77486. * Gets the loaded texture
  77487. */
  77488. texture: HDRCubeTexture;
  77489. /**
  77490. * Callback called when the task is successful
  77491. */
  77492. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  77493. /**
  77494. * Callback called when the task is successful
  77495. */
  77496. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  77497. /**
  77498. * Creates a new HDRCubeTextureAssetTask object
  77499. * @param name defines the name of the task
  77500. * @param url defines the location of the file to load
  77501. * @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.
  77502. * @param noMipmap defines if mipmaps should not be generated (default is false)
  77503. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  77504. * @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)
  77505. * @param reserved Internal use only
  77506. */
  77507. constructor(
  77508. /**
  77509. * Defines the name of the task
  77510. */
  77511. name: string,
  77512. /**
  77513. * Defines the location of the file to load
  77514. */
  77515. url: string,
  77516. /**
  77517. * Defines the desired size (the more it increases the longer the generation will be)
  77518. */
  77519. size: number,
  77520. /**
  77521. * Defines if mipmaps should not be generated (default is false)
  77522. */
  77523. noMipmap?: boolean,
  77524. /**
  77525. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  77526. */
  77527. generateHarmonics?: boolean,
  77528. /**
  77529. * 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)
  77530. */
  77531. gammaSpace?: boolean,
  77532. /**
  77533. * Internal Use Only
  77534. */
  77535. reserved?: boolean);
  77536. /**
  77537. * Execute the current task
  77538. * @param scene defines the scene where you want your assets to be loaded
  77539. * @param onSuccess is a callback called when the task is successfully executed
  77540. * @param onError is a callback called if an error occurs
  77541. */
  77542. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77543. }
  77544. /**
  77545. * Define a task used by AssetsManager to load Equirectangular cube textures
  77546. */
  77547. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  77548. /**
  77549. * Defines the name of the task
  77550. */
  77551. name: string;
  77552. /**
  77553. * Defines the location of the file to load
  77554. */
  77555. url: string;
  77556. /**
  77557. * Defines the desired size (the more it increases the longer the generation will be)
  77558. */
  77559. size: number;
  77560. /**
  77561. * Defines if mipmaps should not be generated (default is false)
  77562. */
  77563. noMipmap: boolean;
  77564. /**
  77565. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  77566. * but the standard material would require them in Gamma space) (default is true)
  77567. */
  77568. gammaSpace: boolean;
  77569. /**
  77570. * Gets the loaded texture
  77571. */
  77572. texture: EquiRectangularCubeTexture;
  77573. /**
  77574. * Callback called when the task is successful
  77575. */
  77576. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  77577. /**
  77578. * Callback called when the task is successful
  77579. */
  77580. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  77581. /**
  77582. * Creates a new EquiRectangularCubeTextureAssetTask object
  77583. * @param name defines the name of the task
  77584. * @param url defines the location of the file to load
  77585. * @param size defines the desired size (the more it increases the longer the generation will be)
  77586. * If the size is omitted this implies you are using a preprocessed cubemap.
  77587. * @param noMipmap defines if mipmaps should not be generated (default is false)
  77588. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  77589. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  77590. * (default is true)
  77591. */
  77592. constructor(
  77593. /**
  77594. * Defines the name of the task
  77595. */
  77596. name: string,
  77597. /**
  77598. * Defines the location of the file to load
  77599. */
  77600. url: string,
  77601. /**
  77602. * Defines the desired size (the more it increases the longer the generation will be)
  77603. */
  77604. size: number,
  77605. /**
  77606. * Defines if mipmaps should not be generated (default is false)
  77607. */
  77608. noMipmap?: boolean,
  77609. /**
  77610. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  77611. * but the standard material would require them in Gamma space) (default is true)
  77612. */
  77613. gammaSpace?: boolean);
  77614. /**
  77615. * Execute the current task
  77616. * @param scene defines the scene where you want your assets to be loaded
  77617. * @param onSuccess is a callback called when the task is successfully executed
  77618. * @param onError is a callback called if an error occurs
  77619. */
  77620. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77621. }
  77622. /**
  77623. * This class can be used to easily import assets into a scene
  77624. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  77625. */
  77626. export class AssetsManager {
  77627. private _scene;
  77628. private _isLoading;
  77629. protected _tasks: AbstractAssetTask[];
  77630. protected _waitingTasksCount: number;
  77631. protected _totalTasksCount: number;
  77632. /**
  77633. * Callback called when all tasks are processed
  77634. */
  77635. onFinish: (tasks: AbstractAssetTask[]) => void;
  77636. /**
  77637. * Callback called when a task is successful
  77638. */
  77639. onTaskSuccess: (task: AbstractAssetTask) => void;
  77640. /**
  77641. * Callback called when a task had an error
  77642. */
  77643. onTaskError: (task: AbstractAssetTask) => void;
  77644. /**
  77645. * Callback called when a task is done (whatever the result is)
  77646. */
  77647. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  77648. /**
  77649. * Observable called when all tasks are processed
  77650. */
  77651. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  77652. /**
  77653. * Observable called when a task had an error
  77654. */
  77655. onTaskErrorObservable: Observable<AbstractAssetTask>;
  77656. /**
  77657. * Observable called when all tasks were executed
  77658. */
  77659. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  77660. /**
  77661. * Observable called when a task is done (whatever the result is)
  77662. */
  77663. onProgressObservable: Observable<IAssetsProgressEvent>;
  77664. /**
  77665. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  77666. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  77667. */
  77668. useDefaultLoadingScreen: boolean;
  77669. /**
  77670. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  77671. * when all assets have been downloaded.
  77672. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  77673. */
  77674. autoHideLoadingUI: boolean;
  77675. /**
  77676. * Creates a new AssetsManager
  77677. * @param scene defines the scene to work on
  77678. */
  77679. constructor(scene: Scene);
  77680. /**
  77681. * Add a ContainerAssetTask to the list of active tasks
  77682. * @param taskName defines the name of the new task
  77683. * @param meshesNames defines the name of meshes to load
  77684. * @param rootUrl defines the root url to use to locate files
  77685. * @param sceneFilename defines the filename of the scene file
  77686. * @returns a new ContainerAssetTask object
  77687. */
  77688. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  77689. /**
  77690. * Add a MeshAssetTask to the list of active tasks
  77691. * @param taskName defines the name of the new task
  77692. * @param meshesNames defines the name of meshes to load
  77693. * @param rootUrl defines the root url to use to locate files
  77694. * @param sceneFilename defines the filename of the scene file
  77695. * @returns a new MeshAssetTask object
  77696. */
  77697. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  77698. /**
  77699. * Add a TextFileAssetTask to the list of active tasks
  77700. * @param taskName defines the name of the new task
  77701. * @param url defines the url of the file to load
  77702. * @returns a new TextFileAssetTask object
  77703. */
  77704. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  77705. /**
  77706. * Add a BinaryFileAssetTask to the list of active tasks
  77707. * @param taskName defines the name of the new task
  77708. * @param url defines the url of the file to load
  77709. * @returns a new BinaryFileAssetTask object
  77710. */
  77711. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  77712. /**
  77713. * Add a ImageAssetTask to the list of active tasks
  77714. * @param taskName defines the name of the new task
  77715. * @param url defines the url of the file to load
  77716. * @returns a new ImageAssetTask object
  77717. */
  77718. addImageTask(taskName: string, url: string): ImageAssetTask;
  77719. /**
  77720. * Add a TextureAssetTask to the list of active tasks
  77721. * @param taskName defines the name of the new task
  77722. * @param url defines the url of the file to load
  77723. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77724. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  77725. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  77726. * @returns a new TextureAssetTask object
  77727. */
  77728. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  77729. /**
  77730. * Add a CubeTextureAssetTask to the list of active tasks
  77731. * @param taskName defines the name of the new task
  77732. * @param url defines the url of the file to load
  77733. * @param extensions defines the extension to use to load the cube map (can be null)
  77734. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77735. * @param files defines the list of files to load (can be null)
  77736. * @returns a new CubeTextureAssetTask object
  77737. */
  77738. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  77739. /**
  77740. *
  77741. * Add a HDRCubeTextureAssetTask to the list of active tasks
  77742. * @param taskName defines the name of the new task
  77743. * @param url defines the url of the file to load
  77744. * @param size defines the size you want for the cubemap (can be null)
  77745. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77746. * @param generateHarmonics defines if you want to automatically generate (true by default)
  77747. * @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)
  77748. * @param reserved Internal use only
  77749. * @returns a new HDRCubeTextureAssetTask object
  77750. */
  77751. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  77752. /**
  77753. *
  77754. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  77755. * @param taskName defines the name of the new task
  77756. * @param url defines the url of the file to load
  77757. * @param size defines the size you want for the cubemap (can be null)
  77758. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77759. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  77760. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  77761. * @returns a new EquiRectangularCubeTextureAssetTask object
  77762. */
  77763. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  77764. /**
  77765. * Remove a task from the assets manager.
  77766. * @param task the task to remove
  77767. */
  77768. removeTask(task: AbstractAssetTask): void;
  77769. private _decreaseWaitingTasksCount;
  77770. private _runTask;
  77771. /**
  77772. * Reset the AssetsManager and remove all tasks
  77773. * @return the current instance of the AssetsManager
  77774. */
  77775. reset(): AssetsManager;
  77776. /**
  77777. * Start the loading process
  77778. * @return the current instance of the AssetsManager
  77779. */
  77780. load(): AssetsManager;
  77781. /**
  77782. * Start the loading process as an async operation
  77783. * @return a promise returning the list of failed tasks
  77784. */
  77785. loadAsync(): Promise<void>;
  77786. }
  77787. }
  77788. declare module "babylonjs/Misc/deferred" {
  77789. /**
  77790. * Wrapper class for promise with external resolve and reject.
  77791. */
  77792. export class Deferred<T> {
  77793. /**
  77794. * The promise associated with this deferred object.
  77795. */
  77796. readonly promise: Promise<T>;
  77797. private _resolve;
  77798. private _reject;
  77799. /**
  77800. * The resolve method of the promise associated with this deferred object.
  77801. */
  77802. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  77803. /**
  77804. * The reject method of the promise associated with this deferred object.
  77805. */
  77806. get reject(): (reason?: any) => void;
  77807. /**
  77808. * Constructor for this deferred object.
  77809. */
  77810. constructor();
  77811. }
  77812. }
  77813. declare module "babylonjs/Misc/meshExploder" {
  77814. import { Mesh } from "babylonjs/Meshes/mesh";
  77815. /**
  77816. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  77817. */
  77818. export class MeshExploder {
  77819. private _centerMesh;
  77820. private _meshes;
  77821. private _meshesOrigins;
  77822. private _toCenterVectors;
  77823. private _scaledDirection;
  77824. private _newPosition;
  77825. private _centerPosition;
  77826. /**
  77827. * Explodes meshes from a center mesh.
  77828. * @param meshes The meshes to explode.
  77829. * @param centerMesh The mesh to be center of explosion.
  77830. */
  77831. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  77832. private _setCenterMesh;
  77833. /**
  77834. * Get class name
  77835. * @returns "MeshExploder"
  77836. */
  77837. getClassName(): string;
  77838. /**
  77839. * "Exploded meshes"
  77840. * @returns Array of meshes with the centerMesh at index 0.
  77841. */
  77842. getMeshes(): Array<Mesh>;
  77843. /**
  77844. * Explodes meshes giving a specific direction
  77845. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  77846. */
  77847. explode(direction?: number): void;
  77848. }
  77849. }
  77850. declare module "babylonjs/Misc/filesInput" {
  77851. import { Engine } from "babylonjs/Engines/engine";
  77852. import { Scene } from "babylonjs/scene";
  77853. import { ISceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
  77854. import { Nullable } from "babylonjs/types";
  77855. /**
  77856. * Class used to help managing file picking and drag'n'drop
  77857. */
  77858. export class FilesInput {
  77859. /**
  77860. * List of files ready to be loaded
  77861. */
  77862. static get FilesToLoad(): {
  77863. [key: string]: File;
  77864. };
  77865. /**
  77866. * Callback called when a file is processed
  77867. */
  77868. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  77869. private _engine;
  77870. private _currentScene;
  77871. private _sceneLoadedCallback;
  77872. private _progressCallback;
  77873. private _additionalRenderLoopLogicCallback;
  77874. private _textureLoadingCallback;
  77875. private _startingProcessingFilesCallback;
  77876. private _onReloadCallback;
  77877. private _errorCallback;
  77878. private _elementToMonitor;
  77879. private _sceneFileToLoad;
  77880. private _filesToLoad;
  77881. /**
  77882. * Creates a new FilesInput
  77883. * @param engine defines the rendering engine
  77884. * @param scene defines the hosting scene
  77885. * @param sceneLoadedCallback callback called when scene is loaded
  77886. * @param progressCallback callback called to track progress
  77887. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  77888. * @param textureLoadingCallback callback called when a texture is loading
  77889. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  77890. * @param onReloadCallback callback called when a reload is requested
  77891. * @param errorCallback callback call if an error occurs
  77892. */
  77893. 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>);
  77894. private _dragEnterHandler;
  77895. private _dragOverHandler;
  77896. private _dropHandler;
  77897. /**
  77898. * Calls this function to listen to drag'n'drop events on a specific DOM element
  77899. * @param elementToMonitor defines the DOM element to track
  77900. */
  77901. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  77902. /** Gets the current list of files to load */
  77903. get filesToLoad(): File[];
  77904. /**
  77905. * Release all associated resources
  77906. */
  77907. dispose(): void;
  77908. private renderFunction;
  77909. private drag;
  77910. private drop;
  77911. private _traverseFolder;
  77912. private _processFiles;
  77913. /**
  77914. * Load files from a drop event
  77915. * @param event defines the drop event to use as source
  77916. */
  77917. loadFiles(event: any): void;
  77918. private _processReload;
  77919. /**
  77920. * Reload the current scene from the loaded files
  77921. */
  77922. reload(): void;
  77923. }
  77924. }
  77925. declare module "babylonjs/Misc/HighDynamicRange/index" {
  77926. export * from "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial";
  77927. export * from "babylonjs/Misc/HighDynamicRange/hdr";
  77928. export * from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  77929. }
  77930. declare module "babylonjs/Misc/sceneOptimizer" {
  77931. import { Scene, IDisposable } from "babylonjs/scene";
  77932. import { Observable } from "babylonjs/Misc/observable";
  77933. /**
  77934. * Defines the root class used to create scene optimization to use with SceneOptimizer
  77935. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77936. */
  77937. export class SceneOptimization {
  77938. /**
  77939. * Defines the priority of this optimization (0 by default which means first in the list)
  77940. */
  77941. priority: number;
  77942. /**
  77943. * Gets a string describing the action executed by the current optimization
  77944. * @returns description string
  77945. */
  77946. getDescription(): string;
  77947. /**
  77948. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77949. * @param scene defines the current scene where to apply this optimization
  77950. * @param optimizer defines the current optimizer
  77951. * @returns true if everything that can be done was applied
  77952. */
  77953. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77954. /**
  77955. * Creates the SceneOptimization object
  77956. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77957. * @param desc defines the description associated with the optimization
  77958. */
  77959. constructor(
  77960. /**
  77961. * Defines the priority of this optimization (0 by default which means first in the list)
  77962. */
  77963. priority?: number);
  77964. }
  77965. /**
  77966. * Defines an optimization used to reduce the size of render target textures
  77967. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77968. */
  77969. export class TextureOptimization extends SceneOptimization {
  77970. /**
  77971. * Defines the priority of this optimization (0 by default which means first in the list)
  77972. */
  77973. priority: number;
  77974. /**
  77975. * 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
  77976. */
  77977. maximumSize: number;
  77978. /**
  77979. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77980. */
  77981. step: number;
  77982. /**
  77983. * Gets a string describing the action executed by the current optimization
  77984. * @returns description string
  77985. */
  77986. getDescription(): string;
  77987. /**
  77988. * Creates the TextureOptimization object
  77989. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77990. * @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
  77991. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77992. */
  77993. constructor(
  77994. /**
  77995. * Defines the priority of this optimization (0 by default which means first in the list)
  77996. */
  77997. priority?: number,
  77998. /**
  77999. * 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
  78000. */
  78001. maximumSize?: number,
  78002. /**
  78003. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  78004. */
  78005. step?: number);
  78006. /**
  78007. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78008. * @param scene defines the current scene where to apply this optimization
  78009. * @param optimizer defines the current optimizer
  78010. * @returns true if everything that can be done was applied
  78011. */
  78012. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  78013. }
  78014. /**
  78015. * Defines an optimization used to increase or decrease the rendering resolution
  78016. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78017. */
  78018. export class HardwareScalingOptimization extends SceneOptimization {
  78019. /**
  78020. * Defines the priority of this optimization (0 by default which means first in the list)
  78021. */
  78022. priority: number;
  78023. /**
  78024. * Defines the maximum scale to use (2 by default)
  78025. */
  78026. maximumScale: number;
  78027. /**
  78028. * Defines the step to use between two passes (0.5 by default)
  78029. */
  78030. step: number;
  78031. private _currentScale;
  78032. private _directionOffset;
  78033. /**
  78034. * Gets a string describing the action executed by the current optimization
  78035. * @return description string
  78036. */
  78037. getDescription(): string;
  78038. /**
  78039. * Creates the HardwareScalingOptimization object
  78040. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  78041. * @param maximumScale defines the maximum scale to use (2 by default)
  78042. * @param step defines the step to use between two passes (0.5 by default)
  78043. */
  78044. constructor(
  78045. /**
  78046. * Defines the priority of this optimization (0 by default which means first in the list)
  78047. */
  78048. priority?: number,
  78049. /**
  78050. * Defines the maximum scale to use (2 by default)
  78051. */
  78052. maximumScale?: number,
  78053. /**
  78054. * Defines the step to use between two passes (0.5 by default)
  78055. */
  78056. step?: number);
  78057. /**
  78058. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78059. * @param scene defines the current scene where to apply this optimization
  78060. * @param optimizer defines the current optimizer
  78061. * @returns true if everything that can be done was applied
  78062. */
  78063. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  78064. }
  78065. /**
  78066. * Defines an optimization used to remove shadows
  78067. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78068. */
  78069. export class ShadowsOptimization extends SceneOptimization {
  78070. /**
  78071. * Gets a string describing the action executed by the current optimization
  78072. * @return description string
  78073. */
  78074. getDescription(): string;
  78075. /**
  78076. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78077. * @param scene defines the current scene where to apply this optimization
  78078. * @param optimizer defines the current optimizer
  78079. * @returns true if everything that can be done was applied
  78080. */
  78081. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  78082. }
  78083. /**
  78084. * Defines an optimization used to turn post-processes off
  78085. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78086. */
  78087. export class PostProcessesOptimization extends SceneOptimization {
  78088. /**
  78089. * Gets a string describing the action executed by the current optimization
  78090. * @return description string
  78091. */
  78092. getDescription(): string;
  78093. /**
  78094. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78095. * @param scene defines the current scene where to apply this optimization
  78096. * @param optimizer defines the current optimizer
  78097. * @returns true if everything that can be done was applied
  78098. */
  78099. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  78100. }
  78101. /**
  78102. * Defines an optimization used to turn lens flares off
  78103. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78104. */
  78105. export class LensFlaresOptimization extends SceneOptimization {
  78106. /**
  78107. * Gets a string describing the action executed by the current optimization
  78108. * @return description string
  78109. */
  78110. getDescription(): string;
  78111. /**
  78112. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78113. * @param scene defines the current scene where to apply this optimization
  78114. * @param optimizer defines the current optimizer
  78115. * @returns true if everything that can be done was applied
  78116. */
  78117. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  78118. }
  78119. /**
  78120. * Defines an optimization based on user defined callback.
  78121. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78122. */
  78123. export class CustomOptimization extends SceneOptimization {
  78124. /**
  78125. * Callback called to apply the custom optimization.
  78126. */
  78127. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  78128. /**
  78129. * Callback called to get custom description
  78130. */
  78131. onGetDescription: () => string;
  78132. /**
  78133. * Gets a string describing the action executed by the current optimization
  78134. * @returns description string
  78135. */
  78136. getDescription(): string;
  78137. /**
  78138. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78139. * @param scene defines the current scene where to apply this optimization
  78140. * @param optimizer defines the current optimizer
  78141. * @returns true if everything that can be done was applied
  78142. */
  78143. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  78144. }
  78145. /**
  78146. * Defines an optimization used to turn particles off
  78147. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78148. */
  78149. export class ParticlesOptimization extends SceneOptimization {
  78150. /**
  78151. * Gets a string describing the action executed by the current optimization
  78152. * @return description string
  78153. */
  78154. getDescription(): string;
  78155. /**
  78156. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78157. * @param scene defines the current scene where to apply this optimization
  78158. * @param optimizer defines the current optimizer
  78159. * @returns true if everything that can be done was applied
  78160. */
  78161. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  78162. }
  78163. /**
  78164. * Defines an optimization used to turn render targets off
  78165. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78166. */
  78167. export class RenderTargetsOptimization extends SceneOptimization {
  78168. /**
  78169. * Gets a string describing the action executed by the current optimization
  78170. * @return description string
  78171. */
  78172. getDescription(): string;
  78173. /**
  78174. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78175. * @param scene defines the current scene where to apply this optimization
  78176. * @param optimizer defines the current optimizer
  78177. * @returns true if everything that can be done was applied
  78178. */
  78179. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  78180. }
  78181. /**
  78182. * Defines an optimization used to merge meshes with compatible materials
  78183. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78184. */
  78185. export class MergeMeshesOptimization extends SceneOptimization {
  78186. private static _UpdateSelectionTree;
  78187. /**
  78188. * Gets or sets a boolean which defines if optimization octree has to be updated
  78189. */
  78190. static get UpdateSelectionTree(): boolean;
  78191. /**
  78192. * Gets or sets a boolean which defines if optimization octree has to be updated
  78193. */
  78194. static set UpdateSelectionTree(value: boolean);
  78195. /**
  78196. * Gets a string describing the action executed by the current optimization
  78197. * @return description string
  78198. */
  78199. getDescription(): string;
  78200. private _canBeMerged;
  78201. /**
  78202. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  78203. * @param scene defines the current scene where to apply this optimization
  78204. * @param optimizer defines the current optimizer
  78205. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  78206. * @returns true if everything that can be done was applied
  78207. */
  78208. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  78209. }
  78210. /**
  78211. * Defines a list of options used by SceneOptimizer
  78212. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78213. */
  78214. export class SceneOptimizerOptions {
  78215. /**
  78216. * Defines the target frame rate to reach (60 by default)
  78217. */
  78218. targetFrameRate: number;
  78219. /**
  78220. * Defines the interval between two checkes (2000ms by default)
  78221. */
  78222. trackerDuration: number;
  78223. /**
  78224. * Gets the list of optimizations to apply
  78225. */
  78226. optimizations: SceneOptimization[];
  78227. /**
  78228. * Creates a new list of options used by SceneOptimizer
  78229. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  78230. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  78231. */
  78232. constructor(
  78233. /**
  78234. * Defines the target frame rate to reach (60 by default)
  78235. */
  78236. targetFrameRate?: number,
  78237. /**
  78238. * Defines the interval between two checkes (2000ms by default)
  78239. */
  78240. trackerDuration?: number);
  78241. /**
  78242. * Add a new optimization
  78243. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  78244. * @returns the current SceneOptimizerOptions
  78245. */
  78246. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  78247. /**
  78248. * Add a new custom optimization
  78249. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  78250. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  78251. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  78252. * @returns the current SceneOptimizerOptions
  78253. */
  78254. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  78255. /**
  78256. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  78257. * @param targetFrameRate defines the target frame rate (60 by default)
  78258. * @returns a SceneOptimizerOptions object
  78259. */
  78260. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  78261. /**
  78262. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  78263. * @param targetFrameRate defines the target frame rate (60 by default)
  78264. * @returns a SceneOptimizerOptions object
  78265. */
  78266. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  78267. /**
  78268. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  78269. * @param targetFrameRate defines the target frame rate (60 by default)
  78270. * @returns a SceneOptimizerOptions object
  78271. */
  78272. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  78273. }
  78274. /**
  78275. * Class used to run optimizations in order to reach a target frame rate
  78276. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  78277. */
  78278. export class SceneOptimizer implements IDisposable {
  78279. private _isRunning;
  78280. private _options;
  78281. private _scene;
  78282. private _currentPriorityLevel;
  78283. private _targetFrameRate;
  78284. private _trackerDuration;
  78285. private _currentFrameRate;
  78286. private _sceneDisposeObserver;
  78287. private _improvementMode;
  78288. /**
  78289. * Defines an observable called when the optimizer reaches the target frame rate
  78290. */
  78291. onSuccessObservable: Observable<SceneOptimizer>;
  78292. /**
  78293. * Defines an observable called when the optimizer enables an optimization
  78294. */
  78295. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  78296. /**
  78297. * Defines an observable called when the optimizer is not able to reach the target frame rate
  78298. */
  78299. onFailureObservable: Observable<SceneOptimizer>;
  78300. /**
  78301. * Gets a boolean indicating if the optimizer is in improvement mode
  78302. */
  78303. get isInImprovementMode(): boolean;
  78304. /**
  78305. * Gets the current priority level (0 at start)
  78306. */
  78307. get currentPriorityLevel(): number;
  78308. /**
  78309. * Gets the current frame rate checked by the SceneOptimizer
  78310. */
  78311. get currentFrameRate(): number;
  78312. /**
  78313. * Gets or sets the current target frame rate (60 by default)
  78314. */
  78315. get targetFrameRate(): number;
  78316. /**
  78317. * Gets or sets the current target frame rate (60 by default)
  78318. */
  78319. set targetFrameRate(value: number);
  78320. /**
  78321. * Gets or sets the current interval between two checks (every 2000ms by default)
  78322. */
  78323. get trackerDuration(): number;
  78324. /**
  78325. * Gets or sets the current interval between two checks (every 2000ms by default)
  78326. */
  78327. set trackerDuration(value: number);
  78328. /**
  78329. * Gets the list of active optimizations
  78330. */
  78331. get optimizations(): SceneOptimization[];
  78332. /**
  78333. * Creates a new SceneOptimizer
  78334. * @param scene defines the scene to work on
  78335. * @param options defines the options to use with the SceneOptimizer
  78336. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  78337. * @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)
  78338. */
  78339. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  78340. /**
  78341. * Stops the current optimizer
  78342. */
  78343. stop(): void;
  78344. /**
  78345. * Reset the optimizer to initial step (current priority level = 0)
  78346. */
  78347. reset(): void;
  78348. /**
  78349. * Start the optimizer. By default it will try to reach a specific framerate
  78350. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  78351. */
  78352. start(): void;
  78353. private _checkCurrentState;
  78354. /**
  78355. * Release all resources
  78356. */
  78357. dispose(): void;
  78358. /**
  78359. * Helper function to create a SceneOptimizer with one single line of code
  78360. * @param scene defines the scene to work on
  78361. * @param options defines the options to use with the SceneOptimizer
  78362. * @param onSuccess defines a callback to call on success
  78363. * @param onFailure defines a callback to call on failure
  78364. * @returns the new SceneOptimizer object
  78365. */
  78366. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  78367. }
  78368. }
  78369. declare module "babylonjs/Misc/sceneSerializer" {
  78370. import { Scene } from "babylonjs/scene";
  78371. /**
  78372. * Class used to serialize a scene into a string
  78373. */
  78374. export class SceneSerializer {
  78375. /**
  78376. * Clear cache used by a previous serialization
  78377. */
  78378. static ClearCache(): void;
  78379. /**
  78380. * Serialize a scene into a JSON compatible object
  78381. * @param scene defines the scene to serialize
  78382. * @returns a JSON compatible object
  78383. */
  78384. static Serialize(scene: Scene): any;
  78385. /**
  78386. * Serialize a mesh into a JSON compatible object
  78387. * @param toSerialize defines the mesh to serialize
  78388. * @param withParents defines if parents must be serialized as well
  78389. * @param withChildren defines if children must be serialized as well
  78390. * @returns a JSON compatible object
  78391. */
  78392. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  78393. }
  78394. }
  78395. declare module "babylonjs/Misc/textureTools" {
  78396. import { Texture } from "babylonjs/Materials/Textures/texture";
  78397. /**
  78398. * Class used to host texture specific utilities
  78399. */
  78400. export class TextureTools {
  78401. /**
  78402. * Uses the GPU to create a copy texture rescaled at a given size
  78403. * @param texture Texture to copy from
  78404. * @param width defines the desired width
  78405. * @param height defines the desired height
  78406. * @param useBilinearMode defines if bilinear mode has to be used
  78407. * @return the generated texture
  78408. */
  78409. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  78410. }
  78411. }
  78412. declare module "babylonjs/Misc/videoRecorder" {
  78413. import { Nullable } from "babylonjs/types";
  78414. import { Engine } from "babylonjs/Engines/engine";
  78415. /**
  78416. * This represents the different options available for the video capture.
  78417. */
  78418. export interface VideoRecorderOptions {
  78419. /** Defines the mime type of the video. */
  78420. mimeType: string;
  78421. /** Defines the FPS the video should be recorded at. */
  78422. fps: number;
  78423. /** Defines the chunk size for the recording data. */
  78424. recordChunckSize: number;
  78425. /** The audio tracks to attach to the recording. */
  78426. audioTracks?: MediaStreamTrack[];
  78427. }
  78428. /**
  78429. * This can help with recording videos from BabylonJS.
  78430. * This is based on the available WebRTC functionalities of the browser.
  78431. *
  78432. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  78433. */
  78434. export class VideoRecorder {
  78435. private static readonly _defaultOptions;
  78436. /**
  78437. * Returns whether or not the VideoRecorder is available in your browser.
  78438. * @param engine Defines the Babylon Engine.
  78439. * @returns true if supported otherwise false.
  78440. */
  78441. static IsSupported(engine: Engine): boolean;
  78442. private readonly _options;
  78443. private _canvas;
  78444. private _mediaRecorder;
  78445. private _recordedChunks;
  78446. private _fileName;
  78447. private _resolve;
  78448. private _reject;
  78449. /**
  78450. * True when a recording is already in progress.
  78451. */
  78452. get isRecording(): boolean;
  78453. /**
  78454. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  78455. * @param engine Defines the BabylonJS Engine you wish to record.
  78456. * @param options Defines options that can be used to customize the capture.
  78457. */
  78458. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  78459. /**
  78460. * Stops the current recording before the default capture timeout passed in the startRecording function.
  78461. */
  78462. stopRecording(): void;
  78463. /**
  78464. * Starts recording the canvas for a max duration specified in parameters.
  78465. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  78466. * If null no automatic download will start and you can rely on the promise to get the data back.
  78467. * @param maxDuration Defines the maximum recording time in seconds.
  78468. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  78469. * @return A promise callback at the end of the recording with the video data in Blob.
  78470. */
  78471. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  78472. /**
  78473. * Releases internal resources used during the recording.
  78474. */
  78475. dispose(): void;
  78476. private _handleDataAvailable;
  78477. private _handleError;
  78478. private _handleStop;
  78479. }
  78480. }
  78481. declare module "babylonjs/Misc/screenshotTools" {
  78482. import { Camera } from "babylonjs/Cameras/camera";
  78483. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  78484. import { Engine } from "babylonjs/Engines/engine";
  78485. /**
  78486. * Class containing a set of static utilities functions for screenshots
  78487. */
  78488. export class ScreenshotTools {
  78489. /**
  78490. * Captures a screenshot of the current rendering
  78491. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78492. * @param engine defines the rendering engine
  78493. * @param camera defines the source camera
  78494. * @param size This parameter can be set to a single number or to an object with the
  78495. * following (optional) properties: precision, width, height. If a single number is passed,
  78496. * it will be used for both width and height. If an object is passed, the screenshot size
  78497. * will be derived from the parameters. The precision property is a multiplier allowing
  78498. * rendering at a higher or lower resolution
  78499. * @param successCallback defines the callback receives a single parameter which contains the
  78500. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  78501. * src parameter of an <img> to display it
  78502. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  78503. * Check your browser for supported MIME types
  78504. */
  78505. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  78506. /**
  78507. * Captures a screenshot of the current rendering
  78508. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78509. * @param engine defines the rendering engine
  78510. * @param camera defines the source camera
  78511. * @param size This parameter can be set to a single number or to an object with the
  78512. * following (optional) properties: precision, width, height. If a single number is passed,
  78513. * it will be used for both width and height. If an object is passed, the screenshot size
  78514. * will be derived from the parameters. The precision property is a multiplier allowing
  78515. * rendering at a higher or lower resolution
  78516. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  78517. * Check your browser for supported MIME types
  78518. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  78519. * to the src parameter of an <img> to display it
  78520. */
  78521. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  78522. /**
  78523. * Generates an image screenshot from the specified camera.
  78524. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78525. * @param engine The engine to use for rendering
  78526. * @param camera The camera to use for rendering
  78527. * @param size This parameter can be set to a single number or to an object with the
  78528. * following (optional) properties: precision, width, height. If a single number is passed,
  78529. * it will be used for both width and height. If an object is passed, the screenshot size
  78530. * will be derived from the parameters. The precision property is a multiplier allowing
  78531. * rendering at a higher or lower resolution
  78532. * @param successCallback The callback receives a single parameter which contains the
  78533. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  78534. * src parameter of an <img> to display it
  78535. * @param mimeType The MIME type of the screenshot image (default: image/png).
  78536. * Check your browser for supported MIME types
  78537. * @param samples Texture samples (default: 1)
  78538. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  78539. * @param fileName A name for for the downloaded file.
  78540. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  78541. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  78542. */
  78543. 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;
  78544. /**
  78545. * Generates an image screenshot from the specified camera.
  78546. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78547. * @param engine The engine to use for rendering
  78548. * @param camera The camera to use for rendering
  78549. * @param size This parameter can be set to a single number or to an object with the
  78550. * following (optional) properties: precision, width, height. If a single number is passed,
  78551. * it will be used for both width and height. If an object is passed, the screenshot size
  78552. * will be derived from the parameters. The precision property is a multiplier allowing
  78553. * rendering at a higher or lower resolution
  78554. * @param mimeType The MIME type of the screenshot image (default: image/png).
  78555. * Check your browser for supported MIME types
  78556. * @param samples Texture samples (default: 1)
  78557. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  78558. * @param fileName A name for for the downloaded file.
  78559. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  78560. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  78561. * to the src parameter of an <img> to display it
  78562. */
  78563. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  78564. /**
  78565. * Gets height and width for screenshot size
  78566. * @private
  78567. */
  78568. private static _getScreenshotSize;
  78569. }
  78570. }
  78571. declare module "babylonjs/Misc/dataReader" {
  78572. /**
  78573. * Interface for a data buffer
  78574. */
  78575. export interface IDataBuffer {
  78576. /**
  78577. * Reads bytes from the data buffer.
  78578. * @param byteOffset The byte offset to read
  78579. * @param byteLength The byte length to read
  78580. * @returns A promise that resolves when the bytes are read
  78581. */
  78582. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  78583. /**
  78584. * The byte length of the buffer.
  78585. */
  78586. readonly byteLength: number;
  78587. }
  78588. /**
  78589. * Utility class for reading from a data buffer
  78590. */
  78591. export class DataReader {
  78592. /**
  78593. * The data buffer associated with this data reader.
  78594. */
  78595. readonly buffer: IDataBuffer;
  78596. /**
  78597. * The current byte offset from the beginning of the data buffer.
  78598. */
  78599. byteOffset: number;
  78600. private _dataView;
  78601. private _dataByteOffset;
  78602. /**
  78603. * Constructor
  78604. * @param buffer The buffer to read
  78605. */
  78606. constructor(buffer: IDataBuffer);
  78607. /**
  78608. * Loads the given byte length.
  78609. * @param byteLength The byte length to load
  78610. * @returns A promise that resolves when the load is complete
  78611. */
  78612. loadAsync(byteLength: number): Promise<void>;
  78613. /**
  78614. * Read a unsigned 32-bit integer from the currently loaded data range.
  78615. * @returns The 32-bit integer read
  78616. */
  78617. readUint32(): number;
  78618. /**
  78619. * Read a byte array from the currently loaded data range.
  78620. * @param byteLength The byte length to read
  78621. * @returns The byte array read
  78622. */
  78623. readUint8Array(byteLength: number): Uint8Array;
  78624. /**
  78625. * Read a string from the currently loaded data range.
  78626. * @param byteLength The byte length to read
  78627. * @returns The string read
  78628. */
  78629. readString(byteLength: number): string;
  78630. /**
  78631. * Skips the given byte length the currently loaded data range.
  78632. * @param byteLength The byte length to skip
  78633. */
  78634. skipBytes(byteLength: number): void;
  78635. }
  78636. }
  78637. declare module "babylonjs/Misc/dataStorage" {
  78638. /**
  78639. * Class for storing data to local storage if available or in-memory storage otherwise
  78640. */
  78641. export class DataStorage {
  78642. private static _Storage;
  78643. private static _GetStorage;
  78644. /**
  78645. * Reads a string from the data storage
  78646. * @param key The key to read
  78647. * @param defaultValue The value if the key doesn't exist
  78648. * @returns The string value
  78649. */
  78650. static ReadString(key: string, defaultValue: string): string;
  78651. /**
  78652. * Writes a string to the data storage
  78653. * @param key The key to write
  78654. * @param value The value to write
  78655. */
  78656. static WriteString(key: string, value: string): void;
  78657. /**
  78658. * Reads a boolean from the data storage
  78659. * @param key The key to read
  78660. * @param defaultValue The value if the key doesn't exist
  78661. * @returns The boolean value
  78662. */
  78663. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  78664. /**
  78665. * Writes a boolean to the data storage
  78666. * @param key The key to write
  78667. * @param value The value to write
  78668. */
  78669. static WriteBoolean(key: string, value: boolean): void;
  78670. /**
  78671. * Reads a number from the data storage
  78672. * @param key The key to read
  78673. * @param defaultValue The value if the key doesn't exist
  78674. * @returns The number value
  78675. */
  78676. static ReadNumber(key: string, defaultValue: number): number;
  78677. /**
  78678. * Writes a number to the data storage
  78679. * @param key The key to write
  78680. * @param value The value to write
  78681. */
  78682. static WriteNumber(key: string, value: number): void;
  78683. }
  78684. }
  78685. declare module "babylonjs/Misc/sceneRecorder" {
  78686. import { Scene } from "babylonjs/scene";
  78687. /**
  78688. * Class used to record delta files between 2 scene states
  78689. */
  78690. export class SceneRecorder {
  78691. private _trackedScene;
  78692. private _savedJSON;
  78693. /**
  78694. * Track a given scene. This means the current scene state will be considered the original state
  78695. * @param scene defines the scene to track
  78696. */
  78697. track(scene: Scene): void;
  78698. /**
  78699. * Get the delta between current state and original state
  78700. * @returns a string containing the delta
  78701. */
  78702. getDelta(): any;
  78703. private _compareArray;
  78704. private _compareObjects;
  78705. private _compareCollections;
  78706. private static GetShadowGeneratorById;
  78707. /**
  78708. * Apply a given delta to a given scene
  78709. * @param deltaJSON defines the JSON containing the delta
  78710. * @param scene defines the scene to apply the delta to
  78711. */
  78712. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  78713. private static _ApplyPropertiesToEntity;
  78714. private static _ApplyDeltaForEntity;
  78715. }
  78716. }
  78717. declare module "babylonjs/Misc/trajectoryClassifier" {
  78718. import { DeepImmutable, Nullable } from "babylonjs/types";
  78719. import { Vector3 } from "babylonjs/Maths/math.vector";
  78720. /**
  78721. * A 3D trajectory consisting of an order list of vectors describing a
  78722. * path of motion through 3D space.
  78723. */
  78724. export class Trajectory {
  78725. private _points;
  78726. private readonly _segmentLength;
  78727. /**
  78728. * Serialize to JSON.
  78729. * @returns serialized JSON string
  78730. */
  78731. serialize(): string;
  78732. /**
  78733. * Deserialize from JSON.
  78734. * @param json serialized JSON string
  78735. * @returns deserialized Trajectory
  78736. */
  78737. static Deserialize(json: string): Trajectory;
  78738. /**
  78739. * Create a new empty Trajectory.
  78740. * @param segmentLength radius of discretization for Trajectory points
  78741. */
  78742. constructor(segmentLength?: number);
  78743. /**
  78744. * Get the length of the Trajectory.
  78745. * @returns length of the Trajectory
  78746. */
  78747. getLength(): number;
  78748. /**
  78749. * Append a new point to the Trajectory.
  78750. * NOTE: This implementation has many allocations.
  78751. * @param point point to append to the Trajectory
  78752. */
  78753. add(point: DeepImmutable<Vector3>): void;
  78754. /**
  78755. * Create a new Trajectory with a segment length chosen to make it
  78756. * probable that the new Trajectory will have a specified number of
  78757. * segments. This operation is imprecise.
  78758. * @param targetResolution number of segments desired
  78759. * @returns new Trajectory with approximately the requested number of segments
  78760. */
  78761. resampleAtTargetResolution(targetResolution: number): Trajectory;
  78762. /**
  78763. * Convert Trajectory segments into tokenized representation. This
  78764. * representation is an array of numbers where each nth number is the
  78765. * index of the token which is most similar to the nth segment of the
  78766. * Trajectory.
  78767. * @param tokens list of vectors which serve as discrete tokens
  78768. * @returns list of indices of most similar token per segment
  78769. */
  78770. tokenize(tokens: DeepImmutable<Vector3[]>): number[];
  78771. private static _forwardDir;
  78772. private static _inverseFromVec;
  78773. private static _upDir;
  78774. private static _fromToVec;
  78775. private static _lookMatrix;
  78776. /**
  78777. * Transform the rotation (i.e., direction) of a segment to isolate
  78778. * the relative transformation represented by the segment. This operation
  78779. * may or may not succeed due to singularities in the equations that define
  78780. * motion relativity in this context.
  78781. * @param priorVec the origin of the prior segment
  78782. * @param fromVec the origin of the current segment
  78783. * @param toVec the destination of the current segment
  78784. * @param result reference to output variable
  78785. * @returns whether or not transformation was successful
  78786. */
  78787. private static _transformSegmentDirToRef;
  78788. private static _bestMatch;
  78789. private static _score;
  78790. private static _bestScore;
  78791. /**
  78792. * Determine which token vector is most similar to the
  78793. * segment vector.
  78794. * @param segment segment vector
  78795. * @param tokens token vector list
  78796. * @returns index of the most similar token to the segment
  78797. */
  78798. private static _tokenizeSegment;
  78799. }
  78800. /**
  78801. * Class representing a set of known, named trajectories to which Trajectories can be
  78802. * added and using which Trajectories can be recognized.
  78803. */
  78804. export class TrajectoryClassifier {
  78805. private _maximumAllowableMatchCost;
  78806. private _vector3Alphabet;
  78807. private _levenshteinAlphabet;
  78808. private _nameToDescribedTrajectory;
  78809. /**
  78810. * Serialize to JSON.
  78811. * @returns JSON serialization
  78812. */
  78813. serialize(): string;
  78814. /**
  78815. * Deserialize from JSON.
  78816. * @param json JSON serialization
  78817. * @returns deserialized TrajectorySet
  78818. */
  78819. static Deserialize(json: string): TrajectoryClassifier;
  78820. /**
  78821. * Initialize a new empty TrajectorySet with auto-generated Alphabets.
  78822. * VERY naive, need to be generating these things from known
  78823. * sets. Better version later, probably eliminating this one.
  78824. * @returns auto-generated TrajectorySet
  78825. */
  78826. static Generate(): TrajectoryClassifier;
  78827. private constructor();
  78828. /**
  78829. * Add a new Trajectory to the set with a given name.
  78830. * @param trajectory new Trajectory to be added
  78831. * @param classification name to which to add the Trajectory
  78832. */
  78833. addTrajectoryToClassification(trajectory: Trajectory, classification: string): void;
  78834. /**
  78835. * Remove a known named trajectory and all Trajectories associated with it.
  78836. * @param classification name to remove
  78837. * @returns whether anything was removed
  78838. */
  78839. deleteClassification(classification: string): boolean;
  78840. /**
  78841. * Attempt to recognize a Trajectory from among all the classifications
  78842. * already known to the classifier.
  78843. * @param trajectory Trajectory to be recognized
  78844. * @returns classification of Trajectory if recognized, null otherwise
  78845. */
  78846. classifyTrajectory(trajectory: Trajectory): Nullable<string>;
  78847. }
  78848. }
  78849. declare module "babylonjs/Misc/index" {
  78850. export * from "babylonjs/Misc/andOrNotEvaluator";
  78851. export * from "babylonjs/Misc/assetsManager";
  78852. export * from "babylonjs/Misc/basis";
  78853. export * from "babylonjs/Misc/dds";
  78854. export * from "babylonjs/Misc/decorators";
  78855. export * from "babylonjs/Misc/deferred";
  78856. export * from "babylonjs/Misc/environmentTextureTools";
  78857. export * from "babylonjs/Misc/meshExploder";
  78858. export * from "babylonjs/Misc/filesInput";
  78859. export * from "babylonjs/Misc/HighDynamicRange/index";
  78860. export * from "babylonjs/Misc/khronosTextureContainer";
  78861. export * from "babylonjs/Misc/observable";
  78862. export * from "babylonjs/Misc/performanceMonitor";
  78863. export * from "babylonjs/Misc/promise";
  78864. export * from "babylonjs/Misc/sceneOptimizer";
  78865. export * from "babylonjs/Misc/sceneSerializer";
  78866. export * from "babylonjs/Misc/smartArray";
  78867. export * from "babylonjs/Misc/stringDictionary";
  78868. export * from "babylonjs/Misc/tags";
  78869. export * from "babylonjs/Misc/textureTools";
  78870. export * from "babylonjs/Misc/tga";
  78871. export * from "babylonjs/Misc/tools";
  78872. export * from "babylonjs/Misc/videoRecorder";
  78873. export * from "babylonjs/Misc/virtualJoystick";
  78874. export * from "babylonjs/Misc/workerPool";
  78875. export * from "babylonjs/Misc/logger";
  78876. export * from "babylonjs/Misc/typeStore";
  78877. export * from "babylonjs/Misc/filesInputStore";
  78878. export * from "babylonjs/Misc/deepCopier";
  78879. export * from "babylonjs/Misc/pivotTools";
  78880. export * from "babylonjs/Misc/precisionDate";
  78881. export * from "babylonjs/Misc/screenshotTools";
  78882. export * from "babylonjs/Misc/typeStore";
  78883. export * from "babylonjs/Misc/webRequest";
  78884. export * from "babylonjs/Misc/iInspectable";
  78885. export * from "babylonjs/Misc/brdfTextureTools";
  78886. export * from "babylonjs/Misc/rgbdTextureTools";
  78887. export * from "babylonjs/Misc/gradients";
  78888. export * from "babylonjs/Misc/perfCounter";
  78889. export * from "babylonjs/Misc/fileRequest";
  78890. export * from "babylonjs/Misc/customAnimationFrameRequester";
  78891. export * from "babylonjs/Misc/retryStrategy";
  78892. export * from "babylonjs/Misc/interfaces/screenshotSize";
  78893. export * from "babylonjs/Misc/canvasGenerator";
  78894. export * from "babylonjs/Misc/fileTools";
  78895. export * from "babylonjs/Misc/stringTools";
  78896. export * from "babylonjs/Misc/dataReader";
  78897. export * from "babylonjs/Misc/minMaxReducer";
  78898. export * from "babylonjs/Misc/depthReducer";
  78899. export * from "babylonjs/Misc/dataStorage";
  78900. export * from "babylonjs/Misc/sceneRecorder";
  78901. export * from "babylonjs/Misc/khronosTextureContainer2";
  78902. export * from "babylonjs/Misc/trajectoryClassifier";
  78903. }
  78904. declare module "babylonjs/XR/features/WebXRHitTestLegacy" {
  78905. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  78906. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78907. import { Observable } from "babylonjs/Misc/observable";
  78908. import { Matrix } from "babylonjs/Maths/math.vector";
  78909. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78910. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78911. /**
  78912. * An interface for all Hit test features
  78913. */
  78914. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  78915. /**
  78916. * Triggered when new babylon (transformed) hit test results are available
  78917. */
  78918. onHitTestResultObservable: Observable<T[]>;
  78919. }
  78920. /**
  78921. * Options used for hit testing
  78922. */
  78923. export interface IWebXRLegacyHitTestOptions {
  78924. /**
  78925. * Only test when user interacted with the scene. Default - hit test every frame
  78926. */
  78927. testOnPointerDownOnly?: boolean;
  78928. /**
  78929. * The node to use to transform the local results to world coordinates
  78930. */
  78931. worldParentNode?: TransformNode;
  78932. }
  78933. /**
  78934. * Interface defining the babylon result of raycasting/hit-test
  78935. */
  78936. export interface IWebXRLegacyHitResult {
  78937. /**
  78938. * Transformation matrix that can be applied to a node that will put it in the hit point location
  78939. */
  78940. transformationMatrix: Matrix;
  78941. /**
  78942. * The native hit test result
  78943. */
  78944. xrHitResult: XRHitResult | XRHitTestResult;
  78945. }
  78946. /**
  78947. * The currently-working hit-test module.
  78948. * Hit test (or Ray-casting) is used to interact with the real world.
  78949. * For further information read here - https://github.com/immersive-web/hit-test
  78950. */
  78951. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  78952. /**
  78953. * options to use when constructing this feature
  78954. */
  78955. readonly options: IWebXRLegacyHitTestOptions;
  78956. private _direction;
  78957. private _mat;
  78958. private _onSelectEnabled;
  78959. private _origin;
  78960. /**
  78961. * The module's name
  78962. */
  78963. static readonly Name: string;
  78964. /**
  78965. * The (Babylon) version of this module.
  78966. * This is an integer representing the implementation version.
  78967. * This number does not correspond to the WebXR specs version
  78968. */
  78969. static readonly Version: number;
  78970. /**
  78971. * Populated with the last native XR Hit Results
  78972. */
  78973. lastNativeXRHitResults: XRHitResult[];
  78974. /**
  78975. * Triggered when new babylon (transformed) hit test results are available
  78976. */
  78977. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  78978. /**
  78979. * Creates a new instance of the (legacy version) hit test feature
  78980. * @param _xrSessionManager an instance of WebXRSessionManager
  78981. * @param options options to use when constructing this feature
  78982. */
  78983. constructor(_xrSessionManager: WebXRSessionManager,
  78984. /**
  78985. * options to use when constructing this feature
  78986. */
  78987. options?: IWebXRLegacyHitTestOptions);
  78988. /**
  78989. * execute a hit test with an XR Ray
  78990. *
  78991. * @param xrSession a native xrSession that will execute this hit test
  78992. * @param xrRay the ray (position and direction) to use for ray-casting
  78993. * @param referenceSpace native XR reference space to use for the hit-test
  78994. * @param filter filter function that will filter the results
  78995. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  78996. */
  78997. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  78998. /**
  78999. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  79000. * @param event the (select) event to use to select with
  79001. * @param referenceSpace the reference space to use for this hit test
  79002. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  79003. */
  79004. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  79005. /**
  79006. * attach this feature
  79007. * Will usually be called by the features manager
  79008. *
  79009. * @returns true if successful.
  79010. */
  79011. attach(): boolean;
  79012. /**
  79013. * detach this feature.
  79014. * Will usually be called by the features manager
  79015. *
  79016. * @returns true if successful.
  79017. */
  79018. detach(): boolean;
  79019. /**
  79020. * Dispose this feature and all of the resources attached
  79021. */
  79022. dispose(): void;
  79023. protected _onXRFrame(frame: XRFrame): void;
  79024. private _onHitTestResults;
  79025. private _onSelect;
  79026. }
  79027. }
  79028. declare module "babylonjs/XR/features/WebXRHitTest" {
  79029. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79030. import { Observable } from "babylonjs/Misc/observable";
  79031. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  79032. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79033. import { IWebXRLegacyHitTestOptions, IWebXRLegacyHitResult, IWebXRHitTestFeature } from "babylonjs/XR/features/WebXRHitTestLegacy";
  79034. /**
  79035. * Options used for hit testing (version 2)
  79036. */
  79037. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  79038. /**
  79039. * Do not create a permanent hit test. Will usually be used when only
  79040. * transient inputs are needed.
  79041. */
  79042. disablePermanentHitTest?: boolean;
  79043. /**
  79044. * Enable transient (for example touch-based) hit test inspections
  79045. */
  79046. enableTransientHitTest?: boolean;
  79047. /**
  79048. * Offset ray for the permanent hit test
  79049. */
  79050. offsetRay?: Vector3;
  79051. /**
  79052. * Offset ray for the transient hit test
  79053. */
  79054. transientOffsetRay?: Vector3;
  79055. /**
  79056. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  79057. */
  79058. useReferenceSpace?: boolean;
  79059. /**
  79060. * Override the default entity type(s) of the hit-test result
  79061. */
  79062. entityTypes?: XRHitTestTrackableType[];
  79063. }
  79064. /**
  79065. * Interface defining the babylon result of hit-test
  79066. */
  79067. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  79068. /**
  79069. * The input source that generated this hit test (if transient)
  79070. */
  79071. inputSource?: XRInputSource;
  79072. /**
  79073. * Is this a transient hit test
  79074. */
  79075. isTransient?: boolean;
  79076. /**
  79077. * Position of the hit test result
  79078. */
  79079. position: Vector3;
  79080. /**
  79081. * Rotation of the hit test result
  79082. */
  79083. rotationQuaternion: Quaternion;
  79084. /**
  79085. * The native hit test result
  79086. */
  79087. xrHitResult: XRHitTestResult;
  79088. }
  79089. /**
  79090. * The currently-working hit-test module.
  79091. * Hit test (or Ray-casting) is used to interact with the real world.
  79092. * For further information read here - https://github.com/immersive-web/hit-test
  79093. *
  79094. * Tested on chrome (mobile) 80.
  79095. */
  79096. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  79097. /**
  79098. * options to use when constructing this feature
  79099. */
  79100. readonly options: IWebXRHitTestOptions;
  79101. private _tmpMat;
  79102. private _tmpPos;
  79103. private _tmpQuat;
  79104. private _transientXrHitTestSource;
  79105. private _xrHitTestSource;
  79106. private initHitTestSource;
  79107. /**
  79108. * The module's name
  79109. */
  79110. static readonly Name: string;
  79111. /**
  79112. * The (Babylon) version of this module.
  79113. * This is an integer representing the implementation version.
  79114. * This number does not correspond to the WebXR specs version
  79115. */
  79116. static readonly Version: number;
  79117. /**
  79118. * When set to true, each hit test will have its own position/rotation objects
  79119. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  79120. * the developers will clone them or copy them as they see fit.
  79121. */
  79122. autoCloneTransformation: boolean;
  79123. /**
  79124. * Triggered when new babylon (transformed) hit test results are available
  79125. * Note - this will be called when results come back from the device. It can be an empty array!!
  79126. */
  79127. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  79128. /**
  79129. * Use this to temporarily pause hit test checks.
  79130. */
  79131. paused: boolean;
  79132. /**
  79133. * Creates a new instance of the hit test feature
  79134. * @param _xrSessionManager an instance of WebXRSessionManager
  79135. * @param options options to use when constructing this feature
  79136. */
  79137. constructor(_xrSessionManager: WebXRSessionManager,
  79138. /**
  79139. * options to use when constructing this feature
  79140. */
  79141. options?: IWebXRHitTestOptions);
  79142. /**
  79143. * attach this feature
  79144. * Will usually be called by the features manager
  79145. *
  79146. * @returns true if successful.
  79147. */
  79148. attach(): boolean;
  79149. /**
  79150. * detach this feature.
  79151. * Will usually be called by the features manager
  79152. *
  79153. * @returns true if successful.
  79154. */
  79155. detach(): boolean;
  79156. /**
  79157. * Dispose this feature and all of the resources attached
  79158. */
  79159. dispose(): void;
  79160. protected _onXRFrame(frame: XRFrame): void;
  79161. private _processWebXRHitTestResult;
  79162. }
  79163. }
  79164. declare module "babylonjs/XR/features/WebXRAnchorSystem" {
  79165. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79166. import { Observable } from "babylonjs/Misc/observable";
  79167. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  79168. import { TransformNode } from "babylonjs/Meshes/transformNode";
  79169. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79170. import { IWebXRHitResult } from "babylonjs/XR/features/WebXRHitTest";
  79171. /**
  79172. * Configuration options of the anchor system
  79173. */
  79174. export interface IWebXRAnchorSystemOptions {
  79175. /**
  79176. * a node that will be used to convert local to world coordinates
  79177. */
  79178. worldParentNode?: TransformNode;
  79179. /**
  79180. * If set to true a reference of the created anchors will be kept until the next session starts
  79181. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  79182. */
  79183. doNotRemoveAnchorsOnSessionEnded?: boolean;
  79184. }
  79185. /**
  79186. * A babylon container for an XR Anchor
  79187. */
  79188. export interface IWebXRAnchor {
  79189. /**
  79190. * A babylon-assigned ID for this anchor
  79191. */
  79192. id: number;
  79193. /**
  79194. * Transformation matrix to apply to an object attached to this anchor
  79195. */
  79196. transformationMatrix: Matrix;
  79197. /**
  79198. * The native anchor object
  79199. */
  79200. xrAnchor: XRAnchor;
  79201. /**
  79202. * if defined, this object will be constantly updated by the anchor's position and rotation
  79203. */
  79204. attachedNode?: TransformNode;
  79205. }
  79206. /**
  79207. * An implementation of the anchor system for WebXR.
  79208. * For further information see https://github.com/immersive-web/anchors/
  79209. */
  79210. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  79211. private _options;
  79212. private _lastFrameDetected;
  79213. private _trackedAnchors;
  79214. private _referenceSpaceForFrameAnchors;
  79215. private _futureAnchors;
  79216. /**
  79217. * The module's name
  79218. */
  79219. static readonly Name: string;
  79220. /**
  79221. * The (Babylon) version of this module.
  79222. * This is an integer representing the implementation version.
  79223. * This number does not correspond to the WebXR specs version
  79224. */
  79225. static readonly Version: number;
  79226. /**
  79227. * Observers registered here will be executed when a new anchor was added to the session
  79228. */
  79229. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  79230. /**
  79231. * Observers registered here will be executed when an anchor was removed from the session
  79232. */
  79233. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  79234. /**
  79235. * Observers registered here will be executed when an existing anchor updates
  79236. * This can execute N times every frame
  79237. */
  79238. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  79239. /**
  79240. * Set the reference space to use for anchor creation, when not using a hit test.
  79241. * Will default to the session's reference space if not defined
  79242. */
  79243. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  79244. /**
  79245. * constructs a new anchor system
  79246. * @param _xrSessionManager an instance of WebXRSessionManager
  79247. * @param _options configuration object for this feature
  79248. */
  79249. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  79250. private _tmpVector;
  79251. private _tmpQuaternion;
  79252. private _populateTmpTransformation;
  79253. /**
  79254. * Create a new anchor point using a hit test result at a specific point in the scene
  79255. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  79256. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  79257. *
  79258. * @param hitTestResult The hit test result to use for this anchor creation
  79259. * @param position an optional position offset for this anchor
  79260. * @param rotationQuaternion an optional rotation offset for this anchor
  79261. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  79262. */
  79263. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  79264. /**
  79265. * Add a new anchor at a specific position and rotation
  79266. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  79267. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  79268. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  79269. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  79270. *
  79271. * @param position the position in which to add an anchor
  79272. * @param rotationQuaternion an optional rotation for the anchor transformation
  79273. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  79274. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  79275. */
  79276. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  79277. /**
  79278. * detach this feature.
  79279. * Will usually be called by the features manager
  79280. *
  79281. * @returns true if successful.
  79282. */
  79283. detach(): boolean;
  79284. /**
  79285. * Dispose this feature and all of the resources attached
  79286. */
  79287. dispose(): void;
  79288. protected _onXRFrame(frame: XRFrame): void;
  79289. /**
  79290. * avoiding using Array.find for global support.
  79291. * @param xrAnchor the plane to find in the array
  79292. */
  79293. private _findIndexInAnchorArray;
  79294. private _updateAnchorWithXRFrame;
  79295. private _createAnchorAtTransformation;
  79296. }
  79297. }
  79298. declare module "babylonjs/XR/features/WebXRPlaneDetector" {
  79299. import { TransformNode } from "babylonjs/Meshes/transformNode";
  79300. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79301. import { Observable } from "babylonjs/Misc/observable";
  79302. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  79303. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79304. /**
  79305. * Options used in the plane detector module
  79306. */
  79307. export interface IWebXRPlaneDetectorOptions {
  79308. /**
  79309. * The node to use to transform the local results to world coordinates
  79310. */
  79311. worldParentNode?: TransformNode;
  79312. /**
  79313. * If set to true a reference of the created planes will be kept until the next session starts
  79314. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  79315. */
  79316. doNotRemovePlanesOnSessionEnded?: boolean;
  79317. }
  79318. /**
  79319. * A babylon interface for a WebXR plane.
  79320. * A Plane is actually a polygon, built from N points in space
  79321. *
  79322. * Supported in chrome 79, not supported in canary 81 ATM
  79323. */
  79324. export interface IWebXRPlane {
  79325. /**
  79326. * a babylon-assigned ID for this polygon
  79327. */
  79328. id: number;
  79329. /**
  79330. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  79331. */
  79332. polygonDefinition: Array<Vector3>;
  79333. /**
  79334. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  79335. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  79336. */
  79337. transformationMatrix: Matrix;
  79338. /**
  79339. * the native xr-plane object
  79340. */
  79341. xrPlane: XRPlane;
  79342. }
  79343. /**
  79344. * The plane detector is used to detect planes in the real world when in AR
  79345. * For more information see https://github.com/immersive-web/real-world-geometry/
  79346. */
  79347. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  79348. private _options;
  79349. private _detectedPlanes;
  79350. private _enabled;
  79351. private _lastFrameDetected;
  79352. /**
  79353. * The module's name
  79354. */
  79355. static readonly Name: string;
  79356. /**
  79357. * The (Babylon) version of this module.
  79358. * This is an integer representing the implementation version.
  79359. * This number does not correspond to the WebXR specs version
  79360. */
  79361. static readonly Version: number;
  79362. /**
  79363. * Observers registered here will be executed when a new plane was added to the session
  79364. */
  79365. onPlaneAddedObservable: Observable<IWebXRPlane>;
  79366. /**
  79367. * Observers registered here will be executed when a plane is no longer detected in the session
  79368. */
  79369. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  79370. /**
  79371. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  79372. * This can execute N times every frame
  79373. */
  79374. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  79375. /**
  79376. * construct a new Plane Detector
  79377. * @param _xrSessionManager an instance of xr Session manager
  79378. * @param _options configuration to use when constructing this feature
  79379. */
  79380. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  79381. /**
  79382. * detach this feature.
  79383. * Will usually be called by the features manager
  79384. *
  79385. * @returns true if successful.
  79386. */
  79387. detach(): boolean;
  79388. /**
  79389. * Dispose this feature and all of the resources attached
  79390. */
  79391. dispose(): void;
  79392. protected _onXRFrame(frame: XRFrame): void;
  79393. private _init;
  79394. private _updatePlaneWithXRPlane;
  79395. /**
  79396. * avoiding using Array.find for global support.
  79397. * @param xrPlane the plane to find in the array
  79398. */
  79399. private findIndexInPlaneArray;
  79400. }
  79401. }
  79402. declare module "babylonjs/XR/features/WebXRBackgroundRemover" {
  79403. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79404. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79405. import { Observable } from "babylonjs/Misc/observable";
  79406. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79407. /**
  79408. * Options interface for the background remover plugin
  79409. */
  79410. export interface IWebXRBackgroundRemoverOptions {
  79411. /**
  79412. * Further background meshes to disable when entering AR
  79413. */
  79414. backgroundMeshes?: AbstractMesh[];
  79415. /**
  79416. * flags to configure the removal of the environment helper.
  79417. * If not set, the entire background will be removed. If set, flags should be set as well.
  79418. */
  79419. environmentHelperRemovalFlags?: {
  79420. /**
  79421. * Should the skybox be removed (default false)
  79422. */
  79423. skyBox?: boolean;
  79424. /**
  79425. * Should the ground be removed (default false)
  79426. */
  79427. ground?: boolean;
  79428. };
  79429. /**
  79430. * don't disable the environment helper
  79431. */
  79432. ignoreEnvironmentHelper?: boolean;
  79433. }
  79434. /**
  79435. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  79436. */
  79437. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  79438. /**
  79439. * read-only options to be used in this module
  79440. */
  79441. readonly options: IWebXRBackgroundRemoverOptions;
  79442. /**
  79443. * The module's name
  79444. */
  79445. static readonly Name: string;
  79446. /**
  79447. * The (Babylon) version of this module.
  79448. * This is an integer representing the implementation version.
  79449. * This number does not correspond to the WebXR specs version
  79450. */
  79451. static readonly Version: number;
  79452. /**
  79453. * registered observers will be triggered when the background state changes
  79454. */
  79455. onBackgroundStateChangedObservable: Observable<boolean>;
  79456. /**
  79457. * constructs a new background remover module
  79458. * @param _xrSessionManager the session manager for this module
  79459. * @param options read-only options to be used in this module
  79460. */
  79461. constructor(_xrSessionManager: WebXRSessionManager,
  79462. /**
  79463. * read-only options to be used in this module
  79464. */
  79465. options?: IWebXRBackgroundRemoverOptions);
  79466. /**
  79467. * attach this feature
  79468. * Will usually be called by the features manager
  79469. *
  79470. * @returns true if successful.
  79471. */
  79472. attach(): boolean;
  79473. /**
  79474. * detach this feature.
  79475. * Will usually be called by the features manager
  79476. *
  79477. * @returns true if successful.
  79478. */
  79479. detach(): boolean;
  79480. /**
  79481. * Dispose this feature and all of the resources attached
  79482. */
  79483. dispose(): void;
  79484. protected _onXRFrame(_xrFrame: XRFrame): void;
  79485. private _setBackgroundState;
  79486. }
  79487. }
  79488. declare module "babylonjs/XR/features/WebXRControllerPhysics" {
  79489. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79490. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  79491. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  79492. import { WebXRInput } from "babylonjs/XR/webXRInput";
  79493. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79494. import { Nullable } from "babylonjs/types";
  79495. /**
  79496. * Options for the controller physics feature
  79497. */
  79498. export class IWebXRControllerPhysicsOptions {
  79499. /**
  79500. * Should the headset get its own impostor
  79501. */
  79502. enableHeadsetImpostor?: boolean;
  79503. /**
  79504. * Optional parameters for the headset impostor
  79505. */
  79506. headsetImpostorParams?: {
  79507. /**
  79508. * The type of impostor to create. Default is sphere
  79509. */
  79510. impostorType: number;
  79511. /**
  79512. * the size of the impostor. Defaults to 10cm
  79513. */
  79514. impostorSize?: number | {
  79515. width: number;
  79516. height: number;
  79517. depth: number;
  79518. };
  79519. /**
  79520. * Friction definitions
  79521. */
  79522. friction?: number;
  79523. /**
  79524. * Restitution
  79525. */
  79526. restitution?: number;
  79527. };
  79528. /**
  79529. * The physics properties of the future impostors
  79530. */
  79531. physicsProperties?: {
  79532. /**
  79533. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  79534. * Note that this requires a physics engine that supports mesh impostors!
  79535. */
  79536. useControllerMesh?: boolean;
  79537. /**
  79538. * The type of impostor to create. Default is sphere
  79539. */
  79540. impostorType?: number;
  79541. /**
  79542. * the size of the impostor. Defaults to 10cm
  79543. */
  79544. impostorSize?: number | {
  79545. width: number;
  79546. height: number;
  79547. depth: number;
  79548. };
  79549. /**
  79550. * Friction definitions
  79551. */
  79552. friction?: number;
  79553. /**
  79554. * Restitution
  79555. */
  79556. restitution?: number;
  79557. };
  79558. /**
  79559. * the xr input to use with this pointer selection
  79560. */
  79561. xrInput: WebXRInput;
  79562. }
  79563. /**
  79564. * Add physics impostor to your webxr controllers,
  79565. * including naive calculation of their linear and angular velocity
  79566. */
  79567. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  79568. private readonly _options;
  79569. private _attachController;
  79570. private _controllers;
  79571. private _debugMode;
  79572. private _delta;
  79573. private _headsetImpostor?;
  79574. private _headsetMesh?;
  79575. private _lastTimestamp;
  79576. private _tmpQuaternion;
  79577. private _tmpVector;
  79578. /**
  79579. * The module's name
  79580. */
  79581. static readonly Name: string;
  79582. /**
  79583. * The (Babylon) version of this module.
  79584. * This is an integer representing the implementation version.
  79585. * This number does not correspond to the webxr specs version
  79586. */
  79587. static readonly Version: number;
  79588. /**
  79589. * Construct a new Controller Physics Feature
  79590. * @param _xrSessionManager the corresponding xr session manager
  79591. * @param _options options to create this feature with
  79592. */
  79593. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  79594. /**
  79595. * @hidden
  79596. * enable debugging - will show console outputs and the impostor mesh
  79597. */
  79598. _enablePhysicsDebug(): void;
  79599. /**
  79600. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  79601. * @param xrController the controller to add
  79602. */
  79603. addController(xrController: WebXRInputSource): void;
  79604. /**
  79605. * attach this feature
  79606. * Will usually be called by the features manager
  79607. *
  79608. * @returns true if successful.
  79609. */
  79610. attach(): boolean;
  79611. /**
  79612. * detach this feature.
  79613. * Will usually be called by the features manager
  79614. *
  79615. * @returns true if successful.
  79616. */
  79617. detach(): boolean;
  79618. /**
  79619. * Get the headset impostor, if enabled
  79620. * @returns the impostor
  79621. */
  79622. getHeadsetImpostor(): PhysicsImpostor | undefined;
  79623. /**
  79624. * Get the physics impostor of a specific controller.
  79625. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  79626. * @param controller the controller or the controller id of which to get the impostor
  79627. * @returns the impostor or null
  79628. */
  79629. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  79630. /**
  79631. * Update the physics properties provided in the constructor
  79632. * @param newProperties the new properties object
  79633. */
  79634. setPhysicsProperties(newProperties: {
  79635. impostorType?: number;
  79636. impostorSize?: number | {
  79637. width: number;
  79638. height: number;
  79639. depth: number;
  79640. };
  79641. friction?: number;
  79642. restitution?: number;
  79643. }): void;
  79644. protected _onXRFrame(_xrFrame: any): void;
  79645. private _detachController;
  79646. }
  79647. }
  79648. declare module "babylonjs/XR/features/WebXRFeaturePointSystem" {
  79649. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79650. import { Observable } from "babylonjs/Misc/observable";
  79651. import { Vector3 } from "babylonjs/Maths/math.vector";
  79652. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79653. /**
  79654. * A babylon interface for a "WebXR" feature point.
  79655. * Represents the position and confidence value of a given feature point.
  79656. */
  79657. export interface IWebXRFeaturePoint {
  79658. /**
  79659. * Represents the position of the feature point in world space.
  79660. */
  79661. position: Vector3;
  79662. /**
  79663. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  79664. */
  79665. confidenceValue: number;
  79666. }
  79667. /**
  79668. * The feature point system is used to detect feature points from real world geometry.
  79669. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  79670. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  79671. */
  79672. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  79673. private _enabled;
  79674. private _featurePointCloud;
  79675. /**
  79676. * The module's name
  79677. */
  79678. static readonly Name: string;
  79679. /**
  79680. * The (Babylon) version of this module.
  79681. * This is an integer representing the implementation version.
  79682. * This number does not correspond to the WebXR specs version
  79683. */
  79684. static readonly Version: number;
  79685. /**
  79686. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  79687. * Will notify the observers about which feature points have been added.
  79688. */
  79689. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  79690. /**
  79691. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  79692. * Will notify the observers about which feature points have been updated.
  79693. */
  79694. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  79695. /**
  79696. * The current feature point cloud maintained across frames.
  79697. */
  79698. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  79699. /**
  79700. * construct the feature point system
  79701. * @param _xrSessionManager an instance of xr Session manager
  79702. */
  79703. constructor(_xrSessionManager: WebXRSessionManager);
  79704. /**
  79705. * Detach this feature.
  79706. * Will usually be called by the features manager
  79707. *
  79708. * @returns true if successful.
  79709. */
  79710. detach(): boolean;
  79711. /**
  79712. * Dispose this feature and all of the resources attached
  79713. */
  79714. dispose(): void;
  79715. /**
  79716. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  79717. */
  79718. protected _onXRFrame(frame: XRFrame): void;
  79719. /**
  79720. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  79721. */
  79722. private _init;
  79723. }
  79724. }
  79725. declare module "babylonjs/XR/features/WebXRHandTracking" {
  79726. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79727. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79728. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79729. import { Mesh } from "babylonjs/Meshes/mesh";
  79730. import { WebXRInput } from "babylonjs/XR/webXRInput";
  79731. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  79732. import { Nullable } from "babylonjs/types";
  79733. import { IDisposable } from "babylonjs/scene";
  79734. import { Observable } from "babylonjs/Misc/observable";
  79735. /**
  79736. * Configuration interface for the hand tracking feature
  79737. */
  79738. export interface IWebXRHandTrackingOptions {
  79739. /**
  79740. * The xrInput that will be used as source for new hands
  79741. */
  79742. xrInput: WebXRInput;
  79743. /**
  79744. * Configuration object for the joint meshes
  79745. */
  79746. jointMeshes?: {
  79747. /**
  79748. * Should the meshes created be invisible (defaults to false)
  79749. */
  79750. invisible?: boolean;
  79751. /**
  79752. * A source mesh to be used to create instances. Defaults to a sphere.
  79753. * This mesh will be the source for all other (25) meshes.
  79754. * It should have the general size of a single unit, as the instances will be scaled according to the provided radius
  79755. */
  79756. sourceMesh?: Mesh;
  79757. /**
  79758. * Should the source mesh stay visible. Defaults to false
  79759. */
  79760. keepOriginalVisible?: boolean;
  79761. /**
  79762. * Scale factor for all instances (defaults to 2)
  79763. */
  79764. scaleFactor?: number;
  79765. /**
  79766. * Should each instance have its own physics impostor
  79767. */
  79768. enablePhysics?: boolean;
  79769. /**
  79770. * If enabled, override default physics properties
  79771. */
  79772. physicsProps?: {
  79773. friction?: number;
  79774. restitution?: number;
  79775. impostorType?: number;
  79776. };
  79777. /**
  79778. * For future use - a single hand-mesh that will be updated according to the XRHand data provided
  79779. */
  79780. handMesh?: AbstractMesh;
  79781. };
  79782. }
  79783. /**
  79784. * Parts of the hands divided to writs and finger names
  79785. */
  79786. export const enum HandPart {
  79787. /**
  79788. * HandPart - Wrist
  79789. */
  79790. WRIST = "wrist",
  79791. /**
  79792. * HandPart - The THumb
  79793. */
  79794. THUMB = "thumb",
  79795. /**
  79796. * HandPart - Index finger
  79797. */
  79798. INDEX = "index",
  79799. /**
  79800. * HandPart - Middle finger
  79801. */
  79802. MIDDLE = "middle",
  79803. /**
  79804. * HandPart - Ring finger
  79805. */
  79806. RING = "ring",
  79807. /**
  79808. * HandPart - Little finger
  79809. */
  79810. LITTLE = "little"
  79811. }
  79812. /**
  79813. * Representing a single hand (with its corresponding native XRHand object)
  79814. */
  79815. export class WebXRHand implements IDisposable {
  79816. /** the controller to which the hand correlates */
  79817. readonly xrController: WebXRInputSource;
  79818. /** the meshes to be used to track the hand joints */
  79819. readonly trackedMeshes: AbstractMesh[];
  79820. /**
  79821. * Hand-parts definition (key is HandPart)
  79822. */
  79823. handPartsDefinition: {
  79824. [key: string]: number[];
  79825. };
  79826. /**
  79827. * Populate the HandPartsDefinition object.
  79828. * This is called as a side effect since certain browsers don't have XRHand defined.
  79829. */
  79830. private generateHandPartsDefinition;
  79831. /**
  79832. * Construct a new hand object
  79833. * @param xrController the controller to which the hand correlates
  79834. * @param trackedMeshes the meshes to be used to track the hand joints
  79835. */
  79836. constructor(
  79837. /** the controller to which the hand correlates */
  79838. xrController: WebXRInputSource,
  79839. /** the meshes to be used to track the hand joints */
  79840. trackedMeshes: AbstractMesh[]);
  79841. /**
  79842. * Update this hand from the latest xr frame
  79843. * @param xrFrame xrFrame to update from
  79844. * @param referenceSpace The current viewer reference space
  79845. * @param scaleFactor optional scale factor for the meshes
  79846. */
  79847. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace, scaleFactor?: number): void;
  79848. /**
  79849. * Get meshes of part of the hand
  79850. * @param part the part of hand to get
  79851. * @returns An array of meshes that correlate to the hand part requested
  79852. */
  79853. getHandPartMeshes(part: HandPart): AbstractMesh[];
  79854. /**
  79855. * Dispose this Hand object
  79856. */
  79857. dispose(): void;
  79858. }
  79859. /**
  79860. * WebXR Hand Joint tracking feature, available for selected browsers and devices
  79861. */
  79862. export class WebXRHandTracking extends WebXRAbstractFeature {
  79863. /**
  79864. * options to use when constructing this feature
  79865. */
  79866. readonly options: IWebXRHandTrackingOptions;
  79867. private static _idCounter;
  79868. /**
  79869. * The module's name
  79870. */
  79871. static readonly Name: string;
  79872. /**
  79873. * The (Babylon) version of this module.
  79874. * This is an integer representing the implementation version.
  79875. * This number does not correspond to the WebXR specs version
  79876. */
  79877. static readonly Version: number;
  79878. /**
  79879. * This observable will notify registered observers when a new hand object was added and initialized
  79880. */
  79881. onHandAddedObservable: Observable<WebXRHand>;
  79882. /**
  79883. * This observable will notify its observers right before the hand object is disposed
  79884. */
  79885. onHandRemovedObservable: Observable<WebXRHand>;
  79886. private _hands;
  79887. /**
  79888. * Creates a new instance of the hit test feature
  79889. * @param _xrSessionManager an instance of WebXRSessionManager
  79890. * @param options options to use when constructing this feature
  79891. */
  79892. constructor(_xrSessionManager: WebXRSessionManager,
  79893. /**
  79894. * options to use when constructing this feature
  79895. */
  79896. options: IWebXRHandTrackingOptions);
  79897. /**
  79898. * Check if the needed objects are defined.
  79899. * This does not mean that the feature is enabled, but that the objects needed are well defined.
  79900. */
  79901. isCompatible(): boolean;
  79902. /**
  79903. * attach this feature
  79904. * Will usually be called by the features manager
  79905. *
  79906. * @returns true if successful.
  79907. */
  79908. attach(): boolean;
  79909. /**
  79910. * detach this feature.
  79911. * Will usually be called by the features manager
  79912. *
  79913. * @returns true if successful.
  79914. */
  79915. detach(): boolean;
  79916. /**
  79917. * Dispose this feature and all of the resources attached
  79918. */
  79919. dispose(): void;
  79920. /**
  79921. * Get the hand object according to the controller id
  79922. * @param controllerId the controller id to which we want to get the hand
  79923. * @returns null if not found or the WebXRHand object if found
  79924. */
  79925. getHandByControllerId(controllerId: string): Nullable<WebXRHand>;
  79926. /**
  79927. * Get a hand object according to the requested handedness
  79928. * @param handedness the handedness to request
  79929. * @returns null if not found or the WebXRHand object if found
  79930. */
  79931. getHandByHandedness(handedness: XRHandedness): Nullable<WebXRHand>;
  79932. protected _onXRFrame(_xrFrame: XRFrame): void;
  79933. private _attachHand;
  79934. private _detachHand;
  79935. }
  79936. }
  79937. declare module "babylonjs/XR/features/index" {
  79938. export * from "babylonjs/XR/features/WebXRHitTestLegacy";
  79939. export * from "babylonjs/XR/features/WebXRAnchorSystem";
  79940. export * from "babylonjs/XR/features/WebXRPlaneDetector";
  79941. export * from "babylonjs/XR/features/WebXRBackgroundRemover";
  79942. export * from "babylonjs/XR/features/WebXRControllerTeleportation";
  79943. export * from "babylonjs/XR/features/WebXRControllerPointerSelection";
  79944. export * from "babylonjs/XR/features/WebXRControllerPhysics";
  79945. export * from "babylonjs/XR/features/WebXRHitTest";
  79946. export * from "babylonjs/XR/features/WebXRFeaturePointSystem";
  79947. export * from "babylonjs/XR/features/WebXRHandTracking";
  79948. }
  79949. declare module "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController" {
  79950. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79951. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79952. import { Scene } from "babylonjs/scene";
  79953. /**
  79954. * The motion controller class for all microsoft mixed reality controllers
  79955. */
  79956. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  79957. protected readonly _mapping: {
  79958. defaultButton: {
  79959. valueNodeName: string;
  79960. unpressedNodeName: string;
  79961. pressedNodeName: string;
  79962. };
  79963. defaultAxis: {
  79964. valueNodeName: string;
  79965. minNodeName: string;
  79966. maxNodeName: string;
  79967. };
  79968. buttons: {
  79969. "xr-standard-trigger": {
  79970. rootNodeName: string;
  79971. componentProperty: string;
  79972. states: string[];
  79973. };
  79974. "xr-standard-squeeze": {
  79975. rootNodeName: string;
  79976. componentProperty: string;
  79977. states: string[];
  79978. };
  79979. "xr-standard-touchpad": {
  79980. rootNodeName: string;
  79981. labelAnchorNodeName: string;
  79982. touchPointNodeName: string;
  79983. };
  79984. "xr-standard-thumbstick": {
  79985. rootNodeName: string;
  79986. componentProperty: string;
  79987. states: string[];
  79988. };
  79989. };
  79990. axes: {
  79991. "xr-standard-touchpad": {
  79992. "x-axis": {
  79993. rootNodeName: string;
  79994. };
  79995. "y-axis": {
  79996. rootNodeName: string;
  79997. };
  79998. };
  79999. "xr-standard-thumbstick": {
  80000. "x-axis": {
  80001. rootNodeName: string;
  80002. };
  80003. "y-axis": {
  80004. rootNodeName: string;
  80005. };
  80006. };
  80007. };
  80008. };
  80009. /**
  80010. * The base url used to load the left and right controller models
  80011. */
  80012. static MODEL_BASE_URL: string;
  80013. /**
  80014. * The name of the left controller model file
  80015. */
  80016. static MODEL_LEFT_FILENAME: string;
  80017. /**
  80018. * The name of the right controller model file
  80019. */
  80020. static MODEL_RIGHT_FILENAME: string;
  80021. profileId: string;
  80022. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  80023. protected _getFilenameAndPath(): {
  80024. filename: string;
  80025. path: string;
  80026. };
  80027. protected _getModelLoadingConstraints(): boolean;
  80028. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  80029. protected _setRootMesh(meshes: AbstractMesh[]): void;
  80030. protected _updateModel(): void;
  80031. }
  80032. }
  80033. declare module "babylonjs/XR/motionController/webXROculusTouchMotionController" {
  80034. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  80035. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  80036. import { Scene } from "babylonjs/scene";
  80037. /**
  80038. * The motion controller class for oculus touch (quest, rift).
  80039. * This class supports legacy mapping as well the standard xr mapping
  80040. */
  80041. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  80042. private _forceLegacyControllers;
  80043. private _modelRootNode;
  80044. /**
  80045. * The base url used to load the left and right controller models
  80046. */
  80047. static MODEL_BASE_URL: string;
  80048. /**
  80049. * The name of the left controller model file
  80050. */
  80051. static MODEL_LEFT_FILENAME: string;
  80052. /**
  80053. * The name of the right controller model file
  80054. */
  80055. static MODEL_RIGHT_FILENAME: string;
  80056. /**
  80057. * Base Url for the Quest controller model.
  80058. */
  80059. static QUEST_MODEL_BASE_URL: string;
  80060. profileId: string;
  80061. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  80062. protected _getFilenameAndPath(): {
  80063. filename: string;
  80064. path: string;
  80065. };
  80066. protected _getModelLoadingConstraints(): boolean;
  80067. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  80068. protected _setRootMesh(meshes: AbstractMesh[]): void;
  80069. protected _updateModel(): void;
  80070. /**
  80071. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  80072. * between the touch and touch 2.
  80073. */
  80074. private _isQuest;
  80075. }
  80076. }
  80077. declare module "babylonjs/XR/motionController/webXRHTCViveMotionController" {
  80078. import { IMinimalMotionControllerObject, MotionControllerHandedness, WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  80079. import { Scene } from "babylonjs/scene";
  80080. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  80081. /**
  80082. * The motion controller class for the standard HTC-Vive controllers
  80083. */
  80084. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  80085. private _modelRootNode;
  80086. /**
  80087. * The base url used to load the left and right controller models
  80088. */
  80089. static MODEL_BASE_URL: string;
  80090. /**
  80091. * File name for the controller model.
  80092. */
  80093. static MODEL_FILENAME: string;
  80094. profileId: string;
  80095. /**
  80096. * Create a new Vive motion controller object
  80097. * @param scene the scene to use to create this controller
  80098. * @param gamepadObject the corresponding gamepad object
  80099. * @param handedness the handedness of the controller
  80100. */
  80101. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  80102. protected _getFilenameAndPath(): {
  80103. filename: string;
  80104. path: string;
  80105. };
  80106. protected _getModelLoadingConstraints(): boolean;
  80107. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  80108. protected _setRootMesh(meshes: AbstractMesh[]): void;
  80109. protected _updateModel(): void;
  80110. }
  80111. }
  80112. declare module "babylonjs/XR/motionController/index" {
  80113. export * from "babylonjs/XR/motionController/webXRAbstractMotionController";
  80114. export * from "babylonjs/XR/motionController/webXRControllerComponent";
  80115. export * from "babylonjs/XR/motionController/webXRGenericMotionController";
  80116. export * from "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController";
  80117. export * from "babylonjs/XR/motionController/webXRMotionControllerManager";
  80118. export * from "babylonjs/XR/motionController/webXROculusTouchMotionController";
  80119. export * from "babylonjs/XR/motionController/webXRHTCViveMotionController";
  80120. export * from "babylonjs/XR/motionController/webXRProfiledMotionController";
  80121. }
  80122. declare module "babylonjs/XR/index" {
  80123. export * from "babylonjs/XR/webXRCamera";
  80124. export * from "babylonjs/XR/webXREnterExitUI";
  80125. export * from "babylonjs/XR/webXRExperienceHelper";
  80126. export * from "babylonjs/XR/webXRInput";
  80127. export * from "babylonjs/XR/webXRInputSource";
  80128. export * from "babylonjs/XR/webXRManagedOutputCanvas";
  80129. export * from "babylonjs/XR/webXRTypes";
  80130. export * from "babylonjs/XR/webXRSessionManager";
  80131. export * from "babylonjs/XR/webXRDefaultExperience";
  80132. export * from "babylonjs/XR/webXRFeaturesManager";
  80133. export * from "babylonjs/XR/features/index";
  80134. export * from "babylonjs/XR/motionController/index";
  80135. }
  80136. declare module "babylonjs/index" {
  80137. export * from "babylonjs/abstractScene";
  80138. export * from "babylonjs/Actions/index";
  80139. export * from "babylonjs/Animations/index";
  80140. export * from "babylonjs/assetContainer";
  80141. export * from "babylonjs/Audio/index";
  80142. export * from "babylonjs/Behaviors/index";
  80143. export * from "babylonjs/Bones/index";
  80144. export * from "babylonjs/Cameras/index";
  80145. export * from "babylonjs/Collisions/index";
  80146. export * from "babylonjs/Culling/index";
  80147. export * from "babylonjs/Debug/index";
  80148. export * from "babylonjs/DeviceInput/index";
  80149. export * from "babylonjs/Engines/index";
  80150. export * from "babylonjs/Events/index";
  80151. export * from "babylonjs/Gamepads/index";
  80152. export * from "babylonjs/Gizmos/index";
  80153. export * from "babylonjs/Helpers/index";
  80154. export * from "babylonjs/Instrumentation/index";
  80155. export * from "babylonjs/Layers/index";
  80156. export * from "babylonjs/LensFlares/index";
  80157. export * from "babylonjs/Lights/index";
  80158. export * from "babylonjs/Loading/index";
  80159. export * from "babylonjs/Materials/index";
  80160. export * from "babylonjs/Maths/index";
  80161. export * from "babylonjs/Meshes/index";
  80162. export * from "babylonjs/Morph/index";
  80163. export * from "babylonjs/Navigation/index";
  80164. export * from "babylonjs/node";
  80165. export * from "babylonjs/Offline/index";
  80166. export * from "babylonjs/Particles/index";
  80167. export * from "babylonjs/Physics/index";
  80168. export * from "babylonjs/PostProcesses/index";
  80169. export * from "babylonjs/Probes/index";
  80170. export * from "babylonjs/Rendering/index";
  80171. export * from "babylonjs/scene";
  80172. export * from "babylonjs/sceneComponent";
  80173. export * from "babylonjs/Sprites/index";
  80174. export * from "babylonjs/States/index";
  80175. export * from "babylonjs/Misc/index";
  80176. export * from "babylonjs/XR/index";
  80177. export * from "babylonjs/types";
  80178. }
  80179. declare module "babylonjs/Animations/pathCursor" {
  80180. import { Vector3 } from "babylonjs/Maths/math.vector";
  80181. import { Path2 } from "babylonjs/Maths/math.path";
  80182. /**
  80183. * A cursor which tracks a point on a path
  80184. */
  80185. export class PathCursor {
  80186. private path;
  80187. /**
  80188. * Stores path cursor callbacks for when an onchange event is triggered
  80189. */
  80190. private _onchange;
  80191. /**
  80192. * The value of the path cursor
  80193. */
  80194. value: number;
  80195. /**
  80196. * The animation array of the path cursor
  80197. */
  80198. animations: Animation[];
  80199. /**
  80200. * Initializes the path cursor
  80201. * @param path The path to track
  80202. */
  80203. constructor(path: Path2);
  80204. /**
  80205. * Gets the cursor point on the path
  80206. * @returns A point on the path cursor at the cursor location
  80207. */
  80208. getPoint(): Vector3;
  80209. /**
  80210. * Moves the cursor ahead by the step amount
  80211. * @param step The amount to move the cursor forward
  80212. * @returns This path cursor
  80213. */
  80214. moveAhead(step?: number): PathCursor;
  80215. /**
  80216. * Moves the cursor behind by the step amount
  80217. * @param step The amount to move the cursor back
  80218. * @returns This path cursor
  80219. */
  80220. moveBack(step?: number): PathCursor;
  80221. /**
  80222. * Moves the cursor by the step amount
  80223. * If the step amount is greater than one, an exception is thrown
  80224. * @param step The amount to move the cursor
  80225. * @returns This path cursor
  80226. */
  80227. move(step: number): PathCursor;
  80228. /**
  80229. * Ensures that the value is limited between zero and one
  80230. * @returns This path cursor
  80231. */
  80232. private ensureLimits;
  80233. /**
  80234. * Runs onchange callbacks on change (used by the animation engine)
  80235. * @returns This path cursor
  80236. */
  80237. private raiseOnChange;
  80238. /**
  80239. * Executes a function on change
  80240. * @param f A path cursor onchange callback
  80241. * @returns This path cursor
  80242. */
  80243. onchange(f: (cursor: PathCursor) => void): PathCursor;
  80244. }
  80245. }
  80246. declare module "babylonjs/Engines/Processors/Expressions/Operators/index" {
  80247. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator";
  80248. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator";
  80249. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator";
  80250. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator";
  80251. }
  80252. declare module "babylonjs/Engines/Processors/Expressions/index" {
  80253. export * from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  80254. export * from "babylonjs/Engines/Processors/Expressions/Operators/index";
  80255. }
  80256. declare module "babylonjs/Engines/Processors/index" {
  80257. export * from "babylonjs/Engines/Processors/iShaderProcessor";
  80258. export * from "babylonjs/Engines/Processors/Expressions/index";
  80259. export * from "babylonjs/Engines/Processors/shaderCodeConditionNode";
  80260. export * from "babylonjs/Engines/Processors/shaderCodeCursor";
  80261. export * from "babylonjs/Engines/Processors/shaderCodeNode";
  80262. export * from "babylonjs/Engines/Processors/shaderCodeTestNode";
  80263. export * from "babylonjs/Engines/Processors/shaderProcessingOptions";
  80264. export * from "babylonjs/Engines/Processors/shaderProcessor";
  80265. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  80266. }
  80267. declare module "babylonjs/Legacy/legacy" {
  80268. import * as Babylon from "babylonjs/index";
  80269. export * from "babylonjs/index";
  80270. }
  80271. declare module "babylonjs/Shaders/blur.fragment" {
  80272. /** @hidden */
  80273. export var blurPixelShader: {
  80274. name: string;
  80275. shader: string;
  80276. };
  80277. }
  80278. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertexDeclaration" {
  80279. /** @hidden */
  80280. export var pointCloudVertexDeclaration: {
  80281. name: string;
  80282. shader: string;
  80283. };
  80284. }
  80285. declare module "babylonjs" {
  80286. export * from "babylonjs/Legacy/legacy";
  80287. }
  80288. declare module BABYLON {
  80289. /** Alias type for value that can be null */
  80290. export type Nullable<T> = T | null;
  80291. /**
  80292. * Alias type for number that are floats
  80293. * @ignorenaming
  80294. */
  80295. export type float = number;
  80296. /**
  80297. * Alias type for number that are doubles.
  80298. * @ignorenaming
  80299. */
  80300. export type double = number;
  80301. /**
  80302. * Alias type for number that are integer
  80303. * @ignorenaming
  80304. */
  80305. export type int = number;
  80306. /** Alias type for number array or Float32Array */
  80307. export type FloatArray = number[] | Float32Array;
  80308. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  80309. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  80310. /**
  80311. * Alias for types that can be used by a Buffer or VertexBuffer.
  80312. */
  80313. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  80314. /**
  80315. * Alias type for primitive types
  80316. * @ignorenaming
  80317. */
  80318. type Primitive = undefined | null | boolean | string | number | Function;
  80319. /**
  80320. * Type modifier to make all the properties of an object Readonly
  80321. */
  80322. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  80323. /**
  80324. * Type modifier to make all the properties of an object Readonly recursively
  80325. */
  80326. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  80327. /**
  80328. * Type modifier to make object properties readonly.
  80329. */
  80330. export type DeepImmutableObject<T> = {
  80331. readonly [K in keyof T]: DeepImmutable<T[K]>;
  80332. };
  80333. /** @hidden */
  80334. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  80335. }
  80336. }
  80337. declare module BABYLON {
  80338. /**
  80339. * A class serves as a medium between the observable and its observers
  80340. */
  80341. export class EventState {
  80342. /**
  80343. * Create a new EventState
  80344. * @param mask defines the mask associated with this state
  80345. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  80346. * @param target defines the original target of the state
  80347. * @param currentTarget defines the current target of the state
  80348. */
  80349. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  80350. /**
  80351. * Initialize the current event state
  80352. * @param mask defines the mask associated with this state
  80353. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  80354. * @param target defines the original target of the state
  80355. * @param currentTarget defines the current target of the state
  80356. * @returns the current event state
  80357. */
  80358. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  80359. /**
  80360. * An Observer can set this property to true to prevent subsequent observers of being notified
  80361. */
  80362. skipNextObservers: boolean;
  80363. /**
  80364. * Get the mask value that were used to trigger the event corresponding to this EventState object
  80365. */
  80366. mask: number;
  80367. /**
  80368. * The object that originally notified the event
  80369. */
  80370. target?: any;
  80371. /**
  80372. * The current object in the bubbling phase
  80373. */
  80374. currentTarget?: any;
  80375. /**
  80376. * This will be populated with the return value of the last function that was executed.
  80377. * If it is the first function in the callback chain it will be the event data.
  80378. */
  80379. lastReturnValue?: any;
  80380. }
  80381. /**
  80382. * Represent an Observer registered to a given Observable object.
  80383. */
  80384. export class Observer<T> {
  80385. /**
  80386. * Defines the callback to call when the observer is notified
  80387. */
  80388. callback: (eventData: T, eventState: EventState) => void;
  80389. /**
  80390. * Defines the mask of the observer (used to filter notifications)
  80391. */
  80392. mask: number;
  80393. /**
  80394. * Defines the current scope used to restore the JS context
  80395. */
  80396. scope: any;
  80397. /** @hidden */
  80398. _willBeUnregistered: boolean;
  80399. /**
  80400. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  80401. */
  80402. unregisterOnNextCall: boolean;
  80403. /**
  80404. * Creates a new observer
  80405. * @param callback defines the callback to call when the observer is notified
  80406. * @param mask defines the mask of the observer (used to filter notifications)
  80407. * @param scope defines the current scope used to restore the JS context
  80408. */
  80409. constructor(
  80410. /**
  80411. * Defines the callback to call when the observer is notified
  80412. */
  80413. callback: (eventData: T, eventState: EventState) => void,
  80414. /**
  80415. * Defines the mask of the observer (used to filter notifications)
  80416. */
  80417. mask: number,
  80418. /**
  80419. * Defines the current scope used to restore the JS context
  80420. */
  80421. scope?: any);
  80422. }
  80423. /**
  80424. * Represent a list of observers registered to multiple Observables object.
  80425. */
  80426. export class MultiObserver<T> {
  80427. private _observers;
  80428. private _observables;
  80429. /**
  80430. * Release associated resources
  80431. */
  80432. dispose(): void;
  80433. /**
  80434. * Raise a callback when one of the observable will notify
  80435. * @param observables defines a list of observables to watch
  80436. * @param callback defines the callback to call on notification
  80437. * @param mask defines the mask used to filter notifications
  80438. * @param scope defines the current scope used to restore the JS context
  80439. * @returns the new MultiObserver
  80440. */
  80441. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  80442. }
  80443. /**
  80444. * The Observable class is a simple implementation of the Observable pattern.
  80445. *
  80446. * 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.
  80447. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  80448. * 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).
  80449. * 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.
  80450. */
  80451. export class Observable<T> {
  80452. private _observers;
  80453. private _eventState;
  80454. private _onObserverAdded;
  80455. /**
  80456. * Gets the list of observers
  80457. */
  80458. get observers(): Array<Observer<T>>;
  80459. /**
  80460. * Creates a new observable
  80461. * @param onObserverAdded defines a callback to call when a new observer is added
  80462. */
  80463. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  80464. /**
  80465. * Create a new Observer with the specified callback
  80466. * @param callback the callback that will be executed for that Observer
  80467. * @param mask the mask used to filter observers
  80468. * @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.
  80469. * @param scope optional scope for the callback to be called from
  80470. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  80471. * @returns the new observer created for the callback
  80472. */
  80473. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  80474. /**
  80475. * Create a new Observer with the specified callback and unregisters after the next notification
  80476. * @param callback the callback that will be executed for that Observer
  80477. * @returns the new observer created for the callback
  80478. */
  80479. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  80480. /**
  80481. * Remove an Observer from the Observable object
  80482. * @param observer the instance of the Observer to remove
  80483. * @returns false if it doesn't belong to this Observable
  80484. */
  80485. remove(observer: Nullable<Observer<T>>): boolean;
  80486. /**
  80487. * Remove a callback from the Observable object
  80488. * @param callback the callback to remove
  80489. * @param scope optional scope. If used only the callbacks with this scope will be removed
  80490. * @returns false if it doesn't belong to this Observable
  80491. */
  80492. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  80493. private _deferUnregister;
  80494. private _remove;
  80495. /**
  80496. * Moves the observable to the top of the observer list making it get called first when notified
  80497. * @param observer the observer to move
  80498. */
  80499. makeObserverTopPriority(observer: Observer<T>): void;
  80500. /**
  80501. * Moves the observable to the bottom of the observer list making it get called last when notified
  80502. * @param observer the observer to move
  80503. */
  80504. makeObserverBottomPriority(observer: Observer<T>): void;
  80505. /**
  80506. * Notify all Observers by calling their respective callback with the given data
  80507. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  80508. * @param eventData defines the data to send to all observers
  80509. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  80510. * @param target defines the original target of the state
  80511. * @param currentTarget defines the current target of the state
  80512. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  80513. */
  80514. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  80515. /**
  80516. * Calling this will execute each callback, expecting it to be a promise or return a value.
  80517. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  80518. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  80519. * and it is crucial that all callbacks will be executed.
  80520. * The order of the callbacks is kept, callbacks are not executed parallel.
  80521. *
  80522. * @param eventData The data to be sent to each callback
  80523. * @param mask is used to filter observers defaults to -1
  80524. * @param target defines the callback target (see EventState)
  80525. * @param currentTarget defines he current object in the bubbling phase
  80526. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  80527. */
  80528. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  80529. /**
  80530. * Notify a specific observer
  80531. * @param observer defines the observer to notify
  80532. * @param eventData defines the data to be sent to each callback
  80533. * @param mask is used to filter observers defaults to -1
  80534. */
  80535. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  80536. /**
  80537. * Gets a boolean indicating if the observable has at least one observer
  80538. * @returns true is the Observable has at least one Observer registered
  80539. */
  80540. hasObservers(): boolean;
  80541. /**
  80542. * Clear the list of observers
  80543. */
  80544. clear(): void;
  80545. /**
  80546. * Clone the current observable
  80547. * @returns a new observable
  80548. */
  80549. clone(): Observable<T>;
  80550. /**
  80551. * Does this observable handles observer registered with a given mask
  80552. * @param mask defines the mask to be tested
  80553. * @return whether or not one observer registered with the given mask is handeled
  80554. **/
  80555. hasSpecificMask(mask?: number): boolean;
  80556. }
  80557. }
  80558. declare module BABYLON {
  80559. /**
  80560. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  80561. * Babylon.js
  80562. */
  80563. export class DomManagement {
  80564. /**
  80565. * Checks if the window object exists
  80566. * @returns true if the window object exists
  80567. */
  80568. static IsWindowObjectExist(): boolean;
  80569. /**
  80570. * Checks if the navigator object exists
  80571. * @returns true if the navigator object exists
  80572. */
  80573. static IsNavigatorAvailable(): boolean;
  80574. /**
  80575. * Check if the document object exists
  80576. * @returns true if the document object exists
  80577. */
  80578. static IsDocumentAvailable(): boolean;
  80579. /**
  80580. * Extracts text content from a DOM element hierarchy
  80581. * @param element defines the root element
  80582. * @returns a string
  80583. */
  80584. static GetDOMTextContent(element: HTMLElement): string;
  80585. }
  80586. }
  80587. declare module BABYLON {
  80588. /**
  80589. * Logger used througouht the application to allow configuration of
  80590. * the log level required for the messages.
  80591. */
  80592. export class Logger {
  80593. /**
  80594. * No log
  80595. */
  80596. static readonly NoneLogLevel: number;
  80597. /**
  80598. * Only message logs
  80599. */
  80600. static readonly MessageLogLevel: number;
  80601. /**
  80602. * Only warning logs
  80603. */
  80604. static readonly WarningLogLevel: number;
  80605. /**
  80606. * Only error logs
  80607. */
  80608. static readonly ErrorLogLevel: number;
  80609. /**
  80610. * All logs
  80611. */
  80612. static readonly AllLogLevel: number;
  80613. private static _LogCache;
  80614. /**
  80615. * Gets a value indicating the number of loading errors
  80616. * @ignorenaming
  80617. */
  80618. static errorsCount: number;
  80619. /**
  80620. * Callback called when a new log is added
  80621. */
  80622. static OnNewCacheEntry: (entry: string) => void;
  80623. private static _AddLogEntry;
  80624. private static _FormatMessage;
  80625. private static _LogDisabled;
  80626. private static _LogEnabled;
  80627. private static _WarnDisabled;
  80628. private static _WarnEnabled;
  80629. private static _ErrorDisabled;
  80630. private static _ErrorEnabled;
  80631. /**
  80632. * Log a message to the console
  80633. */
  80634. static Log: (message: string) => void;
  80635. /**
  80636. * Write a warning message to the console
  80637. */
  80638. static Warn: (message: string) => void;
  80639. /**
  80640. * Write an error message to the console
  80641. */
  80642. static Error: (message: string) => void;
  80643. /**
  80644. * Gets current log cache (list of logs)
  80645. */
  80646. static get LogCache(): string;
  80647. /**
  80648. * Clears the log cache
  80649. */
  80650. static ClearLogCache(): void;
  80651. /**
  80652. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  80653. */
  80654. static set LogLevels(level: number);
  80655. }
  80656. }
  80657. declare module BABYLON {
  80658. /** @hidden */
  80659. export class _TypeStore {
  80660. /** @hidden */
  80661. static RegisteredTypes: {
  80662. [key: string]: Object;
  80663. };
  80664. /** @hidden */
  80665. static GetClass(fqdn: string): any;
  80666. }
  80667. }
  80668. declare module BABYLON {
  80669. /**
  80670. * Helper to manipulate strings
  80671. */
  80672. export class StringTools {
  80673. /**
  80674. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  80675. * @param str Source string
  80676. * @param suffix Suffix to search for in the source string
  80677. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  80678. */
  80679. static EndsWith(str: string, suffix: string): boolean;
  80680. /**
  80681. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  80682. * @param str Source string
  80683. * @param suffix Suffix to search for in the source string
  80684. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  80685. */
  80686. static StartsWith(str: string, suffix: string): boolean;
  80687. /**
  80688. * Decodes a buffer into a string
  80689. * @param buffer The buffer to decode
  80690. * @returns The decoded string
  80691. */
  80692. static Decode(buffer: Uint8Array | Uint16Array): string;
  80693. /**
  80694. * Encode a buffer to a base64 string
  80695. * @param buffer defines the buffer to encode
  80696. * @returns the encoded string
  80697. */
  80698. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  80699. /**
  80700. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  80701. * @param num the number to convert and pad
  80702. * @param length the expected length of the string
  80703. * @returns the padded string
  80704. */
  80705. static PadNumber(num: number, length: number): string;
  80706. }
  80707. }
  80708. declare module BABYLON {
  80709. /**
  80710. * Class containing a set of static utilities functions for deep copy.
  80711. */
  80712. export class DeepCopier {
  80713. /**
  80714. * Tries to copy an object by duplicating every property
  80715. * @param source defines the source object
  80716. * @param destination defines the target object
  80717. * @param doNotCopyList defines a list of properties to avoid
  80718. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  80719. */
  80720. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  80721. }
  80722. }
  80723. declare module BABYLON {
  80724. /**
  80725. * Class containing a set of static utilities functions for precision date
  80726. */
  80727. export class PrecisionDate {
  80728. /**
  80729. * Gets either window.performance.now() if supported or Date.now() else
  80730. */
  80731. static get Now(): number;
  80732. }
  80733. }
  80734. declare module BABYLON {
  80735. /** @hidden */
  80736. export class _DevTools {
  80737. static WarnImport(name: string): string;
  80738. }
  80739. }
  80740. declare module BABYLON {
  80741. /**
  80742. * Interface used to define the mechanism to get data from the network
  80743. */
  80744. export interface IWebRequest {
  80745. /**
  80746. * Returns client's response url
  80747. */
  80748. responseURL: string;
  80749. /**
  80750. * Returns client's status
  80751. */
  80752. status: number;
  80753. /**
  80754. * Returns client's status as a text
  80755. */
  80756. statusText: string;
  80757. }
  80758. }
  80759. declare module BABYLON {
  80760. /**
  80761. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  80762. */
  80763. export class WebRequest implements IWebRequest {
  80764. private _xhr;
  80765. /**
  80766. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  80767. * i.e. when loading files, where the server/service expects an Authorization header
  80768. */
  80769. static CustomRequestHeaders: {
  80770. [key: string]: string;
  80771. };
  80772. /**
  80773. * Add callback functions in this array to update all the requests before they get sent to the network
  80774. */
  80775. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  80776. private _injectCustomRequestHeaders;
  80777. /**
  80778. * Gets or sets a function to be called when loading progress changes
  80779. */
  80780. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  80781. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  80782. /**
  80783. * Returns client's state
  80784. */
  80785. get readyState(): number;
  80786. /**
  80787. * Returns client's status
  80788. */
  80789. get status(): number;
  80790. /**
  80791. * Returns client's status as a text
  80792. */
  80793. get statusText(): string;
  80794. /**
  80795. * Returns client's response
  80796. */
  80797. get response(): any;
  80798. /**
  80799. * Returns client's response url
  80800. */
  80801. get responseURL(): string;
  80802. /**
  80803. * Returns client's response as text
  80804. */
  80805. get responseText(): string;
  80806. /**
  80807. * Gets or sets the expected response type
  80808. */
  80809. get responseType(): XMLHttpRequestResponseType;
  80810. set responseType(value: XMLHttpRequestResponseType);
  80811. /** @hidden */
  80812. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  80813. /** @hidden */
  80814. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  80815. /**
  80816. * Cancels any network activity
  80817. */
  80818. abort(): void;
  80819. /**
  80820. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  80821. * @param body defines an optional request body
  80822. */
  80823. send(body?: Document | BodyInit | null): void;
  80824. /**
  80825. * Sets the request method, request URL
  80826. * @param method defines the method to use (GET, POST, etc..)
  80827. * @param url defines the url to connect with
  80828. */
  80829. open(method: string, url: string): void;
  80830. /**
  80831. * Sets the value of a request header.
  80832. * @param name The name of the header whose value is to be set
  80833. * @param value The value to set as the body of the header
  80834. */
  80835. setRequestHeader(name: string, value: string): void;
  80836. /**
  80837. * Get the string containing the text of a particular header's value.
  80838. * @param name The name of the header
  80839. * @returns The string containing the text of the given header name
  80840. */
  80841. getResponseHeader(name: string): Nullable<string>;
  80842. }
  80843. }
  80844. declare module BABYLON {
  80845. /**
  80846. * File request interface
  80847. */
  80848. export interface IFileRequest {
  80849. /**
  80850. * Raised when the request is complete (success or error).
  80851. */
  80852. onCompleteObservable: Observable<IFileRequest>;
  80853. /**
  80854. * Aborts the request for a file.
  80855. */
  80856. abort: () => void;
  80857. }
  80858. }
  80859. declare module BABYLON {
  80860. /**
  80861. * Define options used to create a render target texture
  80862. */
  80863. export class RenderTargetCreationOptions {
  80864. /**
  80865. * Specifies is mipmaps must be generated
  80866. */
  80867. generateMipMaps?: boolean;
  80868. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  80869. generateDepthBuffer?: boolean;
  80870. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  80871. generateStencilBuffer?: boolean;
  80872. /** Defines texture type (int by default) */
  80873. type?: number;
  80874. /** Defines sampling mode (trilinear by default) */
  80875. samplingMode?: number;
  80876. /** Defines format (RGBA by default) */
  80877. format?: number;
  80878. }
  80879. }
  80880. declare module BABYLON {
  80881. /** Defines the cross module used constants to avoid circular dependncies */
  80882. export class Constants {
  80883. /** Defines that alpha blending is disabled */
  80884. static readonly ALPHA_DISABLE: number;
  80885. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  80886. static readonly ALPHA_ADD: number;
  80887. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  80888. static readonly ALPHA_COMBINE: number;
  80889. /** Defines that alpha blending is DEST - SRC * DEST */
  80890. static readonly ALPHA_SUBTRACT: number;
  80891. /** Defines that alpha blending is SRC * DEST */
  80892. static readonly ALPHA_MULTIPLY: number;
  80893. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  80894. static readonly ALPHA_MAXIMIZED: number;
  80895. /** Defines that alpha blending is SRC + DEST */
  80896. static readonly ALPHA_ONEONE: number;
  80897. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  80898. static readonly ALPHA_PREMULTIPLIED: number;
  80899. /**
  80900. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  80901. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  80902. */
  80903. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  80904. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  80905. static readonly ALPHA_INTERPOLATE: number;
  80906. /**
  80907. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  80908. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  80909. */
  80910. static readonly ALPHA_SCREENMODE: number;
  80911. /**
  80912. * Defines that alpha blending is SRC + DST
  80913. * Alpha will be set to SRC ALPHA + DST ALPHA
  80914. */
  80915. static readonly ALPHA_ONEONE_ONEONE: number;
  80916. /**
  80917. * Defines that alpha blending is SRC * DST ALPHA + DST
  80918. * Alpha will be set to 0
  80919. */
  80920. static readonly ALPHA_ALPHATOCOLOR: number;
  80921. /**
  80922. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  80923. */
  80924. static readonly ALPHA_REVERSEONEMINUS: number;
  80925. /**
  80926. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  80927. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  80928. */
  80929. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  80930. /**
  80931. * Defines that alpha blending is SRC + DST
  80932. * Alpha will be set to SRC ALPHA
  80933. */
  80934. static readonly ALPHA_ONEONE_ONEZERO: number;
  80935. /**
  80936. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  80937. * Alpha will be set to DST ALPHA
  80938. */
  80939. static readonly ALPHA_EXCLUSION: number;
  80940. /** Defines that alpha blending equation a SUM */
  80941. static readonly ALPHA_EQUATION_ADD: number;
  80942. /** Defines that alpha blending equation a SUBSTRACTION */
  80943. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  80944. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  80945. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  80946. /** Defines that alpha blending equation a MAX operation */
  80947. static readonly ALPHA_EQUATION_MAX: number;
  80948. /** Defines that alpha blending equation a MIN operation */
  80949. static readonly ALPHA_EQUATION_MIN: number;
  80950. /**
  80951. * Defines that alpha blending equation a DARKEN operation:
  80952. * It takes the min of the src and sums the alpha channels.
  80953. */
  80954. static readonly ALPHA_EQUATION_DARKEN: number;
  80955. /** Defines that the ressource is not delayed*/
  80956. static readonly DELAYLOADSTATE_NONE: number;
  80957. /** Defines that the ressource was successfully delay loaded */
  80958. static readonly DELAYLOADSTATE_LOADED: number;
  80959. /** Defines that the ressource is currently delay loading */
  80960. static readonly DELAYLOADSTATE_LOADING: number;
  80961. /** Defines that the ressource is delayed and has not started loading */
  80962. static readonly DELAYLOADSTATE_NOTLOADED: number;
  80963. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  80964. static readonly NEVER: number;
  80965. /** 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 */
  80966. static readonly ALWAYS: number;
  80967. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  80968. static readonly LESS: number;
  80969. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  80970. static readonly EQUAL: number;
  80971. /** 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 */
  80972. static readonly LEQUAL: number;
  80973. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  80974. static readonly GREATER: number;
  80975. /** 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 */
  80976. static readonly GEQUAL: number;
  80977. /** 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 */
  80978. static readonly NOTEQUAL: number;
  80979. /** Passed to stencilOperation to specify that stencil value must be kept */
  80980. static readonly KEEP: number;
  80981. /** Passed to stencilOperation to specify that stencil value must be replaced */
  80982. static readonly REPLACE: number;
  80983. /** Passed to stencilOperation to specify that stencil value must be incremented */
  80984. static readonly INCR: number;
  80985. /** Passed to stencilOperation to specify that stencil value must be decremented */
  80986. static readonly DECR: number;
  80987. /** Passed to stencilOperation to specify that stencil value must be inverted */
  80988. static readonly INVERT: number;
  80989. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  80990. static readonly INCR_WRAP: number;
  80991. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  80992. static readonly DECR_WRAP: number;
  80993. /** Texture is not repeating outside of 0..1 UVs */
  80994. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  80995. /** Texture is repeating outside of 0..1 UVs */
  80996. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  80997. /** Texture is repeating and mirrored */
  80998. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  80999. /** ALPHA */
  81000. static readonly TEXTUREFORMAT_ALPHA: number;
  81001. /** LUMINANCE */
  81002. static readonly TEXTUREFORMAT_LUMINANCE: number;
  81003. /** LUMINANCE_ALPHA */
  81004. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  81005. /** RGB */
  81006. static readonly TEXTUREFORMAT_RGB: number;
  81007. /** RGBA */
  81008. static readonly TEXTUREFORMAT_RGBA: number;
  81009. /** RED */
  81010. static readonly TEXTUREFORMAT_RED: number;
  81011. /** RED (2nd reference) */
  81012. static readonly TEXTUREFORMAT_R: number;
  81013. /** RG */
  81014. static readonly TEXTUREFORMAT_RG: number;
  81015. /** RED_INTEGER */
  81016. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  81017. /** RED_INTEGER (2nd reference) */
  81018. static readonly TEXTUREFORMAT_R_INTEGER: number;
  81019. /** RG_INTEGER */
  81020. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  81021. /** RGB_INTEGER */
  81022. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  81023. /** RGBA_INTEGER */
  81024. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  81025. /** UNSIGNED_BYTE */
  81026. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  81027. /** UNSIGNED_BYTE (2nd reference) */
  81028. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  81029. /** FLOAT */
  81030. static readonly TEXTURETYPE_FLOAT: number;
  81031. /** HALF_FLOAT */
  81032. static readonly TEXTURETYPE_HALF_FLOAT: number;
  81033. /** BYTE */
  81034. static readonly TEXTURETYPE_BYTE: number;
  81035. /** SHORT */
  81036. static readonly TEXTURETYPE_SHORT: number;
  81037. /** UNSIGNED_SHORT */
  81038. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  81039. /** INT */
  81040. static readonly TEXTURETYPE_INT: number;
  81041. /** UNSIGNED_INT */
  81042. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  81043. /** UNSIGNED_SHORT_4_4_4_4 */
  81044. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  81045. /** UNSIGNED_SHORT_5_5_5_1 */
  81046. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  81047. /** UNSIGNED_SHORT_5_6_5 */
  81048. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  81049. /** UNSIGNED_INT_2_10_10_10_REV */
  81050. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  81051. /** UNSIGNED_INT_24_8 */
  81052. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  81053. /** UNSIGNED_INT_10F_11F_11F_REV */
  81054. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  81055. /** UNSIGNED_INT_5_9_9_9_REV */
  81056. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  81057. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  81058. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  81059. /** nearest is mag = nearest and min = nearest and no mip */
  81060. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  81061. /** mag = nearest and min = nearest and mip = none */
  81062. static readonly TEXTURE_NEAREST_NEAREST: number;
  81063. /** Bilinear is mag = linear and min = linear and no mip */
  81064. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  81065. /** mag = linear and min = linear and mip = none */
  81066. static readonly TEXTURE_LINEAR_LINEAR: number;
  81067. /** Trilinear is mag = linear and min = linear and mip = linear */
  81068. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  81069. /** Trilinear is mag = linear and min = linear and mip = linear */
  81070. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  81071. /** mag = nearest and min = nearest and mip = nearest */
  81072. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  81073. /** mag = nearest and min = linear and mip = nearest */
  81074. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  81075. /** mag = nearest and min = linear and mip = linear */
  81076. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  81077. /** mag = nearest and min = linear and mip = none */
  81078. static readonly TEXTURE_NEAREST_LINEAR: number;
  81079. /** nearest is mag = nearest and min = nearest and mip = linear */
  81080. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  81081. /** mag = linear and min = nearest and mip = nearest */
  81082. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  81083. /** mag = linear and min = nearest and mip = linear */
  81084. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  81085. /** Bilinear is mag = linear and min = linear and mip = nearest */
  81086. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  81087. /** mag = linear and min = nearest and mip = none */
  81088. static readonly TEXTURE_LINEAR_NEAREST: number;
  81089. /** Explicit coordinates mode */
  81090. static readonly TEXTURE_EXPLICIT_MODE: number;
  81091. /** Spherical coordinates mode */
  81092. static readonly TEXTURE_SPHERICAL_MODE: number;
  81093. /** Planar coordinates mode */
  81094. static readonly TEXTURE_PLANAR_MODE: number;
  81095. /** Cubic coordinates mode */
  81096. static readonly TEXTURE_CUBIC_MODE: number;
  81097. /** Projection coordinates mode */
  81098. static readonly TEXTURE_PROJECTION_MODE: number;
  81099. /** Skybox coordinates mode */
  81100. static readonly TEXTURE_SKYBOX_MODE: number;
  81101. /** Inverse Cubic coordinates mode */
  81102. static readonly TEXTURE_INVCUBIC_MODE: number;
  81103. /** Equirectangular coordinates mode */
  81104. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  81105. /** Equirectangular Fixed coordinates mode */
  81106. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  81107. /** Equirectangular Fixed Mirrored coordinates mode */
  81108. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  81109. /** Offline (baking) quality for texture filtering */
  81110. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  81111. /** High quality for texture filtering */
  81112. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  81113. /** Medium quality for texture filtering */
  81114. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  81115. /** Low quality for texture filtering */
  81116. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  81117. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  81118. static readonly SCALEMODE_FLOOR: number;
  81119. /** Defines that texture rescaling will look for the nearest power of 2 size */
  81120. static readonly SCALEMODE_NEAREST: number;
  81121. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  81122. static readonly SCALEMODE_CEILING: number;
  81123. /**
  81124. * The dirty texture flag value
  81125. */
  81126. static readonly MATERIAL_TextureDirtyFlag: number;
  81127. /**
  81128. * The dirty light flag value
  81129. */
  81130. static readonly MATERIAL_LightDirtyFlag: number;
  81131. /**
  81132. * The dirty fresnel flag value
  81133. */
  81134. static readonly MATERIAL_FresnelDirtyFlag: number;
  81135. /**
  81136. * The dirty attribute flag value
  81137. */
  81138. static readonly MATERIAL_AttributesDirtyFlag: number;
  81139. /**
  81140. * The dirty misc flag value
  81141. */
  81142. static readonly MATERIAL_MiscDirtyFlag: number;
  81143. /**
  81144. * The all dirty flag value
  81145. */
  81146. static readonly MATERIAL_AllDirtyFlag: number;
  81147. /**
  81148. * Returns the triangle fill mode
  81149. */
  81150. static readonly MATERIAL_TriangleFillMode: number;
  81151. /**
  81152. * Returns the wireframe mode
  81153. */
  81154. static readonly MATERIAL_WireFrameFillMode: number;
  81155. /**
  81156. * Returns the point fill mode
  81157. */
  81158. static readonly MATERIAL_PointFillMode: number;
  81159. /**
  81160. * Returns the point list draw mode
  81161. */
  81162. static readonly MATERIAL_PointListDrawMode: number;
  81163. /**
  81164. * Returns the line list draw mode
  81165. */
  81166. static readonly MATERIAL_LineListDrawMode: number;
  81167. /**
  81168. * Returns the line loop draw mode
  81169. */
  81170. static readonly MATERIAL_LineLoopDrawMode: number;
  81171. /**
  81172. * Returns the line strip draw mode
  81173. */
  81174. static readonly MATERIAL_LineStripDrawMode: number;
  81175. /**
  81176. * Returns the triangle strip draw mode
  81177. */
  81178. static readonly MATERIAL_TriangleStripDrawMode: number;
  81179. /**
  81180. * Returns the triangle fan draw mode
  81181. */
  81182. static readonly MATERIAL_TriangleFanDrawMode: number;
  81183. /**
  81184. * Stores the clock-wise side orientation
  81185. */
  81186. static readonly MATERIAL_ClockWiseSideOrientation: number;
  81187. /**
  81188. * Stores the counter clock-wise side orientation
  81189. */
  81190. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  81191. /**
  81192. * Nothing
  81193. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81194. */
  81195. static readonly ACTION_NothingTrigger: number;
  81196. /**
  81197. * On pick
  81198. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81199. */
  81200. static readonly ACTION_OnPickTrigger: number;
  81201. /**
  81202. * On left pick
  81203. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81204. */
  81205. static readonly ACTION_OnLeftPickTrigger: number;
  81206. /**
  81207. * On right pick
  81208. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81209. */
  81210. static readonly ACTION_OnRightPickTrigger: number;
  81211. /**
  81212. * On center pick
  81213. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81214. */
  81215. static readonly ACTION_OnCenterPickTrigger: number;
  81216. /**
  81217. * On pick down
  81218. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81219. */
  81220. static readonly ACTION_OnPickDownTrigger: number;
  81221. /**
  81222. * On double pick
  81223. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81224. */
  81225. static readonly ACTION_OnDoublePickTrigger: number;
  81226. /**
  81227. * On pick up
  81228. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81229. */
  81230. static readonly ACTION_OnPickUpTrigger: number;
  81231. /**
  81232. * On pick out.
  81233. * This trigger will only be raised if you also declared a OnPickDown
  81234. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81235. */
  81236. static readonly ACTION_OnPickOutTrigger: number;
  81237. /**
  81238. * On long press
  81239. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81240. */
  81241. static readonly ACTION_OnLongPressTrigger: number;
  81242. /**
  81243. * On pointer over
  81244. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81245. */
  81246. static readonly ACTION_OnPointerOverTrigger: number;
  81247. /**
  81248. * On pointer out
  81249. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81250. */
  81251. static readonly ACTION_OnPointerOutTrigger: number;
  81252. /**
  81253. * On every frame
  81254. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81255. */
  81256. static readonly ACTION_OnEveryFrameTrigger: number;
  81257. /**
  81258. * On intersection enter
  81259. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81260. */
  81261. static readonly ACTION_OnIntersectionEnterTrigger: number;
  81262. /**
  81263. * On intersection exit
  81264. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81265. */
  81266. static readonly ACTION_OnIntersectionExitTrigger: number;
  81267. /**
  81268. * On key down
  81269. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81270. */
  81271. static readonly ACTION_OnKeyDownTrigger: number;
  81272. /**
  81273. * On key up
  81274. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  81275. */
  81276. static readonly ACTION_OnKeyUpTrigger: number;
  81277. /**
  81278. * Billboard mode will only apply to Y axis
  81279. */
  81280. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  81281. /**
  81282. * Billboard mode will apply to all axes
  81283. */
  81284. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  81285. /**
  81286. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  81287. */
  81288. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  81289. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  81290. * Test order :
  81291. * Is the bounding sphere outside the frustum ?
  81292. * If not, are the bounding box vertices outside the frustum ?
  81293. * It not, then the cullable object is in the frustum.
  81294. */
  81295. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  81296. /** Culling strategy : Bounding Sphere Only.
  81297. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  81298. * It's also less accurate than the standard because some not visible objects can still be selected.
  81299. * Test : is the bounding sphere outside the frustum ?
  81300. * If not, then the cullable object is in the frustum.
  81301. */
  81302. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  81303. /** Culling strategy : Optimistic Inclusion.
  81304. * This in an inclusion test first, then the standard exclusion test.
  81305. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  81306. * 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.
  81307. * Anyway, it's as accurate as the standard strategy.
  81308. * Test :
  81309. * Is the cullable object bounding sphere center in the frustum ?
  81310. * If not, apply the default culling strategy.
  81311. */
  81312. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  81313. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  81314. * This in an inclusion test first, then the bounding sphere only exclusion test.
  81315. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  81316. * 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.
  81317. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  81318. * Test :
  81319. * Is the cullable object bounding sphere center in the frustum ?
  81320. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  81321. */
  81322. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  81323. /**
  81324. * No logging while loading
  81325. */
  81326. static readonly SCENELOADER_NO_LOGGING: number;
  81327. /**
  81328. * Minimal logging while loading
  81329. */
  81330. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  81331. /**
  81332. * Summary logging while loading
  81333. */
  81334. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  81335. /**
  81336. * Detailled logging while loading
  81337. */
  81338. static readonly SCENELOADER_DETAILED_LOGGING: number;
  81339. /**
  81340. * Constant used to retrieve the irradiance texture index in the textures array in the prepass
  81341. * using getIndex(Constants.PREPASS_IRRADIANCE_TEXTURE_TYPE)
  81342. */
  81343. static readonly PREPASS_IRRADIANCE_TEXTURE_TYPE: number;
  81344. /**
  81345. * Constant used to retrieve the position texture index in the textures array in the prepass
  81346. * using getIndex(Constants.PREPASS_POSITION_TEXTURE_INDEX)
  81347. */
  81348. static readonly PREPASS_POSITION_TEXTURE_TYPE: number;
  81349. /**
  81350. * Constant used to retrieve the velocity texture index in the textures array in the prepass
  81351. * using getIndex(Constants.PREPASS_VELOCITY_TEXTURE_INDEX)
  81352. */
  81353. static readonly PREPASS_VELOCITY_TEXTURE_TYPE: number;
  81354. /**
  81355. * Constant used to retrieve the reflectivity texture index in the textures array in the prepass
  81356. * using the getIndex(Constants.PREPASS_REFLECTIVITY_TEXTURE_TYPE)
  81357. */
  81358. static readonly PREPASS_REFLECTIVITY_TEXTURE_TYPE: number;
  81359. /**
  81360. * Constant used to retrieve the lit color texture index in the textures array in the prepass
  81361. * using the getIndex(Constants.PREPASS_COLOR_TEXTURE_TYPE)
  81362. */
  81363. static readonly PREPASS_COLOR_TEXTURE_TYPE: number;
  81364. /**
  81365. * Constant used to retrieve depth + normal index in the textures array in the prepass
  81366. * using the getIndex(Constants.PREPASS_DEPTHNORMAL_TEXTURE_TYPE)
  81367. */
  81368. static readonly PREPASS_DEPTHNORMAL_TEXTURE_TYPE: number;
  81369. /**
  81370. * Constant used to retrieve albedo index in the textures array in the prepass
  81371. * using the getIndex(Constants.PREPASS_ALBEDO_TEXTURE_TYPE)
  81372. */
  81373. static readonly PREPASS_ALBEDO_TEXTURE_TYPE: number;
  81374. }
  81375. }
  81376. declare module BABYLON {
  81377. /**
  81378. * This represents the required contract to create a new type of texture loader.
  81379. */
  81380. export interface IInternalTextureLoader {
  81381. /**
  81382. * Defines wether the loader supports cascade loading the different faces.
  81383. */
  81384. supportCascades: boolean;
  81385. /**
  81386. * This returns if the loader support the current file information.
  81387. * @param extension defines the file extension of the file being loaded
  81388. * @param mimeType defines the optional mime type of the file being loaded
  81389. * @returns true if the loader can load the specified file
  81390. */
  81391. canLoad(extension: string, mimeType?: string): boolean;
  81392. /**
  81393. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  81394. * @param data contains the texture data
  81395. * @param texture defines the BabylonJS internal texture
  81396. * @param createPolynomials will be true if polynomials have been requested
  81397. * @param onLoad defines the callback to trigger once the texture is ready
  81398. * @param onError defines the callback to trigger in case of error
  81399. */
  81400. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  81401. /**
  81402. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  81403. * @param data contains the texture data
  81404. * @param texture defines the BabylonJS internal texture
  81405. * @param callback defines the method to call once ready to upload
  81406. */
  81407. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  81408. }
  81409. }
  81410. declare module BABYLON {
  81411. /**
  81412. * Class used to store and describe the pipeline context associated with an effect
  81413. */
  81414. export interface IPipelineContext {
  81415. /**
  81416. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  81417. */
  81418. isAsync: boolean;
  81419. /**
  81420. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  81421. */
  81422. isReady: boolean;
  81423. /** @hidden */
  81424. _getVertexShaderCode(): string | null;
  81425. /** @hidden */
  81426. _getFragmentShaderCode(): string | null;
  81427. /** @hidden */
  81428. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  81429. }
  81430. }
  81431. declare module BABYLON {
  81432. /**
  81433. * Class used to store gfx data (like WebGLBuffer)
  81434. */
  81435. export class DataBuffer {
  81436. /**
  81437. * Gets or sets the number of objects referencing this buffer
  81438. */
  81439. references: number;
  81440. /** Gets or sets the size of the underlying buffer */
  81441. capacity: number;
  81442. /**
  81443. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  81444. */
  81445. is32Bits: boolean;
  81446. /**
  81447. * Gets the underlying buffer
  81448. */
  81449. get underlyingResource(): any;
  81450. }
  81451. }
  81452. declare module BABYLON {
  81453. /** @hidden */
  81454. export interface IShaderProcessor {
  81455. attributeProcessor?: (attribute: string) => string;
  81456. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  81457. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  81458. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  81459. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  81460. lineProcessor?: (line: string, isFragment: boolean) => string;
  81461. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  81462. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  81463. }
  81464. }
  81465. declare module BABYLON {
  81466. /** @hidden */
  81467. export interface ProcessingOptions {
  81468. defines: string[];
  81469. indexParameters: any;
  81470. isFragment: boolean;
  81471. shouldUseHighPrecisionShader: boolean;
  81472. supportsUniformBuffers: boolean;
  81473. shadersRepository: string;
  81474. includesShadersStore: {
  81475. [key: string]: string;
  81476. };
  81477. processor?: IShaderProcessor;
  81478. version: string;
  81479. platformName: string;
  81480. lookForClosingBracketForUniformBuffer?: boolean;
  81481. }
  81482. }
  81483. declare module BABYLON {
  81484. /** @hidden */
  81485. export class ShaderCodeNode {
  81486. line: string;
  81487. children: ShaderCodeNode[];
  81488. additionalDefineKey?: string;
  81489. additionalDefineValue?: string;
  81490. isValid(preprocessors: {
  81491. [key: string]: string;
  81492. }): boolean;
  81493. process(preprocessors: {
  81494. [key: string]: string;
  81495. }, options: ProcessingOptions): string;
  81496. }
  81497. }
  81498. declare module BABYLON {
  81499. /** @hidden */
  81500. export class ShaderCodeCursor {
  81501. private _lines;
  81502. lineIndex: number;
  81503. get currentLine(): string;
  81504. get canRead(): boolean;
  81505. set lines(value: string[]);
  81506. }
  81507. }
  81508. declare module BABYLON {
  81509. /** @hidden */
  81510. export class ShaderCodeConditionNode extends ShaderCodeNode {
  81511. process(preprocessors: {
  81512. [key: string]: string;
  81513. }, options: ProcessingOptions): string;
  81514. }
  81515. }
  81516. declare module BABYLON {
  81517. /** @hidden */
  81518. export class ShaderDefineExpression {
  81519. isTrue(preprocessors: {
  81520. [key: string]: string;
  81521. }): boolean;
  81522. private static _OperatorPriority;
  81523. private static _Stack;
  81524. static postfixToInfix(postfix: string[]): string;
  81525. static infixToPostfix(infix: string): string[];
  81526. }
  81527. }
  81528. declare module BABYLON {
  81529. /** @hidden */
  81530. export class ShaderCodeTestNode extends ShaderCodeNode {
  81531. testExpression: ShaderDefineExpression;
  81532. isValid(preprocessors: {
  81533. [key: string]: string;
  81534. }): boolean;
  81535. }
  81536. }
  81537. declare module BABYLON {
  81538. /** @hidden */
  81539. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  81540. define: string;
  81541. not: boolean;
  81542. constructor(define: string, not?: boolean);
  81543. isTrue(preprocessors: {
  81544. [key: string]: string;
  81545. }): boolean;
  81546. }
  81547. }
  81548. declare module BABYLON {
  81549. /** @hidden */
  81550. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  81551. leftOperand: ShaderDefineExpression;
  81552. rightOperand: ShaderDefineExpression;
  81553. isTrue(preprocessors: {
  81554. [key: string]: string;
  81555. }): boolean;
  81556. }
  81557. }
  81558. declare module BABYLON {
  81559. /** @hidden */
  81560. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  81561. leftOperand: ShaderDefineExpression;
  81562. rightOperand: ShaderDefineExpression;
  81563. isTrue(preprocessors: {
  81564. [key: string]: string;
  81565. }): boolean;
  81566. }
  81567. }
  81568. declare module BABYLON {
  81569. /** @hidden */
  81570. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  81571. define: string;
  81572. operand: string;
  81573. testValue: string;
  81574. constructor(define: string, operand: string, testValue: string);
  81575. isTrue(preprocessors: {
  81576. [key: string]: string;
  81577. }): boolean;
  81578. }
  81579. }
  81580. declare module BABYLON {
  81581. /**
  81582. * Class used to enable access to offline support
  81583. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  81584. */
  81585. export interface IOfflineProvider {
  81586. /**
  81587. * Gets a boolean indicating if scene must be saved in the database
  81588. */
  81589. enableSceneOffline: boolean;
  81590. /**
  81591. * Gets a boolean indicating if textures must be saved in the database
  81592. */
  81593. enableTexturesOffline: boolean;
  81594. /**
  81595. * Open the offline support and make it available
  81596. * @param successCallback defines the callback to call on success
  81597. * @param errorCallback defines the callback to call on error
  81598. */
  81599. open(successCallback: () => void, errorCallback: () => void): void;
  81600. /**
  81601. * Loads an image from the offline support
  81602. * @param url defines the url to load from
  81603. * @param image defines the target DOM image
  81604. */
  81605. loadImage(url: string, image: HTMLImageElement): void;
  81606. /**
  81607. * Loads a file from offline support
  81608. * @param url defines the URL to load from
  81609. * @param sceneLoaded defines a callback to call on success
  81610. * @param progressCallBack defines a callback to call when progress changed
  81611. * @param errorCallback defines a callback to call on error
  81612. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  81613. */
  81614. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  81615. }
  81616. }
  81617. declare module BABYLON {
  81618. /**
  81619. * Class used to help managing file picking and drag'n'drop
  81620. * File Storage
  81621. */
  81622. export class FilesInputStore {
  81623. /**
  81624. * List of files ready to be loaded
  81625. */
  81626. static FilesToLoad: {
  81627. [key: string]: File;
  81628. };
  81629. }
  81630. }
  81631. declare module BABYLON {
  81632. /**
  81633. * Class used to define a retry strategy when error happens while loading assets
  81634. */
  81635. export class RetryStrategy {
  81636. /**
  81637. * Function used to defines an exponential back off strategy
  81638. * @param maxRetries defines the maximum number of retries (3 by default)
  81639. * @param baseInterval defines the interval between retries
  81640. * @returns the strategy function to use
  81641. */
  81642. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  81643. }
  81644. }
  81645. declare module BABYLON {
  81646. /**
  81647. * @ignore
  81648. * Application error to support additional information when loading a file
  81649. */
  81650. export abstract class BaseError extends Error {
  81651. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  81652. }
  81653. }
  81654. declare module BABYLON {
  81655. /** @ignore */
  81656. export class LoadFileError extends BaseError {
  81657. request?: WebRequest;
  81658. file?: File;
  81659. /**
  81660. * Creates a new LoadFileError
  81661. * @param message defines the message of the error
  81662. * @param request defines the optional web request
  81663. * @param file defines the optional file
  81664. */
  81665. constructor(message: string, object?: WebRequest | File);
  81666. }
  81667. /** @ignore */
  81668. export class RequestFileError extends BaseError {
  81669. request: WebRequest;
  81670. /**
  81671. * Creates a new LoadFileError
  81672. * @param message defines the message of the error
  81673. * @param request defines the optional web request
  81674. */
  81675. constructor(message: string, request: WebRequest);
  81676. }
  81677. /** @ignore */
  81678. export class ReadFileError extends BaseError {
  81679. file: File;
  81680. /**
  81681. * Creates a new ReadFileError
  81682. * @param message defines the message of the error
  81683. * @param file defines the optional file
  81684. */
  81685. constructor(message: string, file: File);
  81686. }
  81687. /**
  81688. * @hidden
  81689. */
  81690. export class FileTools {
  81691. /**
  81692. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  81693. */
  81694. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  81695. /**
  81696. * Gets or sets the base URL to use to load assets
  81697. */
  81698. static BaseUrl: string;
  81699. /**
  81700. * Default behaviour for cors in the application.
  81701. * It can be a string if the expected behavior is identical in the entire app.
  81702. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  81703. */
  81704. static CorsBehavior: string | ((url: string | string[]) => string);
  81705. /**
  81706. * Gets or sets a function used to pre-process url before using them to load assets
  81707. */
  81708. static PreprocessUrl: (url: string) => string;
  81709. /**
  81710. * Removes unwanted characters from an url
  81711. * @param url defines the url to clean
  81712. * @returns the cleaned url
  81713. */
  81714. private static _CleanUrl;
  81715. /**
  81716. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  81717. * @param url define the url we are trying
  81718. * @param element define the dom element where to configure the cors policy
  81719. */
  81720. static SetCorsBehavior(url: string | string[], element: {
  81721. crossOrigin: string | null;
  81722. }): void;
  81723. /**
  81724. * Loads an image as an HTMLImageElement.
  81725. * @param input url string, ArrayBuffer, or Blob to load
  81726. * @param onLoad callback called when the image successfully loads
  81727. * @param onError callback called when the image fails to load
  81728. * @param offlineProvider offline provider for caching
  81729. * @param mimeType optional mime type
  81730. * @returns the HTMLImageElement of the loaded image
  81731. */
  81732. 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>;
  81733. /**
  81734. * Reads a file from a File object
  81735. * @param file defines the file to load
  81736. * @param onSuccess defines the callback to call when data is loaded
  81737. * @param onProgress defines the callback to call during loading process
  81738. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  81739. * @param onError defines the callback to call when an error occurs
  81740. * @returns a file request object
  81741. */
  81742. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  81743. /**
  81744. * Loads a file from a url
  81745. * @param url url to load
  81746. * @param onSuccess callback called when the file successfully loads
  81747. * @param onProgress callback called while file is loading (if the server supports this mode)
  81748. * @param offlineProvider defines the offline provider for caching
  81749. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81750. * @param onError callback called when the file fails to load
  81751. * @returns a file request object
  81752. */
  81753. 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;
  81754. /**
  81755. * Loads a file
  81756. * @param url url to load
  81757. * @param onSuccess callback called when the file successfully loads
  81758. * @param onProgress callback called while file is loading (if the server supports this mode)
  81759. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81760. * @param onError callback called when the file fails to load
  81761. * @param onOpened callback called when the web request is opened
  81762. * @returns a file request object
  81763. */
  81764. 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;
  81765. /**
  81766. * Checks if the loaded document was accessed via `file:`-Protocol.
  81767. * @returns boolean
  81768. */
  81769. static IsFileURL(): boolean;
  81770. }
  81771. }
  81772. declare module BABYLON {
  81773. /** @hidden */
  81774. export class ShaderProcessor {
  81775. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  81776. private static _ProcessPrecision;
  81777. private static _ExtractOperation;
  81778. private static _BuildSubExpression;
  81779. private static _BuildExpression;
  81780. private static _MoveCursorWithinIf;
  81781. private static _MoveCursor;
  81782. private static _EvaluatePreProcessors;
  81783. private static _PreparePreProcessors;
  81784. private static _ProcessShaderConversion;
  81785. private static _ProcessIncludes;
  81786. /**
  81787. * Loads a file from a url
  81788. * @param url url to load
  81789. * @param onSuccess callback called when the file successfully loads
  81790. * @param onProgress callback called while file is loading (if the server supports this mode)
  81791. * @param offlineProvider defines the offline provider for caching
  81792. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81793. * @param onError callback called when the file fails to load
  81794. * @returns a file request object
  81795. * @hidden
  81796. */
  81797. 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;
  81798. }
  81799. }
  81800. declare module BABYLON {
  81801. /**
  81802. * @hidden
  81803. */
  81804. export interface IColor4Like {
  81805. r: float;
  81806. g: float;
  81807. b: float;
  81808. a: float;
  81809. }
  81810. /**
  81811. * @hidden
  81812. */
  81813. export interface IColor3Like {
  81814. r: float;
  81815. g: float;
  81816. b: float;
  81817. }
  81818. /**
  81819. * @hidden
  81820. */
  81821. export interface IVector4Like {
  81822. x: float;
  81823. y: float;
  81824. z: float;
  81825. w: float;
  81826. }
  81827. /**
  81828. * @hidden
  81829. */
  81830. export interface IVector3Like {
  81831. x: float;
  81832. y: float;
  81833. z: float;
  81834. }
  81835. /**
  81836. * @hidden
  81837. */
  81838. export interface IVector2Like {
  81839. x: float;
  81840. y: float;
  81841. }
  81842. /**
  81843. * @hidden
  81844. */
  81845. export interface IMatrixLike {
  81846. toArray(): DeepImmutable<Float32Array | Array<number>>;
  81847. updateFlag: int;
  81848. }
  81849. /**
  81850. * @hidden
  81851. */
  81852. export interface IViewportLike {
  81853. x: float;
  81854. y: float;
  81855. width: float;
  81856. height: float;
  81857. }
  81858. /**
  81859. * @hidden
  81860. */
  81861. export interface IPlaneLike {
  81862. normal: IVector3Like;
  81863. d: float;
  81864. normalize(): void;
  81865. }
  81866. }
  81867. declare module BABYLON {
  81868. /**
  81869. * Interface used to define common properties for effect fallbacks
  81870. */
  81871. export interface IEffectFallbacks {
  81872. /**
  81873. * Removes the defines that should be removed when falling back.
  81874. * @param currentDefines defines the current define statements for the shader.
  81875. * @param effect defines the current effect we try to compile
  81876. * @returns The resulting defines with defines of the current rank removed.
  81877. */
  81878. reduce(currentDefines: string, effect: Effect): string;
  81879. /**
  81880. * Removes the fallback from the bound mesh.
  81881. */
  81882. unBindMesh(): void;
  81883. /**
  81884. * Checks to see if more fallbacks are still availible.
  81885. */
  81886. hasMoreFallbacks: boolean;
  81887. }
  81888. }
  81889. declare module BABYLON {
  81890. /**
  81891. * Class used to evalaute queries containing `and` and `or` operators
  81892. */
  81893. export class AndOrNotEvaluator {
  81894. /**
  81895. * Evaluate a query
  81896. * @param query defines the query to evaluate
  81897. * @param evaluateCallback defines the callback used to filter result
  81898. * @returns true if the query matches
  81899. */
  81900. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  81901. private static _HandleParenthesisContent;
  81902. private static _SimplifyNegation;
  81903. }
  81904. }
  81905. declare module BABYLON {
  81906. /**
  81907. * Class used to store custom tags
  81908. */
  81909. export class Tags {
  81910. /**
  81911. * Adds support for tags on the given object
  81912. * @param obj defines the object to use
  81913. */
  81914. static EnableFor(obj: any): void;
  81915. /**
  81916. * Removes tags support
  81917. * @param obj defines the object to use
  81918. */
  81919. static DisableFor(obj: any): void;
  81920. /**
  81921. * Gets a boolean indicating if the given object has tags
  81922. * @param obj defines the object to use
  81923. * @returns a boolean
  81924. */
  81925. static HasTags(obj: any): boolean;
  81926. /**
  81927. * Gets the tags available on a given object
  81928. * @param obj defines the object to use
  81929. * @param asString defines if the tags must be returned as a string instead of an array of strings
  81930. * @returns the tags
  81931. */
  81932. static GetTags(obj: any, asString?: boolean): any;
  81933. /**
  81934. * Adds tags to an object
  81935. * @param obj defines the object to use
  81936. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  81937. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  81938. */
  81939. static AddTagsTo(obj: any, tagsString: string): void;
  81940. /**
  81941. * @hidden
  81942. */
  81943. static _AddTagTo(obj: any, tag: string): void;
  81944. /**
  81945. * Removes specific tags from a specific object
  81946. * @param obj defines the object to use
  81947. * @param tagsString defines the tags to remove
  81948. */
  81949. static RemoveTagsFrom(obj: any, tagsString: string): void;
  81950. /**
  81951. * @hidden
  81952. */
  81953. static _RemoveTagFrom(obj: any, tag: string): void;
  81954. /**
  81955. * Defines if tags hosted on an object match a given query
  81956. * @param obj defines the object to use
  81957. * @param tagsQuery defines the tag query
  81958. * @returns a boolean
  81959. */
  81960. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  81961. }
  81962. }
  81963. declare module BABYLON {
  81964. /**
  81965. * Scalar computation library
  81966. */
  81967. export class Scalar {
  81968. /**
  81969. * Two pi constants convenient for computation.
  81970. */
  81971. static TwoPi: number;
  81972. /**
  81973. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  81974. * @param a number
  81975. * @param b number
  81976. * @param epsilon (default = 1.401298E-45)
  81977. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  81978. */
  81979. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  81980. /**
  81981. * Returns a string : the upper case translation of the number i to hexadecimal.
  81982. * @param i number
  81983. * @returns the upper case translation of the number i to hexadecimal.
  81984. */
  81985. static ToHex(i: number): string;
  81986. /**
  81987. * Returns -1 if value is negative and +1 is value is positive.
  81988. * @param value the value
  81989. * @returns the value itself if it's equal to zero.
  81990. */
  81991. static Sign(value: number): number;
  81992. /**
  81993. * Returns the value itself if it's between min and max.
  81994. * Returns min if the value is lower than min.
  81995. * Returns max if the value is greater than max.
  81996. * @param value the value to clmap
  81997. * @param min the min value to clamp to (default: 0)
  81998. * @param max the max value to clamp to (default: 1)
  81999. * @returns the clamped value
  82000. */
  82001. static Clamp(value: number, min?: number, max?: number): number;
  82002. /**
  82003. * the log2 of value.
  82004. * @param value the value to compute log2 of
  82005. * @returns the log2 of value.
  82006. */
  82007. static Log2(value: number): number;
  82008. /**
  82009. * Loops the value, so that it is never larger than length and never smaller than 0.
  82010. *
  82011. * This is similar to the modulo operator but it works with floating point numbers.
  82012. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  82013. * With t = 5 and length = 2.5, the result would be 0.0.
  82014. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  82015. * @param value the value
  82016. * @param length the length
  82017. * @returns the looped value
  82018. */
  82019. static Repeat(value: number, length: number): number;
  82020. /**
  82021. * Normalize the value between 0.0 and 1.0 using min and max values
  82022. * @param value value to normalize
  82023. * @param min max to normalize between
  82024. * @param max min to normalize between
  82025. * @returns the normalized value
  82026. */
  82027. static Normalize(value: number, min: number, max: number): number;
  82028. /**
  82029. * Denormalize the value from 0.0 and 1.0 using min and max values
  82030. * @param normalized value to denormalize
  82031. * @param min max to denormalize between
  82032. * @param max min to denormalize between
  82033. * @returns the denormalized value
  82034. */
  82035. static Denormalize(normalized: number, min: number, max: number): number;
  82036. /**
  82037. * Calculates the shortest difference between two given angles given in degrees.
  82038. * @param current current angle in degrees
  82039. * @param target target angle in degrees
  82040. * @returns the delta
  82041. */
  82042. static DeltaAngle(current: number, target: number): number;
  82043. /**
  82044. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  82045. * @param tx value
  82046. * @param length length
  82047. * @returns The returned value will move back and forth between 0 and length
  82048. */
  82049. static PingPong(tx: number, length: number): number;
  82050. /**
  82051. * Interpolates between min and max with smoothing at the limits.
  82052. *
  82053. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  82054. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  82055. * @param from from
  82056. * @param to to
  82057. * @param tx value
  82058. * @returns the smooth stepped value
  82059. */
  82060. static SmoothStep(from: number, to: number, tx: number): number;
  82061. /**
  82062. * Moves a value current towards target.
  82063. *
  82064. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  82065. * Negative values of maxDelta pushes the value away from target.
  82066. * @param current current value
  82067. * @param target target value
  82068. * @param maxDelta max distance to move
  82069. * @returns resulting value
  82070. */
  82071. static MoveTowards(current: number, target: number, maxDelta: number): number;
  82072. /**
  82073. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  82074. *
  82075. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  82076. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  82077. * @param current current value
  82078. * @param target target value
  82079. * @param maxDelta max distance to move
  82080. * @returns resulting angle
  82081. */
  82082. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  82083. /**
  82084. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  82085. * @param start start value
  82086. * @param end target value
  82087. * @param amount amount to lerp between
  82088. * @returns the lerped value
  82089. */
  82090. static Lerp(start: number, end: number, amount: number): number;
  82091. /**
  82092. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  82093. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  82094. * @param start start value
  82095. * @param end target value
  82096. * @param amount amount to lerp between
  82097. * @returns the lerped value
  82098. */
  82099. static LerpAngle(start: number, end: number, amount: number): number;
  82100. /**
  82101. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  82102. * @param a start value
  82103. * @param b target value
  82104. * @param value value between a and b
  82105. * @returns the inverseLerp value
  82106. */
  82107. static InverseLerp(a: number, b: number, value: number): number;
  82108. /**
  82109. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  82110. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  82111. * @param value1 spline value
  82112. * @param tangent1 spline value
  82113. * @param value2 spline value
  82114. * @param tangent2 spline value
  82115. * @param amount input value
  82116. * @returns hermite result
  82117. */
  82118. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  82119. /**
  82120. * Returns a random float number between and min and max values
  82121. * @param min min value of random
  82122. * @param max max value of random
  82123. * @returns random value
  82124. */
  82125. static RandomRange(min: number, max: number): number;
  82126. /**
  82127. * This function returns percentage of a number in a given range.
  82128. *
  82129. * RangeToPercent(40,20,60) will return 0.5 (50%)
  82130. * RangeToPercent(34,0,100) will return 0.34 (34%)
  82131. * @param number to convert to percentage
  82132. * @param min min range
  82133. * @param max max range
  82134. * @returns the percentage
  82135. */
  82136. static RangeToPercent(number: number, min: number, max: number): number;
  82137. /**
  82138. * This function returns number that corresponds to the percentage in a given range.
  82139. *
  82140. * PercentToRange(0.34,0,100) will return 34.
  82141. * @param percent to convert to number
  82142. * @param min min range
  82143. * @param max max range
  82144. * @returns the number
  82145. */
  82146. static PercentToRange(percent: number, min: number, max: number): number;
  82147. /**
  82148. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  82149. * @param angle The angle to normalize in radian.
  82150. * @return The converted angle.
  82151. */
  82152. static NormalizeRadians(angle: number): number;
  82153. }
  82154. }
  82155. declare module BABYLON {
  82156. /**
  82157. * Constant used to convert a value to gamma space
  82158. * @ignorenaming
  82159. */
  82160. export const ToGammaSpace: number;
  82161. /**
  82162. * Constant used to convert a value to linear space
  82163. * @ignorenaming
  82164. */
  82165. export const ToLinearSpace = 2.2;
  82166. /**
  82167. * Constant used to define the minimal number value in Babylon.js
  82168. * @ignorenaming
  82169. */
  82170. let Epsilon: number;
  82171. }
  82172. declare module BABYLON {
  82173. /**
  82174. * Class used to represent a viewport on screen
  82175. */
  82176. export class Viewport {
  82177. /** viewport left coordinate */
  82178. x: number;
  82179. /** viewport top coordinate */
  82180. y: number;
  82181. /**viewport width */
  82182. width: number;
  82183. /** viewport height */
  82184. height: number;
  82185. /**
  82186. * Creates a Viewport object located at (x, y) and sized (width, height)
  82187. * @param x defines viewport left coordinate
  82188. * @param y defines viewport top coordinate
  82189. * @param width defines the viewport width
  82190. * @param height defines the viewport height
  82191. */
  82192. constructor(
  82193. /** viewport left coordinate */
  82194. x: number,
  82195. /** viewport top coordinate */
  82196. y: number,
  82197. /**viewport width */
  82198. width: number,
  82199. /** viewport height */
  82200. height: number);
  82201. /**
  82202. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  82203. * @param renderWidth defines the rendering width
  82204. * @param renderHeight defines the rendering height
  82205. * @returns a new Viewport
  82206. */
  82207. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  82208. /**
  82209. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  82210. * @param renderWidth defines the rendering width
  82211. * @param renderHeight defines the rendering height
  82212. * @param ref defines the target viewport
  82213. * @returns the current viewport
  82214. */
  82215. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  82216. /**
  82217. * Returns a new Viewport copied from the current one
  82218. * @returns a new Viewport
  82219. */
  82220. clone(): Viewport;
  82221. }
  82222. }
  82223. declare module BABYLON {
  82224. /**
  82225. * Class containing a set of static utilities functions for arrays.
  82226. */
  82227. export class ArrayTools {
  82228. /**
  82229. * Returns an array of the given size filled with element built from the given constructor and the paramters
  82230. * @param size the number of element to construct and put in the array
  82231. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  82232. * @returns a new array filled with new objects
  82233. */
  82234. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  82235. }
  82236. }
  82237. declare module BABYLON {
  82238. /**
  82239. * Represents a plane by the equation ax + by + cz + d = 0
  82240. */
  82241. export class Plane {
  82242. private static _TmpMatrix;
  82243. /**
  82244. * Normal of the plane (a,b,c)
  82245. */
  82246. normal: Vector3;
  82247. /**
  82248. * d component of the plane
  82249. */
  82250. d: number;
  82251. /**
  82252. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  82253. * @param a a component of the plane
  82254. * @param b b component of the plane
  82255. * @param c c component of the plane
  82256. * @param d d component of the plane
  82257. */
  82258. constructor(a: number, b: number, c: number, d: number);
  82259. /**
  82260. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  82261. */
  82262. asArray(): number[];
  82263. /**
  82264. * @returns a new plane copied from the current Plane.
  82265. */
  82266. clone(): Plane;
  82267. /**
  82268. * @returns the string "Plane".
  82269. */
  82270. getClassName(): string;
  82271. /**
  82272. * @returns the Plane hash code.
  82273. */
  82274. getHashCode(): number;
  82275. /**
  82276. * Normalize the current Plane in place.
  82277. * @returns the updated Plane.
  82278. */
  82279. normalize(): Plane;
  82280. /**
  82281. * Applies a transformation the plane and returns the result
  82282. * @param transformation the transformation matrix to be applied to the plane
  82283. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  82284. */
  82285. transform(transformation: DeepImmutable<Matrix>): Plane;
  82286. /**
  82287. * Compute the dot product between the point and the plane normal
  82288. * @param point point to calculate the dot product with
  82289. * @returns the dot product (float) of the point coordinates and the plane normal.
  82290. */
  82291. dotCoordinate(point: DeepImmutable<Vector3>): number;
  82292. /**
  82293. * Updates the current Plane from the plane defined by the three given points.
  82294. * @param point1 one of the points used to contruct the plane
  82295. * @param point2 one of the points used to contruct the plane
  82296. * @param point3 one of the points used to contruct the plane
  82297. * @returns the updated Plane.
  82298. */
  82299. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  82300. /**
  82301. * Checks if the plane is facing a given direction
  82302. * @param direction the direction to check if the plane is facing
  82303. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  82304. * @returns True is the vector "direction" is the same side than the plane normal.
  82305. */
  82306. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  82307. /**
  82308. * Calculates the distance to a point
  82309. * @param point point to calculate distance to
  82310. * @returns the signed distance (float) from the given point to the Plane.
  82311. */
  82312. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  82313. /**
  82314. * Creates a plane from an array
  82315. * @param array the array to create a plane from
  82316. * @returns a new Plane from the given array.
  82317. */
  82318. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  82319. /**
  82320. * Creates a plane from three points
  82321. * @param point1 point used to create the plane
  82322. * @param point2 point used to create the plane
  82323. * @param point3 point used to create the plane
  82324. * @returns a new Plane defined by the three given points.
  82325. */
  82326. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  82327. /**
  82328. * Creates a plane from an origin point and a normal
  82329. * @param origin origin of the plane to be constructed
  82330. * @param normal normal of the plane to be constructed
  82331. * @returns a new Plane the normal vector to this plane at the given origin point.
  82332. * Note : the vector "normal" is updated because normalized.
  82333. */
  82334. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  82335. /**
  82336. * Calculates the distance from a plane and a point
  82337. * @param origin origin of the plane to be constructed
  82338. * @param normal normal of the plane to be constructed
  82339. * @param point point to calculate distance to
  82340. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  82341. */
  82342. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  82343. }
  82344. }
  82345. declare module BABYLON {
  82346. /** @hidden */
  82347. export class PerformanceConfigurator {
  82348. /** @hidden */
  82349. static MatrixUse64Bits: boolean;
  82350. /** @hidden */
  82351. static MatrixTrackPrecisionChange: boolean;
  82352. /** @hidden */
  82353. static MatrixCurrentType: any;
  82354. /** @hidden */
  82355. static MatrixTrackedMatrices: Array<any> | null;
  82356. /** @hidden */
  82357. static SetMatrixPrecision(use64bits: boolean): void;
  82358. }
  82359. }
  82360. declare module BABYLON {
  82361. /**
  82362. * Class representing a vector containing 2 coordinates
  82363. */
  82364. export class Vector2 {
  82365. /** defines the first coordinate */
  82366. x: number;
  82367. /** defines the second coordinate */
  82368. y: number;
  82369. /**
  82370. * Creates a new Vector2 from the given x and y coordinates
  82371. * @param x defines the first coordinate
  82372. * @param y defines the second coordinate
  82373. */
  82374. constructor(
  82375. /** defines the first coordinate */
  82376. x?: number,
  82377. /** defines the second coordinate */
  82378. y?: number);
  82379. /**
  82380. * Gets a string with the Vector2 coordinates
  82381. * @returns a string with the Vector2 coordinates
  82382. */
  82383. toString(): string;
  82384. /**
  82385. * Gets class name
  82386. * @returns the string "Vector2"
  82387. */
  82388. getClassName(): string;
  82389. /**
  82390. * Gets current vector hash code
  82391. * @returns the Vector2 hash code as a number
  82392. */
  82393. getHashCode(): number;
  82394. /**
  82395. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  82396. * @param array defines the source array
  82397. * @param index defines the offset in source array
  82398. * @returns the current Vector2
  82399. */
  82400. toArray(array: FloatArray, index?: number): Vector2;
  82401. /**
  82402. * Update the current vector from an array
  82403. * @param array defines the destination array
  82404. * @param index defines the offset in the destination array
  82405. * @returns the current Vector3
  82406. */
  82407. fromArray(array: FloatArray, index?: number): Vector2;
  82408. /**
  82409. * Copy the current vector to an array
  82410. * @returns a new array with 2 elements: the Vector2 coordinates.
  82411. */
  82412. asArray(): number[];
  82413. /**
  82414. * Sets the Vector2 coordinates with the given Vector2 coordinates
  82415. * @param source defines the source Vector2
  82416. * @returns the current updated Vector2
  82417. */
  82418. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  82419. /**
  82420. * Sets the Vector2 coordinates with the given floats
  82421. * @param x defines the first coordinate
  82422. * @param y defines the second coordinate
  82423. * @returns the current updated Vector2
  82424. */
  82425. copyFromFloats(x: number, y: number): Vector2;
  82426. /**
  82427. * Sets the Vector2 coordinates with the given floats
  82428. * @param x defines the first coordinate
  82429. * @param y defines the second coordinate
  82430. * @returns the current updated Vector2
  82431. */
  82432. set(x: number, y: number): Vector2;
  82433. /**
  82434. * Add another vector with the current one
  82435. * @param otherVector defines the other vector
  82436. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  82437. */
  82438. add(otherVector: DeepImmutable<Vector2>): Vector2;
  82439. /**
  82440. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  82441. * @param otherVector defines the other vector
  82442. * @param result defines the target vector
  82443. * @returns the unmodified current Vector2
  82444. */
  82445. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  82446. /**
  82447. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  82448. * @param otherVector defines the other vector
  82449. * @returns the current updated Vector2
  82450. */
  82451. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  82452. /**
  82453. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  82454. * @param otherVector defines the other vector
  82455. * @returns a new Vector2
  82456. */
  82457. addVector3(otherVector: Vector3): Vector2;
  82458. /**
  82459. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  82460. * @param otherVector defines the other vector
  82461. * @returns a new Vector2
  82462. */
  82463. subtract(otherVector: Vector2): Vector2;
  82464. /**
  82465. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  82466. * @param otherVector defines the other vector
  82467. * @param result defines the target vector
  82468. * @returns the unmodified current Vector2
  82469. */
  82470. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  82471. /**
  82472. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  82473. * @param otherVector defines the other vector
  82474. * @returns the current updated Vector2
  82475. */
  82476. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  82477. /**
  82478. * Multiplies in place the current Vector2 coordinates by the given ones
  82479. * @param otherVector defines the other vector
  82480. * @returns the current updated Vector2
  82481. */
  82482. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  82483. /**
  82484. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  82485. * @param otherVector defines the other vector
  82486. * @returns a new Vector2
  82487. */
  82488. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  82489. /**
  82490. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  82491. * @param otherVector defines the other vector
  82492. * @param result defines the target vector
  82493. * @returns the unmodified current Vector2
  82494. */
  82495. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  82496. /**
  82497. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  82498. * @param x defines the first coordinate
  82499. * @param y defines the second coordinate
  82500. * @returns a new Vector2
  82501. */
  82502. multiplyByFloats(x: number, y: number): Vector2;
  82503. /**
  82504. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  82505. * @param otherVector defines the other vector
  82506. * @returns a new Vector2
  82507. */
  82508. divide(otherVector: Vector2): Vector2;
  82509. /**
  82510. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  82511. * @param otherVector defines the other vector
  82512. * @param result defines the target vector
  82513. * @returns the unmodified current Vector2
  82514. */
  82515. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  82516. /**
  82517. * Divides the current Vector2 coordinates by the given ones
  82518. * @param otherVector defines the other vector
  82519. * @returns the current updated Vector2
  82520. */
  82521. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  82522. /**
  82523. * Gets a new Vector2 with current Vector2 negated coordinates
  82524. * @returns a new Vector2
  82525. */
  82526. negate(): Vector2;
  82527. /**
  82528. * Negate this vector in place
  82529. * @returns this
  82530. */
  82531. negateInPlace(): Vector2;
  82532. /**
  82533. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  82534. * @param result defines the Vector3 object where to store the result
  82535. * @returns the current Vector2
  82536. */
  82537. negateToRef(result: Vector2): Vector2;
  82538. /**
  82539. * Multiply the Vector2 coordinates by scale
  82540. * @param scale defines the scaling factor
  82541. * @returns the current updated Vector2
  82542. */
  82543. scaleInPlace(scale: number): Vector2;
  82544. /**
  82545. * Returns a new Vector2 scaled by "scale" from the current Vector2
  82546. * @param scale defines the scaling factor
  82547. * @returns a new Vector2
  82548. */
  82549. scale(scale: number): Vector2;
  82550. /**
  82551. * Scale the current Vector2 values by a factor to a given Vector2
  82552. * @param scale defines the scale factor
  82553. * @param result defines the Vector2 object where to store the result
  82554. * @returns the unmodified current Vector2
  82555. */
  82556. scaleToRef(scale: number, result: Vector2): Vector2;
  82557. /**
  82558. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  82559. * @param scale defines the scale factor
  82560. * @param result defines the Vector2 object where to store the result
  82561. * @returns the unmodified current Vector2
  82562. */
  82563. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  82564. /**
  82565. * Gets a boolean if two vectors are equals
  82566. * @param otherVector defines the other vector
  82567. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  82568. */
  82569. equals(otherVector: DeepImmutable<Vector2>): boolean;
  82570. /**
  82571. * Gets a boolean if two vectors are equals (using an epsilon value)
  82572. * @param otherVector defines the other vector
  82573. * @param epsilon defines the minimal distance to consider equality
  82574. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  82575. */
  82576. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  82577. /**
  82578. * Gets a new Vector2 from current Vector2 floored values
  82579. * @returns a new Vector2
  82580. */
  82581. floor(): Vector2;
  82582. /**
  82583. * Gets a new Vector2 from current Vector2 floored values
  82584. * @returns a new Vector2
  82585. */
  82586. fract(): Vector2;
  82587. /**
  82588. * Gets the length of the vector
  82589. * @returns the vector length (float)
  82590. */
  82591. length(): number;
  82592. /**
  82593. * Gets the vector squared length
  82594. * @returns the vector squared length (float)
  82595. */
  82596. lengthSquared(): number;
  82597. /**
  82598. * Normalize the vector
  82599. * @returns the current updated Vector2
  82600. */
  82601. normalize(): Vector2;
  82602. /**
  82603. * Gets a new Vector2 copied from the Vector2
  82604. * @returns a new Vector2
  82605. */
  82606. clone(): Vector2;
  82607. /**
  82608. * Gets a new Vector2(0, 0)
  82609. * @returns a new Vector2
  82610. */
  82611. static Zero(): Vector2;
  82612. /**
  82613. * Gets a new Vector2(1, 1)
  82614. * @returns a new Vector2
  82615. */
  82616. static One(): Vector2;
  82617. /**
  82618. * Gets a new Vector2 set from the given index element of the given array
  82619. * @param array defines the data source
  82620. * @param offset defines the offset in the data source
  82621. * @returns a new Vector2
  82622. */
  82623. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  82624. /**
  82625. * Sets "result" from the given index element of the given array
  82626. * @param array defines the data source
  82627. * @param offset defines the offset in the data source
  82628. * @param result defines the target vector
  82629. */
  82630. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  82631. /**
  82632. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  82633. * @param value1 defines 1st point of control
  82634. * @param value2 defines 2nd point of control
  82635. * @param value3 defines 3rd point of control
  82636. * @param value4 defines 4th point of control
  82637. * @param amount defines the interpolation factor
  82638. * @returns a new Vector2
  82639. */
  82640. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  82641. /**
  82642. * 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".
  82643. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  82644. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  82645. * @param value defines the value to clamp
  82646. * @param min defines the lower limit
  82647. * @param max defines the upper limit
  82648. * @returns a new Vector2
  82649. */
  82650. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  82651. /**
  82652. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  82653. * @param value1 defines the 1st control point
  82654. * @param tangent1 defines the outgoing tangent
  82655. * @param value2 defines the 2nd control point
  82656. * @param tangent2 defines the incoming tangent
  82657. * @param amount defines the interpolation factor
  82658. * @returns a new Vector2
  82659. */
  82660. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  82661. /**
  82662. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  82663. * @param start defines the start vector
  82664. * @param end defines the end vector
  82665. * @param amount defines the interpolation factor
  82666. * @returns a new Vector2
  82667. */
  82668. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  82669. /**
  82670. * Gets the dot product of the vector "left" and the vector "right"
  82671. * @param left defines first vector
  82672. * @param right defines second vector
  82673. * @returns the dot product (float)
  82674. */
  82675. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  82676. /**
  82677. * Returns a new Vector2 equal to the normalized given vector
  82678. * @param vector defines the vector to normalize
  82679. * @returns a new Vector2
  82680. */
  82681. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  82682. /**
  82683. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  82684. * @param left defines 1st vector
  82685. * @param right defines 2nd vector
  82686. * @returns a new Vector2
  82687. */
  82688. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  82689. /**
  82690. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  82691. * @param left defines 1st vector
  82692. * @param right defines 2nd vector
  82693. * @returns a new Vector2
  82694. */
  82695. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  82696. /**
  82697. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  82698. * @param vector defines the vector to transform
  82699. * @param transformation defines the matrix to apply
  82700. * @returns a new Vector2
  82701. */
  82702. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  82703. /**
  82704. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  82705. * @param vector defines the vector to transform
  82706. * @param transformation defines the matrix to apply
  82707. * @param result defines the target vector
  82708. */
  82709. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  82710. /**
  82711. * Determines if a given vector is included in a triangle
  82712. * @param p defines the vector to test
  82713. * @param p0 defines 1st triangle point
  82714. * @param p1 defines 2nd triangle point
  82715. * @param p2 defines 3rd triangle point
  82716. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  82717. */
  82718. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  82719. /**
  82720. * Gets the distance between the vectors "value1" and "value2"
  82721. * @param value1 defines first vector
  82722. * @param value2 defines second vector
  82723. * @returns the distance between vectors
  82724. */
  82725. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  82726. /**
  82727. * Returns the squared distance between the vectors "value1" and "value2"
  82728. * @param value1 defines first vector
  82729. * @param value2 defines second vector
  82730. * @returns the squared distance between vectors
  82731. */
  82732. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  82733. /**
  82734. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  82735. * @param value1 defines first vector
  82736. * @param value2 defines second vector
  82737. * @returns a new Vector2
  82738. */
  82739. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  82740. /**
  82741. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  82742. * @param p defines the middle point
  82743. * @param segA defines one point of the segment
  82744. * @param segB defines the other point of the segment
  82745. * @returns the shortest distance
  82746. */
  82747. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  82748. }
  82749. /**
  82750. * Class used to store (x,y,z) vector representation
  82751. * A Vector3 is the main object used in 3D geometry
  82752. * It can represent etiher the coordinates of a point the space, either a direction
  82753. * Reminder: js uses a left handed forward facing system
  82754. */
  82755. export class Vector3 {
  82756. private static _UpReadOnly;
  82757. private static _ZeroReadOnly;
  82758. /** @hidden */
  82759. _x: number;
  82760. /** @hidden */
  82761. _y: number;
  82762. /** @hidden */
  82763. _z: number;
  82764. /** @hidden */
  82765. _isDirty: boolean;
  82766. /** Gets or sets the x coordinate */
  82767. get x(): number;
  82768. set x(value: number);
  82769. /** Gets or sets the y coordinate */
  82770. get y(): number;
  82771. set y(value: number);
  82772. /** Gets or sets the z coordinate */
  82773. get z(): number;
  82774. set z(value: number);
  82775. /**
  82776. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  82777. * @param x defines the first coordinates (on X axis)
  82778. * @param y defines the second coordinates (on Y axis)
  82779. * @param z defines the third coordinates (on Z axis)
  82780. */
  82781. constructor(x?: number, y?: number, z?: number);
  82782. /**
  82783. * Creates a string representation of the Vector3
  82784. * @returns a string with the Vector3 coordinates.
  82785. */
  82786. toString(): string;
  82787. /**
  82788. * Gets the class name
  82789. * @returns the string "Vector3"
  82790. */
  82791. getClassName(): string;
  82792. /**
  82793. * Creates the Vector3 hash code
  82794. * @returns a number which tends to be unique between Vector3 instances
  82795. */
  82796. getHashCode(): number;
  82797. /**
  82798. * Creates an array containing three elements : the coordinates of the Vector3
  82799. * @returns a new array of numbers
  82800. */
  82801. asArray(): number[];
  82802. /**
  82803. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  82804. * @param array defines the destination array
  82805. * @param index defines the offset in the destination array
  82806. * @returns the current Vector3
  82807. */
  82808. toArray(array: FloatArray, index?: number): Vector3;
  82809. /**
  82810. * Update the current vector from an array
  82811. * @param array defines the destination array
  82812. * @param index defines the offset in the destination array
  82813. * @returns the current Vector3
  82814. */
  82815. fromArray(array: FloatArray, index?: number): Vector3;
  82816. /**
  82817. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  82818. * @returns a new Quaternion object, computed from the Vector3 coordinates
  82819. */
  82820. toQuaternion(): Quaternion;
  82821. /**
  82822. * Adds the given vector to the current Vector3
  82823. * @param otherVector defines the second operand
  82824. * @returns the current updated Vector3
  82825. */
  82826. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82827. /**
  82828. * Adds the given coordinates to the current Vector3
  82829. * @param x defines the x coordinate of the operand
  82830. * @param y defines the y coordinate of the operand
  82831. * @param z defines the z coordinate of the operand
  82832. * @returns the current updated Vector3
  82833. */
  82834. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82835. /**
  82836. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  82837. * @param otherVector defines the second operand
  82838. * @returns the resulting Vector3
  82839. */
  82840. add(otherVector: DeepImmutable<Vector3>): Vector3;
  82841. /**
  82842. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  82843. * @param otherVector defines the second operand
  82844. * @param result defines the Vector3 object where to store the result
  82845. * @returns the current Vector3
  82846. */
  82847. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82848. /**
  82849. * Subtract the given vector from the current Vector3
  82850. * @param otherVector defines the second operand
  82851. * @returns the current updated Vector3
  82852. */
  82853. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82854. /**
  82855. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  82856. * @param otherVector defines the second operand
  82857. * @returns the resulting Vector3
  82858. */
  82859. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  82860. /**
  82861. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  82862. * @param otherVector defines the second operand
  82863. * @param result defines the Vector3 object where to store the result
  82864. * @returns the current Vector3
  82865. */
  82866. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82867. /**
  82868. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  82869. * @param x defines the x coordinate of the operand
  82870. * @param y defines the y coordinate of the operand
  82871. * @param z defines the z coordinate of the operand
  82872. * @returns the resulting Vector3
  82873. */
  82874. subtractFromFloats(x: number, y: number, z: number): Vector3;
  82875. /**
  82876. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  82877. * @param x defines the x coordinate of the operand
  82878. * @param y defines the y coordinate of the operand
  82879. * @param z defines the z coordinate of the operand
  82880. * @param result defines the Vector3 object where to store the result
  82881. * @returns the current Vector3
  82882. */
  82883. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  82884. /**
  82885. * Gets a new Vector3 set with the current Vector3 negated coordinates
  82886. * @returns a new Vector3
  82887. */
  82888. negate(): Vector3;
  82889. /**
  82890. * Negate this vector in place
  82891. * @returns this
  82892. */
  82893. negateInPlace(): Vector3;
  82894. /**
  82895. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  82896. * @param result defines the Vector3 object where to store the result
  82897. * @returns the current Vector3
  82898. */
  82899. negateToRef(result: Vector3): Vector3;
  82900. /**
  82901. * Multiplies the Vector3 coordinates by the float "scale"
  82902. * @param scale defines the multiplier factor
  82903. * @returns the current updated Vector3
  82904. */
  82905. scaleInPlace(scale: number): Vector3;
  82906. /**
  82907. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  82908. * @param scale defines the multiplier factor
  82909. * @returns a new Vector3
  82910. */
  82911. scale(scale: number): Vector3;
  82912. /**
  82913. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  82914. * @param scale defines the multiplier factor
  82915. * @param result defines the Vector3 object where to store the result
  82916. * @returns the current Vector3
  82917. */
  82918. scaleToRef(scale: number, result: Vector3): Vector3;
  82919. /**
  82920. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  82921. * @param scale defines the scale factor
  82922. * @param result defines the Vector3 object where to store the result
  82923. * @returns the unmodified current Vector3
  82924. */
  82925. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  82926. /**
  82927. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  82928. * @param origin defines the origin of the projection ray
  82929. * @param plane defines the plane to project to
  82930. * @returns the projected vector3
  82931. */
  82932. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  82933. /**
  82934. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  82935. * @param origin defines the origin of the projection ray
  82936. * @param plane defines the plane to project to
  82937. * @param result defines the Vector3 where to store the result
  82938. */
  82939. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  82940. /**
  82941. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  82942. * @param otherVector defines the second operand
  82943. * @returns true if both vectors are equals
  82944. */
  82945. equals(otherVector: DeepImmutable<Vector3>): boolean;
  82946. /**
  82947. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  82948. * @param otherVector defines the second operand
  82949. * @param epsilon defines the minimal distance to define values as equals
  82950. * @returns true if both vectors are distant less than epsilon
  82951. */
  82952. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  82953. /**
  82954. * Returns true if the current Vector3 coordinates equals the given floats
  82955. * @param x defines the x coordinate of the operand
  82956. * @param y defines the y coordinate of the operand
  82957. * @param z defines the z coordinate of the operand
  82958. * @returns true if both vectors are equals
  82959. */
  82960. equalsToFloats(x: number, y: number, z: number): boolean;
  82961. /**
  82962. * Multiplies the current Vector3 coordinates by the given ones
  82963. * @param otherVector defines the second operand
  82964. * @returns the current updated Vector3
  82965. */
  82966. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82967. /**
  82968. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  82969. * @param otherVector defines the second operand
  82970. * @returns the new Vector3
  82971. */
  82972. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  82973. /**
  82974. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  82975. * @param otherVector defines the second operand
  82976. * @param result defines the Vector3 object where to store the result
  82977. * @returns the current Vector3
  82978. */
  82979. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82980. /**
  82981. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  82982. * @param x defines the x coordinate of the operand
  82983. * @param y defines the y coordinate of the operand
  82984. * @param z defines the z coordinate of the operand
  82985. * @returns the new Vector3
  82986. */
  82987. multiplyByFloats(x: number, y: number, z: number): Vector3;
  82988. /**
  82989. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  82990. * @param otherVector defines the second operand
  82991. * @returns the new Vector3
  82992. */
  82993. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  82994. /**
  82995. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  82996. * @param otherVector defines the second operand
  82997. * @param result defines the Vector3 object where to store the result
  82998. * @returns the current Vector3
  82999. */
  83000. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  83001. /**
  83002. * Divides the current Vector3 coordinates by the given ones.
  83003. * @param otherVector defines the second operand
  83004. * @returns the current updated Vector3
  83005. */
  83006. divideInPlace(otherVector: Vector3): Vector3;
  83007. /**
  83008. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  83009. * @param other defines the second operand
  83010. * @returns the current updated Vector3
  83011. */
  83012. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  83013. /**
  83014. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  83015. * @param other defines the second operand
  83016. * @returns the current updated Vector3
  83017. */
  83018. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  83019. /**
  83020. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  83021. * @param x defines the x coordinate of the operand
  83022. * @param y defines the y coordinate of the operand
  83023. * @param z defines the z coordinate of the operand
  83024. * @returns the current updated Vector3
  83025. */
  83026. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  83027. /**
  83028. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  83029. * @param x defines the x coordinate of the operand
  83030. * @param y defines the y coordinate of the operand
  83031. * @param z defines the z coordinate of the operand
  83032. * @returns the current updated Vector3
  83033. */
  83034. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  83035. /**
  83036. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  83037. * Check if is non uniform within a certain amount of decimal places to account for this
  83038. * @param epsilon the amount the values can differ
  83039. * @returns if the the vector is non uniform to a certain number of decimal places
  83040. */
  83041. isNonUniformWithinEpsilon(epsilon: number): boolean;
  83042. /**
  83043. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  83044. */
  83045. get isNonUniform(): boolean;
  83046. /**
  83047. * Gets a new Vector3 from current Vector3 floored values
  83048. * @returns a new Vector3
  83049. */
  83050. floor(): Vector3;
  83051. /**
  83052. * Gets a new Vector3 from current Vector3 floored values
  83053. * @returns a new Vector3
  83054. */
  83055. fract(): Vector3;
  83056. /**
  83057. * Gets the length of the Vector3
  83058. * @returns the length of the Vector3
  83059. */
  83060. length(): number;
  83061. /**
  83062. * Gets the squared length of the Vector3
  83063. * @returns squared length of the Vector3
  83064. */
  83065. lengthSquared(): number;
  83066. /**
  83067. * Normalize the current Vector3.
  83068. * Please note that this is an in place operation.
  83069. * @returns the current updated Vector3
  83070. */
  83071. normalize(): Vector3;
  83072. /**
  83073. * Reorders the x y z properties of the vector in place
  83074. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  83075. * @returns the current updated vector
  83076. */
  83077. reorderInPlace(order: string): this;
  83078. /**
  83079. * Rotates the vector around 0,0,0 by a quaternion
  83080. * @param quaternion the rotation quaternion
  83081. * @param result vector to store the result
  83082. * @returns the resulting vector
  83083. */
  83084. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  83085. /**
  83086. * Rotates a vector around a given point
  83087. * @param quaternion the rotation quaternion
  83088. * @param point the point to rotate around
  83089. * @param result vector to store the result
  83090. * @returns the resulting vector
  83091. */
  83092. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  83093. /**
  83094. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  83095. * The cross product is then orthogonal to both current and "other"
  83096. * @param other defines the right operand
  83097. * @returns the cross product
  83098. */
  83099. cross(other: Vector3): Vector3;
  83100. /**
  83101. * Normalize the current Vector3 with the given input length.
  83102. * Please note that this is an in place operation.
  83103. * @param len the length of the vector
  83104. * @returns the current updated Vector3
  83105. */
  83106. normalizeFromLength(len: number): Vector3;
  83107. /**
  83108. * Normalize the current Vector3 to a new vector
  83109. * @returns the new Vector3
  83110. */
  83111. normalizeToNew(): Vector3;
  83112. /**
  83113. * Normalize the current Vector3 to the reference
  83114. * @param reference define the Vector3 to update
  83115. * @returns the updated Vector3
  83116. */
  83117. normalizeToRef(reference: Vector3): Vector3;
  83118. /**
  83119. * Creates a new Vector3 copied from the current Vector3
  83120. * @returns the new Vector3
  83121. */
  83122. clone(): Vector3;
  83123. /**
  83124. * Copies the given vector coordinates to the current Vector3 ones
  83125. * @param source defines the source Vector3
  83126. * @returns the current updated Vector3
  83127. */
  83128. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  83129. /**
  83130. * Copies the given floats to the current Vector3 coordinates
  83131. * @param x defines the x coordinate of the operand
  83132. * @param y defines the y coordinate of the operand
  83133. * @param z defines the z coordinate of the operand
  83134. * @returns the current updated Vector3
  83135. */
  83136. copyFromFloats(x: number, y: number, z: number): Vector3;
  83137. /**
  83138. * Copies the given floats to the current Vector3 coordinates
  83139. * @param x defines the x coordinate of the operand
  83140. * @param y defines the y coordinate of the operand
  83141. * @param z defines the z coordinate of the operand
  83142. * @returns the current updated Vector3
  83143. */
  83144. set(x: number, y: number, z: number): Vector3;
  83145. /**
  83146. * Copies the given float to the current Vector3 coordinates
  83147. * @param v defines the x, y and z coordinates of the operand
  83148. * @returns the current updated Vector3
  83149. */
  83150. setAll(v: number): Vector3;
  83151. /**
  83152. * Get the clip factor between two vectors
  83153. * @param vector0 defines the first operand
  83154. * @param vector1 defines the second operand
  83155. * @param axis defines the axis to use
  83156. * @param size defines the size along the axis
  83157. * @returns the clip factor
  83158. */
  83159. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  83160. /**
  83161. * Get angle between two vectors
  83162. * @param vector0 angle between vector0 and vector1
  83163. * @param vector1 angle between vector0 and vector1
  83164. * @param normal direction of the normal
  83165. * @return the angle between vector0 and vector1
  83166. */
  83167. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  83168. /**
  83169. * Returns a new Vector3 set from the index "offset" of the given array
  83170. * @param array defines the source array
  83171. * @param offset defines the offset in the source array
  83172. * @returns the new Vector3
  83173. */
  83174. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  83175. /**
  83176. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  83177. * @param array defines the source array
  83178. * @param offset defines the offset in the source array
  83179. * @returns the new Vector3
  83180. * @deprecated Please use FromArray instead.
  83181. */
  83182. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  83183. /**
  83184. * Sets the given vector "result" with the element values from the index "offset" of the given array
  83185. * @param array defines the source array
  83186. * @param offset defines the offset in the source array
  83187. * @param result defines the Vector3 where to store the result
  83188. */
  83189. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  83190. /**
  83191. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  83192. * @param array defines the source array
  83193. * @param offset defines the offset in the source array
  83194. * @param result defines the Vector3 where to store the result
  83195. * @deprecated Please use FromArrayToRef instead.
  83196. */
  83197. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  83198. /**
  83199. * Sets the given vector "result" with the given floats.
  83200. * @param x defines the x coordinate of the source
  83201. * @param y defines the y coordinate of the source
  83202. * @param z defines the z coordinate of the source
  83203. * @param result defines the Vector3 where to store the result
  83204. */
  83205. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  83206. /**
  83207. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  83208. * @returns a new empty Vector3
  83209. */
  83210. static Zero(): Vector3;
  83211. /**
  83212. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  83213. * @returns a new unit Vector3
  83214. */
  83215. static One(): Vector3;
  83216. /**
  83217. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  83218. * @returns a new up Vector3
  83219. */
  83220. static Up(): Vector3;
  83221. /**
  83222. * Gets a up Vector3 that must not be updated
  83223. */
  83224. static get UpReadOnly(): DeepImmutable<Vector3>;
  83225. /**
  83226. * Gets a zero Vector3 that must not be updated
  83227. */
  83228. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  83229. /**
  83230. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  83231. * @returns a new down Vector3
  83232. */
  83233. static Down(): Vector3;
  83234. /**
  83235. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  83236. * @param rightHandedSystem is the scene right-handed (negative z)
  83237. * @returns a new forward Vector3
  83238. */
  83239. static Forward(rightHandedSystem?: boolean): Vector3;
  83240. /**
  83241. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  83242. * @param rightHandedSystem is the scene right-handed (negative-z)
  83243. * @returns a new forward Vector3
  83244. */
  83245. static Backward(rightHandedSystem?: boolean): Vector3;
  83246. /**
  83247. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  83248. * @returns a new right Vector3
  83249. */
  83250. static Right(): Vector3;
  83251. /**
  83252. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  83253. * @returns a new left Vector3
  83254. */
  83255. static Left(): Vector3;
  83256. /**
  83257. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  83258. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  83259. * @param vector defines the Vector3 to transform
  83260. * @param transformation defines the transformation matrix
  83261. * @returns the transformed Vector3
  83262. */
  83263. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  83264. /**
  83265. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  83266. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  83267. * @param vector defines the Vector3 to transform
  83268. * @param transformation defines the transformation matrix
  83269. * @param result defines the Vector3 where to store the result
  83270. */
  83271. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  83272. /**
  83273. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  83274. * This method computes tranformed coordinates only, not transformed direction vectors
  83275. * @param x define the x coordinate of the source vector
  83276. * @param y define the y coordinate of the source vector
  83277. * @param z define the z coordinate of the source vector
  83278. * @param transformation defines the transformation matrix
  83279. * @param result defines the Vector3 where to store the result
  83280. */
  83281. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  83282. /**
  83283. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  83284. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  83285. * @param vector defines the Vector3 to transform
  83286. * @param transformation defines the transformation matrix
  83287. * @returns the new Vector3
  83288. */
  83289. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  83290. /**
  83291. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  83292. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  83293. * @param vector defines the Vector3 to transform
  83294. * @param transformation defines the transformation matrix
  83295. * @param result defines the Vector3 where to store the result
  83296. */
  83297. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  83298. /**
  83299. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  83300. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  83301. * @param x define the x coordinate of the source vector
  83302. * @param y define the y coordinate of the source vector
  83303. * @param z define the z coordinate of the source vector
  83304. * @param transformation defines the transformation matrix
  83305. * @param result defines the Vector3 where to store the result
  83306. */
  83307. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  83308. /**
  83309. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  83310. * @param value1 defines the first control point
  83311. * @param value2 defines the second control point
  83312. * @param value3 defines the third control point
  83313. * @param value4 defines the fourth control point
  83314. * @param amount defines the amount on the spline to use
  83315. * @returns the new Vector3
  83316. */
  83317. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  83318. /**
  83319. * 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"
  83320. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  83321. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  83322. * @param value defines the current value
  83323. * @param min defines the lower range value
  83324. * @param max defines the upper range value
  83325. * @returns the new Vector3
  83326. */
  83327. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  83328. /**
  83329. * 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"
  83330. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  83331. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  83332. * @param value defines the current value
  83333. * @param min defines the lower range value
  83334. * @param max defines the upper range value
  83335. * @param result defines the Vector3 where to store the result
  83336. */
  83337. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  83338. /**
  83339. * Checks if a given vector is inside a specific range
  83340. * @param v defines the vector to test
  83341. * @param min defines the minimum range
  83342. * @param max defines the maximum range
  83343. */
  83344. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  83345. /**
  83346. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  83347. * @param value1 defines the first control point
  83348. * @param tangent1 defines the first tangent vector
  83349. * @param value2 defines the second control point
  83350. * @param tangent2 defines the second tangent vector
  83351. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  83352. * @returns the new Vector3
  83353. */
  83354. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  83355. /**
  83356. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  83357. * @param start defines the start value
  83358. * @param end defines the end value
  83359. * @param amount max defines amount between both (between 0 and 1)
  83360. * @returns the new Vector3
  83361. */
  83362. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  83363. /**
  83364. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  83365. * @param start defines the start value
  83366. * @param end defines the end value
  83367. * @param amount max defines amount between both (between 0 and 1)
  83368. * @param result defines the Vector3 where to store the result
  83369. */
  83370. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  83371. /**
  83372. * Returns the dot product (float) between the vectors "left" and "right"
  83373. * @param left defines the left operand
  83374. * @param right defines the right operand
  83375. * @returns the dot product
  83376. */
  83377. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  83378. /**
  83379. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  83380. * The cross product is then orthogonal to both "left" and "right"
  83381. * @param left defines the left operand
  83382. * @param right defines the right operand
  83383. * @returns the cross product
  83384. */
  83385. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  83386. /**
  83387. * Sets the given vector "result" with the cross product of "left" and "right"
  83388. * The cross product is then orthogonal to both "left" and "right"
  83389. * @param left defines the left operand
  83390. * @param right defines the right operand
  83391. * @param result defines the Vector3 where to store the result
  83392. */
  83393. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  83394. /**
  83395. * Returns a new Vector3 as the normalization of the given vector
  83396. * @param vector defines the Vector3 to normalize
  83397. * @returns the new Vector3
  83398. */
  83399. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  83400. /**
  83401. * Sets the given vector "result" with the normalization of the given first vector
  83402. * @param vector defines the Vector3 to normalize
  83403. * @param result defines the Vector3 where to store the result
  83404. */
  83405. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  83406. /**
  83407. * Project a Vector3 onto screen space
  83408. * @param vector defines the Vector3 to project
  83409. * @param world defines the world matrix to use
  83410. * @param transform defines the transform (view x projection) matrix to use
  83411. * @param viewport defines the screen viewport to use
  83412. * @returns the new Vector3
  83413. */
  83414. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  83415. /** @hidden */
  83416. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  83417. /**
  83418. * Unproject from screen space to object space
  83419. * @param source defines the screen space Vector3 to use
  83420. * @param viewportWidth defines the current width of the viewport
  83421. * @param viewportHeight defines the current height of the viewport
  83422. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  83423. * @param transform defines the transform (view x projection) matrix to use
  83424. * @returns the new Vector3
  83425. */
  83426. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  83427. /**
  83428. * Unproject from screen space to object space
  83429. * @param source defines the screen space Vector3 to use
  83430. * @param viewportWidth defines the current width of the viewport
  83431. * @param viewportHeight defines the current height of the viewport
  83432. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  83433. * @param view defines the view matrix to use
  83434. * @param projection defines the projection matrix to use
  83435. * @returns the new Vector3
  83436. */
  83437. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  83438. /**
  83439. * Unproject from screen space to object space
  83440. * @param source defines the screen space Vector3 to use
  83441. * @param viewportWidth defines the current width of the viewport
  83442. * @param viewportHeight defines the current height of the viewport
  83443. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  83444. * @param view defines the view matrix to use
  83445. * @param projection defines the projection matrix to use
  83446. * @param result defines the Vector3 where to store the result
  83447. */
  83448. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  83449. /**
  83450. * Unproject from screen space to object space
  83451. * @param sourceX defines the screen space x coordinate to use
  83452. * @param sourceY defines the screen space y coordinate to use
  83453. * @param sourceZ defines the screen space z coordinate to use
  83454. * @param viewportWidth defines the current width of the viewport
  83455. * @param viewportHeight defines the current height of the viewport
  83456. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  83457. * @param view defines the view matrix to use
  83458. * @param projection defines the projection matrix to use
  83459. * @param result defines the Vector3 where to store the result
  83460. */
  83461. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  83462. /**
  83463. * Gets the minimal coordinate values between two Vector3
  83464. * @param left defines the first operand
  83465. * @param right defines the second operand
  83466. * @returns the new Vector3
  83467. */
  83468. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  83469. /**
  83470. * Gets the maximal coordinate values between two Vector3
  83471. * @param left defines the first operand
  83472. * @param right defines the second operand
  83473. * @returns the new Vector3
  83474. */
  83475. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  83476. /**
  83477. * Returns the distance between the vectors "value1" and "value2"
  83478. * @param value1 defines the first operand
  83479. * @param value2 defines the second operand
  83480. * @returns the distance
  83481. */
  83482. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  83483. /**
  83484. * Returns the squared distance between the vectors "value1" and "value2"
  83485. * @param value1 defines the first operand
  83486. * @param value2 defines the second operand
  83487. * @returns the squared distance
  83488. */
  83489. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  83490. /**
  83491. * Returns a new Vector3 located at the center between "value1" and "value2"
  83492. * @param value1 defines the first operand
  83493. * @param value2 defines the second operand
  83494. * @returns the new Vector3
  83495. */
  83496. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  83497. /**
  83498. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  83499. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  83500. * to something in order to rotate it from its local system to the given target system
  83501. * Note: axis1, axis2 and axis3 are normalized during this operation
  83502. * @param axis1 defines the first axis
  83503. * @param axis2 defines the second axis
  83504. * @param axis3 defines the third axis
  83505. * @returns a new Vector3
  83506. */
  83507. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  83508. /**
  83509. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  83510. * @param axis1 defines the first axis
  83511. * @param axis2 defines the second axis
  83512. * @param axis3 defines the third axis
  83513. * @param ref defines the Vector3 where to store the result
  83514. */
  83515. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  83516. }
  83517. /**
  83518. * Vector4 class created for EulerAngle class conversion to Quaternion
  83519. */
  83520. export class Vector4 {
  83521. /** x value of the vector */
  83522. x: number;
  83523. /** y value of the vector */
  83524. y: number;
  83525. /** z value of the vector */
  83526. z: number;
  83527. /** w value of the vector */
  83528. w: number;
  83529. /**
  83530. * Creates a Vector4 object from the given floats.
  83531. * @param x x value of the vector
  83532. * @param y y value of the vector
  83533. * @param z z value of the vector
  83534. * @param w w value of the vector
  83535. */
  83536. constructor(
  83537. /** x value of the vector */
  83538. x: number,
  83539. /** y value of the vector */
  83540. y: number,
  83541. /** z value of the vector */
  83542. z: number,
  83543. /** w value of the vector */
  83544. w: number);
  83545. /**
  83546. * Returns the string with the Vector4 coordinates.
  83547. * @returns a string containing all the vector values
  83548. */
  83549. toString(): string;
  83550. /**
  83551. * Returns the string "Vector4".
  83552. * @returns "Vector4"
  83553. */
  83554. getClassName(): string;
  83555. /**
  83556. * Returns the Vector4 hash code.
  83557. * @returns a unique hash code
  83558. */
  83559. getHashCode(): number;
  83560. /**
  83561. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  83562. * @returns the resulting array
  83563. */
  83564. asArray(): number[];
  83565. /**
  83566. * Populates the given array from the given index with the Vector4 coordinates.
  83567. * @param array array to populate
  83568. * @param index index of the array to start at (default: 0)
  83569. * @returns the Vector4.
  83570. */
  83571. toArray(array: FloatArray, index?: number): Vector4;
  83572. /**
  83573. * Update the current vector from an array
  83574. * @param array defines the destination array
  83575. * @param index defines the offset in the destination array
  83576. * @returns the current Vector3
  83577. */
  83578. fromArray(array: FloatArray, index?: number): Vector4;
  83579. /**
  83580. * Adds the given vector to the current Vector4.
  83581. * @param otherVector the vector to add
  83582. * @returns the updated Vector4.
  83583. */
  83584. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  83585. /**
  83586. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  83587. * @param otherVector the vector to add
  83588. * @returns the resulting vector
  83589. */
  83590. add(otherVector: DeepImmutable<Vector4>): Vector4;
  83591. /**
  83592. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  83593. * @param otherVector the vector to add
  83594. * @param result the vector to store the result
  83595. * @returns the current Vector4.
  83596. */
  83597. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83598. /**
  83599. * Subtract in place the given vector from the current Vector4.
  83600. * @param otherVector the vector to subtract
  83601. * @returns the updated Vector4.
  83602. */
  83603. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  83604. /**
  83605. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  83606. * @param otherVector the vector to add
  83607. * @returns the new vector with the result
  83608. */
  83609. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  83610. /**
  83611. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  83612. * @param otherVector the vector to subtract
  83613. * @param result the vector to store the result
  83614. * @returns the current Vector4.
  83615. */
  83616. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83617. /**
  83618. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  83619. */
  83620. /**
  83621. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  83622. * @param x value to subtract
  83623. * @param y value to subtract
  83624. * @param z value to subtract
  83625. * @param w value to subtract
  83626. * @returns new vector containing the result
  83627. */
  83628. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  83629. /**
  83630. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  83631. * @param x value to subtract
  83632. * @param y value to subtract
  83633. * @param z value to subtract
  83634. * @param w value to subtract
  83635. * @param result the vector to store the result in
  83636. * @returns the current Vector4.
  83637. */
  83638. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  83639. /**
  83640. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  83641. * @returns a new vector with the negated values
  83642. */
  83643. negate(): Vector4;
  83644. /**
  83645. * Negate this vector in place
  83646. * @returns this
  83647. */
  83648. negateInPlace(): Vector4;
  83649. /**
  83650. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  83651. * @param result defines the Vector3 object where to store the result
  83652. * @returns the current Vector4
  83653. */
  83654. negateToRef(result: Vector4): Vector4;
  83655. /**
  83656. * Multiplies the current Vector4 coordinates by scale (float).
  83657. * @param scale the number to scale with
  83658. * @returns the updated Vector4.
  83659. */
  83660. scaleInPlace(scale: number): Vector4;
  83661. /**
  83662. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  83663. * @param scale the number to scale with
  83664. * @returns a new vector with the result
  83665. */
  83666. scale(scale: number): Vector4;
  83667. /**
  83668. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  83669. * @param scale the number to scale with
  83670. * @param result a vector to store the result in
  83671. * @returns the current Vector4.
  83672. */
  83673. scaleToRef(scale: number, result: Vector4): Vector4;
  83674. /**
  83675. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  83676. * @param scale defines the scale factor
  83677. * @param result defines the Vector4 object where to store the result
  83678. * @returns the unmodified current Vector4
  83679. */
  83680. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  83681. /**
  83682. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  83683. * @param otherVector the vector to compare against
  83684. * @returns true if they are equal
  83685. */
  83686. equals(otherVector: DeepImmutable<Vector4>): boolean;
  83687. /**
  83688. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  83689. * @param otherVector vector to compare against
  83690. * @param epsilon (Default: very small number)
  83691. * @returns true if they are equal
  83692. */
  83693. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  83694. /**
  83695. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  83696. * @param x x value to compare against
  83697. * @param y y value to compare against
  83698. * @param z z value to compare against
  83699. * @param w w value to compare against
  83700. * @returns true if equal
  83701. */
  83702. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  83703. /**
  83704. * Multiplies in place the current Vector4 by the given one.
  83705. * @param otherVector vector to multiple with
  83706. * @returns the updated Vector4.
  83707. */
  83708. multiplyInPlace(otherVector: Vector4): Vector4;
  83709. /**
  83710. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  83711. * @param otherVector vector to multiple with
  83712. * @returns resulting new vector
  83713. */
  83714. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  83715. /**
  83716. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  83717. * @param otherVector vector to multiple with
  83718. * @param result vector to store the result
  83719. * @returns the current Vector4.
  83720. */
  83721. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83722. /**
  83723. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  83724. * @param x x value multiply with
  83725. * @param y y value multiply with
  83726. * @param z z value multiply with
  83727. * @param w w value multiply with
  83728. * @returns resulting new vector
  83729. */
  83730. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  83731. /**
  83732. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  83733. * @param otherVector vector to devide with
  83734. * @returns resulting new vector
  83735. */
  83736. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  83737. /**
  83738. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  83739. * @param otherVector vector to devide with
  83740. * @param result vector to store the result
  83741. * @returns the current Vector4.
  83742. */
  83743. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83744. /**
  83745. * Divides the current Vector3 coordinates by the given ones.
  83746. * @param otherVector vector to devide with
  83747. * @returns the updated Vector3.
  83748. */
  83749. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  83750. /**
  83751. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  83752. * @param other defines the second operand
  83753. * @returns the current updated Vector4
  83754. */
  83755. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  83756. /**
  83757. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  83758. * @param other defines the second operand
  83759. * @returns the current updated Vector4
  83760. */
  83761. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  83762. /**
  83763. * Gets a new Vector4 from current Vector4 floored values
  83764. * @returns a new Vector4
  83765. */
  83766. floor(): Vector4;
  83767. /**
  83768. * Gets a new Vector4 from current Vector3 floored values
  83769. * @returns a new Vector4
  83770. */
  83771. fract(): Vector4;
  83772. /**
  83773. * Returns the Vector4 length (float).
  83774. * @returns the length
  83775. */
  83776. length(): number;
  83777. /**
  83778. * Returns the Vector4 squared length (float).
  83779. * @returns the length squared
  83780. */
  83781. lengthSquared(): number;
  83782. /**
  83783. * Normalizes in place the Vector4.
  83784. * @returns the updated Vector4.
  83785. */
  83786. normalize(): Vector4;
  83787. /**
  83788. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  83789. * @returns this converted to a new vector3
  83790. */
  83791. toVector3(): Vector3;
  83792. /**
  83793. * Returns a new Vector4 copied from the current one.
  83794. * @returns the new cloned vector
  83795. */
  83796. clone(): Vector4;
  83797. /**
  83798. * Updates the current Vector4 with the given one coordinates.
  83799. * @param source the source vector to copy from
  83800. * @returns the updated Vector4.
  83801. */
  83802. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  83803. /**
  83804. * Updates the current Vector4 coordinates with the given floats.
  83805. * @param x float to copy from
  83806. * @param y float to copy from
  83807. * @param z float to copy from
  83808. * @param w float to copy from
  83809. * @returns the updated Vector4.
  83810. */
  83811. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  83812. /**
  83813. * Updates the current Vector4 coordinates with the given floats.
  83814. * @param x float to set from
  83815. * @param y float to set from
  83816. * @param z float to set from
  83817. * @param w float to set from
  83818. * @returns the updated Vector4.
  83819. */
  83820. set(x: number, y: number, z: number, w: number): Vector4;
  83821. /**
  83822. * Copies the given float to the current Vector3 coordinates
  83823. * @param v defines the x, y, z and w coordinates of the operand
  83824. * @returns the current updated Vector3
  83825. */
  83826. setAll(v: number): Vector4;
  83827. /**
  83828. * Returns a new Vector4 set from the starting index of the given array.
  83829. * @param array the array to pull values from
  83830. * @param offset the offset into the array to start at
  83831. * @returns the new vector
  83832. */
  83833. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  83834. /**
  83835. * Updates the given vector "result" from the starting index of the given array.
  83836. * @param array the array to pull values from
  83837. * @param offset the offset into the array to start at
  83838. * @param result the vector to store the result in
  83839. */
  83840. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  83841. /**
  83842. * Updates the given vector "result" from the starting index of the given Float32Array.
  83843. * @param array the array to pull values from
  83844. * @param offset the offset into the array to start at
  83845. * @param result the vector to store the result in
  83846. */
  83847. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  83848. /**
  83849. * Updates the given vector "result" coordinates from the given floats.
  83850. * @param x float to set from
  83851. * @param y float to set from
  83852. * @param z float to set from
  83853. * @param w float to set from
  83854. * @param result the vector to the floats in
  83855. */
  83856. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  83857. /**
  83858. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  83859. * @returns the new vector
  83860. */
  83861. static Zero(): Vector4;
  83862. /**
  83863. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  83864. * @returns the new vector
  83865. */
  83866. static One(): Vector4;
  83867. /**
  83868. * Returns a new normalized Vector4 from the given one.
  83869. * @param vector the vector to normalize
  83870. * @returns the vector
  83871. */
  83872. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  83873. /**
  83874. * Updates the given vector "result" from the normalization of the given one.
  83875. * @param vector the vector to normalize
  83876. * @param result the vector to store the result in
  83877. */
  83878. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  83879. /**
  83880. * Returns a vector with the minimum values from the left and right vectors
  83881. * @param left left vector to minimize
  83882. * @param right right vector to minimize
  83883. * @returns a new vector with the minimum of the left and right vector values
  83884. */
  83885. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  83886. /**
  83887. * Returns a vector with the maximum values from the left and right vectors
  83888. * @param left left vector to maximize
  83889. * @param right right vector to maximize
  83890. * @returns a new vector with the maximum of the left and right vector values
  83891. */
  83892. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  83893. /**
  83894. * Returns the distance (float) between the vectors "value1" and "value2".
  83895. * @param value1 value to calulate the distance between
  83896. * @param value2 value to calulate the distance between
  83897. * @return the distance between the two vectors
  83898. */
  83899. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  83900. /**
  83901. * Returns the squared distance (float) between the vectors "value1" and "value2".
  83902. * @param value1 value to calulate the distance between
  83903. * @param value2 value to calulate the distance between
  83904. * @return the distance between the two vectors squared
  83905. */
  83906. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  83907. /**
  83908. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  83909. * @param value1 value to calulate the center between
  83910. * @param value2 value to calulate the center between
  83911. * @return the center between the two vectors
  83912. */
  83913. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  83914. /**
  83915. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  83916. * This methods computes transformed normalized direction vectors only.
  83917. * @param vector the vector to transform
  83918. * @param transformation the transformation matrix to apply
  83919. * @returns the new vector
  83920. */
  83921. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  83922. /**
  83923. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  83924. * This methods computes transformed normalized direction vectors only.
  83925. * @param vector the vector to transform
  83926. * @param transformation the transformation matrix to apply
  83927. * @param result the vector to store the result in
  83928. */
  83929. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  83930. /**
  83931. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  83932. * This methods computes transformed normalized direction vectors only.
  83933. * @param x value to transform
  83934. * @param y value to transform
  83935. * @param z value to transform
  83936. * @param w value to transform
  83937. * @param transformation the transformation matrix to apply
  83938. * @param result the vector to store the results in
  83939. */
  83940. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  83941. /**
  83942. * Creates a new Vector4 from a Vector3
  83943. * @param source defines the source data
  83944. * @param w defines the 4th component (default is 0)
  83945. * @returns a new Vector4
  83946. */
  83947. static FromVector3(source: Vector3, w?: number): Vector4;
  83948. }
  83949. /**
  83950. * Class used to store quaternion data
  83951. * @see https://en.wikipedia.org/wiki/Quaternion
  83952. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  83953. */
  83954. export class Quaternion {
  83955. /** @hidden */
  83956. _x: number;
  83957. /** @hidden */
  83958. _y: number;
  83959. /** @hidden */
  83960. _z: number;
  83961. /** @hidden */
  83962. _w: number;
  83963. /** @hidden */
  83964. _isDirty: boolean;
  83965. /** Gets or sets the x coordinate */
  83966. get x(): number;
  83967. set x(value: number);
  83968. /** Gets or sets the y coordinate */
  83969. get y(): number;
  83970. set y(value: number);
  83971. /** Gets or sets the z coordinate */
  83972. get z(): number;
  83973. set z(value: number);
  83974. /** Gets or sets the w coordinate */
  83975. get w(): number;
  83976. set w(value: number);
  83977. /**
  83978. * Creates a new Quaternion from the given floats
  83979. * @param x defines the first component (0 by default)
  83980. * @param y defines the second component (0 by default)
  83981. * @param z defines the third component (0 by default)
  83982. * @param w defines the fourth component (1.0 by default)
  83983. */
  83984. constructor(x?: number, y?: number, z?: number, w?: number);
  83985. /**
  83986. * Gets a string representation for the current quaternion
  83987. * @returns a string with the Quaternion coordinates
  83988. */
  83989. toString(): string;
  83990. /**
  83991. * Gets the class name of the quaternion
  83992. * @returns the string "Quaternion"
  83993. */
  83994. getClassName(): string;
  83995. /**
  83996. * Gets a hash code for this quaternion
  83997. * @returns the quaternion hash code
  83998. */
  83999. getHashCode(): number;
  84000. /**
  84001. * Copy the quaternion to an array
  84002. * @returns a new array populated with 4 elements from the quaternion coordinates
  84003. */
  84004. asArray(): number[];
  84005. /**
  84006. * Check if two quaternions are equals
  84007. * @param otherQuaternion defines the second operand
  84008. * @return true if the current quaternion and the given one coordinates are strictly equals
  84009. */
  84010. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  84011. /**
  84012. * Gets a boolean if two quaternions are equals (using an epsilon value)
  84013. * @param otherQuaternion defines the other quaternion
  84014. * @param epsilon defines the minimal distance to consider equality
  84015. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  84016. */
  84017. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  84018. /**
  84019. * Clone the current quaternion
  84020. * @returns a new quaternion copied from the current one
  84021. */
  84022. clone(): Quaternion;
  84023. /**
  84024. * Copy a quaternion to the current one
  84025. * @param other defines the other quaternion
  84026. * @returns the updated current quaternion
  84027. */
  84028. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  84029. /**
  84030. * Updates the current quaternion with the given float coordinates
  84031. * @param x defines the x coordinate
  84032. * @param y defines the y coordinate
  84033. * @param z defines the z coordinate
  84034. * @param w defines the w coordinate
  84035. * @returns the updated current quaternion
  84036. */
  84037. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  84038. /**
  84039. * Updates the current quaternion from the given float coordinates
  84040. * @param x defines the x coordinate
  84041. * @param y defines the y coordinate
  84042. * @param z defines the z coordinate
  84043. * @param w defines the w coordinate
  84044. * @returns the updated current quaternion
  84045. */
  84046. set(x: number, y: number, z: number, w: number): Quaternion;
  84047. /**
  84048. * Adds two quaternions
  84049. * @param other defines the second operand
  84050. * @returns a new quaternion as the addition result of the given one and the current quaternion
  84051. */
  84052. add(other: DeepImmutable<Quaternion>): Quaternion;
  84053. /**
  84054. * Add a quaternion to the current one
  84055. * @param other defines the quaternion to add
  84056. * @returns the current quaternion
  84057. */
  84058. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  84059. /**
  84060. * Subtract two quaternions
  84061. * @param other defines the second operand
  84062. * @returns a new quaternion as the subtraction result of the given one from the current one
  84063. */
  84064. subtract(other: Quaternion): Quaternion;
  84065. /**
  84066. * Multiplies the current quaternion by a scale factor
  84067. * @param value defines the scale factor
  84068. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  84069. */
  84070. scale(value: number): Quaternion;
  84071. /**
  84072. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  84073. * @param scale defines the scale factor
  84074. * @param result defines the Quaternion object where to store the result
  84075. * @returns the unmodified current quaternion
  84076. */
  84077. scaleToRef(scale: number, result: Quaternion): Quaternion;
  84078. /**
  84079. * Multiplies in place the current quaternion by a scale factor
  84080. * @param value defines the scale factor
  84081. * @returns the current modified quaternion
  84082. */
  84083. scaleInPlace(value: number): Quaternion;
  84084. /**
  84085. * Scale the current quaternion values by a factor and add the result to a given quaternion
  84086. * @param scale defines the scale factor
  84087. * @param result defines the Quaternion object where to store the result
  84088. * @returns the unmodified current quaternion
  84089. */
  84090. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  84091. /**
  84092. * Multiplies two quaternions
  84093. * @param q1 defines the second operand
  84094. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  84095. */
  84096. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  84097. /**
  84098. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  84099. * @param q1 defines the second operand
  84100. * @param result defines the target quaternion
  84101. * @returns the current quaternion
  84102. */
  84103. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  84104. /**
  84105. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  84106. * @param q1 defines the second operand
  84107. * @returns the currentupdated quaternion
  84108. */
  84109. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  84110. /**
  84111. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  84112. * @param ref defines the target quaternion
  84113. * @returns the current quaternion
  84114. */
  84115. conjugateToRef(ref: Quaternion): Quaternion;
  84116. /**
  84117. * Conjugates in place (1-q) the current quaternion
  84118. * @returns the current updated quaternion
  84119. */
  84120. conjugateInPlace(): Quaternion;
  84121. /**
  84122. * Conjugates in place (1-q) the current quaternion
  84123. * @returns a new quaternion
  84124. */
  84125. conjugate(): Quaternion;
  84126. /**
  84127. * Gets length of current quaternion
  84128. * @returns the quaternion length (float)
  84129. */
  84130. length(): number;
  84131. /**
  84132. * Normalize in place the current quaternion
  84133. * @returns the current updated quaternion
  84134. */
  84135. normalize(): Quaternion;
  84136. /**
  84137. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  84138. * @param order is a reserved parameter and is ignored for now
  84139. * @returns a new Vector3 containing the Euler angles
  84140. */
  84141. toEulerAngles(order?: string): Vector3;
  84142. /**
  84143. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  84144. * @param result defines the vector which will be filled with the Euler angles
  84145. * @returns the current unchanged quaternion
  84146. */
  84147. toEulerAnglesToRef(result: Vector3): Quaternion;
  84148. /**
  84149. * Updates the given rotation matrix with the current quaternion values
  84150. * @param result defines the target matrix
  84151. * @returns the current unchanged quaternion
  84152. */
  84153. toRotationMatrix(result: Matrix): Quaternion;
  84154. /**
  84155. * Updates the current quaternion from the given rotation matrix values
  84156. * @param matrix defines the source matrix
  84157. * @returns the current updated quaternion
  84158. */
  84159. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  84160. /**
  84161. * Creates a new quaternion from a rotation matrix
  84162. * @param matrix defines the source matrix
  84163. * @returns a new quaternion created from the given rotation matrix values
  84164. */
  84165. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  84166. /**
  84167. * Updates the given quaternion with the given rotation matrix values
  84168. * @param matrix defines the source matrix
  84169. * @param result defines the target quaternion
  84170. */
  84171. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  84172. /**
  84173. * Returns the dot product (float) between the quaternions "left" and "right"
  84174. * @param left defines the left operand
  84175. * @param right defines the right operand
  84176. * @returns the dot product
  84177. */
  84178. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  84179. /**
  84180. * Checks if the two quaternions are close to each other
  84181. * @param quat0 defines the first quaternion to check
  84182. * @param quat1 defines the second quaternion to check
  84183. * @returns true if the two quaternions are close to each other
  84184. */
  84185. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  84186. /**
  84187. * Creates an empty quaternion
  84188. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  84189. */
  84190. static Zero(): Quaternion;
  84191. /**
  84192. * Inverse a given quaternion
  84193. * @param q defines the source quaternion
  84194. * @returns a new quaternion as the inverted current quaternion
  84195. */
  84196. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  84197. /**
  84198. * Inverse a given quaternion
  84199. * @param q defines the source quaternion
  84200. * @param result the quaternion the result will be stored in
  84201. * @returns the result quaternion
  84202. */
  84203. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  84204. /**
  84205. * Creates an identity quaternion
  84206. * @returns the identity quaternion
  84207. */
  84208. static Identity(): Quaternion;
  84209. /**
  84210. * Gets a boolean indicating if the given quaternion is identity
  84211. * @param quaternion defines the quaternion to check
  84212. * @returns true if the quaternion is identity
  84213. */
  84214. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  84215. /**
  84216. * Creates a quaternion from a rotation around an axis
  84217. * @param axis defines the axis to use
  84218. * @param angle defines the angle to use
  84219. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  84220. */
  84221. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  84222. /**
  84223. * Creates a rotation around an axis and stores it into the given quaternion
  84224. * @param axis defines the axis to use
  84225. * @param angle defines the angle to use
  84226. * @param result defines the target quaternion
  84227. * @returns the target quaternion
  84228. */
  84229. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  84230. /**
  84231. * Creates a new quaternion from data stored into an array
  84232. * @param array defines the data source
  84233. * @param offset defines the offset in the source array where the data starts
  84234. * @returns a new quaternion
  84235. */
  84236. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  84237. /**
  84238. * Updates the given quaternion "result" from the starting index of the given array.
  84239. * @param array the array to pull values from
  84240. * @param offset the offset into the array to start at
  84241. * @param result the quaternion to store the result in
  84242. */
  84243. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  84244. /**
  84245. * Create a quaternion from Euler rotation angles
  84246. * @param x Pitch
  84247. * @param y Yaw
  84248. * @param z Roll
  84249. * @returns the new Quaternion
  84250. */
  84251. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  84252. /**
  84253. * Updates a quaternion from Euler rotation angles
  84254. * @param x Pitch
  84255. * @param y Yaw
  84256. * @param z Roll
  84257. * @param result the quaternion to store the result
  84258. * @returns the updated quaternion
  84259. */
  84260. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  84261. /**
  84262. * Create a quaternion from Euler rotation vector
  84263. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  84264. * @returns the new Quaternion
  84265. */
  84266. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  84267. /**
  84268. * Updates a quaternion from Euler rotation vector
  84269. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  84270. * @param result the quaternion to store the result
  84271. * @returns the updated quaternion
  84272. */
  84273. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  84274. /**
  84275. * Creates a new quaternion from the given Euler float angles (y, x, z)
  84276. * @param yaw defines the rotation around Y axis
  84277. * @param pitch defines the rotation around X axis
  84278. * @param roll defines the rotation around Z axis
  84279. * @returns the new quaternion
  84280. */
  84281. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  84282. /**
  84283. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  84284. * @param yaw defines the rotation around Y axis
  84285. * @param pitch defines the rotation around X axis
  84286. * @param roll defines the rotation around Z axis
  84287. * @param result defines the target quaternion
  84288. */
  84289. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  84290. /**
  84291. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  84292. * @param alpha defines the rotation around first axis
  84293. * @param beta defines the rotation around second axis
  84294. * @param gamma defines the rotation around third axis
  84295. * @returns the new quaternion
  84296. */
  84297. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  84298. /**
  84299. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  84300. * @param alpha defines the rotation around first axis
  84301. * @param beta defines the rotation around second axis
  84302. * @param gamma defines the rotation around third axis
  84303. * @param result defines the target quaternion
  84304. */
  84305. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  84306. /**
  84307. * 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)
  84308. * @param axis1 defines the first axis
  84309. * @param axis2 defines the second axis
  84310. * @param axis3 defines the third axis
  84311. * @returns the new quaternion
  84312. */
  84313. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  84314. /**
  84315. * 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
  84316. * @param axis1 defines the first axis
  84317. * @param axis2 defines the second axis
  84318. * @param axis3 defines the third axis
  84319. * @param ref defines the target quaternion
  84320. */
  84321. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  84322. /**
  84323. * Interpolates between two quaternions
  84324. * @param left defines first quaternion
  84325. * @param right defines second quaternion
  84326. * @param amount defines the gradient to use
  84327. * @returns the new interpolated quaternion
  84328. */
  84329. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  84330. /**
  84331. * Interpolates between two quaternions and stores it into a target quaternion
  84332. * @param left defines first quaternion
  84333. * @param right defines second quaternion
  84334. * @param amount defines the gradient to use
  84335. * @param result defines the target quaternion
  84336. */
  84337. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  84338. /**
  84339. * Interpolate between two quaternions using Hermite interpolation
  84340. * @param value1 defines first quaternion
  84341. * @param tangent1 defines the incoming tangent
  84342. * @param value2 defines second quaternion
  84343. * @param tangent2 defines the outgoing tangent
  84344. * @param amount defines the target quaternion
  84345. * @returns the new interpolated quaternion
  84346. */
  84347. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  84348. }
  84349. /**
  84350. * Class used to store matrix data (4x4)
  84351. */
  84352. export class Matrix {
  84353. /**
  84354. * Gets the precision of matrix computations
  84355. */
  84356. static get Use64Bits(): boolean;
  84357. private static _updateFlagSeed;
  84358. private static _identityReadOnly;
  84359. private _isIdentity;
  84360. private _isIdentityDirty;
  84361. private _isIdentity3x2;
  84362. private _isIdentity3x2Dirty;
  84363. /**
  84364. * Gets the update flag of the matrix which is an unique number for the matrix.
  84365. * It will be incremented every time the matrix data change.
  84366. * You can use it to speed the comparison between two versions of the same matrix.
  84367. */
  84368. updateFlag: number;
  84369. private readonly _m;
  84370. /**
  84371. * Gets the internal data of the matrix
  84372. */
  84373. get m(): DeepImmutable<Float32Array | Array<number>>;
  84374. /** @hidden */
  84375. _markAsUpdated(): void;
  84376. /** @hidden */
  84377. private _updateIdentityStatus;
  84378. /**
  84379. * Creates an empty matrix (filled with zeros)
  84380. */
  84381. constructor();
  84382. /**
  84383. * Check if the current matrix is identity
  84384. * @returns true is the matrix is the identity matrix
  84385. */
  84386. isIdentity(): boolean;
  84387. /**
  84388. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  84389. * @returns true is the matrix is the identity matrix
  84390. */
  84391. isIdentityAs3x2(): boolean;
  84392. /**
  84393. * Gets the determinant of the matrix
  84394. * @returns the matrix determinant
  84395. */
  84396. determinant(): number;
  84397. /**
  84398. * Returns the matrix as a Float32Array or Array<number>
  84399. * @returns the matrix underlying array
  84400. */
  84401. toArray(): DeepImmutable<Float32Array | Array<number>>;
  84402. /**
  84403. * Returns the matrix as a Float32Array or Array<number>
  84404. * @returns the matrix underlying array.
  84405. */
  84406. asArray(): DeepImmutable<Float32Array | Array<number>>;
  84407. /**
  84408. * Inverts the current matrix in place
  84409. * @returns the current inverted matrix
  84410. */
  84411. invert(): Matrix;
  84412. /**
  84413. * Sets all the matrix elements to zero
  84414. * @returns the current matrix
  84415. */
  84416. reset(): Matrix;
  84417. /**
  84418. * Adds the current matrix with a second one
  84419. * @param other defines the matrix to add
  84420. * @returns a new matrix as the addition of the current matrix and the given one
  84421. */
  84422. add(other: DeepImmutable<Matrix>): Matrix;
  84423. /**
  84424. * Sets the given matrix "result" to the addition of the current matrix and the given one
  84425. * @param other defines the matrix to add
  84426. * @param result defines the target matrix
  84427. * @returns the current matrix
  84428. */
  84429. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  84430. /**
  84431. * Adds in place the given matrix to the current matrix
  84432. * @param other defines the second operand
  84433. * @returns the current updated matrix
  84434. */
  84435. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  84436. /**
  84437. * Sets the given matrix to the current inverted Matrix
  84438. * @param other defines the target matrix
  84439. * @returns the unmodified current matrix
  84440. */
  84441. invertToRef(other: Matrix): Matrix;
  84442. /**
  84443. * add a value at the specified position in the current Matrix
  84444. * @param index the index of the value within the matrix. between 0 and 15.
  84445. * @param value the value to be added
  84446. * @returns the current updated matrix
  84447. */
  84448. addAtIndex(index: number, value: number): Matrix;
  84449. /**
  84450. * mutiply the specified position in the current Matrix by a value
  84451. * @param index the index of the value within the matrix. between 0 and 15.
  84452. * @param value the value to be added
  84453. * @returns the current updated matrix
  84454. */
  84455. multiplyAtIndex(index: number, value: number): Matrix;
  84456. /**
  84457. * Inserts the translation vector (using 3 floats) in the current matrix
  84458. * @param x defines the 1st component of the translation
  84459. * @param y defines the 2nd component of the translation
  84460. * @param z defines the 3rd component of the translation
  84461. * @returns the current updated matrix
  84462. */
  84463. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  84464. /**
  84465. * Adds the translation vector (using 3 floats) in the current matrix
  84466. * @param x defines the 1st component of the translation
  84467. * @param y defines the 2nd component of the translation
  84468. * @param z defines the 3rd component of the translation
  84469. * @returns the current updated matrix
  84470. */
  84471. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  84472. /**
  84473. * Inserts the translation vector in the current matrix
  84474. * @param vector3 defines the translation to insert
  84475. * @returns the current updated matrix
  84476. */
  84477. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  84478. /**
  84479. * Gets the translation value of the current matrix
  84480. * @returns a new Vector3 as the extracted translation from the matrix
  84481. */
  84482. getTranslation(): Vector3;
  84483. /**
  84484. * Fill a Vector3 with the extracted translation from the matrix
  84485. * @param result defines the Vector3 where to store the translation
  84486. * @returns the current matrix
  84487. */
  84488. getTranslationToRef(result: Vector3): Matrix;
  84489. /**
  84490. * Remove rotation and scaling part from the matrix
  84491. * @returns the updated matrix
  84492. */
  84493. removeRotationAndScaling(): Matrix;
  84494. /**
  84495. * Multiply two matrices
  84496. * @param other defines the second operand
  84497. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  84498. */
  84499. multiply(other: DeepImmutable<Matrix>): Matrix;
  84500. /**
  84501. * Copy the current matrix from the given one
  84502. * @param other defines the source matrix
  84503. * @returns the current updated matrix
  84504. */
  84505. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  84506. /**
  84507. * Populates the given array from the starting index with the current matrix values
  84508. * @param array defines the target array
  84509. * @param offset defines the offset in the target array where to start storing values
  84510. * @returns the current matrix
  84511. */
  84512. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  84513. /**
  84514. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  84515. * @param other defines the second operand
  84516. * @param result defines the matrix where to store the multiplication
  84517. * @returns the current matrix
  84518. */
  84519. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  84520. /**
  84521. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  84522. * @param other defines the second operand
  84523. * @param result defines the array where to store the multiplication
  84524. * @param offset defines the offset in the target array where to start storing values
  84525. * @returns the current matrix
  84526. */
  84527. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  84528. /**
  84529. * Check equality between this matrix and a second one
  84530. * @param value defines the second matrix to compare
  84531. * @returns true is the current matrix and the given one values are strictly equal
  84532. */
  84533. equals(value: DeepImmutable<Matrix>): boolean;
  84534. /**
  84535. * Clone the current matrix
  84536. * @returns a new matrix from the current matrix
  84537. */
  84538. clone(): Matrix;
  84539. /**
  84540. * Returns the name of the current matrix class
  84541. * @returns the string "Matrix"
  84542. */
  84543. getClassName(): string;
  84544. /**
  84545. * Gets the hash code of the current matrix
  84546. * @returns the hash code
  84547. */
  84548. getHashCode(): number;
  84549. /**
  84550. * Decomposes the current Matrix into a translation, rotation and scaling components
  84551. * @param scale defines the scale vector3 given as a reference to update
  84552. * @param rotation defines the rotation quaternion given as a reference to update
  84553. * @param translation defines the translation vector3 given as a reference to update
  84554. * @returns true if operation was successful
  84555. */
  84556. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  84557. /**
  84558. * Gets specific row of the matrix
  84559. * @param index defines the number of the row to get
  84560. * @returns the index-th row of the current matrix as a new Vector4
  84561. */
  84562. getRow(index: number): Nullable<Vector4>;
  84563. /**
  84564. * Sets the index-th row of the current matrix to the vector4 values
  84565. * @param index defines the number of the row to set
  84566. * @param row defines the target vector4
  84567. * @returns the updated current matrix
  84568. */
  84569. setRow(index: number, row: Vector4): Matrix;
  84570. /**
  84571. * Compute the transpose of the matrix
  84572. * @returns the new transposed matrix
  84573. */
  84574. transpose(): Matrix;
  84575. /**
  84576. * Compute the transpose of the matrix and store it in a given matrix
  84577. * @param result defines the target matrix
  84578. * @returns the current matrix
  84579. */
  84580. transposeToRef(result: Matrix): Matrix;
  84581. /**
  84582. * Sets the index-th row of the current matrix with the given 4 x float values
  84583. * @param index defines the row index
  84584. * @param x defines the x component to set
  84585. * @param y defines the y component to set
  84586. * @param z defines the z component to set
  84587. * @param w defines the w component to set
  84588. * @returns the updated current matrix
  84589. */
  84590. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  84591. /**
  84592. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  84593. * @param scale defines the scale factor
  84594. * @returns a new matrix
  84595. */
  84596. scale(scale: number): Matrix;
  84597. /**
  84598. * Scale the current matrix values by a factor to a given result matrix
  84599. * @param scale defines the scale factor
  84600. * @param result defines the matrix to store the result
  84601. * @returns the current matrix
  84602. */
  84603. scaleToRef(scale: number, result: Matrix): Matrix;
  84604. /**
  84605. * Scale the current matrix values by a factor and add the result to a given matrix
  84606. * @param scale defines the scale factor
  84607. * @param result defines the Matrix to store the result
  84608. * @returns the current matrix
  84609. */
  84610. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  84611. /**
  84612. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  84613. * @param ref matrix to store the result
  84614. */
  84615. toNormalMatrix(ref: Matrix): void;
  84616. /**
  84617. * Gets only rotation part of the current matrix
  84618. * @returns a new matrix sets to the extracted rotation matrix from the current one
  84619. */
  84620. getRotationMatrix(): Matrix;
  84621. /**
  84622. * Extracts the rotation matrix from the current one and sets it as the given "result"
  84623. * @param result defines the target matrix to store data to
  84624. * @returns the current matrix
  84625. */
  84626. getRotationMatrixToRef(result: Matrix): Matrix;
  84627. /**
  84628. * Toggles model matrix from being right handed to left handed in place and vice versa
  84629. */
  84630. toggleModelMatrixHandInPlace(): void;
  84631. /**
  84632. * Toggles projection matrix from being right handed to left handed in place and vice versa
  84633. */
  84634. toggleProjectionMatrixHandInPlace(): void;
  84635. /**
  84636. * Creates a matrix from an array
  84637. * @param array defines the source array
  84638. * @param offset defines an offset in the source array
  84639. * @returns a new Matrix set from the starting index of the given array
  84640. */
  84641. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  84642. /**
  84643. * Copy the content of an array into a given matrix
  84644. * @param array defines the source array
  84645. * @param offset defines an offset in the source array
  84646. * @param result defines the target matrix
  84647. */
  84648. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  84649. /**
  84650. * Stores an array into a matrix after having multiplied each component by a given factor
  84651. * @param array defines the source array
  84652. * @param offset defines the offset in the source array
  84653. * @param scale defines the scaling factor
  84654. * @param result defines the target matrix
  84655. */
  84656. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  84657. /**
  84658. * Gets an identity matrix that must not be updated
  84659. */
  84660. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  84661. /**
  84662. * Stores a list of values (16) inside a given matrix
  84663. * @param initialM11 defines 1st value of 1st row
  84664. * @param initialM12 defines 2nd value of 1st row
  84665. * @param initialM13 defines 3rd value of 1st row
  84666. * @param initialM14 defines 4th value of 1st row
  84667. * @param initialM21 defines 1st value of 2nd row
  84668. * @param initialM22 defines 2nd value of 2nd row
  84669. * @param initialM23 defines 3rd value of 2nd row
  84670. * @param initialM24 defines 4th value of 2nd row
  84671. * @param initialM31 defines 1st value of 3rd row
  84672. * @param initialM32 defines 2nd value of 3rd row
  84673. * @param initialM33 defines 3rd value of 3rd row
  84674. * @param initialM34 defines 4th value of 3rd row
  84675. * @param initialM41 defines 1st value of 4th row
  84676. * @param initialM42 defines 2nd value of 4th row
  84677. * @param initialM43 defines 3rd value of 4th row
  84678. * @param initialM44 defines 4th value of 4th row
  84679. * @param result defines the target matrix
  84680. */
  84681. 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;
  84682. /**
  84683. * Creates new matrix from a list of values (16)
  84684. * @param initialM11 defines 1st value of 1st row
  84685. * @param initialM12 defines 2nd value of 1st row
  84686. * @param initialM13 defines 3rd value of 1st row
  84687. * @param initialM14 defines 4th value of 1st row
  84688. * @param initialM21 defines 1st value of 2nd row
  84689. * @param initialM22 defines 2nd value of 2nd row
  84690. * @param initialM23 defines 3rd value of 2nd row
  84691. * @param initialM24 defines 4th value of 2nd row
  84692. * @param initialM31 defines 1st value of 3rd row
  84693. * @param initialM32 defines 2nd value of 3rd row
  84694. * @param initialM33 defines 3rd value of 3rd row
  84695. * @param initialM34 defines 4th value of 3rd row
  84696. * @param initialM41 defines 1st value of 4th row
  84697. * @param initialM42 defines 2nd value of 4th row
  84698. * @param initialM43 defines 3rd value of 4th row
  84699. * @param initialM44 defines 4th value of 4th row
  84700. * @returns the new matrix
  84701. */
  84702. 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;
  84703. /**
  84704. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  84705. * @param scale defines the scale vector3
  84706. * @param rotation defines the rotation quaternion
  84707. * @param translation defines the translation vector3
  84708. * @returns a new matrix
  84709. */
  84710. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  84711. /**
  84712. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  84713. * @param scale defines the scale vector3
  84714. * @param rotation defines the rotation quaternion
  84715. * @param translation defines the translation vector3
  84716. * @param result defines the target matrix
  84717. */
  84718. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  84719. /**
  84720. * Creates a new identity matrix
  84721. * @returns a new identity matrix
  84722. */
  84723. static Identity(): Matrix;
  84724. /**
  84725. * Creates a new identity matrix and stores the result in a given matrix
  84726. * @param result defines the target matrix
  84727. */
  84728. static IdentityToRef(result: Matrix): void;
  84729. /**
  84730. * Creates a new zero matrix
  84731. * @returns a new zero matrix
  84732. */
  84733. static Zero(): Matrix;
  84734. /**
  84735. * Creates a new rotation matrix for "angle" radians around the X axis
  84736. * @param angle defines the angle (in radians) to use
  84737. * @return the new matrix
  84738. */
  84739. static RotationX(angle: number): Matrix;
  84740. /**
  84741. * Creates a new matrix as the invert of a given matrix
  84742. * @param source defines the source matrix
  84743. * @returns the new matrix
  84744. */
  84745. static Invert(source: DeepImmutable<Matrix>): Matrix;
  84746. /**
  84747. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  84748. * @param angle defines the angle (in radians) to use
  84749. * @param result defines the target matrix
  84750. */
  84751. static RotationXToRef(angle: number, result: Matrix): void;
  84752. /**
  84753. * Creates a new rotation matrix for "angle" radians around the Y axis
  84754. * @param angle defines the angle (in radians) to use
  84755. * @return the new matrix
  84756. */
  84757. static RotationY(angle: number): Matrix;
  84758. /**
  84759. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  84760. * @param angle defines the angle (in radians) to use
  84761. * @param result defines the target matrix
  84762. */
  84763. static RotationYToRef(angle: number, result: Matrix): void;
  84764. /**
  84765. * Creates a new rotation matrix for "angle" radians around the Z axis
  84766. * @param angle defines the angle (in radians) to use
  84767. * @return the new matrix
  84768. */
  84769. static RotationZ(angle: number): Matrix;
  84770. /**
  84771. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  84772. * @param angle defines the angle (in radians) to use
  84773. * @param result defines the target matrix
  84774. */
  84775. static RotationZToRef(angle: number, result: Matrix): void;
  84776. /**
  84777. * Creates a new rotation matrix for "angle" radians around the given axis
  84778. * @param axis defines the axis to use
  84779. * @param angle defines the angle (in radians) to use
  84780. * @return the new matrix
  84781. */
  84782. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  84783. /**
  84784. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  84785. * @param axis defines the axis to use
  84786. * @param angle defines the angle (in radians) to use
  84787. * @param result defines the target matrix
  84788. */
  84789. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  84790. /**
  84791. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  84792. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  84793. * @param from defines the vector to align
  84794. * @param to defines the vector to align to
  84795. * @param result defines the target matrix
  84796. */
  84797. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  84798. /**
  84799. * Creates a rotation matrix
  84800. * @param yaw defines the yaw angle in radians (Y axis)
  84801. * @param pitch defines the pitch angle in radians (X axis)
  84802. * @param roll defines the roll angle in radians (Z axis)
  84803. * @returns the new rotation matrix
  84804. */
  84805. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  84806. /**
  84807. * Creates a rotation matrix and stores it in a given matrix
  84808. * @param yaw defines the yaw angle in radians (Y axis)
  84809. * @param pitch defines the pitch angle in radians (X axis)
  84810. * @param roll defines the roll angle in radians (Z axis)
  84811. * @param result defines the target matrix
  84812. */
  84813. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  84814. /**
  84815. * Creates a scaling matrix
  84816. * @param x defines the scale factor on X axis
  84817. * @param y defines the scale factor on Y axis
  84818. * @param z defines the scale factor on Z axis
  84819. * @returns the new matrix
  84820. */
  84821. static Scaling(x: number, y: number, z: number): Matrix;
  84822. /**
  84823. * Creates a scaling matrix and stores it in a given matrix
  84824. * @param x defines the scale factor on X axis
  84825. * @param y defines the scale factor on Y axis
  84826. * @param z defines the scale factor on Z axis
  84827. * @param result defines the target matrix
  84828. */
  84829. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  84830. /**
  84831. * Creates a translation matrix
  84832. * @param x defines the translation on X axis
  84833. * @param y defines the translation on Y axis
  84834. * @param z defines the translationon Z axis
  84835. * @returns the new matrix
  84836. */
  84837. static Translation(x: number, y: number, z: number): Matrix;
  84838. /**
  84839. * Creates a translation matrix and stores it in a given matrix
  84840. * @param x defines the translation on X axis
  84841. * @param y defines the translation on Y axis
  84842. * @param z defines the translationon Z axis
  84843. * @param result defines the target matrix
  84844. */
  84845. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  84846. /**
  84847. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  84848. * @param startValue defines the start value
  84849. * @param endValue defines the end value
  84850. * @param gradient defines the gradient factor
  84851. * @returns the new matrix
  84852. */
  84853. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  84854. /**
  84855. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  84856. * @param startValue defines the start value
  84857. * @param endValue defines the end value
  84858. * @param gradient defines the gradient factor
  84859. * @param result defines the Matrix object where to store data
  84860. */
  84861. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  84862. /**
  84863. * Builds a new matrix whose values are computed by:
  84864. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  84865. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  84866. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  84867. * @param startValue defines the first matrix
  84868. * @param endValue defines the second matrix
  84869. * @param gradient defines the gradient between the two matrices
  84870. * @returns the new matrix
  84871. */
  84872. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  84873. /**
  84874. * Update a matrix to values which are computed by:
  84875. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  84876. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  84877. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  84878. * @param startValue defines the first matrix
  84879. * @param endValue defines the second matrix
  84880. * @param gradient defines the gradient between the two matrices
  84881. * @param result defines the target matrix
  84882. */
  84883. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  84884. /**
  84885. * 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"
  84886. * This function works in left handed mode
  84887. * @param eye defines the final position of the entity
  84888. * @param target defines where the entity should look at
  84889. * @param up defines the up vector for the entity
  84890. * @returns the new matrix
  84891. */
  84892. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  84893. /**
  84894. * 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".
  84895. * This function works in left handed mode
  84896. * @param eye defines the final position of the entity
  84897. * @param target defines where the entity should look at
  84898. * @param up defines the up vector for the entity
  84899. * @param result defines the target matrix
  84900. */
  84901. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  84902. /**
  84903. * 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"
  84904. * This function works in right handed mode
  84905. * @param eye defines the final position of the entity
  84906. * @param target defines where the entity should look at
  84907. * @param up defines the up vector for the entity
  84908. * @returns the new matrix
  84909. */
  84910. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  84911. /**
  84912. * 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".
  84913. * This function works in right handed mode
  84914. * @param eye defines the final position of the entity
  84915. * @param target defines where the entity should look at
  84916. * @param up defines the up vector for the entity
  84917. * @param result defines the target matrix
  84918. */
  84919. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  84920. /**
  84921. * Create a left-handed orthographic projection matrix
  84922. * @param width defines the viewport width
  84923. * @param height defines the viewport height
  84924. * @param znear defines the near clip plane
  84925. * @param zfar defines the far clip plane
  84926. * @returns a new matrix as a left-handed orthographic projection matrix
  84927. */
  84928. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  84929. /**
  84930. * Store a left-handed orthographic projection to a given matrix
  84931. * @param width defines the viewport width
  84932. * @param height defines the viewport height
  84933. * @param znear defines the near clip plane
  84934. * @param zfar defines the far clip plane
  84935. * @param result defines the target matrix
  84936. */
  84937. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  84938. /**
  84939. * Create a left-handed orthographic projection matrix
  84940. * @param left defines the viewport left coordinate
  84941. * @param right defines the viewport right coordinate
  84942. * @param bottom defines the viewport bottom coordinate
  84943. * @param top defines the viewport top coordinate
  84944. * @param znear defines the near clip plane
  84945. * @param zfar defines the far clip plane
  84946. * @returns a new matrix as a left-handed orthographic projection matrix
  84947. */
  84948. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  84949. /**
  84950. * Stores a left-handed orthographic projection into a given matrix
  84951. * @param left defines the viewport left coordinate
  84952. * @param right defines the viewport right coordinate
  84953. * @param bottom defines the viewport bottom coordinate
  84954. * @param top defines the viewport top coordinate
  84955. * @param znear defines the near clip plane
  84956. * @param zfar defines the far clip plane
  84957. * @param result defines the target matrix
  84958. */
  84959. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  84960. /**
  84961. * Creates a right-handed orthographic projection matrix
  84962. * @param left defines the viewport left coordinate
  84963. * @param right defines the viewport right coordinate
  84964. * @param bottom defines the viewport bottom coordinate
  84965. * @param top defines the viewport top coordinate
  84966. * @param znear defines the near clip plane
  84967. * @param zfar defines the far clip plane
  84968. * @returns a new matrix as a right-handed orthographic projection matrix
  84969. */
  84970. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  84971. /**
  84972. * Stores a right-handed orthographic projection into a given matrix
  84973. * @param left defines the viewport left coordinate
  84974. * @param right defines the viewport right coordinate
  84975. * @param bottom defines the viewport bottom coordinate
  84976. * @param top defines the viewport top coordinate
  84977. * @param znear defines the near clip plane
  84978. * @param zfar defines the far clip plane
  84979. * @param result defines the target matrix
  84980. */
  84981. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  84982. /**
  84983. * Creates a left-handed perspective projection matrix
  84984. * @param width defines the viewport width
  84985. * @param height defines the viewport height
  84986. * @param znear defines the near clip plane
  84987. * @param zfar defines the far clip plane
  84988. * @returns a new matrix as a left-handed perspective projection matrix
  84989. */
  84990. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  84991. /**
  84992. * Creates a left-handed perspective projection matrix
  84993. * @param fov defines the horizontal field of view
  84994. * @param aspect defines the aspect ratio
  84995. * @param znear defines the near clip plane
  84996. * @param zfar defines the far clip plane
  84997. * @returns a new matrix as a left-handed perspective projection matrix
  84998. */
  84999. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  85000. /**
  85001. * Stores a left-handed perspective projection into a given matrix
  85002. * @param fov defines the horizontal field of view
  85003. * @param aspect defines the aspect ratio
  85004. * @param znear defines the near clip plane
  85005. * @param zfar defines the far clip plane
  85006. * @param result defines the target matrix
  85007. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  85008. */
  85009. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  85010. /**
  85011. * Stores a left-handed perspective projection into a given matrix with depth reversed
  85012. * @param fov defines the horizontal field of view
  85013. * @param aspect defines the aspect ratio
  85014. * @param znear defines the near clip plane
  85015. * @param zfar not used as infinity is used as far clip
  85016. * @param result defines the target matrix
  85017. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  85018. */
  85019. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  85020. /**
  85021. * Creates a right-handed perspective projection matrix
  85022. * @param fov defines the horizontal field of view
  85023. * @param aspect defines the aspect ratio
  85024. * @param znear defines the near clip plane
  85025. * @param zfar defines the far clip plane
  85026. * @returns a new matrix as a right-handed perspective projection matrix
  85027. */
  85028. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  85029. /**
  85030. * Stores a right-handed perspective projection into a given matrix
  85031. * @param fov defines the horizontal field of view
  85032. * @param aspect defines the aspect ratio
  85033. * @param znear defines the near clip plane
  85034. * @param zfar defines the far clip plane
  85035. * @param result defines the target matrix
  85036. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  85037. */
  85038. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  85039. /**
  85040. * Stores a right-handed perspective projection into a given matrix
  85041. * @param fov defines the horizontal field of view
  85042. * @param aspect defines the aspect ratio
  85043. * @param znear defines the near clip plane
  85044. * @param zfar not used as infinity is used as far clip
  85045. * @param result defines the target matrix
  85046. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  85047. */
  85048. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  85049. /**
  85050. * Stores a perspective projection for WebVR info a given matrix
  85051. * @param fov defines the field of view
  85052. * @param znear defines the near clip plane
  85053. * @param zfar defines the far clip plane
  85054. * @param result defines the target matrix
  85055. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  85056. */
  85057. static PerspectiveFovWebVRToRef(fov: {
  85058. upDegrees: number;
  85059. downDegrees: number;
  85060. leftDegrees: number;
  85061. rightDegrees: number;
  85062. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  85063. /**
  85064. * Computes a complete transformation matrix
  85065. * @param viewport defines the viewport to use
  85066. * @param world defines the world matrix
  85067. * @param view defines the view matrix
  85068. * @param projection defines the projection matrix
  85069. * @param zmin defines the near clip plane
  85070. * @param zmax defines the far clip plane
  85071. * @returns the transformation matrix
  85072. */
  85073. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  85074. /**
  85075. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  85076. * @param matrix defines the matrix to use
  85077. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  85078. */
  85079. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  85080. /**
  85081. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  85082. * @param matrix defines the matrix to use
  85083. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  85084. */
  85085. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  85086. /**
  85087. * Compute the transpose of a given matrix
  85088. * @param matrix defines the matrix to transpose
  85089. * @returns the new matrix
  85090. */
  85091. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  85092. /**
  85093. * Compute the transpose of a matrix and store it in a target matrix
  85094. * @param matrix defines the matrix to transpose
  85095. * @param result defines the target matrix
  85096. */
  85097. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  85098. /**
  85099. * Computes a reflection matrix from a plane
  85100. * @param plane defines the reflection plane
  85101. * @returns a new matrix
  85102. */
  85103. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  85104. /**
  85105. * Computes a reflection matrix from a plane
  85106. * @param plane defines the reflection plane
  85107. * @param result defines the target matrix
  85108. */
  85109. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  85110. /**
  85111. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  85112. * @param xaxis defines the value of the 1st axis
  85113. * @param yaxis defines the value of the 2nd axis
  85114. * @param zaxis defines the value of the 3rd axis
  85115. * @param result defines the target matrix
  85116. */
  85117. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  85118. /**
  85119. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  85120. * @param quat defines the quaternion to use
  85121. * @param result defines the target matrix
  85122. */
  85123. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  85124. }
  85125. /**
  85126. * @hidden
  85127. */
  85128. export class TmpVectors {
  85129. static Vector2: Vector2[];
  85130. static Vector3: Vector3[];
  85131. static Vector4: Vector4[];
  85132. static Quaternion: Quaternion[];
  85133. static Matrix: Matrix[];
  85134. }
  85135. }
  85136. declare module BABYLON {
  85137. /**
  85138. * Defines potential orientation for back face culling
  85139. */
  85140. export enum Orientation {
  85141. /**
  85142. * Clockwise
  85143. */
  85144. CW = 0,
  85145. /** Counter clockwise */
  85146. CCW = 1
  85147. }
  85148. /** Class used to represent a Bezier curve */
  85149. export class BezierCurve {
  85150. /**
  85151. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  85152. * @param t defines the time
  85153. * @param x1 defines the left coordinate on X axis
  85154. * @param y1 defines the left coordinate on Y axis
  85155. * @param x2 defines the right coordinate on X axis
  85156. * @param y2 defines the right coordinate on Y axis
  85157. * @returns the interpolated value
  85158. */
  85159. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  85160. }
  85161. /**
  85162. * Defines angle representation
  85163. */
  85164. export class Angle {
  85165. private _radians;
  85166. /**
  85167. * Creates an Angle object of "radians" radians (float).
  85168. * @param radians the angle in radians
  85169. */
  85170. constructor(radians: number);
  85171. /**
  85172. * Get value in degrees
  85173. * @returns the Angle value in degrees (float)
  85174. */
  85175. degrees(): number;
  85176. /**
  85177. * Get value in radians
  85178. * @returns the Angle value in radians (float)
  85179. */
  85180. radians(): number;
  85181. /**
  85182. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  85183. * @param a defines first point as the origin
  85184. * @param b defines point
  85185. * @returns a new Angle
  85186. */
  85187. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  85188. /**
  85189. * Gets a new Angle object from the given float in radians
  85190. * @param radians defines the angle value in radians
  85191. * @returns a new Angle
  85192. */
  85193. static FromRadians(radians: number): Angle;
  85194. /**
  85195. * Gets a new Angle object from the given float in degrees
  85196. * @param degrees defines the angle value in degrees
  85197. * @returns a new Angle
  85198. */
  85199. static FromDegrees(degrees: number): Angle;
  85200. }
  85201. /**
  85202. * This represents an arc in a 2d space.
  85203. */
  85204. export class Arc2 {
  85205. /** Defines the start point of the arc */
  85206. startPoint: Vector2;
  85207. /** Defines the mid point of the arc */
  85208. midPoint: Vector2;
  85209. /** Defines the end point of the arc */
  85210. endPoint: Vector2;
  85211. /**
  85212. * Defines the center point of the arc.
  85213. */
  85214. centerPoint: Vector2;
  85215. /**
  85216. * Defines the radius of the arc.
  85217. */
  85218. radius: number;
  85219. /**
  85220. * Defines the angle of the arc (from mid point to end point).
  85221. */
  85222. angle: Angle;
  85223. /**
  85224. * Defines the start angle of the arc (from start point to middle point).
  85225. */
  85226. startAngle: Angle;
  85227. /**
  85228. * Defines the orientation of the arc (clock wise/counter clock wise).
  85229. */
  85230. orientation: Orientation;
  85231. /**
  85232. * Creates an Arc object from the three given points : start, middle and end.
  85233. * @param startPoint Defines the start point of the arc
  85234. * @param midPoint Defines the midlle point of the arc
  85235. * @param endPoint Defines the end point of the arc
  85236. */
  85237. constructor(
  85238. /** Defines the start point of the arc */
  85239. startPoint: Vector2,
  85240. /** Defines the mid point of the arc */
  85241. midPoint: Vector2,
  85242. /** Defines the end point of the arc */
  85243. endPoint: Vector2);
  85244. }
  85245. /**
  85246. * Represents a 2D path made up of multiple 2D points
  85247. */
  85248. export class Path2 {
  85249. private _points;
  85250. private _length;
  85251. /**
  85252. * If the path start and end point are the same
  85253. */
  85254. closed: boolean;
  85255. /**
  85256. * Creates a Path2 object from the starting 2D coordinates x and y.
  85257. * @param x the starting points x value
  85258. * @param y the starting points y value
  85259. */
  85260. constructor(x: number, y: number);
  85261. /**
  85262. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  85263. * @param x the added points x value
  85264. * @param y the added points y value
  85265. * @returns the updated Path2.
  85266. */
  85267. addLineTo(x: number, y: number): Path2;
  85268. /**
  85269. * 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.
  85270. * @param midX middle point x value
  85271. * @param midY middle point y value
  85272. * @param endX end point x value
  85273. * @param endY end point y value
  85274. * @param numberOfSegments (default: 36)
  85275. * @returns the updated Path2.
  85276. */
  85277. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  85278. /**
  85279. * Closes the Path2.
  85280. * @returns the Path2.
  85281. */
  85282. close(): Path2;
  85283. /**
  85284. * Gets the sum of the distance between each sequential point in the path
  85285. * @returns the Path2 total length (float).
  85286. */
  85287. length(): number;
  85288. /**
  85289. * Gets the points which construct the path
  85290. * @returns the Path2 internal array of points.
  85291. */
  85292. getPoints(): Vector2[];
  85293. /**
  85294. * Retreives the point at the distance aways from the starting point
  85295. * @param normalizedLengthPosition the length along the path to retreive the point from
  85296. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  85297. */
  85298. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  85299. /**
  85300. * Creates a new path starting from an x and y position
  85301. * @param x starting x value
  85302. * @param y starting y value
  85303. * @returns a new Path2 starting at the coordinates (x, y).
  85304. */
  85305. static StartingAt(x: number, y: number): Path2;
  85306. }
  85307. /**
  85308. * Represents a 3D path made up of multiple 3D points
  85309. */
  85310. export class Path3D {
  85311. /**
  85312. * an array of Vector3, the curve axis of the Path3D
  85313. */
  85314. path: Vector3[];
  85315. private _curve;
  85316. private _distances;
  85317. private _tangents;
  85318. private _normals;
  85319. private _binormals;
  85320. private _raw;
  85321. private _alignTangentsWithPath;
  85322. private readonly _pointAtData;
  85323. /**
  85324. * new Path3D(path, normal, raw)
  85325. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  85326. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  85327. * @param path an array of Vector3, the curve axis of the Path3D
  85328. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  85329. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  85330. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  85331. */
  85332. constructor(
  85333. /**
  85334. * an array of Vector3, the curve axis of the Path3D
  85335. */
  85336. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  85337. /**
  85338. * Returns the Path3D array of successive Vector3 designing its curve.
  85339. * @returns the Path3D array of successive Vector3 designing its curve.
  85340. */
  85341. getCurve(): Vector3[];
  85342. /**
  85343. * Returns the Path3D array of successive Vector3 designing its curve.
  85344. * @returns the Path3D array of successive Vector3 designing its curve.
  85345. */
  85346. getPoints(): Vector3[];
  85347. /**
  85348. * @returns the computed length (float) of the path.
  85349. */
  85350. length(): number;
  85351. /**
  85352. * Returns an array populated with tangent vectors on each Path3D curve point.
  85353. * @returns an array populated with tangent vectors on each Path3D curve point.
  85354. */
  85355. getTangents(): Vector3[];
  85356. /**
  85357. * Returns an array populated with normal vectors on each Path3D curve point.
  85358. * @returns an array populated with normal vectors on each Path3D curve point.
  85359. */
  85360. getNormals(): Vector3[];
  85361. /**
  85362. * Returns an array populated with binormal vectors on each Path3D curve point.
  85363. * @returns an array populated with binormal vectors on each Path3D curve point.
  85364. */
  85365. getBinormals(): Vector3[];
  85366. /**
  85367. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  85368. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  85369. */
  85370. getDistances(): number[];
  85371. /**
  85372. * Returns an interpolated point along this path
  85373. * @param position the position of the point along this path, from 0.0 to 1.0
  85374. * @returns a new Vector3 as the point
  85375. */
  85376. getPointAt(position: number): Vector3;
  85377. /**
  85378. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  85379. * @param position the position of the point along this path, from 0.0 to 1.0
  85380. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  85381. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  85382. */
  85383. getTangentAt(position: number, interpolated?: boolean): Vector3;
  85384. /**
  85385. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  85386. * @param position the position of the point along this path, from 0.0 to 1.0
  85387. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  85388. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  85389. */
  85390. getNormalAt(position: number, interpolated?: boolean): Vector3;
  85391. /**
  85392. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  85393. * @param position the position of the point along this path, from 0.0 to 1.0
  85394. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  85395. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  85396. */
  85397. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  85398. /**
  85399. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  85400. * @param position the position of the point along this path, from 0.0 to 1.0
  85401. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  85402. */
  85403. getDistanceAt(position: number): number;
  85404. /**
  85405. * Returns the array index of the previous point of an interpolated point along this path
  85406. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  85407. * @returns the array index
  85408. */
  85409. getPreviousPointIndexAt(position: number): number;
  85410. /**
  85411. * 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)
  85412. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  85413. * @returns the sub position
  85414. */
  85415. getSubPositionAt(position: number): number;
  85416. /**
  85417. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  85418. * @param target the vector of which to get the closest position to
  85419. * @returns the position of the closest virtual point on this path to the target vector
  85420. */
  85421. getClosestPositionTo(target: Vector3): number;
  85422. /**
  85423. * Returns a sub path (slice) of this path
  85424. * @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
  85425. * @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
  85426. * @returns a sub path (slice) of this path
  85427. */
  85428. slice(start?: number, end?: number): Path3D;
  85429. /**
  85430. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  85431. * @param path path which all values are copied into the curves points
  85432. * @param firstNormal which should be projected onto the curve
  85433. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  85434. * @returns the same object updated.
  85435. */
  85436. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  85437. private _compute;
  85438. private _getFirstNonNullVector;
  85439. private _getLastNonNullVector;
  85440. private _normalVector;
  85441. /**
  85442. * Updates the point at data for an interpolated point along this curve
  85443. * @param position the position of the point along this curve, from 0.0 to 1.0
  85444. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  85445. * @returns the (updated) point at data
  85446. */
  85447. private _updatePointAtData;
  85448. /**
  85449. * Updates the point at data from the specified parameters
  85450. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  85451. * @param point the interpolated point
  85452. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  85453. */
  85454. private _setPointAtData;
  85455. /**
  85456. * Updates the point at interpolation matrix for the tangents, normals and binormals
  85457. */
  85458. private _updateInterpolationMatrix;
  85459. }
  85460. /**
  85461. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  85462. * A Curve3 is designed from a series of successive Vector3.
  85463. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  85464. */
  85465. export class Curve3 {
  85466. private _points;
  85467. private _length;
  85468. /**
  85469. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  85470. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  85471. * @param v1 (Vector3) the control point
  85472. * @param v2 (Vector3) the end point of the Quadratic Bezier
  85473. * @param nbPoints (integer) the wanted number of points in the curve
  85474. * @returns the created Curve3
  85475. */
  85476. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  85477. /**
  85478. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  85479. * @param v0 (Vector3) the origin point of the Cubic Bezier
  85480. * @param v1 (Vector3) the first control point
  85481. * @param v2 (Vector3) the second control point
  85482. * @param v3 (Vector3) the end point of the Cubic Bezier
  85483. * @param nbPoints (integer) the wanted number of points in the curve
  85484. * @returns the created Curve3
  85485. */
  85486. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  85487. /**
  85488. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  85489. * @param p1 (Vector3) the origin point of the Hermite Spline
  85490. * @param t1 (Vector3) the tangent vector at the origin point
  85491. * @param p2 (Vector3) the end point of the Hermite Spline
  85492. * @param t2 (Vector3) the tangent vector at the end point
  85493. * @param nbPoints (integer) the wanted number of points in the curve
  85494. * @returns the created Curve3
  85495. */
  85496. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  85497. /**
  85498. * Returns a Curve3 object along a CatmullRom Spline curve :
  85499. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  85500. * @param nbPoints (integer) the wanted number of points between each curve control points
  85501. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  85502. * @returns the created Curve3
  85503. */
  85504. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  85505. /**
  85506. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  85507. * A Curve3 is designed from a series of successive Vector3.
  85508. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  85509. * @param points points which make up the curve
  85510. */
  85511. constructor(points: Vector3[]);
  85512. /**
  85513. * @returns the Curve3 stored array of successive Vector3
  85514. */
  85515. getPoints(): Vector3[];
  85516. /**
  85517. * @returns the computed length (float) of the curve.
  85518. */
  85519. length(): number;
  85520. /**
  85521. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  85522. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  85523. * curveA and curveB keep unchanged.
  85524. * @param curve the curve to continue from this curve
  85525. * @returns the newly constructed curve
  85526. */
  85527. continue(curve: DeepImmutable<Curve3>): Curve3;
  85528. private _computeLength;
  85529. }
  85530. }
  85531. declare module BABYLON {
  85532. /**
  85533. * This represents the main contract an easing function should follow.
  85534. * Easing functions are used throughout the animation system.
  85535. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85536. */
  85537. export interface IEasingFunction {
  85538. /**
  85539. * Given an input gradient between 0 and 1, this returns the corrseponding value
  85540. * of the easing function.
  85541. * The link below provides some of the most common examples of easing functions.
  85542. * @see https://easings.net/
  85543. * @param gradient Defines the value between 0 and 1 we want the easing value for
  85544. * @returns the corresponding value on the curve defined by the easing function
  85545. */
  85546. ease(gradient: number): number;
  85547. }
  85548. /**
  85549. * Base class used for every default easing function.
  85550. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85551. */
  85552. export class EasingFunction implements IEasingFunction {
  85553. /**
  85554. * Interpolation follows the mathematical formula associated with the easing function.
  85555. */
  85556. static readonly EASINGMODE_EASEIN: number;
  85557. /**
  85558. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  85559. */
  85560. static readonly EASINGMODE_EASEOUT: number;
  85561. /**
  85562. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  85563. */
  85564. static readonly EASINGMODE_EASEINOUT: number;
  85565. private _easingMode;
  85566. /**
  85567. * Sets the easing mode of the current function.
  85568. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  85569. */
  85570. setEasingMode(easingMode: number): void;
  85571. /**
  85572. * Gets the current easing mode.
  85573. * @returns the easing mode
  85574. */
  85575. getEasingMode(): number;
  85576. /**
  85577. * @hidden
  85578. */
  85579. easeInCore(gradient: number): number;
  85580. /**
  85581. * Given an input gradient between 0 and 1, this returns the corresponding value
  85582. * of the easing function.
  85583. * @param gradient Defines the value between 0 and 1 we want the easing value for
  85584. * @returns the corresponding value on the curve defined by the easing function
  85585. */
  85586. ease(gradient: number): number;
  85587. }
  85588. /**
  85589. * Easing function with a circle shape (see link below).
  85590. * @see https://easings.net/#easeInCirc
  85591. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85592. */
  85593. export class CircleEase extends EasingFunction implements IEasingFunction {
  85594. /** @hidden */
  85595. easeInCore(gradient: number): number;
  85596. }
  85597. /**
  85598. * Easing function with a ease back shape (see link below).
  85599. * @see https://easings.net/#easeInBack
  85600. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85601. */
  85602. export class BackEase extends EasingFunction implements IEasingFunction {
  85603. /** Defines the amplitude of the function */
  85604. amplitude: number;
  85605. /**
  85606. * Instantiates a back ease easing
  85607. * @see https://easings.net/#easeInBack
  85608. * @param amplitude Defines the amplitude of the function
  85609. */
  85610. constructor(
  85611. /** Defines the amplitude of the function */
  85612. amplitude?: number);
  85613. /** @hidden */
  85614. easeInCore(gradient: number): number;
  85615. }
  85616. /**
  85617. * Easing function with a bouncing shape (see link below).
  85618. * @see https://easings.net/#easeInBounce
  85619. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85620. */
  85621. export class BounceEase extends EasingFunction implements IEasingFunction {
  85622. /** Defines the number of bounces */
  85623. bounces: number;
  85624. /** Defines the amplitude of the bounce */
  85625. bounciness: number;
  85626. /**
  85627. * Instantiates a bounce easing
  85628. * @see https://easings.net/#easeInBounce
  85629. * @param bounces Defines the number of bounces
  85630. * @param bounciness Defines the amplitude of the bounce
  85631. */
  85632. constructor(
  85633. /** Defines the number of bounces */
  85634. bounces?: number,
  85635. /** Defines the amplitude of the bounce */
  85636. bounciness?: number);
  85637. /** @hidden */
  85638. easeInCore(gradient: number): number;
  85639. }
  85640. /**
  85641. * Easing function with a power of 3 shape (see link below).
  85642. * @see https://easings.net/#easeInCubic
  85643. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85644. */
  85645. export class CubicEase extends EasingFunction implements IEasingFunction {
  85646. /** @hidden */
  85647. easeInCore(gradient: number): number;
  85648. }
  85649. /**
  85650. * Easing function with an elastic shape (see link below).
  85651. * @see https://easings.net/#easeInElastic
  85652. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85653. */
  85654. export class ElasticEase extends EasingFunction implements IEasingFunction {
  85655. /** Defines the number of oscillations*/
  85656. oscillations: number;
  85657. /** Defines the amplitude of the oscillations*/
  85658. springiness: number;
  85659. /**
  85660. * Instantiates an elastic easing function
  85661. * @see https://easings.net/#easeInElastic
  85662. * @param oscillations Defines the number of oscillations
  85663. * @param springiness Defines the amplitude of the oscillations
  85664. */
  85665. constructor(
  85666. /** Defines the number of oscillations*/
  85667. oscillations?: number,
  85668. /** Defines the amplitude of the oscillations*/
  85669. springiness?: number);
  85670. /** @hidden */
  85671. easeInCore(gradient: number): number;
  85672. }
  85673. /**
  85674. * Easing function with an exponential shape (see link below).
  85675. * @see https://easings.net/#easeInExpo
  85676. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85677. */
  85678. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  85679. /** Defines the exponent of the function */
  85680. exponent: number;
  85681. /**
  85682. * Instantiates an exponential easing function
  85683. * @see https://easings.net/#easeInExpo
  85684. * @param exponent Defines the exponent of the function
  85685. */
  85686. constructor(
  85687. /** Defines the exponent of the function */
  85688. exponent?: number);
  85689. /** @hidden */
  85690. easeInCore(gradient: number): number;
  85691. }
  85692. /**
  85693. * Easing function with a power shape (see link below).
  85694. * @see https://easings.net/#easeInQuad
  85695. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85696. */
  85697. export class PowerEase extends EasingFunction implements IEasingFunction {
  85698. /** Defines the power of the function */
  85699. power: number;
  85700. /**
  85701. * Instantiates an power base easing function
  85702. * @see https://easings.net/#easeInQuad
  85703. * @param power Defines the power of the function
  85704. */
  85705. constructor(
  85706. /** Defines the power of the function */
  85707. power?: number);
  85708. /** @hidden */
  85709. easeInCore(gradient: number): number;
  85710. }
  85711. /**
  85712. * Easing function with a power of 2 shape (see link below).
  85713. * @see https://easings.net/#easeInQuad
  85714. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85715. */
  85716. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  85717. /** @hidden */
  85718. easeInCore(gradient: number): number;
  85719. }
  85720. /**
  85721. * Easing function with a power of 4 shape (see link below).
  85722. * @see https://easings.net/#easeInQuart
  85723. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85724. */
  85725. export class QuarticEase extends EasingFunction implements IEasingFunction {
  85726. /** @hidden */
  85727. easeInCore(gradient: number): number;
  85728. }
  85729. /**
  85730. * Easing function with a power of 5 shape (see link below).
  85731. * @see https://easings.net/#easeInQuint
  85732. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85733. */
  85734. export class QuinticEase extends EasingFunction implements IEasingFunction {
  85735. /** @hidden */
  85736. easeInCore(gradient: number): number;
  85737. }
  85738. /**
  85739. * Easing function with a sin shape (see link below).
  85740. * @see https://easings.net/#easeInSine
  85741. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85742. */
  85743. export class SineEase extends EasingFunction implements IEasingFunction {
  85744. /** @hidden */
  85745. easeInCore(gradient: number): number;
  85746. }
  85747. /**
  85748. * Easing function with a bezier shape (see link below).
  85749. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  85750. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85751. */
  85752. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  85753. /** Defines the x component of the start tangent in the bezier curve */
  85754. x1: number;
  85755. /** Defines the y component of the start tangent in the bezier curve */
  85756. y1: number;
  85757. /** Defines the x component of the end tangent in the bezier curve */
  85758. x2: number;
  85759. /** Defines the y component of the end tangent in the bezier curve */
  85760. y2: number;
  85761. /**
  85762. * Instantiates a bezier function
  85763. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  85764. * @param x1 Defines the x component of the start tangent in the bezier curve
  85765. * @param y1 Defines the y component of the start tangent in the bezier curve
  85766. * @param x2 Defines the x component of the end tangent in the bezier curve
  85767. * @param y2 Defines the y component of the end tangent in the bezier curve
  85768. */
  85769. constructor(
  85770. /** Defines the x component of the start tangent in the bezier curve */
  85771. x1?: number,
  85772. /** Defines the y component of the start tangent in the bezier curve */
  85773. y1?: number,
  85774. /** Defines the x component of the end tangent in the bezier curve */
  85775. x2?: number,
  85776. /** Defines the y component of the end tangent in the bezier curve */
  85777. y2?: number);
  85778. /** @hidden */
  85779. easeInCore(gradient: number): number;
  85780. }
  85781. }
  85782. declare module BABYLON {
  85783. /**
  85784. * Class used to hold a RBG color
  85785. */
  85786. export class Color3 {
  85787. /**
  85788. * Defines the red component (between 0 and 1, default is 0)
  85789. */
  85790. r: number;
  85791. /**
  85792. * Defines the green component (between 0 and 1, default is 0)
  85793. */
  85794. g: number;
  85795. /**
  85796. * Defines the blue component (between 0 and 1, default is 0)
  85797. */
  85798. b: number;
  85799. /**
  85800. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  85801. * @param r defines the red component (between 0 and 1, default is 0)
  85802. * @param g defines the green component (between 0 and 1, default is 0)
  85803. * @param b defines the blue component (between 0 and 1, default is 0)
  85804. */
  85805. constructor(
  85806. /**
  85807. * Defines the red component (between 0 and 1, default is 0)
  85808. */
  85809. r?: number,
  85810. /**
  85811. * Defines the green component (between 0 and 1, default is 0)
  85812. */
  85813. g?: number,
  85814. /**
  85815. * Defines the blue component (between 0 and 1, default is 0)
  85816. */
  85817. b?: number);
  85818. /**
  85819. * Creates a string with the Color3 current values
  85820. * @returns the string representation of the Color3 object
  85821. */
  85822. toString(): string;
  85823. /**
  85824. * Returns the string "Color3"
  85825. * @returns "Color3"
  85826. */
  85827. getClassName(): string;
  85828. /**
  85829. * Compute the Color3 hash code
  85830. * @returns an unique number that can be used to hash Color3 objects
  85831. */
  85832. getHashCode(): number;
  85833. /**
  85834. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  85835. * @param array defines the array where to store the r,g,b components
  85836. * @param index defines an optional index in the target array to define where to start storing values
  85837. * @returns the current Color3 object
  85838. */
  85839. toArray(array: FloatArray, index?: number): Color3;
  85840. /**
  85841. * Update the current color with values stored in an array from the starting index of the given array
  85842. * @param array defines the source array
  85843. * @param offset defines an offset in the source array
  85844. * @returns the current Color3 object
  85845. */
  85846. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  85847. /**
  85848. * Returns a new Color4 object from the current Color3 and the given alpha
  85849. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  85850. * @returns a new Color4 object
  85851. */
  85852. toColor4(alpha?: number): Color4;
  85853. /**
  85854. * Returns a new array populated with 3 numeric elements : red, green and blue values
  85855. * @returns the new array
  85856. */
  85857. asArray(): number[];
  85858. /**
  85859. * Returns the luminance value
  85860. * @returns a float value
  85861. */
  85862. toLuminance(): number;
  85863. /**
  85864. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  85865. * @param otherColor defines the second operand
  85866. * @returns the new Color3 object
  85867. */
  85868. multiply(otherColor: DeepImmutable<Color3>): Color3;
  85869. /**
  85870. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  85871. * @param otherColor defines the second operand
  85872. * @param result defines the Color3 object where to store the result
  85873. * @returns the current Color3
  85874. */
  85875. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85876. /**
  85877. * Determines equality between Color3 objects
  85878. * @param otherColor defines the second operand
  85879. * @returns true if the rgb values are equal to the given ones
  85880. */
  85881. equals(otherColor: DeepImmutable<Color3>): boolean;
  85882. /**
  85883. * Determines equality between the current Color3 object and a set of r,b,g values
  85884. * @param r defines the red component to check
  85885. * @param g defines the green component to check
  85886. * @param b defines the blue component to check
  85887. * @returns true if the rgb values are equal to the given ones
  85888. */
  85889. equalsFloats(r: number, g: number, b: number): boolean;
  85890. /**
  85891. * Multiplies in place each rgb value by scale
  85892. * @param scale defines the scaling factor
  85893. * @returns the updated Color3
  85894. */
  85895. scale(scale: number): Color3;
  85896. /**
  85897. * Multiplies the rgb values by scale and stores the result into "result"
  85898. * @param scale defines the scaling factor
  85899. * @param result defines the Color3 object where to store the result
  85900. * @returns the unmodified current Color3
  85901. */
  85902. scaleToRef(scale: number, result: Color3): Color3;
  85903. /**
  85904. * Scale the current Color3 values by a factor and add the result to a given Color3
  85905. * @param scale defines the scale factor
  85906. * @param result defines color to store the result into
  85907. * @returns the unmodified current Color3
  85908. */
  85909. scaleAndAddToRef(scale: number, result: Color3): Color3;
  85910. /**
  85911. * Clamps the rgb values by the min and max values and stores the result into "result"
  85912. * @param min defines minimum clamping value (default is 0)
  85913. * @param max defines maximum clamping value (default is 1)
  85914. * @param result defines color to store the result into
  85915. * @returns the original Color3
  85916. */
  85917. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  85918. /**
  85919. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  85920. * @param otherColor defines the second operand
  85921. * @returns the new Color3
  85922. */
  85923. add(otherColor: DeepImmutable<Color3>): Color3;
  85924. /**
  85925. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  85926. * @param otherColor defines the second operand
  85927. * @param result defines Color3 object to store the result into
  85928. * @returns the unmodified current Color3
  85929. */
  85930. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85931. /**
  85932. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  85933. * @param otherColor defines the second operand
  85934. * @returns the new Color3
  85935. */
  85936. subtract(otherColor: DeepImmutable<Color3>): Color3;
  85937. /**
  85938. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  85939. * @param otherColor defines the second operand
  85940. * @param result defines Color3 object to store the result into
  85941. * @returns the unmodified current Color3
  85942. */
  85943. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85944. /**
  85945. * Copy the current object
  85946. * @returns a new Color3 copied the current one
  85947. */
  85948. clone(): Color3;
  85949. /**
  85950. * Copies the rgb values from the source in the current Color3
  85951. * @param source defines the source Color3 object
  85952. * @returns the updated Color3 object
  85953. */
  85954. copyFrom(source: DeepImmutable<Color3>): Color3;
  85955. /**
  85956. * Updates the Color3 rgb values from the given floats
  85957. * @param r defines the red component to read from
  85958. * @param g defines the green component to read from
  85959. * @param b defines the blue component to read from
  85960. * @returns the current Color3 object
  85961. */
  85962. copyFromFloats(r: number, g: number, b: number): Color3;
  85963. /**
  85964. * Updates the Color3 rgb values from the given floats
  85965. * @param r defines the red component to read from
  85966. * @param g defines the green component to read from
  85967. * @param b defines the blue component to read from
  85968. * @returns the current Color3 object
  85969. */
  85970. set(r: number, g: number, b: number): Color3;
  85971. /**
  85972. * Compute the Color3 hexadecimal code as a string
  85973. * @returns a string containing the hexadecimal representation of the Color3 object
  85974. */
  85975. toHexString(): string;
  85976. /**
  85977. * Computes a new Color3 converted from the current one to linear space
  85978. * @returns a new Color3 object
  85979. */
  85980. toLinearSpace(): Color3;
  85981. /**
  85982. * Converts current color in rgb space to HSV values
  85983. * @returns a new color3 representing the HSV values
  85984. */
  85985. toHSV(): Color3;
  85986. /**
  85987. * Converts current color in rgb space to HSV values
  85988. * @param result defines the Color3 where to store the HSV values
  85989. */
  85990. toHSVToRef(result: Color3): void;
  85991. /**
  85992. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  85993. * @param convertedColor defines the Color3 object where to store the linear space version
  85994. * @returns the unmodified Color3
  85995. */
  85996. toLinearSpaceToRef(convertedColor: Color3): Color3;
  85997. /**
  85998. * Computes a new Color3 converted from the current one to gamma space
  85999. * @returns a new Color3 object
  86000. */
  86001. toGammaSpace(): Color3;
  86002. /**
  86003. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  86004. * @param convertedColor defines the Color3 object where to store the gamma space version
  86005. * @returns the unmodified Color3
  86006. */
  86007. toGammaSpaceToRef(convertedColor: Color3): Color3;
  86008. private static _BlackReadOnly;
  86009. /**
  86010. * Convert Hue, saturation and value to a Color3 (RGB)
  86011. * @param hue defines the hue
  86012. * @param saturation defines the saturation
  86013. * @param value defines the value
  86014. * @param result defines the Color3 where to store the RGB values
  86015. */
  86016. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  86017. /**
  86018. * Creates a new Color3 from the string containing valid hexadecimal values
  86019. * @param hex defines a string containing valid hexadecimal values
  86020. * @returns a new Color3 object
  86021. */
  86022. static FromHexString(hex: string): Color3;
  86023. /**
  86024. * Creates a new Color3 from the starting index of the given array
  86025. * @param array defines the source array
  86026. * @param offset defines an offset in the source array
  86027. * @returns a new Color3 object
  86028. */
  86029. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  86030. /**
  86031. * Creates a new Color3 from the starting index element of the given array
  86032. * @param array defines the source array to read from
  86033. * @param offset defines the offset in the source array
  86034. * @param result defines the target Color3 object
  86035. */
  86036. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  86037. /**
  86038. * Creates a new Color3 from integer values (< 256)
  86039. * @param r defines the red component to read from (value between 0 and 255)
  86040. * @param g defines the green component to read from (value between 0 and 255)
  86041. * @param b defines the blue component to read from (value between 0 and 255)
  86042. * @returns a new Color3 object
  86043. */
  86044. static FromInts(r: number, g: number, b: number): Color3;
  86045. /**
  86046. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  86047. * @param start defines the start Color3 value
  86048. * @param end defines the end Color3 value
  86049. * @param amount defines the gradient value between start and end
  86050. * @returns a new Color3 object
  86051. */
  86052. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  86053. /**
  86054. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  86055. * @param left defines the start value
  86056. * @param right defines the end value
  86057. * @param amount defines the gradient factor
  86058. * @param result defines the Color3 object where to store the result
  86059. */
  86060. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  86061. /**
  86062. * Returns a Color3 value containing a red color
  86063. * @returns a new Color3 object
  86064. */
  86065. static Red(): Color3;
  86066. /**
  86067. * Returns a Color3 value containing a green color
  86068. * @returns a new Color3 object
  86069. */
  86070. static Green(): Color3;
  86071. /**
  86072. * Returns a Color3 value containing a blue color
  86073. * @returns a new Color3 object
  86074. */
  86075. static Blue(): Color3;
  86076. /**
  86077. * Returns a Color3 value containing a black color
  86078. * @returns a new Color3 object
  86079. */
  86080. static Black(): Color3;
  86081. /**
  86082. * Gets a Color3 value containing a black color that must not be updated
  86083. */
  86084. static get BlackReadOnly(): DeepImmutable<Color3>;
  86085. /**
  86086. * Returns a Color3 value containing a white color
  86087. * @returns a new Color3 object
  86088. */
  86089. static White(): Color3;
  86090. /**
  86091. * Returns a Color3 value containing a purple color
  86092. * @returns a new Color3 object
  86093. */
  86094. static Purple(): Color3;
  86095. /**
  86096. * Returns a Color3 value containing a magenta color
  86097. * @returns a new Color3 object
  86098. */
  86099. static Magenta(): Color3;
  86100. /**
  86101. * Returns a Color3 value containing a yellow color
  86102. * @returns a new Color3 object
  86103. */
  86104. static Yellow(): Color3;
  86105. /**
  86106. * Returns a Color3 value containing a gray color
  86107. * @returns a new Color3 object
  86108. */
  86109. static Gray(): Color3;
  86110. /**
  86111. * Returns a Color3 value containing a teal color
  86112. * @returns a new Color3 object
  86113. */
  86114. static Teal(): Color3;
  86115. /**
  86116. * Returns a Color3 value containing a random color
  86117. * @returns a new Color3 object
  86118. */
  86119. static Random(): Color3;
  86120. }
  86121. /**
  86122. * Class used to hold a RBGA color
  86123. */
  86124. export class Color4 {
  86125. /**
  86126. * Defines the red component (between 0 and 1, default is 0)
  86127. */
  86128. r: number;
  86129. /**
  86130. * Defines the green component (between 0 and 1, default is 0)
  86131. */
  86132. g: number;
  86133. /**
  86134. * Defines the blue component (between 0 and 1, default is 0)
  86135. */
  86136. b: number;
  86137. /**
  86138. * Defines the alpha component (between 0 and 1, default is 1)
  86139. */
  86140. a: number;
  86141. /**
  86142. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  86143. * @param r defines the red component (between 0 and 1, default is 0)
  86144. * @param g defines the green component (between 0 and 1, default is 0)
  86145. * @param b defines the blue component (between 0 and 1, default is 0)
  86146. * @param a defines the alpha component (between 0 and 1, default is 1)
  86147. */
  86148. constructor(
  86149. /**
  86150. * Defines the red component (between 0 and 1, default is 0)
  86151. */
  86152. r?: number,
  86153. /**
  86154. * Defines the green component (between 0 and 1, default is 0)
  86155. */
  86156. g?: number,
  86157. /**
  86158. * Defines the blue component (between 0 and 1, default is 0)
  86159. */
  86160. b?: number,
  86161. /**
  86162. * Defines the alpha component (between 0 and 1, default is 1)
  86163. */
  86164. a?: number);
  86165. /**
  86166. * Adds in place the given Color4 values to the current Color4 object
  86167. * @param right defines the second operand
  86168. * @returns the current updated Color4 object
  86169. */
  86170. addInPlace(right: DeepImmutable<Color4>): Color4;
  86171. /**
  86172. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  86173. * @returns the new array
  86174. */
  86175. asArray(): number[];
  86176. /**
  86177. * Stores from the starting index in the given array the Color4 successive values
  86178. * @param array defines the array where to store the r,g,b components
  86179. * @param index defines an optional index in the target array to define where to start storing values
  86180. * @returns the current Color4 object
  86181. */
  86182. toArray(array: number[], index?: number): Color4;
  86183. /**
  86184. * Update the current color with values stored in an array from the starting index of the given array
  86185. * @param array defines the source array
  86186. * @param offset defines an offset in the source array
  86187. * @returns the current Color4 object
  86188. */
  86189. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  86190. /**
  86191. * Determines equality between Color4 objects
  86192. * @param otherColor defines the second operand
  86193. * @returns true if the rgba values are equal to the given ones
  86194. */
  86195. equals(otherColor: DeepImmutable<Color4>): boolean;
  86196. /**
  86197. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  86198. * @param right defines the second operand
  86199. * @returns a new Color4 object
  86200. */
  86201. add(right: DeepImmutable<Color4>): Color4;
  86202. /**
  86203. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  86204. * @param right defines the second operand
  86205. * @returns a new Color4 object
  86206. */
  86207. subtract(right: DeepImmutable<Color4>): Color4;
  86208. /**
  86209. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  86210. * @param right defines the second operand
  86211. * @param result defines the Color4 object where to store the result
  86212. * @returns the current Color4 object
  86213. */
  86214. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  86215. /**
  86216. * Creates a new Color4 with the current Color4 values multiplied by scale
  86217. * @param scale defines the scaling factor to apply
  86218. * @returns a new Color4 object
  86219. */
  86220. scale(scale: number): Color4;
  86221. /**
  86222. * Multiplies the current Color4 values by scale and stores the result in "result"
  86223. * @param scale defines the scaling factor to apply
  86224. * @param result defines the Color4 object where to store the result
  86225. * @returns the current unmodified Color4
  86226. */
  86227. scaleToRef(scale: number, result: Color4): Color4;
  86228. /**
  86229. * Scale the current Color4 values by a factor and add the result to a given Color4
  86230. * @param scale defines the scale factor
  86231. * @param result defines the Color4 object where to store the result
  86232. * @returns the unmodified current Color4
  86233. */
  86234. scaleAndAddToRef(scale: number, result: Color4): Color4;
  86235. /**
  86236. * Clamps the rgb values by the min and max values and stores the result into "result"
  86237. * @param min defines minimum clamping value (default is 0)
  86238. * @param max defines maximum clamping value (default is 1)
  86239. * @param result defines color to store the result into.
  86240. * @returns the cuurent Color4
  86241. */
  86242. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  86243. /**
  86244. * Multipy an Color4 value by another and return a new Color4 object
  86245. * @param color defines the Color4 value to multiply by
  86246. * @returns a new Color4 object
  86247. */
  86248. multiply(color: Color4): Color4;
  86249. /**
  86250. * Multipy a Color4 value by another and push the result in a reference value
  86251. * @param color defines the Color4 value to multiply by
  86252. * @param result defines the Color4 to fill the result in
  86253. * @returns the result Color4
  86254. */
  86255. multiplyToRef(color: Color4, result: Color4): Color4;
  86256. /**
  86257. * Creates a string with the Color4 current values
  86258. * @returns the string representation of the Color4 object
  86259. */
  86260. toString(): string;
  86261. /**
  86262. * Returns the string "Color4"
  86263. * @returns "Color4"
  86264. */
  86265. getClassName(): string;
  86266. /**
  86267. * Compute the Color4 hash code
  86268. * @returns an unique number that can be used to hash Color4 objects
  86269. */
  86270. getHashCode(): number;
  86271. /**
  86272. * Creates a new Color4 copied from the current one
  86273. * @returns a new Color4 object
  86274. */
  86275. clone(): Color4;
  86276. /**
  86277. * Copies the given Color4 values into the current one
  86278. * @param source defines the source Color4 object
  86279. * @returns the current updated Color4 object
  86280. */
  86281. copyFrom(source: Color4): Color4;
  86282. /**
  86283. * Copies the given float values into the current one
  86284. * @param r defines the red component to read from
  86285. * @param g defines the green component to read from
  86286. * @param b defines the blue component to read from
  86287. * @param a defines the alpha component to read from
  86288. * @returns the current updated Color4 object
  86289. */
  86290. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  86291. /**
  86292. * Copies the given float values into the current one
  86293. * @param r defines the red component to read from
  86294. * @param g defines the green component to read from
  86295. * @param b defines the blue component to read from
  86296. * @param a defines the alpha component to read from
  86297. * @returns the current updated Color4 object
  86298. */
  86299. set(r: number, g: number, b: number, a: number): Color4;
  86300. /**
  86301. * Compute the Color4 hexadecimal code as a string
  86302. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  86303. * @returns a string containing the hexadecimal representation of the Color4 object
  86304. */
  86305. toHexString(returnAsColor3?: boolean): string;
  86306. /**
  86307. * Computes a new Color4 converted from the current one to linear space
  86308. * @returns a new Color4 object
  86309. */
  86310. toLinearSpace(): Color4;
  86311. /**
  86312. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  86313. * @param convertedColor defines the Color4 object where to store the linear space version
  86314. * @returns the unmodified Color4
  86315. */
  86316. toLinearSpaceToRef(convertedColor: Color4): Color4;
  86317. /**
  86318. * Computes a new Color4 converted from the current one to gamma space
  86319. * @returns a new Color4 object
  86320. */
  86321. toGammaSpace(): Color4;
  86322. /**
  86323. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  86324. * @param convertedColor defines the Color4 object where to store the gamma space version
  86325. * @returns the unmodified Color4
  86326. */
  86327. toGammaSpaceToRef(convertedColor: Color4): Color4;
  86328. /**
  86329. * Creates a new Color4 from the string containing valid hexadecimal values
  86330. * @param hex defines a string containing valid hexadecimal values
  86331. * @returns a new Color4 object
  86332. */
  86333. static FromHexString(hex: string): Color4;
  86334. /**
  86335. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  86336. * @param left defines the start value
  86337. * @param right defines the end value
  86338. * @param amount defines the gradient factor
  86339. * @returns a new Color4 object
  86340. */
  86341. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  86342. /**
  86343. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  86344. * @param left defines the start value
  86345. * @param right defines the end value
  86346. * @param amount defines the gradient factor
  86347. * @param result defines the Color4 object where to store data
  86348. */
  86349. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  86350. /**
  86351. * Creates a new Color4 from a Color3 and an alpha value
  86352. * @param color3 defines the source Color3 to read from
  86353. * @param alpha defines the alpha component (1.0 by default)
  86354. * @returns a new Color4 object
  86355. */
  86356. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  86357. /**
  86358. * Creates a new Color4 from the starting index element of the given array
  86359. * @param array defines the source array to read from
  86360. * @param offset defines the offset in the source array
  86361. * @returns a new Color4 object
  86362. */
  86363. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  86364. /**
  86365. * Creates a new Color4 from the starting index element of the given array
  86366. * @param array defines the source array to read from
  86367. * @param offset defines the offset in the source array
  86368. * @param result defines the target Color4 object
  86369. */
  86370. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  86371. /**
  86372. * Creates a new Color3 from integer values (< 256)
  86373. * @param r defines the red component to read from (value between 0 and 255)
  86374. * @param g defines the green component to read from (value between 0 and 255)
  86375. * @param b defines the blue component to read from (value between 0 and 255)
  86376. * @param a defines the alpha component to read from (value between 0 and 255)
  86377. * @returns a new Color3 object
  86378. */
  86379. static FromInts(r: number, g: number, b: number, a: number): Color4;
  86380. /**
  86381. * Check the content of a given array and convert it to an array containing RGBA data
  86382. * If the original array was already containing count * 4 values then it is returned directly
  86383. * @param colors defines the array to check
  86384. * @param count defines the number of RGBA data to expect
  86385. * @returns an array containing count * 4 values (RGBA)
  86386. */
  86387. static CheckColors4(colors: number[], count: number): number[];
  86388. }
  86389. /**
  86390. * @hidden
  86391. */
  86392. export class TmpColors {
  86393. static Color3: Color3[];
  86394. static Color4: Color4[];
  86395. }
  86396. }
  86397. declare module BABYLON {
  86398. /**
  86399. * Defines an interface which represents an animation key frame
  86400. */
  86401. export interface IAnimationKey {
  86402. /**
  86403. * Frame of the key frame
  86404. */
  86405. frame: number;
  86406. /**
  86407. * Value at the specifies key frame
  86408. */
  86409. value: any;
  86410. /**
  86411. * The input tangent for the cubic hermite spline
  86412. */
  86413. inTangent?: any;
  86414. /**
  86415. * The output tangent for the cubic hermite spline
  86416. */
  86417. outTangent?: any;
  86418. /**
  86419. * The animation interpolation type
  86420. */
  86421. interpolation?: AnimationKeyInterpolation;
  86422. }
  86423. /**
  86424. * Enum for the animation key frame interpolation type
  86425. */
  86426. export enum AnimationKeyInterpolation {
  86427. /**
  86428. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  86429. */
  86430. STEP = 1
  86431. }
  86432. }
  86433. declare module BABYLON {
  86434. /**
  86435. * Represents the range of an animation
  86436. */
  86437. export class AnimationRange {
  86438. /**The name of the animation range**/
  86439. name: string;
  86440. /**The starting frame of the animation */
  86441. from: number;
  86442. /**The ending frame of the animation*/
  86443. to: number;
  86444. /**
  86445. * Initializes the range of an animation
  86446. * @param name The name of the animation range
  86447. * @param from The starting frame of the animation
  86448. * @param to The ending frame of the animation
  86449. */
  86450. constructor(
  86451. /**The name of the animation range**/
  86452. name: string,
  86453. /**The starting frame of the animation */
  86454. from: number,
  86455. /**The ending frame of the animation*/
  86456. to: number);
  86457. /**
  86458. * Makes a copy of the animation range
  86459. * @returns A copy of the animation range
  86460. */
  86461. clone(): AnimationRange;
  86462. }
  86463. }
  86464. declare module BABYLON {
  86465. /**
  86466. * Composed of a frame, and an action function
  86467. */
  86468. export class AnimationEvent {
  86469. /** The frame for which the event is triggered **/
  86470. frame: number;
  86471. /** The event to perform when triggered **/
  86472. action: (currentFrame: number) => void;
  86473. /** Specifies if the event should be triggered only once**/
  86474. onlyOnce?: boolean | undefined;
  86475. /**
  86476. * Specifies if the animation event is done
  86477. */
  86478. isDone: boolean;
  86479. /**
  86480. * Initializes the animation event
  86481. * @param frame The frame for which the event is triggered
  86482. * @param action The event to perform when triggered
  86483. * @param onlyOnce Specifies if the event should be triggered only once
  86484. */
  86485. constructor(
  86486. /** The frame for which the event is triggered **/
  86487. frame: number,
  86488. /** The event to perform when triggered **/
  86489. action: (currentFrame: number) => void,
  86490. /** Specifies if the event should be triggered only once**/
  86491. onlyOnce?: boolean | undefined);
  86492. /** @hidden */
  86493. _clone(): AnimationEvent;
  86494. }
  86495. }
  86496. declare module BABYLON {
  86497. /**
  86498. * Interface used to define a behavior
  86499. */
  86500. export interface Behavior<T> {
  86501. /** gets or sets behavior's name */
  86502. name: string;
  86503. /**
  86504. * Function called when the behavior needs to be initialized (after attaching it to a target)
  86505. */
  86506. init(): void;
  86507. /**
  86508. * Called when the behavior is attached to a target
  86509. * @param target defines the target where the behavior is attached to
  86510. */
  86511. attach(target: T): void;
  86512. /**
  86513. * Called when the behavior is detached from its target
  86514. */
  86515. detach(): void;
  86516. }
  86517. /**
  86518. * Interface implemented by classes supporting behaviors
  86519. */
  86520. export interface IBehaviorAware<T> {
  86521. /**
  86522. * Attach a behavior
  86523. * @param behavior defines the behavior to attach
  86524. * @returns the current host
  86525. */
  86526. addBehavior(behavior: Behavior<T>): T;
  86527. /**
  86528. * Remove a behavior from the current object
  86529. * @param behavior defines the behavior to detach
  86530. * @returns the current host
  86531. */
  86532. removeBehavior(behavior: Behavior<T>): T;
  86533. /**
  86534. * Gets a behavior using its name to search
  86535. * @param name defines the name to search
  86536. * @returns the behavior or null if not found
  86537. */
  86538. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  86539. }
  86540. }
  86541. declare module BABYLON {
  86542. /**
  86543. * Defines an array and its length.
  86544. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  86545. */
  86546. export interface ISmartArrayLike<T> {
  86547. /**
  86548. * The data of the array.
  86549. */
  86550. data: Array<T>;
  86551. /**
  86552. * The active length of the array.
  86553. */
  86554. length: number;
  86555. }
  86556. /**
  86557. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  86558. */
  86559. export class SmartArray<T> implements ISmartArrayLike<T> {
  86560. /**
  86561. * The full set of data from the array.
  86562. */
  86563. data: Array<T>;
  86564. /**
  86565. * The active length of the array.
  86566. */
  86567. length: number;
  86568. protected _id: number;
  86569. /**
  86570. * Instantiates a Smart Array.
  86571. * @param capacity defines the default capacity of the array.
  86572. */
  86573. constructor(capacity: number);
  86574. /**
  86575. * Pushes a value at the end of the active data.
  86576. * @param value defines the object to push in the array.
  86577. */
  86578. push(value: T): void;
  86579. /**
  86580. * Iterates over the active data and apply the lambda to them.
  86581. * @param func defines the action to apply on each value.
  86582. */
  86583. forEach(func: (content: T) => void): void;
  86584. /**
  86585. * Sorts the full sets of data.
  86586. * @param compareFn defines the comparison function to apply.
  86587. */
  86588. sort(compareFn: (a: T, b: T) => number): void;
  86589. /**
  86590. * Resets the active data to an empty array.
  86591. */
  86592. reset(): void;
  86593. /**
  86594. * Releases all the data from the array as well as the array.
  86595. */
  86596. dispose(): void;
  86597. /**
  86598. * Concats the active data with a given array.
  86599. * @param array defines the data to concatenate with.
  86600. */
  86601. concat(array: any): void;
  86602. /**
  86603. * Returns the position of a value in the active data.
  86604. * @param value defines the value to find the index for
  86605. * @returns the index if found in the active data otherwise -1
  86606. */
  86607. indexOf(value: T): number;
  86608. /**
  86609. * Returns whether an element is part of the active data.
  86610. * @param value defines the value to look for
  86611. * @returns true if found in the active data otherwise false
  86612. */
  86613. contains(value: T): boolean;
  86614. private static _GlobalId;
  86615. }
  86616. /**
  86617. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  86618. * The data in this array can only be present once
  86619. */
  86620. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  86621. private _duplicateId;
  86622. /**
  86623. * Pushes a value at the end of the active data.
  86624. * THIS DOES NOT PREVENT DUPPLICATE DATA
  86625. * @param value defines the object to push in the array.
  86626. */
  86627. push(value: T): void;
  86628. /**
  86629. * Pushes a value at the end of the active data.
  86630. * If the data is already present, it won t be added again
  86631. * @param value defines the object to push in the array.
  86632. * @returns true if added false if it was already present
  86633. */
  86634. pushNoDuplicate(value: T): boolean;
  86635. /**
  86636. * Resets the active data to an empty array.
  86637. */
  86638. reset(): void;
  86639. /**
  86640. * Concats the active data with a given array.
  86641. * This ensures no dupplicate will be present in the result.
  86642. * @param array defines the data to concatenate with.
  86643. */
  86644. concatWithNoDuplicate(array: any): void;
  86645. }
  86646. }
  86647. declare module BABYLON {
  86648. /**
  86649. * @ignore
  86650. * This is a list of all the different input types that are available in the application.
  86651. * Fo instance: ArcRotateCameraGamepadInput...
  86652. */
  86653. export var CameraInputTypes: {};
  86654. /**
  86655. * This is the contract to implement in order to create a new input class.
  86656. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  86657. */
  86658. export interface ICameraInput<TCamera extends Camera> {
  86659. /**
  86660. * Defines the camera the input is attached to.
  86661. */
  86662. camera: Nullable<TCamera>;
  86663. /**
  86664. * Gets the class name of the current intput.
  86665. * @returns the class name
  86666. */
  86667. getClassName(): string;
  86668. /**
  86669. * Get the friendly name associated with the input class.
  86670. * @returns the input friendly name
  86671. */
  86672. getSimpleName(): string;
  86673. /**
  86674. * Attach the input controls to a specific dom element to get the input from.
  86675. * @param element Defines the element the controls should be listened from
  86676. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86677. */
  86678. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  86679. /**
  86680. * Detach the current controls from the specified dom element.
  86681. * @param element Defines the element to stop listening the inputs from
  86682. */
  86683. detachControl(element: Nullable<HTMLElement>): void;
  86684. /**
  86685. * Update the current camera state depending on the inputs that have been used this frame.
  86686. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  86687. */
  86688. checkInputs?: () => void;
  86689. }
  86690. /**
  86691. * Represents a map of input types to input instance or input index to input instance.
  86692. */
  86693. export interface CameraInputsMap<TCamera extends Camera> {
  86694. /**
  86695. * Accessor to the input by input type.
  86696. */
  86697. [name: string]: ICameraInput<TCamera>;
  86698. /**
  86699. * Accessor to the input by input index.
  86700. */
  86701. [idx: number]: ICameraInput<TCamera>;
  86702. }
  86703. /**
  86704. * This represents the input manager used within a camera.
  86705. * It helps dealing with all the different kind of input attached to a camera.
  86706. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  86707. */
  86708. export class CameraInputsManager<TCamera extends Camera> {
  86709. /**
  86710. * Defines the list of inputs attahed to the camera.
  86711. */
  86712. attached: CameraInputsMap<TCamera>;
  86713. /**
  86714. * Defines the dom element the camera is collecting inputs from.
  86715. * This is null if the controls have not been attached.
  86716. */
  86717. attachedElement: Nullable<HTMLElement>;
  86718. /**
  86719. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86720. */
  86721. noPreventDefault: boolean;
  86722. /**
  86723. * Defined the camera the input manager belongs to.
  86724. */
  86725. camera: TCamera;
  86726. /**
  86727. * Update the current camera state depending on the inputs that have been used this frame.
  86728. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  86729. */
  86730. checkInputs: () => void;
  86731. /**
  86732. * Instantiate a new Camera Input Manager.
  86733. * @param camera Defines the camera the input manager blongs to
  86734. */
  86735. constructor(camera: TCamera);
  86736. /**
  86737. * Add an input method to a camera
  86738. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  86739. * @param input camera input method
  86740. */
  86741. add(input: ICameraInput<TCamera>): void;
  86742. /**
  86743. * Remove a specific input method from a camera
  86744. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  86745. * @param inputToRemove camera input method
  86746. */
  86747. remove(inputToRemove: ICameraInput<TCamera>): void;
  86748. /**
  86749. * Remove a specific input type from a camera
  86750. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  86751. * @param inputType the type of the input to remove
  86752. */
  86753. removeByType(inputType: string): void;
  86754. private _addCheckInputs;
  86755. /**
  86756. * Attach the input controls to the currently attached dom element to listen the events from.
  86757. * @param input Defines the input to attach
  86758. */
  86759. attachInput(input: ICameraInput<TCamera>): void;
  86760. /**
  86761. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  86762. * @param element Defines the dom element to collect the events from
  86763. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86764. */
  86765. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  86766. /**
  86767. * Detach the current manager inputs controls from a specific dom element.
  86768. * @param element Defines the dom element to collect the events from
  86769. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  86770. */
  86771. detachElement(element: HTMLElement, disconnect?: boolean): void;
  86772. /**
  86773. * Rebuild the dynamic inputCheck function from the current list of
  86774. * defined inputs in the manager.
  86775. */
  86776. rebuildInputCheck(): void;
  86777. /**
  86778. * Remove all attached input methods from a camera
  86779. */
  86780. clear(): void;
  86781. /**
  86782. * Serialize the current input manager attached to a camera.
  86783. * This ensures than once parsed,
  86784. * the input associated to the camera will be identical to the current ones
  86785. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  86786. */
  86787. serialize(serializedCamera: any): void;
  86788. /**
  86789. * Parses an input manager serialized JSON to restore the previous list of inputs
  86790. * and states associated to a camera.
  86791. * @param parsedCamera Defines the JSON to parse
  86792. */
  86793. parse(parsedCamera: any): void;
  86794. }
  86795. }
  86796. declare module BABYLON {
  86797. /**
  86798. * Class used to store data that will be store in GPU memory
  86799. */
  86800. export class Buffer {
  86801. private _engine;
  86802. private _buffer;
  86803. /** @hidden */
  86804. _data: Nullable<DataArray>;
  86805. private _updatable;
  86806. private _instanced;
  86807. private _divisor;
  86808. /**
  86809. * Gets the byte stride.
  86810. */
  86811. readonly byteStride: number;
  86812. /**
  86813. * Constructor
  86814. * @param engine the engine
  86815. * @param data the data to use for this buffer
  86816. * @param updatable whether the data is updatable
  86817. * @param stride the stride (optional)
  86818. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  86819. * @param instanced whether the buffer is instanced (optional)
  86820. * @param useBytes set to true if the stride in in bytes (optional)
  86821. * @param divisor sets an optional divisor for instances (1 by default)
  86822. */
  86823. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  86824. /**
  86825. * Create a new VertexBuffer based on the current buffer
  86826. * @param kind defines the vertex buffer kind (position, normal, etc.)
  86827. * @param offset defines offset in the buffer (0 by default)
  86828. * @param size defines the size in floats of attributes (position is 3 for instance)
  86829. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  86830. * @param instanced defines if the vertex buffer contains indexed data
  86831. * @param useBytes defines if the offset and stride are in bytes *
  86832. * @param divisor sets an optional divisor for instances (1 by default)
  86833. * @returns the new vertex buffer
  86834. */
  86835. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  86836. /**
  86837. * Gets a boolean indicating if the Buffer is updatable?
  86838. * @returns true if the buffer is updatable
  86839. */
  86840. isUpdatable(): boolean;
  86841. /**
  86842. * Gets current buffer's data
  86843. * @returns a DataArray or null
  86844. */
  86845. getData(): Nullable<DataArray>;
  86846. /**
  86847. * Gets underlying native buffer
  86848. * @returns underlying native buffer
  86849. */
  86850. getBuffer(): Nullable<DataBuffer>;
  86851. /**
  86852. * Gets the stride in float32 units (i.e. byte stride / 4).
  86853. * May not be an integer if the byte stride is not divisible by 4.
  86854. * @returns the stride in float32 units
  86855. * @deprecated Please use byteStride instead.
  86856. */
  86857. getStrideSize(): number;
  86858. /**
  86859. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  86860. * @param data defines the data to store
  86861. */
  86862. create(data?: Nullable<DataArray>): void;
  86863. /** @hidden */
  86864. _rebuild(): void;
  86865. /**
  86866. * Update current buffer data
  86867. * @param data defines the data to store
  86868. */
  86869. update(data: DataArray): void;
  86870. /**
  86871. * Updates the data directly.
  86872. * @param data the new data
  86873. * @param offset the new offset
  86874. * @param vertexCount the vertex count (optional)
  86875. * @param useBytes set to true if the offset is in bytes
  86876. */
  86877. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  86878. /**
  86879. * Release all resources
  86880. */
  86881. dispose(): void;
  86882. }
  86883. /**
  86884. * Specialized buffer used to store vertex data
  86885. */
  86886. export class VertexBuffer {
  86887. /** @hidden */
  86888. _buffer: Buffer;
  86889. private _kind;
  86890. private _size;
  86891. private _ownsBuffer;
  86892. private _instanced;
  86893. private _instanceDivisor;
  86894. /**
  86895. * The byte type.
  86896. */
  86897. static readonly BYTE: number;
  86898. /**
  86899. * The unsigned byte type.
  86900. */
  86901. static readonly UNSIGNED_BYTE: number;
  86902. /**
  86903. * The short type.
  86904. */
  86905. static readonly SHORT: number;
  86906. /**
  86907. * The unsigned short type.
  86908. */
  86909. static readonly UNSIGNED_SHORT: number;
  86910. /**
  86911. * The integer type.
  86912. */
  86913. static readonly INT: number;
  86914. /**
  86915. * The unsigned integer type.
  86916. */
  86917. static readonly UNSIGNED_INT: number;
  86918. /**
  86919. * The float type.
  86920. */
  86921. static readonly FLOAT: number;
  86922. /**
  86923. * Gets or sets the instance divisor when in instanced mode
  86924. */
  86925. get instanceDivisor(): number;
  86926. set instanceDivisor(value: number);
  86927. /**
  86928. * Gets the byte stride.
  86929. */
  86930. readonly byteStride: number;
  86931. /**
  86932. * Gets the byte offset.
  86933. */
  86934. readonly byteOffset: number;
  86935. /**
  86936. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  86937. */
  86938. readonly normalized: boolean;
  86939. /**
  86940. * Gets the data type of each component in the array.
  86941. */
  86942. readonly type: number;
  86943. /**
  86944. * Constructor
  86945. * @param engine the engine
  86946. * @param data the data to use for this vertex buffer
  86947. * @param kind the vertex buffer kind
  86948. * @param updatable whether the data is updatable
  86949. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  86950. * @param stride the stride (optional)
  86951. * @param instanced whether the buffer is instanced (optional)
  86952. * @param offset the offset of the data (optional)
  86953. * @param size the number of components (optional)
  86954. * @param type the type of the component (optional)
  86955. * @param normalized whether the data contains normalized data (optional)
  86956. * @param useBytes set to true if stride and offset are in bytes (optional)
  86957. * @param divisor defines the instance divisor to use (1 by default)
  86958. */
  86959. 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);
  86960. /** @hidden */
  86961. _rebuild(): void;
  86962. /**
  86963. * Returns the kind of the VertexBuffer (string)
  86964. * @returns a string
  86965. */
  86966. getKind(): string;
  86967. /**
  86968. * Gets a boolean indicating if the VertexBuffer is updatable?
  86969. * @returns true if the buffer is updatable
  86970. */
  86971. isUpdatable(): boolean;
  86972. /**
  86973. * Gets current buffer's data
  86974. * @returns a DataArray or null
  86975. */
  86976. getData(): Nullable<DataArray>;
  86977. /**
  86978. * Gets underlying native buffer
  86979. * @returns underlying native buffer
  86980. */
  86981. getBuffer(): Nullable<DataBuffer>;
  86982. /**
  86983. * Gets the stride in float32 units (i.e. byte stride / 4).
  86984. * May not be an integer if the byte stride is not divisible by 4.
  86985. * @returns the stride in float32 units
  86986. * @deprecated Please use byteStride instead.
  86987. */
  86988. getStrideSize(): number;
  86989. /**
  86990. * Returns the offset as a multiple of the type byte length.
  86991. * @returns the offset in bytes
  86992. * @deprecated Please use byteOffset instead.
  86993. */
  86994. getOffset(): number;
  86995. /**
  86996. * Returns the number of components per vertex attribute (integer)
  86997. * @returns the size in float
  86998. */
  86999. getSize(): number;
  87000. /**
  87001. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  87002. * @returns true if this buffer is instanced
  87003. */
  87004. getIsInstanced(): boolean;
  87005. /**
  87006. * Returns the instancing divisor, zero for non-instanced (integer).
  87007. * @returns a number
  87008. */
  87009. getInstanceDivisor(): number;
  87010. /**
  87011. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  87012. * @param data defines the data to store
  87013. */
  87014. create(data?: DataArray): void;
  87015. /**
  87016. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  87017. * This function will create a new buffer if the current one is not updatable
  87018. * @param data defines the data to store
  87019. */
  87020. update(data: DataArray): void;
  87021. /**
  87022. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  87023. * Returns the directly updated WebGLBuffer.
  87024. * @param data the new data
  87025. * @param offset the new offset
  87026. * @param useBytes set to true if the offset is in bytes
  87027. */
  87028. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  87029. /**
  87030. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  87031. */
  87032. dispose(): void;
  87033. /**
  87034. * Enumerates each value of this vertex buffer as numbers.
  87035. * @param count the number of values to enumerate
  87036. * @param callback the callback function called for each value
  87037. */
  87038. forEach(count: number, callback: (value: number, index: number) => void): void;
  87039. /**
  87040. * Positions
  87041. */
  87042. static readonly PositionKind: string;
  87043. /**
  87044. * Normals
  87045. */
  87046. static readonly NormalKind: string;
  87047. /**
  87048. * Tangents
  87049. */
  87050. static readonly TangentKind: string;
  87051. /**
  87052. * Texture coordinates
  87053. */
  87054. static readonly UVKind: string;
  87055. /**
  87056. * Texture coordinates 2
  87057. */
  87058. static readonly UV2Kind: string;
  87059. /**
  87060. * Texture coordinates 3
  87061. */
  87062. static readonly UV3Kind: string;
  87063. /**
  87064. * Texture coordinates 4
  87065. */
  87066. static readonly UV4Kind: string;
  87067. /**
  87068. * Texture coordinates 5
  87069. */
  87070. static readonly UV5Kind: string;
  87071. /**
  87072. * Texture coordinates 6
  87073. */
  87074. static readonly UV6Kind: string;
  87075. /**
  87076. * Colors
  87077. */
  87078. static readonly ColorKind: string;
  87079. /**
  87080. * Matrix indices (for bones)
  87081. */
  87082. static readonly MatricesIndicesKind: string;
  87083. /**
  87084. * Matrix weights (for bones)
  87085. */
  87086. static readonly MatricesWeightsKind: string;
  87087. /**
  87088. * Additional matrix indices (for bones)
  87089. */
  87090. static readonly MatricesIndicesExtraKind: string;
  87091. /**
  87092. * Additional matrix weights (for bones)
  87093. */
  87094. static readonly MatricesWeightsExtraKind: string;
  87095. /**
  87096. * Deduces the stride given a kind.
  87097. * @param kind The kind string to deduce
  87098. * @returns The deduced stride
  87099. */
  87100. static DeduceStride(kind: string): number;
  87101. /**
  87102. * Gets the byte length of the given type.
  87103. * @param type the type
  87104. * @returns the number of bytes
  87105. */
  87106. static GetTypeByteLength(type: number): number;
  87107. /**
  87108. * Enumerates each value of the given parameters as numbers.
  87109. * @param data the data to enumerate
  87110. * @param byteOffset the byte offset of the data
  87111. * @param byteStride the byte stride of the data
  87112. * @param componentCount the number of components per element
  87113. * @param componentType the type of the component
  87114. * @param count the number of values to enumerate
  87115. * @param normalized whether the data is normalized
  87116. * @param callback the callback function called for each value
  87117. */
  87118. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  87119. private static _GetFloatValue;
  87120. }
  87121. }
  87122. declare module BABYLON {
  87123. /**
  87124. * The options Interface for creating a Capsule Mesh
  87125. */
  87126. export interface ICreateCapsuleOptions {
  87127. /** The Orientation of the capsule. Default : Vector3.Up() */
  87128. orientation?: Vector3;
  87129. /** Number of sub segments on the tube section of the capsule running parallel to orientation. */
  87130. subdivisions: number;
  87131. /** Number of cylindrical segments on the capsule. */
  87132. tessellation: number;
  87133. /** Height or Length of the capsule. */
  87134. height: number;
  87135. /** Radius of the capsule. */
  87136. radius: number;
  87137. /** Number of sub segments on the cap sections of the capsule running parallel to orientation. */
  87138. capSubdivisions: number;
  87139. /** Overwrite for the top radius. */
  87140. radiusTop?: number;
  87141. /** Overwrite for the bottom radius. */
  87142. radiusBottom?: number;
  87143. /** Overwrite for the top capSubdivisions. */
  87144. topCapSubdivisions?: number;
  87145. /** Overwrite for the bottom capSubdivisions. */
  87146. bottomCapSubdivisions?: number;
  87147. }
  87148. /**
  87149. * Class containing static functions to help procedurally build meshes
  87150. */
  87151. export class CapsuleBuilder {
  87152. /**
  87153. * Creates a capsule or a pill mesh
  87154. * @param name defines the name of the mesh
  87155. * @param options The constructors options.
  87156. * @param scene The scene the mesh is scoped to.
  87157. * @returns Capsule Mesh
  87158. */
  87159. static CreateCapsule(name: string, options: ICreateCapsuleOptions | undefined, scene: any): Mesh;
  87160. }
  87161. }
  87162. declare module BABYLON {
  87163. /**
  87164. * @hidden
  87165. */
  87166. export class IntersectionInfo {
  87167. bu: Nullable<number>;
  87168. bv: Nullable<number>;
  87169. distance: number;
  87170. faceId: number;
  87171. subMeshId: number;
  87172. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  87173. }
  87174. }
  87175. declare module BABYLON {
  87176. /**
  87177. * Class used to store bounding sphere information
  87178. */
  87179. export class BoundingSphere {
  87180. /**
  87181. * Gets the center of the bounding sphere in local space
  87182. */
  87183. readonly center: Vector3;
  87184. /**
  87185. * Radius of the bounding sphere in local space
  87186. */
  87187. radius: number;
  87188. /**
  87189. * Gets the center of the bounding sphere in world space
  87190. */
  87191. readonly centerWorld: Vector3;
  87192. /**
  87193. * Radius of the bounding sphere in world space
  87194. */
  87195. radiusWorld: number;
  87196. /**
  87197. * Gets the minimum vector in local space
  87198. */
  87199. readonly minimum: Vector3;
  87200. /**
  87201. * Gets the maximum vector in local space
  87202. */
  87203. readonly maximum: Vector3;
  87204. private _worldMatrix;
  87205. private static readonly TmpVector3;
  87206. /**
  87207. * Creates a new bounding sphere
  87208. * @param min defines the minimum vector (in local space)
  87209. * @param max defines the maximum vector (in local space)
  87210. * @param worldMatrix defines the new world matrix
  87211. */
  87212. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  87213. /**
  87214. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  87215. * @param min defines the new minimum vector (in local space)
  87216. * @param max defines the new maximum vector (in local space)
  87217. * @param worldMatrix defines the new world matrix
  87218. */
  87219. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  87220. /**
  87221. * Scale the current bounding sphere by applying a scale factor
  87222. * @param factor defines the scale factor to apply
  87223. * @returns the current bounding box
  87224. */
  87225. scale(factor: number): BoundingSphere;
  87226. /**
  87227. * Gets the world matrix of the bounding box
  87228. * @returns a matrix
  87229. */
  87230. getWorldMatrix(): DeepImmutable<Matrix>;
  87231. /** @hidden */
  87232. _update(worldMatrix: DeepImmutable<Matrix>): void;
  87233. /**
  87234. * Tests if the bounding sphere is intersecting the frustum planes
  87235. * @param frustumPlanes defines the frustum planes to test
  87236. * @returns true if there is an intersection
  87237. */
  87238. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  87239. /**
  87240. * Tests if the bounding sphere center is in between the frustum planes.
  87241. * Used for optimistic fast inclusion.
  87242. * @param frustumPlanes defines the frustum planes to test
  87243. * @returns true if the sphere center is in between the frustum planes
  87244. */
  87245. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  87246. /**
  87247. * Tests if a point is inside the bounding sphere
  87248. * @param point defines the point to test
  87249. * @returns true if the point is inside the bounding sphere
  87250. */
  87251. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  87252. /**
  87253. * Checks if two sphere intersct
  87254. * @param sphere0 sphere 0
  87255. * @param sphere1 sphere 1
  87256. * @returns true if the speres intersect
  87257. */
  87258. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  87259. }
  87260. }
  87261. declare module BABYLON {
  87262. /**
  87263. * Class used to store bounding box information
  87264. */
  87265. export class BoundingBox implements ICullable {
  87266. /**
  87267. * Gets the 8 vectors representing the bounding box in local space
  87268. */
  87269. readonly vectors: Vector3[];
  87270. /**
  87271. * Gets the center of the bounding box in local space
  87272. */
  87273. readonly center: Vector3;
  87274. /**
  87275. * Gets the center of the bounding box in world space
  87276. */
  87277. readonly centerWorld: Vector3;
  87278. /**
  87279. * Gets the extend size in local space
  87280. */
  87281. readonly extendSize: Vector3;
  87282. /**
  87283. * Gets the extend size in world space
  87284. */
  87285. readonly extendSizeWorld: Vector3;
  87286. /**
  87287. * Gets the OBB (object bounding box) directions
  87288. */
  87289. readonly directions: Vector3[];
  87290. /**
  87291. * Gets the 8 vectors representing the bounding box in world space
  87292. */
  87293. readonly vectorsWorld: Vector3[];
  87294. /**
  87295. * Gets the minimum vector in world space
  87296. */
  87297. readonly minimumWorld: Vector3;
  87298. /**
  87299. * Gets the maximum vector in world space
  87300. */
  87301. readonly maximumWorld: Vector3;
  87302. /**
  87303. * Gets the minimum vector in local space
  87304. */
  87305. readonly minimum: Vector3;
  87306. /**
  87307. * Gets the maximum vector in local space
  87308. */
  87309. readonly maximum: Vector3;
  87310. private _worldMatrix;
  87311. private static readonly TmpVector3;
  87312. /**
  87313. * @hidden
  87314. */
  87315. _tag: number;
  87316. /**
  87317. * Creates a new bounding box
  87318. * @param min defines the minimum vector (in local space)
  87319. * @param max defines the maximum vector (in local space)
  87320. * @param worldMatrix defines the new world matrix
  87321. */
  87322. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  87323. /**
  87324. * Recreates the entire bounding box from scratch as if we call the constructor in place
  87325. * @param min defines the new minimum vector (in local space)
  87326. * @param max defines the new maximum vector (in local space)
  87327. * @param worldMatrix defines the new world matrix
  87328. */
  87329. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  87330. /**
  87331. * Scale the current bounding box by applying a scale factor
  87332. * @param factor defines the scale factor to apply
  87333. * @returns the current bounding box
  87334. */
  87335. scale(factor: number): BoundingBox;
  87336. /**
  87337. * Gets the world matrix of the bounding box
  87338. * @returns a matrix
  87339. */
  87340. getWorldMatrix(): DeepImmutable<Matrix>;
  87341. /** @hidden */
  87342. _update(world: DeepImmutable<Matrix>): void;
  87343. /**
  87344. * Tests if the bounding box is intersecting the frustum planes
  87345. * @param frustumPlanes defines the frustum planes to test
  87346. * @returns true if there is an intersection
  87347. */
  87348. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  87349. /**
  87350. * Tests if the bounding box is entirely inside the frustum planes
  87351. * @param frustumPlanes defines the frustum planes to test
  87352. * @returns true if there is an inclusion
  87353. */
  87354. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  87355. /**
  87356. * Tests if a point is inside the bounding box
  87357. * @param point defines the point to test
  87358. * @returns true if the point is inside the bounding box
  87359. */
  87360. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  87361. /**
  87362. * Tests if the bounding box intersects with a bounding sphere
  87363. * @param sphere defines the sphere to test
  87364. * @returns true if there is an intersection
  87365. */
  87366. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  87367. /**
  87368. * Tests if the bounding box intersects with a box defined by a min and max vectors
  87369. * @param min defines the min vector to use
  87370. * @param max defines the max vector to use
  87371. * @returns true if there is an intersection
  87372. */
  87373. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  87374. /**
  87375. * Tests if two bounding boxes are intersections
  87376. * @param box0 defines the first box to test
  87377. * @param box1 defines the second box to test
  87378. * @returns true if there is an intersection
  87379. */
  87380. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  87381. /**
  87382. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  87383. * @param minPoint defines the minimum vector of the bounding box
  87384. * @param maxPoint defines the maximum vector of the bounding box
  87385. * @param sphereCenter defines the sphere center
  87386. * @param sphereRadius defines the sphere radius
  87387. * @returns true if there is an intersection
  87388. */
  87389. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  87390. /**
  87391. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  87392. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  87393. * @param frustumPlanes defines the frustum planes to test
  87394. * @return true if there is an inclusion
  87395. */
  87396. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  87397. /**
  87398. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  87399. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  87400. * @param frustumPlanes defines the frustum planes to test
  87401. * @return true if there is an intersection
  87402. */
  87403. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  87404. }
  87405. }
  87406. declare module BABYLON {
  87407. /** @hidden */
  87408. export class Collider {
  87409. /** Define if a collision was found */
  87410. collisionFound: boolean;
  87411. /**
  87412. * Define last intersection point in local space
  87413. */
  87414. intersectionPoint: Vector3;
  87415. /**
  87416. * Define last collided mesh
  87417. */
  87418. collidedMesh: Nullable<AbstractMesh>;
  87419. private _collisionPoint;
  87420. private _planeIntersectionPoint;
  87421. private _tempVector;
  87422. private _tempVector2;
  87423. private _tempVector3;
  87424. private _tempVector4;
  87425. private _edge;
  87426. private _baseToVertex;
  87427. private _destinationPoint;
  87428. private _slidePlaneNormal;
  87429. private _displacementVector;
  87430. /** @hidden */
  87431. _radius: Vector3;
  87432. /** @hidden */
  87433. _retry: number;
  87434. private _velocity;
  87435. private _basePoint;
  87436. private _epsilon;
  87437. /** @hidden */
  87438. _velocityWorldLength: number;
  87439. /** @hidden */
  87440. _basePointWorld: Vector3;
  87441. private _velocityWorld;
  87442. private _normalizedVelocity;
  87443. /** @hidden */
  87444. _initialVelocity: Vector3;
  87445. /** @hidden */
  87446. _initialPosition: Vector3;
  87447. private _nearestDistance;
  87448. private _collisionMask;
  87449. get collisionMask(): number;
  87450. set collisionMask(mask: number);
  87451. /**
  87452. * Gets the plane normal used to compute the sliding response (in local space)
  87453. */
  87454. get slidePlaneNormal(): Vector3;
  87455. /** @hidden */
  87456. _initialize(source: Vector3, dir: Vector3, e: number): void;
  87457. /** @hidden */
  87458. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  87459. /** @hidden */
  87460. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  87461. /** @hidden */
  87462. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  87463. /** @hidden */
  87464. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  87465. /** @hidden */
  87466. _getResponse(pos: Vector3, vel: Vector3): void;
  87467. }
  87468. }
  87469. declare module BABYLON {
  87470. /**
  87471. * Interface for cullable objects
  87472. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  87473. */
  87474. export interface ICullable {
  87475. /**
  87476. * Checks if the object or part of the object is in the frustum
  87477. * @param frustumPlanes Camera near/planes
  87478. * @returns true if the object is in frustum otherwise false
  87479. */
  87480. isInFrustum(frustumPlanes: Plane[]): boolean;
  87481. /**
  87482. * Checks if a cullable object (mesh...) is in the camera frustum
  87483. * Unlike isInFrustum this cheks the full bounding box
  87484. * @param frustumPlanes Camera near/planes
  87485. * @returns true if the object is in frustum otherwise false
  87486. */
  87487. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  87488. }
  87489. /**
  87490. * Info for a bounding data of a mesh
  87491. */
  87492. export class BoundingInfo implements ICullable {
  87493. /**
  87494. * Bounding box for the mesh
  87495. */
  87496. readonly boundingBox: BoundingBox;
  87497. /**
  87498. * Bounding sphere for the mesh
  87499. */
  87500. readonly boundingSphere: BoundingSphere;
  87501. private _isLocked;
  87502. private static readonly TmpVector3;
  87503. /**
  87504. * Constructs bounding info
  87505. * @param minimum min vector of the bounding box/sphere
  87506. * @param maximum max vector of the bounding box/sphere
  87507. * @param worldMatrix defines the new world matrix
  87508. */
  87509. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  87510. /**
  87511. * Recreates the entire bounding info from scratch as if we call the constructor in place
  87512. * @param min defines the new minimum vector (in local space)
  87513. * @param max defines the new maximum vector (in local space)
  87514. * @param worldMatrix defines the new world matrix
  87515. */
  87516. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  87517. /**
  87518. * min vector of the bounding box/sphere
  87519. */
  87520. get minimum(): Vector3;
  87521. /**
  87522. * max vector of the bounding box/sphere
  87523. */
  87524. get maximum(): Vector3;
  87525. /**
  87526. * If the info is locked and won't be updated to avoid perf overhead
  87527. */
  87528. get isLocked(): boolean;
  87529. set isLocked(value: boolean);
  87530. /**
  87531. * Updates the bounding sphere and box
  87532. * @param world world matrix to be used to update
  87533. */
  87534. update(world: DeepImmutable<Matrix>): void;
  87535. /**
  87536. * Recreate the bounding info to be centered around a specific point given a specific extend.
  87537. * @param center New center of the bounding info
  87538. * @param extend New extend of the bounding info
  87539. * @returns the current bounding info
  87540. */
  87541. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  87542. /**
  87543. * Scale the current bounding info by applying a scale factor
  87544. * @param factor defines the scale factor to apply
  87545. * @returns the current bounding info
  87546. */
  87547. scale(factor: number): BoundingInfo;
  87548. /**
  87549. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  87550. * @param frustumPlanes defines the frustum to test
  87551. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  87552. * @returns true if the bounding info is in the frustum planes
  87553. */
  87554. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  87555. /**
  87556. * Gets the world distance between the min and max points of the bounding box
  87557. */
  87558. get diagonalLength(): number;
  87559. /**
  87560. * Checks if a cullable object (mesh...) is in the camera frustum
  87561. * Unlike isInFrustum this cheks the full bounding box
  87562. * @param frustumPlanes Camera near/planes
  87563. * @returns true if the object is in frustum otherwise false
  87564. */
  87565. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  87566. /** @hidden */
  87567. _checkCollision(collider: Collider): boolean;
  87568. /**
  87569. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  87570. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  87571. * @param point the point to check intersection with
  87572. * @returns if the point intersects
  87573. */
  87574. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  87575. /**
  87576. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  87577. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  87578. * @param boundingInfo the bounding info to check intersection with
  87579. * @param precise if the intersection should be done using OBB
  87580. * @returns if the bounding info intersects
  87581. */
  87582. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  87583. }
  87584. }
  87585. declare module BABYLON {
  87586. /**
  87587. * Extracts minimum and maximum values from a list of indexed positions
  87588. * @param positions defines the positions to use
  87589. * @param indices defines the indices to the positions
  87590. * @param indexStart defines the start index
  87591. * @param indexCount defines the end index
  87592. * @param bias defines bias value to add to the result
  87593. * @return minimum and maximum values
  87594. */
  87595. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  87596. minimum: Vector3;
  87597. maximum: Vector3;
  87598. };
  87599. /**
  87600. * Extracts minimum and maximum values from a list of positions
  87601. * @param positions defines the positions to use
  87602. * @param start defines the start index in the positions array
  87603. * @param count defines the number of positions to handle
  87604. * @param bias defines bias value to add to the result
  87605. * @param stride defines the stride size to use (distance between two positions in the positions array)
  87606. * @return minimum and maximum values
  87607. */
  87608. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  87609. minimum: Vector3;
  87610. maximum: Vector3;
  87611. };
  87612. }
  87613. declare module BABYLON {
  87614. /** @hidden */
  87615. export class WebGLDataBuffer extends DataBuffer {
  87616. private _buffer;
  87617. constructor(resource: WebGLBuffer);
  87618. get underlyingResource(): any;
  87619. }
  87620. }
  87621. declare module BABYLON {
  87622. /** @hidden */
  87623. export class WebGLPipelineContext implements IPipelineContext {
  87624. engine: ThinEngine;
  87625. program: Nullable<WebGLProgram>;
  87626. context?: WebGLRenderingContext;
  87627. vertexShader?: WebGLShader;
  87628. fragmentShader?: WebGLShader;
  87629. isParallelCompiled: boolean;
  87630. onCompiled?: () => void;
  87631. transformFeedback?: WebGLTransformFeedback | null;
  87632. vertexCompilationError: Nullable<string>;
  87633. fragmentCompilationError: Nullable<string>;
  87634. programLinkError: Nullable<string>;
  87635. programValidationError: Nullable<string>;
  87636. get isAsync(): boolean;
  87637. get isReady(): boolean;
  87638. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  87639. _getVertexShaderCode(): string | null;
  87640. _getFragmentShaderCode(): string | null;
  87641. }
  87642. }
  87643. declare module BABYLON {
  87644. interface ThinEngine {
  87645. /**
  87646. * Create an uniform buffer
  87647. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  87648. * @param elements defines the content of the uniform buffer
  87649. * @returns the webGL uniform buffer
  87650. */
  87651. createUniformBuffer(elements: FloatArray): DataBuffer;
  87652. /**
  87653. * Create a dynamic uniform buffer
  87654. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  87655. * @param elements defines the content of the uniform buffer
  87656. * @returns the webGL uniform buffer
  87657. */
  87658. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  87659. /**
  87660. * Update an existing uniform buffer
  87661. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  87662. * @param uniformBuffer defines the target uniform buffer
  87663. * @param elements defines the content to update
  87664. * @param offset defines the offset in the uniform buffer where update should start
  87665. * @param count defines the size of the data to update
  87666. */
  87667. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  87668. /**
  87669. * Bind an uniform buffer to the current webGL context
  87670. * @param buffer defines the buffer to bind
  87671. */
  87672. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  87673. /**
  87674. * Bind a buffer to the current webGL context at a given location
  87675. * @param buffer defines the buffer to bind
  87676. * @param location defines the index where to bind the buffer
  87677. */
  87678. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  87679. /**
  87680. * Bind a specific block at a given index in a specific shader program
  87681. * @param pipelineContext defines the pipeline context to use
  87682. * @param blockName defines the block name
  87683. * @param index defines the index where to bind the block
  87684. */
  87685. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  87686. }
  87687. }
  87688. declare module BABYLON {
  87689. /**
  87690. * Uniform buffer objects.
  87691. *
  87692. * Handles blocks of uniform on the GPU.
  87693. *
  87694. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  87695. *
  87696. * For more information, please refer to :
  87697. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  87698. */
  87699. export class UniformBuffer {
  87700. private _engine;
  87701. private _buffer;
  87702. private _data;
  87703. private _bufferData;
  87704. private _dynamic?;
  87705. private _uniformLocations;
  87706. private _uniformSizes;
  87707. private _uniformLocationPointer;
  87708. private _needSync;
  87709. private _noUBO;
  87710. private _currentEffect;
  87711. /** @hidden */
  87712. _alreadyBound: boolean;
  87713. private static _MAX_UNIFORM_SIZE;
  87714. private static _tempBuffer;
  87715. /**
  87716. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  87717. * This is dynamic to allow compat with webgl 1 and 2.
  87718. * You will need to pass the name of the uniform as well as the value.
  87719. */
  87720. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  87721. /**
  87722. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  87723. * This is dynamic to allow compat with webgl 1 and 2.
  87724. * You will need to pass the name of the uniform as well as the value.
  87725. */
  87726. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  87727. /**
  87728. * Lambda to Update a single float in a uniform buffer.
  87729. * This is dynamic to allow compat with webgl 1 and 2.
  87730. * You will need to pass the name of the uniform as well as the value.
  87731. */
  87732. updateFloat: (name: string, x: number) => void;
  87733. /**
  87734. * Lambda to Update a vec2 of float in a uniform buffer.
  87735. * This is dynamic to allow compat with webgl 1 and 2.
  87736. * You will need to pass the name of the uniform as well as the value.
  87737. */
  87738. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  87739. /**
  87740. * Lambda to Update a vec3 of float in a uniform buffer.
  87741. * This is dynamic to allow compat with webgl 1 and 2.
  87742. * You will need to pass the name of the uniform as well as the value.
  87743. */
  87744. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  87745. /**
  87746. * Lambda to Update a vec4 of float in a uniform buffer.
  87747. * This is dynamic to allow compat with webgl 1 and 2.
  87748. * You will need to pass the name of the uniform as well as the value.
  87749. */
  87750. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  87751. /**
  87752. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  87753. * This is dynamic to allow compat with webgl 1 and 2.
  87754. * You will need to pass the name of the uniform as well as the value.
  87755. */
  87756. updateMatrix: (name: string, mat: Matrix) => void;
  87757. /**
  87758. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  87759. * This is dynamic to allow compat with webgl 1 and 2.
  87760. * You will need to pass the name of the uniform as well as the value.
  87761. */
  87762. updateVector3: (name: string, vector: Vector3) => void;
  87763. /**
  87764. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  87765. * This is dynamic to allow compat with webgl 1 and 2.
  87766. * You will need to pass the name of the uniform as well as the value.
  87767. */
  87768. updateVector4: (name: string, vector: Vector4) => void;
  87769. /**
  87770. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  87771. * This is dynamic to allow compat with webgl 1 and 2.
  87772. * You will need to pass the name of the uniform as well as the value.
  87773. */
  87774. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  87775. /**
  87776. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  87777. * This is dynamic to allow compat with webgl 1 and 2.
  87778. * You will need to pass the name of the uniform as well as the value.
  87779. */
  87780. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  87781. /**
  87782. * Instantiates a new Uniform buffer objects.
  87783. *
  87784. * Handles blocks of uniform on the GPU.
  87785. *
  87786. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  87787. *
  87788. * For more information, please refer to :
  87789. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  87790. * @param engine Define the engine the buffer is associated with
  87791. * @param data Define the data contained in the buffer
  87792. * @param dynamic Define if the buffer is updatable
  87793. */
  87794. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  87795. /**
  87796. * Indicates if the buffer is using the WebGL2 UBO implementation,
  87797. * or just falling back on setUniformXXX calls.
  87798. */
  87799. get useUbo(): boolean;
  87800. /**
  87801. * Indicates if the WebGL underlying uniform buffer is in sync
  87802. * with the javascript cache data.
  87803. */
  87804. get isSync(): boolean;
  87805. /**
  87806. * Indicates if the WebGL underlying uniform buffer is dynamic.
  87807. * Also, a dynamic UniformBuffer will disable cache verification and always
  87808. * update the underlying WebGL uniform buffer to the GPU.
  87809. * @returns if Dynamic, otherwise false
  87810. */
  87811. isDynamic(): boolean;
  87812. /**
  87813. * The data cache on JS side.
  87814. * @returns the underlying data as a float array
  87815. */
  87816. getData(): Float32Array;
  87817. /**
  87818. * The underlying WebGL Uniform buffer.
  87819. * @returns the webgl buffer
  87820. */
  87821. getBuffer(): Nullable<DataBuffer>;
  87822. /**
  87823. * std140 layout specifies how to align data within an UBO structure.
  87824. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  87825. * for specs.
  87826. */
  87827. private _fillAlignment;
  87828. /**
  87829. * Adds an uniform in the buffer.
  87830. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  87831. * for the layout to be correct !
  87832. * @param name Name of the uniform, as used in the uniform block in the shader.
  87833. * @param size Data size, or data directly.
  87834. */
  87835. addUniform(name: string, size: number | number[]): void;
  87836. /**
  87837. * Adds a Matrix 4x4 to the uniform buffer.
  87838. * @param name Name of the uniform, as used in the uniform block in the shader.
  87839. * @param mat A 4x4 matrix.
  87840. */
  87841. addMatrix(name: string, mat: Matrix): void;
  87842. /**
  87843. * Adds a vec2 to the uniform buffer.
  87844. * @param name Name of the uniform, as used in the uniform block in the shader.
  87845. * @param x Define the x component value of the vec2
  87846. * @param y Define the y component value of the vec2
  87847. */
  87848. addFloat2(name: string, x: number, y: number): void;
  87849. /**
  87850. * Adds a vec3 to the uniform buffer.
  87851. * @param name Name of the uniform, as used in the uniform block in the shader.
  87852. * @param x Define the x component value of the vec3
  87853. * @param y Define the y component value of the vec3
  87854. * @param z Define the z component value of the vec3
  87855. */
  87856. addFloat3(name: string, x: number, y: number, z: number): void;
  87857. /**
  87858. * Adds a vec3 to the uniform buffer.
  87859. * @param name Name of the uniform, as used in the uniform block in the shader.
  87860. * @param color Define the vec3 from a Color
  87861. */
  87862. addColor3(name: string, color: Color3): void;
  87863. /**
  87864. * Adds a vec4 to the uniform buffer.
  87865. * @param name Name of the uniform, as used in the uniform block in the shader.
  87866. * @param color Define the rgb components from a Color
  87867. * @param alpha Define the a component of the vec4
  87868. */
  87869. addColor4(name: string, color: Color3, alpha: number): void;
  87870. /**
  87871. * Adds a vec3 to the uniform buffer.
  87872. * @param name Name of the uniform, as used in the uniform block in the shader.
  87873. * @param vector Define the vec3 components from a Vector
  87874. */
  87875. addVector3(name: string, vector: Vector3): void;
  87876. /**
  87877. * Adds a Matrix 3x3 to the uniform buffer.
  87878. * @param name Name of the uniform, as used in the uniform block in the shader.
  87879. */
  87880. addMatrix3x3(name: string): void;
  87881. /**
  87882. * Adds a Matrix 2x2 to the uniform buffer.
  87883. * @param name Name of the uniform, as used in the uniform block in the shader.
  87884. */
  87885. addMatrix2x2(name: string): void;
  87886. /**
  87887. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  87888. */
  87889. create(): void;
  87890. /** @hidden */
  87891. _rebuild(): void;
  87892. /**
  87893. * Updates the WebGL Uniform Buffer on the GPU.
  87894. * If the `dynamic` flag is set to true, no cache comparison is done.
  87895. * Otherwise, the buffer will be updated only if the cache differs.
  87896. */
  87897. update(): void;
  87898. /**
  87899. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  87900. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  87901. * @param data Define the flattened data
  87902. * @param size Define the size of the data.
  87903. */
  87904. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  87905. private _valueCache;
  87906. private _cacheMatrix;
  87907. private _updateMatrix3x3ForUniform;
  87908. private _updateMatrix3x3ForEffect;
  87909. private _updateMatrix2x2ForEffect;
  87910. private _updateMatrix2x2ForUniform;
  87911. private _updateFloatForEffect;
  87912. private _updateFloatForUniform;
  87913. private _updateFloat2ForEffect;
  87914. private _updateFloat2ForUniform;
  87915. private _updateFloat3ForEffect;
  87916. private _updateFloat3ForUniform;
  87917. private _updateFloat4ForEffect;
  87918. private _updateFloat4ForUniform;
  87919. private _updateMatrixForEffect;
  87920. private _updateMatrixForUniform;
  87921. private _updateVector3ForEffect;
  87922. private _updateVector3ForUniform;
  87923. private _updateVector4ForEffect;
  87924. private _updateVector4ForUniform;
  87925. private _updateColor3ForEffect;
  87926. private _updateColor3ForUniform;
  87927. private _updateColor4ForEffect;
  87928. private _updateColor4ForUniform;
  87929. /**
  87930. * Sets a sampler uniform on the effect.
  87931. * @param name Define the name of the sampler.
  87932. * @param texture Define the texture to set in the sampler
  87933. */
  87934. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  87935. /**
  87936. * Directly updates the value of the uniform in the cache AND on the GPU.
  87937. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  87938. * @param data Define the flattened data
  87939. */
  87940. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  87941. /**
  87942. * Binds this uniform buffer to an effect.
  87943. * @param effect Define the effect to bind the buffer to
  87944. * @param name Name of the uniform block in the shader.
  87945. */
  87946. bindToEffect(effect: Effect, name: string): void;
  87947. /**
  87948. * Disposes the uniform buffer.
  87949. */
  87950. dispose(): void;
  87951. }
  87952. }
  87953. declare module BABYLON {
  87954. /**
  87955. * Enum that determines the text-wrapping mode to use.
  87956. */
  87957. export enum InspectableType {
  87958. /**
  87959. * Checkbox for booleans
  87960. */
  87961. Checkbox = 0,
  87962. /**
  87963. * Sliders for numbers
  87964. */
  87965. Slider = 1,
  87966. /**
  87967. * Vector3
  87968. */
  87969. Vector3 = 2,
  87970. /**
  87971. * Quaternions
  87972. */
  87973. Quaternion = 3,
  87974. /**
  87975. * Color3
  87976. */
  87977. Color3 = 4,
  87978. /**
  87979. * String
  87980. */
  87981. String = 5
  87982. }
  87983. /**
  87984. * Interface used to define custom inspectable properties.
  87985. * This interface is used by the inspector to display custom property grids
  87986. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  87987. */
  87988. export interface IInspectable {
  87989. /**
  87990. * Gets the label to display
  87991. */
  87992. label: string;
  87993. /**
  87994. * Gets the name of the property to edit
  87995. */
  87996. propertyName: string;
  87997. /**
  87998. * Gets the type of the editor to use
  87999. */
  88000. type: InspectableType;
  88001. /**
  88002. * Gets the minimum value of the property when using in "slider" mode
  88003. */
  88004. min?: number;
  88005. /**
  88006. * Gets the maximum value of the property when using in "slider" mode
  88007. */
  88008. max?: number;
  88009. /**
  88010. * Gets the setp to use when using in "slider" mode
  88011. */
  88012. step?: number;
  88013. }
  88014. }
  88015. declare module BABYLON {
  88016. /**
  88017. * Class used to provide helper for timing
  88018. */
  88019. export class TimingTools {
  88020. /**
  88021. * Polyfill for setImmediate
  88022. * @param action defines the action to execute after the current execution block
  88023. */
  88024. static SetImmediate(action: () => void): void;
  88025. }
  88026. }
  88027. declare module BABYLON {
  88028. /**
  88029. * Class used to enable instatition of objects by class name
  88030. */
  88031. export class InstantiationTools {
  88032. /**
  88033. * Use this object to register external classes like custom textures or material
  88034. * to allow the laoders to instantiate them
  88035. */
  88036. static RegisteredExternalClasses: {
  88037. [key: string]: Object;
  88038. };
  88039. /**
  88040. * Tries to instantiate a new object from a given class name
  88041. * @param className defines the class name to instantiate
  88042. * @returns the new object or null if the system was not able to do the instantiation
  88043. */
  88044. static Instantiate(className: string): any;
  88045. }
  88046. }
  88047. declare module BABYLON {
  88048. /**
  88049. * Define options used to create a depth texture
  88050. */
  88051. export class DepthTextureCreationOptions {
  88052. /** Specifies whether or not a stencil should be allocated in the texture */
  88053. generateStencil?: boolean;
  88054. /** Specifies whether or not bilinear filtering is enable on the texture */
  88055. bilinearFiltering?: boolean;
  88056. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  88057. comparisonFunction?: number;
  88058. /** Specifies if the created texture is a cube texture */
  88059. isCube?: boolean;
  88060. }
  88061. }
  88062. declare module BABYLON {
  88063. interface ThinEngine {
  88064. /**
  88065. * Creates a depth stencil cube texture.
  88066. * This is only available in WebGL 2.
  88067. * @param size The size of face edge in the cube texture.
  88068. * @param options The options defining the cube texture.
  88069. * @returns The cube texture
  88070. */
  88071. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  88072. /**
  88073. * Creates a cube texture
  88074. * @param rootUrl defines the url where the files to load is located
  88075. * @param scene defines the current scene
  88076. * @param files defines the list of files to load (1 per face)
  88077. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  88078. * @param onLoad defines an optional callback raised when the texture is loaded
  88079. * @param onError defines an optional callback raised if there is an issue to load the texture
  88080. * @param format defines the format of the data
  88081. * @param forcedExtension defines the extension to use to pick the right loader
  88082. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  88083. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  88084. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  88085. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  88086. * @returns the cube texture as an InternalTexture
  88087. */
  88088. 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;
  88089. /**
  88090. * Creates a cube texture
  88091. * @param rootUrl defines the url where the files to load is located
  88092. * @param scene defines the current scene
  88093. * @param files defines the list of files to load (1 per face)
  88094. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  88095. * @param onLoad defines an optional callback raised when the texture is loaded
  88096. * @param onError defines an optional callback raised if there is an issue to load the texture
  88097. * @param format defines the format of the data
  88098. * @param forcedExtension defines the extension to use to pick the right loader
  88099. * @returns the cube texture as an InternalTexture
  88100. */
  88101. 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;
  88102. /**
  88103. * Creates a cube texture
  88104. * @param rootUrl defines the url where the files to load is located
  88105. * @param scene defines the current scene
  88106. * @param files defines the list of files to load (1 per face)
  88107. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  88108. * @param onLoad defines an optional callback raised when the texture is loaded
  88109. * @param onError defines an optional callback raised if there is an issue to load the texture
  88110. * @param format defines the format of the data
  88111. * @param forcedExtension defines the extension to use to pick the right loader
  88112. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  88113. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  88114. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  88115. * @returns the cube texture as an InternalTexture
  88116. */
  88117. 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;
  88118. /** @hidden */
  88119. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  88120. /** @hidden */
  88121. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  88122. /** @hidden */
  88123. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  88124. /** @hidden */
  88125. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  88126. /**
  88127. * @hidden
  88128. */
  88129. _setCubeMapTextureParams(loadMipmap: boolean): void;
  88130. }
  88131. }
  88132. declare module BABYLON {
  88133. /**
  88134. * Class for creating a cube texture
  88135. */
  88136. export class CubeTexture extends BaseTexture {
  88137. private _delayedOnLoad;
  88138. /**
  88139. * Observable triggered once the texture has been loaded.
  88140. */
  88141. onLoadObservable: Observable<CubeTexture>;
  88142. /**
  88143. * The url of the texture
  88144. */
  88145. url: string;
  88146. /**
  88147. * Gets or sets the center of the bounding box associated with the cube texture.
  88148. * It must define where the camera used to render the texture was set
  88149. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  88150. */
  88151. boundingBoxPosition: Vector3;
  88152. private _boundingBoxSize;
  88153. /**
  88154. * Gets or sets the size of the bounding box associated with the cube texture
  88155. * When defined, the cubemap will switch to local mode
  88156. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  88157. * @example https://www.babylonjs-playground.com/#RNASML
  88158. */
  88159. set boundingBoxSize(value: Vector3);
  88160. /**
  88161. * Returns the bounding box size
  88162. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  88163. */
  88164. get boundingBoxSize(): Vector3;
  88165. protected _rotationY: number;
  88166. /**
  88167. * Sets texture matrix rotation angle around Y axis in radians.
  88168. */
  88169. set rotationY(value: number);
  88170. /**
  88171. * Gets texture matrix rotation angle around Y axis radians.
  88172. */
  88173. get rotationY(): number;
  88174. /**
  88175. * Are mip maps generated for this texture or not.
  88176. */
  88177. get noMipmap(): boolean;
  88178. private _noMipmap;
  88179. private _files;
  88180. protected _forcedExtension: Nullable<string>;
  88181. private _extensions;
  88182. private _textureMatrix;
  88183. private _format;
  88184. private _createPolynomials;
  88185. /**
  88186. * Creates a cube texture from an array of image urls
  88187. * @param files defines an array of image urls
  88188. * @param scene defines the hosting scene
  88189. * @param noMipmap specifies if mip maps are not used
  88190. * @returns a cube texture
  88191. */
  88192. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  88193. /**
  88194. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  88195. * @param url defines the url of the prefiltered texture
  88196. * @param scene defines the scene the texture is attached to
  88197. * @param forcedExtension defines the extension of the file if different from the url
  88198. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  88199. * @return the prefiltered texture
  88200. */
  88201. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  88202. /**
  88203. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  88204. * as prefiltered data.
  88205. * @param rootUrl defines the url of the texture or the root name of the six images
  88206. * @param null defines the scene or engine the texture is attached to
  88207. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  88208. * @param noMipmap defines if mipmaps should be created or not
  88209. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  88210. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  88211. * @param onError defines a callback triggered in case of error during load
  88212. * @param format defines the internal format to use for the texture once loaded
  88213. * @param prefiltered defines whether or not the texture is created from prefiltered data
  88214. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  88215. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  88216. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  88217. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  88218. * @return the cube texture
  88219. */
  88220. 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);
  88221. /**
  88222. * Get the current class name of the texture useful for serialization or dynamic coding.
  88223. * @returns "CubeTexture"
  88224. */
  88225. getClassName(): string;
  88226. /**
  88227. * Update the url (and optional buffer) of this texture if url was null during construction.
  88228. * @param url the url of the texture
  88229. * @param forcedExtension defines the extension to use
  88230. * @param onLoad callback called when the texture is loaded (defaults to null)
  88231. * @param prefiltered Defines whether the updated texture is prefiltered or not
  88232. */
  88233. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  88234. /**
  88235. * Delays loading of the cube texture
  88236. * @param forcedExtension defines the extension to use
  88237. */
  88238. delayLoad(forcedExtension?: string): void;
  88239. /**
  88240. * Returns the reflection texture matrix
  88241. * @returns the reflection texture matrix
  88242. */
  88243. getReflectionTextureMatrix(): Matrix;
  88244. /**
  88245. * Sets the reflection texture matrix
  88246. * @param value Reflection texture matrix
  88247. */
  88248. setReflectionTextureMatrix(value: Matrix): void;
  88249. /**
  88250. * Parses text to create a cube texture
  88251. * @param parsedTexture define the serialized text to read from
  88252. * @param scene defines the hosting scene
  88253. * @param rootUrl defines the root url of the cube texture
  88254. * @returns a cube texture
  88255. */
  88256. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  88257. /**
  88258. * Makes a clone, or deep copy, of the cube texture
  88259. * @returns a new cube texture
  88260. */
  88261. clone(): CubeTexture;
  88262. }
  88263. }
  88264. declare module BABYLON {
  88265. /**
  88266. * Manages the defines for the Material
  88267. */
  88268. export class MaterialDefines {
  88269. /** @hidden */
  88270. protected _keys: string[];
  88271. private _isDirty;
  88272. /** @hidden */
  88273. _renderId: number;
  88274. /** @hidden */
  88275. _areLightsDirty: boolean;
  88276. /** @hidden */
  88277. _areLightsDisposed: boolean;
  88278. /** @hidden */
  88279. _areAttributesDirty: boolean;
  88280. /** @hidden */
  88281. _areTexturesDirty: boolean;
  88282. /** @hidden */
  88283. _areFresnelDirty: boolean;
  88284. /** @hidden */
  88285. _areMiscDirty: boolean;
  88286. /** @hidden */
  88287. _areImageProcessingDirty: boolean;
  88288. /** @hidden */
  88289. _normals: boolean;
  88290. /** @hidden */
  88291. _uvs: boolean;
  88292. /** @hidden */
  88293. _needNormals: boolean;
  88294. /** @hidden */
  88295. _needUVs: boolean;
  88296. [id: string]: any;
  88297. /**
  88298. * Specifies if the material needs to be re-calculated
  88299. */
  88300. get isDirty(): boolean;
  88301. /**
  88302. * Marks the material to indicate that it has been re-calculated
  88303. */
  88304. markAsProcessed(): void;
  88305. /**
  88306. * Marks the material to indicate that it needs to be re-calculated
  88307. */
  88308. markAsUnprocessed(): void;
  88309. /**
  88310. * Marks the material to indicate all of its defines need to be re-calculated
  88311. */
  88312. markAllAsDirty(): void;
  88313. /**
  88314. * Marks the material to indicate that image processing needs to be re-calculated
  88315. */
  88316. markAsImageProcessingDirty(): void;
  88317. /**
  88318. * Marks the material to indicate the lights need to be re-calculated
  88319. * @param disposed Defines whether the light is dirty due to dispose or not
  88320. */
  88321. markAsLightDirty(disposed?: boolean): void;
  88322. /**
  88323. * Marks the attribute state as changed
  88324. */
  88325. markAsAttributesDirty(): void;
  88326. /**
  88327. * Marks the texture state as changed
  88328. */
  88329. markAsTexturesDirty(): void;
  88330. /**
  88331. * Marks the fresnel state as changed
  88332. */
  88333. markAsFresnelDirty(): void;
  88334. /**
  88335. * Marks the misc state as changed
  88336. */
  88337. markAsMiscDirty(): void;
  88338. /**
  88339. * Rebuilds the material defines
  88340. */
  88341. rebuild(): void;
  88342. /**
  88343. * Specifies if two material defines are equal
  88344. * @param other - A material define instance to compare to
  88345. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  88346. */
  88347. isEqual(other: MaterialDefines): boolean;
  88348. /**
  88349. * Clones this instance's defines to another instance
  88350. * @param other - material defines to clone values to
  88351. */
  88352. cloneTo(other: MaterialDefines): void;
  88353. /**
  88354. * Resets the material define values
  88355. */
  88356. reset(): void;
  88357. /**
  88358. * Converts the material define values to a string
  88359. * @returns - String of material define information
  88360. */
  88361. toString(): string;
  88362. }
  88363. }
  88364. declare module BABYLON {
  88365. /**
  88366. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  88367. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  88368. * 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;
  88369. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  88370. */
  88371. export class ColorCurves {
  88372. private _dirty;
  88373. private _tempColor;
  88374. private _globalCurve;
  88375. private _highlightsCurve;
  88376. private _midtonesCurve;
  88377. private _shadowsCurve;
  88378. private _positiveCurve;
  88379. private _negativeCurve;
  88380. private _globalHue;
  88381. private _globalDensity;
  88382. private _globalSaturation;
  88383. private _globalExposure;
  88384. /**
  88385. * Gets the global Hue value.
  88386. * 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).
  88387. */
  88388. get globalHue(): number;
  88389. /**
  88390. * Sets the global Hue value.
  88391. * 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).
  88392. */
  88393. set globalHue(value: number);
  88394. /**
  88395. * Gets the global Density value.
  88396. * 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.
  88397. * Values less than zero provide a filter of opposite hue.
  88398. */
  88399. get globalDensity(): number;
  88400. /**
  88401. * Sets the global Density value.
  88402. * 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.
  88403. * Values less than zero provide a filter of opposite hue.
  88404. */
  88405. set globalDensity(value: number);
  88406. /**
  88407. * Gets the global Saturation value.
  88408. * 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.
  88409. */
  88410. get globalSaturation(): number;
  88411. /**
  88412. * Sets the global Saturation value.
  88413. * 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.
  88414. */
  88415. set globalSaturation(value: number);
  88416. /**
  88417. * Gets the global Exposure value.
  88418. * 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.
  88419. */
  88420. get globalExposure(): number;
  88421. /**
  88422. * Sets the global Exposure value.
  88423. * 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.
  88424. */
  88425. set globalExposure(value: number);
  88426. private _highlightsHue;
  88427. private _highlightsDensity;
  88428. private _highlightsSaturation;
  88429. private _highlightsExposure;
  88430. /**
  88431. * Gets the highlights Hue value.
  88432. * 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).
  88433. */
  88434. get highlightsHue(): number;
  88435. /**
  88436. * Sets the highlights Hue value.
  88437. * 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).
  88438. */
  88439. set highlightsHue(value: number);
  88440. /**
  88441. * Gets the highlights Density value.
  88442. * 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.
  88443. * Values less than zero provide a filter of opposite hue.
  88444. */
  88445. get highlightsDensity(): number;
  88446. /**
  88447. * Sets the highlights Density value.
  88448. * 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.
  88449. * Values less than zero provide a filter of opposite hue.
  88450. */
  88451. set highlightsDensity(value: number);
  88452. /**
  88453. * Gets the highlights Saturation value.
  88454. * 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.
  88455. */
  88456. get highlightsSaturation(): number;
  88457. /**
  88458. * Sets the highlights Saturation value.
  88459. * 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.
  88460. */
  88461. set highlightsSaturation(value: number);
  88462. /**
  88463. * Gets the highlights Exposure value.
  88464. * 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.
  88465. */
  88466. get highlightsExposure(): number;
  88467. /**
  88468. * Sets the highlights Exposure value.
  88469. * 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.
  88470. */
  88471. set highlightsExposure(value: number);
  88472. private _midtonesHue;
  88473. private _midtonesDensity;
  88474. private _midtonesSaturation;
  88475. private _midtonesExposure;
  88476. /**
  88477. * Gets the midtones Hue value.
  88478. * 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).
  88479. */
  88480. get midtonesHue(): number;
  88481. /**
  88482. * Sets the midtones Hue value.
  88483. * 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).
  88484. */
  88485. set midtonesHue(value: number);
  88486. /**
  88487. * Gets the midtones Density value.
  88488. * 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.
  88489. * Values less than zero provide a filter of opposite hue.
  88490. */
  88491. get midtonesDensity(): number;
  88492. /**
  88493. * Sets the midtones Density value.
  88494. * 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.
  88495. * Values less than zero provide a filter of opposite hue.
  88496. */
  88497. set midtonesDensity(value: number);
  88498. /**
  88499. * Gets the midtones Saturation value.
  88500. * 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.
  88501. */
  88502. get midtonesSaturation(): number;
  88503. /**
  88504. * Sets the midtones Saturation value.
  88505. * 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.
  88506. */
  88507. set midtonesSaturation(value: number);
  88508. /**
  88509. * Gets the midtones Exposure value.
  88510. * 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.
  88511. */
  88512. get midtonesExposure(): number;
  88513. /**
  88514. * Sets the midtones Exposure value.
  88515. * 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.
  88516. */
  88517. set midtonesExposure(value: number);
  88518. private _shadowsHue;
  88519. private _shadowsDensity;
  88520. private _shadowsSaturation;
  88521. private _shadowsExposure;
  88522. /**
  88523. * Gets the shadows Hue value.
  88524. * 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).
  88525. */
  88526. get shadowsHue(): number;
  88527. /**
  88528. * Sets the shadows Hue value.
  88529. * 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).
  88530. */
  88531. set shadowsHue(value: number);
  88532. /**
  88533. * Gets the shadows Density value.
  88534. * 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.
  88535. * Values less than zero provide a filter of opposite hue.
  88536. */
  88537. get shadowsDensity(): number;
  88538. /**
  88539. * Sets the shadows Density value.
  88540. * 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.
  88541. * Values less than zero provide a filter of opposite hue.
  88542. */
  88543. set shadowsDensity(value: number);
  88544. /**
  88545. * Gets the shadows Saturation value.
  88546. * 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.
  88547. */
  88548. get shadowsSaturation(): number;
  88549. /**
  88550. * Sets the shadows Saturation value.
  88551. * 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.
  88552. */
  88553. set shadowsSaturation(value: number);
  88554. /**
  88555. * Gets the shadows Exposure value.
  88556. * 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.
  88557. */
  88558. get shadowsExposure(): number;
  88559. /**
  88560. * Sets the shadows Exposure value.
  88561. * 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.
  88562. */
  88563. set shadowsExposure(value: number);
  88564. /**
  88565. * Returns the class name
  88566. * @returns The class name
  88567. */
  88568. getClassName(): string;
  88569. /**
  88570. * Binds the color curves to the shader.
  88571. * @param colorCurves The color curve to bind
  88572. * @param effect The effect to bind to
  88573. * @param positiveUniform The positive uniform shader parameter
  88574. * @param neutralUniform The neutral uniform shader parameter
  88575. * @param negativeUniform The negative uniform shader parameter
  88576. */
  88577. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  88578. /**
  88579. * Prepare the list of uniforms associated with the ColorCurves effects.
  88580. * @param uniformsList The list of uniforms used in the effect
  88581. */
  88582. static PrepareUniforms(uniformsList: string[]): void;
  88583. /**
  88584. * Returns color grading data based on a hue, density, saturation and exposure value.
  88585. * @param filterHue The hue of the color filter.
  88586. * @param filterDensity The density of the color filter.
  88587. * @param saturation The saturation.
  88588. * @param exposure The exposure.
  88589. * @param result The result data container.
  88590. */
  88591. private getColorGradingDataToRef;
  88592. /**
  88593. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  88594. * @param value The input slider value in range [-100,100].
  88595. * @returns Adjusted value.
  88596. */
  88597. private static applyColorGradingSliderNonlinear;
  88598. /**
  88599. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  88600. * @param hue The hue (H) input.
  88601. * @param saturation The saturation (S) input.
  88602. * @param brightness The brightness (B) input.
  88603. * @result An RGBA color represented as Vector4.
  88604. */
  88605. private static fromHSBToRef;
  88606. /**
  88607. * Returns a value clamped between min and max
  88608. * @param value The value to clamp
  88609. * @param min The minimum of value
  88610. * @param max The maximum of value
  88611. * @returns The clamped value.
  88612. */
  88613. private static clamp;
  88614. /**
  88615. * Clones the current color curve instance.
  88616. * @return The cloned curves
  88617. */
  88618. clone(): ColorCurves;
  88619. /**
  88620. * Serializes the current color curve instance to a json representation.
  88621. * @return a JSON representation
  88622. */
  88623. serialize(): any;
  88624. /**
  88625. * Parses the color curve from a json representation.
  88626. * @param source the JSON source to parse
  88627. * @return The parsed curves
  88628. */
  88629. static Parse(source: any): ColorCurves;
  88630. }
  88631. }
  88632. declare module BABYLON {
  88633. /**
  88634. * Interface to follow in your material defines to integrate easily the
  88635. * Image proccessing functions.
  88636. * @hidden
  88637. */
  88638. export interface IImageProcessingConfigurationDefines {
  88639. IMAGEPROCESSING: boolean;
  88640. VIGNETTE: boolean;
  88641. VIGNETTEBLENDMODEMULTIPLY: boolean;
  88642. VIGNETTEBLENDMODEOPAQUE: boolean;
  88643. TONEMAPPING: boolean;
  88644. TONEMAPPING_ACES: boolean;
  88645. CONTRAST: boolean;
  88646. EXPOSURE: boolean;
  88647. COLORCURVES: boolean;
  88648. COLORGRADING: boolean;
  88649. COLORGRADING3D: boolean;
  88650. SAMPLER3DGREENDEPTH: boolean;
  88651. SAMPLER3DBGRMAP: boolean;
  88652. IMAGEPROCESSINGPOSTPROCESS: boolean;
  88653. }
  88654. /**
  88655. * @hidden
  88656. */
  88657. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  88658. IMAGEPROCESSING: boolean;
  88659. VIGNETTE: boolean;
  88660. VIGNETTEBLENDMODEMULTIPLY: boolean;
  88661. VIGNETTEBLENDMODEOPAQUE: boolean;
  88662. TONEMAPPING: boolean;
  88663. TONEMAPPING_ACES: boolean;
  88664. CONTRAST: boolean;
  88665. COLORCURVES: boolean;
  88666. COLORGRADING: boolean;
  88667. COLORGRADING3D: boolean;
  88668. SAMPLER3DGREENDEPTH: boolean;
  88669. SAMPLER3DBGRMAP: boolean;
  88670. IMAGEPROCESSINGPOSTPROCESS: boolean;
  88671. EXPOSURE: boolean;
  88672. constructor();
  88673. }
  88674. /**
  88675. * This groups together the common properties used for image processing either in direct forward pass
  88676. * or through post processing effect depending on the use of the image processing pipeline in your scene
  88677. * or not.
  88678. */
  88679. export class ImageProcessingConfiguration {
  88680. /**
  88681. * Default tone mapping applied in BabylonJS.
  88682. */
  88683. static readonly TONEMAPPING_STANDARD: number;
  88684. /**
  88685. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  88686. * to other engines rendering to increase portability.
  88687. */
  88688. static readonly TONEMAPPING_ACES: number;
  88689. /**
  88690. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  88691. */
  88692. colorCurves: Nullable<ColorCurves>;
  88693. private _colorCurvesEnabled;
  88694. /**
  88695. * Gets wether the color curves effect is enabled.
  88696. */
  88697. get colorCurvesEnabled(): boolean;
  88698. /**
  88699. * Sets wether the color curves effect is enabled.
  88700. */
  88701. set colorCurvesEnabled(value: boolean);
  88702. private _colorGradingTexture;
  88703. /**
  88704. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  88705. */
  88706. get colorGradingTexture(): Nullable<BaseTexture>;
  88707. /**
  88708. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  88709. */
  88710. set colorGradingTexture(value: Nullable<BaseTexture>);
  88711. private _colorGradingEnabled;
  88712. /**
  88713. * Gets wether the color grading effect is enabled.
  88714. */
  88715. get colorGradingEnabled(): boolean;
  88716. /**
  88717. * Sets wether the color grading effect is enabled.
  88718. */
  88719. set colorGradingEnabled(value: boolean);
  88720. private _colorGradingWithGreenDepth;
  88721. /**
  88722. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  88723. */
  88724. get colorGradingWithGreenDepth(): boolean;
  88725. /**
  88726. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  88727. */
  88728. set colorGradingWithGreenDepth(value: boolean);
  88729. private _colorGradingBGR;
  88730. /**
  88731. * Gets wether the color grading texture contains BGR values.
  88732. */
  88733. get colorGradingBGR(): boolean;
  88734. /**
  88735. * Sets wether the color grading texture contains BGR values.
  88736. */
  88737. set colorGradingBGR(value: boolean);
  88738. /** @hidden */
  88739. _exposure: number;
  88740. /**
  88741. * Gets the Exposure used in the effect.
  88742. */
  88743. get exposure(): number;
  88744. /**
  88745. * Sets the Exposure used in the effect.
  88746. */
  88747. set exposure(value: number);
  88748. private _toneMappingEnabled;
  88749. /**
  88750. * Gets wether the tone mapping effect is enabled.
  88751. */
  88752. get toneMappingEnabled(): boolean;
  88753. /**
  88754. * Sets wether the tone mapping effect is enabled.
  88755. */
  88756. set toneMappingEnabled(value: boolean);
  88757. private _toneMappingType;
  88758. /**
  88759. * Gets the type of tone mapping effect.
  88760. */
  88761. get toneMappingType(): number;
  88762. /**
  88763. * Sets the type of tone mapping effect used in BabylonJS.
  88764. */
  88765. set toneMappingType(value: number);
  88766. protected _contrast: number;
  88767. /**
  88768. * Gets the contrast used in the effect.
  88769. */
  88770. get contrast(): number;
  88771. /**
  88772. * Sets the contrast used in the effect.
  88773. */
  88774. set contrast(value: number);
  88775. /**
  88776. * Vignette stretch size.
  88777. */
  88778. vignetteStretch: number;
  88779. /**
  88780. * Vignette centre X Offset.
  88781. */
  88782. vignetteCentreX: number;
  88783. /**
  88784. * Vignette centre Y Offset.
  88785. */
  88786. vignetteCentreY: number;
  88787. /**
  88788. * Vignette weight or intensity of the vignette effect.
  88789. */
  88790. vignetteWeight: number;
  88791. /**
  88792. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  88793. * if vignetteEnabled is set to true.
  88794. */
  88795. vignetteColor: Color4;
  88796. /**
  88797. * Camera field of view used by the Vignette effect.
  88798. */
  88799. vignetteCameraFov: number;
  88800. private _vignetteBlendMode;
  88801. /**
  88802. * Gets the vignette blend mode allowing different kind of effect.
  88803. */
  88804. get vignetteBlendMode(): number;
  88805. /**
  88806. * Sets the vignette blend mode allowing different kind of effect.
  88807. */
  88808. set vignetteBlendMode(value: number);
  88809. private _vignetteEnabled;
  88810. /**
  88811. * Gets wether the vignette effect is enabled.
  88812. */
  88813. get vignetteEnabled(): boolean;
  88814. /**
  88815. * Sets wether the vignette effect is enabled.
  88816. */
  88817. set vignetteEnabled(value: boolean);
  88818. private _applyByPostProcess;
  88819. /**
  88820. * Gets wether the image processing is applied through a post process or not.
  88821. */
  88822. get applyByPostProcess(): boolean;
  88823. /**
  88824. * Sets wether the image processing is applied through a post process or not.
  88825. */
  88826. set applyByPostProcess(value: boolean);
  88827. private _isEnabled;
  88828. /**
  88829. * Gets wether the image processing is enabled or not.
  88830. */
  88831. get isEnabled(): boolean;
  88832. /**
  88833. * Sets wether the image processing is enabled or not.
  88834. */
  88835. set isEnabled(value: boolean);
  88836. /**
  88837. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  88838. */
  88839. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  88840. /**
  88841. * Method called each time the image processing information changes requires to recompile the effect.
  88842. */
  88843. protected _updateParameters(): void;
  88844. /**
  88845. * Gets the current class name.
  88846. * @return "ImageProcessingConfiguration"
  88847. */
  88848. getClassName(): string;
  88849. /**
  88850. * Prepare the list of uniforms associated with the Image Processing effects.
  88851. * @param uniforms The list of uniforms used in the effect
  88852. * @param defines the list of defines currently in use
  88853. */
  88854. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  88855. /**
  88856. * Prepare the list of samplers associated with the Image Processing effects.
  88857. * @param samplersList The list of uniforms used in the effect
  88858. * @param defines the list of defines currently in use
  88859. */
  88860. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  88861. /**
  88862. * Prepare the list of defines associated to the shader.
  88863. * @param defines the list of defines to complete
  88864. * @param forPostProcess Define if we are currently in post process mode or not
  88865. */
  88866. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  88867. /**
  88868. * Returns true if all the image processing information are ready.
  88869. * @returns True if ready, otherwise, false
  88870. */
  88871. isReady(): boolean;
  88872. /**
  88873. * Binds the image processing to the shader.
  88874. * @param effect The effect to bind to
  88875. * @param overrideAspectRatio Override the aspect ratio of the effect
  88876. */
  88877. bind(effect: Effect, overrideAspectRatio?: number): void;
  88878. /**
  88879. * Clones the current image processing instance.
  88880. * @return The cloned image processing
  88881. */
  88882. clone(): ImageProcessingConfiguration;
  88883. /**
  88884. * Serializes the current image processing instance to a json representation.
  88885. * @return a JSON representation
  88886. */
  88887. serialize(): any;
  88888. /**
  88889. * Parses the image processing from a json representation.
  88890. * @param source the JSON source to parse
  88891. * @return The parsed image processing
  88892. */
  88893. static Parse(source: any): ImageProcessingConfiguration;
  88894. private static _VIGNETTEMODE_MULTIPLY;
  88895. private static _VIGNETTEMODE_OPAQUE;
  88896. /**
  88897. * Used to apply the vignette as a mix with the pixel color.
  88898. */
  88899. static get VIGNETTEMODE_MULTIPLY(): number;
  88900. /**
  88901. * Used to apply the vignette as a replacement of the pixel color.
  88902. */
  88903. static get VIGNETTEMODE_OPAQUE(): number;
  88904. }
  88905. }
  88906. declare module BABYLON {
  88907. /** @hidden */
  88908. export var postprocessVertexShader: {
  88909. name: string;
  88910. shader: string;
  88911. };
  88912. }
  88913. declare module BABYLON {
  88914. /**
  88915. * Type used to define a render target texture size (either with a number or with a rect width and height)
  88916. */
  88917. export type RenderTargetTextureSize = number | {
  88918. width: number;
  88919. height: number;
  88920. layers?: number;
  88921. };
  88922. interface ThinEngine {
  88923. /**
  88924. * Creates a new render target texture
  88925. * @param size defines the size of the texture
  88926. * @param options defines the options used to create the texture
  88927. * @returns a new render target texture stored in an InternalTexture
  88928. */
  88929. createRenderTargetTexture(size: RenderTargetTextureSize, options: boolean | RenderTargetCreationOptions): InternalTexture;
  88930. /**
  88931. * Creates a depth stencil texture.
  88932. * This is only available in WebGL 2 or with the depth texture extension available.
  88933. * @param size The size of face edge in the texture.
  88934. * @param options The options defining the texture.
  88935. * @returns The texture
  88936. */
  88937. createDepthStencilTexture(size: RenderTargetTextureSize, options: DepthTextureCreationOptions): InternalTexture;
  88938. /** @hidden */
  88939. _createDepthStencilTexture(size: RenderTargetTextureSize, options: DepthTextureCreationOptions): InternalTexture;
  88940. }
  88941. }
  88942. declare module BABYLON {
  88943. /**
  88944. * Defines the kind of connection point for node based material
  88945. */
  88946. export enum NodeMaterialBlockConnectionPointTypes {
  88947. /** Float */
  88948. Float = 1,
  88949. /** Int */
  88950. Int = 2,
  88951. /** Vector2 */
  88952. Vector2 = 4,
  88953. /** Vector3 */
  88954. Vector3 = 8,
  88955. /** Vector4 */
  88956. Vector4 = 16,
  88957. /** Color3 */
  88958. Color3 = 32,
  88959. /** Color4 */
  88960. Color4 = 64,
  88961. /** Matrix */
  88962. Matrix = 128,
  88963. /** Custom object */
  88964. Object = 256,
  88965. /** Detect type based on connection */
  88966. AutoDetect = 1024,
  88967. /** Output type that will be defined by input type */
  88968. BasedOnInput = 2048
  88969. }
  88970. }
  88971. declare module BABYLON {
  88972. /**
  88973. * Enum used to define the target of a block
  88974. */
  88975. export enum NodeMaterialBlockTargets {
  88976. /** Vertex shader */
  88977. Vertex = 1,
  88978. /** Fragment shader */
  88979. Fragment = 2,
  88980. /** Neutral */
  88981. Neutral = 4,
  88982. /** Vertex and Fragment */
  88983. VertexAndFragment = 3
  88984. }
  88985. }
  88986. declare module BABYLON {
  88987. /**
  88988. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  88989. */
  88990. export enum NodeMaterialBlockConnectionPointMode {
  88991. /** Value is an uniform */
  88992. Uniform = 0,
  88993. /** Value is a mesh attribute */
  88994. Attribute = 1,
  88995. /** Value is a varying between vertex and fragment shaders */
  88996. Varying = 2,
  88997. /** Mode is undefined */
  88998. Undefined = 3
  88999. }
  89000. }
  89001. declare module BABYLON {
  89002. /**
  89003. * Enum used to define system values e.g. values automatically provided by the system
  89004. */
  89005. export enum NodeMaterialSystemValues {
  89006. /** World */
  89007. World = 1,
  89008. /** View */
  89009. View = 2,
  89010. /** Projection */
  89011. Projection = 3,
  89012. /** ViewProjection */
  89013. ViewProjection = 4,
  89014. /** WorldView */
  89015. WorldView = 5,
  89016. /** WorldViewProjection */
  89017. WorldViewProjection = 6,
  89018. /** CameraPosition */
  89019. CameraPosition = 7,
  89020. /** Fog Color */
  89021. FogColor = 8,
  89022. /** Delta time */
  89023. DeltaTime = 9
  89024. }
  89025. }
  89026. declare module BABYLON {
  89027. /** Defines supported spaces */
  89028. export enum Space {
  89029. /** Local (object) space */
  89030. LOCAL = 0,
  89031. /** World space */
  89032. WORLD = 1,
  89033. /** Bone space */
  89034. BONE = 2
  89035. }
  89036. /** Defines the 3 main axes */
  89037. export class Axis {
  89038. /** X axis */
  89039. static X: Vector3;
  89040. /** Y axis */
  89041. static Y: Vector3;
  89042. /** Z axis */
  89043. static Z: Vector3;
  89044. }
  89045. }
  89046. declare module BABYLON {
  89047. /**
  89048. * Represents a camera frustum
  89049. */
  89050. export class Frustum {
  89051. /**
  89052. * Gets the planes representing the frustum
  89053. * @param transform matrix to be applied to the returned planes
  89054. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  89055. */
  89056. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  89057. /**
  89058. * Gets the near frustum plane transformed by the transform matrix
  89059. * @param transform transformation matrix to be applied to the resulting frustum plane
  89060. * @param frustumPlane the resuling frustum plane
  89061. */
  89062. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  89063. /**
  89064. * Gets the far frustum plane transformed by the transform matrix
  89065. * @param transform transformation matrix to be applied to the resulting frustum plane
  89066. * @param frustumPlane the resuling frustum plane
  89067. */
  89068. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  89069. /**
  89070. * Gets the left frustum plane transformed by the transform matrix
  89071. * @param transform transformation matrix to be applied to the resulting frustum plane
  89072. * @param frustumPlane the resuling frustum plane
  89073. */
  89074. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  89075. /**
  89076. * Gets the right frustum plane transformed by the transform matrix
  89077. * @param transform transformation matrix to be applied to the resulting frustum plane
  89078. * @param frustumPlane the resuling frustum plane
  89079. */
  89080. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  89081. /**
  89082. * Gets the top frustum plane transformed by the transform matrix
  89083. * @param transform transformation matrix to be applied to the resulting frustum plane
  89084. * @param frustumPlane the resuling frustum plane
  89085. */
  89086. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  89087. /**
  89088. * Gets the bottom frustum plane transformed by the transform matrix
  89089. * @param transform transformation matrix to be applied to the resulting frustum plane
  89090. * @param frustumPlane the resuling frustum plane
  89091. */
  89092. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  89093. /**
  89094. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  89095. * @param transform transformation matrix to be applied to the resulting frustum planes
  89096. * @param frustumPlanes the resuling frustum planes
  89097. */
  89098. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  89099. }
  89100. }
  89101. declare module BABYLON {
  89102. /**
  89103. * Interface for the size containing width and height
  89104. */
  89105. export interface ISize {
  89106. /**
  89107. * Width
  89108. */
  89109. width: number;
  89110. /**
  89111. * Heighht
  89112. */
  89113. height: number;
  89114. }
  89115. /**
  89116. * Size containing widht and height
  89117. */
  89118. export class Size implements ISize {
  89119. /**
  89120. * Width
  89121. */
  89122. width: number;
  89123. /**
  89124. * Height
  89125. */
  89126. height: number;
  89127. /**
  89128. * Creates a Size object from the given width and height (floats).
  89129. * @param width width of the new size
  89130. * @param height height of the new size
  89131. */
  89132. constructor(width: number, height: number);
  89133. /**
  89134. * Returns a string with the Size width and height
  89135. * @returns a string with the Size width and height
  89136. */
  89137. toString(): string;
  89138. /**
  89139. * "Size"
  89140. * @returns the string "Size"
  89141. */
  89142. getClassName(): string;
  89143. /**
  89144. * Returns the Size hash code.
  89145. * @returns a hash code for a unique width and height
  89146. */
  89147. getHashCode(): number;
  89148. /**
  89149. * Updates the current size from the given one.
  89150. * @param src the given size
  89151. */
  89152. copyFrom(src: Size): void;
  89153. /**
  89154. * Updates in place the current Size from the given floats.
  89155. * @param width width of the new size
  89156. * @param height height of the new size
  89157. * @returns the updated Size.
  89158. */
  89159. copyFromFloats(width: number, height: number): Size;
  89160. /**
  89161. * Updates in place the current Size from the given floats.
  89162. * @param width width to set
  89163. * @param height height to set
  89164. * @returns the updated Size.
  89165. */
  89166. set(width: number, height: number): Size;
  89167. /**
  89168. * Multiplies the width and height by numbers
  89169. * @param w factor to multiple the width by
  89170. * @param h factor to multiple the height by
  89171. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  89172. */
  89173. multiplyByFloats(w: number, h: number): Size;
  89174. /**
  89175. * Clones the size
  89176. * @returns a new Size copied from the given one.
  89177. */
  89178. clone(): Size;
  89179. /**
  89180. * True if the current Size and the given one width and height are strictly equal.
  89181. * @param other the other size to compare against
  89182. * @returns True if the current Size and the given one width and height are strictly equal.
  89183. */
  89184. equals(other: Size): boolean;
  89185. /**
  89186. * The surface of the Size : width * height (float).
  89187. */
  89188. get surface(): number;
  89189. /**
  89190. * Create a new size of zero
  89191. * @returns a new Size set to (0.0, 0.0)
  89192. */
  89193. static Zero(): Size;
  89194. /**
  89195. * Sums the width and height of two sizes
  89196. * @param otherSize size to add to this size
  89197. * @returns a new Size set as the addition result of the current Size and the given one.
  89198. */
  89199. add(otherSize: Size): Size;
  89200. /**
  89201. * Subtracts the width and height of two
  89202. * @param otherSize size to subtract to this size
  89203. * @returns a new Size set as the subtraction result of the given one from the current Size.
  89204. */
  89205. subtract(otherSize: Size): Size;
  89206. /**
  89207. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  89208. * @param start starting size to lerp between
  89209. * @param end end size to lerp between
  89210. * @param amount amount to lerp between the start and end values
  89211. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  89212. */
  89213. static Lerp(start: Size, end: Size, amount: number): Size;
  89214. }
  89215. }
  89216. declare module BABYLON {
  89217. /**
  89218. * Contains position and normal vectors for a vertex
  89219. */
  89220. export class PositionNormalVertex {
  89221. /** the position of the vertex (defaut: 0,0,0) */
  89222. position: Vector3;
  89223. /** the normal of the vertex (defaut: 0,1,0) */
  89224. normal: Vector3;
  89225. /**
  89226. * Creates a PositionNormalVertex
  89227. * @param position the position of the vertex (defaut: 0,0,0)
  89228. * @param normal the normal of the vertex (defaut: 0,1,0)
  89229. */
  89230. constructor(
  89231. /** the position of the vertex (defaut: 0,0,0) */
  89232. position?: Vector3,
  89233. /** the normal of the vertex (defaut: 0,1,0) */
  89234. normal?: Vector3);
  89235. /**
  89236. * Clones the PositionNormalVertex
  89237. * @returns the cloned PositionNormalVertex
  89238. */
  89239. clone(): PositionNormalVertex;
  89240. }
  89241. /**
  89242. * Contains position, normal and uv vectors for a vertex
  89243. */
  89244. export class PositionNormalTextureVertex {
  89245. /** the position of the vertex (defaut: 0,0,0) */
  89246. position: Vector3;
  89247. /** the normal of the vertex (defaut: 0,1,0) */
  89248. normal: Vector3;
  89249. /** the uv of the vertex (default: 0,0) */
  89250. uv: Vector2;
  89251. /**
  89252. * Creates a PositionNormalTextureVertex
  89253. * @param position the position of the vertex (defaut: 0,0,0)
  89254. * @param normal the normal of the vertex (defaut: 0,1,0)
  89255. * @param uv the uv of the vertex (default: 0,0)
  89256. */
  89257. constructor(
  89258. /** the position of the vertex (defaut: 0,0,0) */
  89259. position?: Vector3,
  89260. /** the normal of the vertex (defaut: 0,1,0) */
  89261. normal?: Vector3,
  89262. /** the uv of the vertex (default: 0,0) */
  89263. uv?: Vector2);
  89264. /**
  89265. * Clones the PositionNormalTextureVertex
  89266. * @returns the cloned PositionNormalTextureVertex
  89267. */
  89268. clone(): PositionNormalTextureVertex;
  89269. }
  89270. }
  89271. declare module BABYLON {
  89272. /**
  89273. * Enum defining the type of animations supported by InputBlock
  89274. */
  89275. export enum AnimatedInputBlockTypes {
  89276. /** No animation */
  89277. None = 0,
  89278. /** Time based animation. Will only work for floats */
  89279. Time = 1
  89280. }
  89281. }
  89282. declare module BABYLON {
  89283. /**
  89284. * Interface describing all the common properties and methods a shadow light needs to implement.
  89285. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  89286. * as well as binding the different shadow properties to the effects.
  89287. */
  89288. export interface IShadowLight extends Light {
  89289. /**
  89290. * The light id in the scene (used in scene.findLighById for instance)
  89291. */
  89292. id: string;
  89293. /**
  89294. * The position the shdow will be casted from.
  89295. */
  89296. position: Vector3;
  89297. /**
  89298. * In 2d mode (needCube being false), the direction used to cast the shadow.
  89299. */
  89300. direction: Vector3;
  89301. /**
  89302. * The transformed position. Position of the light in world space taking parenting in account.
  89303. */
  89304. transformedPosition: Vector3;
  89305. /**
  89306. * The transformed direction. Direction of the light in world space taking parenting in account.
  89307. */
  89308. transformedDirection: Vector3;
  89309. /**
  89310. * The friendly name of the light in the scene.
  89311. */
  89312. name: string;
  89313. /**
  89314. * Defines the shadow projection clipping minimum z value.
  89315. */
  89316. shadowMinZ: number;
  89317. /**
  89318. * Defines the shadow projection clipping maximum z value.
  89319. */
  89320. shadowMaxZ: number;
  89321. /**
  89322. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  89323. * @returns true if the information has been computed, false if it does not need to (no parenting)
  89324. */
  89325. computeTransformedInformation(): boolean;
  89326. /**
  89327. * Gets the scene the light belongs to.
  89328. * @returns The scene
  89329. */
  89330. getScene(): Scene;
  89331. /**
  89332. * Callback defining a custom Projection Matrix Builder.
  89333. * This can be used to override the default projection matrix computation.
  89334. */
  89335. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  89336. /**
  89337. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  89338. * @param matrix The materix to updated with the projection information
  89339. * @param viewMatrix The transform matrix of the light
  89340. * @param renderList The list of mesh to render in the map
  89341. * @returns The current light
  89342. */
  89343. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  89344. /**
  89345. * Gets the current depth scale used in ESM.
  89346. * @returns The scale
  89347. */
  89348. getDepthScale(): number;
  89349. /**
  89350. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  89351. * @returns true if a cube texture needs to be use
  89352. */
  89353. needCube(): boolean;
  89354. /**
  89355. * Detects if the projection matrix requires to be recomputed this frame.
  89356. * @returns true if it requires to be recomputed otherwise, false.
  89357. */
  89358. needProjectionMatrixCompute(): boolean;
  89359. /**
  89360. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  89361. */
  89362. forceProjectionMatrixCompute(): void;
  89363. /**
  89364. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  89365. * @param faceIndex The index of the face we are computed the direction to generate shadow
  89366. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  89367. */
  89368. getShadowDirection(faceIndex?: number): Vector3;
  89369. /**
  89370. * Gets the minZ used for shadow according to both the scene and the light.
  89371. * @param activeCamera The camera we are returning the min for
  89372. * @returns the depth min z
  89373. */
  89374. getDepthMinZ(activeCamera: Camera): number;
  89375. /**
  89376. * Gets the maxZ used for shadow according to both the scene and the light.
  89377. * @param activeCamera The camera we are returning the max for
  89378. * @returns the depth max z
  89379. */
  89380. getDepthMaxZ(activeCamera: Camera): number;
  89381. }
  89382. /**
  89383. * Base implementation IShadowLight
  89384. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  89385. */
  89386. export abstract class ShadowLight extends Light implements IShadowLight {
  89387. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  89388. protected _position: Vector3;
  89389. protected _setPosition(value: Vector3): void;
  89390. /**
  89391. * Sets the position the shadow will be casted from. Also use as the light position for both
  89392. * point and spot lights.
  89393. */
  89394. get position(): Vector3;
  89395. /**
  89396. * Sets the position the shadow will be casted from. Also use as the light position for both
  89397. * point and spot lights.
  89398. */
  89399. set position(value: Vector3);
  89400. protected _direction: Vector3;
  89401. protected _setDirection(value: Vector3): void;
  89402. /**
  89403. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  89404. * Also use as the light direction on spot and directional lights.
  89405. */
  89406. get direction(): Vector3;
  89407. /**
  89408. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  89409. * Also use as the light direction on spot and directional lights.
  89410. */
  89411. set direction(value: Vector3);
  89412. protected _shadowMinZ: number;
  89413. /**
  89414. * Gets the shadow projection clipping minimum z value.
  89415. */
  89416. get shadowMinZ(): number;
  89417. /**
  89418. * Sets the shadow projection clipping minimum z value.
  89419. */
  89420. set shadowMinZ(value: number);
  89421. protected _shadowMaxZ: number;
  89422. /**
  89423. * Sets the shadow projection clipping maximum z value.
  89424. */
  89425. get shadowMaxZ(): number;
  89426. /**
  89427. * Gets the shadow projection clipping maximum z value.
  89428. */
  89429. set shadowMaxZ(value: number);
  89430. /**
  89431. * Callback defining a custom Projection Matrix Builder.
  89432. * This can be used to override the default projection matrix computation.
  89433. */
  89434. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  89435. /**
  89436. * The transformed position. Position of the light in world space taking parenting in account.
  89437. */
  89438. transformedPosition: Vector3;
  89439. /**
  89440. * The transformed direction. Direction of the light in world space taking parenting in account.
  89441. */
  89442. transformedDirection: Vector3;
  89443. private _needProjectionMatrixCompute;
  89444. /**
  89445. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  89446. * @returns true if the information has been computed, false if it does not need to (no parenting)
  89447. */
  89448. computeTransformedInformation(): boolean;
  89449. /**
  89450. * Return the depth scale used for the shadow map.
  89451. * @returns the depth scale.
  89452. */
  89453. getDepthScale(): number;
  89454. /**
  89455. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  89456. * @param faceIndex The index of the face we are computed the direction to generate shadow
  89457. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  89458. */
  89459. getShadowDirection(faceIndex?: number): Vector3;
  89460. /**
  89461. * Returns the ShadowLight absolute position in the World.
  89462. * @returns the position vector in world space
  89463. */
  89464. getAbsolutePosition(): Vector3;
  89465. /**
  89466. * Sets the ShadowLight direction toward the passed target.
  89467. * @param target The point to target in local space
  89468. * @returns the updated ShadowLight direction
  89469. */
  89470. setDirectionToTarget(target: Vector3): Vector3;
  89471. /**
  89472. * Returns the light rotation in euler definition.
  89473. * @returns the x y z rotation in local space.
  89474. */
  89475. getRotation(): Vector3;
  89476. /**
  89477. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  89478. * @returns true if a cube texture needs to be use
  89479. */
  89480. needCube(): boolean;
  89481. /**
  89482. * Detects if the projection matrix requires to be recomputed this frame.
  89483. * @returns true if it requires to be recomputed otherwise, false.
  89484. */
  89485. needProjectionMatrixCompute(): boolean;
  89486. /**
  89487. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  89488. */
  89489. forceProjectionMatrixCompute(): void;
  89490. /** @hidden */
  89491. _initCache(): void;
  89492. /** @hidden */
  89493. _isSynchronized(): boolean;
  89494. /**
  89495. * Computes the world matrix of the node
  89496. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  89497. * @returns the world matrix
  89498. */
  89499. computeWorldMatrix(force?: boolean): Matrix;
  89500. /**
  89501. * Gets the minZ used for shadow according to both the scene and the light.
  89502. * @param activeCamera The camera we are returning the min for
  89503. * @returns the depth min z
  89504. */
  89505. getDepthMinZ(activeCamera: Camera): number;
  89506. /**
  89507. * Gets the maxZ used for shadow according to both the scene and the light.
  89508. * @param activeCamera The camera we are returning the max for
  89509. * @returns the depth max z
  89510. */
  89511. getDepthMaxZ(activeCamera: Camera): number;
  89512. /**
  89513. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  89514. * @param matrix The materix to updated with the projection information
  89515. * @param viewMatrix The transform matrix of the light
  89516. * @param renderList The list of mesh to render in the map
  89517. * @returns The current light
  89518. */
  89519. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  89520. }
  89521. }
  89522. declare module BABYLON {
  89523. /** @hidden */
  89524. export var packingFunctions: {
  89525. name: string;
  89526. shader: string;
  89527. };
  89528. }
  89529. declare module BABYLON {
  89530. /** @hidden */
  89531. export var bayerDitherFunctions: {
  89532. name: string;
  89533. shader: string;
  89534. };
  89535. }
  89536. declare module BABYLON {
  89537. /** @hidden */
  89538. export var shadowMapFragmentDeclaration: {
  89539. name: string;
  89540. shader: string;
  89541. };
  89542. }
  89543. declare module BABYLON {
  89544. /** @hidden */
  89545. export var clipPlaneFragmentDeclaration: {
  89546. name: string;
  89547. shader: string;
  89548. };
  89549. }
  89550. declare module BABYLON {
  89551. /** @hidden */
  89552. export var clipPlaneFragment: {
  89553. name: string;
  89554. shader: string;
  89555. };
  89556. }
  89557. declare module BABYLON {
  89558. /** @hidden */
  89559. export var shadowMapFragment: {
  89560. name: string;
  89561. shader: string;
  89562. };
  89563. }
  89564. declare module BABYLON {
  89565. /** @hidden */
  89566. export var shadowMapPixelShader: {
  89567. name: string;
  89568. shader: string;
  89569. };
  89570. }
  89571. declare module BABYLON {
  89572. /** @hidden */
  89573. export var bonesDeclaration: {
  89574. name: string;
  89575. shader: string;
  89576. };
  89577. }
  89578. declare module BABYLON {
  89579. /** @hidden */
  89580. export var morphTargetsVertexGlobalDeclaration: {
  89581. name: string;
  89582. shader: string;
  89583. };
  89584. }
  89585. declare module BABYLON {
  89586. /** @hidden */
  89587. export var morphTargetsVertexDeclaration: {
  89588. name: string;
  89589. shader: string;
  89590. };
  89591. }
  89592. declare module BABYLON {
  89593. /** @hidden */
  89594. export var instancesDeclaration: {
  89595. name: string;
  89596. shader: string;
  89597. };
  89598. }
  89599. declare module BABYLON {
  89600. /** @hidden */
  89601. export var helperFunctions: {
  89602. name: string;
  89603. shader: string;
  89604. };
  89605. }
  89606. declare module BABYLON {
  89607. /** @hidden */
  89608. export var shadowMapVertexDeclaration: {
  89609. name: string;
  89610. shader: string;
  89611. };
  89612. }
  89613. declare module BABYLON {
  89614. /** @hidden */
  89615. export var clipPlaneVertexDeclaration: {
  89616. name: string;
  89617. shader: string;
  89618. };
  89619. }
  89620. declare module BABYLON {
  89621. /** @hidden */
  89622. export var morphTargetsVertex: {
  89623. name: string;
  89624. shader: string;
  89625. };
  89626. }
  89627. declare module BABYLON {
  89628. /** @hidden */
  89629. export var instancesVertex: {
  89630. name: string;
  89631. shader: string;
  89632. };
  89633. }
  89634. declare module BABYLON {
  89635. /** @hidden */
  89636. export var bonesVertex: {
  89637. name: string;
  89638. shader: string;
  89639. };
  89640. }
  89641. declare module BABYLON {
  89642. /** @hidden */
  89643. export var shadowMapVertexNormalBias: {
  89644. name: string;
  89645. shader: string;
  89646. };
  89647. }
  89648. declare module BABYLON {
  89649. /** @hidden */
  89650. export var shadowMapVertexMetric: {
  89651. name: string;
  89652. shader: string;
  89653. };
  89654. }
  89655. declare module BABYLON {
  89656. /** @hidden */
  89657. export var clipPlaneVertex: {
  89658. name: string;
  89659. shader: string;
  89660. };
  89661. }
  89662. declare module BABYLON {
  89663. /** @hidden */
  89664. export var shadowMapVertexShader: {
  89665. name: string;
  89666. shader: string;
  89667. };
  89668. }
  89669. declare module BABYLON {
  89670. /** @hidden */
  89671. export var depthBoxBlurPixelShader: {
  89672. name: string;
  89673. shader: string;
  89674. };
  89675. }
  89676. declare module BABYLON {
  89677. /** @hidden */
  89678. export var shadowMapFragmentSoftTransparentShadow: {
  89679. name: string;
  89680. shader: string;
  89681. };
  89682. }
  89683. declare module BABYLON {
  89684. /**
  89685. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  89686. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  89687. */
  89688. export class EffectFallbacks implements IEffectFallbacks {
  89689. private _defines;
  89690. private _currentRank;
  89691. private _maxRank;
  89692. private _mesh;
  89693. /**
  89694. * Removes the fallback from the bound mesh.
  89695. */
  89696. unBindMesh(): void;
  89697. /**
  89698. * Adds a fallback on the specified property.
  89699. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  89700. * @param define The name of the define in the shader
  89701. */
  89702. addFallback(rank: number, define: string): void;
  89703. /**
  89704. * Sets the mesh to use CPU skinning when needing to fallback.
  89705. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  89706. * @param mesh The mesh to use the fallbacks.
  89707. */
  89708. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  89709. /**
  89710. * Checks to see if more fallbacks are still availible.
  89711. */
  89712. get hasMoreFallbacks(): boolean;
  89713. /**
  89714. * Removes the defines that should be removed when falling back.
  89715. * @param currentDefines defines the current define statements for the shader.
  89716. * @param effect defines the current effect we try to compile
  89717. * @returns The resulting defines with defines of the current rank removed.
  89718. */
  89719. reduce(currentDefines: string, effect: Effect): string;
  89720. }
  89721. }
  89722. declare module BABYLON {
  89723. /**
  89724. * Interface used to define Action
  89725. */
  89726. export interface IAction {
  89727. /**
  89728. * Trigger for the action
  89729. */
  89730. trigger: number;
  89731. /** Options of the trigger */
  89732. triggerOptions: any;
  89733. /**
  89734. * Gets the trigger parameters
  89735. * @returns the trigger parameters
  89736. */
  89737. getTriggerParameter(): any;
  89738. /**
  89739. * Internal only - executes current action event
  89740. * @hidden
  89741. */
  89742. _executeCurrent(evt?: ActionEvent): void;
  89743. /**
  89744. * Serialize placeholder for child classes
  89745. * @param parent of child
  89746. * @returns the serialized object
  89747. */
  89748. serialize(parent: any): any;
  89749. /**
  89750. * Internal only
  89751. * @hidden
  89752. */
  89753. _prepare(): void;
  89754. /**
  89755. * Internal only - manager for action
  89756. * @hidden
  89757. */
  89758. _actionManager: Nullable<AbstractActionManager>;
  89759. /**
  89760. * Adds action to chain of actions, may be a DoNothingAction
  89761. * @param action defines the next action to execute
  89762. * @returns The action passed in
  89763. * @see https://www.babylonjs-playground.com/#1T30HR#0
  89764. */
  89765. then(action: IAction): IAction;
  89766. }
  89767. /**
  89768. * The action to be carried out following a trigger
  89769. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  89770. */
  89771. export class Action implements IAction {
  89772. /** the trigger, with or without parameters, for the action */
  89773. triggerOptions: any;
  89774. /**
  89775. * Trigger for the action
  89776. */
  89777. trigger: number;
  89778. /**
  89779. * Internal only - manager for action
  89780. * @hidden
  89781. */
  89782. _actionManager: ActionManager;
  89783. private _nextActiveAction;
  89784. private _child;
  89785. private _condition?;
  89786. private _triggerParameter;
  89787. /**
  89788. * An event triggered prior to action being executed.
  89789. */
  89790. onBeforeExecuteObservable: Observable<Action>;
  89791. /**
  89792. * Creates a new Action
  89793. * @param triggerOptions the trigger, with or without parameters, for the action
  89794. * @param condition an optional determinant of action
  89795. */
  89796. constructor(
  89797. /** the trigger, with or without parameters, for the action */
  89798. triggerOptions: any, condition?: Condition);
  89799. /**
  89800. * Internal only
  89801. * @hidden
  89802. */
  89803. _prepare(): void;
  89804. /**
  89805. * Gets the trigger parameters
  89806. * @returns the trigger parameters
  89807. */
  89808. getTriggerParameter(): any;
  89809. /**
  89810. * Internal only - executes current action event
  89811. * @hidden
  89812. */
  89813. _executeCurrent(evt?: ActionEvent): void;
  89814. /**
  89815. * Execute placeholder for child classes
  89816. * @param evt optional action event
  89817. */
  89818. execute(evt?: ActionEvent): void;
  89819. /**
  89820. * Skips to next active action
  89821. */
  89822. skipToNextActiveAction(): void;
  89823. /**
  89824. * Adds action to chain of actions, may be a DoNothingAction
  89825. * @param action defines the next action to execute
  89826. * @returns The action passed in
  89827. * @see https://www.babylonjs-playground.com/#1T30HR#0
  89828. */
  89829. then(action: Action): Action;
  89830. /**
  89831. * Internal only
  89832. * @hidden
  89833. */
  89834. _getProperty(propertyPath: string): string;
  89835. /**
  89836. * Internal only
  89837. * @hidden
  89838. */
  89839. _getEffectiveTarget(target: any, propertyPath: string): any;
  89840. /**
  89841. * Serialize placeholder for child classes
  89842. * @param parent of child
  89843. * @returns the serialized object
  89844. */
  89845. serialize(parent: any): any;
  89846. /**
  89847. * Internal only called by serialize
  89848. * @hidden
  89849. */
  89850. protected _serialize(serializedAction: any, parent?: any): any;
  89851. /**
  89852. * Internal only
  89853. * @hidden
  89854. */
  89855. static _SerializeValueAsString: (value: any) => string;
  89856. /**
  89857. * Internal only
  89858. * @hidden
  89859. */
  89860. static _GetTargetProperty: (target: Scene | Node) => {
  89861. name: string;
  89862. targetType: string;
  89863. value: string;
  89864. };
  89865. }
  89866. }
  89867. declare module BABYLON {
  89868. /**
  89869. * A Condition applied to an Action
  89870. */
  89871. export class Condition {
  89872. /**
  89873. * Internal only - manager for action
  89874. * @hidden
  89875. */
  89876. _actionManager: ActionManager;
  89877. /**
  89878. * Internal only
  89879. * @hidden
  89880. */
  89881. _evaluationId: number;
  89882. /**
  89883. * Internal only
  89884. * @hidden
  89885. */
  89886. _currentResult: boolean;
  89887. /**
  89888. * Creates a new Condition
  89889. * @param actionManager the manager of the action the condition is applied to
  89890. */
  89891. constructor(actionManager: ActionManager);
  89892. /**
  89893. * Check if the current condition is valid
  89894. * @returns a boolean
  89895. */
  89896. isValid(): boolean;
  89897. /**
  89898. * Internal only
  89899. * @hidden
  89900. */
  89901. _getProperty(propertyPath: string): string;
  89902. /**
  89903. * Internal only
  89904. * @hidden
  89905. */
  89906. _getEffectiveTarget(target: any, propertyPath: string): any;
  89907. /**
  89908. * Serialize placeholder for child classes
  89909. * @returns the serialized object
  89910. */
  89911. serialize(): any;
  89912. /**
  89913. * Internal only
  89914. * @hidden
  89915. */
  89916. protected _serialize(serializedCondition: any): any;
  89917. }
  89918. /**
  89919. * Defines specific conditional operators as extensions of Condition
  89920. */
  89921. export class ValueCondition extends Condition {
  89922. /** path to specify the property of the target the conditional operator uses */
  89923. propertyPath: string;
  89924. /** the value compared by the conditional operator against the current value of the property */
  89925. value: any;
  89926. /** the conditional operator, default ValueCondition.IsEqual */
  89927. operator: number;
  89928. /**
  89929. * Internal only
  89930. * @hidden
  89931. */
  89932. private static _IsEqual;
  89933. /**
  89934. * Internal only
  89935. * @hidden
  89936. */
  89937. private static _IsDifferent;
  89938. /**
  89939. * Internal only
  89940. * @hidden
  89941. */
  89942. private static _IsGreater;
  89943. /**
  89944. * Internal only
  89945. * @hidden
  89946. */
  89947. private static _IsLesser;
  89948. /**
  89949. * returns the number for IsEqual
  89950. */
  89951. static get IsEqual(): number;
  89952. /**
  89953. * Returns the number for IsDifferent
  89954. */
  89955. static get IsDifferent(): number;
  89956. /**
  89957. * Returns the number for IsGreater
  89958. */
  89959. static get IsGreater(): number;
  89960. /**
  89961. * Returns the number for IsLesser
  89962. */
  89963. static get IsLesser(): number;
  89964. /**
  89965. * Internal only The action manager for the condition
  89966. * @hidden
  89967. */
  89968. _actionManager: ActionManager;
  89969. /**
  89970. * Internal only
  89971. * @hidden
  89972. */
  89973. private _target;
  89974. /**
  89975. * Internal only
  89976. * @hidden
  89977. */
  89978. private _effectiveTarget;
  89979. /**
  89980. * Internal only
  89981. * @hidden
  89982. */
  89983. private _property;
  89984. /**
  89985. * Creates a new ValueCondition
  89986. * @param actionManager manager for the action the condition applies to
  89987. * @param target for the action
  89988. * @param propertyPath path to specify the property of the target the conditional operator uses
  89989. * @param value the value compared by the conditional operator against the current value of the property
  89990. * @param operator the conditional operator, default ValueCondition.IsEqual
  89991. */
  89992. constructor(actionManager: ActionManager, target: any,
  89993. /** path to specify the property of the target the conditional operator uses */
  89994. propertyPath: string,
  89995. /** the value compared by the conditional operator against the current value of the property */
  89996. value: any,
  89997. /** the conditional operator, default ValueCondition.IsEqual */
  89998. operator?: number);
  89999. /**
  90000. * Compares the given value with the property value for the specified conditional operator
  90001. * @returns the result of the comparison
  90002. */
  90003. isValid(): boolean;
  90004. /**
  90005. * Serialize the ValueCondition into a JSON compatible object
  90006. * @returns serialization object
  90007. */
  90008. serialize(): any;
  90009. /**
  90010. * Gets the name of the conditional operator for the ValueCondition
  90011. * @param operator the conditional operator
  90012. * @returns the name
  90013. */
  90014. static GetOperatorName(operator: number): string;
  90015. }
  90016. /**
  90017. * Defines a predicate condition as an extension of Condition
  90018. */
  90019. export class PredicateCondition extends Condition {
  90020. /** defines the predicate function used to validate the condition */
  90021. predicate: () => boolean;
  90022. /**
  90023. * Internal only - manager for action
  90024. * @hidden
  90025. */
  90026. _actionManager: ActionManager;
  90027. /**
  90028. * Creates a new PredicateCondition
  90029. * @param actionManager manager for the action the condition applies to
  90030. * @param predicate defines the predicate function used to validate the condition
  90031. */
  90032. constructor(actionManager: ActionManager,
  90033. /** defines the predicate function used to validate the condition */
  90034. predicate: () => boolean);
  90035. /**
  90036. * @returns the validity of the predicate condition
  90037. */
  90038. isValid(): boolean;
  90039. }
  90040. /**
  90041. * Defines a state condition as an extension of Condition
  90042. */
  90043. export class StateCondition extends Condition {
  90044. /** Value to compare with target state */
  90045. value: string;
  90046. /**
  90047. * Internal only - manager for action
  90048. * @hidden
  90049. */
  90050. _actionManager: ActionManager;
  90051. /**
  90052. * Internal only
  90053. * @hidden
  90054. */
  90055. private _target;
  90056. /**
  90057. * Creates a new StateCondition
  90058. * @param actionManager manager for the action the condition applies to
  90059. * @param target of the condition
  90060. * @param value to compare with target state
  90061. */
  90062. constructor(actionManager: ActionManager, target: any,
  90063. /** Value to compare with target state */
  90064. value: string);
  90065. /**
  90066. * Gets a boolean indicating if the current condition is met
  90067. * @returns the validity of the state
  90068. */
  90069. isValid(): boolean;
  90070. /**
  90071. * Serialize the StateCondition into a JSON compatible object
  90072. * @returns serialization object
  90073. */
  90074. serialize(): any;
  90075. }
  90076. }
  90077. declare module BABYLON {
  90078. /**
  90079. * This defines an action responsible to toggle a boolean once triggered.
  90080. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90081. */
  90082. export class SwitchBooleanAction extends Action {
  90083. /**
  90084. * The path to the boolean property in the target object
  90085. */
  90086. propertyPath: string;
  90087. private _target;
  90088. private _effectiveTarget;
  90089. private _property;
  90090. /**
  90091. * Instantiate the action
  90092. * @param triggerOptions defines the trigger options
  90093. * @param target defines the object containing the boolean
  90094. * @param propertyPath defines the path to the boolean property in the target object
  90095. * @param condition defines the trigger related conditions
  90096. */
  90097. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  90098. /** @hidden */
  90099. _prepare(): void;
  90100. /**
  90101. * Execute the action toggle the boolean value.
  90102. */
  90103. execute(): void;
  90104. /**
  90105. * Serializes the actions and its related information.
  90106. * @param parent defines the object to serialize in
  90107. * @returns the serialized object
  90108. */
  90109. serialize(parent: any): any;
  90110. }
  90111. /**
  90112. * This defines an action responsible to set a the state field of the target
  90113. * to a desired value once triggered.
  90114. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90115. */
  90116. export class SetStateAction extends Action {
  90117. /**
  90118. * The value to store in the state field.
  90119. */
  90120. value: string;
  90121. private _target;
  90122. /**
  90123. * Instantiate the action
  90124. * @param triggerOptions defines the trigger options
  90125. * @param target defines the object containing the state property
  90126. * @param value defines the value to store in the state field
  90127. * @param condition defines the trigger related conditions
  90128. */
  90129. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  90130. /**
  90131. * Execute the action and store the value on the target state property.
  90132. */
  90133. execute(): void;
  90134. /**
  90135. * Serializes the actions and its related information.
  90136. * @param parent defines the object to serialize in
  90137. * @returns the serialized object
  90138. */
  90139. serialize(parent: any): any;
  90140. }
  90141. /**
  90142. * This defines an action responsible to set a property of the target
  90143. * to a desired value once triggered.
  90144. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90145. */
  90146. export class SetValueAction extends Action {
  90147. /**
  90148. * The path of the property to set in the target.
  90149. */
  90150. propertyPath: string;
  90151. /**
  90152. * The value to set in the property
  90153. */
  90154. value: any;
  90155. private _target;
  90156. private _effectiveTarget;
  90157. private _property;
  90158. /**
  90159. * Instantiate the action
  90160. * @param triggerOptions defines the trigger options
  90161. * @param target defines the object containing the property
  90162. * @param propertyPath defines the path of the property to set in the target
  90163. * @param value defines the value to set in the property
  90164. * @param condition defines the trigger related conditions
  90165. */
  90166. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  90167. /** @hidden */
  90168. _prepare(): void;
  90169. /**
  90170. * Execute the action and set the targetted property to the desired value.
  90171. */
  90172. execute(): void;
  90173. /**
  90174. * Serializes the actions and its related information.
  90175. * @param parent defines the object to serialize in
  90176. * @returns the serialized object
  90177. */
  90178. serialize(parent: any): any;
  90179. }
  90180. /**
  90181. * This defines an action responsible to increment the target value
  90182. * to a desired value once triggered.
  90183. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90184. */
  90185. export class IncrementValueAction extends Action {
  90186. /**
  90187. * The path of the property to increment in the target.
  90188. */
  90189. propertyPath: string;
  90190. /**
  90191. * The value we should increment the property by.
  90192. */
  90193. value: any;
  90194. private _target;
  90195. private _effectiveTarget;
  90196. private _property;
  90197. /**
  90198. * Instantiate the action
  90199. * @param triggerOptions defines the trigger options
  90200. * @param target defines the object containing the property
  90201. * @param propertyPath defines the path of the property to increment in the target
  90202. * @param value defines the value value we should increment the property by
  90203. * @param condition defines the trigger related conditions
  90204. */
  90205. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  90206. /** @hidden */
  90207. _prepare(): void;
  90208. /**
  90209. * Execute the action and increment the target of the value amount.
  90210. */
  90211. execute(): void;
  90212. /**
  90213. * Serializes the actions and its related information.
  90214. * @param parent defines the object to serialize in
  90215. * @returns the serialized object
  90216. */
  90217. serialize(parent: any): any;
  90218. }
  90219. /**
  90220. * This defines an action responsible to start an animation once triggered.
  90221. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90222. */
  90223. export class PlayAnimationAction extends Action {
  90224. /**
  90225. * Where the animation should start (animation frame)
  90226. */
  90227. from: number;
  90228. /**
  90229. * Where the animation should stop (animation frame)
  90230. */
  90231. to: number;
  90232. /**
  90233. * Define if the animation should loop or stop after the first play.
  90234. */
  90235. loop?: boolean;
  90236. private _target;
  90237. /**
  90238. * Instantiate the action
  90239. * @param triggerOptions defines the trigger options
  90240. * @param target defines the target animation or animation name
  90241. * @param from defines from where the animation should start (animation frame)
  90242. * @param end defines where the animation should stop (animation frame)
  90243. * @param loop defines if the animation should loop or stop after the first play
  90244. * @param condition defines the trigger related conditions
  90245. */
  90246. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  90247. /** @hidden */
  90248. _prepare(): void;
  90249. /**
  90250. * Execute the action and play the animation.
  90251. */
  90252. execute(): void;
  90253. /**
  90254. * Serializes the actions and its related information.
  90255. * @param parent defines the object to serialize in
  90256. * @returns the serialized object
  90257. */
  90258. serialize(parent: any): any;
  90259. }
  90260. /**
  90261. * This defines an action responsible to stop an animation once triggered.
  90262. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90263. */
  90264. export class StopAnimationAction extends Action {
  90265. private _target;
  90266. /**
  90267. * Instantiate the action
  90268. * @param triggerOptions defines the trigger options
  90269. * @param target defines the target animation or animation name
  90270. * @param condition defines the trigger related conditions
  90271. */
  90272. constructor(triggerOptions: any, target: any, condition?: Condition);
  90273. /** @hidden */
  90274. _prepare(): void;
  90275. /**
  90276. * Execute the action and stop the animation.
  90277. */
  90278. execute(): void;
  90279. /**
  90280. * Serializes the actions and its related information.
  90281. * @param parent defines the object to serialize in
  90282. * @returns the serialized object
  90283. */
  90284. serialize(parent: any): any;
  90285. }
  90286. /**
  90287. * This defines an action responsible that does nothing once triggered.
  90288. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90289. */
  90290. export class DoNothingAction extends Action {
  90291. /**
  90292. * Instantiate the action
  90293. * @param triggerOptions defines the trigger options
  90294. * @param condition defines the trigger related conditions
  90295. */
  90296. constructor(triggerOptions?: any, condition?: Condition);
  90297. /**
  90298. * Execute the action and do nothing.
  90299. */
  90300. execute(): void;
  90301. /**
  90302. * Serializes the actions and its related information.
  90303. * @param parent defines the object to serialize in
  90304. * @returns the serialized object
  90305. */
  90306. serialize(parent: any): any;
  90307. }
  90308. /**
  90309. * This defines an action responsible to trigger several actions once triggered.
  90310. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90311. */
  90312. export class CombineAction extends Action {
  90313. /**
  90314. * The list of aggregated animations to run.
  90315. */
  90316. children: Action[];
  90317. /**
  90318. * Instantiate the action
  90319. * @param triggerOptions defines the trigger options
  90320. * @param children defines the list of aggregated animations to run
  90321. * @param condition defines the trigger related conditions
  90322. */
  90323. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  90324. /** @hidden */
  90325. _prepare(): void;
  90326. /**
  90327. * Execute the action and executes all the aggregated actions.
  90328. */
  90329. execute(evt: ActionEvent): void;
  90330. /**
  90331. * Serializes the actions and its related information.
  90332. * @param parent defines the object to serialize in
  90333. * @returns the serialized object
  90334. */
  90335. serialize(parent: any): any;
  90336. }
  90337. /**
  90338. * This defines an action responsible to run code (external event) once triggered.
  90339. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90340. */
  90341. export class ExecuteCodeAction extends Action {
  90342. /**
  90343. * The callback function to run.
  90344. */
  90345. func: (evt: ActionEvent) => void;
  90346. /**
  90347. * Instantiate the action
  90348. * @param triggerOptions defines the trigger options
  90349. * @param func defines the callback function to run
  90350. * @param condition defines the trigger related conditions
  90351. */
  90352. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  90353. /**
  90354. * Execute the action and run the attached code.
  90355. */
  90356. execute(evt: ActionEvent): void;
  90357. }
  90358. /**
  90359. * This defines an action responsible to set the parent property of the target once triggered.
  90360. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90361. */
  90362. export class SetParentAction extends Action {
  90363. private _parent;
  90364. private _target;
  90365. /**
  90366. * Instantiate the action
  90367. * @param triggerOptions defines the trigger options
  90368. * @param target defines the target containing the parent property
  90369. * @param parent defines from where the animation should start (animation frame)
  90370. * @param condition defines the trigger related conditions
  90371. */
  90372. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  90373. /** @hidden */
  90374. _prepare(): void;
  90375. /**
  90376. * Execute the action and set the parent property.
  90377. */
  90378. execute(): void;
  90379. /**
  90380. * Serializes the actions and its related information.
  90381. * @param parent defines the object to serialize in
  90382. * @returns the serialized object
  90383. */
  90384. serialize(parent: any): any;
  90385. }
  90386. }
  90387. declare module BABYLON {
  90388. /**
  90389. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  90390. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  90391. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  90392. */
  90393. export class ActionManager extends AbstractActionManager {
  90394. /**
  90395. * Nothing
  90396. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90397. */
  90398. static readonly NothingTrigger: number;
  90399. /**
  90400. * On pick
  90401. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90402. */
  90403. static readonly OnPickTrigger: number;
  90404. /**
  90405. * On left pick
  90406. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90407. */
  90408. static readonly OnLeftPickTrigger: number;
  90409. /**
  90410. * On right pick
  90411. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90412. */
  90413. static readonly OnRightPickTrigger: number;
  90414. /**
  90415. * On center pick
  90416. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90417. */
  90418. static readonly OnCenterPickTrigger: number;
  90419. /**
  90420. * On pick down
  90421. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90422. */
  90423. static readonly OnPickDownTrigger: number;
  90424. /**
  90425. * On double pick
  90426. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90427. */
  90428. static readonly OnDoublePickTrigger: number;
  90429. /**
  90430. * On pick up
  90431. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90432. */
  90433. static readonly OnPickUpTrigger: number;
  90434. /**
  90435. * On pick out.
  90436. * This trigger will only be raised if you also declared a OnPickDown
  90437. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90438. */
  90439. static readonly OnPickOutTrigger: number;
  90440. /**
  90441. * On long press
  90442. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90443. */
  90444. static readonly OnLongPressTrigger: number;
  90445. /**
  90446. * On pointer over
  90447. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90448. */
  90449. static readonly OnPointerOverTrigger: number;
  90450. /**
  90451. * On pointer out
  90452. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90453. */
  90454. static readonly OnPointerOutTrigger: number;
  90455. /**
  90456. * On every frame
  90457. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90458. */
  90459. static readonly OnEveryFrameTrigger: number;
  90460. /**
  90461. * On intersection enter
  90462. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90463. */
  90464. static readonly OnIntersectionEnterTrigger: number;
  90465. /**
  90466. * On intersection exit
  90467. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90468. */
  90469. static readonly OnIntersectionExitTrigger: number;
  90470. /**
  90471. * On key down
  90472. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90473. */
  90474. static readonly OnKeyDownTrigger: number;
  90475. /**
  90476. * On key up
  90477. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  90478. */
  90479. static readonly OnKeyUpTrigger: number;
  90480. private _scene;
  90481. /**
  90482. * Creates a new action manager
  90483. * @param scene defines the hosting scene
  90484. */
  90485. constructor(scene: Scene);
  90486. /**
  90487. * Releases all associated resources
  90488. */
  90489. dispose(): void;
  90490. /**
  90491. * Gets hosting scene
  90492. * @returns the hosting scene
  90493. */
  90494. getScene(): Scene;
  90495. /**
  90496. * Does this action manager handles actions of any of the given triggers
  90497. * @param triggers defines the triggers to be tested
  90498. * @return a boolean indicating whether one (or more) of the triggers is handled
  90499. */
  90500. hasSpecificTriggers(triggers: number[]): boolean;
  90501. /**
  90502. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  90503. * speed.
  90504. * @param triggerA defines the trigger to be tested
  90505. * @param triggerB defines the trigger to be tested
  90506. * @return a boolean indicating whether one (or more) of the triggers is handled
  90507. */
  90508. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  90509. /**
  90510. * Does this action manager handles actions of a given trigger
  90511. * @param trigger defines the trigger to be tested
  90512. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  90513. * @return whether the trigger is handled
  90514. */
  90515. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  90516. /**
  90517. * Does this action manager has pointer triggers
  90518. */
  90519. get hasPointerTriggers(): boolean;
  90520. /**
  90521. * Does this action manager has pick triggers
  90522. */
  90523. get hasPickTriggers(): boolean;
  90524. /**
  90525. * Registers an action to this action manager
  90526. * @param action defines the action to be registered
  90527. * @return the action amended (prepared) after registration
  90528. */
  90529. registerAction(action: IAction): Nullable<IAction>;
  90530. /**
  90531. * Unregisters an action to this action manager
  90532. * @param action defines the action to be unregistered
  90533. * @return a boolean indicating whether the action has been unregistered
  90534. */
  90535. unregisterAction(action: IAction): Boolean;
  90536. /**
  90537. * Process a specific trigger
  90538. * @param trigger defines the trigger to process
  90539. * @param evt defines the event details to be processed
  90540. */
  90541. processTrigger(trigger: number, evt?: IActionEvent): void;
  90542. /** @hidden */
  90543. _getEffectiveTarget(target: any, propertyPath: string): any;
  90544. /** @hidden */
  90545. _getProperty(propertyPath: string): string;
  90546. /**
  90547. * Serialize this manager to a JSON object
  90548. * @param name defines the property name to store this manager
  90549. * @returns a JSON representation of this manager
  90550. */
  90551. serialize(name: string): any;
  90552. /**
  90553. * Creates a new ActionManager from a JSON data
  90554. * @param parsedActions defines the JSON data to read from
  90555. * @param object defines the hosting mesh
  90556. * @param scene defines the hosting scene
  90557. */
  90558. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  90559. /**
  90560. * Get a trigger name by index
  90561. * @param trigger defines the trigger index
  90562. * @returns a trigger name
  90563. */
  90564. static GetTriggerName(trigger: number): string;
  90565. }
  90566. }
  90567. declare module BABYLON {
  90568. /**
  90569. * Class used to represent a sprite
  90570. * @see https://doc.babylonjs.com/babylon101/sprites
  90571. */
  90572. export class Sprite implements IAnimatable {
  90573. /** defines the name */
  90574. name: string;
  90575. /** Gets or sets the current world position */
  90576. position: Vector3;
  90577. /** Gets or sets the main color */
  90578. color: Color4;
  90579. /** Gets or sets the width */
  90580. width: number;
  90581. /** Gets or sets the height */
  90582. height: number;
  90583. /** Gets or sets rotation angle */
  90584. angle: number;
  90585. /** Gets or sets the cell index in the sprite sheet */
  90586. cellIndex: number;
  90587. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  90588. cellRef: string;
  90589. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  90590. invertU: boolean;
  90591. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  90592. invertV: boolean;
  90593. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  90594. disposeWhenFinishedAnimating: boolean;
  90595. /** Gets the list of attached animations */
  90596. animations: Nullable<Array<Animation>>;
  90597. /** Gets or sets a boolean indicating if the sprite can be picked */
  90598. isPickable: boolean;
  90599. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  90600. useAlphaForPicking: boolean;
  90601. /** @hidden */
  90602. _xOffset: number;
  90603. /** @hidden */
  90604. _yOffset: number;
  90605. /** @hidden */
  90606. _xSize: number;
  90607. /** @hidden */
  90608. _ySize: number;
  90609. /**
  90610. * Gets or sets the associated action manager
  90611. */
  90612. actionManager: Nullable<ActionManager>;
  90613. /**
  90614. * An event triggered when the control has been disposed
  90615. */
  90616. onDisposeObservable: Observable<Sprite>;
  90617. private _animationStarted;
  90618. private _loopAnimation;
  90619. private _fromIndex;
  90620. private _toIndex;
  90621. private _delay;
  90622. private _direction;
  90623. private _manager;
  90624. private _time;
  90625. private _onAnimationEnd;
  90626. /**
  90627. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  90628. */
  90629. isVisible: boolean;
  90630. /**
  90631. * Gets or sets the sprite size
  90632. */
  90633. get size(): number;
  90634. set size(value: number);
  90635. /**
  90636. * Returns a boolean indicating if the animation is started
  90637. */
  90638. get animationStarted(): boolean;
  90639. /**
  90640. * Gets or sets the unique id of the sprite
  90641. */
  90642. uniqueId: number;
  90643. /**
  90644. * Gets the manager of this sprite
  90645. */
  90646. get manager(): ISpriteManager;
  90647. /**
  90648. * Creates a new Sprite
  90649. * @param name defines the name
  90650. * @param manager defines the manager
  90651. */
  90652. constructor(
  90653. /** defines the name */
  90654. name: string, manager: ISpriteManager);
  90655. /**
  90656. * Returns the string "Sprite"
  90657. * @returns "Sprite"
  90658. */
  90659. getClassName(): string;
  90660. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  90661. get fromIndex(): number;
  90662. set fromIndex(value: number);
  90663. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  90664. get toIndex(): number;
  90665. set toIndex(value: number);
  90666. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  90667. get loopAnimation(): boolean;
  90668. set loopAnimation(value: boolean);
  90669. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  90670. get delay(): number;
  90671. set delay(value: number);
  90672. /**
  90673. * Starts an animation
  90674. * @param from defines the initial key
  90675. * @param to defines the end key
  90676. * @param loop defines if the animation must loop
  90677. * @param delay defines the start delay (in ms)
  90678. * @param onAnimationEnd defines a callback to call when animation ends
  90679. */
  90680. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  90681. /** Stops current animation (if any) */
  90682. stopAnimation(): void;
  90683. /** @hidden */
  90684. _animate(deltaTime: number): void;
  90685. /** Release associated resources */
  90686. dispose(): void;
  90687. /**
  90688. * Serializes the sprite to a JSON object
  90689. * @returns the JSON object
  90690. */
  90691. serialize(): any;
  90692. /**
  90693. * Parses a JSON object to create a new sprite
  90694. * @param parsedSprite The JSON object to parse
  90695. * @param manager defines the hosting manager
  90696. * @returns the new sprite
  90697. */
  90698. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  90699. }
  90700. }
  90701. declare module BABYLON {
  90702. /**
  90703. * Information about the result of picking within a scene
  90704. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  90705. */
  90706. export class PickingInfo {
  90707. /** @hidden */
  90708. _pickingUnavailable: boolean;
  90709. /**
  90710. * If the pick collided with an object
  90711. */
  90712. hit: boolean;
  90713. /**
  90714. * Distance away where the pick collided
  90715. */
  90716. distance: number;
  90717. /**
  90718. * The location of pick collision
  90719. */
  90720. pickedPoint: Nullable<Vector3>;
  90721. /**
  90722. * The mesh corresponding the the pick collision
  90723. */
  90724. pickedMesh: Nullable<AbstractMesh>;
  90725. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  90726. bu: number;
  90727. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  90728. bv: number;
  90729. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  90730. faceId: number;
  90731. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  90732. subMeshFaceId: number;
  90733. /** Id of the the submesh that was picked */
  90734. subMeshId: number;
  90735. /** If a sprite was picked, this will be the sprite the pick collided with */
  90736. pickedSprite: Nullable<Sprite>;
  90737. /** If we are pikcing a mesh with thin instance, this will give you the picked thin instance */
  90738. thinInstanceIndex: number;
  90739. /**
  90740. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  90741. */
  90742. originMesh: Nullable<AbstractMesh>;
  90743. /**
  90744. * The ray that was used to perform the picking.
  90745. */
  90746. ray: Nullable<Ray>;
  90747. /**
  90748. * Gets the normal correspodning to the face the pick collided with
  90749. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  90750. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  90751. * @returns The normal correspodning to the face the pick collided with
  90752. */
  90753. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  90754. /**
  90755. * Gets the texture coordinates of where the pick occured
  90756. * @returns the vector containing the coordnates of the texture
  90757. */
  90758. getTextureCoordinates(): Nullable<Vector2>;
  90759. }
  90760. }
  90761. declare module BABYLON {
  90762. /**
  90763. * Class representing a ray with position and direction
  90764. */
  90765. export class Ray {
  90766. /** origin point */
  90767. origin: Vector3;
  90768. /** direction */
  90769. direction: Vector3;
  90770. /** length of the ray */
  90771. length: number;
  90772. private static readonly _TmpVector3;
  90773. private _tmpRay;
  90774. /**
  90775. * Creates a new ray
  90776. * @param origin origin point
  90777. * @param direction direction
  90778. * @param length length of the ray
  90779. */
  90780. constructor(
  90781. /** origin point */
  90782. origin: Vector3,
  90783. /** direction */
  90784. direction: Vector3,
  90785. /** length of the ray */
  90786. length?: number);
  90787. /**
  90788. * Checks if the ray intersects a box
  90789. * This does not account for the ray lenght by design to improve perfs.
  90790. * @param minimum bound of the box
  90791. * @param maximum bound of the box
  90792. * @param intersectionTreshold extra extend to be added to the box in all direction
  90793. * @returns if the box was hit
  90794. */
  90795. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  90796. /**
  90797. * Checks if the ray intersects a box
  90798. * This does not account for the ray lenght by design to improve perfs.
  90799. * @param box the bounding box to check
  90800. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  90801. * @returns if the box was hit
  90802. */
  90803. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  90804. /**
  90805. * If the ray hits a sphere
  90806. * @param sphere the bounding sphere to check
  90807. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  90808. * @returns true if it hits the sphere
  90809. */
  90810. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  90811. /**
  90812. * If the ray hits a triange
  90813. * @param vertex0 triangle vertex
  90814. * @param vertex1 triangle vertex
  90815. * @param vertex2 triangle vertex
  90816. * @returns intersection information if hit
  90817. */
  90818. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  90819. /**
  90820. * Checks if ray intersects a plane
  90821. * @param plane the plane to check
  90822. * @returns the distance away it was hit
  90823. */
  90824. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  90825. /**
  90826. * Calculate the intercept of a ray on a given axis
  90827. * @param axis to check 'x' | 'y' | 'z'
  90828. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  90829. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  90830. */
  90831. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  90832. /**
  90833. * Checks if ray intersects a mesh
  90834. * @param mesh the mesh to check
  90835. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90836. * @returns picking info of the intersecton
  90837. */
  90838. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  90839. /**
  90840. * Checks if ray intersects a mesh
  90841. * @param meshes the meshes to check
  90842. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90843. * @param results array to store result in
  90844. * @returns Array of picking infos
  90845. */
  90846. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  90847. private _comparePickingInfo;
  90848. private static smallnum;
  90849. private static rayl;
  90850. /**
  90851. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  90852. * @param sega the first point of the segment to test the intersection against
  90853. * @param segb the second point of the segment to test the intersection against
  90854. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  90855. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  90856. */
  90857. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  90858. /**
  90859. * Update the ray from viewport position
  90860. * @param x position
  90861. * @param y y position
  90862. * @param viewportWidth viewport width
  90863. * @param viewportHeight viewport height
  90864. * @param world world matrix
  90865. * @param view view matrix
  90866. * @param projection projection matrix
  90867. * @returns this ray updated
  90868. */
  90869. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  90870. /**
  90871. * Creates a ray with origin and direction of 0,0,0
  90872. * @returns the new ray
  90873. */
  90874. static Zero(): Ray;
  90875. /**
  90876. * Creates a new ray from screen space and viewport
  90877. * @param x position
  90878. * @param y y position
  90879. * @param viewportWidth viewport width
  90880. * @param viewportHeight viewport height
  90881. * @param world world matrix
  90882. * @param view view matrix
  90883. * @param projection projection matrix
  90884. * @returns new ray
  90885. */
  90886. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  90887. /**
  90888. * 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
  90889. * transformed to the given world matrix.
  90890. * @param origin The origin point
  90891. * @param end The end point
  90892. * @param world a matrix to transform the ray to. Default is the identity matrix.
  90893. * @returns the new ray
  90894. */
  90895. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  90896. /**
  90897. * Transforms a ray by a matrix
  90898. * @param ray ray to transform
  90899. * @param matrix matrix to apply
  90900. * @returns the resulting new ray
  90901. */
  90902. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  90903. /**
  90904. * Transforms a ray by a matrix
  90905. * @param ray ray to transform
  90906. * @param matrix matrix to apply
  90907. * @param result ray to store result in
  90908. */
  90909. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  90910. /**
  90911. * Unproject a ray from screen space to object space
  90912. * @param sourceX defines the screen space x coordinate to use
  90913. * @param sourceY defines the screen space y coordinate to use
  90914. * @param viewportWidth defines the current width of the viewport
  90915. * @param viewportHeight defines the current height of the viewport
  90916. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  90917. * @param view defines the view matrix to use
  90918. * @param projection defines the projection matrix to use
  90919. */
  90920. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  90921. }
  90922. /**
  90923. * Type used to define predicate used to select faces when a mesh intersection is detected
  90924. */
  90925. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  90926. interface Scene {
  90927. /** @hidden */
  90928. _tempPickingRay: Nullable<Ray>;
  90929. /** @hidden */
  90930. _cachedRayForTransform: Ray;
  90931. /** @hidden */
  90932. _pickWithRayInverseMatrix: Matrix;
  90933. /** @hidden */
  90934. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  90935. /** @hidden */
  90936. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  90937. /** @hidden */
  90938. _internalPickForMesh(pickingInfo: Nullable<PickingInfo>, rayFunction: (world: Matrix) => Ray, mesh: AbstractMesh, world: Matrix, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  90939. }
  90940. }
  90941. declare module BABYLON {
  90942. /**
  90943. * Groups all the scene component constants in one place to ease maintenance.
  90944. * @hidden
  90945. */
  90946. export class SceneComponentConstants {
  90947. static readonly NAME_EFFECTLAYER: string;
  90948. static readonly NAME_LAYER: string;
  90949. static readonly NAME_LENSFLARESYSTEM: string;
  90950. static readonly NAME_BOUNDINGBOXRENDERER: string;
  90951. static readonly NAME_PARTICLESYSTEM: string;
  90952. static readonly NAME_GAMEPAD: string;
  90953. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  90954. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  90955. static readonly NAME_PREPASSRENDERER: string;
  90956. static readonly NAME_DEPTHRENDERER: string;
  90957. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  90958. static readonly NAME_SPRITE: string;
  90959. static readonly NAME_SUBSURFACE: string;
  90960. static readonly NAME_OUTLINERENDERER: string;
  90961. static readonly NAME_PROCEDURALTEXTURE: string;
  90962. static readonly NAME_SHADOWGENERATOR: string;
  90963. static readonly NAME_OCTREE: string;
  90964. static readonly NAME_PHYSICSENGINE: string;
  90965. static readonly NAME_AUDIO: string;
  90966. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  90967. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  90968. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  90969. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  90970. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  90971. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  90972. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  90973. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  90974. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  90975. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  90976. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  90977. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  90978. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  90979. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  90980. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  90981. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  90982. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  90983. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  90984. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  90985. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  90986. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  90987. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  90988. static readonly STEP_AFTERRENDER_AUDIO: number;
  90989. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  90990. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  90991. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  90992. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  90993. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  90994. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  90995. static readonly STEP_POINTERMOVE_SPRITE: number;
  90996. static readonly STEP_POINTERDOWN_SPRITE: number;
  90997. static readonly STEP_POINTERUP_SPRITE: number;
  90998. }
  90999. /**
  91000. * This represents a scene component.
  91001. *
  91002. * This is used to decouple the dependency the scene is having on the different workloads like
  91003. * layers, post processes...
  91004. */
  91005. export interface ISceneComponent {
  91006. /**
  91007. * The name of the component. Each component must have a unique name.
  91008. */
  91009. name: string;
  91010. /**
  91011. * The scene the component belongs to.
  91012. */
  91013. scene: Scene;
  91014. /**
  91015. * Register the component to one instance of a scene.
  91016. */
  91017. register(): void;
  91018. /**
  91019. * Rebuilds the elements related to this component in case of
  91020. * context lost for instance.
  91021. */
  91022. rebuild(): void;
  91023. /**
  91024. * Disposes the component and the associated ressources.
  91025. */
  91026. dispose(): void;
  91027. }
  91028. /**
  91029. * This represents a SERIALIZABLE scene component.
  91030. *
  91031. * This extends Scene Component to add Serialization methods on top.
  91032. */
  91033. export interface ISceneSerializableComponent extends ISceneComponent {
  91034. /**
  91035. * Adds all the elements from the container to the scene
  91036. * @param container the container holding the elements
  91037. */
  91038. addFromContainer(container: AbstractScene): void;
  91039. /**
  91040. * Removes all the elements in the container from the scene
  91041. * @param container contains the elements to remove
  91042. * @param dispose if the removed element should be disposed (default: false)
  91043. */
  91044. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  91045. /**
  91046. * Serializes the component data to the specified json object
  91047. * @param serializationObject The object to serialize to
  91048. */
  91049. serialize(serializationObject: any): void;
  91050. }
  91051. /**
  91052. * Strong typing of a Mesh related stage step action
  91053. */
  91054. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  91055. /**
  91056. * Strong typing of a Evaluate Sub Mesh related stage step action
  91057. */
  91058. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  91059. /**
  91060. * Strong typing of a Active Mesh related stage step action
  91061. */
  91062. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  91063. /**
  91064. * Strong typing of a Camera related stage step action
  91065. */
  91066. export type CameraStageAction = (camera: Camera) => void;
  91067. /**
  91068. * Strong typing of a Camera Frame buffer related stage step action
  91069. */
  91070. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  91071. /**
  91072. * Strong typing of a Render Target related stage step action
  91073. */
  91074. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  91075. /**
  91076. * Strong typing of a RenderingGroup related stage step action
  91077. */
  91078. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  91079. /**
  91080. * Strong typing of a Mesh Render related stage step action
  91081. */
  91082. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  91083. /**
  91084. * Strong typing of a simple stage step action
  91085. */
  91086. export type SimpleStageAction = () => void;
  91087. /**
  91088. * Strong typing of a render target action.
  91089. */
  91090. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  91091. /**
  91092. * Strong typing of a pointer move action.
  91093. */
  91094. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  91095. /**
  91096. * Strong typing of a pointer up/down action.
  91097. */
  91098. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  91099. /**
  91100. * Representation of a stage in the scene (Basically a list of ordered steps)
  91101. * @hidden
  91102. */
  91103. export class Stage<T extends Function> extends Array<{
  91104. index: number;
  91105. component: ISceneComponent;
  91106. action: T;
  91107. }> {
  91108. /**
  91109. * Hide ctor from the rest of the world.
  91110. * @param items The items to add.
  91111. */
  91112. private constructor();
  91113. /**
  91114. * Creates a new Stage.
  91115. * @returns A new instance of a Stage
  91116. */
  91117. static Create<T extends Function>(): Stage<T>;
  91118. /**
  91119. * Registers a step in an ordered way in the targeted stage.
  91120. * @param index Defines the position to register the step in
  91121. * @param component Defines the component attached to the step
  91122. * @param action Defines the action to launch during the step
  91123. */
  91124. registerStep(index: number, component: ISceneComponent, action: T): void;
  91125. /**
  91126. * Clears all the steps from the stage.
  91127. */
  91128. clear(): void;
  91129. }
  91130. }
  91131. declare module BABYLON {
  91132. interface Scene {
  91133. /** @hidden */
  91134. _pointerOverSprite: Nullable<Sprite>;
  91135. /** @hidden */
  91136. _pickedDownSprite: Nullable<Sprite>;
  91137. /** @hidden */
  91138. _tempSpritePickingRay: Nullable<Ray>;
  91139. /**
  91140. * All of the sprite managers added to this scene
  91141. * @see https://doc.babylonjs.com/babylon101/sprites
  91142. */
  91143. spriteManagers: Array<ISpriteManager>;
  91144. /**
  91145. * An event triggered when sprites rendering is about to start
  91146. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  91147. */
  91148. onBeforeSpritesRenderingObservable: Observable<Scene>;
  91149. /**
  91150. * An event triggered when sprites rendering is done
  91151. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  91152. */
  91153. onAfterSpritesRenderingObservable: Observable<Scene>;
  91154. /** @hidden */
  91155. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  91156. /** Launch a ray to try to pick a sprite in the scene
  91157. * @param x position on screen
  91158. * @param y position on screen
  91159. * @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
  91160. * @param fastCheck defines if the first intersection will be used (and not the closest)
  91161. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  91162. * @returns a PickingInfo
  91163. */
  91164. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  91165. /** Use the given ray to pick a sprite in the scene
  91166. * @param ray The ray (in world space) to use to pick meshes
  91167. * @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
  91168. * @param fastCheck defines if the first intersection will be used (and not the closest)
  91169. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  91170. * @returns a PickingInfo
  91171. */
  91172. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  91173. /** @hidden */
  91174. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  91175. /** Launch a ray to try to pick sprites in the scene
  91176. * @param x position on screen
  91177. * @param y position on screen
  91178. * @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
  91179. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  91180. * @returns a PickingInfo array
  91181. */
  91182. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  91183. /** Use the given ray to pick sprites in the scene
  91184. * @param ray The ray (in world space) to use to pick meshes
  91185. * @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
  91186. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  91187. * @returns a PickingInfo array
  91188. */
  91189. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  91190. /**
  91191. * Force the sprite under the pointer
  91192. * @param sprite defines the sprite to use
  91193. */
  91194. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  91195. /**
  91196. * Gets the sprite under the pointer
  91197. * @returns a Sprite or null if no sprite is under the pointer
  91198. */
  91199. getPointerOverSprite(): Nullable<Sprite>;
  91200. }
  91201. /**
  91202. * Defines the sprite scene component responsible to manage sprites
  91203. * in a given scene.
  91204. */
  91205. export class SpriteSceneComponent implements ISceneComponent {
  91206. /**
  91207. * The component name helpfull to identify the component in the list of scene components.
  91208. */
  91209. readonly name: string;
  91210. /**
  91211. * The scene the component belongs to.
  91212. */
  91213. scene: Scene;
  91214. /** @hidden */
  91215. private _spritePredicate;
  91216. /**
  91217. * Creates a new instance of the component for the given scene
  91218. * @param scene Defines the scene to register the component in
  91219. */
  91220. constructor(scene: Scene);
  91221. /**
  91222. * Registers the component in a given scene
  91223. */
  91224. register(): void;
  91225. /**
  91226. * Rebuilds the elements related to this component in case of
  91227. * context lost for instance.
  91228. */
  91229. rebuild(): void;
  91230. /**
  91231. * Disposes the component and the associated ressources.
  91232. */
  91233. dispose(): void;
  91234. private _pickSpriteButKeepRay;
  91235. private _pointerMove;
  91236. private _pointerDown;
  91237. private _pointerUp;
  91238. }
  91239. }
  91240. declare module BABYLON {
  91241. /** @hidden */
  91242. export var fogFragmentDeclaration: {
  91243. name: string;
  91244. shader: string;
  91245. };
  91246. }
  91247. declare module BABYLON {
  91248. /** @hidden */
  91249. export var fogFragment: {
  91250. name: string;
  91251. shader: string;
  91252. };
  91253. }
  91254. declare module BABYLON {
  91255. /** @hidden */
  91256. export var spritesPixelShader: {
  91257. name: string;
  91258. shader: string;
  91259. };
  91260. }
  91261. declare module BABYLON {
  91262. /** @hidden */
  91263. export var fogVertexDeclaration: {
  91264. name: string;
  91265. shader: string;
  91266. };
  91267. }
  91268. declare module BABYLON {
  91269. /** @hidden */
  91270. export var spritesVertexShader: {
  91271. name: string;
  91272. shader: string;
  91273. };
  91274. }
  91275. declare module BABYLON {
  91276. /**
  91277. * Defines the minimum interface to fullfil in order to be a sprite manager.
  91278. */
  91279. export interface ISpriteManager extends IDisposable {
  91280. /**
  91281. * Gets manager's name
  91282. */
  91283. name: string;
  91284. /**
  91285. * Restricts the camera to viewing objects with the same layerMask.
  91286. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  91287. */
  91288. layerMask: number;
  91289. /**
  91290. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  91291. */
  91292. isPickable: boolean;
  91293. /**
  91294. * Gets the hosting scene
  91295. */
  91296. scene: Scene;
  91297. /**
  91298. * Specifies the rendering group id for this mesh (0 by default)
  91299. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  91300. */
  91301. renderingGroupId: number;
  91302. /**
  91303. * Defines the list of sprites managed by the manager.
  91304. */
  91305. sprites: Array<Sprite>;
  91306. /**
  91307. * Gets or sets the spritesheet texture
  91308. */
  91309. texture: Texture;
  91310. /** Defines the default width of a cell in the spritesheet */
  91311. cellWidth: number;
  91312. /** Defines the default height of a cell in the spritesheet */
  91313. cellHeight: number;
  91314. /**
  91315. * Tests the intersection of a sprite with a specific ray.
  91316. * @param ray The ray we are sending to test the collision
  91317. * @param camera The camera space we are sending rays in
  91318. * @param predicate A predicate allowing excluding sprites from the list of object to test
  91319. * @param fastCheck defines if the first intersection will be used (and not the closest)
  91320. * @returns picking info or null.
  91321. */
  91322. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  91323. /**
  91324. * Intersects the sprites with a ray
  91325. * @param ray defines the ray to intersect with
  91326. * @param camera defines the current active camera
  91327. * @param predicate defines a predicate used to select candidate sprites
  91328. * @returns null if no hit or a PickingInfo array
  91329. */
  91330. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  91331. /**
  91332. * Renders the list of sprites on screen.
  91333. */
  91334. render(): void;
  91335. }
  91336. /**
  91337. * Class used to manage multiple sprites on the same spritesheet
  91338. * @see https://doc.babylonjs.com/babylon101/sprites
  91339. */
  91340. export class SpriteManager implements ISpriteManager {
  91341. /** defines the manager's name */
  91342. name: string;
  91343. /** Define the Url to load snippets */
  91344. static SnippetUrl: string;
  91345. /** Snippet ID if the manager was created from the snippet server */
  91346. snippetId: string;
  91347. /** Gets the list of sprites */
  91348. sprites: Sprite[];
  91349. /** Gets or sets the rendering group id (0 by default) */
  91350. renderingGroupId: number;
  91351. /** Gets or sets camera layer mask */
  91352. layerMask: number;
  91353. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  91354. fogEnabled: boolean;
  91355. /** Gets or sets a boolean indicating if the sprites are pickable */
  91356. isPickable: boolean;
  91357. /** Defines the default width of a cell in the spritesheet */
  91358. cellWidth: number;
  91359. /** Defines the default height of a cell in the spritesheet */
  91360. cellHeight: number;
  91361. /** Associative array from JSON sprite data file */
  91362. private _cellData;
  91363. /** Array of sprite names from JSON sprite data file */
  91364. private _spriteMap;
  91365. /** True when packed cell data from JSON file is ready*/
  91366. private _packedAndReady;
  91367. private _textureContent;
  91368. private _useInstancing;
  91369. /**
  91370. * An event triggered when the manager is disposed.
  91371. */
  91372. onDisposeObservable: Observable<SpriteManager>;
  91373. private _onDisposeObserver;
  91374. /**
  91375. * Callback called when the manager is disposed
  91376. */
  91377. set onDispose(callback: () => void);
  91378. private _capacity;
  91379. private _fromPacked;
  91380. private _spriteTexture;
  91381. private _epsilon;
  91382. private _scene;
  91383. private _vertexData;
  91384. private _buffer;
  91385. private _vertexBuffers;
  91386. private _spriteBuffer;
  91387. private _indexBuffer;
  91388. private _effectBase;
  91389. private _effectFog;
  91390. private _vertexBufferSize;
  91391. /**
  91392. * Gets or sets the unique id of the sprite
  91393. */
  91394. uniqueId: number;
  91395. /**
  91396. * Gets the array of sprites
  91397. */
  91398. get children(): Sprite[];
  91399. /**
  91400. * Gets the hosting scene
  91401. */
  91402. get scene(): Scene;
  91403. /**
  91404. * Gets the capacity of the manager
  91405. */
  91406. get capacity(): number;
  91407. /**
  91408. * Gets or sets the spritesheet texture
  91409. */
  91410. get texture(): Texture;
  91411. set texture(value: Texture);
  91412. private _blendMode;
  91413. /**
  91414. * Blend mode use to render the particle, it can be any of
  91415. * the static Constants.ALPHA_x properties provided in this class.
  91416. * Default value is Constants.ALPHA_COMBINE
  91417. */
  91418. get blendMode(): number;
  91419. set blendMode(blendMode: number);
  91420. /** Disables writing to the depth buffer when rendering the sprites.
  91421. * It can be handy to disable depth writing when using textures without alpha channel
  91422. * and setting some specific blend modes.
  91423. */
  91424. disableDepthWrite: boolean;
  91425. /**
  91426. * Creates a new sprite manager
  91427. * @param name defines the manager's name
  91428. * @param imgUrl defines the sprite sheet url
  91429. * @param capacity defines the maximum allowed number of sprites
  91430. * @param cellSize defines the size of a sprite cell
  91431. * @param scene defines the hosting scene
  91432. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  91433. * @param samplingMode defines the smapling mode to use with spritesheet
  91434. * @param fromPacked set to false; do not alter
  91435. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  91436. */
  91437. constructor(
  91438. /** defines the manager's name */
  91439. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  91440. /**
  91441. * Returns the string "SpriteManager"
  91442. * @returns "SpriteManager"
  91443. */
  91444. getClassName(): string;
  91445. private _makePacked;
  91446. private _appendSpriteVertex;
  91447. private _checkTextureAlpha;
  91448. /**
  91449. * Intersects the sprites with a ray
  91450. * @param ray defines the ray to intersect with
  91451. * @param camera defines the current active camera
  91452. * @param predicate defines a predicate used to select candidate sprites
  91453. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  91454. * @returns null if no hit or a PickingInfo
  91455. */
  91456. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  91457. /**
  91458. * Intersects the sprites with a ray
  91459. * @param ray defines the ray to intersect with
  91460. * @param camera defines the current active camera
  91461. * @param predicate defines a predicate used to select candidate sprites
  91462. * @returns null if no hit or a PickingInfo array
  91463. */
  91464. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  91465. /**
  91466. * Render all child sprites
  91467. */
  91468. render(): void;
  91469. /**
  91470. * Release associated resources
  91471. */
  91472. dispose(): void;
  91473. /**
  91474. * Serializes the sprite manager to a JSON object
  91475. * @param serializeTexture defines if the texture must be serialized as well
  91476. * @returns the JSON object
  91477. */
  91478. serialize(serializeTexture?: boolean): any;
  91479. /**
  91480. * Parses a JSON object to create a new sprite manager.
  91481. * @param parsedManager The JSON object to parse
  91482. * @param scene The scene to create the sprite managerin
  91483. * @param rootUrl The root url to use to load external dependencies like texture
  91484. * @returns the new sprite manager
  91485. */
  91486. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  91487. /**
  91488. * Creates a sprite manager from a snippet saved in a remote file
  91489. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  91490. * @param url defines the url to load from
  91491. * @param scene defines the hosting scene
  91492. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  91493. * @returns a promise that will resolve to the new sprite manager
  91494. */
  91495. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  91496. /**
  91497. * Creates a sprite manager from a snippet saved by the sprite editor
  91498. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  91499. * @param scene defines the hosting scene
  91500. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  91501. * @returns a promise that will resolve to the new sprite manager
  91502. */
  91503. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  91504. }
  91505. }
  91506. declare module BABYLON {
  91507. /** Interface used by value gradients (color, factor, ...) */
  91508. export interface IValueGradient {
  91509. /**
  91510. * Gets or sets the gradient value (between 0 and 1)
  91511. */
  91512. gradient: number;
  91513. }
  91514. /** Class used to store color4 gradient */
  91515. export class ColorGradient implements IValueGradient {
  91516. /**
  91517. * Gets or sets the gradient value (between 0 and 1)
  91518. */
  91519. gradient: number;
  91520. /**
  91521. * Gets or sets first associated color
  91522. */
  91523. color1: Color4;
  91524. /**
  91525. * Gets or sets second associated color
  91526. */
  91527. color2?: Color4 | undefined;
  91528. /**
  91529. * Creates a new color4 gradient
  91530. * @param gradient gets or sets the gradient value (between 0 and 1)
  91531. * @param color1 gets or sets first associated color
  91532. * @param color2 gets or sets first second color
  91533. */
  91534. constructor(
  91535. /**
  91536. * Gets or sets the gradient value (between 0 and 1)
  91537. */
  91538. gradient: number,
  91539. /**
  91540. * Gets or sets first associated color
  91541. */
  91542. color1: Color4,
  91543. /**
  91544. * Gets or sets second associated color
  91545. */
  91546. color2?: Color4 | undefined);
  91547. /**
  91548. * Will get a color picked randomly between color1 and color2.
  91549. * If color2 is undefined then color1 will be used
  91550. * @param result defines the target Color4 to store the result in
  91551. */
  91552. getColorToRef(result: Color4): void;
  91553. }
  91554. /** Class used to store color 3 gradient */
  91555. export class Color3Gradient implements IValueGradient {
  91556. /**
  91557. * Gets or sets the gradient value (between 0 and 1)
  91558. */
  91559. gradient: number;
  91560. /**
  91561. * Gets or sets the associated color
  91562. */
  91563. color: Color3;
  91564. /**
  91565. * Creates a new color3 gradient
  91566. * @param gradient gets or sets the gradient value (between 0 and 1)
  91567. * @param color gets or sets associated color
  91568. */
  91569. constructor(
  91570. /**
  91571. * Gets or sets the gradient value (between 0 and 1)
  91572. */
  91573. gradient: number,
  91574. /**
  91575. * Gets or sets the associated color
  91576. */
  91577. color: Color3);
  91578. }
  91579. /** Class used to store factor gradient */
  91580. export class FactorGradient implements IValueGradient {
  91581. /**
  91582. * Gets or sets the gradient value (between 0 and 1)
  91583. */
  91584. gradient: number;
  91585. /**
  91586. * Gets or sets first associated factor
  91587. */
  91588. factor1: number;
  91589. /**
  91590. * Gets or sets second associated factor
  91591. */
  91592. factor2?: number | undefined;
  91593. /**
  91594. * Creates a new factor gradient
  91595. * @param gradient gets or sets the gradient value (between 0 and 1)
  91596. * @param factor1 gets or sets first associated factor
  91597. * @param factor2 gets or sets second associated factor
  91598. */
  91599. constructor(
  91600. /**
  91601. * Gets or sets the gradient value (between 0 and 1)
  91602. */
  91603. gradient: number,
  91604. /**
  91605. * Gets or sets first associated factor
  91606. */
  91607. factor1: number,
  91608. /**
  91609. * Gets or sets second associated factor
  91610. */
  91611. factor2?: number | undefined);
  91612. /**
  91613. * Will get a number picked randomly between factor1 and factor2.
  91614. * If factor2 is undefined then factor1 will be used
  91615. * @returns the picked number
  91616. */
  91617. getFactor(): number;
  91618. }
  91619. /**
  91620. * Helper used to simplify some generic gradient tasks
  91621. */
  91622. export class GradientHelper {
  91623. /**
  91624. * Gets the current gradient from an array of IValueGradient
  91625. * @param ratio defines the current ratio to get
  91626. * @param gradients defines the array of IValueGradient
  91627. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  91628. */
  91629. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  91630. }
  91631. }
  91632. declare module BABYLON {
  91633. interface ThinEngine {
  91634. /**
  91635. * Creates a raw texture
  91636. * @param data defines the data to store in the texture
  91637. * @param width defines the width of the texture
  91638. * @param height defines the height of the texture
  91639. * @param format defines the format of the data
  91640. * @param generateMipMaps defines if the engine should generate the mip levels
  91641. * @param invertY defines if data must be stored with Y axis inverted
  91642. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  91643. * @param compression defines the compression used (null by default)
  91644. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91645. * @returns the raw texture inside an InternalTexture
  91646. */
  91647. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  91648. /**
  91649. * Update a raw texture
  91650. * @param texture defines the texture to update
  91651. * @param data defines the data to store in the texture
  91652. * @param format defines the format of the data
  91653. * @param invertY defines if data must be stored with Y axis inverted
  91654. */
  91655. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  91656. /**
  91657. * Update a raw texture
  91658. * @param texture defines the texture to update
  91659. * @param data defines the data to store in the texture
  91660. * @param format defines the format of the data
  91661. * @param invertY defines if data must be stored with Y axis inverted
  91662. * @param compression defines the compression used (null by default)
  91663. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91664. */
  91665. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  91666. /**
  91667. * Creates a new raw cube texture
  91668. * @param data defines the array of data to use to create each face
  91669. * @param size defines the size of the textures
  91670. * @param format defines the format of the data
  91671. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  91672. * @param generateMipMaps defines if the engine should generate the mip levels
  91673. * @param invertY defines if data must be stored with Y axis inverted
  91674. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91675. * @param compression defines the compression used (null by default)
  91676. * @returns the cube texture as an InternalTexture
  91677. */
  91678. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  91679. /**
  91680. * Update a raw cube texture
  91681. * @param texture defines the texture to udpdate
  91682. * @param data defines the data to store
  91683. * @param format defines the data format
  91684. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91685. * @param invertY defines if data must be stored with Y axis inverted
  91686. */
  91687. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  91688. /**
  91689. * Update a raw cube texture
  91690. * @param texture defines the texture to udpdate
  91691. * @param data defines the data to store
  91692. * @param format defines the data format
  91693. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91694. * @param invertY defines if data must be stored with Y axis inverted
  91695. * @param compression defines the compression used (null by default)
  91696. */
  91697. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  91698. /**
  91699. * Update a raw cube texture
  91700. * @param texture defines the texture to udpdate
  91701. * @param data defines the data to store
  91702. * @param format defines the data format
  91703. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  91704. * @param invertY defines if data must be stored with Y axis inverted
  91705. * @param compression defines the compression used (null by default)
  91706. * @param level defines which level of the texture to update
  91707. */
  91708. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  91709. /**
  91710. * Creates a new raw cube texture from a specified url
  91711. * @param url defines the url where the data is located
  91712. * @param scene defines the current scene
  91713. * @param size defines the size of the textures
  91714. * @param format defines the format of the data
  91715. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  91716. * @param noMipmap defines if the engine should avoid generating the mip levels
  91717. * @param callback defines a callback used to extract texture data from loaded data
  91718. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  91719. * @param onLoad defines a callback called when texture is loaded
  91720. * @param onError defines a callback called if there is an error
  91721. * @returns the cube texture as an InternalTexture
  91722. */
  91723. 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;
  91724. /**
  91725. * Creates a new raw cube texture from a specified url
  91726. * @param url defines the url where the data is located
  91727. * @param scene defines the current scene
  91728. * @param size defines the size of the textures
  91729. * @param format defines the format of the data
  91730. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  91731. * @param noMipmap defines if the engine should avoid generating the mip levels
  91732. * @param callback defines a callback used to extract texture data from loaded data
  91733. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  91734. * @param onLoad defines a callback called when texture is loaded
  91735. * @param onError defines a callback called if there is an error
  91736. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91737. * @param invertY defines if data must be stored with Y axis inverted
  91738. * @returns the cube texture as an InternalTexture
  91739. */
  91740. 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;
  91741. /**
  91742. * Creates a new raw 3D texture
  91743. * @param data defines the data used to create the texture
  91744. * @param width defines the width of the texture
  91745. * @param height defines the height of the texture
  91746. * @param depth defines the depth of the texture
  91747. * @param format defines the format of the texture
  91748. * @param generateMipMaps defines if the engine must generate mip levels
  91749. * @param invertY defines if data must be stored with Y axis inverted
  91750. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91751. * @param compression defines the compressed used (can be null)
  91752. * @param textureType defines the compressed used (can be null)
  91753. * @returns a new raw 3D texture (stored in an InternalTexture)
  91754. */
  91755. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  91756. /**
  91757. * Update a raw 3D texture
  91758. * @param texture defines the texture to update
  91759. * @param data defines the data to store
  91760. * @param format defines the data format
  91761. * @param invertY defines if data must be stored with Y axis inverted
  91762. */
  91763. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  91764. /**
  91765. * Update a raw 3D texture
  91766. * @param texture defines the texture to update
  91767. * @param data defines the data to store
  91768. * @param format defines the data format
  91769. * @param invertY defines if data must be stored with Y axis inverted
  91770. * @param compression defines the used compression (can be null)
  91771. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  91772. */
  91773. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  91774. /**
  91775. * Creates a new raw 2D array texture
  91776. * @param data defines the data used to create the texture
  91777. * @param width defines the width of the texture
  91778. * @param height defines the height of the texture
  91779. * @param depth defines the number of layers of the texture
  91780. * @param format defines the format of the texture
  91781. * @param generateMipMaps defines if the engine must generate mip levels
  91782. * @param invertY defines if data must be stored with Y axis inverted
  91783. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91784. * @param compression defines the compressed used (can be null)
  91785. * @param textureType defines the compressed used (can be null)
  91786. * @returns a new raw 2D array texture (stored in an InternalTexture)
  91787. */
  91788. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  91789. /**
  91790. * Update a raw 2D array texture
  91791. * @param texture defines the texture to update
  91792. * @param data defines the data to store
  91793. * @param format defines the data format
  91794. * @param invertY defines if data must be stored with Y axis inverted
  91795. */
  91796. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  91797. /**
  91798. * Update a raw 2D array texture
  91799. * @param texture defines the texture to update
  91800. * @param data defines the data to store
  91801. * @param format defines the data format
  91802. * @param invertY defines if data must be stored with Y axis inverted
  91803. * @param compression defines the used compression (can be null)
  91804. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  91805. */
  91806. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  91807. }
  91808. }
  91809. declare module BABYLON {
  91810. /**
  91811. * Raw texture can help creating a texture directly from an array of data.
  91812. * This can be super useful if you either get the data from an uncompressed source or
  91813. * if you wish to create your texture pixel by pixel.
  91814. */
  91815. export class RawTexture extends Texture {
  91816. /**
  91817. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91818. */
  91819. format: number;
  91820. /**
  91821. * Instantiates a new RawTexture.
  91822. * Raw texture can help creating a texture directly from an array of data.
  91823. * This can be super useful if you either get the data from an uncompressed source or
  91824. * if you wish to create your texture pixel by pixel.
  91825. * @param data define the array of data to use to create the texture
  91826. * @param width define the width of the texture
  91827. * @param height define the height of the texture
  91828. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91829. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91830. * @param generateMipMaps define whether mip maps should be generated or not
  91831. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91832. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91833. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91834. */
  91835. constructor(data: ArrayBufferView, width: number, height: number,
  91836. /**
  91837. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91838. */
  91839. format: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  91840. /**
  91841. * Updates the texture underlying data.
  91842. * @param data Define the new data of the texture
  91843. */
  91844. update(data: ArrayBufferView): void;
  91845. /**
  91846. * Creates a luminance texture from some data.
  91847. * @param data Define the texture data
  91848. * @param width Define the width of the texture
  91849. * @param height Define the height of the texture
  91850. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91851. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91852. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91853. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91854. * @returns the luminance texture
  91855. */
  91856. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91857. /**
  91858. * Creates a luminance alpha texture from some data.
  91859. * @param data Define the texture data
  91860. * @param width Define the width of the texture
  91861. * @param height Define the height of the texture
  91862. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91863. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91864. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91865. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91866. * @returns the luminance alpha texture
  91867. */
  91868. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91869. /**
  91870. * Creates an alpha texture from some data.
  91871. * @param data Define the texture data
  91872. * @param width Define the width of the texture
  91873. * @param height Define the height of the texture
  91874. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91875. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91876. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91877. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91878. * @returns the alpha texture
  91879. */
  91880. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91881. /**
  91882. * Creates a RGB texture from some data.
  91883. * @param data Define the texture data
  91884. * @param width Define the width of the texture
  91885. * @param height Define the height of the texture
  91886. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91887. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91888. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91889. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91890. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91891. * @returns the RGB alpha texture
  91892. */
  91893. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91894. /**
  91895. * Creates a RGBA texture from some data.
  91896. * @param data Define the texture data
  91897. * @param width Define the width of the texture
  91898. * @param height Define the height of the texture
  91899. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91900. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91901. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91902. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91903. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91904. * @returns the RGBA texture
  91905. */
  91906. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91907. /**
  91908. * Creates a R texture from some data.
  91909. * @param data Define the texture data
  91910. * @param width Define the width of the texture
  91911. * @param height Define the height of the texture
  91912. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91913. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91914. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91915. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91916. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91917. * @returns the R texture
  91918. */
  91919. static CreateRTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91920. }
  91921. }
  91922. declare module BABYLON {
  91923. interface ThinEngine {
  91924. /**
  91925. * Update a dynamic index buffer
  91926. * @param indexBuffer defines the target index buffer
  91927. * @param indices defines the data to update
  91928. * @param offset defines the offset in the target index buffer where update should start
  91929. */
  91930. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  91931. /**
  91932. * Updates a dynamic vertex buffer.
  91933. * @param vertexBuffer the vertex buffer to update
  91934. * @param data the data used to update the vertex buffer
  91935. * @param byteOffset the byte offset of the data
  91936. * @param byteLength the byte length of the data
  91937. */
  91938. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  91939. }
  91940. }
  91941. declare module BABYLON {
  91942. interface AbstractScene {
  91943. /**
  91944. * The list of procedural textures added to the scene
  91945. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91946. */
  91947. proceduralTextures: Array<ProceduralTexture>;
  91948. }
  91949. /**
  91950. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  91951. * in a given scene.
  91952. */
  91953. export class ProceduralTextureSceneComponent implements ISceneComponent {
  91954. /**
  91955. * The component name helpfull to identify the component in the list of scene components.
  91956. */
  91957. readonly name: string;
  91958. /**
  91959. * The scene the component belongs to.
  91960. */
  91961. scene: Scene;
  91962. /**
  91963. * Creates a new instance of the component for the given scene
  91964. * @param scene Defines the scene to register the component in
  91965. */
  91966. constructor(scene: Scene);
  91967. /**
  91968. * Registers the component in a given scene
  91969. */
  91970. register(): void;
  91971. /**
  91972. * Rebuilds the elements related to this component in case of
  91973. * context lost for instance.
  91974. */
  91975. rebuild(): void;
  91976. /**
  91977. * Disposes the component and the associated ressources.
  91978. */
  91979. dispose(): void;
  91980. private _beforeClear;
  91981. }
  91982. }
  91983. declare module BABYLON {
  91984. interface ThinEngine {
  91985. /**
  91986. * Creates a new render target cube texture
  91987. * @param size defines the size of the texture
  91988. * @param options defines the options used to create the texture
  91989. * @returns a new render target cube texture stored in an InternalTexture
  91990. */
  91991. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  91992. }
  91993. }
  91994. declare module BABYLON {
  91995. /** @hidden */
  91996. export var proceduralVertexShader: {
  91997. name: string;
  91998. shader: string;
  91999. };
  92000. }
  92001. declare module BABYLON {
  92002. /**
  92003. * 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.
  92004. * This is the base class of any Procedural texture and contains most of the shareable code.
  92005. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  92006. */
  92007. export class ProceduralTexture extends Texture {
  92008. /**
  92009. * Define if the texture is enabled or not (disabled texture will not render)
  92010. */
  92011. isEnabled: boolean;
  92012. /**
  92013. * Define if the texture must be cleared before rendering (default is true)
  92014. */
  92015. autoClear: boolean;
  92016. /**
  92017. * Callback called when the texture is generated
  92018. */
  92019. onGenerated: () => void;
  92020. /**
  92021. * Event raised when the texture is generated
  92022. */
  92023. onGeneratedObservable: Observable<ProceduralTexture>;
  92024. /**
  92025. * Event raised before the texture is generated
  92026. */
  92027. onBeforeGenerationObservable: Observable<ProceduralTexture>;
  92028. /**
  92029. * Gets or sets the node material used to create this texture (null if the texture was manually created)
  92030. */
  92031. nodeMaterialSource: Nullable<NodeMaterial>;
  92032. /** @hidden */
  92033. _generateMipMaps: boolean;
  92034. /** @hidden **/
  92035. _effect: Effect;
  92036. /** @hidden */
  92037. _textures: {
  92038. [key: string]: Texture;
  92039. };
  92040. /** @hidden */
  92041. protected _fallbackTexture: Nullable<Texture>;
  92042. private _size;
  92043. private _currentRefreshId;
  92044. private _frameId;
  92045. private _refreshRate;
  92046. private _vertexBuffers;
  92047. private _indexBuffer;
  92048. private _uniforms;
  92049. private _samplers;
  92050. private _fragment;
  92051. private _floats;
  92052. private _ints;
  92053. private _floatsArrays;
  92054. private _colors3;
  92055. private _colors4;
  92056. private _vectors2;
  92057. private _vectors3;
  92058. private _matrices;
  92059. private _fallbackTextureUsed;
  92060. private _fullEngine;
  92061. private _cachedDefines;
  92062. private _contentUpdateId;
  92063. private _contentData;
  92064. /**
  92065. * Instantiates a new procedural texture.
  92066. * 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.
  92067. * This is the base class of any Procedural texture and contains most of the shareable code.
  92068. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  92069. * @param name Define the name of the texture
  92070. * @param size Define the size of the texture to create
  92071. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  92072. * @param scene Define the scene the texture belongs to
  92073. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  92074. * @param generateMipMaps Define if the texture should creates mip maps or not
  92075. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  92076. */
  92077. constructor(name: string, size: RenderTargetTextureSize, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  92078. /**
  92079. * The effect that is created when initializing the post process.
  92080. * @returns The created effect corresponding the the postprocess.
  92081. */
  92082. getEffect(): Effect;
  92083. /**
  92084. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  92085. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  92086. */
  92087. getContent(): Nullable<ArrayBufferView>;
  92088. private _createIndexBuffer;
  92089. /** @hidden */
  92090. _rebuild(): void;
  92091. /**
  92092. * Resets the texture in order to recreate its associated resources.
  92093. * This can be called in case of context loss
  92094. */
  92095. reset(): void;
  92096. protected _getDefines(): string;
  92097. /**
  92098. * Is the texture ready to be used ? (rendered at least once)
  92099. * @returns true if ready, otherwise, false.
  92100. */
  92101. isReady(): boolean;
  92102. /**
  92103. * Resets the refresh counter of the texture and start bak from scratch.
  92104. * Could be useful to regenerate the texture if it is setup to render only once.
  92105. */
  92106. resetRefreshCounter(): void;
  92107. /**
  92108. * Set the fragment shader to use in order to render the texture.
  92109. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  92110. */
  92111. setFragment(fragment: any): void;
  92112. /**
  92113. * Define the refresh rate of the texture or the rendering frequency.
  92114. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  92115. */
  92116. get refreshRate(): number;
  92117. set refreshRate(value: number);
  92118. /** @hidden */
  92119. _shouldRender(): boolean;
  92120. /**
  92121. * Get the size the texture is rendering at.
  92122. * @returns the size (on cube texture it is always squared)
  92123. */
  92124. getRenderSize(): RenderTargetTextureSize;
  92125. /**
  92126. * Resize the texture to new value.
  92127. * @param size Define the new size the texture should have
  92128. * @param generateMipMaps Define whether the new texture should create mip maps
  92129. */
  92130. resize(size: number, generateMipMaps: boolean): void;
  92131. private _checkUniform;
  92132. /**
  92133. * Set a texture in the shader program used to render.
  92134. * @param name Define the name of the uniform samplers as defined in the shader
  92135. * @param texture Define the texture to bind to this sampler
  92136. * @return the texture itself allowing "fluent" like uniform updates
  92137. */
  92138. setTexture(name: string, texture: Texture): ProceduralTexture;
  92139. /**
  92140. * Set a float in the shader.
  92141. * @param name Define the name of the uniform as defined in the shader
  92142. * @param value Define the value to give to the uniform
  92143. * @return the texture itself allowing "fluent" like uniform updates
  92144. */
  92145. setFloat(name: string, value: number): ProceduralTexture;
  92146. /**
  92147. * Set a int in the shader.
  92148. * @param name Define the name of the uniform as defined in the shader
  92149. * @param value Define the value to give to the uniform
  92150. * @return the texture itself allowing "fluent" like uniform updates
  92151. */
  92152. setInt(name: string, value: number): ProceduralTexture;
  92153. /**
  92154. * Set an array of floats in the shader.
  92155. * @param name Define the name of the uniform as defined in the shader
  92156. * @param value Define the value to give to the uniform
  92157. * @return the texture itself allowing "fluent" like uniform updates
  92158. */
  92159. setFloats(name: string, value: number[]): ProceduralTexture;
  92160. /**
  92161. * Set a vec3 in the shader from a Color3.
  92162. * @param name Define the name of the uniform as defined in the shader
  92163. * @param value Define the value to give to the uniform
  92164. * @return the texture itself allowing "fluent" like uniform updates
  92165. */
  92166. setColor3(name: string, value: Color3): ProceduralTexture;
  92167. /**
  92168. * Set a vec4 in the shader from a Color4.
  92169. * @param name Define the name of the uniform as defined in the shader
  92170. * @param value Define the value to give to the uniform
  92171. * @return the texture itself allowing "fluent" like uniform updates
  92172. */
  92173. setColor4(name: string, value: Color4): ProceduralTexture;
  92174. /**
  92175. * Set a vec2 in the shader from a Vector2.
  92176. * @param name Define the name of the uniform as defined in the shader
  92177. * @param value Define the value to give to the uniform
  92178. * @return the texture itself allowing "fluent" like uniform updates
  92179. */
  92180. setVector2(name: string, value: Vector2): ProceduralTexture;
  92181. /**
  92182. * Set a vec3 in the shader from a Vector3.
  92183. * @param name Define the name of the uniform as defined in the shader
  92184. * @param value Define the value to give to the uniform
  92185. * @return the texture itself allowing "fluent" like uniform updates
  92186. */
  92187. setVector3(name: string, value: Vector3): ProceduralTexture;
  92188. /**
  92189. * Set a mat4 in the shader from a MAtrix.
  92190. * @param name Define the name of the uniform as defined in the shader
  92191. * @param value Define the value to give to the uniform
  92192. * @return the texture itself allowing "fluent" like uniform updates
  92193. */
  92194. setMatrix(name: string, value: Matrix): ProceduralTexture;
  92195. /**
  92196. * Render the texture to its associated render target.
  92197. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  92198. */
  92199. render(useCameraPostProcess?: boolean): void;
  92200. /**
  92201. * Clone the texture.
  92202. * @returns the cloned texture
  92203. */
  92204. clone(): ProceduralTexture;
  92205. /**
  92206. * Dispose the texture and release its asoociated resources.
  92207. */
  92208. dispose(): void;
  92209. }
  92210. }
  92211. declare module BABYLON {
  92212. /**
  92213. * This represents the base class for particle system in Babylon.
  92214. * 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.
  92215. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  92216. * @example https://doc.babylonjs.com/babylon101/particles
  92217. */
  92218. export class BaseParticleSystem {
  92219. /**
  92220. * Source color is added to the destination color without alpha affecting the result
  92221. */
  92222. static BLENDMODE_ONEONE: number;
  92223. /**
  92224. * Blend current color and particle color using particle’s alpha
  92225. */
  92226. static BLENDMODE_STANDARD: number;
  92227. /**
  92228. * Add current color and particle color multiplied by particle’s alpha
  92229. */
  92230. static BLENDMODE_ADD: number;
  92231. /**
  92232. * Multiply current color with particle color
  92233. */
  92234. static BLENDMODE_MULTIPLY: number;
  92235. /**
  92236. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  92237. */
  92238. static BLENDMODE_MULTIPLYADD: number;
  92239. /**
  92240. * List of animations used by the particle system.
  92241. */
  92242. animations: Animation[];
  92243. /**
  92244. * Gets or sets the unique id of the particle system
  92245. */
  92246. uniqueId: number;
  92247. /**
  92248. * The id of the Particle system.
  92249. */
  92250. id: string;
  92251. /**
  92252. * The friendly name of the Particle system.
  92253. */
  92254. name: string;
  92255. /**
  92256. * Snippet ID if the particle system was created from the snippet server
  92257. */
  92258. snippetId: string;
  92259. /**
  92260. * The rendering group used by the Particle system to chose when to render.
  92261. */
  92262. renderingGroupId: number;
  92263. /**
  92264. * The emitter represents the Mesh or position we are attaching the particle system to.
  92265. */
  92266. emitter: Nullable<AbstractMesh | Vector3>;
  92267. /**
  92268. * The maximum number of particles to emit per frame
  92269. */
  92270. emitRate: number;
  92271. /**
  92272. * If you want to launch only a few particles at once, that can be done, as well.
  92273. */
  92274. manualEmitCount: number;
  92275. /**
  92276. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  92277. */
  92278. updateSpeed: number;
  92279. /**
  92280. * The amount of time the particle system is running (depends of the overall update speed).
  92281. */
  92282. targetStopDuration: number;
  92283. /**
  92284. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  92285. */
  92286. disposeOnStop: boolean;
  92287. /**
  92288. * Minimum power of emitting particles.
  92289. */
  92290. minEmitPower: number;
  92291. /**
  92292. * Maximum power of emitting particles.
  92293. */
  92294. maxEmitPower: number;
  92295. /**
  92296. * Minimum life time of emitting particles.
  92297. */
  92298. minLifeTime: number;
  92299. /**
  92300. * Maximum life time of emitting particles.
  92301. */
  92302. maxLifeTime: number;
  92303. /**
  92304. * Minimum Size of emitting particles.
  92305. */
  92306. minSize: number;
  92307. /**
  92308. * Maximum Size of emitting particles.
  92309. */
  92310. maxSize: number;
  92311. /**
  92312. * Minimum scale of emitting particles on X axis.
  92313. */
  92314. minScaleX: number;
  92315. /**
  92316. * Maximum scale of emitting particles on X axis.
  92317. */
  92318. maxScaleX: number;
  92319. /**
  92320. * Minimum scale of emitting particles on Y axis.
  92321. */
  92322. minScaleY: number;
  92323. /**
  92324. * Maximum scale of emitting particles on Y axis.
  92325. */
  92326. maxScaleY: number;
  92327. /**
  92328. * Gets or sets the minimal initial rotation in radians.
  92329. */
  92330. minInitialRotation: number;
  92331. /**
  92332. * Gets or sets the maximal initial rotation in radians.
  92333. */
  92334. maxInitialRotation: number;
  92335. /**
  92336. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  92337. */
  92338. minAngularSpeed: number;
  92339. /**
  92340. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  92341. */
  92342. maxAngularSpeed: number;
  92343. /**
  92344. * The texture used to render each particle. (this can be a spritesheet)
  92345. */
  92346. particleTexture: Nullable<BaseTexture>;
  92347. /**
  92348. * The layer mask we are rendering the particles through.
  92349. */
  92350. layerMask: number;
  92351. /**
  92352. * This can help using your own shader to render the particle system.
  92353. * The according effect will be created
  92354. */
  92355. customShader: any;
  92356. /**
  92357. * By default particle system starts as soon as they are created. This prevents the
  92358. * automatic start to happen and let you decide when to start emitting particles.
  92359. */
  92360. preventAutoStart: boolean;
  92361. private _noiseTexture;
  92362. /**
  92363. * Gets or sets a texture used to add random noise to particle positions
  92364. */
  92365. get noiseTexture(): Nullable<ProceduralTexture>;
  92366. set noiseTexture(value: Nullable<ProceduralTexture>);
  92367. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  92368. noiseStrength: Vector3;
  92369. /**
  92370. * Callback triggered when the particle animation is ending.
  92371. */
  92372. onAnimationEnd: Nullable<() => void>;
  92373. /**
  92374. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  92375. */
  92376. blendMode: number;
  92377. /**
  92378. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  92379. * to override the particles.
  92380. */
  92381. forceDepthWrite: boolean;
  92382. /** 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 */
  92383. preWarmCycles: number;
  92384. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  92385. preWarmStepOffset: number;
  92386. /**
  92387. * 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)
  92388. */
  92389. spriteCellChangeSpeed: number;
  92390. /**
  92391. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  92392. */
  92393. startSpriteCellID: number;
  92394. /**
  92395. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  92396. */
  92397. endSpriteCellID: number;
  92398. /**
  92399. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  92400. */
  92401. spriteCellWidth: number;
  92402. /**
  92403. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  92404. */
  92405. spriteCellHeight: number;
  92406. /**
  92407. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  92408. */
  92409. spriteRandomStartCell: boolean;
  92410. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  92411. translationPivot: Vector2;
  92412. /** @hidden */
  92413. protected _isAnimationSheetEnabled: boolean;
  92414. /**
  92415. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  92416. */
  92417. beginAnimationOnStart: boolean;
  92418. /**
  92419. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  92420. */
  92421. beginAnimationFrom: number;
  92422. /**
  92423. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  92424. */
  92425. beginAnimationTo: number;
  92426. /**
  92427. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  92428. */
  92429. beginAnimationLoop: boolean;
  92430. /**
  92431. * Gets or sets a world offset applied to all particles
  92432. */
  92433. worldOffset: Vector3;
  92434. /**
  92435. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  92436. */
  92437. get isAnimationSheetEnabled(): boolean;
  92438. set isAnimationSheetEnabled(value: boolean);
  92439. /**
  92440. * Get hosting scene
  92441. * @returns the scene
  92442. */
  92443. getScene(): Nullable<Scene>;
  92444. /**
  92445. * You can use gravity if you want to give an orientation to your particles.
  92446. */
  92447. gravity: Vector3;
  92448. protected _colorGradients: Nullable<Array<ColorGradient>>;
  92449. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  92450. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  92451. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  92452. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  92453. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  92454. protected _dragGradients: Nullable<Array<FactorGradient>>;
  92455. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  92456. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  92457. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  92458. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  92459. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  92460. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  92461. /**
  92462. * Defines the delay in milliseconds before starting the system (0 by default)
  92463. */
  92464. startDelay: number;
  92465. /**
  92466. * Gets the current list of drag gradients.
  92467. * You must use addDragGradient and removeDragGradient to udpate this list
  92468. * @returns the list of drag gradients
  92469. */
  92470. getDragGradients(): Nullable<Array<FactorGradient>>;
  92471. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  92472. limitVelocityDamping: number;
  92473. /**
  92474. * Gets the current list of limit velocity gradients.
  92475. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  92476. * @returns the list of limit velocity gradients
  92477. */
  92478. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  92479. /**
  92480. * Gets the current list of color gradients.
  92481. * You must use addColorGradient and removeColorGradient to udpate this list
  92482. * @returns the list of color gradients
  92483. */
  92484. getColorGradients(): Nullable<Array<ColorGradient>>;
  92485. /**
  92486. * Gets the current list of size gradients.
  92487. * You must use addSizeGradient and removeSizeGradient to udpate this list
  92488. * @returns the list of size gradients
  92489. */
  92490. getSizeGradients(): Nullable<Array<FactorGradient>>;
  92491. /**
  92492. * Gets the current list of color remap gradients.
  92493. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  92494. * @returns the list of color remap gradients
  92495. */
  92496. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  92497. /**
  92498. * Gets the current list of alpha remap gradients.
  92499. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  92500. * @returns the list of alpha remap gradients
  92501. */
  92502. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  92503. /**
  92504. * Gets the current list of life time gradients.
  92505. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  92506. * @returns the list of life time gradients
  92507. */
  92508. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  92509. /**
  92510. * Gets the current list of angular speed gradients.
  92511. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  92512. * @returns the list of angular speed gradients
  92513. */
  92514. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  92515. /**
  92516. * Gets the current list of velocity gradients.
  92517. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  92518. * @returns the list of velocity gradients
  92519. */
  92520. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  92521. /**
  92522. * Gets the current list of start size gradients.
  92523. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  92524. * @returns the list of start size gradients
  92525. */
  92526. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  92527. /**
  92528. * Gets the current list of emit rate gradients.
  92529. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  92530. * @returns the list of emit rate gradients
  92531. */
  92532. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  92533. /**
  92534. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92535. * This only works when particleEmitterTyps is a BoxParticleEmitter
  92536. */
  92537. get direction1(): Vector3;
  92538. set direction1(value: Vector3);
  92539. /**
  92540. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92541. * This only works when particleEmitterTyps is a BoxParticleEmitter
  92542. */
  92543. get direction2(): Vector3;
  92544. set direction2(value: Vector3);
  92545. /**
  92546. * 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.
  92547. * This only works when particleEmitterTyps is a BoxParticleEmitter
  92548. */
  92549. get minEmitBox(): Vector3;
  92550. set minEmitBox(value: Vector3);
  92551. /**
  92552. * 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.
  92553. * This only works when particleEmitterTyps is a BoxParticleEmitter
  92554. */
  92555. get maxEmitBox(): Vector3;
  92556. set maxEmitBox(value: Vector3);
  92557. /**
  92558. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  92559. */
  92560. color1: Color4;
  92561. /**
  92562. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  92563. */
  92564. color2: Color4;
  92565. /**
  92566. * Color the particle will have at the end of its lifetime
  92567. */
  92568. colorDead: Color4;
  92569. /**
  92570. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  92571. */
  92572. textureMask: Color4;
  92573. /**
  92574. * The particle emitter type defines the emitter used by the particle system.
  92575. * It can be for example box, sphere, or cone...
  92576. */
  92577. particleEmitterType: IParticleEmitterType;
  92578. /** @hidden */
  92579. _isSubEmitter: boolean;
  92580. /**
  92581. * Gets or sets the billboard mode to use when isBillboardBased = true.
  92582. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  92583. */
  92584. billboardMode: number;
  92585. protected _isBillboardBased: boolean;
  92586. /**
  92587. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  92588. */
  92589. get isBillboardBased(): boolean;
  92590. set isBillboardBased(value: boolean);
  92591. /**
  92592. * The scene the particle system belongs to.
  92593. */
  92594. protected _scene: Nullable<Scene>;
  92595. /**
  92596. * The engine the particle system belongs to.
  92597. */
  92598. protected _engine: ThinEngine;
  92599. /**
  92600. * Local cache of defines for image processing.
  92601. */
  92602. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  92603. /**
  92604. * Default configuration related to image processing available in the standard Material.
  92605. */
  92606. protected _imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  92607. /**
  92608. * Gets the image processing configuration used either in this material.
  92609. */
  92610. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  92611. /**
  92612. * Sets the Default image processing configuration used either in the this material.
  92613. *
  92614. * If sets to null, the scene one is in use.
  92615. */
  92616. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  92617. /**
  92618. * Attaches a new image processing configuration to the Standard Material.
  92619. * @param configuration
  92620. */
  92621. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  92622. /** @hidden */
  92623. protected _reset(): void;
  92624. /** @hidden */
  92625. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  92626. /**
  92627. * Instantiates a particle system.
  92628. * 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.
  92629. * @param name The name of the particle system
  92630. */
  92631. constructor(name: string);
  92632. /**
  92633. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  92634. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  92635. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  92636. * @returns the emitter
  92637. */
  92638. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  92639. /**
  92640. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  92641. * @param radius The radius of the hemisphere to emit from
  92642. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  92643. * @returns the emitter
  92644. */
  92645. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  92646. /**
  92647. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  92648. * @param radius The radius of the sphere to emit from
  92649. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  92650. * @returns the emitter
  92651. */
  92652. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  92653. /**
  92654. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  92655. * @param radius The radius of the sphere to emit from
  92656. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  92657. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  92658. * @returns the emitter
  92659. */
  92660. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  92661. /**
  92662. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  92663. * @param radius The radius of the emission cylinder
  92664. * @param height The height of the emission cylinder
  92665. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  92666. * @param directionRandomizer How much to randomize the particle direction [0-1]
  92667. * @returns the emitter
  92668. */
  92669. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  92670. /**
  92671. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  92672. * @param radius The radius of the cylinder to emit from
  92673. * @param height The height of the emission cylinder
  92674. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  92675. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  92676. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  92677. * @returns the emitter
  92678. */
  92679. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  92680. /**
  92681. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  92682. * @param radius The radius of the cone to emit from
  92683. * @param angle The base angle of the cone
  92684. * @returns the emitter
  92685. */
  92686. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  92687. /**
  92688. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  92689. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  92690. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  92691. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  92692. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  92693. * @returns the emitter
  92694. */
  92695. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  92696. }
  92697. }
  92698. declare module BABYLON {
  92699. /**
  92700. * Type of sub emitter
  92701. */
  92702. export enum SubEmitterType {
  92703. /**
  92704. * Attached to the particle over it's lifetime
  92705. */
  92706. ATTACHED = 0,
  92707. /**
  92708. * Created when the particle dies
  92709. */
  92710. END = 1
  92711. }
  92712. /**
  92713. * Sub emitter class used to emit particles from an existing particle
  92714. */
  92715. export class SubEmitter {
  92716. /**
  92717. * the particle system to be used by the sub emitter
  92718. */
  92719. particleSystem: ParticleSystem;
  92720. /**
  92721. * Type of the submitter (Default: END)
  92722. */
  92723. type: SubEmitterType;
  92724. /**
  92725. * 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)
  92726. * Note: This only is supported when using an emitter of type Mesh
  92727. */
  92728. inheritDirection: boolean;
  92729. /**
  92730. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  92731. */
  92732. inheritedVelocityAmount: number;
  92733. /**
  92734. * Creates a sub emitter
  92735. * @param particleSystem the particle system to be used by the sub emitter
  92736. */
  92737. constructor(
  92738. /**
  92739. * the particle system to be used by the sub emitter
  92740. */
  92741. particleSystem: ParticleSystem);
  92742. /**
  92743. * Clones the sub emitter
  92744. * @returns the cloned sub emitter
  92745. */
  92746. clone(): SubEmitter;
  92747. /**
  92748. * Serialize current object to a JSON object
  92749. * @returns the serialized object
  92750. */
  92751. serialize(): any;
  92752. /** @hidden */
  92753. static _ParseParticleSystem(system: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): ParticleSystem;
  92754. /**
  92755. * Creates a new SubEmitter from a serialized JSON version
  92756. * @param serializationObject defines the JSON object to read from
  92757. * @param sceneOrEngine defines the hosting scene or the hosting engine
  92758. * @param rootUrl defines the rootUrl for data loading
  92759. * @returns a new SubEmitter
  92760. */
  92761. static Parse(serializationObject: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): SubEmitter;
  92762. /** Release associated resources */
  92763. dispose(): void;
  92764. }
  92765. }
  92766. declare module BABYLON {
  92767. /** @hidden */
  92768. export var imageProcessingDeclaration: {
  92769. name: string;
  92770. shader: string;
  92771. };
  92772. }
  92773. declare module BABYLON {
  92774. /** @hidden */
  92775. export var imageProcessingFunctions: {
  92776. name: string;
  92777. shader: string;
  92778. };
  92779. }
  92780. declare module BABYLON {
  92781. /** @hidden */
  92782. export var particlesPixelShader: {
  92783. name: string;
  92784. shader: string;
  92785. };
  92786. }
  92787. declare module BABYLON {
  92788. /** @hidden */
  92789. export var particlesVertexShader: {
  92790. name: string;
  92791. shader: string;
  92792. };
  92793. }
  92794. declare module BABYLON {
  92795. /**
  92796. * Interface used to define entities containing multiple clip planes
  92797. */
  92798. export interface IClipPlanesHolder {
  92799. /**
  92800. * Gets or sets the active clipplane 1
  92801. */
  92802. clipPlane: Nullable<Plane>;
  92803. /**
  92804. * Gets or sets the active clipplane 2
  92805. */
  92806. clipPlane2: Nullable<Plane>;
  92807. /**
  92808. * Gets or sets the active clipplane 3
  92809. */
  92810. clipPlane3: Nullable<Plane>;
  92811. /**
  92812. * Gets or sets the active clipplane 4
  92813. */
  92814. clipPlane4: Nullable<Plane>;
  92815. /**
  92816. * Gets or sets the active clipplane 5
  92817. */
  92818. clipPlane5: Nullable<Plane>;
  92819. /**
  92820. * Gets or sets the active clipplane 6
  92821. */
  92822. clipPlane6: Nullable<Plane>;
  92823. }
  92824. }
  92825. declare module BABYLON {
  92826. /**
  92827. * "Static Class" containing a few commonly used helper while dealing with material for rendering purpose.
  92828. *
  92829. * It is complementary with MaterialHelper but provides completely independent functions (for tree shaking sake)
  92830. *
  92831. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  92832. */
  92833. export class ThinMaterialHelper {
  92834. /**
  92835. * Binds the clip plane information from the holder to the effect.
  92836. * @param effect The effect we are binding the data to
  92837. * @param holder The entity containing the clip plane information
  92838. */
  92839. static BindClipPlane(effect: Effect, holder: IClipPlanesHolder): void;
  92840. }
  92841. }
  92842. declare module BABYLON {
  92843. interface ThinEngine {
  92844. /**
  92845. * Sets alpha constants used by some alpha blending modes
  92846. * @param r defines the red component
  92847. * @param g defines the green component
  92848. * @param b defines the blue component
  92849. * @param a defines the alpha component
  92850. */
  92851. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  92852. /**
  92853. * Sets the current alpha mode
  92854. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  92855. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  92856. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  92857. */
  92858. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  92859. /**
  92860. * Gets the current alpha mode
  92861. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  92862. * @returns the current alpha mode
  92863. */
  92864. getAlphaMode(): number;
  92865. /**
  92866. * Sets the current alpha equation
  92867. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  92868. */
  92869. setAlphaEquation(equation: number): void;
  92870. /**
  92871. * Gets the current alpha equation.
  92872. * @returns the current alpha equation
  92873. */
  92874. getAlphaEquation(): number;
  92875. }
  92876. }
  92877. declare module BABYLON {
  92878. /**
  92879. * This represents a particle system in Babylon.
  92880. * 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.
  92881. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  92882. * @example https://doc.babylonjs.com/babylon101/particles
  92883. */
  92884. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  92885. /**
  92886. * Billboard mode will only apply to Y axis
  92887. */
  92888. static readonly BILLBOARDMODE_Y: number;
  92889. /**
  92890. * Billboard mode will apply to all axes
  92891. */
  92892. static readonly BILLBOARDMODE_ALL: number;
  92893. /**
  92894. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  92895. */
  92896. static readonly BILLBOARDMODE_STRETCHED: number;
  92897. /**
  92898. * This function can be defined to provide custom update for active particles.
  92899. * This function will be called instead of regular update (age, position, color, etc.).
  92900. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  92901. */
  92902. updateFunction: (particles: Particle[]) => void;
  92903. private _emitterWorldMatrix;
  92904. /**
  92905. * This function can be defined to specify initial direction for every new particle.
  92906. * It by default use the emitterType defined function
  92907. */
  92908. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  92909. /**
  92910. * This function can be defined to specify initial position for every new particle.
  92911. * It by default use the emitterType defined function
  92912. */
  92913. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  92914. /**
  92915. * @hidden
  92916. */
  92917. _inheritedVelocityOffset: Vector3;
  92918. /**
  92919. * An event triggered when the system is disposed
  92920. */
  92921. onDisposeObservable: Observable<IParticleSystem>;
  92922. private _onDisposeObserver;
  92923. /**
  92924. * Sets a callback that will be triggered when the system is disposed
  92925. */
  92926. set onDispose(callback: () => void);
  92927. private _particles;
  92928. private _epsilon;
  92929. private _capacity;
  92930. private _stockParticles;
  92931. private _newPartsExcess;
  92932. private _vertexData;
  92933. private _vertexBuffer;
  92934. private _vertexBuffers;
  92935. private _spriteBuffer;
  92936. private _indexBuffer;
  92937. private _effect;
  92938. private _customEffect;
  92939. private _cachedDefines;
  92940. private _scaledColorStep;
  92941. private _colorDiff;
  92942. private _scaledDirection;
  92943. private _scaledGravity;
  92944. private _currentRenderId;
  92945. private _alive;
  92946. private _useInstancing;
  92947. private _started;
  92948. private _stopped;
  92949. private _actualFrame;
  92950. private _scaledUpdateSpeed;
  92951. private _vertexBufferSize;
  92952. /** @hidden */
  92953. _currentEmitRateGradient: Nullable<FactorGradient>;
  92954. /** @hidden */
  92955. _currentEmitRate1: number;
  92956. /** @hidden */
  92957. _currentEmitRate2: number;
  92958. /** @hidden */
  92959. _currentStartSizeGradient: Nullable<FactorGradient>;
  92960. /** @hidden */
  92961. _currentStartSize1: number;
  92962. /** @hidden */
  92963. _currentStartSize2: number;
  92964. private readonly _rawTextureWidth;
  92965. private _rampGradientsTexture;
  92966. private _useRampGradients;
  92967. /** Gets or sets a matrix to use to compute projection */
  92968. defaultProjectionMatrix: Matrix;
  92969. /** Gets or sets a matrix to use to compute view */
  92970. defaultViewMatrix: Matrix;
  92971. /** Gets or sets a boolean indicating that ramp gradients must be used
  92972. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  92973. */
  92974. get useRampGradients(): boolean;
  92975. set useRampGradients(value: boolean);
  92976. /**
  92977. * 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.
  92978. * 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: [])
  92979. */
  92980. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  92981. private _subEmitters;
  92982. /**
  92983. * @hidden
  92984. * If the particle systems emitter should be disposed when the particle system is disposed
  92985. */
  92986. _disposeEmitterOnDispose: boolean;
  92987. /**
  92988. * The current active Sub-systems, this property is used by the root particle system only.
  92989. */
  92990. activeSubSystems: Array<ParticleSystem>;
  92991. /**
  92992. * Specifies if the particles are updated in emitter local space or world space
  92993. */
  92994. isLocal: boolean;
  92995. private _rootParticleSystem;
  92996. /**
  92997. * Gets the current list of active particles
  92998. */
  92999. get particles(): Particle[];
  93000. /**
  93001. * Gets the number of particles active at the same time.
  93002. * @returns The number of active particles.
  93003. */
  93004. getActiveCount(): number;
  93005. /**
  93006. * Returns the string "ParticleSystem"
  93007. * @returns a string containing the class name
  93008. */
  93009. getClassName(): string;
  93010. /**
  93011. * Gets a boolean indicating that the system is stopping
  93012. * @returns true if the system is currently stopping
  93013. */
  93014. isStopping(): boolean;
  93015. /**
  93016. * Gets the custom effect used to render the particles
  93017. * @param blendMode Blend mode for which the effect should be retrieved
  93018. * @returns The effect
  93019. */
  93020. getCustomEffect(blendMode?: number): Nullable<Effect>;
  93021. /**
  93022. * Sets the custom effect used to render the particles
  93023. * @param effect The effect to set
  93024. * @param blendMode Blend mode for which the effect should be set
  93025. */
  93026. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  93027. /** @hidden */
  93028. private _onBeforeDrawParticlesObservable;
  93029. /**
  93030. * Observable that will be called just before the particles are drawn
  93031. */
  93032. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  93033. /**
  93034. * Gets the name of the particle vertex shader
  93035. */
  93036. get vertexShaderName(): string;
  93037. /**
  93038. * Instantiates a particle system.
  93039. * 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.
  93040. * @param name The name of the particle system
  93041. * @param capacity The max number of particles alive at the same time
  93042. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  93043. * @param customEffect a custom effect used to change the way particles are rendered by default
  93044. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  93045. * @param epsilon Offset used to render the particles
  93046. */
  93047. constructor(name: string, capacity: number, sceneOrEngine: Scene | ThinEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  93048. private _addFactorGradient;
  93049. private _removeFactorGradient;
  93050. /**
  93051. * Adds a new life time gradient
  93052. * @param gradient defines the gradient to use (between 0 and 1)
  93053. * @param factor defines the life time factor to affect to the specified gradient
  93054. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93055. * @returns the current particle system
  93056. */
  93057. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93058. /**
  93059. * Remove a specific life time gradient
  93060. * @param gradient defines the gradient to remove
  93061. * @returns the current particle system
  93062. */
  93063. removeLifeTimeGradient(gradient: number): IParticleSystem;
  93064. /**
  93065. * Adds a new size gradient
  93066. * @param gradient defines the gradient to use (between 0 and 1)
  93067. * @param factor defines the size factor to affect to the specified gradient
  93068. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93069. * @returns the current particle system
  93070. */
  93071. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93072. /**
  93073. * Remove a specific size gradient
  93074. * @param gradient defines the gradient to remove
  93075. * @returns the current particle system
  93076. */
  93077. removeSizeGradient(gradient: number): IParticleSystem;
  93078. /**
  93079. * Adds a new color remap gradient
  93080. * @param gradient defines the gradient to use (between 0 and 1)
  93081. * @param min defines the color remap minimal range
  93082. * @param max defines the color remap maximal range
  93083. * @returns the current particle system
  93084. */
  93085. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  93086. /**
  93087. * Remove a specific color remap gradient
  93088. * @param gradient defines the gradient to remove
  93089. * @returns the current particle system
  93090. */
  93091. removeColorRemapGradient(gradient: number): IParticleSystem;
  93092. /**
  93093. * Adds a new alpha remap gradient
  93094. * @param gradient defines the gradient to use (between 0 and 1)
  93095. * @param min defines the alpha remap minimal range
  93096. * @param max defines the alpha remap maximal range
  93097. * @returns the current particle system
  93098. */
  93099. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  93100. /**
  93101. * Remove a specific alpha remap gradient
  93102. * @param gradient defines the gradient to remove
  93103. * @returns the current particle system
  93104. */
  93105. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  93106. /**
  93107. * Adds a new angular speed gradient
  93108. * @param gradient defines the gradient to use (between 0 and 1)
  93109. * @param factor defines the angular speed to affect to the specified gradient
  93110. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93111. * @returns the current particle system
  93112. */
  93113. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93114. /**
  93115. * Remove a specific angular speed gradient
  93116. * @param gradient defines the gradient to remove
  93117. * @returns the current particle system
  93118. */
  93119. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  93120. /**
  93121. * Adds a new velocity gradient
  93122. * @param gradient defines the gradient to use (between 0 and 1)
  93123. * @param factor defines the velocity to affect to the specified gradient
  93124. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93125. * @returns the current particle system
  93126. */
  93127. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93128. /**
  93129. * Remove a specific velocity gradient
  93130. * @param gradient defines the gradient to remove
  93131. * @returns the current particle system
  93132. */
  93133. removeVelocityGradient(gradient: number): IParticleSystem;
  93134. /**
  93135. * Adds a new limit velocity gradient
  93136. * @param gradient defines the gradient to use (between 0 and 1)
  93137. * @param factor defines the limit velocity value to affect to the specified gradient
  93138. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93139. * @returns the current particle system
  93140. */
  93141. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93142. /**
  93143. * Remove a specific limit velocity gradient
  93144. * @param gradient defines the gradient to remove
  93145. * @returns the current particle system
  93146. */
  93147. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  93148. /**
  93149. * Adds a new drag gradient
  93150. * @param gradient defines the gradient to use (between 0 and 1)
  93151. * @param factor defines the drag value to affect to the specified gradient
  93152. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93153. * @returns the current particle system
  93154. */
  93155. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93156. /**
  93157. * Remove a specific drag gradient
  93158. * @param gradient defines the gradient to remove
  93159. * @returns the current particle system
  93160. */
  93161. removeDragGradient(gradient: number): IParticleSystem;
  93162. /**
  93163. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  93164. * @param gradient defines the gradient to use (between 0 and 1)
  93165. * @param factor defines the emit rate value to affect to the specified gradient
  93166. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93167. * @returns the current particle system
  93168. */
  93169. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93170. /**
  93171. * Remove a specific emit rate gradient
  93172. * @param gradient defines the gradient to remove
  93173. * @returns the current particle system
  93174. */
  93175. removeEmitRateGradient(gradient: number): IParticleSystem;
  93176. /**
  93177. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  93178. * @param gradient defines the gradient to use (between 0 and 1)
  93179. * @param factor defines the start size value to affect to the specified gradient
  93180. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93181. * @returns the current particle system
  93182. */
  93183. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93184. /**
  93185. * Remove a specific start size gradient
  93186. * @param gradient defines the gradient to remove
  93187. * @returns the current particle system
  93188. */
  93189. removeStartSizeGradient(gradient: number): IParticleSystem;
  93190. private _createRampGradientTexture;
  93191. /**
  93192. * Gets the current list of ramp gradients.
  93193. * You must use addRampGradient and removeRampGradient to udpate this list
  93194. * @returns the list of ramp gradients
  93195. */
  93196. getRampGradients(): Nullable<Array<Color3Gradient>>;
  93197. /** Force the system to rebuild all gradients that need to be resync */
  93198. forceRefreshGradients(): void;
  93199. private _syncRampGradientTexture;
  93200. /**
  93201. * Adds a new ramp gradient used to remap particle colors
  93202. * @param gradient defines the gradient to use (between 0 and 1)
  93203. * @param color defines the color to affect to the specified gradient
  93204. * @returns the current particle system
  93205. */
  93206. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  93207. /**
  93208. * Remove a specific ramp gradient
  93209. * @param gradient defines the gradient to remove
  93210. * @returns the current particle system
  93211. */
  93212. removeRampGradient(gradient: number): ParticleSystem;
  93213. /**
  93214. * Adds a new color gradient
  93215. * @param gradient defines the gradient to use (between 0 and 1)
  93216. * @param color1 defines the color to affect to the specified gradient
  93217. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  93218. * @returns this particle system
  93219. */
  93220. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  93221. /**
  93222. * Remove a specific color gradient
  93223. * @param gradient defines the gradient to remove
  93224. * @returns this particle system
  93225. */
  93226. removeColorGradient(gradient: number): IParticleSystem;
  93227. private _fetchR;
  93228. protected _reset(): void;
  93229. private _resetEffect;
  93230. private _createVertexBuffers;
  93231. private _createIndexBuffer;
  93232. /**
  93233. * Gets the maximum number of particles active at the same time.
  93234. * @returns The max number of active particles.
  93235. */
  93236. getCapacity(): number;
  93237. /**
  93238. * Gets whether there are still active particles in the system.
  93239. * @returns True if it is alive, otherwise false.
  93240. */
  93241. isAlive(): boolean;
  93242. /**
  93243. * Gets if the system has been started. (Note: this will still be true after stop is called)
  93244. * @returns True if it has been started, otherwise false.
  93245. */
  93246. isStarted(): boolean;
  93247. private _prepareSubEmitterInternalArray;
  93248. /**
  93249. * Starts the particle system and begins to emit
  93250. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  93251. */
  93252. start(delay?: number): void;
  93253. /**
  93254. * Stops the particle system.
  93255. * @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.
  93256. */
  93257. stop(stopSubEmitters?: boolean): void;
  93258. /**
  93259. * Remove all active particles
  93260. */
  93261. reset(): void;
  93262. /**
  93263. * @hidden (for internal use only)
  93264. */
  93265. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  93266. /**
  93267. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  93268. * Its lifetime will start back at 0.
  93269. */
  93270. recycleParticle: (particle: Particle) => void;
  93271. private _stopSubEmitters;
  93272. private _createParticle;
  93273. private _removeFromRoot;
  93274. private _emitFromParticle;
  93275. private _update;
  93276. /** @hidden */
  93277. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  93278. /** @hidden */
  93279. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  93280. /**
  93281. * Fill the defines array according to the current settings of the particle system
  93282. * @param defines Array to be updated
  93283. * @param blendMode blend mode to take into account when updating the array
  93284. */
  93285. fillDefines(defines: Array<string>, blendMode: number): void;
  93286. /**
  93287. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  93288. * @param uniforms Uniforms array to fill
  93289. * @param attributes Attributes array to fill
  93290. * @param samplers Samplers array to fill
  93291. */
  93292. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  93293. /** @hidden */
  93294. private _getEffect;
  93295. /**
  93296. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  93297. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  93298. */
  93299. animate(preWarmOnly?: boolean): void;
  93300. private _appendParticleVertices;
  93301. /**
  93302. * Rebuilds the particle system.
  93303. */
  93304. rebuild(): void;
  93305. /**
  93306. * Is this system ready to be used/rendered
  93307. * @return true if the system is ready
  93308. */
  93309. isReady(): boolean;
  93310. private _render;
  93311. /**
  93312. * Renders the particle system in its current state.
  93313. * @returns the current number of particles
  93314. */
  93315. render(): number;
  93316. /**
  93317. * Disposes the particle system and free the associated resources
  93318. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  93319. */
  93320. dispose(disposeTexture?: boolean): void;
  93321. /**
  93322. * Clones the particle system.
  93323. * @param name The name of the cloned object
  93324. * @param newEmitter The new emitter to use
  93325. * @returns the cloned particle system
  93326. */
  93327. clone(name: string, newEmitter: any): ParticleSystem;
  93328. /**
  93329. * Serializes the particle system to a JSON object
  93330. * @param serializeTexture defines if the texture must be serialized as well
  93331. * @returns the JSON object
  93332. */
  93333. serialize(serializeTexture?: boolean): any;
  93334. /** @hidden */
  93335. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  93336. /** @hidden */
  93337. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, sceneOrEngine: Scene | ThinEngine, rootUrl: string): void;
  93338. /**
  93339. * Parses a JSON object to create a particle system.
  93340. * @param parsedParticleSystem The JSON object to parse
  93341. * @param sceneOrEngine The scene or the engine to create the particle system in
  93342. * @param rootUrl The root url to use to load external dependencies like texture
  93343. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  93344. * @returns the Parsed particle system
  93345. */
  93346. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  93347. }
  93348. }
  93349. declare module BABYLON {
  93350. /**
  93351. * A particle represents one of the element emitted by a particle system.
  93352. * This is mainly define by its coordinates, direction, velocity and age.
  93353. */
  93354. export class Particle {
  93355. /**
  93356. * The particle system the particle belongs to.
  93357. */
  93358. particleSystem: ParticleSystem;
  93359. private static _Count;
  93360. /**
  93361. * Unique ID of the particle
  93362. */
  93363. id: number;
  93364. /**
  93365. * The world position of the particle in the scene.
  93366. */
  93367. position: Vector3;
  93368. /**
  93369. * The world direction of the particle in the scene.
  93370. */
  93371. direction: Vector3;
  93372. /**
  93373. * The color of the particle.
  93374. */
  93375. color: Color4;
  93376. /**
  93377. * The color change of the particle per step.
  93378. */
  93379. colorStep: Color4;
  93380. /**
  93381. * Defines how long will the life of the particle be.
  93382. */
  93383. lifeTime: number;
  93384. /**
  93385. * The current age of the particle.
  93386. */
  93387. age: number;
  93388. /**
  93389. * The current size of the particle.
  93390. */
  93391. size: number;
  93392. /**
  93393. * The current scale of the particle.
  93394. */
  93395. scale: Vector2;
  93396. /**
  93397. * The current angle of the particle.
  93398. */
  93399. angle: number;
  93400. /**
  93401. * Defines how fast is the angle changing.
  93402. */
  93403. angularSpeed: number;
  93404. /**
  93405. * Defines the cell index used by the particle to be rendered from a sprite.
  93406. */
  93407. cellIndex: number;
  93408. /**
  93409. * The information required to support color remapping
  93410. */
  93411. remapData: Vector4;
  93412. /** @hidden */
  93413. _randomCellOffset?: number;
  93414. /** @hidden */
  93415. _initialDirection: Nullable<Vector3>;
  93416. /** @hidden */
  93417. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  93418. /** @hidden */
  93419. _initialStartSpriteCellID: number;
  93420. /** @hidden */
  93421. _initialEndSpriteCellID: number;
  93422. /** @hidden */
  93423. _currentColorGradient: Nullable<ColorGradient>;
  93424. /** @hidden */
  93425. _currentColor1: Color4;
  93426. /** @hidden */
  93427. _currentColor2: Color4;
  93428. /** @hidden */
  93429. _currentSizeGradient: Nullable<FactorGradient>;
  93430. /** @hidden */
  93431. _currentSize1: number;
  93432. /** @hidden */
  93433. _currentSize2: number;
  93434. /** @hidden */
  93435. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  93436. /** @hidden */
  93437. _currentAngularSpeed1: number;
  93438. /** @hidden */
  93439. _currentAngularSpeed2: number;
  93440. /** @hidden */
  93441. _currentVelocityGradient: Nullable<FactorGradient>;
  93442. /** @hidden */
  93443. _currentVelocity1: number;
  93444. /** @hidden */
  93445. _currentVelocity2: number;
  93446. /** @hidden */
  93447. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  93448. /** @hidden */
  93449. _currentLimitVelocity1: number;
  93450. /** @hidden */
  93451. _currentLimitVelocity2: number;
  93452. /** @hidden */
  93453. _currentDragGradient: Nullable<FactorGradient>;
  93454. /** @hidden */
  93455. _currentDrag1: number;
  93456. /** @hidden */
  93457. _currentDrag2: number;
  93458. /** @hidden */
  93459. _randomNoiseCoordinates1: Vector3;
  93460. /** @hidden */
  93461. _randomNoiseCoordinates2: Vector3;
  93462. /** @hidden */
  93463. _localPosition?: Vector3;
  93464. /**
  93465. * Creates a new instance Particle
  93466. * @param particleSystem the particle system the particle belongs to
  93467. */
  93468. constructor(
  93469. /**
  93470. * The particle system the particle belongs to.
  93471. */
  93472. particleSystem: ParticleSystem);
  93473. private updateCellInfoFromSystem;
  93474. /**
  93475. * Defines how the sprite cell index is updated for the particle
  93476. */
  93477. updateCellIndex(): void;
  93478. /** @hidden */
  93479. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  93480. /** @hidden */
  93481. _inheritParticleInfoToSubEmitters(): void;
  93482. /** @hidden */
  93483. _reset(): void;
  93484. /**
  93485. * Copy the properties of particle to another one.
  93486. * @param other the particle to copy the information to.
  93487. */
  93488. copyTo(other: Particle): void;
  93489. }
  93490. }
  93491. declare module BABYLON {
  93492. /**
  93493. * Particle emitter represents a volume emitting particles.
  93494. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  93495. */
  93496. export interface IParticleEmitterType {
  93497. /**
  93498. * Called by the particle System when the direction is computed for the created particle.
  93499. * @param worldMatrix is the world matrix of the particle system
  93500. * @param directionToUpdate is the direction vector to update with the result
  93501. * @param particle is the particle we are computed the direction for
  93502. * @param isLocal defines if the direction should be set in local space
  93503. */
  93504. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93505. /**
  93506. * Called by the particle System when the position is computed for the created particle.
  93507. * @param worldMatrix is the world matrix of the particle system
  93508. * @param positionToUpdate is the position vector to update with the result
  93509. * @param particle is the particle we are computed the position for
  93510. * @param isLocal defines if the position should be set in local space
  93511. */
  93512. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93513. /**
  93514. * Clones the current emitter and returns a copy of it
  93515. * @returns the new emitter
  93516. */
  93517. clone(): IParticleEmitterType;
  93518. /**
  93519. * Called by the GPUParticleSystem to setup the update shader
  93520. * @param effect defines the update shader
  93521. */
  93522. applyToShader(effect: Effect): void;
  93523. /**
  93524. * Returns a string to use to update the GPU particles update shader
  93525. * @returns the effect defines string
  93526. */
  93527. getEffectDefines(): string;
  93528. /**
  93529. * Returns a string representing the class name
  93530. * @returns a string containing the class name
  93531. */
  93532. getClassName(): string;
  93533. /**
  93534. * Serializes the particle system to a JSON object.
  93535. * @returns the JSON object
  93536. */
  93537. serialize(): any;
  93538. /**
  93539. * Parse properties from a JSON object
  93540. * @param serializationObject defines the JSON object
  93541. * @param scene defines the hosting scene
  93542. */
  93543. parse(serializationObject: any, scene: Nullable<Scene>): void;
  93544. }
  93545. }
  93546. declare module BABYLON {
  93547. /**
  93548. * Particle emitter emitting particles from the inside of a box.
  93549. * It emits the particles randomly between 2 given directions.
  93550. */
  93551. export class BoxParticleEmitter implements IParticleEmitterType {
  93552. /**
  93553. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93554. */
  93555. direction1: Vector3;
  93556. /**
  93557. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93558. */
  93559. direction2: Vector3;
  93560. /**
  93561. * 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.
  93562. */
  93563. minEmitBox: Vector3;
  93564. /**
  93565. * 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.
  93566. */
  93567. maxEmitBox: Vector3;
  93568. /**
  93569. * Creates a new instance BoxParticleEmitter
  93570. */
  93571. constructor();
  93572. /**
  93573. * Called by the particle System when the direction is computed for the created particle.
  93574. * @param worldMatrix is the world matrix of the particle system
  93575. * @param directionToUpdate is the direction vector to update with the result
  93576. * @param particle is the particle we are computed the direction for
  93577. * @param isLocal defines if the direction should be set in local space
  93578. */
  93579. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93580. /**
  93581. * Called by the particle System when the position is computed for the created particle.
  93582. * @param worldMatrix is the world matrix of the particle system
  93583. * @param positionToUpdate is the position vector to update with the result
  93584. * @param particle is the particle we are computed the position for
  93585. * @param isLocal defines if the position should be set in local space
  93586. */
  93587. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93588. /**
  93589. * Clones the current emitter and returns a copy of it
  93590. * @returns the new emitter
  93591. */
  93592. clone(): BoxParticleEmitter;
  93593. /**
  93594. * Called by the GPUParticleSystem to setup the update shader
  93595. * @param effect defines the update shader
  93596. */
  93597. applyToShader(effect: Effect): void;
  93598. /**
  93599. * Returns a string to use to update the GPU particles update shader
  93600. * @returns a string containng the defines string
  93601. */
  93602. getEffectDefines(): string;
  93603. /**
  93604. * Returns the string "BoxParticleEmitter"
  93605. * @returns a string containing the class name
  93606. */
  93607. getClassName(): string;
  93608. /**
  93609. * Serializes the particle system to a JSON object.
  93610. * @returns the JSON object
  93611. */
  93612. serialize(): any;
  93613. /**
  93614. * Parse properties from a JSON object
  93615. * @param serializationObject defines the JSON object
  93616. */
  93617. parse(serializationObject: any): void;
  93618. }
  93619. }
  93620. declare module BABYLON {
  93621. /**
  93622. * Particle emitter emitting particles from the inside of a cone.
  93623. * It emits the particles alongside the cone volume from the base to the particle.
  93624. * The emission direction might be randomized.
  93625. */
  93626. export class ConeParticleEmitter implements IParticleEmitterType {
  93627. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  93628. directionRandomizer: number;
  93629. private _radius;
  93630. private _angle;
  93631. private _height;
  93632. /**
  93633. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  93634. */
  93635. radiusRange: number;
  93636. /**
  93637. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  93638. */
  93639. heightRange: number;
  93640. /**
  93641. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  93642. */
  93643. emitFromSpawnPointOnly: boolean;
  93644. /**
  93645. * Gets or sets the radius of the emission cone
  93646. */
  93647. get radius(): number;
  93648. set radius(value: number);
  93649. /**
  93650. * Gets or sets the angle of the emission cone
  93651. */
  93652. get angle(): number;
  93653. set angle(value: number);
  93654. private _buildHeight;
  93655. /**
  93656. * Creates a new instance ConeParticleEmitter
  93657. * @param radius the radius of the emission cone (1 by default)
  93658. * @param angle the cone base angle (PI by default)
  93659. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  93660. */
  93661. constructor(radius?: number, angle?: number,
  93662. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  93663. directionRandomizer?: number);
  93664. /**
  93665. * Called by the particle System when the direction is computed for the created particle.
  93666. * @param worldMatrix is the world matrix of the particle system
  93667. * @param directionToUpdate is the direction vector to update with the result
  93668. * @param particle is the particle we are computed the direction for
  93669. * @param isLocal defines if the direction should be set in local space
  93670. */
  93671. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93672. /**
  93673. * Called by the particle System when the position is computed for the created particle.
  93674. * @param worldMatrix is the world matrix of the particle system
  93675. * @param positionToUpdate is the position vector to update with the result
  93676. * @param particle is the particle we are computed the position for
  93677. * @param isLocal defines if the position should be set in local space
  93678. */
  93679. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93680. /**
  93681. * Clones the current emitter and returns a copy of it
  93682. * @returns the new emitter
  93683. */
  93684. clone(): ConeParticleEmitter;
  93685. /**
  93686. * Called by the GPUParticleSystem to setup the update shader
  93687. * @param effect defines the update shader
  93688. */
  93689. applyToShader(effect: Effect): void;
  93690. /**
  93691. * Returns a string to use to update the GPU particles update shader
  93692. * @returns a string containng the defines string
  93693. */
  93694. getEffectDefines(): string;
  93695. /**
  93696. * Returns the string "ConeParticleEmitter"
  93697. * @returns a string containing the class name
  93698. */
  93699. getClassName(): string;
  93700. /**
  93701. * Serializes the particle system to a JSON object.
  93702. * @returns the JSON object
  93703. */
  93704. serialize(): any;
  93705. /**
  93706. * Parse properties from a JSON object
  93707. * @param serializationObject defines the JSON object
  93708. */
  93709. parse(serializationObject: any): void;
  93710. }
  93711. }
  93712. declare module BABYLON {
  93713. /**
  93714. * Particle emitter emitting particles from the inside of a cylinder.
  93715. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  93716. */
  93717. export class CylinderParticleEmitter implements IParticleEmitterType {
  93718. /**
  93719. * The radius of the emission cylinder.
  93720. */
  93721. radius: number;
  93722. /**
  93723. * The height of the emission cylinder.
  93724. */
  93725. height: number;
  93726. /**
  93727. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93728. */
  93729. radiusRange: number;
  93730. /**
  93731. * How much to randomize the particle direction [0-1].
  93732. */
  93733. directionRandomizer: number;
  93734. /**
  93735. * Creates a new instance CylinderParticleEmitter
  93736. * @param radius the radius of the emission cylinder (1 by default)
  93737. * @param height the height of the emission cylinder (1 by default)
  93738. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93739. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93740. */
  93741. constructor(
  93742. /**
  93743. * The radius of the emission cylinder.
  93744. */
  93745. radius?: number,
  93746. /**
  93747. * The height of the emission cylinder.
  93748. */
  93749. height?: number,
  93750. /**
  93751. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93752. */
  93753. radiusRange?: number,
  93754. /**
  93755. * How much to randomize the particle direction [0-1].
  93756. */
  93757. directionRandomizer?: number);
  93758. /**
  93759. * Called by the particle System when the direction is computed for the created particle.
  93760. * @param worldMatrix is the world matrix of the particle system
  93761. * @param directionToUpdate is the direction vector to update with the result
  93762. * @param particle is the particle we are computed the direction for
  93763. * @param isLocal defines if the direction should be set in local space
  93764. */
  93765. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93766. /**
  93767. * Called by the particle System when the position is computed for the created particle.
  93768. * @param worldMatrix is the world matrix of the particle system
  93769. * @param positionToUpdate is the position vector to update with the result
  93770. * @param particle is the particle we are computed the position for
  93771. * @param isLocal defines if the position should be set in local space
  93772. */
  93773. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93774. /**
  93775. * Clones the current emitter and returns a copy of it
  93776. * @returns the new emitter
  93777. */
  93778. clone(): CylinderParticleEmitter;
  93779. /**
  93780. * Called by the GPUParticleSystem to setup the update shader
  93781. * @param effect defines the update shader
  93782. */
  93783. applyToShader(effect: Effect): void;
  93784. /**
  93785. * Returns a string to use to update the GPU particles update shader
  93786. * @returns a string containng the defines string
  93787. */
  93788. getEffectDefines(): string;
  93789. /**
  93790. * Returns the string "CylinderParticleEmitter"
  93791. * @returns a string containing the class name
  93792. */
  93793. getClassName(): string;
  93794. /**
  93795. * Serializes the particle system to a JSON object.
  93796. * @returns the JSON object
  93797. */
  93798. serialize(): any;
  93799. /**
  93800. * Parse properties from a JSON object
  93801. * @param serializationObject defines the JSON object
  93802. */
  93803. parse(serializationObject: any): void;
  93804. }
  93805. /**
  93806. * Particle emitter emitting particles from the inside of a cylinder.
  93807. * It emits the particles randomly between two vectors.
  93808. */
  93809. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  93810. /**
  93811. * The min limit of the emission direction.
  93812. */
  93813. direction1: Vector3;
  93814. /**
  93815. * The max limit of the emission direction.
  93816. */
  93817. direction2: Vector3;
  93818. /**
  93819. * Creates a new instance CylinderDirectedParticleEmitter
  93820. * @param radius the radius of the emission cylinder (1 by default)
  93821. * @param height the height of the emission cylinder (1 by default)
  93822. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93823. * @param direction1 the min limit of the emission direction (up vector by default)
  93824. * @param direction2 the max limit of the emission direction (up vector by default)
  93825. */
  93826. constructor(radius?: number, height?: number, radiusRange?: number,
  93827. /**
  93828. * The min limit of the emission direction.
  93829. */
  93830. direction1?: Vector3,
  93831. /**
  93832. * The max limit of the emission direction.
  93833. */
  93834. direction2?: Vector3);
  93835. /**
  93836. * Called by the particle System when the direction is computed for the created particle.
  93837. * @param worldMatrix is the world matrix of the particle system
  93838. * @param directionToUpdate is the direction vector to update with the result
  93839. * @param particle is the particle we are computed the direction for
  93840. */
  93841. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  93842. /**
  93843. * Clones the current emitter and returns a copy of it
  93844. * @returns the new emitter
  93845. */
  93846. clone(): CylinderDirectedParticleEmitter;
  93847. /**
  93848. * Called by the GPUParticleSystem to setup the update shader
  93849. * @param effect defines the update shader
  93850. */
  93851. applyToShader(effect: Effect): void;
  93852. /**
  93853. * Returns a string to use to update the GPU particles update shader
  93854. * @returns a string containng the defines string
  93855. */
  93856. getEffectDefines(): string;
  93857. /**
  93858. * Returns the string "CylinderDirectedParticleEmitter"
  93859. * @returns a string containing the class name
  93860. */
  93861. getClassName(): string;
  93862. /**
  93863. * Serializes the particle system to a JSON object.
  93864. * @returns the JSON object
  93865. */
  93866. serialize(): any;
  93867. /**
  93868. * Parse properties from a JSON object
  93869. * @param serializationObject defines the JSON object
  93870. */
  93871. parse(serializationObject: any): void;
  93872. }
  93873. }
  93874. declare module BABYLON {
  93875. /**
  93876. * Particle emitter emitting particles from the inside of a hemisphere.
  93877. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  93878. */
  93879. export class HemisphericParticleEmitter implements IParticleEmitterType {
  93880. /**
  93881. * The radius of the emission hemisphere.
  93882. */
  93883. radius: number;
  93884. /**
  93885. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93886. */
  93887. radiusRange: number;
  93888. /**
  93889. * How much to randomize the particle direction [0-1].
  93890. */
  93891. directionRandomizer: number;
  93892. /**
  93893. * Creates a new instance HemisphericParticleEmitter
  93894. * @param radius the radius of the emission hemisphere (1 by default)
  93895. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93896. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93897. */
  93898. constructor(
  93899. /**
  93900. * The radius of the emission hemisphere.
  93901. */
  93902. radius?: number,
  93903. /**
  93904. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93905. */
  93906. radiusRange?: number,
  93907. /**
  93908. * How much to randomize the particle direction [0-1].
  93909. */
  93910. directionRandomizer?: number);
  93911. /**
  93912. * Called by the particle System when the direction is computed for the created particle.
  93913. * @param worldMatrix is the world matrix of the particle system
  93914. * @param directionToUpdate is the direction vector to update with the result
  93915. * @param particle is the particle we are computed the direction for
  93916. * @param isLocal defines if the direction should be set in local space
  93917. */
  93918. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93919. /**
  93920. * Called by the particle System when the position is computed for the created particle.
  93921. * @param worldMatrix is the world matrix of the particle system
  93922. * @param positionToUpdate is the position vector to update with the result
  93923. * @param particle is the particle we are computed the position for
  93924. * @param isLocal defines if the position should be set in local space
  93925. */
  93926. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93927. /**
  93928. * Clones the current emitter and returns a copy of it
  93929. * @returns the new emitter
  93930. */
  93931. clone(): HemisphericParticleEmitter;
  93932. /**
  93933. * Called by the GPUParticleSystem to setup the update shader
  93934. * @param effect defines the update shader
  93935. */
  93936. applyToShader(effect: Effect): void;
  93937. /**
  93938. * Returns a string to use to update the GPU particles update shader
  93939. * @returns a string containng the defines string
  93940. */
  93941. getEffectDefines(): string;
  93942. /**
  93943. * Returns the string "HemisphericParticleEmitter"
  93944. * @returns a string containing the class name
  93945. */
  93946. getClassName(): string;
  93947. /**
  93948. * Serializes the particle system to a JSON object.
  93949. * @returns the JSON object
  93950. */
  93951. serialize(): any;
  93952. /**
  93953. * Parse properties from a JSON object
  93954. * @param serializationObject defines the JSON object
  93955. */
  93956. parse(serializationObject: any): void;
  93957. }
  93958. }
  93959. declare module BABYLON {
  93960. /**
  93961. * Particle emitter emitting particles from a point.
  93962. * It emits the particles randomly between 2 given directions.
  93963. */
  93964. export class PointParticleEmitter implements IParticleEmitterType {
  93965. /**
  93966. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93967. */
  93968. direction1: Vector3;
  93969. /**
  93970. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93971. */
  93972. direction2: Vector3;
  93973. /**
  93974. * Creates a new instance PointParticleEmitter
  93975. */
  93976. constructor();
  93977. /**
  93978. * Called by the particle System when the direction is computed for the created particle.
  93979. * @param worldMatrix is the world matrix of the particle system
  93980. * @param directionToUpdate is the direction vector to update with the result
  93981. * @param particle is the particle we are computed the direction for
  93982. * @param isLocal defines if the direction should be set in local space
  93983. */
  93984. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93985. /**
  93986. * Called by the particle System when the position is computed for the created particle.
  93987. * @param worldMatrix is the world matrix of the particle system
  93988. * @param positionToUpdate is the position vector to update with the result
  93989. * @param particle is the particle we are computed the position for
  93990. * @param isLocal defines if the position should be set in local space
  93991. */
  93992. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93993. /**
  93994. * Clones the current emitter and returns a copy of it
  93995. * @returns the new emitter
  93996. */
  93997. clone(): PointParticleEmitter;
  93998. /**
  93999. * Called by the GPUParticleSystem to setup the update shader
  94000. * @param effect defines the update shader
  94001. */
  94002. applyToShader(effect: Effect): void;
  94003. /**
  94004. * Returns a string to use to update the GPU particles update shader
  94005. * @returns a string containng the defines string
  94006. */
  94007. getEffectDefines(): string;
  94008. /**
  94009. * Returns the string "PointParticleEmitter"
  94010. * @returns a string containing the class name
  94011. */
  94012. getClassName(): string;
  94013. /**
  94014. * Serializes the particle system to a JSON object.
  94015. * @returns the JSON object
  94016. */
  94017. serialize(): any;
  94018. /**
  94019. * Parse properties from a JSON object
  94020. * @param serializationObject defines the JSON object
  94021. */
  94022. parse(serializationObject: any): void;
  94023. }
  94024. }
  94025. declare module BABYLON {
  94026. /**
  94027. * Particle emitter emitting particles from the inside of a sphere.
  94028. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  94029. */
  94030. export class SphereParticleEmitter implements IParticleEmitterType {
  94031. /**
  94032. * The radius of the emission sphere.
  94033. */
  94034. radius: number;
  94035. /**
  94036. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  94037. */
  94038. radiusRange: number;
  94039. /**
  94040. * How much to randomize the particle direction [0-1].
  94041. */
  94042. directionRandomizer: number;
  94043. /**
  94044. * Creates a new instance SphereParticleEmitter
  94045. * @param radius the radius of the emission sphere (1 by default)
  94046. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  94047. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  94048. */
  94049. constructor(
  94050. /**
  94051. * The radius of the emission sphere.
  94052. */
  94053. radius?: number,
  94054. /**
  94055. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  94056. */
  94057. radiusRange?: number,
  94058. /**
  94059. * How much to randomize the particle direction [0-1].
  94060. */
  94061. directionRandomizer?: number);
  94062. /**
  94063. * Called by the particle System when the direction is computed for the created particle.
  94064. * @param worldMatrix is the world matrix of the particle system
  94065. * @param directionToUpdate is the direction vector to update with the result
  94066. * @param particle is the particle we are computed the direction for
  94067. * @param isLocal defines if the direction should be set in local space
  94068. */
  94069. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94070. /**
  94071. * Called by the particle System when the position is computed for the created particle.
  94072. * @param worldMatrix is the world matrix of the particle system
  94073. * @param positionToUpdate is the position vector to update with the result
  94074. * @param particle is the particle we are computed the position for
  94075. * @param isLocal defines if the position should be set in local space
  94076. */
  94077. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94078. /**
  94079. * Clones the current emitter and returns a copy of it
  94080. * @returns the new emitter
  94081. */
  94082. clone(): SphereParticleEmitter;
  94083. /**
  94084. * Called by the GPUParticleSystem to setup the update shader
  94085. * @param effect defines the update shader
  94086. */
  94087. applyToShader(effect: Effect): void;
  94088. /**
  94089. * Returns a string to use to update the GPU particles update shader
  94090. * @returns a string containng the defines string
  94091. */
  94092. getEffectDefines(): string;
  94093. /**
  94094. * Returns the string "SphereParticleEmitter"
  94095. * @returns a string containing the class name
  94096. */
  94097. getClassName(): string;
  94098. /**
  94099. * Serializes the particle system to a JSON object.
  94100. * @returns the JSON object
  94101. */
  94102. serialize(): any;
  94103. /**
  94104. * Parse properties from a JSON object
  94105. * @param serializationObject defines the JSON object
  94106. */
  94107. parse(serializationObject: any): void;
  94108. }
  94109. /**
  94110. * Particle emitter emitting particles from the inside of a sphere.
  94111. * It emits the particles randomly between two vectors.
  94112. */
  94113. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  94114. /**
  94115. * The min limit of the emission direction.
  94116. */
  94117. direction1: Vector3;
  94118. /**
  94119. * The max limit of the emission direction.
  94120. */
  94121. direction2: Vector3;
  94122. /**
  94123. * Creates a new instance SphereDirectedParticleEmitter
  94124. * @param radius the radius of the emission sphere (1 by default)
  94125. * @param direction1 the min limit of the emission direction (up vector by default)
  94126. * @param direction2 the max limit of the emission direction (up vector by default)
  94127. */
  94128. constructor(radius?: number,
  94129. /**
  94130. * The min limit of the emission direction.
  94131. */
  94132. direction1?: Vector3,
  94133. /**
  94134. * The max limit of the emission direction.
  94135. */
  94136. direction2?: Vector3);
  94137. /**
  94138. * Called by the particle System when the direction is computed for the created particle.
  94139. * @param worldMatrix is the world matrix of the particle system
  94140. * @param directionToUpdate is the direction vector to update with the result
  94141. * @param particle is the particle we are computed the direction for
  94142. */
  94143. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  94144. /**
  94145. * Clones the current emitter and returns a copy of it
  94146. * @returns the new emitter
  94147. */
  94148. clone(): SphereDirectedParticleEmitter;
  94149. /**
  94150. * Called by the GPUParticleSystem to setup the update shader
  94151. * @param effect defines the update shader
  94152. */
  94153. applyToShader(effect: Effect): void;
  94154. /**
  94155. * Returns a string to use to update the GPU particles update shader
  94156. * @returns a string containng the defines string
  94157. */
  94158. getEffectDefines(): string;
  94159. /**
  94160. * Returns the string "SphereDirectedParticleEmitter"
  94161. * @returns a string containing the class name
  94162. */
  94163. getClassName(): string;
  94164. /**
  94165. * Serializes the particle system to a JSON object.
  94166. * @returns the JSON object
  94167. */
  94168. serialize(): any;
  94169. /**
  94170. * Parse properties from a JSON object
  94171. * @param serializationObject defines the JSON object
  94172. */
  94173. parse(serializationObject: any): void;
  94174. }
  94175. }
  94176. declare module BABYLON {
  94177. /**
  94178. * Particle emitter emitting particles from a custom list of positions.
  94179. */
  94180. export class CustomParticleEmitter implements IParticleEmitterType {
  94181. /**
  94182. * Gets or sets the position generator that will create the inital position of each particle.
  94183. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  94184. */
  94185. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  94186. /**
  94187. * Gets or sets the destination generator that will create the final destination of each particle.
  94188. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  94189. */
  94190. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  94191. /**
  94192. * Creates a new instance CustomParticleEmitter
  94193. */
  94194. constructor();
  94195. /**
  94196. * Called by the particle System when the direction is computed for the created particle.
  94197. * @param worldMatrix is the world matrix of the particle system
  94198. * @param directionToUpdate is the direction vector to update with the result
  94199. * @param particle is the particle we are computed the direction for
  94200. * @param isLocal defines if the direction should be set in local space
  94201. */
  94202. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94203. /**
  94204. * Called by the particle System when the position is computed for the created particle.
  94205. * @param worldMatrix is the world matrix of the particle system
  94206. * @param positionToUpdate is the position vector to update with the result
  94207. * @param particle is the particle we are computed the position for
  94208. * @param isLocal defines if the position should be set in local space
  94209. */
  94210. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94211. /**
  94212. * Clones the current emitter and returns a copy of it
  94213. * @returns the new emitter
  94214. */
  94215. clone(): CustomParticleEmitter;
  94216. /**
  94217. * Called by the GPUParticleSystem to setup the update shader
  94218. * @param effect defines the update shader
  94219. */
  94220. applyToShader(effect: Effect): void;
  94221. /**
  94222. * Returns a string to use to update the GPU particles update shader
  94223. * @returns a string containng the defines string
  94224. */
  94225. getEffectDefines(): string;
  94226. /**
  94227. * Returns the string "PointParticleEmitter"
  94228. * @returns a string containing the class name
  94229. */
  94230. getClassName(): string;
  94231. /**
  94232. * Serializes the particle system to a JSON object.
  94233. * @returns the JSON object
  94234. */
  94235. serialize(): any;
  94236. /**
  94237. * Parse properties from a JSON object
  94238. * @param serializationObject defines the JSON object
  94239. */
  94240. parse(serializationObject: any): void;
  94241. }
  94242. }
  94243. declare module BABYLON {
  94244. /**
  94245. * Particle emitter emitting particles from the inside of a box.
  94246. * It emits the particles randomly between 2 given directions.
  94247. */
  94248. export class MeshParticleEmitter implements IParticleEmitterType {
  94249. private _indices;
  94250. private _positions;
  94251. private _normals;
  94252. private _storedNormal;
  94253. private _mesh;
  94254. /**
  94255. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  94256. */
  94257. direction1: Vector3;
  94258. /**
  94259. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  94260. */
  94261. direction2: Vector3;
  94262. /**
  94263. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  94264. */
  94265. useMeshNormalsForDirection: boolean;
  94266. /** Defines the mesh to use as source */
  94267. get mesh(): Nullable<AbstractMesh>;
  94268. set mesh(value: Nullable<AbstractMesh>);
  94269. /**
  94270. * Creates a new instance MeshParticleEmitter
  94271. * @param mesh defines the mesh to use as source
  94272. */
  94273. constructor(mesh?: Nullable<AbstractMesh>);
  94274. /**
  94275. * Called by the particle System when the direction is computed for the created particle.
  94276. * @param worldMatrix is the world matrix of the particle system
  94277. * @param directionToUpdate is the direction vector to update with the result
  94278. * @param particle is the particle we are computed the direction for
  94279. * @param isLocal defines if the direction should be set in local space
  94280. */
  94281. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94282. /**
  94283. * Called by the particle System when the position is computed for the created particle.
  94284. * @param worldMatrix is the world matrix of the particle system
  94285. * @param positionToUpdate is the position vector to update with the result
  94286. * @param particle is the particle we are computed the position for
  94287. * @param isLocal defines if the position should be set in local space
  94288. */
  94289. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  94290. /**
  94291. * Clones the current emitter and returns a copy of it
  94292. * @returns the new emitter
  94293. */
  94294. clone(): MeshParticleEmitter;
  94295. /**
  94296. * Called by the GPUParticleSystem to setup the update shader
  94297. * @param effect defines the update shader
  94298. */
  94299. applyToShader(effect: Effect): void;
  94300. /**
  94301. * Returns a string to use to update the GPU particles update shader
  94302. * @returns a string containng the defines string
  94303. */
  94304. getEffectDefines(): string;
  94305. /**
  94306. * Returns the string "BoxParticleEmitter"
  94307. * @returns a string containing the class name
  94308. */
  94309. getClassName(): string;
  94310. /**
  94311. * Serializes the particle system to a JSON object.
  94312. * @returns the JSON object
  94313. */
  94314. serialize(): any;
  94315. /**
  94316. * Parse properties from a JSON object
  94317. * @param serializationObject defines the JSON object
  94318. * @param scene defines the hosting scene
  94319. */
  94320. parse(serializationObject: any, scene: Nullable<Scene>): void;
  94321. }
  94322. }
  94323. declare module BABYLON {
  94324. /**
  94325. * Interface representing a particle system in Babylon.js.
  94326. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  94327. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  94328. */
  94329. export interface IParticleSystem {
  94330. /**
  94331. * List of animations used by the particle system.
  94332. */
  94333. animations: Animation[];
  94334. /**
  94335. * The id of the Particle system.
  94336. */
  94337. id: string;
  94338. /**
  94339. * The name of the Particle system.
  94340. */
  94341. name: string;
  94342. /**
  94343. * The emitter represents the Mesh or position we are attaching the particle system to.
  94344. */
  94345. emitter: Nullable<AbstractMesh | Vector3>;
  94346. /**
  94347. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  94348. */
  94349. isBillboardBased: boolean;
  94350. /**
  94351. * The rendering group used by the Particle system to chose when to render.
  94352. */
  94353. renderingGroupId: number;
  94354. /**
  94355. * The layer mask we are rendering the particles through.
  94356. */
  94357. layerMask: number;
  94358. /**
  94359. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  94360. */
  94361. updateSpeed: number;
  94362. /**
  94363. * The amount of time the particle system is running (depends of the overall update speed).
  94364. */
  94365. targetStopDuration: number;
  94366. /**
  94367. * The texture used to render each particle. (this can be a spritesheet)
  94368. */
  94369. particleTexture: Nullable<BaseTexture>;
  94370. /**
  94371. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  94372. */
  94373. blendMode: number;
  94374. /**
  94375. * Minimum life time of emitting particles.
  94376. */
  94377. minLifeTime: number;
  94378. /**
  94379. * Maximum life time of emitting particles.
  94380. */
  94381. maxLifeTime: number;
  94382. /**
  94383. * Minimum Size of emitting particles.
  94384. */
  94385. minSize: number;
  94386. /**
  94387. * Maximum Size of emitting particles.
  94388. */
  94389. maxSize: number;
  94390. /**
  94391. * Minimum scale of emitting particles on X axis.
  94392. */
  94393. minScaleX: number;
  94394. /**
  94395. * Maximum scale of emitting particles on X axis.
  94396. */
  94397. maxScaleX: number;
  94398. /**
  94399. * Minimum scale of emitting particles on Y axis.
  94400. */
  94401. minScaleY: number;
  94402. /**
  94403. * Maximum scale of emitting particles on Y axis.
  94404. */
  94405. maxScaleY: number;
  94406. /**
  94407. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  94408. */
  94409. color1: Color4;
  94410. /**
  94411. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  94412. */
  94413. color2: Color4;
  94414. /**
  94415. * Color the particle will have at the end of its lifetime.
  94416. */
  94417. colorDead: Color4;
  94418. /**
  94419. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  94420. */
  94421. emitRate: number;
  94422. /**
  94423. * You can use gravity if you want to give an orientation to your particles.
  94424. */
  94425. gravity: Vector3;
  94426. /**
  94427. * Minimum power of emitting particles.
  94428. */
  94429. minEmitPower: number;
  94430. /**
  94431. * Maximum power of emitting particles.
  94432. */
  94433. maxEmitPower: number;
  94434. /**
  94435. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  94436. */
  94437. minAngularSpeed: number;
  94438. /**
  94439. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  94440. */
  94441. maxAngularSpeed: number;
  94442. /**
  94443. * Gets or sets the minimal initial rotation in radians.
  94444. */
  94445. minInitialRotation: number;
  94446. /**
  94447. * Gets or sets the maximal initial rotation in radians.
  94448. */
  94449. maxInitialRotation: number;
  94450. /**
  94451. * The particle emitter type defines the emitter used by the particle system.
  94452. * It can be for example box, sphere, or cone...
  94453. */
  94454. particleEmitterType: Nullable<IParticleEmitterType>;
  94455. /**
  94456. * Defines the delay in milliseconds before starting the system (0 by default)
  94457. */
  94458. startDelay: number;
  94459. /**
  94460. * 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
  94461. */
  94462. preWarmCycles: number;
  94463. /**
  94464. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  94465. */
  94466. preWarmStepOffset: number;
  94467. /**
  94468. * 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)
  94469. */
  94470. spriteCellChangeSpeed: number;
  94471. /**
  94472. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  94473. */
  94474. startSpriteCellID: number;
  94475. /**
  94476. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  94477. */
  94478. endSpriteCellID: number;
  94479. /**
  94480. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  94481. */
  94482. spriteCellWidth: number;
  94483. /**
  94484. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  94485. */
  94486. spriteCellHeight: number;
  94487. /**
  94488. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  94489. */
  94490. spriteRandomStartCell: boolean;
  94491. /**
  94492. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  94493. */
  94494. isAnimationSheetEnabled: boolean;
  94495. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  94496. translationPivot: Vector2;
  94497. /**
  94498. * Gets or sets a texture used to add random noise to particle positions
  94499. */
  94500. noiseTexture: Nullable<BaseTexture>;
  94501. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  94502. noiseStrength: Vector3;
  94503. /**
  94504. * Gets or sets the billboard mode to use when isBillboardBased = true.
  94505. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  94506. */
  94507. billboardMode: number;
  94508. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  94509. limitVelocityDamping: number;
  94510. /**
  94511. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  94512. */
  94513. beginAnimationOnStart: boolean;
  94514. /**
  94515. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  94516. */
  94517. beginAnimationFrom: number;
  94518. /**
  94519. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  94520. */
  94521. beginAnimationTo: number;
  94522. /**
  94523. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  94524. */
  94525. beginAnimationLoop: boolean;
  94526. /**
  94527. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  94528. */
  94529. disposeOnStop: boolean;
  94530. /**
  94531. * Specifies if the particles are updated in emitter local space or world space
  94532. */
  94533. isLocal: boolean;
  94534. /** Snippet ID if the particle system was created from the snippet server */
  94535. snippetId: string;
  94536. /** Gets or sets a matrix to use to compute projection */
  94537. defaultProjectionMatrix: Matrix;
  94538. /**
  94539. * Gets the maximum number of particles active at the same time.
  94540. * @returns The max number of active particles.
  94541. */
  94542. getCapacity(): number;
  94543. /**
  94544. * Gets the number of particles active at the same time.
  94545. * @returns The number of active particles.
  94546. */
  94547. getActiveCount(): number;
  94548. /**
  94549. * Gets if the system has been started. (Note: this will still be true after stop is called)
  94550. * @returns True if it has been started, otherwise false.
  94551. */
  94552. isStarted(): boolean;
  94553. /**
  94554. * Animates the particle system for this frame.
  94555. */
  94556. animate(): void;
  94557. /**
  94558. * Renders the particle system in its current state.
  94559. * @returns the current number of particles
  94560. */
  94561. render(): number;
  94562. /**
  94563. * Dispose the particle system and frees its associated resources.
  94564. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  94565. */
  94566. dispose(disposeTexture?: boolean): void;
  94567. /**
  94568. * An event triggered when the system is disposed
  94569. */
  94570. onDisposeObservable: Observable<IParticleSystem>;
  94571. /**
  94572. * Clones the particle system.
  94573. * @param name The name of the cloned object
  94574. * @param newEmitter The new emitter to use
  94575. * @returns the cloned particle system
  94576. */
  94577. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  94578. /**
  94579. * Serializes the particle system to a JSON object
  94580. * @param serializeTexture defines if the texture must be serialized as well
  94581. * @returns the JSON object
  94582. */
  94583. serialize(serializeTexture: boolean): any;
  94584. /**
  94585. * Rebuild the particle system
  94586. */
  94587. rebuild(): void;
  94588. /** Force the system to rebuild all gradients that need to be resync */
  94589. forceRefreshGradients(): void;
  94590. /**
  94591. * Starts the particle system and begins to emit
  94592. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  94593. */
  94594. start(delay?: number): void;
  94595. /**
  94596. * Stops the particle system.
  94597. */
  94598. stop(): void;
  94599. /**
  94600. * Remove all active particles
  94601. */
  94602. reset(): void;
  94603. /**
  94604. * Gets a boolean indicating that the system is stopping
  94605. * @returns true if the system is currently stopping
  94606. */
  94607. isStopping(): boolean;
  94608. /**
  94609. * Is this system ready to be used/rendered
  94610. * @return true if the system is ready
  94611. */
  94612. isReady(): boolean;
  94613. /**
  94614. * Returns the string "ParticleSystem"
  94615. * @returns a string containing the class name
  94616. */
  94617. getClassName(): string;
  94618. /**
  94619. * Gets the custom effect used to render the particles
  94620. * @param blendMode Blend mode for which the effect should be retrieved
  94621. * @returns The effect
  94622. */
  94623. getCustomEffect(blendMode: number): Nullable<Effect>;
  94624. /**
  94625. * Sets the custom effect used to render the particles
  94626. * @param effect The effect to set
  94627. * @param blendMode Blend mode for which the effect should be set
  94628. */
  94629. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  94630. /**
  94631. * Fill the defines array according to the current settings of the particle system
  94632. * @param defines Array to be updated
  94633. * @param blendMode blend mode to take into account when updating the array
  94634. */
  94635. fillDefines(defines: Array<string>, blendMode: number): void;
  94636. /**
  94637. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  94638. * @param uniforms Uniforms array to fill
  94639. * @param attributes Attributes array to fill
  94640. * @param samplers Samplers array to fill
  94641. */
  94642. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  94643. /**
  94644. * Observable that will be called just before the particles are drawn
  94645. */
  94646. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  94647. /**
  94648. * Gets the name of the particle vertex shader
  94649. */
  94650. vertexShaderName: string;
  94651. /**
  94652. * Adds a new color gradient
  94653. * @param gradient defines the gradient to use (between 0 and 1)
  94654. * @param color1 defines the color to affect to the specified gradient
  94655. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  94656. * @returns the current particle system
  94657. */
  94658. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  94659. /**
  94660. * Remove a specific color gradient
  94661. * @param gradient defines the gradient to remove
  94662. * @returns the current particle system
  94663. */
  94664. removeColorGradient(gradient: number): IParticleSystem;
  94665. /**
  94666. * Adds a new size gradient
  94667. * @param gradient defines the gradient to use (between 0 and 1)
  94668. * @param factor defines the size factor to affect to the specified gradient
  94669. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94670. * @returns the current particle system
  94671. */
  94672. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94673. /**
  94674. * Remove a specific size gradient
  94675. * @param gradient defines the gradient to remove
  94676. * @returns the current particle system
  94677. */
  94678. removeSizeGradient(gradient: number): IParticleSystem;
  94679. /**
  94680. * Gets the current list of color gradients.
  94681. * You must use addColorGradient and removeColorGradient to udpate this list
  94682. * @returns the list of color gradients
  94683. */
  94684. getColorGradients(): Nullable<Array<ColorGradient>>;
  94685. /**
  94686. * Gets the current list of size gradients.
  94687. * You must use addSizeGradient and removeSizeGradient to udpate this list
  94688. * @returns the list of size gradients
  94689. */
  94690. getSizeGradients(): Nullable<Array<FactorGradient>>;
  94691. /**
  94692. * Gets the current list of angular speed gradients.
  94693. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  94694. * @returns the list of angular speed gradients
  94695. */
  94696. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  94697. /**
  94698. * Adds a new angular speed gradient
  94699. * @param gradient defines the gradient to use (between 0 and 1)
  94700. * @param factor defines the angular speed to affect to the specified gradient
  94701. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94702. * @returns the current particle system
  94703. */
  94704. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94705. /**
  94706. * Remove a specific angular speed gradient
  94707. * @param gradient defines the gradient to remove
  94708. * @returns the current particle system
  94709. */
  94710. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  94711. /**
  94712. * Gets the current list of velocity gradients.
  94713. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  94714. * @returns the list of velocity gradients
  94715. */
  94716. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  94717. /**
  94718. * Adds a new velocity gradient
  94719. * @param gradient defines the gradient to use (between 0 and 1)
  94720. * @param factor defines the velocity to affect to the specified gradient
  94721. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94722. * @returns the current particle system
  94723. */
  94724. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94725. /**
  94726. * Remove a specific velocity gradient
  94727. * @param gradient defines the gradient to remove
  94728. * @returns the current particle system
  94729. */
  94730. removeVelocityGradient(gradient: number): IParticleSystem;
  94731. /**
  94732. * Gets the current list of limit velocity gradients.
  94733. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  94734. * @returns the list of limit velocity gradients
  94735. */
  94736. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  94737. /**
  94738. * Adds a new limit velocity gradient
  94739. * @param gradient defines the gradient to use (between 0 and 1)
  94740. * @param factor defines the limit velocity to affect to the specified gradient
  94741. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94742. * @returns the current particle system
  94743. */
  94744. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94745. /**
  94746. * Remove a specific limit velocity gradient
  94747. * @param gradient defines the gradient to remove
  94748. * @returns the current particle system
  94749. */
  94750. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  94751. /**
  94752. * Adds a new drag gradient
  94753. * @param gradient defines the gradient to use (between 0 and 1)
  94754. * @param factor defines the drag to affect to the specified gradient
  94755. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94756. * @returns the current particle system
  94757. */
  94758. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94759. /**
  94760. * Remove a specific drag gradient
  94761. * @param gradient defines the gradient to remove
  94762. * @returns the current particle system
  94763. */
  94764. removeDragGradient(gradient: number): IParticleSystem;
  94765. /**
  94766. * Gets the current list of drag gradients.
  94767. * You must use addDragGradient and removeDragGradient to udpate this list
  94768. * @returns the list of drag gradients
  94769. */
  94770. getDragGradients(): Nullable<Array<FactorGradient>>;
  94771. /**
  94772. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  94773. * @param gradient defines the gradient to use (between 0 and 1)
  94774. * @param factor defines the emit rate to affect to the specified gradient
  94775. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94776. * @returns the current particle system
  94777. */
  94778. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94779. /**
  94780. * Remove a specific emit rate gradient
  94781. * @param gradient defines the gradient to remove
  94782. * @returns the current particle system
  94783. */
  94784. removeEmitRateGradient(gradient: number): IParticleSystem;
  94785. /**
  94786. * Gets the current list of emit rate gradients.
  94787. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  94788. * @returns the list of emit rate gradients
  94789. */
  94790. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  94791. /**
  94792. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  94793. * @param gradient defines the gradient to use (between 0 and 1)
  94794. * @param factor defines the start size to affect to the specified gradient
  94795. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94796. * @returns the current particle system
  94797. */
  94798. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94799. /**
  94800. * Remove a specific start size gradient
  94801. * @param gradient defines the gradient to remove
  94802. * @returns the current particle system
  94803. */
  94804. removeStartSizeGradient(gradient: number): IParticleSystem;
  94805. /**
  94806. * Gets the current list of start size gradients.
  94807. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  94808. * @returns the list of start size gradients
  94809. */
  94810. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  94811. /**
  94812. * Adds a new life time gradient
  94813. * @param gradient defines the gradient to use (between 0 and 1)
  94814. * @param factor defines the life time factor to affect to the specified gradient
  94815. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94816. * @returns the current particle system
  94817. */
  94818. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94819. /**
  94820. * Remove a specific life time gradient
  94821. * @param gradient defines the gradient to remove
  94822. * @returns the current particle system
  94823. */
  94824. removeLifeTimeGradient(gradient: number): IParticleSystem;
  94825. /**
  94826. * Gets the current list of life time gradients.
  94827. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  94828. * @returns the list of life time gradients
  94829. */
  94830. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  94831. /**
  94832. * Gets the current list of color gradients.
  94833. * You must use addColorGradient and removeColorGradient to udpate this list
  94834. * @returns the list of color gradients
  94835. */
  94836. getColorGradients(): Nullable<Array<ColorGradient>>;
  94837. /**
  94838. * Adds a new ramp gradient used to remap particle colors
  94839. * @param gradient defines the gradient to use (between 0 and 1)
  94840. * @param color defines the color to affect to the specified gradient
  94841. * @returns the current particle system
  94842. */
  94843. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  94844. /**
  94845. * Gets the current list of ramp gradients.
  94846. * You must use addRampGradient and removeRampGradient to udpate this list
  94847. * @returns the list of ramp gradients
  94848. */
  94849. getRampGradients(): Nullable<Array<Color3Gradient>>;
  94850. /** Gets or sets a boolean indicating that ramp gradients must be used
  94851. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  94852. */
  94853. useRampGradients: boolean;
  94854. /**
  94855. * Adds a new color remap gradient
  94856. * @param gradient defines the gradient to use (between 0 and 1)
  94857. * @param min defines the color remap minimal range
  94858. * @param max defines the color remap maximal range
  94859. * @returns the current particle system
  94860. */
  94861. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  94862. /**
  94863. * Gets the current list of color remap gradients.
  94864. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  94865. * @returns the list of color remap gradients
  94866. */
  94867. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  94868. /**
  94869. * Adds a new alpha remap gradient
  94870. * @param gradient defines the gradient to use (between 0 and 1)
  94871. * @param min defines the alpha remap minimal range
  94872. * @param max defines the alpha remap maximal range
  94873. * @returns the current particle system
  94874. */
  94875. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  94876. /**
  94877. * Gets the current list of alpha remap gradients.
  94878. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  94879. * @returns the list of alpha remap gradients
  94880. */
  94881. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  94882. /**
  94883. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  94884. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  94885. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  94886. * @returns the emitter
  94887. */
  94888. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  94889. /**
  94890. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  94891. * @param radius The radius of the hemisphere to emit from
  94892. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  94893. * @returns the emitter
  94894. */
  94895. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  94896. /**
  94897. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  94898. * @param radius The radius of the sphere to emit from
  94899. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  94900. * @returns the emitter
  94901. */
  94902. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  94903. /**
  94904. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  94905. * @param radius The radius of the sphere to emit from
  94906. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  94907. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  94908. * @returns the emitter
  94909. */
  94910. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  94911. /**
  94912. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  94913. * @param radius The radius of the emission cylinder
  94914. * @param height The height of the emission cylinder
  94915. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  94916. * @param directionRandomizer How much to randomize the particle direction [0-1]
  94917. * @returns the emitter
  94918. */
  94919. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  94920. /**
  94921. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  94922. * @param radius The radius of the cylinder to emit from
  94923. * @param height The height of the emission cylinder
  94924. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  94925. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  94926. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  94927. * @returns the emitter
  94928. */
  94929. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  94930. /**
  94931. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  94932. * @param radius The radius of the cone to emit from
  94933. * @param angle The base angle of the cone
  94934. * @returns the emitter
  94935. */
  94936. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  94937. /**
  94938. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  94939. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  94940. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  94941. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  94942. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  94943. * @returns the emitter
  94944. */
  94945. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  94946. /**
  94947. * Get hosting scene
  94948. * @returns the scene
  94949. */
  94950. getScene(): Nullable<Scene>;
  94951. }
  94952. }
  94953. declare module BABYLON {
  94954. /**
  94955. * 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.
  94956. * @see https://doc.babylonjs.com/how_to/transformnode
  94957. */
  94958. export class TransformNode extends Node {
  94959. /**
  94960. * Object will not rotate to face the camera
  94961. */
  94962. static BILLBOARDMODE_NONE: number;
  94963. /**
  94964. * Object will rotate to face the camera but only on the x axis
  94965. */
  94966. static BILLBOARDMODE_X: number;
  94967. /**
  94968. * Object will rotate to face the camera but only on the y axis
  94969. */
  94970. static BILLBOARDMODE_Y: number;
  94971. /**
  94972. * Object will rotate to face the camera but only on the z axis
  94973. */
  94974. static BILLBOARDMODE_Z: number;
  94975. /**
  94976. * Object will rotate to face the camera
  94977. */
  94978. static BILLBOARDMODE_ALL: number;
  94979. /**
  94980. * Object will rotate to face the camera's position instead of orientation
  94981. */
  94982. static BILLBOARDMODE_USE_POSITION: number;
  94983. private static _TmpRotation;
  94984. private static _TmpScaling;
  94985. private static _TmpTranslation;
  94986. private _forward;
  94987. private _forwardInverted;
  94988. private _up;
  94989. private _right;
  94990. private _rightInverted;
  94991. private _position;
  94992. private _rotation;
  94993. private _rotationQuaternion;
  94994. protected _scaling: Vector3;
  94995. protected _isDirty: boolean;
  94996. private _transformToBoneReferal;
  94997. private _isAbsoluteSynced;
  94998. private _billboardMode;
  94999. /**
  95000. * Gets or sets the billboard mode. Default is 0.
  95001. *
  95002. * | Value | Type | Description |
  95003. * | --- | --- | --- |
  95004. * | 0 | BILLBOARDMODE_NONE | |
  95005. * | 1 | BILLBOARDMODE_X | |
  95006. * | 2 | BILLBOARDMODE_Y | |
  95007. * | 4 | BILLBOARDMODE_Z | |
  95008. * | 7 | BILLBOARDMODE_ALL | |
  95009. *
  95010. */
  95011. get billboardMode(): number;
  95012. set billboardMode(value: number);
  95013. private _preserveParentRotationForBillboard;
  95014. /**
  95015. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  95016. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  95017. */
  95018. get preserveParentRotationForBillboard(): boolean;
  95019. set preserveParentRotationForBillboard(value: boolean);
  95020. /**
  95021. * 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
  95022. */
  95023. scalingDeterminant: number;
  95024. private _infiniteDistance;
  95025. /**
  95026. * Gets or sets the distance of the object to max, often used by skybox
  95027. */
  95028. get infiniteDistance(): boolean;
  95029. set infiniteDistance(value: boolean);
  95030. /**
  95031. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  95032. * By default the system will update normals to compensate
  95033. */
  95034. ignoreNonUniformScaling: boolean;
  95035. /**
  95036. * 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
  95037. */
  95038. reIntegrateRotationIntoRotationQuaternion: boolean;
  95039. /** @hidden */
  95040. _poseMatrix: Nullable<Matrix>;
  95041. /** @hidden */
  95042. _localMatrix: Matrix;
  95043. private _usePivotMatrix;
  95044. private _absolutePosition;
  95045. private _absoluteScaling;
  95046. private _absoluteRotationQuaternion;
  95047. private _pivotMatrix;
  95048. private _pivotMatrixInverse;
  95049. /** @hidden */
  95050. _postMultiplyPivotMatrix: boolean;
  95051. protected _isWorldMatrixFrozen: boolean;
  95052. /** @hidden */
  95053. _indexInSceneTransformNodesArray: number;
  95054. /**
  95055. * An event triggered after the world matrix is updated
  95056. */
  95057. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  95058. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  95059. /**
  95060. * Gets a string identifying the name of the class
  95061. * @returns "TransformNode" string
  95062. */
  95063. getClassName(): string;
  95064. /**
  95065. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  95066. */
  95067. get position(): Vector3;
  95068. set position(newPosition: Vector3);
  95069. /**
  95070. * 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)).
  95071. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  95072. */
  95073. get rotation(): Vector3;
  95074. set rotation(newRotation: Vector3);
  95075. /**
  95076. * 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)).
  95077. */
  95078. get scaling(): Vector3;
  95079. set scaling(newScaling: Vector3);
  95080. /**
  95081. * 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).
  95082. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  95083. */
  95084. get rotationQuaternion(): Nullable<Quaternion>;
  95085. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  95086. /**
  95087. * The forward direction of that transform in world space.
  95088. */
  95089. get forward(): Vector3;
  95090. /**
  95091. * The up direction of that transform in world space.
  95092. */
  95093. get up(): Vector3;
  95094. /**
  95095. * The right direction of that transform in world space.
  95096. */
  95097. get right(): Vector3;
  95098. /**
  95099. * Copies the parameter passed Matrix into the mesh Pose matrix.
  95100. * @param matrix the matrix to copy the pose from
  95101. * @returns this TransformNode.
  95102. */
  95103. updatePoseMatrix(matrix: Matrix): TransformNode;
  95104. /**
  95105. * Returns the mesh Pose matrix.
  95106. * @returns the pose matrix
  95107. */
  95108. getPoseMatrix(): Matrix;
  95109. /** @hidden */
  95110. _isSynchronized(): boolean;
  95111. /** @hidden */
  95112. _initCache(): void;
  95113. /**
  95114. * Flag the transform node as dirty (Forcing it to update everything)
  95115. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  95116. * @returns this transform node
  95117. */
  95118. markAsDirty(property: string): TransformNode;
  95119. /**
  95120. * Returns the current mesh absolute position.
  95121. * Returns a Vector3.
  95122. */
  95123. get absolutePosition(): Vector3;
  95124. /**
  95125. * Returns the current mesh absolute scaling.
  95126. * Returns a Vector3.
  95127. */
  95128. get absoluteScaling(): Vector3;
  95129. /**
  95130. * Returns the current mesh absolute rotation.
  95131. * Returns a Quaternion.
  95132. */
  95133. get absoluteRotationQuaternion(): Quaternion;
  95134. /**
  95135. * Sets a new matrix to apply before all other transformation
  95136. * @param matrix defines the transform matrix
  95137. * @returns the current TransformNode
  95138. */
  95139. setPreTransformMatrix(matrix: Matrix): TransformNode;
  95140. /**
  95141. * Sets a new pivot matrix to the current node
  95142. * @param matrix defines the new pivot matrix to use
  95143. * @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
  95144. * @returns the current TransformNode
  95145. */
  95146. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  95147. /**
  95148. * Returns the mesh pivot matrix.
  95149. * Default : Identity.
  95150. * @returns the matrix
  95151. */
  95152. getPivotMatrix(): Matrix;
  95153. /**
  95154. * Instantiate (when possible) or clone that node with its hierarchy
  95155. * @param newParent defines the new parent to use for the instance (or clone)
  95156. * @param options defines options to configure how copy is done
  95157. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  95158. * @returns an instance (or a clone) of the current node with its hiearchy
  95159. */
  95160. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  95161. doNotInstantiate: boolean;
  95162. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  95163. /**
  95164. * Prevents the World matrix to be computed any longer
  95165. * @param newWorldMatrix defines an optional matrix to use as world matrix
  95166. * @returns the TransformNode.
  95167. */
  95168. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  95169. /**
  95170. * Allows back the World matrix computation.
  95171. * @returns the TransformNode.
  95172. */
  95173. unfreezeWorldMatrix(): this;
  95174. /**
  95175. * True if the World matrix has been frozen.
  95176. */
  95177. get isWorldMatrixFrozen(): boolean;
  95178. /**
  95179. * Retuns the mesh absolute position in the World.
  95180. * @returns a Vector3.
  95181. */
  95182. getAbsolutePosition(): Vector3;
  95183. /**
  95184. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  95185. * @param absolutePosition the absolute position to set
  95186. * @returns the TransformNode.
  95187. */
  95188. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  95189. /**
  95190. * Sets the mesh position in its local space.
  95191. * @param vector3 the position to set in localspace
  95192. * @returns the TransformNode.
  95193. */
  95194. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  95195. /**
  95196. * Returns the mesh position in the local space from the current World matrix values.
  95197. * @returns a new Vector3.
  95198. */
  95199. getPositionExpressedInLocalSpace(): Vector3;
  95200. /**
  95201. * Translates the mesh along the passed Vector3 in its local space.
  95202. * @param vector3 the distance to translate in localspace
  95203. * @returns the TransformNode.
  95204. */
  95205. locallyTranslate(vector3: Vector3): TransformNode;
  95206. private static _lookAtVectorCache;
  95207. /**
  95208. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  95209. * @param targetPoint the position (must be in same space as current mesh) to look at
  95210. * @param yawCor optional yaw (y-axis) correction in radians
  95211. * @param pitchCor optional pitch (x-axis) correction in radians
  95212. * @param rollCor optional roll (z-axis) correction in radians
  95213. * @param space the choosen space of the target
  95214. * @returns the TransformNode.
  95215. */
  95216. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  95217. /**
  95218. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  95219. * This Vector3 is expressed in the World space.
  95220. * @param localAxis axis to rotate
  95221. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  95222. */
  95223. getDirection(localAxis: Vector3): Vector3;
  95224. /**
  95225. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  95226. * localAxis is expressed in the mesh local space.
  95227. * result is computed in the Wordl space from the mesh World matrix.
  95228. * @param localAxis axis to rotate
  95229. * @param result the resulting transformnode
  95230. * @returns this TransformNode.
  95231. */
  95232. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  95233. /**
  95234. * Sets this transform node rotation to the given local axis.
  95235. * @param localAxis the axis in local space
  95236. * @param yawCor optional yaw (y-axis) correction in radians
  95237. * @param pitchCor optional pitch (x-axis) correction in radians
  95238. * @param rollCor optional roll (z-axis) correction in radians
  95239. * @returns this TransformNode
  95240. */
  95241. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  95242. /**
  95243. * Sets a new pivot point to the current node
  95244. * @param point defines the new pivot point to use
  95245. * @param space defines if the point is in world or local space (local by default)
  95246. * @returns the current TransformNode
  95247. */
  95248. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  95249. /**
  95250. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  95251. * @returns the pivot point
  95252. */
  95253. getPivotPoint(): Vector3;
  95254. /**
  95255. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  95256. * @param result the vector3 to store the result
  95257. * @returns this TransformNode.
  95258. */
  95259. getPivotPointToRef(result: Vector3): TransformNode;
  95260. /**
  95261. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  95262. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  95263. */
  95264. getAbsolutePivotPoint(): Vector3;
  95265. /**
  95266. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  95267. * @param result vector3 to store the result
  95268. * @returns this TransformNode.
  95269. */
  95270. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  95271. /**
  95272. * Defines the passed node as the parent of the current node.
  95273. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  95274. * @see https://doc.babylonjs.com/how_to/parenting
  95275. * @param node the node ot set as the parent
  95276. * @returns this TransformNode.
  95277. */
  95278. setParent(node: Nullable<Node>): TransformNode;
  95279. private _nonUniformScaling;
  95280. /**
  95281. * True if the scaling property of this object is non uniform eg. (1,2,1)
  95282. */
  95283. get nonUniformScaling(): boolean;
  95284. /** @hidden */
  95285. _updateNonUniformScalingState(value: boolean): boolean;
  95286. /**
  95287. * Attach the current TransformNode to another TransformNode associated with a bone
  95288. * @param bone Bone affecting the TransformNode
  95289. * @param affectedTransformNode TransformNode associated with the bone
  95290. * @returns this object
  95291. */
  95292. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  95293. /**
  95294. * Detach the transform node if its associated with a bone
  95295. * @returns this object
  95296. */
  95297. detachFromBone(): TransformNode;
  95298. private static _rotationAxisCache;
  95299. /**
  95300. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  95301. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  95302. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  95303. * The passed axis is also normalized.
  95304. * @param axis the axis to rotate around
  95305. * @param amount the amount to rotate in radians
  95306. * @param space Space to rotate in (Default: local)
  95307. * @returns the TransformNode.
  95308. */
  95309. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  95310. /**
  95311. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  95312. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  95313. * The passed axis is also normalized. .
  95314. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  95315. * @param point the point to rotate around
  95316. * @param axis the axis to rotate around
  95317. * @param amount the amount to rotate in radians
  95318. * @returns the TransformNode
  95319. */
  95320. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  95321. /**
  95322. * Translates the mesh along the axis vector for the passed distance in the given space.
  95323. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  95324. * @param axis the axis to translate in
  95325. * @param distance the distance to translate
  95326. * @param space Space to rotate in (Default: local)
  95327. * @returns the TransformNode.
  95328. */
  95329. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  95330. /**
  95331. * Adds a rotation step to the mesh current rotation.
  95332. * x, y, z are Euler angles expressed in radians.
  95333. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  95334. * This means this rotation is made in the mesh local space only.
  95335. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  95336. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  95337. * ```javascript
  95338. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  95339. * ```
  95340. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  95341. * 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.
  95342. * @param x Rotation to add
  95343. * @param y Rotation to add
  95344. * @param z Rotation to add
  95345. * @returns the TransformNode.
  95346. */
  95347. addRotation(x: number, y: number, z: number): TransformNode;
  95348. /**
  95349. * @hidden
  95350. */
  95351. protected _getEffectiveParent(): Nullable<Node>;
  95352. /**
  95353. * Computes the world matrix of the node
  95354. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  95355. * @returns the world matrix
  95356. */
  95357. computeWorldMatrix(force?: boolean): Matrix;
  95358. /**
  95359. * Resets this nodeTransform's local matrix to Matrix.Identity().
  95360. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  95361. */
  95362. resetLocalMatrix(independentOfChildren?: boolean): void;
  95363. protected _afterComputeWorldMatrix(): void;
  95364. /**
  95365. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  95366. * @param func callback function to add
  95367. *
  95368. * @returns the TransformNode.
  95369. */
  95370. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  95371. /**
  95372. * Removes a registered callback function.
  95373. * @param func callback function to remove
  95374. * @returns the TransformNode.
  95375. */
  95376. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  95377. /**
  95378. * Gets the position of the current mesh in camera space
  95379. * @param camera defines the camera to use
  95380. * @returns a position
  95381. */
  95382. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  95383. /**
  95384. * Returns the distance from the mesh to the active camera
  95385. * @param camera defines the camera to use
  95386. * @returns the distance
  95387. */
  95388. getDistanceToCamera(camera?: Nullable<Camera>): number;
  95389. /**
  95390. * Clone the current transform node
  95391. * @param name Name of the new clone
  95392. * @param newParent New parent for the clone
  95393. * @param doNotCloneChildren Do not clone children hierarchy
  95394. * @returns the new transform node
  95395. */
  95396. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  95397. /**
  95398. * Serializes the objects information.
  95399. * @param currentSerializationObject defines the object to serialize in
  95400. * @returns the serialized object
  95401. */
  95402. serialize(currentSerializationObject?: any): any;
  95403. /**
  95404. * Returns a new TransformNode object parsed from the source provided.
  95405. * @param parsedTransformNode is the source.
  95406. * @param scene the scne the object belongs to
  95407. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  95408. * @returns a new TransformNode object parsed from the source provided.
  95409. */
  95410. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  95411. /**
  95412. * Get all child-transformNodes of this node
  95413. * @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
  95414. * @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
  95415. * @returns an array of TransformNode
  95416. */
  95417. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  95418. /**
  95419. * Releases resources associated with this transform node.
  95420. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  95421. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  95422. */
  95423. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  95424. /**
  95425. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  95426. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  95427. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  95428. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  95429. * @returns the current mesh
  95430. */
  95431. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  95432. private _syncAbsoluteScalingAndRotation;
  95433. }
  95434. }
  95435. declare module BABYLON {
  95436. /**
  95437. * Class used to override all child animations of a given target
  95438. */
  95439. export class AnimationPropertiesOverride {
  95440. /**
  95441. * Gets or sets a value indicating if animation blending must be used
  95442. */
  95443. enableBlending: boolean;
  95444. /**
  95445. * Gets or sets the blending speed to use when enableBlending is true
  95446. */
  95447. blendingSpeed: number;
  95448. /**
  95449. * Gets or sets the default loop mode to use
  95450. */
  95451. loopMode: number;
  95452. }
  95453. }
  95454. declare module BABYLON {
  95455. /**
  95456. * Class used to store bone information
  95457. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  95458. */
  95459. export class Bone extends Node {
  95460. /**
  95461. * defines the bone name
  95462. */
  95463. name: string;
  95464. private static _tmpVecs;
  95465. private static _tmpQuat;
  95466. private static _tmpMats;
  95467. /**
  95468. * Gets the list of child bones
  95469. */
  95470. children: Bone[];
  95471. /** Gets the animations associated with this bone */
  95472. animations: Animation[];
  95473. /**
  95474. * Gets or sets bone length
  95475. */
  95476. length: number;
  95477. /**
  95478. * @hidden Internal only
  95479. * Set this value to map this bone to a different index in the transform matrices
  95480. * Set this value to -1 to exclude the bone from the transform matrices
  95481. */
  95482. _index: Nullable<number>;
  95483. private _skeleton;
  95484. private _localMatrix;
  95485. private _restPose;
  95486. private _bindPose;
  95487. private _baseMatrix;
  95488. private _absoluteTransform;
  95489. private _invertedAbsoluteTransform;
  95490. private _parent;
  95491. private _scalingDeterminant;
  95492. private _worldTransform;
  95493. private _localScaling;
  95494. private _localRotation;
  95495. private _localPosition;
  95496. private _needToDecompose;
  95497. private _needToCompose;
  95498. /** @hidden */
  95499. _linkedTransformNode: Nullable<TransformNode>;
  95500. /** @hidden */
  95501. _waitingTransformNodeId: Nullable<string>;
  95502. /** @hidden */
  95503. get _matrix(): Matrix;
  95504. /** @hidden */
  95505. set _matrix(value: Matrix);
  95506. /**
  95507. * Create a new bone
  95508. * @param name defines the bone name
  95509. * @param skeleton defines the parent skeleton
  95510. * @param parentBone defines the parent (can be null if the bone is the root)
  95511. * @param localMatrix defines the local matrix
  95512. * @param restPose defines the rest pose matrix
  95513. * @param baseMatrix defines the base matrix
  95514. * @param index defines index of the bone in the hiearchy
  95515. */
  95516. constructor(
  95517. /**
  95518. * defines the bone name
  95519. */
  95520. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  95521. /**
  95522. * Gets the current object class name.
  95523. * @return the class name
  95524. */
  95525. getClassName(): string;
  95526. /**
  95527. * Gets the parent skeleton
  95528. * @returns a skeleton
  95529. */
  95530. getSkeleton(): Skeleton;
  95531. /**
  95532. * Gets parent bone
  95533. * @returns a bone or null if the bone is the root of the bone hierarchy
  95534. */
  95535. getParent(): Nullable<Bone>;
  95536. /**
  95537. * Returns an array containing the root bones
  95538. * @returns an array containing the root bones
  95539. */
  95540. getChildren(): Array<Bone>;
  95541. /**
  95542. * Gets the node index in matrix array generated for rendering
  95543. * @returns the node index
  95544. */
  95545. getIndex(): number;
  95546. /**
  95547. * Sets the parent bone
  95548. * @param parent defines the parent (can be null if the bone is the root)
  95549. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  95550. */
  95551. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  95552. /**
  95553. * Gets the local matrix
  95554. * @returns a matrix
  95555. */
  95556. getLocalMatrix(): Matrix;
  95557. /**
  95558. * Gets the base matrix (initial matrix which remains unchanged)
  95559. * @returns a matrix
  95560. */
  95561. getBaseMatrix(): Matrix;
  95562. /**
  95563. * Gets the rest pose matrix
  95564. * @returns a matrix
  95565. */
  95566. getRestPose(): Matrix;
  95567. /**
  95568. * Sets the rest pose matrix
  95569. * @param matrix the local-space rest pose to set for this bone
  95570. */
  95571. setRestPose(matrix: Matrix): void;
  95572. /**
  95573. * Gets the bind pose matrix
  95574. * @returns the bind pose matrix
  95575. */
  95576. getBindPose(): Matrix;
  95577. /**
  95578. * Sets the bind pose matrix
  95579. * @param matrix the local-space bind pose to set for this bone
  95580. */
  95581. setBindPose(matrix: Matrix): void;
  95582. /**
  95583. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  95584. */
  95585. getWorldMatrix(): Matrix;
  95586. /**
  95587. * Sets the local matrix to rest pose matrix
  95588. */
  95589. returnToRest(): void;
  95590. /**
  95591. * Gets the inverse of the absolute transform matrix.
  95592. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  95593. * @returns a matrix
  95594. */
  95595. getInvertedAbsoluteTransform(): Matrix;
  95596. /**
  95597. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  95598. * @returns a matrix
  95599. */
  95600. getAbsoluteTransform(): Matrix;
  95601. /**
  95602. * Links with the given transform node.
  95603. * The local matrix of this bone is copied from the transform node every frame.
  95604. * @param transformNode defines the transform node to link to
  95605. */
  95606. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  95607. /**
  95608. * Gets the node used to drive the bone's transformation
  95609. * @returns a transform node or null
  95610. */
  95611. getTransformNode(): Nullable<TransformNode>;
  95612. /** Gets or sets current position (in local space) */
  95613. get position(): Vector3;
  95614. set position(newPosition: Vector3);
  95615. /** Gets or sets current rotation (in local space) */
  95616. get rotation(): Vector3;
  95617. set rotation(newRotation: Vector3);
  95618. /** Gets or sets current rotation quaternion (in local space) */
  95619. get rotationQuaternion(): Quaternion;
  95620. set rotationQuaternion(newRotation: Quaternion);
  95621. /** Gets or sets current scaling (in local space) */
  95622. get scaling(): Vector3;
  95623. set scaling(newScaling: Vector3);
  95624. /**
  95625. * Gets the animation properties override
  95626. */
  95627. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  95628. private _decompose;
  95629. private _compose;
  95630. /**
  95631. * Update the base and local matrices
  95632. * @param matrix defines the new base or local matrix
  95633. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  95634. * @param updateLocalMatrix defines if the local matrix should be updated
  95635. */
  95636. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  95637. /** @hidden */
  95638. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  95639. /**
  95640. * Flag the bone as dirty (Forcing it to update everything)
  95641. */
  95642. markAsDirty(): void;
  95643. /** @hidden */
  95644. _markAsDirtyAndCompose(): void;
  95645. private _markAsDirtyAndDecompose;
  95646. /**
  95647. * Translate the bone in local or world space
  95648. * @param vec The amount to translate the bone
  95649. * @param space The space that the translation is in
  95650. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95651. */
  95652. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  95653. /**
  95654. * Set the postion of the bone in local or world space
  95655. * @param position The position to set the bone
  95656. * @param space The space that the position is in
  95657. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95658. */
  95659. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  95660. /**
  95661. * Set the absolute position of the bone (world space)
  95662. * @param position The position to set the bone
  95663. * @param mesh The mesh that this bone is attached to
  95664. */
  95665. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  95666. /**
  95667. * Scale the bone on the x, y and z axes (in local space)
  95668. * @param x The amount to scale the bone on the x axis
  95669. * @param y The amount to scale the bone on the y axis
  95670. * @param z The amount to scale the bone on the z axis
  95671. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  95672. */
  95673. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  95674. /**
  95675. * Set the bone scaling in local space
  95676. * @param scale defines the scaling vector
  95677. */
  95678. setScale(scale: Vector3): void;
  95679. /**
  95680. * Gets the current scaling in local space
  95681. * @returns the current scaling vector
  95682. */
  95683. getScale(): Vector3;
  95684. /**
  95685. * Gets the current scaling in local space and stores it in a target vector
  95686. * @param result defines the target vector
  95687. */
  95688. getScaleToRef(result: Vector3): void;
  95689. /**
  95690. * Set the yaw, pitch, and roll of the bone in local or world space
  95691. * @param yaw The rotation of the bone on the y axis
  95692. * @param pitch The rotation of the bone on the x axis
  95693. * @param roll The rotation of the bone on the z axis
  95694. * @param space The space that the axes of rotation are in
  95695. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95696. */
  95697. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  95698. /**
  95699. * Add a rotation to the bone on an axis in local or world space
  95700. * @param axis The axis to rotate the bone on
  95701. * @param amount The amount to rotate the bone
  95702. * @param space The space that the axis is in
  95703. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95704. */
  95705. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  95706. /**
  95707. * Set the rotation of the bone to a particular axis angle in local or world space
  95708. * @param axis The axis to rotate the bone on
  95709. * @param angle The angle that the bone should be rotated to
  95710. * @param space The space that the axis is in
  95711. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95712. */
  95713. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  95714. /**
  95715. * Set the euler rotation of the bone in local or world space
  95716. * @param rotation The euler rotation that the bone should be set to
  95717. * @param space The space that the rotation is in
  95718. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95719. */
  95720. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  95721. /**
  95722. * Set the quaternion rotation of the bone in local or world space
  95723. * @param quat The quaternion rotation that the bone should be set to
  95724. * @param space The space that the rotation is in
  95725. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95726. */
  95727. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  95728. /**
  95729. * Set the rotation matrix of the bone in local or world space
  95730. * @param rotMat The rotation matrix that the bone should be set to
  95731. * @param space The space that the rotation is in
  95732. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95733. */
  95734. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  95735. private _rotateWithMatrix;
  95736. private _getNegativeRotationToRef;
  95737. /**
  95738. * Get the position of the bone in local or world space
  95739. * @param space The space that the returned position is in
  95740. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95741. * @returns The position of the bone
  95742. */
  95743. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  95744. /**
  95745. * Copy the position of the bone to a vector3 in local or world space
  95746. * @param space The space that the returned position is in
  95747. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95748. * @param result The vector3 to copy the position to
  95749. */
  95750. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  95751. /**
  95752. * Get the absolute position of the bone (world space)
  95753. * @param mesh The mesh that this bone is attached to
  95754. * @returns The absolute position of the bone
  95755. */
  95756. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  95757. /**
  95758. * Copy the absolute position of the bone (world space) to the result param
  95759. * @param mesh The mesh that this bone is attached to
  95760. * @param result The vector3 to copy the absolute position to
  95761. */
  95762. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  95763. /**
  95764. * Compute the absolute transforms of this bone and its children
  95765. */
  95766. computeAbsoluteTransforms(): void;
  95767. /**
  95768. * Get the world direction from an axis that is in the local space of the bone
  95769. * @param localAxis The local direction that is used to compute the world direction
  95770. * @param mesh The mesh that this bone is attached to
  95771. * @returns The world direction
  95772. */
  95773. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95774. /**
  95775. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  95776. * @param localAxis The local direction that is used to compute the world direction
  95777. * @param mesh The mesh that this bone is attached to
  95778. * @param result The vector3 that the world direction will be copied to
  95779. */
  95780. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95781. /**
  95782. * Get the euler rotation of the bone in local or world space
  95783. * @param space The space that the rotation should be in
  95784. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95785. * @returns The euler rotation
  95786. */
  95787. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  95788. /**
  95789. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  95790. * @param space The space that the rotation should be in
  95791. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95792. * @param result The vector3 that the rotation should be copied to
  95793. */
  95794. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95795. /**
  95796. * Get the quaternion rotation of the bone in either local or world space
  95797. * @param space The space that the rotation should be in
  95798. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95799. * @returns The quaternion rotation
  95800. */
  95801. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  95802. /**
  95803. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  95804. * @param space The space that the rotation should be in
  95805. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95806. * @param result The quaternion that the rotation should be copied to
  95807. */
  95808. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  95809. /**
  95810. * Get the rotation matrix of the bone in local or world space
  95811. * @param space The space that the rotation should be in
  95812. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95813. * @returns The rotation matrix
  95814. */
  95815. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  95816. /**
  95817. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  95818. * @param space The space that the rotation should be in
  95819. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95820. * @param result The quaternion that the rotation should be copied to
  95821. */
  95822. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  95823. /**
  95824. * Get the world position of a point that is in the local space of the bone
  95825. * @param position The local position
  95826. * @param mesh The mesh that this bone is attached to
  95827. * @returns The world position
  95828. */
  95829. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95830. /**
  95831. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  95832. * @param position The local position
  95833. * @param mesh The mesh that this bone is attached to
  95834. * @param result The vector3 that the world position should be copied to
  95835. */
  95836. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95837. /**
  95838. * Get the local position of a point that is in world space
  95839. * @param position The world position
  95840. * @param mesh The mesh that this bone is attached to
  95841. * @returns The local position
  95842. */
  95843. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95844. /**
  95845. * Get the local position of a point that is in world space and copy it to the result param
  95846. * @param position The world position
  95847. * @param mesh The mesh that this bone is attached to
  95848. * @param result The vector3 that the local position should be copied to
  95849. */
  95850. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95851. /**
  95852. * Set the current local matrix as the restPose for this bone.
  95853. */
  95854. setCurrentPoseAsRest(): void;
  95855. }
  95856. }
  95857. declare module BABYLON {
  95858. /**
  95859. * Defines a runtime animation
  95860. */
  95861. export class RuntimeAnimation {
  95862. private _events;
  95863. /**
  95864. * The current frame of the runtime animation
  95865. */
  95866. private _currentFrame;
  95867. /**
  95868. * The animation used by the runtime animation
  95869. */
  95870. private _animation;
  95871. /**
  95872. * The target of the runtime animation
  95873. */
  95874. private _target;
  95875. /**
  95876. * The initiating animatable
  95877. */
  95878. private _host;
  95879. /**
  95880. * The original value of the runtime animation
  95881. */
  95882. private _originalValue;
  95883. /**
  95884. * The original blend value of the runtime animation
  95885. */
  95886. private _originalBlendValue;
  95887. /**
  95888. * The offsets cache of the runtime animation
  95889. */
  95890. private _offsetsCache;
  95891. /**
  95892. * The high limits cache of the runtime animation
  95893. */
  95894. private _highLimitsCache;
  95895. /**
  95896. * Specifies if the runtime animation has been stopped
  95897. */
  95898. private _stopped;
  95899. /**
  95900. * The blending factor of the runtime animation
  95901. */
  95902. private _blendingFactor;
  95903. /**
  95904. * The BabylonJS scene
  95905. */
  95906. private _scene;
  95907. /**
  95908. * The current value of the runtime animation
  95909. */
  95910. private _currentValue;
  95911. /** @hidden */
  95912. _animationState: _IAnimationState;
  95913. /**
  95914. * The active target of the runtime animation
  95915. */
  95916. private _activeTargets;
  95917. private _currentActiveTarget;
  95918. private _directTarget;
  95919. /**
  95920. * The target path of the runtime animation
  95921. */
  95922. private _targetPath;
  95923. /**
  95924. * The weight of the runtime animation
  95925. */
  95926. private _weight;
  95927. /**
  95928. * The ratio offset of the runtime animation
  95929. */
  95930. private _ratioOffset;
  95931. /**
  95932. * The previous delay of the runtime animation
  95933. */
  95934. private _previousDelay;
  95935. /**
  95936. * The previous ratio of the runtime animation
  95937. */
  95938. private _previousRatio;
  95939. private _enableBlending;
  95940. private _keys;
  95941. private _minFrame;
  95942. private _maxFrame;
  95943. private _minValue;
  95944. private _maxValue;
  95945. private _targetIsArray;
  95946. /**
  95947. * Gets the current frame of the runtime animation
  95948. */
  95949. get currentFrame(): number;
  95950. /**
  95951. * Gets the weight of the runtime animation
  95952. */
  95953. get weight(): number;
  95954. /**
  95955. * Gets the current value of the runtime animation
  95956. */
  95957. get currentValue(): any;
  95958. /**
  95959. * Gets the target path of the runtime animation
  95960. */
  95961. get targetPath(): string;
  95962. /**
  95963. * Gets the actual target of the runtime animation
  95964. */
  95965. get target(): any;
  95966. /**
  95967. * Gets the additive state of the runtime animation
  95968. */
  95969. get isAdditive(): boolean;
  95970. /** @hidden */
  95971. _onLoop: () => void;
  95972. /**
  95973. * Create a new RuntimeAnimation object
  95974. * @param target defines the target of the animation
  95975. * @param animation defines the source animation object
  95976. * @param scene defines the hosting scene
  95977. * @param host defines the initiating Animatable
  95978. */
  95979. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  95980. private _preparePath;
  95981. /**
  95982. * Gets the animation from the runtime animation
  95983. */
  95984. get animation(): Animation;
  95985. /**
  95986. * Resets the runtime animation to the beginning
  95987. * @param restoreOriginal defines whether to restore the target property to the original value
  95988. */
  95989. reset(restoreOriginal?: boolean): void;
  95990. /**
  95991. * Specifies if the runtime animation is stopped
  95992. * @returns Boolean specifying if the runtime animation is stopped
  95993. */
  95994. isStopped(): boolean;
  95995. /**
  95996. * Disposes of the runtime animation
  95997. */
  95998. dispose(): void;
  95999. /**
  96000. * Apply the interpolated value to the target
  96001. * @param currentValue defines the value computed by the animation
  96002. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  96003. */
  96004. setValue(currentValue: any, weight: number): void;
  96005. private _getOriginalValues;
  96006. private _setValue;
  96007. /**
  96008. * Gets the loop pmode of the runtime animation
  96009. * @returns Loop Mode
  96010. */
  96011. private _getCorrectLoopMode;
  96012. /**
  96013. * Move the current animation to a given frame
  96014. * @param frame defines the frame to move to
  96015. */
  96016. goToFrame(frame: number): void;
  96017. /**
  96018. * @hidden Internal use only
  96019. */
  96020. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  96021. /**
  96022. * Execute the current animation
  96023. * @param delay defines the delay to add to the current frame
  96024. * @param from defines the lower bound of the animation range
  96025. * @param to defines the upper bound of the animation range
  96026. * @param loop defines if the current animation must loop
  96027. * @param speedRatio defines the current speed ratio
  96028. * @param weight defines the weight of the animation (default is -1 so no weight)
  96029. * @param onLoop optional callback called when animation loops
  96030. * @returns a boolean indicating if the animation is running
  96031. */
  96032. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  96033. }
  96034. }
  96035. declare module BABYLON {
  96036. /**
  96037. * Class used to store an actual running animation
  96038. */
  96039. export class Animatable {
  96040. /** defines the target object */
  96041. target: any;
  96042. /** defines the starting frame number (default is 0) */
  96043. fromFrame: number;
  96044. /** defines the ending frame number (default is 100) */
  96045. toFrame: number;
  96046. /** defines if the animation must loop (default is false) */
  96047. loopAnimation: boolean;
  96048. /** defines a callback to call when animation ends if it is not looping */
  96049. onAnimationEnd?: (() => void) | null | undefined;
  96050. /** defines a callback to call when animation loops */
  96051. onAnimationLoop?: (() => void) | null | undefined;
  96052. /** defines whether the animation should be evaluated additively */
  96053. isAdditive: boolean;
  96054. private _localDelayOffset;
  96055. private _pausedDelay;
  96056. private _runtimeAnimations;
  96057. private _paused;
  96058. private _scene;
  96059. private _speedRatio;
  96060. private _weight;
  96061. private _syncRoot;
  96062. /**
  96063. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  96064. * This will only apply for non looping animation (default is true)
  96065. */
  96066. disposeOnEnd: boolean;
  96067. /**
  96068. * Gets a boolean indicating if the animation has started
  96069. */
  96070. animationStarted: boolean;
  96071. /**
  96072. * Observer raised when the animation ends
  96073. */
  96074. onAnimationEndObservable: Observable<Animatable>;
  96075. /**
  96076. * Observer raised when the animation loops
  96077. */
  96078. onAnimationLoopObservable: Observable<Animatable>;
  96079. /**
  96080. * Gets the root Animatable used to synchronize and normalize animations
  96081. */
  96082. get syncRoot(): Nullable<Animatable>;
  96083. /**
  96084. * Gets the current frame of the first RuntimeAnimation
  96085. * Used to synchronize Animatables
  96086. */
  96087. get masterFrame(): number;
  96088. /**
  96089. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  96090. */
  96091. get weight(): number;
  96092. set weight(value: number);
  96093. /**
  96094. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  96095. */
  96096. get speedRatio(): number;
  96097. set speedRatio(value: number);
  96098. /**
  96099. * Creates a new Animatable
  96100. * @param scene defines the hosting scene
  96101. * @param target defines the target object
  96102. * @param fromFrame defines the starting frame number (default is 0)
  96103. * @param toFrame defines the ending frame number (default is 100)
  96104. * @param loopAnimation defines if the animation must loop (default is false)
  96105. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  96106. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  96107. * @param animations defines a group of animation to add to the new Animatable
  96108. * @param onAnimationLoop defines a callback to call when animation loops
  96109. * @param isAdditive defines whether the animation should be evaluated additively
  96110. */
  96111. constructor(scene: Scene,
  96112. /** defines the target object */
  96113. target: any,
  96114. /** defines the starting frame number (default is 0) */
  96115. fromFrame?: number,
  96116. /** defines the ending frame number (default is 100) */
  96117. toFrame?: number,
  96118. /** defines if the animation must loop (default is false) */
  96119. loopAnimation?: boolean, speedRatio?: number,
  96120. /** defines a callback to call when animation ends if it is not looping */
  96121. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  96122. /** defines a callback to call when animation loops */
  96123. onAnimationLoop?: (() => void) | null | undefined,
  96124. /** defines whether the animation should be evaluated additively */
  96125. isAdditive?: boolean);
  96126. /**
  96127. * Synchronize and normalize current Animatable with a source Animatable
  96128. * This is useful when using animation weights and when animations are not of the same length
  96129. * @param root defines the root Animatable to synchronize with
  96130. * @returns the current Animatable
  96131. */
  96132. syncWith(root: Animatable): Animatable;
  96133. /**
  96134. * Gets the list of runtime animations
  96135. * @returns an array of RuntimeAnimation
  96136. */
  96137. getAnimations(): RuntimeAnimation[];
  96138. /**
  96139. * Adds more animations to the current animatable
  96140. * @param target defines the target of the animations
  96141. * @param animations defines the new animations to add
  96142. */
  96143. appendAnimations(target: any, animations: Animation[]): void;
  96144. /**
  96145. * Gets the source animation for a specific property
  96146. * @param property defines the propertyu to look for
  96147. * @returns null or the source animation for the given property
  96148. */
  96149. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  96150. /**
  96151. * Gets the runtime animation for a specific property
  96152. * @param property defines the propertyu to look for
  96153. * @returns null or the runtime animation for the given property
  96154. */
  96155. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  96156. /**
  96157. * Resets the animatable to its original state
  96158. */
  96159. reset(): void;
  96160. /**
  96161. * Allows the animatable to blend with current running animations
  96162. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  96163. * @param blendingSpeed defines the blending speed to use
  96164. */
  96165. enableBlending(blendingSpeed: number): void;
  96166. /**
  96167. * Disable animation blending
  96168. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  96169. */
  96170. disableBlending(): void;
  96171. /**
  96172. * Jump directly to a given frame
  96173. * @param frame defines the frame to jump to
  96174. */
  96175. goToFrame(frame: number): void;
  96176. /**
  96177. * Pause the animation
  96178. */
  96179. pause(): void;
  96180. /**
  96181. * Restart the animation
  96182. */
  96183. restart(): void;
  96184. private _raiseOnAnimationEnd;
  96185. /**
  96186. * Stop and delete the current animation
  96187. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  96188. * @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)
  96189. */
  96190. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  96191. /**
  96192. * Wait asynchronously for the animation to end
  96193. * @returns a promise which will be fullfilled when the animation ends
  96194. */
  96195. waitAsync(): Promise<Animatable>;
  96196. /** @hidden */
  96197. _animate(delay: number): boolean;
  96198. }
  96199. interface Scene {
  96200. /** @hidden */
  96201. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  96202. /** @hidden */
  96203. _processLateAnimationBindingsForMatrices(holder: {
  96204. totalWeight: number;
  96205. totalAdditiveWeight: number;
  96206. animations: RuntimeAnimation[];
  96207. additiveAnimations: RuntimeAnimation[];
  96208. originalValue: Matrix;
  96209. }): any;
  96210. /** @hidden */
  96211. _processLateAnimationBindingsForQuaternions(holder: {
  96212. totalWeight: number;
  96213. totalAdditiveWeight: number;
  96214. animations: RuntimeAnimation[];
  96215. additiveAnimations: RuntimeAnimation[];
  96216. originalValue: Quaternion;
  96217. }, refQuaternion: Quaternion): Quaternion;
  96218. /** @hidden */
  96219. _processLateAnimationBindings(): void;
  96220. /**
  96221. * Will start the animation sequence of a given target
  96222. * @param target defines the target
  96223. * @param from defines from which frame should animation start
  96224. * @param to defines until which frame should animation run.
  96225. * @param weight defines the weight to apply to the animation (1.0 by default)
  96226. * @param loop defines if the animation loops
  96227. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  96228. * @param onAnimationEnd defines the function to be executed when the animation ends
  96229. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  96230. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  96231. * @param onAnimationLoop defines the callback to call when an animation loops
  96232. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  96233. * @returns the animatable object created for this animation
  96234. */
  96235. 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;
  96236. /**
  96237. * Will start the animation sequence of a given target
  96238. * @param target defines the target
  96239. * @param from defines from which frame should animation start
  96240. * @param to defines until which frame should animation run.
  96241. * @param loop defines if the animation loops
  96242. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  96243. * @param onAnimationEnd defines the function to be executed when the animation ends
  96244. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  96245. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  96246. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  96247. * @param onAnimationLoop defines the callback to call when an animation loops
  96248. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  96249. * @returns the animatable object created for this animation
  96250. */
  96251. 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;
  96252. /**
  96253. * Will start the animation sequence of a given target and its hierarchy
  96254. * @param target defines the target
  96255. * @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.
  96256. * @param from defines from which frame should animation start
  96257. * @param to defines until which frame should animation run.
  96258. * @param loop defines if the animation loops
  96259. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  96260. * @param onAnimationEnd defines the function to be executed when the animation ends
  96261. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  96262. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  96263. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  96264. * @param onAnimationLoop defines the callback to call when an animation loops
  96265. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  96266. * @returns the list of created animatables
  96267. */
  96268. 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[];
  96269. /**
  96270. * Begin a new animation on a given node
  96271. * @param target defines the target where the animation will take place
  96272. * @param animations defines the list of animations to start
  96273. * @param from defines the initial value
  96274. * @param to defines the final value
  96275. * @param loop defines if you want animation to loop (off by default)
  96276. * @param speedRatio defines the speed ratio to apply to all animations
  96277. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  96278. * @param onAnimationLoop defines the callback to call when an animation loops
  96279. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  96280. * @returns the list of created animatables
  96281. */
  96282. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  96283. /**
  96284. * Begin a new animation on a given node and its hierarchy
  96285. * @param target defines the root node where the animation will take place
  96286. * @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.
  96287. * @param animations defines the list of animations to start
  96288. * @param from defines the initial value
  96289. * @param to defines the final value
  96290. * @param loop defines if you want animation to loop (off by default)
  96291. * @param speedRatio defines the speed ratio to apply to all animations
  96292. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  96293. * @param onAnimationLoop defines the callback to call when an animation loops
  96294. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  96295. * @returns the list of animatables created for all nodes
  96296. */
  96297. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  96298. /**
  96299. * Gets the animatable associated with a specific target
  96300. * @param target defines the target of the animatable
  96301. * @returns the required animatable if found
  96302. */
  96303. getAnimatableByTarget(target: any): Nullable<Animatable>;
  96304. /**
  96305. * Gets all animatables associated with a given target
  96306. * @param target defines the target to look animatables for
  96307. * @returns an array of Animatables
  96308. */
  96309. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  96310. /**
  96311. * Stops and removes all animations that have been applied to the scene
  96312. */
  96313. stopAllAnimations(): void;
  96314. /**
  96315. * Gets the current delta time used by animation engine
  96316. */
  96317. deltaTime: number;
  96318. }
  96319. interface Bone {
  96320. /**
  96321. * Copy an animation range from another bone
  96322. * @param source defines the source bone
  96323. * @param rangeName defines the range name to copy
  96324. * @param frameOffset defines the frame offset
  96325. * @param rescaleAsRequired defines if rescaling must be applied if required
  96326. * @param skelDimensionsRatio defines the scaling ratio
  96327. * @returns true if operation was successful
  96328. */
  96329. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  96330. }
  96331. }
  96332. declare module BABYLON {
  96333. /**
  96334. * Class used to handle skinning animations
  96335. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  96336. */
  96337. export class Skeleton implements IAnimatable {
  96338. /** defines the skeleton name */
  96339. name: string;
  96340. /** defines the skeleton Id */
  96341. id: string;
  96342. /**
  96343. * Defines the list of child bones
  96344. */
  96345. bones: Bone[];
  96346. /**
  96347. * Defines an estimate of the dimension of the skeleton at rest
  96348. */
  96349. dimensionsAtRest: Vector3;
  96350. /**
  96351. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  96352. */
  96353. needInitialSkinMatrix: boolean;
  96354. /**
  96355. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  96356. */
  96357. overrideMesh: Nullable<AbstractMesh>;
  96358. /**
  96359. * Gets the list of animations attached to this skeleton
  96360. */
  96361. animations: Array<Animation>;
  96362. private _scene;
  96363. private _isDirty;
  96364. private _transformMatrices;
  96365. private _transformMatrixTexture;
  96366. private _meshesWithPoseMatrix;
  96367. private _animatables;
  96368. private _identity;
  96369. private _synchronizedWithMesh;
  96370. private _ranges;
  96371. private _lastAbsoluteTransformsUpdateId;
  96372. private _canUseTextureForBones;
  96373. private _uniqueId;
  96374. /** @hidden */
  96375. _numBonesWithLinkedTransformNode: number;
  96376. /** @hidden */
  96377. _hasWaitingData: Nullable<boolean>;
  96378. /** @hidden */
  96379. _waitingOverrideMeshId: Nullable<string>;
  96380. /**
  96381. * Specifies if the skeleton should be serialized
  96382. */
  96383. doNotSerialize: boolean;
  96384. private _useTextureToStoreBoneMatrices;
  96385. /**
  96386. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  96387. * Please note that this option is not available if the hardware does not support it
  96388. */
  96389. get useTextureToStoreBoneMatrices(): boolean;
  96390. set useTextureToStoreBoneMatrices(value: boolean);
  96391. private _animationPropertiesOverride;
  96392. /**
  96393. * Gets or sets the animation properties override
  96394. */
  96395. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  96396. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  96397. /**
  96398. * List of inspectable custom properties (used by the Inspector)
  96399. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  96400. */
  96401. inspectableCustomProperties: IInspectable[];
  96402. /**
  96403. * An observable triggered before computing the skeleton's matrices
  96404. */
  96405. onBeforeComputeObservable: Observable<Skeleton>;
  96406. /**
  96407. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  96408. */
  96409. get isUsingTextureForMatrices(): boolean;
  96410. /**
  96411. * Gets the unique ID of this skeleton
  96412. */
  96413. get uniqueId(): number;
  96414. /**
  96415. * Creates a new skeleton
  96416. * @param name defines the skeleton name
  96417. * @param id defines the skeleton Id
  96418. * @param scene defines the hosting scene
  96419. */
  96420. constructor(
  96421. /** defines the skeleton name */
  96422. name: string,
  96423. /** defines the skeleton Id */
  96424. id: string, scene: Scene);
  96425. /**
  96426. * Gets the current object class name.
  96427. * @return the class name
  96428. */
  96429. getClassName(): string;
  96430. /**
  96431. * Returns an array containing the root bones
  96432. * @returns an array containing the root bones
  96433. */
  96434. getChildren(): Array<Bone>;
  96435. /**
  96436. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  96437. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  96438. * @returns a Float32Array containing matrices data
  96439. */
  96440. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  96441. /**
  96442. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  96443. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  96444. * @returns a raw texture containing the data
  96445. */
  96446. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  96447. /**
  96448. * Gets the current hosting scene
  96449. * @returns a scene object
  96450. */
  96451. getScene(): Scene;
  96452. /**
  96453. * Gets a string representing the current skeleton data
  96454. * @param fullDetails defines a boolean indicating if we want a verbose version
  96455. * @returns a string representing the current skeleton data
  96456. */
  96457. toString(fullDetails?: boolean): string;
  96458. /**
  96459. * Get bone's index searching by name
  96460. * @param name defines bone's name to search for
  96461. * @return the indice of the bone. Returns -1 if not found
  96462. */
  96463. getBoneIndexByName(name: string): number;
  96464. /**
  96465. * Creater a new animation range
  96466. * @param name defines the name of the range
  96467. * @param from defines the start key
  96468. * @param to defines the end key
  96469. */
  96470. createAnimationRange(name: string, from: number, to: number): void;
  96471. /**
  96472. * Delete a specific animation range
  96473. * @param name defines the name of the range
  96474. * @param deleteFrames defines if frames must be removed as well
  96475. */
  96476. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  96477. /**
  96478. * Gets a specific animation range
  96479. * @param name defines the name of the range to look for
  96480. * @returns the requested animation range or null if not found
  96481. */
  96482. getAnimationRange(name: string): Nullable<AnimationRange>;
  96483. /**
  96484. * Gets the list of all animation ranges defined on this skeleton
  96485. * @returns an array
  96486. */
  96487. getAnimationRanges(): Nullable<AnimationRange>[];
  96488. /**
  96489. * Copy animation range from a source skeleton.
  96490. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  96491. * @param source defines the source skeleton
  96492. * @param name defines the name of the range to copy
  96493. * @param rescaleAsRequired defines if rescaling must be applied if required
  96494. * @returns true if operation was successful
  96495. */
  96496. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  96497. /**
  96498. * Forces the skeleton to go to rest pose
  96499. */
  96500. returnToRest(): void;
  96501. private _getHighestAnimationFrame;
  96502. /**
  96503. * Begin a specific animation range
  96504. * @param name defines the name of the range to start
  96505. * @param loop defines if looping must be turned on (false by default)
  96506. * @param speedRatio defines the speed ratio to apply (1 by default)
  96507. * @param onAnimationEnd defines a callback which will be called when animation will end
  96508. * @returns a new animatable
  96509. */
  96510. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  96511. /**
  96512. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  96513. * @param skeleton defines the Skeleton containing the animation range to convert
  96514. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  96515. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  96516. * @returns the original skeleton
  96517. */
  96518. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  96519. /** @hidden */
  96520. _markAsDirty(): void;
  96521. /** @hidden */
  96522. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  96523. /** @hidden */
  96524. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  96525. private _computeTransformMatrices;
  96526. /**
  96527. * Build all resources required to render a skeleton
  96528. */
  96529. prepare(): void;
  96530. /**
  96531. * Gets the list of animatables currently running for this skeleton
  96532. * @returns an array of animatables
  96533. */
  96534. getAnimatables(): IAnimatable[];
  96535. /**
  96536. * Clone the current skeleton
  96537. * @param name defines the name of the new skeleton
  96538. * @param id defines the id of the new skeleton
  96539. * @returns the new skeleton
  96540. */
  96541. clone(name: string, id?: string): Skeleton;
  96542. /**
  96543. * Enable animation blending for this skeleton
  96544. * @param blendingSpeed defines the blending speed to apply
  96545. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  96546. */
  96547. enableBlending(blendingSpeed?: number): void;
  96548. /**
  96549. * Releases all resources associated with the current skeleton
  96550. */
  96551. dispose(): void;
  96552. /**
  96553. * Serialize the skeleton in a JSON object
  96554. * @returns a JSON object
  96555. */
  96556. serialize(): any;
  96557. /**
  96558. * Creates a new skeleton from serialized data
  96559. * @param parsedSkeleton defines the serialized data
  96560. * @param scene defines the hosting scene
  96561. * @returns a new skeleton
  96562. */
  96563. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  96564. /**
  96565. * Compute all node absolute transforms
  96566. * @param forceUpdate defines if computation must be done even if cache is up to date
  96567. */
  96568. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  96569. /**
  96570. * Gets the root pose matrix
  96571. * @returns a matrix
  96572. */
  96573. getPoseMatrix(): Nullable<Matrix>;
  96574. /**
  96575. * Sorts bones per internal index
  96576. */
  96577. sortBones(): void;
  96578. private _sortBones;
  96579. /**
  96580. * Set the current local matrix as the restPose for all bones in the skeleton.
  96581. */
  96582. setCurrentPoseAsRest(): void;
  96583. }
  96584. }
  96585. declare module BABYLON {
  96586. /**
  96587. * Creates an instance based on a source mesh.
  96588. */
  96589. export class InstancedMesh extends AbstractMesh {
  96590. private _sourceMesh;
  96591. private _currentLOD;
  96592. /** @hidden */
  96593. _indexInSourceMeshInstanceArray: number;
  96594. constructor(name: string, source: Mesh);
  96595. /**
  96596. * Returns the string "InstancedMesh".
  96597. */
  96598. getClassName(): string;
  96599. /** Gets the list of lights affecting that mesh */
  96600. get lightSources(): Light[];
  96601. _resyncLightSources(): void;
  96602. _resyncLightSource(light: Light): void;
  96603. _removeLightSource(light: Light, dispose: boolean): void;
  96604. /**
  96605. * If the source mesh receives shadows
  96606. */
  96607. get receiveShadows(): boolean;
  96608. /**
  96609. * The material of the source mesh
  96610. */
  96611. get material(): Nullable<Material>;
  96612. /**
  96613. * Visibility of the source mesh
  96614. */
  96615. get visibility(): number;
  96616. /**
  96617. * Skeleton of the source mesh
  96618. */
  96619. get skeleton(): Nullable<Skeleton>;
  96620. /**
  96621. * Rendering ground id of the source mesh
  96622. */
  96623. get renderingGroupId(): number;
  96624. set renderingGroupId(value: number);
  96625. /**
  96626. * Returns the total number of vertices (integer).
  96627. */
  96628. getTotalVertices(): number;
  96629. /**
  96630. * Returns a positive integer : the total number of indices in this mesh geometry.
  96631. * @returns the numner of indices or zero if the mesh has no geometry.
  96632. */
  96633. getTotalIndices(): number;
  96634. /**
  96635. * The source mesh of the instance
  96636. */
  96637. get sourceMesh(): Mesh;
  96638. /**
  96639. * Creates a new InstancedMesh object from the mesh model.
  96640. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  96641. * @param name defines the name of the new instance
  96642. * @returns a new InstancedMesh
  96643. */
  96644. createInstance(name: string): InstancedMesh;
  96645. /**
  96646. * Is this node ready to be used/rendered
  96647. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  96648. * @return {boolean} is it ready
  96649. */
  96650. isReady(completeCheck?: boolean): boolean;
  96651. /**
  96652. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  96653. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  96654. * @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.
  96655. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  96656. */
  96657. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  96658. /**
  96659. * Sets the vertex data of the mesh geometry for the requested `kind`.
  96660. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  96661. * The `data` are either a numeric array either a Float32Array.
  96662. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  96663. * 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).
  96664. * Note that a new underlying VertexBuffer object is created each call.
  96665. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  96666. *
  96667. * Possible `kind` values :
  96668. * - VertexBuffer.PositionKind
  96669. * - VertexBuffer.UVKind
  96670. * - VertexBuffer.UV2Kind
  96671. * - VertexBuffer.UV3Kind
  96672. * - VertexBuffer.UV4Kind
  96673. * - VertexBuffer.UV5Kind
  96674. * - VertexBuffer.UV6Kind
  96675. * - VertexBuffer.ColorKind
  96676. * - VertexBuffer.MatricesIndicesKind
  96677. * - VertexBuffer.MatricesIndicesExtraKind
  96678. * - VertexBuffer.MatricesWeightsKind
  96679. * - VertexBuffer.MatricesWeightsExtraKind
  96680. *
  96681. * Returns the Mesh.
  96682. */
  96683. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  96684. /**
  96685. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  96686. * If the mesh has no geometry, it is simply returned as it is.
  96687. * The `data` are either a numeric array either a Float32Array.
  96688. * No new underlying VertexBuffer object is created.
  96689. * 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.
  96690. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  96691. *
  96692. * Possible `kind` values :
  96693. * - VertexBuffer.PositionKind
  96694. * - VertexBuffer.UVKind
  96695. * - VertexBuffer.UV2Kind
  96696. * - VertexBuffer.UV3Kind
  96697. * - VertexBuffer.UV4Kind
  96698. * - VertexBuffer.UV5Kind
  96699. * - VertexBuffer.UV6Kind
  96700. * - VertexBuffer.ColorKind
  96701. * - VertexBuffer.MatricesIndicesKind
  96702. * - VertexBuffer.MatricesIndicesExtraKind
  96703. * - VertexBuffer.MatricesWeightsKind
  96704. * - VertexBuffer.MatricesWeightsExtraKind
  96705. *
  96706. * Returns the Mesh.
  96707. */
  96708. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  96709. /**
  96710. * Sets the mesh indices.
  96711. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  96712. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  96713. * This method creates a new index buffer each call.
  96714. * Returns the Mesh.
  96715. */
  96716. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  96717. /**
  96718. * Boolean : True if the mesh owns the requested kind of data.
  96719. */
  96720. isVerticesDataPresent(kind: string): boolean;
  96721. /**
  96722. * Returns an array of indices (IndicesArray).
  96723. */
  96724. getIndices(): Nullable<IndicesArray>;
  96725. get _positions(): Nullable<Vector3[]>;
  96726. /**
  96727. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  96728. * This means the mesh underlying bounding box and sphere are recomputed.
  96729. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  96730. * @returns the current mesh
  96731. */
  96732. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  96733. /** @hidden */
  96734. _preActivate(): InstancedMesh;
  96735. /** @hidden */
  96736. _activate(renderId: number, intermediateRendering: boolean): boolean;
  96737. /** @hidden */
  96738. _postActivate(): void;
  96739. getWorldMatrix(): Matrix;
  96740. get isAnInstance(): boolean;
  96741. /**
  96742. * Returns the current associated LOD AbstractMesh.
  96743. */
  96744. getLOD(camera: Camera): AbstractMesh;
  96745. /** @hidden */
  96746. _preActivateForIntermediateRendering(renderId: number): Mesh;
  96747. /** @hidden */
  96748. _syncSubMeshes(): InstancedMesh;
  96749. /** @hidden */
  96750. _generatePointsArray(): boolean;
  96751. /** @hidden */
  96752. _updateBoundingInfo(): AbstractMesh;
  96753. /**
  96754. * Creates a new InstancedMesh from the current mesh.
  96755. * - name (string) : the cloned mesh name
  96756. * - newParent (optional Node) : the optional Node to parent the clone to.
  96757. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  96758. *
  96759. * Returns the clone.
  96760. */
  96761. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  96762. /**
  96763. * Disposes the InstancedMesh.
  96764. * Returns nothing.
  96765. */
  96766. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  96767. }
  96768. interface Mesh {
  96769. /**
  96770. * Register a custom buffer that will be instanced
  96771. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  96772. * @param kind defines the buffer kind
  96773. * @param stride defines the stride in floats
  96774. */
  96775. registerInstancedBuffer(kind: string, stride: number): void;
  96776. /**
  96777. * true to use the edge renderer for all instances of this mesh
  96778. */
  96779. edgesShareWithInstances: boolean;
  96780. /** @hidden */
  96781. _userInstancedBuffersStorage: {
  96782. data: {
  96783. [key: string]: Float32Array;
  96784. };
  96785. sizes: {
  96786. [key: string]: number;
  96787. };
  96788. vertexBuffers: {
  96789. [key: string]: Nullable<VertexBuffer>;
  96790. };
  96791. strides: {
  96792. [key: string]: number;
  96793. };
  96794. };
  96795. }
  96796. interface AbstractMesh {
  96797. /**
  96798. * Object used to store instanced buffers defined by user
  96799. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  96800. */
  96801. instancedBuffers: {
  96802. [key: string]: any;
  96803. };
  96804. }
  96805. }
  96806. declare module BABYLON {
  96807. /**
  96808. * Defines the options associated with the creation of a shader material.
  96809. */
  96810. export interface IShaderMaterialOptions {
  96811. /**
  96812. * Does the material work in alpha blend mode
  96813. */
  96814. needAlphaBlending: boolean;
  96815. /**
  96816. * Does the material work in alpha test mode
  96817. */
  96818. needAlphaTesting: boolean;
  96819. /**
  96820. * The list of attribute names used in the shader
  96821. */
  96822. attributes: string[];
  96823. /**
  96824. * The list of unifrom names used in the shader
  96825. */
  96826. uniforms: string[];
  96827. /**
  96828. * The list of UBO names used in the shader
  96829. */
  96830. uniformBuffers: string[];
  96831. /**
  96832. * The list of sampler names used in the shader
  96833. */
  96834. samplers: string[];
  96835. /**
  96836. * The list of defines used in the shader
  96837. */
  96838. defines: string[];
  96839. }
  96840. /**
  96841. * 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.
  96842. *
  96843. * This returned material effects how the mesh will look based on the code in the shaders.
  96844. *
  96845. * @see https://doc.babylonjs.com/how_to/shader_material
  96846. */
  96847. export class ShaderMaterial extends Material {
  96848. private _shaderPath;
  96849. private _options;
  96850. private _textures;
  96851. private _textureArrays;
  96852. private _floats;
  96853. private _ints;
  96854. private _floatsArrays;
  96855. private _colors3;
  96856. private _colors3Arrays;
  96857. private _colors4;
  96858. private _colors4Arrays;
  96859. private _vectors2;
  96860. private _vectors3;
  96861. private _vectors4;
  96862. private _matrices;
  96863. private _matrixArrays;
  96864. private _matrices3x3;
  96865. private _matrices2x2;
  96866. private _vectors2Arrays;
  96867. private _vectors3Arrays;
  96868. private _vectors4Arrays;
  96869. private _cachedWorldViewMatrix;
  96870. private _cachedWorldViewProjectionMatrix;
  96871. private _renderId;
  96872. private _multiview;
  96873. private _cachedDefines;
  96874. /** Define the Url to load snippets */
  96875. static SnippetUrl: string;
  96876. /** Snippet ID if the material was created from the snippet server */
  96877. snippetId: string;
  96878. /**
  96879. * Instantiate a new shader material.
  96880. * 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.
  96881. * This returned material effects how the mesh will look based on the code in the shaders.
  96882. * @see https://doc.babylonjs.com/how_to/shader_material
  96883. * @param name Define the name of the material in the scene
  96884. * @param scene Define the scene the material belongs to
  96885. * @param shaderPath Defines the route to the shader code in one of three ways:
  96886. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  96887. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  96888. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  96889. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  96890. * @param options Define the options used to create the shader
  96891. */
  96892. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  96893. /**
  96894. * Gets the shader path used to define the shader code
  96895. * It can be modified to trigger a new compilation
  96896. */
  96897. get shaderPath(): any;
  96898. /**
  96899. * Sets the shader path used to define the shader code
  96900. * It can be modified to trigger a new compilation
  96901. */
  96902. set shaderPath(shaderPath: any);
  96903. /**
  96904. * Gets the options used to compile the shader.
  96905. * They can be modified to trigger a new compilation
  96906. */
  96907. get options(): IShaderMaterialOptions;
  96908. /**
  96909. * Gets the current class name of the material e.g. "ShaderMaterial"
  96910. * Mainly use in serialization.
  96911. * @returns the class name
  96912. */
  96913. getClassName(): string;
  96914. /**
  96915. * Specifies if the material will require alpha blending
  96916. * @returns a boolean specifying if alpha blending is needed
  96917. */
  96918. needAlphaBlending(): boolean;
  96919. /**
  96920. * Specifies if this material should be rendered in alpha test mode
  96921. * @returns a boolean specifying if an alpha test is needed.
  96922. */
  96923. needAlphaTesting(): boolean;
  96924. private _checkUniform;
  96925. /**
  96926. * Set a texture in the shader.
  96927. * @param name Define the name of the uniform samplers as defined in the shader
  96928. * @param texture Define the texture to bind to this sampler
  96929. * @return the material itself allowing "fluent" like uniform updates
  96930. */
  96931. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  96932. /**
  96933. * Set a texture array in the shader.
  96934. * @param name Define the name of the uniform sampler array as defined in the shader
  96935. * @param textures Define the list of textures to bind to this sampler
  96936. * @return the material itself allowing "fluent" like uniform updates
  96937. */
  96938. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  96939. /**
  96940. * Set a float in the shader.
  96941. * @param name Define the name of the uniform as defined in the shader
  96942. * @param value Define the value to give to the uniform
  96943. * @return the material itself allowing "fluent" like uniform updates
  96944. */
  96945. setFloat(name: string, value: number): ShaderMaterial;
  96946. /**
  96947. * Set a int in the shader.
  96948. * @param name Define the name of the uniform as defined in the shader
  96949. * @param value Define the value to give to the uniform
  96950. * @return the material itself allowing "fluent" like uniform updates
  96951. */
  96952. setInt(name: string, value: number): ShaderMaterial;
  96953. /**
  96954. * Set an array of floats in the shader.
  96955. * @param name Define the name of the uniform as defined in the shader
  96956. * @param value Define the value to give to the uniform
  96957. * @return the material itself allowing "fluent" like uniform updates
  96958. */
  96959. setFloats(name: string, value: number[]): ShaderMaterial;
  96960. /**
  96961. * Set a vec3 in the shader from a Color3.
  96962. * @param name Define the name of the uniform as defined in the shader
  96963. * @param value Define the value to give to the uniform
  96964. * @return the material itself allowing "fluent" like uniform updates
  96965. */
  96966. setColor3(name: string, value: Color3): ShaderMaterial;
  96967. /**
  96968. * Set a vec3 array in the shader from a Color3 array.
  96969. * @param name Define the name of the uniform as defined in the shader
  96970. * @param value Define the value to give to the uniform
  96971. * @return the material itself allowing "fluent" like uniform updates
  96972. */
  96973. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  96974. /**
  96975. * Set a vec4 in the shader from a Color4.
  96976. * @param name Define the name of the uniform as defined in the shader
  96977. * @param value Define the value to give to the uniform
  96978. * @return the material itself allowing "fluent" like uniform updates
  96979. */
  96980. setColor4(name: string, value: Color4): ShaderMaterial;
  96981. /**
  96982. * Set a vec4 array in the shader from a Color4 array.
  96983. * @param name Define the name of the uniform as defined in the shader
  96984. * @param value Define the value to give to the uniform
  96985. * @return the material itself allowing "fluent" like uniform updates
  96986. */
  96987. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  96988. /**
  96989. * Set a vec2 in the shader from a Vector2.
  96990. * @param name Define the name of the uniform as defined in the shader
  96991. * @param value Define the value to give to the uniform
  96992. * @return the material itself allowing "fluent" like uniform updates
  96993. */
  96994. setVector2(name: string, value: Vector2): ShaderMaterial;
  96995. /**
  96996. * Set a vec3 in the shader from a Vector3.
  96997. * @param name Define the name of the uniform as defined in the shader
  96998. * @param value Define the value to give to the uniform
  96999. * @return the material itself allowing "fluent" like uniform updates
  97000. */
  97001. setVector3(name: string, value: Vector3): ShaderMaterial;
  97002. /**
  97003. * Set a vec4 in the shader from a Vector4.
  97004. * @param name Define the name of the uniform as defined in the shader
  97005. * @param value Define the value to give to the uniform
  97006. * @return the material itself allowing "fluent" like uniform updates
  97007. */
  97008. setVector4(name: string, value: Vector4): ShaderMaterial;
  97009. /**
  97010. * Set a mat4 in the shader from a Matrix.
  97011. * @param name Define the name of the uniform as defined in the shader
  97012. * @param value Define the value to give to the uniform
  97013. * @return the material itself allowing "fluent" like uniform updates
  97014. */
  97015. setMatrix(name: string, value: Matrix): ShaderMaterial;
  97016. /**
  97017. * Set a float32Array in the shader from a matrix array.
  97018. * @param name Define the name of the uniform as defined in the shader
  97019. * @param value Define the value to give to the uniform
  97020. * @return the material itself allowing "fluent" like uniform updates
  97021. */
  97022. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  97023. /**
  97024. * Set a mat3 in the shader from a Float32Array.
  97025. * @param name Define the name of the uniform as defined in the shader
  97026. * @param value Define the value to give to the uniform
  97027. * @return the material itself allowing "fluent" like uniform updates
  97028. */
  97029. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  97030. /**
  97031. * Set a mat2 in the shader from a Float32Array.
  97032. * @param name Define the name of the uniform as defined in the shader
  97033. * @param value Define the value to give to the uniform
  97034. * @return the material itself allowing "fluent" like uniform updates
  97035. */
  97036. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  97037. /**
  97038. * Set a vec2 array in the shader from a number array.
  97039. * @param name Define the name of the uniform as defined in the shader
  97040. * @param value Define the value to give to the uniform
  97041. * @return the material itself allowing "fluent" like uniform updates
  97042. */
  97043. setArray2(name: string, value: number[]): ShaderMaterial;
  97044. /**
  97045. * Set a vec3 array in the shader from a number array.
  97046. * @param name Define the name of the uniform as defined in the shader
  97047. * @param value Define the value to give to the uniform
  97048. * @return the material itself allowing "fluent" like uniform updates
  97049. */
  97050. setArray3(name: string, value: number[]): ShaderMaterial;
  97051. /**
  97052. * Set a vec4 array in the shader from a number array.
  97053. * @param name Define the name of the uniform as defined in the shader
  97054. * @param value Define the value to give to the uniform
  97055. * @return the material itself allowing "fluent" like uniform updates
  97056. */
  97057. setArray4(name: string, value: number[]): ShaderMaterial;
  97058. private _checkCache;
  97059. /**
  97060. * Specifies that the submesh is ready to be used
  97061. * @param mesh defines the mesh to check
  97062. * @param subMesh defines which submesh to check
  97063. * @param useInstances specifies that instances should be used
  97064. * @returns a boolean indicating that the submesh is ready or not
  97065. */
  97066. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  97067. /**
  97068. * Checks if the material is ready to render the requested mesh
  97069. * @param mesh Define the mesh to render
  97070. * @param useInstances Define whether or not the material is used with instances
  97071. * @returns true if ready, otherwise false
  97072. */
  97073. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  97074. /**
  97075. * Binds the world matrix to the material
  97076. * @param world defines the world transformation matrix
  97077. * @param effectOverride - If provided, use this effect instead of internal effect
  97078. */
  97079. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  97080. /**
  97081. * Binds the submesh to this material by preparing the effect and shader to draw
  97082. * @param world defines the world transformation matrix
  97083. * @param mesh defines the mesh containing the submesh
  97084. * @param subMesh defines the submesh to bind the material to
  97085. */
  97086. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  97087. /**
  97088. * Binds the material to the mesh
  97089. * @param world defines the world transformation matrix
  97090. * @param mesh defines the mesh to bind the material to
  97091. * @param effectOverride - If provided, use this effect instead of internal effect
  97092. */
  97093. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  97094. protected _afterBind(mesh?: Mesh): void;
  97095. /**
  97096. * Gets the active textures from the material
  97097. * @returns an array of textures
  97098. */
  97099. getActiveTextures(): BaseTexture[];
  97100. /**
  97101. * Specifies if the material uses a texture
  97102. * @param texture defines the texture to check against the material
  97103. * @returns a boolean specifying if the material uses the texture
  97104. */
  97105. hasTexture(texture: BaseTexture): boolean;
  97106. /**
  97107. * Makes a duplicate of the material, and gives it a new name
  97108. * @param name defines the new name for the duplicated material
  97109. * @returns the cloned material
  97110. */
  97111. clone(name: string): ShaderMaterial;
  97112. /**
  97113. * Disposes the material
  97114. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  97115. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  97116. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  97117. */
  97118. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  97119. /**
  97120. * Serializes this material in a JSON representation
  97121. * @returns the serialized material object
  97122. */
  97123. serialize(): any;
  97124. /**
  97125. * Creates a shader material from parsed shader material data
  97126. * @param source defines the JSON represnetation of the material
  97127. * @param scene defines the hosting scene
  97128. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  97129. * @returns a new material
  97130. */
  97131. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  97132. /**
  97133. * Creates a new ShaderMaterial from a snippet saved in a remote file
  97134. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  97135. * @param url defines the url to load from
  97136. * @param scene defines the hosting scene
  97137. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  97138. * @returns a promise that will resolve to the new ShaderMaterial
  97139. */
  97140. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  97141. /**
  97142. * Creates a ShaderMaterial from a snippet saved by the Inspector
  97143. * @param snippetId defines the snippet to load
  97144. * @param scene defines the hosting scene
  97145. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  97146. * @returns a promise that will resolve to the new ShaderMaterial
  97147. */
  97148. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  97149. }
  97150. }
  97151. declare module BABYLON {
  97152. /** @hidden */
  97153. export var colorPixelShader: {
  97154. name: string;
  97155. shader: string;
  97156. };
  97157. }
  97158. declare module BABYLON {
  97159. /** @hidden */
  97160. export var colorVertexShader: {
  97161. name: string;
  97162. shader: string;
  97163. };
  97164. }
  97165. declare module BABYLON {
  97166. /**
  97167. * Line mesh
  97168. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  97169. */
  97170. export class LinesMesh extends Mesh {
  97171. /**
  97172. * If vertex color should be applied to the mesh
  97173. */
  97174. readonly useVertexColor?: boolean | undefined;
  97175. /**
  97176. * If vertex alpha should be applied to the mesh
  97177. */
  97178. readonly useVertexAlpha?: boolean | undefined;
  97179. /**
  97180. * Color of the line (Default: White)
  97181. */
  97182. color: Color3;
  97183. /**
  97184. * Alpha of the line (Default: 1)
  97185. */
  97186. alpha: number;
  97187. /**
  97188. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  97189. * This margin is expressed in world space coordinates, so its value may vary.
  97190. * Default value is 0.1
  97191. */
  97192. intersectionThreshold: number;
  97193. private _colorShader;
  97194. private color4;
  97195. /**
  97196. * Creates a new LinesMesh
  97197. * @param name defines the name
  97198. * @param scene defines the hosting scene
  97199. * @param parent defines the parent mesh if any
  97200. * @param source defines the optional source LinesMesh used to clone data from
  97201. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  97202. * When false, achieved by calling a clone(), also passing False.
  97203. * This will make creation of children, recursive.
  97204. * @param useVertexColor defines if this LinesMesh supports vertex color
  97205. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  97206. */
  97207. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  97208. /**
  97209. * If vertex color should be applied to the mesh
  97210. */
  97211. useVertexColor?: boolean | undefined,
  97212. /**
  97213. * If vertex alpha should be applied to the mesh
  97214. */
  97215. useVertexAlpha?: boolean | undefined);
  97216. private _addClipPlaneDefine;
  97217. private _removeClipPlaneDefine;
  97218. isReady(): boolean;
  97219. /**
  97220. * Returns the string "LineMesh"
  97221. */
  97222. getClassName(): string;
  97223. /**
  97224. * @hidden
  97225. */
  97226. get material(): Material;
  97227. /**
  97228. * @hidden
  97229. */
  97230. set material(value: Material);
  97231. /**
  97232. * @hidden
  97233. */
  97234. get checkCollisions(): boolean;
  97235. /** @hidden */
  97236. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  97237. /** @hidden */
  97238. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  97239. /**
  97240. * Disposes of the line mesh
  97241. * @param doNotRecurse If children should be disposed
  97242. */
  97243. dispose(doNotRecurse?: boolean): void;
  97244. /**
  97245. * Returns a new LineMesh object cloned from the current one.
  97246. */
  97247. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  97248. /**
  97249. * Creates a new InstancedLinesMesh object from the mesh model.
  97250. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  97251. * @param name defines the name of the new instance
  97252. * @returns a new InstancedLinesMesh
  97253. */
  97254. createInstance(name: string): InstancedLinesMesh;
  97255. }
  97256. /**
  97257. * Creates an instance based on a source LinesMesh
  97258. */
  97259. export class InstancedLinesMesh extends InstancedMesh {
  97260. /**
  97261. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  97262. * This margin is expressed in world space coordinates, so its value may vary.
  97263. * Initilized with the intersectionThreshold value of the source LinesMesh
  97264. */
  97265. intersectionThreshold: number;
  97266. constructor(name: string, source: LinesMesh);
  97267. /**
  97268. * Returns the string "InstancedLinesMesh".
  97269. */
  97270. getClassName(): string;
  97271. }
  97272. }
  97273. declare module BABYLON {
  97274. /** @hidden */
  97275. export var linePixelShader: {
  97276. name: string;
  97277. shader: string;
  97278. };
  97279. }
  97280. declare module BABYLON {
  97281. /** @hidden */
  97282. export var lineVertexShader: {
  97283. name: string;
  97284. shader: string;
  97285. };
  97286. }
  97287. declare module BABYLON {
  97288. interface Scene {
  97289. /** @hidden */
  97290. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  97291. }
  97292. interface AbstractMesh {
  97293. /**
  97294. * Gets the edgesRenderer associated with the mesh
  97295. */
  97296. edgesRenderer: Nullable<EdgesRenderer>;
  97297. }
  97298. interface LinesMesh {
  97299. /**
  97300. * Enables the edge rendering mode on the mesh.
  97301. * This mode makes the mesh edges visible
  97302. * @param epsilon defines the maximal distance between two angles to detect a face
  97303. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  97304. * @returns the currentAbstractMesh
  97305. * @see https://www.babylonjs-playground.com/#19O9TU#0
  97306. */
  97307. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  97308. }
  97309. interface InstancedLinesMesh {
  97310. /**
  97311. * Enables the edge rendering mode on the mesh.
  97312. * This mode makes the mesh edges visible
  97313. * @param epsilon defines the maximal distance between two angles to detect a face
  97314. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  97315. * @returns the current InstancedLinesMesh
  97316. * @see https://www.babylonjs-playground.com/#19O9TU#0
  97317. */
  97318. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  97319. }
  97320. /**
  97321. * Defines the minimum contract an Edges renderer should follow.
  97322. */
  97323. export interface IEdgesRenderer extends IDisposable {
  97324. /**
  97325. * Gets or sets a boolean indicating if the edgesRenderer is active
  97326. */
  97327. isEnabled: boolean;
  97328. /**
  97329. * Renders the edges of the attached mesh,
  97330. */
  97331. render(): void;
  97332. /**
  97333. * Checks wether or not the edges renderer is ready to render.
  97334. * @return true if ready, otherwise false.
  97335. */
  97336. isReady(): boolean;
  97337. /**
  97338. * List of instances to render in case the source mesh has instances
  97339. */
  97340. customInstances: SmartArray<Matrix>;
  97341. }
  97342. /**
  97343. * Defines the additional options of the edges renderer
  97344. */
  97345. export interface IEdgesRendererOptions {
  97346. /**
  97347. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  97348. * If not defined, the default value is true
  97349. */
  97350. useAlternateEdgeFinder?: boolean;
  97351. /**
  97352. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  97353. * If not defined, the default value is true.
  97354. * 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)
  97355. * This option is used only if useAlternateEdgeFinder = true
  97356. */
  97357. useFastVertexMerger?: boolean;
  97358. /**
  97359. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  97360. * The default value is 1e-6
  97361. * This option is used only if useAlternateEdgeFinder = true
  97362. */
  97363. epsilonVertexMerge?: number;
  97364. /**
  97365. * 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
  97366. * 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.
  97367. * This option is used only if useAlternateEdgeFinder = true
  97368. */
  97369. applyTessellation?: boolean;
  97370. /**
  97371. * 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
  97372. * The default value is 1e-6
  97373. * This option is used only if useAlternateEdgeFinder = true
  97374. */
  97375. epsilonVertexAligned?: number;
  97376. }
  97377. /**
  97378. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  97379. */
  97380. export class EdgesRenderer implements IEdgesRenderer {
  97381. /**
  97382. * Define the size of the edges with an orthographic camera
  97383. */
  97384. edgesWidthScalerForOrthographic: number;
  97385. /**
  97386. * Define the size of the edges with a perspective camera
  97387. */
  97388. edgesWidthScalerForPerspective: number;
  97389. protected _source: AbstractMesh;
  97390. protected _linesPositions: number[];
  97391. protected _linesNormals: number[];
  97392. protected _linesIndices: number[];
  97393. protected _epsilon: number;
  97394. protected _indicesCount: number;
  97395. protected _lineShader: ShaderMaterial;
  97396. protected _ib: DataBuffer;
  97397. protected _buffers: {
  97398. [key: string]: Nullable<VertexBuffer>;
  97399. };
  97400. protected _buffersForInstances: {
  97401. [key: string]: Nullable<VertexBuffer>;
  97402. };
  97403. protected _checkVerticesInsteadOfIndices: boolean;
  97404. protected _options: Nullable<IEdgesRendererOptions>;
  97405. private _meshRebuildObserver;
  97406. private _meshDisposeObserver;
  97407. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  97408. isEnabled: boolean;
  97409. /**
  97410. * List of instances to render in case the source mesh has instances
  97411. */
  97412. customInstances: SmartArray<Matrix>;
  97413. private static GetShader;
  97414. /**
  97415. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  97416. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  97417. * @param source Mesh used to create edges
  97418. * @param epsilon sum of angles in adjacency to check for edge
  97419. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  97420. * @param generateEdgesLines - should generate Lines or only prepare resources.
  97421. * @param options The options to apply when generating the edges
  97422. */
  97423. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  97424. protected _prepareRessources(): void;
  97425. /** @hidden */
  97426. _rebuild(): void;
  97427. /**
  97428. * Releases the required resources for the edges renderer
  97429. */
  97430. dispose(): void;
  97431. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  97432. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  97433. /**
  97434. * Checks if the pair of p0 and p1 is en edge
  97435. * @param faceIndex
  97436. * @param edge
  97437. * @param faceNormals
  97438. * @param p0
  97439. * @param p1
  97440. * @private
  97441. */
  97442. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  97443. /**
  97444. * push line into the position, normal and index buffer
  97445. * @protected
  97446. */
  97447. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  97448. /**
  97449. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  97450. */
  97451. private _tessellateTriangle;
  97452. private _generateEdgesLinesAlternate;
  97453. /**
  97454. * Generates lines edges from adjacencjes
  97455. * @private
  97456. */
  97457. _generateEdgesLines(): void;
  97458. /**
  97459. * Checks wether or not the edges renderer is ready to render.
  97460. * @return true if ready, otherwise false.
  97461. */
  97462. isReady(): boolean;
  97463. /**
  97464. * Renders the edges of the attached mesh,
  97465. */
  97466. render(): void;
  97467. }
  97468. /**
  97469. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  97470. */
  97471. export class LineEdgesRenderer extends EdgesRenderer {
  97472. /**
  97473. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  97474. * @param source LineMesh used to generate edges
  97475. * @param epsilon not important (specified angle for edge detection)
  97476. * @param checkVerticesInsteadOfIndices not important for LineMesh
  97477. */
  97478. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  97479. /**
  97480. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  97481. */
  97482. _generateEdgesLines(): void;
  97483. }
  97484. }
  97485. declare module BABYLON {
  97486. /**
  97487. * This represents the object necessary to create a rendering group.
  97488. * This is exclusively used and created by the rendering manager.
  97489. * To modify the behavior, you use the available helpers in your scene or meshes.
  97490. * @hidden
  97491. */
  97492. export class RenderingGroup {
  97493. index: number;
  97494. private static _zeroVector;
  97495. private _scene;
  97496. private _opaqueSubMeshes;
  97497. private _transparentSubMeshes;
  97498. private _alphaTestSubMeshes;
  97499. private _depthOnlySubMeshes;
  97500. private _particleSystems;
  97501. private _spriteManagers;
  97502. private _opaqueSortCompareFn;
  97503. private _alphaTestSortCompareFn;
  97504. private _transparentSortCompareFn;
  97505. private _renderOpaque;
  97506. private _renderAlphaTest;
  97507. private _renderTransparent;
  97508. /** @hidden */
  97509. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  97510. onBeforeTransparentRendering: () => void;
  97511. /**
  97512. * Set the opaque sort comparison function.
  97513. * If null the sub meshes will be render in the order they were created
  97514. */
  97515. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  97516. /**
  97517. * Set the alpha test sort comparison function.
  97518. * If null the sub meshes will be render in the order they were created
  97519. */
  97520. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  97521. /**
  97522. * Set the transparent sort comparison function.
  97523. * If null the sub meshes will be render in the order they were created
  97524. */
  97525. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  97526. /**
  97527. * Creates a new rendering group.
  97528. * @param index The rendering group index
  97529. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  97530. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  97531. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  97532. */
  97533. 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>);
  97534. /**
  97535. * Render all the sub meshes contained in the group.
  97536. * @param customRenderFunction Used to override the default render behaviour of the group.
  97537. * @returns true if rendered some submeshes.
  97538. */
  97539. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  97540. /**
  97541. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  97542. * @param subMeshes The submeshes to render
  97543. */
  97544. private renderOpaqueSorted;
  97545. /**
  97546. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  97547. * @param subMeshes The submeshes to render
  97548. */
  97549. private renderAlphaTestSorted;
  97550. /**
  97551. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  97552. * @param subMeshes The submeshes to render
  97553. */
  97554. private renderTransparentSorted;
  97555. /**
  97556. * Renders the submeshes in a specified order.
  97557. * @param subMeshes The submeshes to sort before render
  97558. * @param sortCompareFn The comparison function use to sort
  97559. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  97560. * @param transparent Specifies to activate blending if true
  97561. */
  97562. private static renderSorted;
  97563. /**
  97564. * Renders the submeshes in the order they were dispatched (no sort applied).
  97565. * @param subMeshes The submeshes to render
  97566. */
  97567. private static renderUnsorted;
  97568. /**
  97569. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  97570. * are rendered back to front if in the same alpha index.
  97571. *
  97572. * @param a The first submesh
  97573. * @param b The second submesh
  97574. * @returns The result of the comparison
  97575. */
  97576. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  97577. /**
  97578. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  97579. * are rendered back to front.
  97580. *
  97581. * @param a The first submesh
  97582. * @param b The second submesh
  97583. * @returns The result of the comparison
  97584. */
  97585. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  97586. /**
  97587. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  97588. * are rendered front to back (prevent overdraw).
  97589. *
  97590. * @param a The first submesh
  97591. * @param b The second submesh
  97592. * @returns The result of the comparison
  97593. */
  97594. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  97595. /**
  97596. * Resets the different lists of submeshes to prepare a new frame.
  97597. */
  97598. prepare(): void;
  97599. dispose(): void;
  97600. /**
  97601. * Inserts the submesh in its correct queue depending on its material.
  97602. * @param subMesh The submesh to dispatch
  97603. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  97604. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  97605. */
  97606. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  97607. dispatchSprites(spriteManager: ISpriteManager): void;
  97608. dispatchParticles(particleSystem: IParticleSystem): void;
  97609. private _renderParticles;
  97610. private _renderSprites;
  97611. }
  97612. }
  97613. declare module BABYLON {
  97614. /**
  97615. * Interface describing the different options available in the rendering manager
  97616. * regarding Auto Clear between groups.
  97617. */
  97618. export interface IRenderingManagerAutoClearSetup {
  97619. /**
  97620. * Defines whether or not autoclear is enable.
  97621. */
  97622. autoClear: boolean;
  97623. /**
  97624. * Defines whether or not to autoclear the depth buffer.
  97625. */
  97626. depth: boolean;
  97627. /**
  97628. * Defines whether or not to autoclear the stencil buffer.
  97629. */
  97630. stencil: boolean;
  97631. }
  97632. /**
  97633. * This class is used by the onRenderingGroupObservable
  97634. */
  97635. export class RenderingGroupInfo {
  97636. /**
  97637. * The Scene that being rendered
  97638. */
  97639. scene: Scene;
  97640. /**
  97641. * The camera currently used for the rendering pass
  97642. */
  97643. camera: Nullable<Camera>;
  97644. /**
  97645. * The ID of the renderingGroup being processed
  97646. */
  97647. renderingGroupId: number;
  97648. }
  97649. /**
  97650. * This is the manager responsible of all the rendering for meshes sprites and particles.
  97651. * It is enable to manage the different groups as well as the different necessary sort functions.
  97652. * This should not be used directly aside of the few static configurations
  97653. */
  97654. export class RenderingManager {
  97655. /**
  97656. * The max id used for rendering groups (not included)
  97657. */
  97658. static MAX_RENDERINGGROUPS: number;
  97659. /**
  97660. * The min id used for rendering groups (included)
  97661. */
  97662. static MIN_RENDERINGGROUPS: number;
  97663. /**
  97664. * Used to globally prevent autoclearing scenes.
  97665. */
  97666. static AUTOCLEAR: boolean;
  97667. /**
  97668. * @hidden
  97669. */
  97670. _useSceneAutoClearSetup: boolean;
  97671. private _scene;
  97672. private _renderingGroups;
  97673. private _depthStencilBufferAlreadyCleaned;
  97674. private _autoClearDepthStencil;
  97675. private _customOpaqueSortCompareFn;
  97676. private _customAlphaTestSortCompareFn;
  97677. private _customTransparentSortCompareFn;
  97678. private _renderingGroupInfo;
  97679. /**
  97680. * Instantiates a new rendering group for a particular scene
  97681. * @param scene Defines the scene the groups belongs to
  97682. */
  97683. constructor(scene: Scene);
  97684. private _clearDepthStencilBuffer;
  97685. /**
  97686. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  97687. * @hidden
  97688. */
  97689. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  97690. /**
  97691. * Resets the different information of the group to prepare a new frame
  97692. * @hidden
  97693. */
  97694. reset(): void;
  97695. /**
  97696. * Dispose and release the group and its associated resources.
  97697. * @hidden
  97698. */
  97699. dispose(): void;
  97700. /**
  97701. * Clear the info related to rendering groups preventing retention points during dispose.
  97702. */
  97703. freeRenderingGroups(): void;
  97704. private _prepareRenderingGroup;
  97705. /**
  97706. * Add a sprite manager to the rendering manager in order to render it this frame.
  97707. * @param spriteManager Define the sprite manager to render
  97708. */
  97709. dispatchSprites(spriteManager: ISpriteManager): void;
  97710. /**
  97711. * Add a particle system to the rendering manager in order to render it this frame.
  97712. * @param particleSystem Define the particle system to render
  97713. */
  97714. dispatchParticles(particleSystem: IParticleSystem): void;
  97715. /**
  97716. * Add a submesh to the manager in order to render it this frame
  97717. * @param subMesh The submesh to dispatch
  97718. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  97719. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  97720. */
  97721. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  97722. /**
  97723. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  97724. * This allowed control for front to back rendering or reversly depending of the special needs.
  97725. *
  97726. * @param renderingGroupId The rendering group id corresponding to its index
  97727. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  97728. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  97729. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  97730. */
  97731. 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;
  97732. /**
  97733. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  97734. *
  97735. * @param renderingGroupId The rendering group id corresponding to its index
  97736. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  97737. * @param depth Automatically clears depth between groups if true and autoClear is true.
  97738. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  97739. */
  97740. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  97741. /**
  97742. * Gets the current auto clear configuration for one rendering group of the rendering
  97743. * manager.
  97744. * @param index the rendering group index to get the information for
  97745. * @returns The auto clear setup for the requested rendering group
  97746. */
  97747. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  97748. }
  97749. }
  97750. declare module BABYLON {
  97751. /**
  97752. * Defines the options associated with the creation of a custom shader for a shadow generator.
  97753. */
  97754. export interface ICustomShaderOptions {
  97755. /**
  97756. * Gets or sets the custom shader name to use
  97757. */
  97758. shaderName: string;
  97759. /**
  97760. * The list of attribute names used in the shader
  97761. */
  97762. attributes?: string[];
  97763. /**
  97764. * The list of unifrom names used in the shader
  97765. */
  97766. uniforms?: string[];
  97767. /**
  97768. * The list of sampler names used in the shader
  97769. */
  97770. samplers?: string[];
  97771. /**
  97772. * The list of defines used in the shader
  97773. */
  97774. defines?: string[];
  97775. }
  97776. /**
  97777. * Interface to implement to create a shadow generator compatible with BJS.
  97778. */
  97779. export interface IShadowGenerator {
  97780. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  97781. id: string;
  97782. /**
  97783. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  97784. * @returns The render target texture if present otherwise, null
  97785. */
  97786. getShadowMap(): Nullable<RenderTargetTexture>;
  97787. /**
  97788. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  97789. * @param subMesh The submesh we want to render in the shadow map
  97790. * @param useInstances Defines wether will draw in the map using instances
  97791. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  97792. * @returns true if ready otherwise, false
  97793. */
  97794. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  97795. /**
  97796. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  97797. * @param defines Defines of the material we want to update
  97798. * @param lightIndex Index of the light in the enabled light list of the material
  97799. */
  97800. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  97801. /**
  97802. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  97803. * defined in the generator but impacting the effect).
  97804. * It implies the unifroms available on the materials are the standard BJS ones.
  97805. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  97806. * @param effect The effect we are binfing the information for
  97807. */
  97808. bindShadowLight(lightIndex: string, effect: Effect): void;
  97809. /**
  97810. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  97811. * (eq to shadow prjection matrix * light transform matrix)
  97812. * @returns The transform matrix used to create the shadow map
  97813. */
  97814. getTransformMatrix(): Matrix;
  97815. /**
  97816. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  97817. * Cube and 2D textures for instance.
  97818. */
  97819. recreateShadowMap(): void;
  97820. /**
  97821. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97822. * @param onCompiled Callback triggered at the and of the effects compilation
  97823. * @param options Sets of optional options forcing the compilation with different modes
  97824. */
  97825. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  97826. useInstances: boolean;
  97827. }>): void;
  97828. /**
  97829. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97830. * @param options Sets of optional options forcing the compilation with different modes
  97831. * @returns A promise that resolves when the compilation completes
  97832. */
  97833. forceCompilationAsync(options?: Partial<{
  97834. useInstances: boolean;
  97835. }>): Promise<void>;
  97836. /**
  97837. * Serializes the shadow generator setup to a json object.
  97838. * @returns The serialized JSON object
  97839. */
  97840. serialize(): any;
  97841. /**
  97842. * Disposes the Shadow map and related Textures and effects.
  97843. */
  97844. dispose(): void;
  97845. }
  97846. /**
  97847. * Default implementation IShadowGenerator.
  97848. * This is the main object responsible of generating shadows in the framework.
  97849. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  97850. */
  97851. export class ShadowGenerator implements IShadowGenerator {
  97852. /**
  97853. * Name of the shadow generator class
  97854. */
  97855. static CLASSNAME: string;
  97856. /**
  97857. * Shadow generator mode None: no filtering applied.
  97858. */
  97859. static readonly FILTER_NONE: number;
  97860. /**
  97861. * Shadow generator mode ESM: Exponential Shadow Mapping.
  97862. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97863. */
  97864. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  97865. /**
  97866. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  97867. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  97868. */
  97869. static readonly FILTER_POISSONSAMPLING: number;
  97870. /**
  97871. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  97872. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97873. */
  97874. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  97875. /**
  97876. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  97877. * edge artifacts on steep falloff.
  97878. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97879. */
  97880. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  97881. /**
  97882. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  97883. * edge artifacts on steep falloff.
  97884. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97885. */
  97886. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  97887. /**
  97888. * Shadow generator mode PCF: Percentage Closer Filtering
  97889. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  97890. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  97891. */
  97892. static readonly FILTER_PCF: number;
  97893. /**
  97894. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  97895. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  97896. * Contact Hardening
  97897. */
  97898. static readonly FILTER_PCSS: number;
  97899. /**
  97900. * Reserved for PCF and PCSS
  97901. * Highest Quality.
  97902. *
  97903. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  97904. *
  97905. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  97906. */
  97907. static readonly QUALITY_HIGH: number;
  97908. /**
  97909. * Reserved for PCF and PCSS
  97910. * Good tradeoff for quality/perf cross devices
  97911. *
  97912. * Execute PCF on a 3*3 kernel.
  97913. *
  97914. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  97915. */
  97916. static readonly QUALITY_MEDIUM: number;
  97917. /**
  97918. * Reserved for PCF and PCSS
  97919. * The lowest quality but the fastest.
  97920. *
  97921. * Execute PCF on a 1*1 kernel.
  97922. *
  97923. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  97924. */
  97925. static readonly QUALITY_LOW: number;
  97926. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  97927. id: string;
  97928. /** Gets or sets the custom shader name to use */
  97929. customShaderOptions: ICustomShaderOptions;
  97930. /**
  97931. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  97932. */
  97933. onBeforeShadowMapRenderObservable: Observable<Effect>;
  97934. /**
  97935. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  97936. */
  97937. onAfterShadowMapRenderObservable: Observable<Effect>;
  97938. /**
  97939. * Observable triggered before a mesh is rendered in the shadow map.
  97940. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  97941. */
  97942. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  97943. /**
  97944. * Observable triggered after a mesh is rendered in the shadow map.
  97945. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  97946. */
  97947. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  97948. protected _bias: number;
  97949. /**
  97950. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  97951. */
  97952. get bias(): number;
  97953. /**
  97954. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  97955. */
  97956. set bias(bias: number);
  97957. protected _normalBias: number;
  97958. /**
  97959. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  97960. */
  97961. get normalBias(): number;
  97962. /**
  97963. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  97964. */
  97965. set normalBias(normalBias: number);
  97966. protected _blurBoxOffset: number;
  97967. /**
  97968. * Gets the blur box offset: offset applied during the blur pass.
  97969. * Only useful if useKernelBlur = false
  97970. */
  97971. get blurBoxOffset(): number;
  97972. /**
  97973. * Sets the blur box offset: offset applied during the blur pass.
  97974. * Only useful if useKernelBlur = false
  97975. */
  97976. set blurBoxOffset(value: number);
  97977. protected _blurScale: number;
  97978. /**
  97979. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  97980. * 2 means half of the size.
  97981. */
  97982. get blurScale(): number;
  97983. /**
  97984. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  97985. * 2 means half of the size.
  97986. */
  97987. set blurScale(value: number);
  97988. protected _blurKernel: number;
  97989. /**
  97990. * Gets the blur kernel: kernel size of the blur pass.
  97991. * Only useful if useKernelBlur = true
  97992. */
  97993. get blurKernel(): number;
  97994. /**
  97995. * Sets the blur kernel: kernel size of the blur pass.
  97996. * Only useful if useKernelBlur = true
  97997. */
  97998. set blurKernel(value: number);
  97999. protected _useKernelBlur: boolean;
  98000. /**
  98001. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  98002. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  98003. */
  98004. get useKernelBlur(): boolean;
  98005. /**
  98006. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  98007. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  98008. */
  98009. set useKernelBlur(value: boolean);
  98010. protected _depthScale: number;
  98011. /**
  98012. * Gets the depth scale used in ESM mode.
  98013. */
  98014. get depthScale(): number;
  98015. /**
  98016. * Sets the depth scale used in ESM mode.
  98017. * This can override the scale stored on the light.
  98018. */
  98019. set depthScale(value: number);
  98020. protected _validateFilter(filter: number): number;
  98021. protected _filter: number;
  98022. /**
  98023. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  98024. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  98025. */
  98026. get filter(): number;
  98027. /**
  98028. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  98029. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  98030. */
  98031. set filter(value: number);
  98032. /**
  98033. * Gets if the current filter is set to Poisson Sampling.
  98034. */
  98035. get usePoissonSampling(): boolean;
  98036. /**
  98037. * Sets the current filter to Poisson Sampling.
  98038. */
  98039. set usePoissonSampling(value: boolean);
  98040. /**
  98041. * Gets if the current filter is set to ESM.
  98042. */
  98043. get useExponentialShadowMap(): boolean;
  98044. /**
  98045. * Sets the current filter is to ESM.
  98046. */
  98047. set useExponentialShadowMap(value: boolean);
  98048. /**
  98049. * Gets if the current filter is set to filtered ESM.
  98050. */
  98051. get useBlurExponentialShadowMap(): boolean;
  98052. /**
  98053. * Gets if the current filter is set to filtered ESM.
  98054. */
  98055. set useBlurExponentialShadowMap(value: boolean);
  98056. /**
  98057. * Gets if the current filter is set to "close ESM" (using the inverse of the
  98058. * exponential to prevent steep falloff artifacts).
  98059. */
  98060. get useCloseExponentialShadowMap(): boolean;
  98061. /**
  98062. * Sets the current filter to "close ESM" (using the inverse of the
  98063. * exponential to prevent steep falloff artifacts).
  98064. */
  98065. set useCloseExponentialShadowMap(value: boolean);
  98066. /**
  98067. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  98068. * exponential to prevent steep falloff artifacts).
  98069. */
  98070. get useBlurCloseExponentialShadowMap(): boolean;
  98071. /**
  98072. * Sets the current filter to filtered "close ESM" (using the inverse of the
  98073. * exponential to prevent steep falloff artifacts).
  98074. */
  98075. set useBlurCloseExponentialShadowMap(value: boolean);
  98076. /**
  98077. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  98078. */
  98079. get usePercentageCloserFiltering(): boolean;
  98080. /**
  98081. * Sets the current filter to "PCF" (percentage closer filtering).
  98082. */
  98083. set usePercentageCloserFiltering(value: boolean);
  98084. protected _filteringQuality: number;
  98085. /**
  98086. * Gets the PCF or PCSS Quality.
  98087. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  98088. */
  98089. get filteringQuality(): number;
  98090. /**
  98091. * Sets the PCF or PCSS Quality.
  98092. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  98093. */
  98094. set filteringQuality(filteringQuality: number);
  98095. /**
  98096. * Gets if the current filter is set to "PCSS" (contact hardening).
  98097. */
  98098. get useContactHardeningShadow(): boolean;
  98099. /**
  98100. * Sets the current filter to "PCSS" (contact hardening).
  98101. */
  98102. set useContactHardeningShadow(value: boolean);
  98103. protected _contactHardeningLightSizeUVRatio: number;
  98104. /**
  98105. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  98106. * Using a ratio helps keeping shape stability independently of the map size.
  98107. *
  98108. * It does not account for the light projection as it was having too much
  98109. * instability during the light setup or during light position changes.
  98110. *
  98111. * Only valid if useContactHardeningShadow is true.
  98112. */
  98113. get contactHardeningLightSizeUVRatio(): number;
  98114. /**
  98115. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  98116. * Using a ratio helps keeping shape stability independently of the map size.
  98117. *
  98118. * It does not account for the light projection as it was having too much
  98119. * instability during the light setup or during light position changes.
  98120. *
  98121. * Only valid if useContactHardeningShadow is true.
  98122. */
  98123. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  98124. protected _darkness: number;
  98125. /** Gets or sets the actual darkness of a shadow */
  98126. get darkness(): number;
  98127. set darkness(value: number);
  98128. /**
  98129. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  98130. * 0 means strongest and 1 would means no shadow.
  98131. * @returns the darkness.
  98132. */
  98133. getDarkness(): number;
  98134. /**
  98135. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  98136. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  98137. * @returns the shadow generator allowing fluent coding.
  98138. */
  98139. setDarkness(darkness: number): ShadowGenerator;
  98140. protected _transparencyShadow: boolean;
  98141. /** Gets or sets the ability to have transparent shadow */
  98142. get transparencyShadow(): boolean;
  98143. set transparencyShadow(value: boolean);
  98144. /**
  98145. * Sets the ability to have transparent shadow (boolean).
  98146. * @param transparent True if transparent else False
  98147. * @returns the shadow generator allowing fluent coding
  98148. */
  98149. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  98150. /**
  98151. * Enables or disables shadows with varying strength based on the transparency
  98152. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  98153. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  98154. * mesh.visibility * alphaTexture.a
  98155. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  98156. */
  98157. enableSoftTransparentShadow: boolean;
  98158. protected _shadowMap: Nullable<RenderTargetTexture>;
  98159. protected _shadowMap2: Nullable<RenderTargetTexture>;
  98160. /**
  98161. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  98162. * @returns The render target texture if present otherwise, null
  98163. */
  98164. getShadowMap(): Nullable<RenderTargetTexture>;
  98165. /**
  98166. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  98167. * @returns The render target texture if the shadow map is present otherwise, null
  98168. */
  98169. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  98170. /**
  98171. * Gets the class name of that object
  98172. * @returns "ShadowGenerator"
  98173. */
  98174. getClassName(): string;
  98175. /**
  98176. * Helper function to add a mesh and its descendants to the list of shadow casters.
  98177. * @param mesh Mesh to add
  98178. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  98179. * @returns the Shadow Generator itself
  98180. */
  98181. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  98182. /**
  98183. * Helper function to remove a mesh and its descendants from the list of shadow casters
  98184. * @param mesh Mesh to remove
  98185. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  98186. * @returns the Shadow Generator itself
  98187. */
  98188. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  98189. /**
  98190. * Controls the extent to which the shadows fade out at the edge of the frustum
  98191. */
  98192. frustumEdgeFalloff: number;
  98193. protected _light: IShadowLight;
  98194. /**
  98195. * Returns the associated light object.
  98196. * @returns the light generating the shadow
  98197. */
  98198. getLight(): IShadowLight;
  98199. /**
  98200. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  98201. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  98202. * It might on the other hand introduce peter panning.
  98203. */
  98204. forceBackFacesOnly: boolean;
  98205. protected _scene: Scene;
  98206. protected _lightDirection: Vector3;
  98207. protected _effect: Effect;
  98208. protected _viewMatrix: Matrix;
  98209. protected _projectionMatrix: Matrix;
  98210. protected _transformMatrix: Matrix;
  98211. protected _cachedPosition: Vector3;
  98212. protected _cachedDirection: Vector3;
  98213. protected _cachedDefines: string;
  98214. protected _currentRenderID: number;
  98215. protected _boxBlurPostprocess: Nullable<PostProcess>;
  98216. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  98217. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  98218. protected _blurPostProcesses: PostProcess[];
  98219. protected _mapSize: number;
  98220. protected _currentFaceIndex: number;
  98221. protected _currentFaceIndexCache: number;
  98222. protected _textureType: number;
  98223. protected _defaultTextureMatrix: Matrix;
  98224. protected _storedUniqueId: Nullable<number>;
  98225. /** @hidden */
  98226. static _SceneComponentInitialization: (scene: Scene) => void;
  98227. /**
  98228. * Creates a ShadowGenerator object.
  98229. * A ShadowGenerator is the required tool to use the shadows.
  98230. * Each light casting shadows needs to use its own ShadowGenerator.
  98231. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  98232. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  98233. * @param light The light object generating the shadows.
  98234. * @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.
  98235. */
  98236. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  98237. protected _initializeGenerator(): void;
  98238. protected _createTargetRenderTexture(): void;
  98239. protected _initializeShadowMap(): void;
  98240. protected _initializeBlurRTTAndPostProcesses(): void;
  98241. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  98242. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  98243. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  98244. protected _applyFilterValues(): void;
  98245. /**
  98246. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  98247. * @param onCompiled Callback triggered at the and of the effects compilation
  98248. * @param options Sets of optional options forcing the compilation with different modes
  98249. */
  98250. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  98251. useInstances: boolean;
  98252. }>): void;
  98253. /**
  98254. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  98255. * @param options Sets of optional options forcing the compilation with different modes
  98256. * @returns A promise that resolves when the compilation completes
  98257. */
  98258. forceCompilationAsync(options?: Partial<{
  98259. useInstances: boolean;
  98260. }>): Promise<void>;
  98261. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  98262. private _prepareShadowDefines;
  98263. /**
  98264. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  98265. * @param subMesh The submesh we want to render in the shadow map
  98266. * @param useInstances Defines wether will draw in the map using instances
  98267. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  98268. * @returns true if ready otherwise, false
  98269. */
  98270. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  98271. /**
  98272. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  98273. * @param defines Defines of the material we want to update
  98274. * @param lightIndex Index of the light in the enabled light list of the material
  98275. */
  98276. prepareDefines(defines: any, lightIndex: number): void;
  98277. /**
  98278. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  98279. * defined in the generator but impacting the effect).
  98280. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  98281. * @param effect The effect we are binfing the information for
  98282. */
  98283. bindShadowLight(lightIndex: string, effect: Effect): void;
  98284. /**
  98285. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  98286. * (eq to shadow prjection matrix * light transform matrix)
  98287. * @returns The transform matrix used to create the shadow map
  98288. */
  98289. getTransformMatrix(): Matrix;
  98290. /**
  98291. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  98292. * Cube and 2D textures for instance.
  98293. */
  98294. recreateShadowMap(): void;
  98295. protected _disposeBlurPostProcesses(): void;
  98296. protected _disposeRTTandPostProcesses(): void;
  98297. /**
  98298. * Disposes the ShadowGenerator.
  98299. * Returns nothing.
  98300. */
  98301. dispose(): void;
  98302. /**
  98303. * Serializes the shadow generator setup to a json object.
  98304. * @returns The serialized JSON object
  98305. */
  98306. serialize(): any;
  98307. /**
  98308. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  98309. * @param parsedShadowGenerator The JSON object to parse
  98310. * @param scene The scene to create the shadow map for
  98311. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  98312. * @returns The parsed shadow generator
  98313. */
  98314. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  98315. }
  98316. }
  98317. declare module BABYLON {
  98318. /**
  98319. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  98320. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  98321. * 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.
  98322. */
  98323. export abstract class Light extends Node {
  98324. /**
  98325. * Falloff Default: light is falling off following the material specification:
  98326. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  98327. */
  98328. static readonly FALLOFF_DEFAULT: number;
  98329. /**
  98330. * Falloff Physical: light is falling off following the inverse squared distance law.
  98331. */
  98332. static readonly FALLOFF_PHYSICAL: number;
  98333. /**
  98334. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  98335. * to enhance interoperability with other engines.
  98336. */
  98337. static readonly FALLOFF_GLTF: number;
  98338. /**
  98339. * Falloff Standard: light is falling off like in the standard material
  98340. * to enhance interoperability with other materials.
  98341. */
  98342. static readonly FALLOFF_STANDARD: number;
  98343. /**
  98344. * If every light affecting the material is in this lightmapMode,
  98345. * material.lightmapTexture adds or multiplies
  98346. * (depends on material.useLightmapAsShadowmap)
  98347. * after every other light calculations.
  98348. */
  98349. static readonly LIGHTMAP_DEFAULT: number;
  98350. /**
  98351. * material.lightmapTexture as only diffuse lighting from this light
  98352. * adds only specular lighting from this light
  98353. * adds dynamic shadows
  98354. */
  98355. static readonly LIGHTMAP_SPECULAR: number;
  98356. /**
  98357. * material.lightmapTexture as only lighting
  98358. * no light calculation from this light
  98359. * only adds dynamic shadows from this light
  98360. */
  98361. static readonly LIGHTMAP_SHADOWSONLY: number;
  98362. /**
  98363. * Each light type uses the default quantity according to its type:
  98364. * point/spot lights use luminous intensity
  98365. * directional lights use illuminance
  98366. */
  98367. static readonly INTENSITYMODE_AUTOMATIC: number;
  98368. /**
  98369. * lumen (lm)
  98370. */
  98371. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  98372. /**
  98373. * candela (lm/sr)
  98374. */
  98375. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  98376. /**
  98377. * lux (lm/m^2)
  98378. */
  98379. static readonly INTENSITYMODE_ILLUMINANCE: number;
  98380. /**
  98381. * nit (cd/m^2)
  98382. */
  98383. static readonly INTENSITYMODE_LUMINANCE: number;
  98384. /**
  98385. * Light type const id of the point light.
  98386. */
  98387. static readonly LIGHTTYPEID_POINTLIGHT: number;
  98388. /**
  98389. * Light type const id of the directional light.
  98390. */
  98391. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  98392. /**
  98393. * Light type const id of the spot light.
  98394. */
  98395. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  98396. /**
  98397. * Light type const id of the hemispheric light.
  98398. */
  98399. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  98400. /**
  98401. * Diffuse gives the basic color to an object.
  98402. */
  98403. diffuse: Color3;
  98404. /**
  98405. * Specular produces a highlight color on an object.
  98406. * Note: This is note affecting PBR materials.
  98407. */
  98408. specular: Color3;
  98409. /**
  98410. * Defines the falloff type for this light. This lets overrriding how punctual light are
  98411. * falling off base on range or angle.
  98412. * This can be set to any values in Light.FALLOFF_x.
  98413. *
  98414. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  98415. * other types of materials.
  98416. */
  98417. falloffType: number;
  98418. /**
  98419. * Strength of the light.
  98420. * Note: By default it is define in the framework own unit.
  98421. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  98422. */
  98423. intensity: number;
  98424. private _range;
  98425. protected _inverseSquaredRange: number;
  98426. /**
  98427. * Defines how far from the source the light is impacting in scene units.
  98428. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  98429. */
  98430. get range(): number;
  98431. /**
  98432. * Defines how far from the source the light is impacting in scene units.
  98433. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  98434. */
  98435. set range(value: number);
  98436. /**
  98437. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  98438. * of light.
  98439. */
  98440. private _photometricScale;
  98441. private _intensityMode;
  98442. /**
  98443. * Gets the photometric scale used to interpret the intensity.
  98444. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  98445. */
  98446. get intensityMode(): number;
  98447. /**
  98448. * Sets the photometric scale used to interpret the intensity.
  98449. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  98450. */
  98451. set intensityMode(value: number);
  98452. private _radius;
  98453. /**
  98454. * Gets the light radius used by PBR Materials to simulate soft area lights.
  98455. */
  98456. get radius(): number;
  98457. /**
  98458. * sets the light radius used by PBR Materials to simulate soft area lights.
  98459. */
  98460. set radius(value: number);
  98461. private _renderPriority;
  98462. /**
  98463. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  98464. * exceeding the number allowed of the materials.
  98465. */
  98466. renderPriority: number;
  98467. private _shadowEnabled;
  98468. /**
  98469. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  98470. * the current shadow generator.
  98471. */
  98472. get shadowEnabled(): boolean;
  98473. /**
  98474. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  98475. * the current shadow generator.
  98476. */
  98477. set shadowEnabled(value: boolean);
  98478. private _includedOnlyMeshes;
  98479. /**
  98480. * Gets the only meshes impacted by this light.
  98481. */
  98482. get includedOnlyMeshes(): AbstractMesh[];
  98483. /**
  98484. * Sets the only meshes impacted by this light.
  98485. */
  98486. set includedOnlyMeshes(value: AbstractMesh[]);
  98487. private _excludedMeshes;
  98488. /**
  98489. * Gets the meshes not impacted by this light.
  98490. */
  98491. get excludedMeshes(): AbstractMesh[];
  98492. /**
  98493. * Sets the meshes not impacted by this light.
  98494. */
  98495. set excludedMeshes(value: AbstractMesh[]);
  98496. private _excludeWithLayerMask;
  98497. /**
  98498. * Gets the layer id use to find what meshes are not impacted by the light.
  98499. * Inactive if 0
  98500. */
  98501. get excludeWithLayerMask(): number;
  98502. /**
  98503. * Sets the layer id use to find what meshes are not impacted by the light.
  98504. * Inactive if 0
  98505. */
  98506. set excludeWithLayerMask(value: number);
  98507. private _includeOnlyWithLayerMask;
  98508. /**
  98509. * Gets the layer id use to find what meshes are impacted by the light.
  98510. * Inactive if 0
  98511. */
  98512. get includeOnlyWithLayerMask(): number;
  98513. /**
  98514. * Sets the layer id use to find what meshes are impacted by the light.
  98515. * Inactive if 0
  98516. */
  98517. set includeOnlyWithLayerMask(value: number);
  98518. private _lightmapMode;
  98519. /**
  98520. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  98521. */
  98522. get lightmapMode(): number;
  98523. /**
  98524. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  98525. */
  98526. set lightmapMode(value: number);
  98527. /**
  98528. * Shadow generator associted to the light.
  98529. * @hidden Internal use only.
  98530. */
  98531. _shadowGenerator: Nullable<IShadowGenerator>;
  98532. /**
  98533. * @hidden Internal use only.
  98534. */
  98535. _excludedMeshesIds: string[];
  98536. /**
  98537. * @hidden Internal use only.
  98538. */
  98539. _includedOnlyMeshesIds: string[];
  98540. /**
  98541. * The current light unifom buffer.
  98542. * @hidden Internal use only.
  98543. */
  98544. _uniformBuffer: UniformBuffer;
  98545. /** @hidden */
  98546. _renderId: number;
  98547. /**
  98548. * Creates a Light object in the scene.
  98549. * Documentation : https://doc.babylonjs.com/babylon101/lights
  98550. * @param name The firendly name of the light
  98551. * @param scene The scene the light belongs too
  98552. */
  98553. constructor(name: string, scene: Scene);
  98554. protected abstract _buildUniformLayout(): void;
  98555. /**
  98556. * Sets the passed Effect "effect" with the Light information.
  98557. * @param effect The effect to update
  98558. * @param lightIndex The index of the light in the effect to update
  98559. * @returns The light
  98560. */
  98561. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  98562. /**
  98563. * Sets the passed Effect "effect" with the Light textures.
  98564. * @param effect The effect to update
  98565. * @param lightIndex The index of the light in the effect to update
  98566. * @returns The light
  98567. */
  98568. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  98569. /**
  98570. * Binds the lights information from the scene to the effect for the given mesh.
  98571. * @param lightIndex Light index
  98572. * @param scene The scene where the light belongs to
  98573. * @param effect The effect we are binding the data to
  98574. * @param useSpecular Defines if specular is supported
  98575. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  98576. */
  98577. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  98578. /**
  98579. * Sets the passed Effect "effect" with the Light information.
  98580. * @param effect The effect to update
  98581. * @param lightDataUniformName The uniform used to store light data (position or direction)
  98582. * @returns The light
  98583. */
  98584. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  98585. /**
  98586. * Returns the string "Light".
  98587. * @returns the class name
  98588. */
  98589. getClassName(): string;
  98590. /** @hidden */
  98591. readonly _isLight: boolean;
  98592. /**
  98593. * Converts the light information to a readable string for debug purpose.
  98594. * @param fullDetails Supports for multiple levels of logging within scene loading
  98595. * @returns the human readable light info
  98596. */
  98597. toString(fullDetails?: boolean): string;
  98598. /** @hidden */
  98599. protected _syncParentEnabledState(): void;
  98600. /**
  98601. * Set the enabled state of this node.
  98602. * @param value - the new enabled state
  98603. */
  98604. setEnabled(value: boolean): void;
  98605. /**
  98606. * Returns the Light associated shadow generator if any.
  98607. * @return the associated shadow generator.
  98608. */
  98609. getShadowGenerator(): Nullable<IShadowGenerator>;
  98610. /**
  98611. * Returns a Vector3, the absolute light position in the World.
  98612. * @returns the world space position of the light
  98613. */
  98614. getAbsolutePosition(): Vector3;
  98615. /**
  98616. * Specifies if the light will affect the passed mesh.
  98617. * @param mesh The mesh to test against the light
  98618. * @return true the mesh is affected otherwise, false.
  98619. */
  98620. canAffectMesh(mesh: AbstractMesh): boolean;
  98621. /**
  98622. * Sort function to order lights for rendering.
  98623. * @param a First Light object to compare to second.
  98624. * @param b Second Light object to compare first.
  98625. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  98626. */
  98627. static CompareLightsPriority(a: Light, b: Light): number;
  98628. /**
  98629. * Releases resources associated with this node.
  98630. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  98631. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  98632. */
  98633. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  98634. /**
  98635. * Returns the light type ID (integer).
  98636. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  98637. */
  98638. getTypeID(): number;
  98639. /**
  98640. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  98641. * @returns the scaled intensity in intensity mode unit
  98642. */
  98643. getScaledIntensity(): number;
  98644. /**
  98645. * Returns a new Light object, named "name", from the current one.
  98646. * @param name The name of the cloned light
  98647. * @param newParent The parent of this light, if it has one
  98648. * @returns the new created light
  98649. */
  98650. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  98651. /**
  98652. * Serializes the current light into a Serialization object.
  98653. * @returns the serialized object.
  98654. */
  98655. serialize(): any;
  98656. /**
  98657. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  98658. * This new light is named "name" and added to the passed scene.
  98659. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  98660. * @param name The friendly name of the light
  98661. * @param scene The scene the new light will belong to
  98662. * @returns the constructor function
  98663. */
  98664. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  98665. /**
  98666. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  98667. * @param parsedLight The JSON representation of the light
  98668. * @param scene The scene to create the parsed light in
  98669. * @returns the created light after parsing
  98670. */
  98671. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  98672. private _hookArrayForExcluded;
  98673. private _hookArrayForIncludedOnly;
  98674. private _resyncMeshes;
  98675. /**
  98676. * Forces the meshes to update their light related information in their rendering used effects
  98677. * @hidden Internal Use Only
  98678. */
  98679. _markMeshesAsLightDirty(): void;
  98680. /**
  98681. * Recomputes the cached photometric scale if needed.
  98682. */
  98683. private _computePhotometricScale;
  98684. /**
  98685. * Returns the Photometric Scale according to the light type and intensity mode.
  98686. */
  98687. private _getPhotometricScale;
  98688. /**
  98689. * Reorder the light in the scene according to their defined priority.
  98690. * @hidden Internal Use Only
  98691. */
  98692. _reorderLightsInScene(): void;
  98693. /**
  98694. * Prepares the list of defines specific to the light type.
  98695. * @param defines the list of defines
  98696. * @param lightIndex defines the index of the light for the effect
  98697. */
  98698. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  98699. }
  98700. }
  98701. declare module BABYLON {
  98702. /**
  98703. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  98704. * This is the base of the follow, arc rotate cameras and Free camera
  98705. * @see https://doc.babylonjs.com/features/cameras
  98706. */
  98707. export class TargetCamera extends Camera {
  98708. private static _RigCamTransformMatrix;
  98709. private static _TargetTransformMatrix;
  98710. private static _TargetFocalPoint;
  98711. private _tmpUpVector;
  98712. private _tmpTargetVector;
  98713. /**
  98714. * Define the current direction the camera is moving to
  98715. */
  98716. cameraDirection: Vector3;
  98717. /**
  98718. * Define the current rotation the camera is rotating to
  98719. */
  98720. cameraRotation: Vector2;
  98721. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  98722. ignoreParentScaling: boolean;
  98723. /**
  98724. * When set, the up vector of the camera will be updated by the rotation of the camera
  98725. */
  98726. updateUpVectorFromRotation: boolean;
  98727. private _tmpQuaternion;
  98728. /**
  98729. * Define the current rotation of the camera
  98730. */
  98731. rotation: Vector3;
  98732. /**
  98733. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  98734. */
  98735. rotationQuaternion: Quaternion;
  98736. /**
  98737. * Define the current speed of the camera
  98738. */
  98739. speed: number;
  98740. /**
  98741. * Add constraint to the camera to prevent it to move freely in all directions and
  98742. * around all axis.
  98743. */
  98744. noRotationConstraint: boolean;
  98745. /**
  98746. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  98747. * panning
  98748. */
  98749. invertRotation: boolean;
  98750. /**
  98751. * Speed multiplier for inverse camera panning
  98752. */
  98753. inverseRotationSpeed: number;
  98754. /**
  98755. * Define the current target of the camera as an object or a position.
  98756. */
  98757. lockedTarget: any;
  98758. /** @hidden */
  98759. _currentTarget: Vector3;
  98760. /** @hidden */
  98761. _initialFocalDistance: number;
  98762. /** @hidden */
  98763. _viewMatrix: Matrix;
  98764. /** @hidden */
  98765. _camMatrix: Matrix;
  98766. /** @hidden */
  98767. _cameraTransformMatrix: Matrix;
  98768. /** @hidden */
  98769. _cameraRotationMatrix: Matrix;
  98770. /** @hidden */
  98771. _referencePoint: Vector3;
  98772. /** @hidden */
  98773. _transformedReferencePoint: Vector3;
  98774. /** @hidden */
  98775. _reset: () => void;
  98776. private _defaultUp;
  98777. /**
  98778. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  98779. * This is the base of the follow, arc rotate cameras and Free camera
  98780. * @see https://doc.babylonjs.com/features/cameras
  98781. * @param name Defines the name of the camera in the scene
  98782. * @param position Defines the start position of the camera in the scene
  98783. * @param scene Defines the scene the camera belongs to
  98784. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  98785. */
  98786. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  98787. /**
  98788. * Gets the position in front of the camera at a given distance.
  98789. * @param distance The distance from the camera we want the position to be
  98790. * @returns the position
  98791. */
  98792. getFrontPosition(distance: number): Vector3;
  98793. /** @hidden */
  98794. _getLockedTargetPosition(): Nullable<Vector3>;
  98795. private _storedPosition;
  98796. private _storedRotation;
  98797. private _storedRotationQuaternion;
  98798. /**
  98799. * Store current camera state of the camera (fov, position, rotation, etc..)
  98800. * @returns the camera
  98801. */
  98802. storeState(): Camera;
  98803. /**
  98804. * Restored camera state. You must call storeState() first
  98805. * @returns whether it was successful or not
  98806. * @hidden
  98807. */
  98808. _restoreStateValues(): boolean;
  98809. /** @hidden */
  98810. _initCache(): void;
  98811. /** @hidden */
  98812. _updateCache(ignoreParentClass?: boolean): void;
  98813. /** @hidden */
  98814. _isSynchronizedViewMatrix(): boolean;
  98815. /** @hidden */
  98816. _computeLocalCameraSpeed(): number;
  98817. /**
  98818. * Defines the target the camera should look at.
  98819. * @param target Defines the new target as a Vector or a mesh
  98820. */
  98821. setTarget(target: Vector3): void;
  98822. /**
  98823. * Defines the target point of the camera.
  98824. * The camera looks towards it form the radius distance.
  98825. */
  98826. get target(): Vector3;
  98827. set target(value: Vector3);
  98828. /**
  98829. * Return the current target position of the camera. This value is expressed in local space.
  98830. * @returns the target position
  98831. */
  98832. getTarget(): Vector3;
  98833. /** @hidden */
  98834. _decideIfNeedsToMove(): boolean;
  98835. /** @hidden */
  98836. _updatePosition(): void;
  98837. /** @hidden */
  98838. _checkInputs(): void;
  98839. protected _updateCameraRotationMatrix(): void;
  98840. /**
  98841. * 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)
  98842. * @returns the current camera
  98843. */
  98844. private _rotateUpVectorWithCameraRotationMatrix;
  98845. private _cachedRotationZ;
  98846. private _cachedQuaternionRotationZ;
  98847. /** @hidden */
  98848. _getViewMatrix(): Matrix;
  98849. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  98850. /**
  98851. * @hidden
  98852. */
  98853. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  98854. /**
  98855. * @hidden
  98856. */
  98857. _updateRigCameras(): void;
  98858. private _getRigCamPositionAndTarget;
  98859. /**
  98860. * Gets the current object class name.
  98861. * @return the class name
  98862. */
  98863. getClassName(): string;
  98864. }
  98865. }
  98866. declare module BABYLON {
  98867. /**
  98868. * Gather the list of keyboard event types as constants.
  98869. */
  98870. export class KeyboardEventTypes {
  98871. /**
  98872. * The keydown event is fired when a key becomes active (pressed).
  98873. */
  98874. static readonly KEYDOWN: number;
  98875. /**
  98876. * The keyup event is fired when a key has been released.
  98877. */
  98878. static readonly KEYUP: number;
  98879. }
  98880. /**
  98881. * This class is used to store keyboard related info for the onKeyboardObservable event.
  98882. */
  98883. export class KeyboardInfo {
  98884. /**
  98885. * Defines the type of event (KeyboardEventTypes)
  98886. */
  98887. type: number;
  98888. /**
  98889. * Defines the related dom event
  98890. */
  98891. event: KeyboardEvent;
  98892. /**
  98893. * Instantiates a new keyboard info.
  98894. * This class is used to store keyboard related info for the onKeyboardObservable event.
  98895. * @param type Defines the type of event (KeyboardEventTypes)
  98896. * @param event Defines the related dom event
  98897. */
  98898. constructor(
  98899. /**
  98900. * Defines the type of event (KeyboardEventTypes)
  98901. */
  98902. type: number,
  98903. /**
  98904. * Defines the related dom event
  98905. */
  98906. event: KeyboardEvent);
  98907. }
  98908. /**
  98909. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  98910. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  98911. */
  98912. export class KeyboardInfoPre extends KeyboardInfo {
  98913. /**
  98914. * Defines the type of event (KeyboardEventTypes)
  98915. */
  98916. type: number;
  98917. /**
  98918. * Defines the related dom event
  98919. */
  98920. event: KeyboardEvent;
  98921. /**
  98922. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  98923. */
  98924. skipOnPointerObservable: boolean;
  98925. /**
  98926. * Instantiates a new keyboard pre info.
  98927. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  98928. * @param type Defines the type of event (KeyboardEventTypes)
  98929. * @param event Defines the related dom event
  98930. */
  98931. constructor(
  98932. /**
  98933. * Defines the type of event (KeyboardEventTypes)
  98934. */
  98935. type: number,
  98936. /**
  98937. * Defines the related dom event
  98938. */
  98939. event: KeyboardEvent);
  98940. }
  98941. }
  98942. declare module BABYLON {
  98943. /**
  98944. * Manage the keyboard inputs to control the movement of a free camera.
  98945. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98946. */
  98947. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  98948. /**
  98949. * Defines the camera the input is attached to.
  98950. */
  98951. camera: FreeCamera;
  98952. /**
  98953. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  98954. */
  98955. keysUp: number[];
  98956. /**
  98957. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  98958. */
  98959. keysUpward: number[];
  98960. /**
  98961. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  98962. */
  98963. keysDown: number[];
  98964. /**
  98965. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  98966. */
  98967. keysDownward: number[];
  98968. /**
  98969. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  98970. */
  98971. keysLeft: number[];
  98972. /**
  98973. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  98974. */
  98975. keysRight: number[];
  98976. private _keys;
  98977. private _onCanvasBlurObserver;
  98978. private _onKeyboardObserver;
  98979. private _engine;
  98980. private _scene;
  98981. /**
  98982. * Attach the input controls to a specific dom element to get the input from.
  98983. * @param element Defines the element the controls should be listened from
  98984. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98985. */
  98986. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98987. /**
  98988. * Detach the current controls from the specified dom element.
  98989. * @param element Defines the element to stop listening the inputs from
  98990. */
  98991. detachControl(element: Nullable<HTMLElement>): void;
  98992. /**
  98993. * Update the current camera state depending on the inputs that have been used this frame.
  98994. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  98995. */
  98996. checkInputs(): void;
  98997. /**
  98998. * Gets the class name of the current intput.
  98999. * @returns the class name
  99000. */
  99001. getClassName(): string;
  99002. /** @hidden */
  99003. _onLostFocus(): void;
  99004. /**
  99005. * Get the friendly name associated with the input class.
  99006. * @returns the input friendly name
  99007. */
  99008. getSimpleName(): string;
  99009. }
  99010. }
  99011. declare module BABYLON {
  99012. /**
  99013. * Gather the list of pointer event types as constants.
  99014. */
  99015. export class PointerEventTypes {
  99016. /**
  99017. * 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.
  99018. */
  99019. static readonly POINTERDOWN: number;
  99020. /**
  99021. * The pointerup event is fired when a pointer is no longer active.
  99022. */
  99023. static readonly POINTERUP: number;
  99024. /**
  99025. * The pointermove event is fired when a pointer changes coordinates.
  99026. */
  99027. static readonly POINTERMOVE: number;
  99028. /**
  99029. * The pointerwheel event is fired when a mouse wheel has been rotated.
  99030. */
  99031. static readonly POINTERWHEEL: number;
  99032. /**
  99033. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  99034. */
  99035. static readonly POINTERPICK: number;
  99036. /**
  99037. * The pointertap event is fired when a the object has been touched and released without drag.
  99038. */
  99039. static readonly POINTERTAP: number;
  99040. /**
  99041. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  99042. */
  99043. static readonly POINTERDOUBLETAP: number;
  99044. }
  99045. /**
  99046. * Base class of pointer info types.
  99047. */
  99048. export class PointerInfoBase {
  99049. /**
  99050. * Defines the type of event (PointerEventTypes)
  99051. */
  99052. type: number;
  99053. /**
  99054. * Defines the related dom event
  99055. */
  99056. event: PointerEvent | MouseWheelEvent;
  99057. /**
  99058. * Instantiates the base class of pointers info.
  99059. * @param type Defines the type of event (PointerEventTypes)
  99060. * @param event Defines the related dom event
  99061. */
  99062. constructor(
  99063. /**
  99064. * Defines the type of event (PointerEventTypes)
  99065. */
  99066. type: number,
  99067. /**
  99068. * Defines the related dom event
  99069. */
  99070. event: PointerEvent | MouseWheelEvent);
  99071. }
  99072. /**
  99073. * This class is used to store pointer related info for the onPrePointerObservable event.
  99074. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  99075. */
  99076. export class PointerInfoPre extends PointerInfoBase {
  99077. /**
  99078. * Ray from a pointer if availible (eg. 6dof controller)
  99079. */
  99080. ray: Nullable<Ray>;
  99081. /**
  99082. * Defines the local position of the pointer on the canvas.
  99083. */
  99084. localPosition: Vector2;
  99085. /**
  99086. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  99087. */
  99088. skipOnPointerObservable: boolean;
  99089. /**
  99090. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  99091. * @param type Defines the type of event (PointerEventTypes)
  99092. * @param event Defines the related dom event
  99093. * @param localX Defines the local x coordinates of the pointer when the event occured
  99094. * @param localY Defines the local y coordinates of the pointer when the event occured
  99095. */
  99096. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  99097. }
  99098. /**
  99099. * This type contains all the data related to a pointer event in Babylon.js.
  99100. * 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.
  99101. */
  99102. export class PointerInfo extends PointerInfoBase {
  99103. /**
  99104. * Defines the picking info associated to the info (if any)\
  99105. */
  99106. pickInfo: Nullable<PickingInfo>;
  99107. /**
  99108. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  99109. * @param type Defines the type of event (PointerEventTypes)
  99110. * @param event Defines the related dom event
  99111. * @param pickInfo Defines the picking info associated to the info (if any)\
  99112. */
  99113. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  99114. /**
  99115. * Defines the picking info associated to the info (if any)\
  99116. */
  99117. pickInfo: Nullable<PickingInfo>);
  99118. }
  99119. /**
  99120. * Data relating to a touch event on the screen.
  99121. */
  99122. export interface PointerTouch {
  99123. /**
  99124. * X coordinate of touch.
  99125. */
  99126. x: number;
  99127. /**
  99128. * Y coordinate of touch.
  99129. */
  99130. y: number;
  99131. /**
  99132. * Id of touch. Unique for each finger.
  99133. */
  99134. pointerId: number;
  99135. /**
  99136. * Event type passed from DOM.
  99137. */
  99138. type: any;
  99139. }
  99140. }
  99141. declare module BABYLON {
  99142. /**
  99143. * Manage the mouse inputs to control the movement of a free camera.
  99144. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  99145. */
  99146. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  99147. /**
  99148. * Define if touch is enabled in the mouse input
  99149. */
  99150. touchEnabled: boolean;
  99151. /**
  99152. * Defines the camera the input is attached to.
  99153. */
  99154. camera: FreeCamera;
  99155. /**
  99156. * Defines the buttons associated with the input to handle camera move.
  99157. */
  99158. buttons: number[];
  99159. /**
  99160. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  99161. */
  99162. angularSensibility: number;
  99163. private _pointerInput;
  99164. private _onMouseMove;
  99165. private _observer;
  99166. private previousPosition;
  99167. /**
  99168. * Observable for when a pointer move event occurs containing the move offset
  99169. */
  99170. onPointerMovedObservable: Observable<{
  99171. offsetX: number;
  99172. offsetY: number;
  99173. }>;
  99174. /**
  99175. * @hidden
  99176. * If the camera should be rotated automatically based on pointer movement
  99177. */
  99178. _allowCameraRotation: boolean;
  99179. /**
  99180. * Manage the mouse inputs to control the movement of a free camera.
  99181. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  99182. * @param touchEnabled Defines if touch is enabled or not
  99183. */
  99184. constructor(
  99185. /**
  99186. * Define if touch is enabled in the mouse input
  99187. */
  99188. touchEnabled?: boolean);
  99189. /**
  99190. * Attach the input controls to a specific dom element to get the input from.
  99191. * @param element Defines the element the controls should be listened from
  99192. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  99193. */
  99194. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  99195. /**
  99196. * Called on JS contextmenu event.
  99197. * Override this method to provide functionality.
  99198. */
  99199. protected onContextMenu(evt: PointerEvent): void;
  99200. /**
  99201. * Detach the current controls from the specified dom element.
  99202. * @param element Defines the element to stop listening the inputs from
  99203. */
  99204. detachControl(element: Nullable<HTMLElement>): void;
  99205. /**
  99206. * Gets the class name of the current intput.
  99207. * @returns the class name
  99208. */
  99209. getClassName(): string;
  99210. /**
  99211. * Get the friendly name associated with the input class.
  99212. * @returns the input friendly name
  99213. */
  99214. getSimpleName(): string;
  99215. }
  99216. }
  99217. declare module BABYLON {
  99218. /**
  99219. * Manage the touch inputs to control the movement of a free camera.
  99220. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  99221. */
  99222. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  99223. /**
  99224. * Define if mouse events can be treated as touch events
  99225. */
  99226. allowMouse: boolean;
  99227. /**
  99228. * Defines the camera the input is attached to.
  99229. */
  99230. camera: FreeCamera;
  99231. /**
  99232. * Defines the touch sensibility for rotation.
  99233. * The higher the faster.
  99234. */
  99235. touchAngularSensibility: number;
  99236. /**
  99237. * Defines the touch sensibility for move.
  99238. * The higher the faster.
  99239. */
  99240. touchMoveSensibility: number;
  99241. private _offsetX;
  99242. private _offsetY;
  99243. private _pointerPressed;
  99244. private _pointerInput;
  99245. private _observer;
  99246. private _onLostFocus;
  99247. /**
  99248. * Manage the touch inputs to control the movement of a free camera.
  99249. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  99250. * @param allowMouse Defines if mouse events can be treated as touch events
  99251. */
  99252. constructor(
  99253. /**
  99254. * Define if mouse events can be treated as touch events
  99255. */
  99256. allowMouse?: boolean);
  99257. /**
  99258. * Attach the input controls to a specific dom element to get the input from.
  99259. * @param element Defines the element the controls should be listened from
  99260. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  99261. */
  99262. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  99263. /**
  99264. * Detach the current controls from the specified dom element.
  99265. * @param element Defines the element to stop listening the inputs from
  99266. */
  99267. detachControl(element: Nullable<HTMLElement>): void;
  99268. /**
  99269. * Update the current camera state depending on the inputs that have been used this frame.
  99270. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  99271. */
  99272. checkInputs(): void;
  99273. /**
  99274. * Gets the class name of the current intput.
  99275. * @returns the class name
  99276. */
  99277. getClassName(): string;
  99278. /**
  99279. * Get the friendly name associated with the input class.
  99280. * @returns the input friendly name
  99281. */
  99282. getSimpleName(): string;
  99283. }
  99284. }
  99285. declare module BABYLON {
  99286. /**
  99287. * Default Inputs manager for the FreeCamera.
  99288. * It groups all the default supported inputs for ease of use.
  99289. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  99290. */
  99291. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  99292. /**
  99293. * @hidden
  99294. */
  99295. _mouseInput: Nullable<FreeCameraMouseInput>;
  99296. /**
  99297. * Instantiates a new FreeCameraInputsManager.
  99298. * @param camera Defines the camera the inputs belong to
  99299. */
  99300. constructor(camera: FreeCamera);
  99301. /**
  99302. * Add keyboard input support to the input manager.
  99303. * @returns the current input manager
  99304. */
  99305. addKeyboard(): FreeCameraInputsManager;
  99306. /**
  99307. * Add mouse input support to the input manager.
  99308. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  99309. * @returns the current input manager
  99310. */
  99311. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  99312. /**
  99313. * Removes the mouse input support from the manager
  99314. * @returns the current input manager
  99315. */
  99316. removeMouse(): FreeCameraInputsManager;
  99317. /**
  99318. * Add touch input support to the input manager.
  99319. * @returns the current input manager
  99320. */
  99321. addTouch(): FreeCameraInputsManager;
  99322. /**
  99323. * Remove all attached input methods from a camera
  99324. */
  99325. clear(): void;
  99326. }
  99327. }
  99328. declare module BABYLON {
  99329. /**
  99330. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  99331. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  99332. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  99333. */
  99334. export class FreeCamera extends TargetCamera {
  99335. /**
  99336. * Define the collision ellipsoid of the camera.
  99337. * This is helpful to simulate a camera body like the player body around the camera
  99338. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  99339. */
  99340. ellipsoid: Vector3;
  99341. /**
  99342. * Define an offset for the position of the ellipsoid around the camera.
  99343. * This can be helpful to determine the center of the body near the gravity center of the body
  99344. * instead of its head.
  99345. */
  99346. ellipsoidOffset: Vector3;
  99347. /**
  99348. * Enable or disable collisions of the camera with the rest of the scene objects.
  99349. */
  99350. checkCollisions: boolean;
  99351. /**
  99352. * Enable or disable gravity on the camera.
  99353. */
  99354. applyGravity: boolean;
  99355. /**
  99356. * Define the input manager associated to the camera.
  99357. */
  99358. inputs: FreeCameraInputsManager;
  99359. /**
  99360. * Gets the input sensibility for a mouse input. (default is 2000.0)
  99361. * Higher values reduce sensitivity.
  99362. */
  99363. get angularSensibility(): number;
  99364. /**
  99365. * Sets the input sensibility for a mouse input. (default is 2000.0)
  99366. * Higher values reduce sensitivity.
  99367. */
  99368. set angularSensibility(value: number);
  99369. /**
  99370. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  99371. */
  99372. get keysUp(): number[];
  99373. set keysUp(value: number[]);
  99374. /**
  99375. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  99376. */
  99377. get keysUpward(): number[];
  99378. set keysUpward(value: number[]);
  99379. /**
  99380. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  99381. */
  99382. get keysDown(): number[];
  99383. set keysDown(value: number[]);
  99384. /**
  99385. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  99386. */
  99387. get keysDownward(): number[];
  99388. set keysDownward(value: number[]);
  99389. /**
  99390. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  99391. */
  99392. get keysLeft(): number[];
  99393. set keysLeft(value: number[]);
  99394. /**
  99395. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  99396. */
  99397. get keysRight(): number[];
  99398. set keysRight(value: number[]);
  99399. /**
  99400. * Event raised when the camera collide with a mesh in the scene.
  99401. */
  99402. onCollide: (collidedMesh: AbstractMesh) => void;
  99403. private _collider;
  99404. private _needMoveForGravity;
  99405. private _oldPosition;
  99406. private _diffPosition;
  99407. private _newPosition;
  99408. /** @hidden */
  99409. _localDirection: Vector3;
  99410. /** @hidden */
  99411. _transformedDirection: Vector3;
  99412. /**
  99413. * Instantiates a Free Camera.
  99414. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  99415. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  99416. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  99417. * @param name Define the name of the camera in the scene
  99418. * @param position Define the start position of the camera in the scene
  99419. * @param scene Define the scene the camera belongs to
  99420. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  99421. */
  99422. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  99423. /**
  99424. * Attached controls to the current camera.
  99425. * @param element Defines the element the controls should be listened from
  99426. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  99427. */
  99428. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  99429. /**
  99430. * Detach the current controls from the camera.
  99431. * The camera will stop reacting to inputs.
  99432. * @param element Defines the element to stop listening the inputs from
  99433. */
  99434. detachControl(element: HTMLElement): void;
  99435. private _collisionMask;
  99436. /**
  99437. * Define a collision mask to limit the list of object the camera can collide with
  99438. */
  99439. get collisionMask(): number;
  99440. set collisionMask(mask: number);
  99441. /** @hidden */
  99442. _collideWithWorld(displacement: Vector3): void;
  99443. private _onCollisionPositionChange;
  99444. /** @hidden */
  99445. _checkInputs(): void;
  99446. /** @hidden */
  99447. _decideIfNeedsToMove(): boolean;
  99448. /** @hidden */
  99449. _updatePosition(): void;
  99450. /**
  99451. * Destroy the camera and release the current resources hold by it.
  99452. */
  99453. dispose(): void;
  99454. /**
  99455. * Gets the current object class name.
  99456. * @return the class name
  99457. */
  99458. getClassName(): string;
  99459. }
  99460. }
  99461. declare module BABYLON {
  99462. /**
  99463. * Represents a gamepad control stick position
  99464. */
  99465. export class StickValues {
  99466. /**
  99467. * The x component of the control stick
  99468. */
  99469. x: number;
  99470. /**
  99471. * The y component of the control stick
  99472. */
  99473. y: number;
  99474. /**
  99475. * Initializes the gamepad x and y control stick values
  99476. * @param x The x component of the gamepad control stick value
  99477. * @param y The y component of the gamepad control stick value
  99478. */
  99479. constructor(
  99480. /**
  99481. * The x component of the control stick
  99482. */
  99483. x: number,
  99484. /**
  99485. * The y component of the control stick
  99486. */
  99487. y: number);
  99488. }
  99489. /**
  99490. * An interface which manages callbacks for gamepad button changes
  99491. */
  99492. export interface GamepadButtonChanges {
  99493. /**
  99494. * Called when a gamepad has been changed
  99495. */
  99496. changed: boolean;
  99497. /**
  99498. * Called when a gamepad press event has been triggered
  99499. */
  99500. pressChanged: boolean;
  99501. /**
  99502. * Called when a touch event has been triggered
  99503. */
  99504. touchChanged: boolean;
  99505. /**
  99506. * Called when a value has changed
  99507. */
  99508. valueChanged: boolean;
  99509. }
  99510. /**
  99511. * Represents a gamepad
  99512. */
  99513. export class Gamepad {
  99514. /**
  99515. * The id of the gamepad
  99516. */
  99517. id: string;
  99518. /**
  99519. * The index of the gamepad
  99520. */
  99521. index: number;
  99522. /**
  99523. * The browser gamepad
  99524. */
  99525. browserGamepad: any;
  99526. /**
  99527. * Specifies what type of gamepad this represents
  99528. */
  99529. type: number;
  99530. private _leftStick;
  99531. private _rightStick;
  99532. /** @hidden */
  99533. _isConnected: boolean;
  99534. private _leftStickAxisX;
  99535. private _leftStickAxisY;
  99536. private _rightStickAxisX;
  99537. private _rightStickAxisY;
  99538. /**
  99539. * Triggered when the left control stick has been changed
  99540. */
  99541. private _onleftstickchanged;
  99542. /**
  99543. * Triggered when the right control stick has been changed
  99544. */
  99545. private _onrightstickchanged;
  99546. /**
  99547. * Represents a gamepad controller
  99548. */
  99549. static GAMEPAD: number;
  99550. /**
  99551. * Represents a generic controller
  99552. */
  99553. static GENERIC: number;
  99554. /**
  99555. * Represents an XBox controller
  99556. */
  99557. static XBOX: number;
  99558. /**
  99559. * Represents a pose-enabled controller
  99560. */
  99561. static POSE_ENABLED: number;
  99562. /**
  99563. * Represents an Dual Shock controller
  99564. */
  99565. static DUALSHOCK: number;
  99566. /**
  99567. * Specifies whether the left control stick should be Y-inverted
  99568. */
  99569. protected _invertLeftStickY: boolean;
  99570. /**
  99571. * Specifies if the gamepad has been connected
  99572. */
  99573. get isConnected(): boolean;
  99574. /**
  99575. * Initializes the gamepad
  99576. * @param id The id of the gamepad
  99577. * @param index The index of the gamepad
  99578. * @param browserGamepad The browser gamepad
  99579. * @param leftStickX The x component of the left joystick
  99580. * @param leftStickY The y component of the left joystick
  99581. * @param rightStickX The x component of the right joystick
  99582. * @param rightStickY The y component of the right joystick
  99583. */
  99584. constructor(
  99585. /**
  99586. * The id of the gamepad
  99587. */
  99588. id: string,
  99589. /**
  99590. * The index of the gamepad
  99591. */
  99592. index: number,
  99593. /**
  99594. * The browser gamepad
  99595. */
  99596. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  99597. /**
  99598. * Callback triggered when the left joystick has changed
  99599. * @param callback
  99600. */
  99601. onleftstickchanged(callback: (values: StickValues) => void): void;
  99602. /**
  99603. * Callback triggered when the right joystick has changed
  99604. * @param callback
  99605. */
  99606. onrightstickchanged(callback: (values: StickValues) => void): void;
  99607. /**
  99608. * Gets the left joystick
  99609. */
  99610. get leftStick(): StickValues;
  99611. /**
  99612. * Sets the left joystick values
  99613. */
  99614. set leftStick(newValues: StickValues);
  99615. /**
  99616. * Gets the right joystick
  99617. */
  99618. get rightStick(): StickValues;
  99619. /**
  99620. * Sets the right joystick value
  99621. */
  99622. set rightStick(newValues: StickValues);
  99623. /**
  99624. * Updates the gamepad joystick positions
  99625. */
  99626. update(): void;
  99627. /**
  99628. * Disposes the gamepad
  99629. */
  99630. dispose(): void;
  99631. }
  99632. /**
  99633. * Represents a generic gamepad
  99634. */
  99635. export class GenericPad extends Gamepad {
  99636. private _buttons;
  99637. private _onbuttondown;
  99638. private _onbuttonup;
  99639. /**
  99640. * Observable triggered when a button has been pressed
  99641. */
  99642. onButtonDownObservable: Observable<number>;
  99643. /**
  99644. * Observable triggered when a button has been released
  99645. */
  99646. onButtonUpObservable: Observable<number>;
  99647. /**
  99648. * Callback triggered when a button has been pressed
  99649. * @param callback Called when a button has been pressed
  99650. */
  99651. onbuttondown(callback: (buttonPressed: number) => void): void;
  99652. /**
  99653. * Callback triggered when a button has been released
  99654. * @param callback Called when a button has been released
  99655. */
  99656. onbuttonup(callback: (buttonReleased: number) => void): void;
  99657. /**
  99658. * Initializes the generic gamepad
  99659. * @param id The id of the generic gamepad
  99660. * @param index The index of the generic gamepad
  99661. * @param browserGamepad The browser gamepad
  99662. */
  99663. constructor(id: string, index: number, browserGamepad: any);
  99664. private _setButtonValue;
  99665. /**
  99666. * Updates the generic gamepad
  99667. */
  99668. update(): void;
  99669. /**
  99670. * Disposes the generic gamepad
  99671. */
  99672. dispose(): void;
  99673. }
  99674. }
  99675. declare module BABYLON {
  99676. /**
  99677. * Defines the types of pose enabled controllers that are supported
  99678. */
  99679. export enum PoseEnabledControllerType {
  99680. /**
  99681. * HTC Vive
  99682. */
  99683. VIVE = 0,
  99684. /**
  99685. * Oculus Rift
  99686. */
  99687. OCULUS = 1,
  99688. /**
  99689. * Windows mixed reality
  99690. */
  99691. WINDOWS = 2,
  99692. /**
  99693. * Samsung gear VR
  99694. */
  99695. GEAR_VR = 3,
  99696. /**
  99697. * Google Daydream
  99698. */
  99699. DAYDREAM = 4,
  99700. /**
  99701. * Generic
  99702. */
  99703. GENERIC = 5
  99704. }
  99705. /**
  99706. * Defines the MutableGamepadButton interface for the state of a gamepad button
  99707. */
  99708. export interface MutableGamepadButton {
  99709. /**
  99710. * Value of the button/trigger
  99711. */
  99712. value: number;
  99713. /**
  99714. * If the button/trigger is currently touched
  99715. */
  99716. touched: boolean;
  99717. /**
  99718. * If the button/trigger is currently pressed
  99719. */
  99720. pressed: boolean;
  99721. }
  99722. /**
  99723. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  99724. * @hidden
  99725. */
  99726. export interface ExtendedGamepadButton extends GamepadButton {
  99727. /**
  99728. * If the button/trigger is currently pressed
  99729. */
  99730. readonly pressed: boolean;
  99731. /**
  99732. * If the button/trigger is currently touched
  99733. */
  99734. readonly touched: boolean;
  99735. /**
  99736. * Value of the button/trigger
  99737. */
  99738. readonly value: number;
  99739. }
  99740. /** @hidden */
  99741. export interface _GamePadFactory {
  99742. /**
  99743. * Returns whether or not the current gamepad can be created for this type of controller.
  99744. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  99745. * @returns true if it can be created, otherwise false
  99746. */
  99747. canCreate(gamepadInfo: any): boolean;
  99748. /**
  99749. * Creates a new instance of the Gamepad.
  99750. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  99751. * @returns the new gamepad instance
  99752. */
  99753. create(gamepadInfo: any): Gamepad;
  99754. }
  99755. /**
  99756. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  99757. */
  99758. export class PoseEnabledControllerHelper {
  99759. /** @hidden */
  99760. static _ControllerFactories: _GamePadFactory[];
  99761. /** @hidden */
  99762. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  99763. /**
  99764. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  99765. * @param vrGamepad the gamepad to initialized
  99766. * @returns a vr controller of the type the gamepad identified as
  99767. */
  99768. static InitiateController(vrGamepad: any): Gamepad;
  99769. }
  99770. /**
  99771. * Defines the PoseEnabledController object that contains state of a vr capable controller
  99772. */
  99773. export class PoseEnabledController extends Gamepad implements PoseControlled {
  99774. /**
  99775. * If the controller is used in a webXR session
  99776. */
  99777. isXR: boolean;
  99778. private _deviceRoomPosition;
  99779. private _deviceRoomRotationQuaternion;
  99780. /**
  99781. * The device position in babylon space
  99782. */
  99783. devicePosition: Vector3;
  99784. /**
  99785. * The device rotation in babylon space
  99786. */
  99787. deviceRotationQuaternion: Quaternion;
  99788. /**
  99789. * The scale factor of the device in babylon space
  99790. */
  99791. deviceScaleFactor: number;
  99792. /**
  99793. * (Likely devicePosition should be used instead) The device position in its room space
  99794. */
  99795. position: Vector3;
  99796. /**
  99797. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  99798. */
  99799. rotationQuaternion: Quaternion;
  99800. /**
  99801. * The type of controller (Eg. Windows mixed reality)
  99802. */
  99803. controllerType: PoseEnabledControllerType;
  99804. protected _calculatedPosition: Vector3;
  99805. private _calculatedRotation;
  99806. /**
  99807. * The raw pose from the device
  99808. */
  99809. rawPose: DevicePose;
  99810. private _trackPosition;
  99811. private _maxRotationDistFromHeadset;
  99812. private _draggedRoomRotation;
  99813. /**
  99814. * @hidden
  99815. */
  99816. _disableTrackPosition(fixedPosition: Vector3): void;
  99817. /**
  99818. * Internal, the mesh attached to the controller
  99819. * @hidden
  99820. */
  99821. _mesh: Nullable<AbstractMesh>;
  99822. private _poseControlledCamera;
  99823. private _leftHandSystemQuaternion;
  99824. /**
  99825. * Internal, matrix used to convert room space to babylon space
  99826. * @hidden
  99827. */
  99828. _deviceToWorld: Matrix;
  99829. /**
  99830. * Node to be used when casting a ray from the controller
  99831. * @hidden
  99832. */
  99833. _pointingPoseNode: Nullable<TransformNode>;
  99834. /**
  99835. * Name of the child mesh that can be used to cast a ray from the controller
  99836. */
  99837. static readonly POINTING_POSE: string;
  99838. /**
  99839. * Creates a new PoseEnabledController from a gamepad
  99840. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  99841. */
  99842. constructor(browserGamepad: any);
  99843. private _workingMatrix;
  99844. /**
  99845. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  99846. */
  99847. update(): void;
  99848. /**
  99849. * Updates only the pose device and mesh without doing any button event checking
  99850. */
  99851. protected _updatePoseAndMesh(): void;
  99852. /**
  99853. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  99854. * @param poseData raw pose fromthe device
  99855. */
  99856. updateFromDevice(poseData: DevicePose): void;
  99857. /**
  99858. * @hidden
  99859. */
  99860. _meshAttachedObservable: Observable<AbstractMesh>;
  99861. /**
  99862. * Attaches a mesh to the controller
  99863. * @param mesh the mesh to be attached
  99864. */
  99865. attachToMesh(mesh: AbstractMesh): void;
  99866. /**
  99867. * Attaches the controllers mesh to a camera
  99868. * @param camera the camera the mesh should be attached to
  99869. */
  99870. attachToPoseControlledCamera(camera: TargetCamera): void;
  99871. /**
  99872. * Disposes of the controller
  99873. */
  99874. dispose(): void;
  99875. /**
  99876. * The mesh that is attached to the controller
  99877. */
  99878. get mesh(): Nullable<AbstractMesh>;
  99879. /**
  99880. * Gets the ray of the controller in the direction the controller is pointing
  99881. * @param length the length the resulting ray should be
  99882. * @returns a ray in the direction the controller is pointing
  99883. */
  99884. getForwardRay(length?: number): Ray;
  99885. }
  99886. }
  99887. declare module BABYLON {
  99888. /**
  99889. * Defines the WebVRController object that represents controllers tracked in 3D space
  99890. */
  99891. export abstract class WebVRController extends PoseEnabledController {
  99892. /**
  99893. * Internal, the default controller model for the controller
  99894. */
  99895. protected _defaultModel: Nullable<AbstractMesh>;
  99896. /**
  99897. * Fired when the trigger state has changed
  99898. */
  99899. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  99900. /**
  99901. * Fired when the main button state has changed
  99902. */
  99903. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  99904. /**
  99905. * Fired when the secondary button state has changed
  99906. */
  99907. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  99908. /**
  99909. * Fired when the pad state has changed
  99910. */
  99911. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  99912. /**
  99913. * Fired when controllers stick values have changed
  99914. */
  99915. onPadValuesChangedObservable: Observable<StickValues>;
  99916. /**
  99917. * Array of button availible on the controller
  99918. */
  99919. protected _buttons: Array<MutableGamepadButton>;
  99920. private _onButtonStateChange;
  99921. /**
  99922. * Fired when a controller button's state has changed
  99923. * @param callback the callback containing the button that was modified
  99924. */
  99925. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  99926. /**
  99927. * X and Y axis corresponding to the controllers joystick
  99928. */
  99929. pad: StickValues;
  99930. /**
  99931. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  99932. */
  99933. hand: string;
  99934. /**
  99935. * The default controller model for the controller
  99936. */
  99937. get defaultModel(): Nullable<AbstractMesh>;
  99938. /**
  99939. * Creates a new WebVRController from a gamepad
  99940. * @param vrGamepad the gamepad that the WebVRController should be created from
  99941. */
  99942. constructor(vrGamepad: any);
  99943. /**
  99944. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  99945. */
  99946. update(): void;
  99947. /**
  99948. * Function to be called when a button is modified
  99949. */
  99950. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  99951. /**
  99952. * Loads a mesh and attaches it to the controller
  99953. * @param scene the scene the mesh should be added to
  99954. * @param meshLoaded callback for when the mesh has been loaded
  99955. */
  99956. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  99957. private _setButtonValue;
  99958. private _changes;
  99959. private _checkChanges;
  99960. /**
  99961. * Disposes of th webVRCOntroller
  99962. */
  99963. dispose(): void;
  99964. }
  99965. }
  99966. declare module BABYLON {
  99967. /**
  99968. * The HemisphericLight simulates the ambient environment light,
  99969. * so the passed direction is the light reflection direction, not the incoming direction.
  99970. */
  99971. export class HemisphericLight extends Light {
  99972. /**
  99973. * The groundColor is the light in the opposite direction to the one specified during creation.
  99974. * 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.
  99975. */
  99976. groundColor: Color3;
  99977. /**
  99978. * The light reflection direction, not the incoming direction.
  99979. */
  99980. direction: Vector3;
  99981. /**
  99982. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  99983. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  99984. * The HemisphericLight can't cast shadows.
  99985. * Documentation : https://doc.babylonjs.com/babylon101/lights
  99986. * @param name The friendly name of the light
  99987. * @param direction The direction of the light reflection
  99988. * @param scene The scene the light belongs to
  99989. */
  99990. constructor(name: string, direction: Vector3, scene: Scene);
  99991. protected _buildUniformLayout(): void;
  99992. /**
  99993. * Returns the string "HemisphericLight".
  99994. * @return The class name
  99995. */
  99996. getClassName(): string;
  99997. /**
  99998. * Sets the HemisphericLight direction towards the passed target (Vector3).
  99999. * Returns the updated direction.
  100000. * @param target The target the direction should point to
  100001. * @return The computed direction
  100002. */
  100003. setDirectionToTarget(target: Vector3): Vector3;
  100004. /**
  100005. * Returns the shadow generator associated to the light.
  100006. * @returns Always null for hemispheric lights because it does not support shadows.
  100007. */
  100008. getShadowGenerator(): Nullable<IShadowGenerator>;
  100009. /**
  100010. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  100011. * @param effect The effect to update
  100012. * @param lightIndex The index of the light in the effect to update
  100013. * @returns The hemispheric light
  100014. */
  100015. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  100016. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  100017. /**
  100018. * Computes the world matrix of the node
  100019. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  100020. * @param useWasUpdatedFlag defines a reserved property
  100021. * @returns the world matrix
  100022. */
  100023. computeWorldMatrix(): Matrix;
  100024. /**
  100025. * Returns the integer 3.
  100026. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  100027. */
  100028. getTypeID(): number;
  100029. /**
  100030. * Prepares the list of defines specific to the light type.
  100031. * @param defines the list of defines
  100032. * @param lightIndex defines the index of the light for the effect
  100033. */
  100034. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  100035. }
  100036. }
  100037. declare module BABYLON {
  100038. /** @hidden */
  100039. export var vrMultiviewToSingleviewPixelShader: {
  100040. name: string;
  100041. shader: string;
  100042. };
  100043. }
  100044. declare module BABYLON {
  100045. /**
  100046. * Renders to multiple views with a single draw call
  100047. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  100048. */
  100049. export class MultiviewRenderTarget extends RenderTargetTexture {
  100050. /**
  100051. * Creates a multiview render target
  100052. * @param scene scene used with the render target
  100053. * @param size the size of the render target (used for each view)
  100054. */
  100055. constructor(scene: Scene, size?: number | {
  100056. width: number;
  100057. height: number;
  100058. } | {
  100059. ratio: number;
  100060. });
  100061. /**
  100062. * @hidden
  100063. * @param faceIndex the face index, if its a cube texture
  100064. */
  100065. _bindFrameBuffer(faceIndex?: number): void;
  100066. /**
  100067. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  100068. * @returns the view count
  100069. */
  100070. getViewCount(): number;
  100071. }
  100072. }
  100073. declare module BABYLON {
  100074. interface Engine {
  100075. /**
  100076. * Creates a new multiview render target
  100077. * @param width defines the width of the texture
  100078. * @param height defines the height of the texture
  100079. * @returns the created multiview texture
  100080. */
  100081. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  100082. /**
  100083. * Binds a multiview framebuffer to be drawn to
  100084. * @param multiviewTexture texture to bind
  100085. */
  100086. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  100087. }
  100088. interface Camera {
  100089. /**
  100090. * @hidden
  100091. * 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)
  100092. */
  100093. _useMultiviewToSingleView: boolean;
  100094. /**
  100095. * @hidden
  100096. * 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)
  100097. */
  100098. _multiviewTexture: Nullable<RenderTargetTexture>;
  100099. /**
  100100. * @hidden
  100101. * ensures the multiview texture of the camera exists and has the specified width/height
  100102. * @param width height to set on the multiview texture
  100103. * @param height width to set on the multiview texture
  100104. */
  100105. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  100106. }
  100107. interface Scene {
  100108. /** @hidden */
  100109. _transformMatrixR: Matrix;
  100110. /** @hidden */
  100111. _multiviewSceneUbo: Nullable<UniformBuffer>;
  100112. /** @hidden */
  100113. _createMultiviewUbo(): void;
  100114. /** @hidden */
  100115. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  100116. /** @hidden */
  100117. _renderMultiviewToSingleView(camera: Camera): void;
  100118. }
  100119. }
  100120. declare module BABYLON {
  100121. /**
  100122. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  100123. * This will not be used for webXR as it supports displaying texture arrays directly
  100124. */
  100125. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  100126. /**
  100127. * Gets a string identifying the name of the class
  100128. * @returns "VRMultiviewToSingleviewPostProcess" string
  100129. */
  100130. getClassName(): string;
  100131. /**
  100132. * Initializes a VRMultiviewToSingleview
  100133. * @param name name of the post process
  100134. * @param camera camera to be applied to
  100135. * @param scaleFactor scaling factor to the size of the output texture
  100136. */
  100137. constructor(name: string, camera: Camera, scaleFactor: number);
  100138. }
  100139. }
  100140. declare module BABYLON {
  100141. /**
  100142. * Interface used to define additional presentation attributes
  100143. */
  100144. export interface IVRPresentationAttributes {
  100145. /**
  100146. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  100147. */
  100148. highRefreshRate: boolean;
  100149. /**
  100150. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  100151. */
  100152. foveationLevel: number;
  100153. }
  100154. interface Engine {
  100155. /** @hidden */
  100156. _vrDisplay: any;
  100157. /** @hidden */
  100158. _vrSupported: boolean;
  100159. /** @hidden */
  100160. _oldSize: Size;
  100161. /** @hidden */
  100162. _oldHardwareScaleFactor: number;
  100163. /** @hidden */
  100164. _vrExclusivePointerMode: boolean;
  100165. /** @hidden */
  100166. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  100167. /** @hidden */
  100168. _onVRDisplayPointerRestricted: () => void;
  100169. /** @hidden */
  100170. _onVRDisplayPointerUnrestricted: () => void;
  100171. /** @hidden */
  100172. _onVrDisplayConnect: Nullable<(display: any) => void>;
  100173. /** @hidden */
  100174. _onVrDisplayDisconnect: Nullable<() => void>;
  100175. /** @hidden */
  100176. _onVrDisplayPresentChange: Nullable<() => void>;
  100177. /**
  100178. * Observable signaled when VR display mode changes
  100179. */
  100180. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  100181. /**
  100182. * Observable signaled when VR request present is complete
  100183. */
  100184. onVRRequestPresentComplete: Observable<boolean>;
  100185. /**
  100186. * Observable signaled when VR request present starts
  100187. */
  100188. onVRRequestPresentStart: Observable<Engine>;
  100189. /**
  100190. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  100191. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  100192. */
  100193. isInVRExclusivePointerMode: boolean;
  100194. /**
  100195. * Gets a boolean indicating if a webVR device was detected
  100196. * @returns true if a webVR device was detected
  100197. */
  100198. isVRDevicePresent(): boolean;
  100199. /**
  100200. * Gets the current webVR device
  100201. * @returns the current webVR device (or null)
  100202. */
  100203. getVRDevice(): any;
  100204. /**
  100205. * Initializes a webVR display and starts listening to display change events
  100206. * The onVRDisplayChangedObservable will be notified upon these changes
  100207. * @returns A promise containing a VRDisplay and if vr is supported
  100208. */
  100209. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  100210. /** @hidden */
  100211. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  100212. /**
  100213. * Gets or sets the presentation attributes used to configure VR rendering
  100214. */
  100215. vrPresentationAttributes?: IVRPresentationAttributes;
  100216. /**
  100217. * Call this function to switch to webVR mode
  100218. * Will do nothing if webVR is not supported or if there is no webVR device
  100219. * @param options the webvr options provided to the camera. mainly used for multiview
  100220. * @see https://doc.babylonjs.com/how_to/webvr_camera
  100221. */
  100222. enableVR(options: WebVROptions): void;
  100223. /** @hidden */
  100224. _onVRFullScreenTriggered(): void;
  100225. }
  100226. }
  100227. declare module BABYLON {
  100228. /**
  100229. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  100230. * IMPORTANT!! The data is right-hand data.
  100231. * @export
  100232. * @interface DevicePose
  100233. */
  100234. export interface DevicePose {
  100235. /**
  100236. * The position of the device, values in array are [x,y,z].
  100237. */
  100238. readonly position: Nullable<Float32Array>;
  100239. /**
  100240. * The linearVelocity of the device, values in array are [x,y,z].
  100241. */
  100242. readonly linearVelocity: Nullable<Float32Array>;
  100243. /**
  100244. * The linearAcceleration of the device, values in array are [x,y,z].
  100245. */
  100246. readonly linearAcceleration: Nullable<Float32Array>;
  100247. /**
  100248. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  100249. */
  100250. readonly orientation: Nullable<Float32Array>;
  100251. /**
  100252. * The angularVelocity of the device, values in array are [x,y,z].
  100253. */
  100254. readonly angularVelocity: Nullable<Float32Array>;
  100255. /**
  100256. * The angularAcceleration of the device, values in array are [x,y,z].
  100257. */
  100258. readonly angularAcceleration: Nullable<Float32Array>;
  100259. }
  100260. /**
  100261. * Interface representing a pose controlled object in Babylon.
  100262. * A pose controlled object has both regular pose values as well as pose values
  100263. * from an external device such as a VR head mounted display
  100264. */
  100265. export interface PoseControlled {
  100266. /**
  100267. * The position of the object in babylon space.
  100268. */
  100269. position: Vector3;
  100270. /**
  100271. * The rotation quaternion of the object in babylon space.
  100272. */
  100273. rotationQuaternion: Quaternion;
  100274. /**
  100275. * The position of the device in babylon space.
  100276. */
  100277. devicePosition?: Vector3;
  100278. /**
  100279. * The rotation quaternion of the device in babylon space.
  100280. */
  100281. deviceRotationQuaternion: Quaternion;
  100282. /**
  100283. * The raw pose coming from the device.
  100284. */
  100285. rawPose: Nullable<DevicePose>;
  100286. /**
  100287. * The scale of the device to be used when translating from device space to babylon space.
  100288. */
  100289. deviceScaleFactor: number;
  100290. /**
  100291. * Updates the poseControlled values based on the input device pose.
  100292. * @param poseData the pose data to update the object with
  100293. */
  100294. updateFromDevice(poseData: DevicePose): void;
  100295. }
  100296. /**
  100297. * Set of options to customize the webVRCamera
  100298. */
  100299. export interface WebVROptions {
  100300. /**
  100301. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  100302. */
  100303. trackPosition?: boolean;
  100304. /**
  100305. * Sets the scale of the vrDevice in babylon space. (default: 1)
  100306. */
  100307. positionScale?: number;
  100308. /**
  100309. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  100310. */
  100311. displayName?: string;
  100312. /**
  100313. * Should the native controller meshes be initialized. (default: true)
  100314. */
  100315. controllerMeshes?: boolean;
  100316. /**
  100317. * Creating a default HemiLight only on controllers. (default: true)
  100318. */
  100319. defaultLightingOnControllers?: boolean;
  100320. /**
  100321. * If you don't want to use the default VR button of the helper. (default: false)
  100322. */
  100323. useCustomVRButton?: boolean;
  100324. /**
  100325. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  100326. */
  100327. customVRButton?: HTMLButtonElement;
  100328. /**
  100329. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  100330. */
  100331. rayLength?: number;
  100332. /**
  100333. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  100334. */
  100335. defaultHeight?: number;
  100336. /**
  100337. * If multiview should be used if availible (default: false)
  100338. */
  100339. useMultiview?: boolean;
  100340. }
  100341. /**
  100342. * This represents a WebVR camera.
  100343. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  100344. * @example https://doc.babylonjs.com/how_to/webvr_camera
  100345. */
  100346. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  100347. private webVROptions;
  100348. /**
  100349. * @hidden
  100350. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  100351. */
  100352. _vrDevice: any;
  100353. /**
  100354. * The rawPose of the vrDevice.
  100355. */
  100356. rawPose: Nullable<DevicePose>;
  100357. private _onVREnabled;
  100358. private _specsVersion;
  100359. private _attached;
  100360. private _frameData;
  100361. protected _descendants: Array<Node>;
  100362. private _deviceRoomPosition;
  100363. /** @hidden */
  100364. _deviceRoomRotationQuaternion: Quaternion;
  100365. private _standingMatrix;
  100366. /**
  100367. * Represents device position in babylon space.
  100368. */
  100369. devicePosition: Vector3;
  100370. /**
  100371. * Represents device rotation in babylon space.
  100372. */
  100373. deviceRotationQuaternion: Quaternion;
  100374. /**
  100375. * The scale of the device to be used when translating from device space to babylon space.
  100376. */
  100377. deviceScaleFactor: number;
  100378. private _deviceToWorld;
  100379. private _worldToDevice;
  100380. /**
  100381. * References to the webVR controllers for the vrDevice.
  100382. */
  100383. controllers: Array<WebVRController>;
  100384. /**
  100385. * Emits an event when a controller is attached.
  100386. */
  100387. onControllersAttachedObservable: Observable<WebVRController[]>;
  100388. /**
  100389. * Emits an event when a controller's mesh has been loaded;
  100390. */
  100391. onControllerMeshLoadedObservable: Observable<WebVRController>;
  100392. /**
  100393. * Emits an event when the HMD's pose has been updated.
  100394. */
  100395. onPoseUpdatedFromDeviceObservable: Observable<any>;
  100396. private _poseSet;
  100397. /**
  100398. * If the rig cameras be used as parent instead of this camera.
  100399. */
  100400. rigParenting: boolean;
  100401. private _lightOnControllers;
  100402. private _defaultHeight?;
  100403. /**
  100404. * Instantiates a WebVRFreeCamera.
  100405. * @param name The name of the WebVRFreeCamera
  100406. * @param position The starting anchor position for the camera
  100407. * @param scene The scene the camera belongs to
  100408. * @param webVROptions a set of customizable options for the webVRCamera
  100409. */
  100410. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  100411. /**
  100412. * Gets the device distance from the ground in meters.
  100413. * @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.
  100414. */
  100415. deviceDistanceToRoomGround(): number;
  100416. /**
  100417. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  100418. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  100419. */
  100420. useStandingMatrix(callback?: (bool: boolean) => void): void;
  100421. /**
  100422. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  100423. * @returns A promise with a boolean set to if the standing matrix is supported.
  100424. */
  100425. useStandingMatrixAsync(): Promise<boolean>;
  100426. /**
  100427. * Disposes the camera
  100428. */
  100429. dispose(): void;
  100430. /**
  100431. * Gets a vrController by name.
  100432. * @param name The name of the controller to retreive
  100433. * @returns the controller matching the name specified or null if not found
  100434. */
  100435. getControllerByName(name: string): Nullable<WebVRController>;
  100436. private _leftController;
  100437. /**
  100438. * The controller corresponding to the users left hand.
  100439. */
  100440. get leftController(): Nullable<WebVRController>;
  100441. private _rightController;
  100442. /**
  100443. * The controller corresponding to the users right hand.
  100444. */
  100445. get rightController(): Nullable<WebVRController>;
  100446. /**
  100447. * Casts a ray forward from the vrCamera's gaze.
  100448. * @param length Length of the ray (default: 100)
  100449. * @returns the ray corresponding to the gaze
  100450. */
  100451. getForwardRay(length?: number): Ray;
  100452. /**
  100453. * @hidden
  100454. * Updates the camera based on device's frame data
  100455. */
  100456. _checkInputs(): void;
  100457. /**
  100458. * Updates the poseControlled values based on the input device pose.
  100459. * @param poseData Pose coming from the device
  100460. */
  100461. updateFromDevice(poseData: DevicePose): void;
  100462. private _htmlElementAttached;
  100463. private _detachIfAttached;
  100464. /**
  100465. * WebVR's attach control will start broadcasting frames to the device.
  100466. * Note that in certain browsers (chrome for example) this function must be called
  100467. * within a user-interaction callback. Example:
  100468. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  100469. *
  100470. * @param element html element to attach the vrDevice to
  100471. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  100472. */
  100473. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  100474. /**
  100475. * Detaches the camera from the html element and disables VR
  100476. *
  100477. * @param element html element to detach from
  100478. */
  100479. detachControl(element: HTMLElement): void;
  100480. /**
  100481. * @returns the name of this class
  100482. */
  100483. getClassName(): string;
  100484. /**
  100485. * Calls resetPose on the vrDisplay
  100486. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  100487. */
  100488. resetToCurrentRotation(): void;
  100489. /**
  100490. * @hidden
  100491. * Updates the rig cameras (left and right eye)
  100492. */
  100493. _updateRigCameras(): void;
  100494. private _workingVector;
  100495. private _oneVector;
  100496. private _workingMatrix;
  100497. private updateCacheCalled;
  100498. private _correctPositionIfNotTrackPosition;
  100499. /**
  100500. * @hidden
  100501. * Updates the cached values of the camera
  100502. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  100503. */
  100504. _updateCache(ignoreParentClass?: boolean): void;
  100505. /**
  100506. * @hidden
  100507. * Get current device position in babylon world
  100508. */
  100509. _computeDevicePosition(): void;
  100510. /**
  100511. * Updates the current device position and rotation in the babylon world
  100512. */
  100513. update(): void;
  100514. /**
  100515. * @hidden
  100516. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  100517. * @returns an identity matrix
  100518. */
  100519. _getViewMatrix(): Matrix;
  100520. private _tmpMatrix;
  100521. /**
  100522. * This function is called by the two RIG cameras.
  100523. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  100524. * @hidden
  100525. */
  100526. _getWebVRViewMatrix(): Matrix;
  100527. /** @hidden */
  100528. _getWebVRProjectionMatrix(): Matrix;
  100529. private _onGamepadConnectedObserver;
  100530. private _onGamepadDisconnectedObserver;
  100531. private _updateCacheWhenTrackingDisabledObserver;
  100532. /**
  100533. * Initializes the controllers and their meshes
  100534. */
  100535. initControllers(): void;
  100536. }
  100537. }
  100538. declare module BABYLON {
  100539. /**
  100540. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  100541. *
  100542. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  100543. *
  100544. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  100545. */
  100546. export class MaterialHelper {
  100547. /**
  100548. * Bind the current view position to an effect.
  100549. * @param effect The effect to be bound
  100550. * @param scene The scene the eyes position is used from
  100551. * @param variableName name of the shader variable that will hold the eye position
  100552. */
  100553. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  100554. /**
  100555. * Helps preparing the defines values about the UVs in used in the effect.
  100556. * UVs are shared as much as we can accross channels in the shaders.
  100557. * @param texture The texture we are preparing the UVs for
  100558. * @param defines The defines to update
  100559. * @param key The channel key "diffuse", "specular"... used in the shader
  100560. */
  100561. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  100562. /**
  100563. * Binds a texture matrix value to its corrsponding uniform
  100564. * @param texture The texture to bind the matrix for
  100565. * @param uniformBuffer The uniform buffer receivin the data
  100566. * @param key The channel key "diffuse", "specular"... used in the shader
  100567. */
  100568. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  100569. /**
  100570. * Gets the current status of the fog (should it be enabled?)
  100571. * @param mesh defines the mesh to evaluate for fog support
  100572. * @param scene defines the hosting scene
  100573. * @returns true if fog must be enabled
  100574. */
  100575. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  100576. /**
  100577. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  100578. * @param mesh defines the current mesh
  100579. * @param scene defines the current scene
  100580. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  100581. * @param pointsCloud defines if point cloud rendering has to be turned on
  100582. * @param fogEnabled defines if fog has to be turned on
  100583. * @param alphaTest defines if alpha testing has to be turned on
  100584. * @param defines defines the current list of defines
  100585. */
  100586. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  100587. /**
  100588. * Helper used to prepare the list of defines associated with frame values for shader compilation
  100589. * @param scene defines the current scene
  100590. * @param engine defines the current engine
  100591. * @param defines specifies the list of active defines
  100592. * @param useInstances defines if instances have to be turned on
  100593. * @param useClipPlane defines if clip plane have to be turned on
  100594. * @param useInstances defines if instances have to be turned on
  100595. * @param useThinInstances defines if thin instances have to be turned on
  100596. */
  100597. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  100598. /**
  100599. * Prepares the defines for bones
  100600. * @param mesh The mesh containing the geometry data we will draw
  100601. * @param defines The defines to update
  100602. */
  100603. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  100604. /**
  100605. * Prepares the defines for morph targets
  100606. * @param mesh The mesh containing the geometry data we will draw
  100607. * @param defines The defines to update
  100608. */
  100609. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  100610. /**
  100611. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  100612. * @param mesh The mesh containing the geometry data we will draw
  100613. * @param defines The defines to update
  100614. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  100615. * @param useBones Precise whether bones should be used or not (override mesh info)
  100616. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  100617. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  100618. * @returns false if defines are considered not dirty and have not been checked
  100619. */
  100620. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  100621. /**
  100622. * Prepares the defines related to multiview
  100623. * @param scene The scene we are intending to draw
  100624. * @param defines The defines to update
  100625. */
  100626. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  100627. /**
  100628. * Prepares the defines related to the prepass
  100629. * @param scene The scene we are intending to draw
  100630. * @param defines The defines to update
  100631. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  100632. */
  100633. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  100634. /**
  100635. * Prepares the defines related to the light information passed in parameter
  100636. * @param scene The scene we are intending to draw
  100637. * @param mesh The mesh the effect is compiling for
  100638. * @param light The light the effect is compiling for
  100639. * @param lightIndex The index of the light
  100640. * @param defines The defines to update
  100641. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  100642. * @param state Defines the current state regarding what is needed (normals, etc...)
  100643. */
  100644. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  100645. needNormals: boolean;
  100646. needRebuild: boolean;
  100647. shadowEnabled: boolean;
  100648. specularEnabled: boolean;
  100649. lightmapMode: boolean;
  100650. }): void;
  100651. /**
  100652. * Prepares the defines related to the light information passed in parameter
  100653. * @param scene The scene we are intending to draw
  100654. * @param mesh The mesh the effect is compiling for
  100655. * @param defines The defines to update
  100656. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  100657. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  100658. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  100659. * @returns true if normals will be required for the rest of the effect
  100660. */
  100661. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  100662. /**
  100663. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  100664. * @param lightIndex defines the light index
  100665. * @param uniformsList The uniform list
  100666. * @param samplersList The sampler list
  100667. * @param projectedLightTexture defines if projected texture must be used
  100668. * @param uniformBuffersList defines an optional list of uniform buffers
  100669. */
  100670. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  100671. /**
  100672. * Prepares the uniforms and samplers list to be used in the effect
  100673. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  100674. * @param samplersList The sampler list
  100675. * @param defines The defines helping in the list generation
  100676. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  100677. */
  100678. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  100679. /**
  100680. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  100681. * @param defines The defines to update while falling back
  100682. * @param fallbacks The authorized effect fallbacks
  100683. * @param maxSimultaneousLights The maximum number of lights allowed
  100684. * @param rank the current rank of the Effect
  100685. * @returns The newly affected rank
  100686. */
  100687. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  100688. private static _TmpMorphInfluencers;
  100689. /**
  100690. * Prepares the list of attributes required for morph targets according to the effect defines.
  100691. * @param attribs The current list of supported attribs
  100692. * @param mesh The mesh to prepare the morph targets attributes for
  100693. * @param influencers The number of influencers
  100694. */
  100695. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  100696. /**
  100697. * Prepares the list of attributes required for morph targets according to the effect defines.
  100698. * @param attribs The current list of supported attribs
  100699. * @param mesh The mesh to prepare the morph targets attributes for
  100700. * @param defines The current Defines of the effect
  100701. */
  100702. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  100703. /**
  100704. * Prepares the list of attributes required for bones according to the effect defines.
  100705. * @param attribs The current list of supported attribs
  100706. * @param mesh The mesh to prepare the bones attributes for
  100707. * @param defines The current Defines of the effect
  100708. * @param fallbacks The current efffect fallback strategy
  100709. */
  100710. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  100711. /**
  100712. * Check and prepare the list of attributes required for instances according to the effect defines.
  100713. * @param attribs The current list of supported attribs
  100714. * @param defines The current MaterialDefines of the effect
  100715. */
  100716. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  100717. /**
  100718. * Add the list of attributes required for instances to the attribs array.
  100719. * @param attribs The current list of supported attribs
  100720. */
  100721. static PushAttributesForInstances(attribs: string[]): void;
  100722. /**
  100723. * Binds the light information to the effect.
  100724. * @param light The light containing the generator
  100725. * @param effect The effect we are binding the data to
  100726. * @param lightIndex The light index in the effect used to render
  100727. */
  100728. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  100729. /**
  100730. * Binds the lights information from the scene to the effect for the given mesh.
  100731. * @param light Light to bind
  100732. * @param lightIndex Light index
  100733. * @param scene The scene where the light belongs to
  100734. * @param effect The effect we are binding the data to
  100735. * @param useSpecular Defines if specular is supported
  100736. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  100737. */
  100738. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  100739. /**
  100740. * Binds the lights information from the scene to the effect for the given mesh.
  100741. * @param scene The scene the lights belongs to
  100742. * @param mesh The mesh we are binding the information to render
  100743. * @param effect The effect we are binding the data to
  100744. * @param defines The generated defines for the effect
  100745. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  100746. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  100747. */
  100748. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  100749. private static _tempFogColor;
  100750. /**
  100751. * Binds the fog information from the scene to the effect for the given mesh.
  100752. * @param scene The scene the lights belongs to
  100753. * @param mesh The mesh we are binding the information to render
  100754. * @param effect The effect we are binding the data to
  100755. * @param linearSpace Defines if the fog effect is applied in linear space
  100756. */
  100757. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  100758. /**
  100759. * Binds the bones information from the mesh to the effect.
  100760. * @param mesh The mesh we are binding the information to render
  100761. * @param effect The effect we are binding the data to
  100762. */
  100763. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  100764. /**
  100765. * Binds the morph targets information from the mesh to the effect.
  100766. * @param abstractMesh The mesh we are binding the information to render
  100767. * @param effect The effect we are binding the data to
  100768. */
  100769. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  100770. /**
  100771. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  100772. * @param defines The generated defines used in the effect
  100773. * @param effect The effect we are binding the data to
  100774. * @param scene The scene we are willing to render with logarithmic scale for
  100775. */
  100776. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  100777. /**
  100778. * Binds the clip plane information from the scene to the effect.
  100779. * @param scene The scene the clip plane information are extracted from
  100780. * @param effect The effect we are binding the data to
  100781. */
  100782. static BindClipPlane(effect: Effect, scene: Scene): void;
  100783. }
  100784. }
  100785. declare module BABYLON {
  100786. /**
  100787. * Block used to expose an input value
  100788. */
  100789. export class InputBlock extends NodeMaterialBlock {
  100790. private _mode;
  100791. private _associatedVariableName;
  100792. private _storedValue;
  100793. private _valueCallback;
  100794. private _type;
  100795. private _animationType;
  100796. /** Gets or set a value used to limit the range of float values */
  100797. min: number;
  100798. /** Gets or set a value used to limit the range of float values */
  100799. max: number;
  100800. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  100801. isBoolean: boolean;
  100802. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  100803. matrixMode: number;
  100804. /** @hidden */
  100805. _systemValue: Nullable<NodeMaterialSystemValues>;
  100806. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  100807. isConstant: boolean;
  100808. /** Gets or sets the group to use to display this block in the Inspector */
  100809. groupInInspector: string;
  100810. /** Gets an observable raised when the value is changed */
  100811. onValueChangedObservable: Observable<InputBlock>;
  100812. /**
  100813. * Gets or sets the connection point type (default is float)
  100814. */
  100815. get type(): NodeMaterialBlockConnectionPointTypes;
  100816. /**
  100817. * Creates a new InputBlock
  100818. * @param name defines the block name
  100819. * @param target defines the target of that block (Vertex by default)
  100820. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  100821. */
  100822. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  100823. /**
  100824. * Validates if a name is a reserve word.
  100825. * @param newName the new name to be given to the node.
  100826. * @returns false if the name is a reserve word, else true.
  100827. */
  100828. validateBlockName(newName: string): boolean;
  100829. /**
  100830. * Gets the output component
  100831. */
  100832. get output(): NodeMaterialConnectionPoint;
  100833. /**
  100834. * Set the source of this connection point to a vertex attribute
  100835. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  100836. * @returns the current connection point
  100837. */
  100838. setAsAttribute(attributeName?: string): InputBlock;
  100839. /**
  100840. * Set the source of this connection point to a system value
  100841. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  100842. * @returns the current connection point
  100843. */
  100844. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  100845. /**
  100846. * Gets or sets the value of that point.
  100847. * Please note that this value will be ignored if valueCallback is defined
  100848. */
  100849. get value(): any;
  100850. set value(value: any);
  100851. /**
  100852. * Gets or sets a callback used to get the value of that point.
  100853. * Please note that setting this value will force the connection point to ignore the value property
  100854. */
  100855. get valueCallback(): () => any;
  100856. set valueCallback(value: () => any);
  100857. /**
  100858. * Gets or sets the associated variable name in the shader
  100859. */
  100860. get associatedVariableName(): string;
  100861. set associatedVariableName(value: string);
  100862. /** Gets or sets the type of animation applied to the input */
  100863. get animationType(): AnimatedInputBlockTypes;
  100864. set animationType(value: AnimatedInputBlockTypes);
  100865. /**
  100866. * Gets a boolean indicating that this connection point not defined yet
  100867. */
  100868. get isUndefined(): boolean;
  100869. /**
  100870. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  100871. * In this case the connection point name must be the name of the uniform to use.
  100872. * Can only be set on inputs
  100873. */
  100874. get isUniform(): boolean;
  100875. set isUniform(value: boolean);
  100876. /**
  100877. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  100878. * In this case the connection point name must be the name of the attribute to use
  100879. * Can only be set on inputs
  100880. */
  100881. get isAttribute(): boolean;
  100882. set isAttribute(value: boolean);
  100883. /**
  100884. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  100885. * Can only be set on exit points
  100886. */
  100887. get isVarying(): boolean;
  100888. set isVarying(value: boolean);
  100889. /**
  100890. * Gets a boolean indicating that the current connection point is a system value
  100891. */
  100892. get isSystemValue(): boolean;
  100893. /**
  100894. * Gets or sets the current well known value or null if not defined as a system value
  100895. */
  100896. get systemValue(): Nullable<NodeMaterialSystemValues>;
  100897. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  100898. /**
  100899. * Gets the current class name
  100900. * @returns the class name
  100901. */
  100902. getClassName(): string;
  100903. /**
  100904. * Animate the input if animationType !== None
  100905. * @param scene defines the rendering scene
  100906. */
  100907. animate(scene: Scene): void;
  100908. private _emitDefine;
  100909. initialize(state: NodeMaterialBuildState): void;
  100910. /**
  100911. * Set the input block to its default value (based on its type)
  100912. */
  100913. setDefaultValue(): void;
  100914. private _emitConstant;
  100915. /** @hidden */
  100916. get _noContextSwitch(): boolean;
  100917. private _emit;
  100918. /** @hidden */
  100919. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  100920. /** @hidden */
  100921. _transmit(effect: Effect, scene: Scene): void;
  100922. protected _buildBlock(state: NodeMaterialBuildState): void;
  100923. protected _dumpPropertiesCode(): string;
  100924. dispose(): void;
  100925. serialize(): any;
  100926. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100927. }
  100928. }
  100929. declare module BABYLON {
  100930. /**
  100931. * Enum used to define the compatibility state between two connection points
  100932. */
  100933. export enum NodeMaterialConnectionPointCompatibilityStates {
  100934. /** Points are compatibles */
  100935. Compatible = 0,
  100936. /** Points are incompatible because of their types */
  100937. TypeIncompatible = 1,
  100938. /** Points are incompatible because of their targets (vertex vs fragment) */
  100939. TargetIncompatible = 2
  100940. }
  100941. /**
  100942. * Defines the direction of a connection point
  100943. */
  100944. export enum NodeMaterialConnectionPointDirection {
  100945. /** Input */
  100946. Input = 0,
  100947. /** Output */
  100948. Output = 1
  100949. }
  100950. /**
  100951. * Defines a connection point for a block
  100952. */
  100953. export class NodeMaterialConnectionPoint {
  100954. /** @hidden */
  100955. _ownerBlock: NodeMaterialBlock;
  100956. /** @hidden */
  100957. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  100958. private _endpoints;
  100959. private _associatedVariableName;
  100960. private _direction;
  100961. /** @hidden */
  100962. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  100963. /** @hidden */
  100964. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  100965. private _type;
  100966. /** @hidden */
  100967. _enforceAssociatedVariableName: boolean;
  100968. /** Gets the direction of the point */
  100969. get direction(): NodeMaterialConnectionPointDirection;
  100970. /** Indicates that this connection point needs dual validation before being connected to another point */
  100971. needDualDirectionValidation: boolean;
  100972. /**
  100973. * Gets or sets the additional types supported by this connection point
  100974. */
  100975. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  100976. /**
  100977. * Gets or sets the additional types excluded by this connection point
  100978. */
  100979. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  100980. /**
  100981. * Observable triggered when this point is connected
  100982. */
  100983. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  100984. /**
  100985. * Gets or sets the associated variable name in the shader
  100986. */
  100987. get associatedVariableName(): string;
  100988. set associatedVariableName(value: string);
  100989. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  100990. get innerType(): NodeMaterialBlockConnectionPointTypes;
  100991. /**
  100992. * Gets or sets the connection point type (default is float)
  100993. */
  100994. get type(): NodeMaterialBlockConnectionPointTypes;
  100995. set type(value: NodeMaterialBlockConnectionPointTypes);
  100996. /**
  100997. * Gets or sets the connection point name
  100998. */
  100999. name: string;
  101000. /**
  101001. * Gets or sets the connection point name
  101002. */
  101003. displayName: string;
  101004. /**
  101005. * Gets or sets a boolean indicating that this connection point can be omitted
  101006. */
  101007. isOptional: boolean;
  101008. /**
  101009. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  101010. */
  101011. isExposedOnFrame: boolean;
  101012. /**
  101013. * Gets or sets number indicating the position that the port is exposed to on a frame
  101014. */
  101015. exposedPortPosition: number;
  101016. /**
  101017. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  101018. */
  101019. define: string;
  101020. /** @hidden */
  101021. _prioritizeVertex: boolean;
  101022. private _target;
  101023. /** Gets or sets the target of that connection point */
  101024. get target(): NodeMaterialBlockTargets;
  101025. set target(value: NodeMaterialBlockTargets);
  101026. /**
  101027. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  101028. */
  101029. get isConnected(): boolean;
  101030. /**
  101031. * Gets a boolean indicating that the current point is connected to an input block
  101032. */
  101033. get isConnectedToInputBlock(): boolean;
  101034. /**
  101035. * Gets a the connected input block (if any)
  101036. */
  101037. get connectInputBlock(): Nullable<InputBlock>;
  101038. /** Get the other side of the connection (if any) */
  101039. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  101040. /** Get the block that owns this connection point */
  101041. get ownerBlock(): NodeMaterialBlock;
  101042. /** Get the block connected on the other side of this connection (if any) */
  101043. get sourceBlock(): Nullable<NodeMaterialBlock>;
  101044. /** Get the block connected on the endpoints of this connection (if any) */
  101045. get connectedBlocks(): Array<NodeMaterialBlock>;
  101046. /** Gets the list of connected endpoints */
  101047. get endpoints(): NodeMaterialConnectionPoint[];
  101048. /** Gets a boolean indicating if that output point is connected to at least one input */
  101049. get hasEndpoints(): boolean;
  101050. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  101051. get isConnectedInVertexShader(): boolean;
  101052. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  101053. get isConnectedInFragmentShader(): boolean;
  101054. /**
  101055. * Creates a block suitable to be used as an input for this input point.
  101056. * If null is returned, a block based on the point type will be created.
  101057. * @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
  101058. */
  101059. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  101060. /**
  101061. * Creates a new connection point
  101062. * @param name defines the connection point name
  101063. * @param ownerBlock defines the block hosting this connection point
  101064. * @param direction defines the direction of the connection point
  101065. */
  101066. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  101067. /**
  101068. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  101069. * @returns the class name
  101070. */
  101071. getClassName(): string;
  101072. /**
  101073. * Gets a boolean indicating if the current point can be connected to another point
  101074. * @param connectionPoint defines the other connection point
  101075. * @returns a boolean
  101076. */
  101077. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  101078. /**
  101079. * Gets a number indicating if the current point can be connected to another point
  101080. * @param connectionPoint defines the other connection point
  101081. * @returns a number defining the compatibility state
  101082. */
  101083. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  101084. /**
  101085. * Connect this point to another connection point
  101086. * @param connectionPoint defines the other connection point
  101087. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  101088. * @returns the current connection point
  101089. */
  101090. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  101091. /**
  101092. * Disconnect this point from one of his endpoint
  101093. * @param endpoint defines the other connection point
  101094. * @returns the current connection point
  101095. */
  101096. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  101097. /**
  101098. * Serializes this point in a JSON representation
  101099. * @param isInput defines if the connection point is an input (default is true)
  101100. * @returns the serialized point object
  101101. */
  101102. serialize(isInput?: boolean): any;
  101103. /**
  101104. * Release resources
  101105. */
  101106. dispose(): void;
  101107. }
  101108. }
  101109. declare module BABYLON {
  101110. /**
  101111. * Enum used to define the material modes
  101112. */
  101113. export enum NodeMaterialModes {
  101114. /** Regular material */
  101115. Material = 0,
  101116. /** For post process */
  101117. PostProcess = 1,
  101118. /** For particle system */
  101119. Particle = 2,
  101120. /** For procedural texture */
  101121. ProceduralTexture = 3
  101122. }
  101123. }
  101124. declare module BABYLON {
  101125. /**
  101126. * Block used to read a texture from a sampler
  101127. */
  101128. export class TextureBlock extends NodeMaterialBlock {
  101129. private _defineName;
  101130. private _linearDefineName;
  101131. private _gammaDefineName;
  101132. private _tempTextureRead;
  101133. private _samplerName;
  101134. private _transformedUVName;
  101135. private _textureTransformName;
  101136. private _textureInfoName;
  101137. private _mainUVName;
  101138. private _mainUVDefineName;
  101139. private _fragmentOnly;
  101140. /**
  101141. * Gets or sets the texture associated with the node
  101142. */
  101143. texture: Nullable<Texture>;
  101144. /**
  101145. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  101146. */
  101147. convertToGammaSpace: boolean;
  101148. /**
  101149. * Gets or sets a boolean indicating if content needs to be converted to linear space
  101150. */
  101151. convertToLinearSpace: boolean;
  101152. /**
  101153. * Create a new TextureBlock
  101154. * @param name defines the block name
  101155. */
  101156. constructor(name: string, fragmentOnly?: boolean);
  101157. /**
  101158. * Gets the current class name
  101159. * @returns the class name
  101160. */
  101161. getClassName(): string;
  101162. /**
  101163. * Gets the uv input component
  101164. */
  101165. get uv(): NodeMaterialConnectionPoint;
  101166. /**
  101167. * Gets the rgba output component
  101168. */
  101169. get rgba(): NodeMaterialConnectionPoint;
  101170. /**
  101171. * Gets the rgb output component
  101172. */
  101173. get rgb(): NodeMaterialConnectionPoint;
  101174. /**
  101175. * Gets the r output component
  101176. */
  101177. get r(): NodeMaterialConnectionPoint;
  101178. /**
  101179. * Gets the g output component
  101180. */
  101181. get g(): NodeMaterialConnectionPoint;
  101182. /**
  101183. * Gets the b output component
  101184. */
  101185. get b(): NodeMaterialConnectionPoint;
  101186. /**
  101187. * Gets the a output component
  101188. */
  101189. get a(): NodeMaterialConnectionPoint;
  101190. get target(): NodeMaterialBlockTargets;
  101191. autoConfigure(material: NodeMaterial): void;
  101192. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  101193. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  101194. isReady(): boolean;
  101195. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  101196. private get _isMixed();
  101197. private _injectVertexCode;
  101198. private _writeTextureRead;
  101199. private _writeOutput;
  101200. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101201. protected _dumpPropertiesCode(): string;
  101202. serialize(): any;
  101203. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101204. }
  101205. }
  101206. declare module BABYLON {
  101207. /** @hidden */
  101208. export var reflectionFunction: {
  101209. name: string;
  101210. shader: string;
  101211. };
  101212. }
  101213. declare module BABYLON {
  101214. /**
  101215. * Base block used to read a reflection texture from a sampler
  101216. */
  101217. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  101218. /** @hidden */
  101219. _define3DName: string;
  101220. /** @hidden */
  101221. _defineCubicName: string;
  101222. /** @hidden */
  101223. _defineExplicitName: string;
  101224. /** @hidden */
  101225. _defineProjectionName: string;
  101226. /** @hidden */
  101227. _defineLocalCubicName: string;
  101228. /** @hidden */
  101229. _defineSphericalName: string;
  101230. /** @hidden */
  101231. _definePlanarName: string;
  101232. /** @hidden */
  101233. _defineEquirectangularName: string;
  101234. /** @hidden */
  101235. _defineMirroredEquirectangularFixedName: string;
  101236. /** @hidden */
  101237. _defineEquirectangularFixedName: string;
  101238. /** @hidden */
  101239. _defineSkyboxName: string;
  101240. /** @hidden */
  101241. _defineOppositeZ: string;
  101242. /** @hidden */
  101243. _cubeSamplerName: string;
  101244. /** @hidden */
  101245. _2DSamplerName: string;
  101246. protected _positionUVWName: string;
  101247. protected _directionWName: string;
  101248. protected _reflectionVectorName: string;
  101249. /** @hidden */
  101250. _reflectionCoordsName: string;
  101251. /** @hidden */
  101252. _reflectionMatrixName: string;
  101253. protected _reflectionColorName: string;
  101254. /**
  101255. * Gets or sets the texture associated with the node
  101256. */
  101257. texture: Nullable<BaseTexture>;
  101258. /**
  101259. * Create a new ReflectionTextureBaseBlock
  101260. * @param name defines the block name
  101261. */
  101262. constructor(name: string);
  101263. /**
  101264. * Gets the current class name
  101265. * @returns the class name
  101266. */
  101267. getClassName(): string;
  101268. /**
  101269. * Gets the world position input component
  101270. */
  101271. abstract get position(): NodeMaterialConnectionPoint;
  101272. /**
  101273. * Gets the world position input component
  101274. */
  101275. abstract get worldPosition(): NodeMaterialConnectionPoint;
  101276. /**
  101277. * Gets the world normal input component
  101278. */
  101279. abstract get worldNormal(): NodeMaterialConnectionPoint;
  101280. /**
  101281. * Gets the world input component
  101282. */
  101283. abstract get world(): NodeMaterialConnectionPoint;
  101284. /**
  101285. * Gets the camera (or eye) position component
  101286. */
  101287. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  101288. /**
  101289. * Gets the view input component
  101290. */
  101291. abstract get view(): NodeMaterialConnectionPoint;
  101292. protected _getTexture(): Nullable<BaseTexture>;
  101293. autoConfigure(material: NodeMaterial): void;
  101294. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  101295. isReady(): boolean;
  101296. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  101297. /**
  101298. * Gets the code to inject in the vertex shader
  101299. * @param state current state of the node material building
  101300. * @returns the shader code
  101301. */
  101302. handleVertexSide(state: NodeMaterialBuildState): string;
  101303. /**
  101304. * Handles the inits for the fragment code path
  101305. * @param state node material build state
  101306. */
  101307. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  101308. /**
  101309. * Generates the reflection coords code for the fragment code path
  101310. * @param worldNormalVarName name of the world normal variable
  101311. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  101312. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  101313. * @returns the shader code
  101314. */
  101315. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  101316. /**
  101317. * Generates the reflection color code for the fragment code path
  101318. * @param lodVarName name of the lod variable
  101319. * @param swizzleLookupTexture swizzle to use for the final color variable
  101320. * @returns the shader code
  101321. */
  101322. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  101323. /**
  101324. * Generates the code corresponding to the connected output points
  101325. * @param state node material build state
  101326. * @param varName name of the variable to output
  101327. * @returns the shader code
  101328. */
  101329. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  101330. protected _buildBlock(state: NodeMaterialBuildState): this;
  101331. protected _dumpPropertiesCode(): string;
  101332. serialize(): any;
  101333. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101334. }
  101335. }
  101336. declare module BABYLON {
  101337. /**
  101338. * Defines a connection point to be used for points with a custom object type
  101339. */
  101340. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  101341. private _blockType;
  101342. private _blockName;
  101343. private _nameForCheking?;
  101344. /**
  101345. * Creates a new connection point
  101346. * @param name defines the connection point name
  101347. * @param ownerBlock defines the block hosting this connection point
  101348. * @param direction defines the direction of the connection point
  101349. */
  101350. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  101351. /**
  101352. * Gets a number indicating if the current point can be connected to another point
  101353. * @param connectionPoint defines the other connection point
  101354. * @returns a number defining the compatibility state
  101355. */
  101356. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  101357. /**
  101358. * Creates a block suitable to be used as an input for this input point.
  101359. * If null is returned, a block based on the point type will be created.
  101360. * @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
  101361. */
  101362. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  101363. }
  101364. }
  101365. declare module BABYLON {
  101366. /**
  101367. * Enum defining the type of properties that can be edited in the property pages in the NME
  101368. */
  101369. export enum PropertyTypeForEdition {
  101370. /** property is a boolean */
  101371. Boolean = 0,
  101372. /** property is a float */
  101373. Float = 1,
  101374. /** property is a Vector2 */
  101375. Vector2 = 2,
  101376. /** property is a list of values */
  101377. List = 3
  101378. }
  101379. /**
  101380. * Interface that defines an option in a variable of type list
  101381. */
  101382. export interface IEditablePropertyListOption {
  101383. /** label of the option */
  101384. "label": string;
  101385. /** value of the option */
  101386. "value": number;
  101387. }
  101388. /**
  101389. * Interface that defines the options available for an editable property
  101390. */
  101391. export interface IEditablePropertyOption {
  101392. /** min value */
  101393. "min"?: number;
  101394. /** max value */
  101395. "max"?: number;
  101396. /** notifiers: indicates which actions to take when the property is changed */
  101397. "notifiers"?: {
  101398. /** the material should be rebuilt */
  101399. "rebuild"?: boolean;
  101400. /** the preview should be updated */
  101401. "update"?: boolean;
  101402. };
  101403. /** list of the options for a variable of type list */
  101404. "options"?: IEditablePropertyListOption[];
  101405. }
  101406. /**
  101407. * Interface that describes an editable property
  101408. */
  101409. export interface IPropertyDescriptionForEdition {
  101410. /** name of the property */
  101411. "propertyName": string;
  101412. /** display name of the property */
  101413. "displayName": string;
  101414. /** type of the property */
  101415. "type": PropertyTypeForEdition;
  101416. /** group of the property - all properties with the same group value will be displayed in a specific section */
  101417. "groupName": string;
  101418. /** options for the property */
  101419. "options": IEditablePropertyOption;
  101420. }
  101421. /**
  101422. * Decorator that flags a property in a node material block as being editable
  101423. */
  101424. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  101425. }
  101426. declare module BABYLON {
  101427. /**
  101428. * Block used to implement the refraction part of the sub surface module of the PBR material
  101429. */
  101430. export class RefractionBlock extends NodeMaterialBlock {
  101431. /** @hidden */
  101432. _define3DName: string;
  101433. /** @hidden */
  101434. _refractionMatrixName: string;
  101435. /** @hidden */
  101436. _defineLODRefractionAlpha: string;
  101437. /** @hidden */
  101438. _defineLinearSpecularRefraction: string;
  101439. /** @hidden */
  101440. _defineOppositeZ: string;
  101441. /** @hidden */
  101442. _cubeSamplerName: string;
  101443. /** @hidden */
  101444. _2DSamplerName: string;
  101445. /** @hidden */
  101446. _vRefractionMicrosurfaceInfosName: string;
  101447. /** @hidden */
  101448. _vRefractionInfosName: string;
  101449. private _scene;
  101450. /**
  101451. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  101452. * Materials half opaque for instance using refraction could benefit from this control.
  101453. */
  101454. linkRefractionWithTransparency: boolean;
  101455. /**
  101456. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  101457. */
  101458. invertRefractionY: boolean;
  101459. /**
  101460. * Gets or sets the texture associated with the node
  101461. */
  101462. texture: Nullable<BaseTexture>;
  101463. /**
  101464. * Create a new RefractionBlock
  101465. * @param name defines the block name
  101466. */
  101467. constructor(name: string);
  101468. /**
  101469. * Gets the current class name
  101470. * @returns the class name
  101471. */
  101472. getClassName(): string;
  101473. /**
  101474. * Gets the intensity input component
  101475. */
  101476. get intensity(): NodeMaterialConnectionPoint;
  101477. /**
  101478. * Gets the index of refraction input component
  101479. */
  101480. get indexOfRefraction(): NodeMaterialConnectionPoint;
  101481. /**
  101482. * Gets the tint at distance input component
  101483. */
  101484. get tintAtDistance(): NodeMaterialConnectionPoint;
  101485. /**
  101486. * Gets the view input component
  101487. */
  101488. get view(): NodeMaterialConnectionPoint;
  101489. /**
  101490. * Gets the refraction object output component
  101491. */
  101492. get refraction(): NodeMaterialConnectionPoint;
  101493. /**
  101494. * Returns true if the block has a texture
  101495. */
  101496. get hasTexture(): boolean;
  101497. protected _getTexture(): Nullable<BaseTexture>;
  101498. autoConfigure(material: NodeMaterial): void;
  101499. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  101500. isReady(): boolean;
  101501. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  101502. /**
  101503. * Gets the main code of the block (fragment side)
  101504. * @param state current state of the node material building
  101505. * @returns the shader code
  101506. */
  101507. getCode(state: NodeMaterialBuildState): string;
  101508. protected _buildBlock(state: NodeMaterialBuildState): this;
  101509. protected _dumpPropertiesCode(): string;
  101510. serialize(): any;
  101511. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101512. }
  101513. }
  101514. declare module BABYLON {
  101515. /**
  101516. * Base block used as input for post process
  101517. */
  101518. export class CurrentScreenBlock extends NodeMaterialBlock {
  101519. private _samplerName;
  101520. private _linearDefineName;
  101521. private _gammaDefineName;
  101522. private _mainUVName;
  101523. private _tempTextureRead;
  101524. /**
  101525. * Gets or sets the texture associated with the node
  101526. */
  101527. texture: Nullable<BaseTexture>;
  101528. /**
  101529. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  101530. */
  101531. convertToGammaSpace: boolean;
  101532. /**
  101533. * Gets or sets a boolean indicating if content needs to be converted to linear space
  101534. */
  101535. convertToLinearSpace: boolean;
  101536. /**
  101537. * Create a new CurrentScreenBlock
  101538. * @param name defines the block name
  101539. */
  101540. constructor(name: string);
  101541. /**
  101542. * Gets the current class name
  101543. * @returns the class name
  101544. */
  101545. getClassName(): string;
  101546. /**
  101547. * Gets the uv input component
  101548. */
  101549. get uv(): NodeMaterialConnectionPoint;
  101550. /**
  101551. * Gets the rgba output component
  101552. */
  101553. get rgba(): NodeMaterialConnectionPoint;
  101554. /**
  101555. * Gets the rgb output component
  101556. */
  101557. get rgb(): NodeMaterialConnectionPoint;
  101558. /**
  101559. * Gets the r output component
  101560. */
  101561. get r(): NodeMaterialConnectionPoint;
  101562. /**
  101563. * Gets the g output component
  101564. */
  101565. get g(): NodeMaterialConnectionPoint;
  101566. /**
  101567. * Gets the b output component
  101568. */
  101569. get b(): NodeMaterialConnectionPoint;
  101570. /**
  101571. * Gets the a output component
  101572. */
  101573. get a(): NodeMaterialConnectionPoint;
  101574. /**
  101575. * Initialize the block and prepare the context for build
  101576. * @param state defines the state that will be used for the build
  101577. */
  101578. initialize(state: NodeMaterialBuildState): void;
  101579. get target(): NodeMaterialBlockTargets;
  101580. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  101581. isReady(): boolean;
  101582. private _injectVertexCode;
  101583. private _writeTextureRead;
  101584. private _writeOutput;
  101585. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101586. serialize(): any;
  101587. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101588. }
  101589. }
  101590. declare module BABYLON {
  101591. /**
  101592. * Base block used for the particle texture
  101593. */
  101594. export class ParticleTextureBlock extends NodeMaterialBlock {
  101595. private _samplerName;
  101596. private _linearDefineName;
  101597. private _gammaDefineName;
  101598. private _tempTextureRead;
  101599. /**
  101600. * Gets or sets the texture associated with the node
  101601. */
  101602. texture: Nullable<BaseTexture>;
  101603. /**
  101604. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  101605. */
  101606. convertToGammaSpace: boolean;
  101607. /**
  101608. * Gets or sets a boolean indicating if content needs to be converted to linear space
  101609. */
  101610. convertToLinearSpace: boolean;
  101611. /**
  101612. * Create a new ParticleTextureBlock
  101613. * @param name defines the block name
  101614. */
  101615. constructor(name: string);
  101616. /**
  101617. * Gets the current class name
  101618. * @returns the class name
  101619. */
  101620. getClassName(): string;
  101621. /**
  101622. * Gets the uv input component
  101623. */
  101624. get uv(): NodeMaterialConnectionPoint;
  101625. /**
  101626. * Gets the rgba output component
  101627. */
  101628. get rgba(): NodeMaterialConnectionPoint;
  101629. /**
  101630. * Gets the rgb output component
  101631. */
  101632. get rgb(): NodeMaterialConnectionPoint;
  101633. /**
  101634. * Gets the r output component
  101635. */
  101636. get r(): NodeMaterialConnectionPoint;
  101637. /**
  101638. * Gets the g output component
  101639. */
  101640. get g(): NodeMaterialConnectionPoint;
  101641. /**
  101642. * Gets the b output component
  101643. */
  101644. get b(): NodeMaterialConnectionPoint;
  101645. /**
  101646. * Gets the a output component
  101647. */
  101648. get a(): NodeMaterialConnectionPoint;
  101649. /**
  101650. * Initialize the block and prepare the context for build
  101651. * @param state defines the state that will be used for the build
  101652. */
  101653. initialize(state: NodeMaterialBuildState): void;
  101654. autoConfigure(material: NodeMaterial): void;
  101655. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  101656. isReady(): boolean;
  101657. private _writeOutput;
  101658. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101659. serialize(): any;
  101660. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101661. }
  101662. }
  101663. declare module BABYLON {
  101664. /**
  101665. * Class used to store shared data between 2 NodeMaterialBuildState
  101666. */
  101667. export class NodeMaterialBuildStateSharedData {
  101668. /**
  101669. * Gets the list of emitted varyings
  101670. */
  101671. temps: string[];
  101672. /**
  101673. * Gets the list of emitted varyings
  101674. */
  101675. varyings: string[];
  101676. /**
  101677. * Gets the varying declaration string
  101678. */
  101679. varyingDeclaration: string;
  101680. /**
  101681. * Input blocks
  101682. */
  101683. inputBlocks: InputBlock[];
  101684. /**
  101685. * Input blocks
  101686. */
  101687. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  101688. /**
  101689. * Bindable blocks (Blocks that need to set data to the effect)
  101690. */
  101691. bindableBlocks: NodeMaterialBlock[];
  101692. /**
  101693. * List of blocks that can provide a compilation fallback
  101694. */
  101695. blocksWithFallbacks: NodeMaterialBlock[];
  101696. /**
  101697. * List of blocks that can provide a define update
  101698. */
  101699. blocksWithDefines: NodeMaterialBlock[];
  101700. /**
  101701. * List of blocks that can provide a repeatable content
  101702. */
  101703. repeatableContentBlocks: NodeMaterialBlock[];
  101704. /**
  101705. * List of blocks that can provide a dynamic list of uniforms
  101706. */
  101707. dynamicUniformBlocks: NodeMaterialBlock[];
  101708. /**
  101709. * List of blocks that can block the isReady function for the material
  101710. */
  101711. blockingBlocks: NodeMaterialBlock[];
  101712. /**
  101713. * Gets the list of animated inputs
  101714. */
  101715. animatedInputs: InputBlock[];
  101716. /**
  101717. * Build Id used to avoid multiple recompilations
  101718. */
  101719. buildId: number;
  101720. /** List of emitted variables */
  101721. variableNames: {
  101722. [key: string]: number;
  101723. };
  101724. /** List of emitted defines */
  101725. defineNames: {
  101726. [key: string]: number;
  101727. };
  101728. /** Should emit comments? */
  101729. emitComments: boolean;
  101730. /** Emit build activity */
  101731. verbose: boolean;
  101732. /** Gets or sets the hosting scene */
  101733. scene: Scene;
  101734. /**
  101735. * Gets the compilation hints emitted at compilation time
  101736. */
  101737. hints: {
  101738. needWorldViewMatrix: boolean;
  101739. needWorldViewProjectionMatrix: boolean;
  101740. needAlphaBlending: boolean;
  101741. needAlphaTesting: boolean;
  101742. };
  101743. /**
  101744. * List of compilation checks
  101745. */
  101746. checks: {
  101747. emitVertex: boolean;
  101748. emitFragment: boolean;
  101749. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  101750. };
  101751. /**
  101752. * Is vertex program allowed to be empty?
  101753. */
  101754. allowEmptyVertexProgram: boolean;
  101755. /** Creates a new shared data */
  101756. constructor();
  101757. /**
  101758. * Emits console errors and exceptions if there is a failing check
  101759. */
  101760. emitErrors(): void;
  101761. }
  101762. }
  101763. declare module BABYLON {
  101764. /**
  101765. * Class used to store node based material build state
  101766. */
  101767. export class NodeMaterialBuildState {
  101768. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  101769. supportUniformBuffers: boolean;
  101770. /**
  101771. * Gets the list of emitted attributes
  101772. */
  101773. attributes: string[];
  101774. /**
  101775. * Gets the list of emitted uniforms
  101776. */
  101777. uniforms: string[];
  101778. /**
  101779. * Gets the list of emitted constants
  101780. */
  101781. constants: string[];
  101782. /**
  101783. * Gets the list of emitted samplers
  101784. */
  101785. samplers: string[];
  101786. /**
  101787. * Gets the list of emitted functions
  101788. */
  101789. functions: {
  101790. [key: string]: string;
  101791. };
  101792. /**
  101793. * Gets the list of emitted extensions
  101794. */
  101795. extensions: {
  101796. [key: string]: string;
  101797. };
  101798. /**
  101799. * Gets the target of the compilation state
  101800. */
  101801. target: NodeMaterialBlockTargets;
  101802. /**
  101803. * Gets the list of emitted counters
  101804. */
  101805. counters: {
  101806. [key: string]: number;
  101807. };
  101808. /**
  101809. * Shared data between multiple NodeMaterialBuildState instances
  101810. */
  101811. sharedData: NodeMaterialBuildStateSharedData;
  101812. /** @hidden */
  101813. _vertexState: NodeMaterialBuildState;
  101814. /** @hidden */
  101815. _attributeDeclaration: string;
  101816. /** @hidden */
  101817. _uniformDeclaration: string;
  101818. /** @hidden */
  101819. _constantDeclaration: string;
  101820. /** @hidden */
  101821. _samplerDeclaration: string;
  101822. /** @hidden */
  101823. _varyingTransfer: string;
  101824. /** @hidden */
  101825. _injectAtEnd: string;
  101826. private _repeatableContentAnchorIndex;
  101827. /** @hidden */
  101828. _builtCompilationString: string;
  101829. /**
  101830. * Gets the emitted compilation strings
  101831. */
  101832. compilationString: string;
  101833. /**
  101834. * Finalize the compilation strings
  101835. * @param state defines the current compilation state
  101836. */
  101837. finalize(state: NodeMaterialBuildState): void;
  101838. /** @hidden */
  101839. get _repeatableContentAnchor(): string;
  101840. /** @hidden */
  101841. _getFreeVariableName(prefix: string): string;
  101842. /** @hidden */
  101843. _getFreeDefineName(prefix: string): string;
  101844. /** @hidden */
  101845. _excludeVariableName(name: string): void;
  101846. /** @hidden */
  101847. _emit2DSampler(name: string): void;
  101848. /** @hidden */
  101849. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  101850. /** @hidden */
  101851. _emitExtension(name: string, extension: string, define?: string): void;
  101852. /** @hidden */
  101853. _emitFunction(name: string, code: string, comments: string): void;
  101854. /** @hidden */
  101855. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  101856. replaceStrings?: {
  101857. search: RegExp;
  101858. replace: string;
  101859. }[];
  101860. repeatKey?: string;
  101861. }): string;
  101862. /** @hidden */
  101863. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  101864. repeatKey?: string;
  101865. removeAttributes?: boolean;
  101866. removeUniforms?: boolean;
  101867. removeVaryings?: boolean;
  101868. removeIfDef?: boolean;
  101869. replaceStrings?: {
  101870. search: RegExp;
  101871. replace: string;
  101872. }[];
  101873. }, storeKey?: string): void;
  101874. /** @hidden */
  101875. _registerTempVariable(name: string): boolean;
  101876. /** @hidden */
  101877. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  101878. /** @hidden */
  101879. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  101880. /** @hidden */
  101881. _emitFloat(value: number): string;
  101882. }
  101883. }
  101884. declare module BABYLON {
  101885. /**
  101886. * Helper class used to generate session unique ID
  101887. */
  101888. export class UniqueIdGenerator {
  101889. private static _UniqueIdCounter;
  101890. /**
  101891. * Gets an unique (relatively to the current scene) Id
  101892. */
  101893. static get UniqueId(): number;
  101894. }
  101895. }
  101896. declare module BABYLON {
  101897. /**
  101898. * Defines a block that can be used inside a node based material
  101899. */
  101900. export class NodeMaterialBlock {
  101901. private _buildId;
  101902. private _buildTarget;
  101903. private _target;
  101904. private _isFinalMerger;
  101905. private _isInput;
  101906. private _name;
  101907. protected _isUnique: boolean;
  101908. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  101909. inputsAreExclusive: boolean;
  101910. /** @hidden */
  101911. _codeVariableName: string;
  101912. /** @hidden */
  101913. _inputs: NodeMaterialConnectionPoint[];
  101914. /** @hidden */
  101915. _outputs: NodeMaterialConnectionPoint[];
  101916. /** @hidden */
  101917. _preparationId: number;
  101918. /**
  101919. * Gets the name of the block
  101920. */
  101921. get name(): string;
  101922. /**
  101923. * Sets the name of the block. Will check if the name is valid.
  101924. */
  101925. set name(newName: string);
  101926. /**
  101927. * Gets or sets the unique id of the node
  101928. */
  101929. uniqueId: number;
  101930. /**
  101931. * Gets or sets the comments associated with this block
  101932. */
  101933. comments: string;
  101934. /**
  101935. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  101936. */
  101937. get isUnique(): boolean;
  101938. /**
  101939. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  101940. */
  101941. get isFinalMerger(): boolean;
  101942. /**
  101943. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  101944. */
  101945. get isInput(): boolean;
  101946. /**
  101947. * Gets or sets the build Id
  101948. */
  101949. get buildId(): number;
  101950. set buildId(value: number);
  101951. /**
  101952. * Gets or sets the target of the block
  101953. */
  101954. get target(): NodeMaterialBlockTargets;
  101955. set target(value: NodeMaterialBlockTargets);
  101956. /**
  101957. * Gets the list of input points
  101958. */
  101959. get inputs(): NodeMaterialConnectionPoint[];
  101960. /** Gets the list of output points */
  101961. get outputs(): NodeMaterialConnectionPoint[];
  101962. /**
  101963. * Find an input by its name
  101964. * @param name defines the name of the input to look for
  101965. * @returns the input or null if not found
  101966. */
  101967. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  101968. /**
  101969. * Find an output by its name
  101970. * @param name defines the name of the outputto look for
  101971. * @returns the output or null if not found
  101972. */
  101973. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  101974. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  101975. visibleInInspector: boolean;
  101976. /**
  101977. * Creates a new NodeMaterialBlock
  101978. * @param name defines the block name
  101979. * @param target defines the target of that block (Vertex by default)
  101980. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  101981. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  101982. */
  101983. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  101984. /**
  101985. * Initialize the block and prepare the context for build
  101986. * @param state defines the state that will be used for the build
  101987. */
  101988. initialize(state: NodeMaterialBuildState): void;
  101989. /**
  101990. * Bind data to effect. Will only be called for blocks with isBindable === true
  101991. * @param effect defines the effect to bind data to
  101992. * @param nodeMaterial defines the hosting NodeMaterial
  101993. * @param mesh defines the mesh that will be rendered
  101994. * @param subMesh defines the submesh that will be rendered
  101995. */
  101996. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  101997. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  101998. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  101999. protected _writeFloat(value: number): string;
  102000. /**
  102001. * Gets the current class name e.g. "NodeMaterialBlock"
  102002. * @returns the class name
  102003. */
  102004. getClassName(): string;
  102005. /**
  102006. * Register a new input. Must be called inside a block constructor
  102007. * @param name defines the connection point name
  102008. * @param type defines the connection point type
  102009. * @param isOptional defines a boolean indicating that this input can be omitted
  102010. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  102011. * @param point an already created connection point. If not provided, create a new one
  102012. * @returns the current block
  102013. */
  102014. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  102015. /**
  102016. * Register a new output. Must be called inside a block constructor
  102017. * @param name defines the connection point name
  102018. * @param type defines the connection point type
  102019. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  102020. * @param point an already created connection point. If not provided, create a new one
  102021. * @returns the current block
  102022. */
  102023. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  102024. /**
  102025. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  102026. * @param forOutput defines an optional connection point to check compatibility with
  102027. * @returns the first available input or null
  102028. */
  102029. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  102030. /**
  102031. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  102032. * @param forBlock defines an optional block to check compatibility with
  102033. * @returns the first available input or null
  102034. */
  102035. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  102036. /**
  102037. * Gets the sibling of the given output
  102038. * @param current defines the current output
  102039. * @returns the next output in the list or null
  102040. */
  102041. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  102042. /**
  102043. * Connect current block with another block
  102044. * @param other defines the block to connect with
  102045. * @param options define the various options to help pick the right connections
  102046. * @returns the current block
  102047. */
  102048. connectTo(other: NodeMaterialBlock, options?: {
  102049. input?: string;
  102050. output?: string;
  102051. outputSwizzle?: string;
  102052. }): this | undefined;
  102053. protected _buildBlock(state: NodeMaterialBuildState): void;
  102054. /**
  102055. * Add uniforms, samplers and uniform buffers at compilation time
  102056. * @param state defines the state to update
  102057. * @param nodeMaterial defines the node material requesting the update
  102058. * @param defines defines the material defines to update
  102059. * @param uniformBuffers defines the list of uniform buffer names
  102060. */
  102061. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  102062. /**
  102063. * Add potential fallbacks if shader compilation fails
  102064. * @param mesh defines the mesh to be rendered
  102065. * @param fallbacks defines the current prioritized list of fallbacks
  102066. */
  102067. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  102068. /**
  102069. * Initialize defines for shader compilation
  102070. * @param mesh defines the mesh to be rendered
  102071. * @param nodeMaterial defines the node material requesting the update
  102072. * @param defines defines the material defines to update
  102073. * @param useInstances specifies that instances should be used
  102074. */
  102075. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  102076. /**
  102077. * Update defines for shader compilation
  102078. * @param mesh defines the mesh to be rendered
  102079. * @param nodeMaterial defines the node material requesting the update
  102080. * @param defines defines the material defines to update
  102081. * @param useInstances specifies that instances should be used
  102082. * @param subMesh defines which submesh to render
  102083. */
  102084. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  102085. /**
  102086. * Lets the block try to connect some inputs automatically
  102087. * @param material defines the hosting NodeMaterial
  102088. */
  102089. autoConfigure(material: NodeMaterial): void;
  102090. /**
  102091. * Function called when a block is declared as repeatable content generator
  102092. * @param vertexShaderState defines the current compilation state for the vertex shader
  102093. * @param fragmentShaderState defines the current compilation state for the fragment shader
  102094. * @param mesh defines the mesh to be rendered
  102095. * @param defines defines the material defines to update
  102096. */
  102097. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  102098. /**
  102099. * Checks if the block is ready
  102100. * @param mesh defines the mesh to be rendered
  102101. * @param nodeMaterial defines the node material requesting the update
  102102. * @param defines defines the material defines to update
  102103. * @param useInstances specifies that instances should be used
  102104. * @returns true if the block is ready
  102105. */
  102106. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  102107. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  102108. private _processBuild;
  102109. /**
  102110. * Validates the new name for the block node.
  102111. * @param newName the new name to be given to the node.
  102112. * @returns false if the name is a reserve word, else true.
  102113. */
  102114. validateBlockName(newName: string): boolean;
  102115. /**
  102116. * Compile the current node and generate the shader code
  102117. * @param state defines the current compilation state (uniforms, samplers, current string)
  102118. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  102119. * @returns true if already built
  102120. */
  102121. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  102122. protected _inputRename(name: string): string;
  102123. protected _outputRename(name: string): string;
  102124. protected _dumpPropertiesCode(): string;
  102125. /** @hidden */
  102126. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  102127. /** @hidden */
  102128. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  102129. /**
  102130. * Clone the current block to a new identical block
  102131. * @param scene defines the hosting scene
  102132. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102133. * @returns a copy of the current block
  102134. */
  102135. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  102136. /**
  102137. * Serializes this block in a JSON representation
  102138. * @returns the serialized block object
  102139. */
  102140. serialize(): any;
  102141. /** @hidden */
  102142. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  102143. private _deserializePortDisplayNamesAndExposedOnFrame;
  102144. /**
  102145. * Release resources
  102146. */
  102147. dispose(): void;
  102148. }
  102149. }
  102150. declare module BABYLON {
  102151. /**
  102152. * Base class of materials working in push mode in babylon JS
  102153. * @hidden
  102154. */
  102155. export class PushMaterial extends Material {
  102156. protected _activeEffect: Effect;
  102157. protected _normalMatrix: Matrix;
  102158. constructor(name: string, scene: Scene);
  102159. getEffect(): Effect;
  102160. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  102161. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  102162. /**
  102163. * Binds the given world matrix to the active effect
  102164. *
  102165. * @param world the matrix to bind
  102166. */
  102167. bindOnlyWorldMatrix(world: Matrix): void;
  102168. /**
  102169. * Binds the given normal matrix to the active effect
  102170. *
  102171. * @param normalMatrix the matrix to bind
  102172. */
  102173. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  102174. bind(world: Matrix, mesh?: Mesh): void;
  102175. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  102176. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  102177. }
  102178. }
  102179. declare module BABYLON {
  102180. /**
  102181. * Root class for all node material optimizers
  102182. */
  102183. export class NodeMaterialOptimizer {
  102184. /**
  102185. * Function used to optimize a NodeMaterial graph
  102186. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  102187. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  102188. */
  102189. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  102190. }
  102191. }
  102192. declare module BABYLON {
  102193. /**
  102194. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  102195. */
  102196. export class TransformBlock extends NodeMaterialBlock {
  102197. /**
  102198. * Defines the value to use to complement W value to transform it to a Vector4
  102199. */
  102200. complementW: number;
  102201. /**
  102202. * Defines the value to use to complement z value to transform it to a Vector4
  102203. */
  102204. complementZ: number;
  102205. /**
  102206. * Creates a new TransformBlock
  102207. * @param name defines the block name
  102208. */
  102209. constructor(name: string);
  102210. /**
  102211. * Gets the current class name
  102212. * @returns the class name
  102213. */
  102214. getClassName(): string;
  102215. /**
  102216. * Gets the vector input
  102217. */
  102218. get vector(): NodeMaterialConnectionPoint;
  102219. /**
  102220. * Gets the output component
  102221. */
  102222. get output(): NodeMaterialConnectionPoint;
  102223. /**
  102224. * Gets the xyz output component
  102225. */
  102226. get xyz(): NodeMaterialConnectionPoint;
  102227. /**
  102228. * Gets the matrix transform input
  102229. */
  102230. get transform(): NodeMaterialConnectionPoint;
  102231. protected _buildBlock(state: NodeMaterialBuildState): this;
  102232. /**
  102233. * Update defines for shader compilation
  102234. * @param mesh defines the mesh to be rendered
  102235. * @param nodeMaterial defines the node material requesting the update
  102236. * @param defines defines the material defines to update
  102237. * @param useInstances specifies that instances should be used
  102238. * @param subMesh defines which submesh to render
  102239. */
  102240. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  102241. serialize(): any;
  102242. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  102243. protected _dumpPropertiesCode(): string;
  102244. }
  102245. }
  102246. declare module BABYLON {
  102247. /**
  102248. * Block used to output the vertex position
  102249. */
  102250. export class VertexOutputBlock extends NodeMaterialBlock {
  102251. /**
  102252. * Creates a new VertexOutputBlock
  102253. * @param name defines the block name
  102254. */
  102255. constructor(name: string);
  102256. /**
  102257. * Gets the current class name
  102258. * @returns the class name
  102259. */
  102260. getClassName(): string;
  102261. /**
  102262. * Gets the vector input component
  102263. */
  102264. get vector(): NodeMaterialConnectionPoint;
  102265. protected _buildBlock(state: NodeMaterialBuildState): this;
  102266. }
  102267. }
  102268. declare module BABYLON {
  102269. /**
  102270. * Block used to output the final color
  102271. */
  102272. export class FragmentOutputBlock extends NodeMaterialBlock {
  102273. /**
  102274. * Create a new FragmentOutputBlock
  102275. * @param name defines the block name
  102276. */
  102277. constructor(name: string);
  102278. /**
  102279. * Gets the current class name
  102280. * @returns the class name
  102281. */
  102282. getClassName(): string;
  102283. /**
  102284. * Gets the rgba input component
  102285. */
  102286. get rgba(): NodeMaterialConnectionPoint;
  102287. /**
  102288. * Gets the rgb input component
  102289. */
  102290. get rgb(): NodeMaterialConnectionPoint;
  102291. /**
  102292. * Gets the a input component
  102293. */
  102294. get a(): NodeMaterialConnectionPoint;
  102295. protected _buildBlock(state: NodeMaterialBuildState): this;
  102296. }
  102297. }
  102298. declare module BABYLON {
  102299. /**
  102300. * Block used for the particle ramp gradient section
  102301. */
  102302. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  102303. /**
  102304. * Create a new ParticleRampGradientBlock
  102305. * @param name defines the block name
  102306. */
  102307. constructor(name: string);
  102308. /**
  102309. * Gets the current class name
  102310. * @returns the class name
  102311. */
  102312. getClassName(): string;
  102313. /**
  102314. * Gets the color input component
  102315. */
  102316. get color(): NodeMaterialConnectionPoint;
  102317. /**
  102318. * Gets the rampColor output component
  102319. */
  102320. get rampColor(): NodeMaterialConnectionPoint;
  102321. /**
  102322. * Initialize the block and prepare the context for build
  102323. * @param state defines the state that will be used for the build
  102324. */
  102325. initialize(state: NodeMaterialBuildState): void;
  102326. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  102327. }
  102328. }
  102329. declare module BABYLON {
  102330. /**
  102331. * Block used for the particle blend multiply section
  102332. */
  102333. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  102334. /**
  102335. * Create a new ParticleBlendMultiplyBlock
  102336. * @param name defines the block name
  102337. */
  102338. constructor(name: string);
  102339. /**
  102340. * Gets the current class name
  102341. * @returns the class name
  102342. */
  102343. getClassName(): string;
  102344. /**
  102345. * Gets the color input component
  102346. */
  102347. get color(): NodeMaterialConnectionPoint;
  102348. /**
  102349. * Gets the alphaTexture input component
  102350. */
  102351. get alphaTexture(): NodeMaterialConnectionPoint;
  102352. /**
  102353. * Gets the alphaColor input component
  102354. */
  102355. get alphaColor(): NodeMaterialConnectionPoint;
  102356. /**
  102357. * Gets the blendColor output component
  102358. */
  102359. get blendColor(): NodeMaterialConnectionPoint;
  102360. /**
  102361. * Initialize the block and prepare the context for build
  102362. * @param state defines the state that will be used for the build
  102363. */
  102364. initialize(state: NodeMaterialBuildState): void;
  102365. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  102366. }
  102367. }
  102368. declare module BABYLON {
  102369. /**
  102370. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  102371. */
  102372. export class VectorMergerBlock extends NodeMaterialBlock {
  102373. /**
  102374. * Create a new VectorMergerBlock
  102375. * @param name defines the block name
  102376. */
  102377. constructor(name: string);
  102378. /**
  102379. * Gets the current class name
  102380. * @returns the class name
  102381. */
  102382. getClassName(): string;
  102383. /**
  102384. * Gets the xyz component (input)
  102385. */
  102386. get xyzIn(): NodeMaterialConnectionPoint;
  102387. /**
  102388. * Gets the xy component (input)
  102389. */
  102390. get xyIn(): NodeMaterialConnectionPoint;
  102391. /**
  102392. * Gets the x component (input)
  102393. */
  102394. get x(): NodeMaterialConnectionPoint;
  102395. /**
  102396. * Gets the y component (input)
  102397. */
  102398. get y(): NodeMaterialConnectionPoint;
  102399. /**
  102400. * Gets the z component (input)
  102401. */
  102402. get z(): NodeMaterialConnectionPoint;
  102403. /**
  102404. * Gets the w component (input)
  102405. */
  102406. get w(): NodeMaterialConnectionPoint;
  102407. /**
  102408. * Gets the xyzw component (output)
  102409. */
  102410. get xyzw(): NodeMaterialConnectionPoint;
  102411. /**
  102412. * Gets the xyz component (output)
  102413. */
  102414. get xyzOut(): NodeMaterialConnectionPoint;
  102415. /**
  102416. * Gets the xy component (output)
  102417. */
  102418. get xyOut(): NodeMaterialConnectionPoint;
  102419. /**
  102420. * Gets the xy component (output)
  102421. * @deprecated Please use xyOut instead.
  102422. */
  102423. get xy(): NodeMaterialConnectionPoint;
  102424. /**
  102425. * Gets the xyz component (output)
  102426. * @deprecated Please use xyzOut instead.
  102427. */
  102428. get xyz(): NodeMaterialConnectionPoint;
  102429. protected _buildBlock(state: NodeMaterialBuildState): this;
  102430. }
  102431. }
  102432. declare module BABYLON {
  102433. /**
  102434. * Block used to remap a float from a range to a new one
  102435. */
  102436. export class RemapBlock extends NodeMaterialBlock {
  102437. /**
  102438. * Gets or sets the source range
  102439. */
  102440. sourceRange: Vector2;
  102441. /**
  102442. * Gets or sets the target range
  102443. */
  102444. targetRange: Vector2;
  102445. /**
  102446. * Creates a new RemapBlock
  102447. * @param name defines the block name
  102448. */
  102449. constructor(name: string);
  102450. /**
  102451. * Gets the current class name
  102452. * @returns the class name
  102453. */
  102454. getClassName(): string;
  102455. /**
  102456. * Gets the input component
  102457. */
  102458. get input(): NodeMaterialConnectionPoint;
  102459. /**
  102460. * Gets the source min input component
  102461. */
  102462. get sourceMin(): NodeMaterialConnectionPoint;
  102463. /**
  102464. * Gets the source max input component
  102465. */
  102466. get sourceMax(): NodeMaterialConnectionPoint;
  102467. /**
  102468. * Gets the target min input component
  102469. */
  102470. get targetMin(): NodeMaterialConnectionPoint;
  102471. /**
  102472. * Gets the target max input component
  102473. */
  102474. get targetMax(): NodeMaterialConnectionPoint;
  102475. /**
  102476. * Gets the output component
  102477. */
  102478. get output(): NodeMaterialConnectionPoint;
  102479. protected _buildBlock(state: NodeMaterialBuildState): this;
  102480. protected _dumpPropertiesCode(): string;
  102481. serialize(): any;
  102482. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  102483. }
  102484. }
  102485. declare module BABYLON {
  102486. /**
  102487. * Block used to multiply 2 values
  102488. */
  102489. export class MultiplyBlock extends NodeMaterialBlock {
  102490. /**
  102491. * Creates a new MultiplyBlock
  102492. * @param name defines the block name
  102493. */
  102494. constructor(name: string);
  102495. /**
  102496. * Gets the current class name
  102497. * @returns the class name
  102498. */
  102499. getClassName(): string;
  102500. /**
  102501. * Gets the left operand input component
  102502. */
  102503. get left(): NodeMaterialConnectionPoint;
  102504. /**
  102505. * Gets the right operand input component
  102506. */
  102507. get right(): NodeMaterialConnectionPoint;
  102508. /**
  102509. * Gets the output component
  102510. */
  102511. get output(): NodeMaterialConnectionPoint;
  102512. protected _buildBlock(state: NodeMaterialBuildState): this;
  102513. }
  102514. }
  102515. declare module BABYLON {
  102516. /**
  102517. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  102518. */
  102519. export class ColorSplitterBlock extends NodeMaterialBlock {
  102520. /**
  102521. * Create a new ColorSplitterBlock
  102522. * @param name defines the block name
  102523. */
  102524. constructor(name: string);
  102525. /**
  102526. * Gets the current class name
  102527. * @returns the class name
  102528. */
  102529. getClassName(): string;
  102530. /**
  102531. * Gets the rgba component (input)
  102532. */
  102533. get rgba(): NodeMaterialConnectionPoint;
  102534. /**
  102535. * Gets the rgb component (input)
  102536. */
  102537. get rgbIn(): NodeMaterialConnectionPoint;
  102538. /**
  102539. * Gets the rgb component (output)
  102540. */
  102541. get rgbOut(): NodeMaterialConnectionPoint;
  102542. /**
  102543. * Gets the r component (output)
  102544. */
  102545. get r(): NodeMaterialConnectionPoint;
  102546. /**
  102547. * Gets the g component (output)
  102548. */
  102549. get g(): NodeMaterialConnectionPoint;
  102550. /**
  102551. * Gets the b component (output)
  102552. */
  102553. get b(): NodeMaterialConnectionPoint;
  102554. /**
  102555. * Gets the a component (output)
  102556. */
  102557. get a(): NodeMaterialConnectionPoint;
  102558. protected _inputRename(name: string): string;
  102559. protected _outputRename(name: string): string;
  102560. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  102561. }
  102562. }
  102563. declare module BABYLON {
  102564. /**
  102565. * Operations supported by the Trigonometry block
  102566. */
  102567. export enum TrigonometryBlockOperations {
  102568. /** Cos */
  102569. Cos = 0,
  102570. /** Sin */
  102571. Sin = 1,
  102572. /** Abs */
  102573. Abs = 2,
  102574. /** Exp */
  102575. Exp = 3,
  102576. /** Exp2 */
  102577. Exp2 = 4,
  102578. /** Round */
  102579. Round = 5,
  102580. /** Floor */
  102581. Floor = 6,
  102582. /** Ceiling */
  102583. Ceiling = 7,
  102584. /** Square root */
  102585. Sqrt = 8,
  102586. /** Log */
  102587. Log = 9,
  102588. /** Tangent */
  102589. Tan = 10,
  102590. /** Arc tangent */
  102591. ArcTan = 11,
  102592. /** Arc cosinus */
  102593. ArcCos = 12,
  102594. /** Arc sinus */
  102595. ArcSin = 13,
  102596. /** Fraction */
  102597. Fract = 14,
  102598. /** Sign */
  102599. Sign = 15,
  102600. /** To radians (from degrees) */
  102601. Radians = 16,
  102602. /** To degrees (from radians) */
  102603. Degrees = 17
  102604. }
  102605. /**
  102606. * Block used to apply trigonometry operation to floats
  102607. */
  102608. export class TrigonometryBlock extends NodeMaterialBlock {
  102609. /**
  102610. * Gets or sets the operation applied by the block
  102611. */
  102612. operation: TrigonometryBlockOperations;
  102613. /**
  102614. * Creates a new TrigonometryBlock
  102615. * @param name defines the block name
  102616. */
  102617. constructor(name: string);
  102618. /**
  102619. * Gets the current class name
  102620. * @returns the class name
  102621. */
  102622. getClassName(): string;
  102623. /**
  102624. * Gets the input component
  102625. */
  102626. get input(): NodeMaterialConnectionPoint;
  102627. /**
  102628. * Gets the output component
  102629. */
  102630. get output(): NodeMaterialConnectionPoint;
  102631. protected _buildBlock(state: NodeMaterialBuildState): this;
  102632. serialize(): any;
  102633. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  102634. protected _dumpPropertiesCode(): string;
  102635. }
  102636. }
  102637. declare module BABYLON {
  102638. /**
  102639. * Interface used to configure the node material editor
  102640. */
  102641. export interface INodeMaterialEditorOptions {
  102642. /** Define the URl to load node editor script */
  102643. editorURL?: string;
  102644. }
  102645. /** @hidden */
  102646. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  102647. NORMAL: boolean;
  102648. TANGENT: boolean;
  102649. UV1: boolean;
  102650. /** BONES */
  102651. NUM_BONE_INFLUENCERS: number;
  102652. BonesPerMesh: number;
  102653. BONETEXTURE: boolean;
  102654. /** MORPH TARGETS */
  102655. MORPHTARGETS: boolean;
  102656. MORPHTARGETS_NORMAL: boolean;
  102657. MORPHTARGETS_TANGENT: boolean;
  102658. MORPHTARGETS_UV: boolean;
  102659. NUM_MORPH_INFLUENCERS: number;
  102660. /** IMAGE PROCESSING */
  102661. IMAGEPROCESSING: boolean;
  102662. VIGNETTE: boolean;
  102663. VIGNETTEBLENDMODEMULTIPLY: boolean;
  102664. VIGNETTEBLENDMODEOPAQUE: boolean;
  102665. TONEMAPPING: boolean;
  102666. TONEMAPPING_ACES: boolean;
  102667. CONTRAST: boolean;
  102668. EXPOSURE: boolean;
  102669. COLORCURVES: boolean;
  102670. COLORGRADING: boolean;
  102671. COLORGRADING3D: boolean;
  102672. SAMPLER3DGREENDEPTH: boolean;
  102673. SAMPLER3DBGRMAP: boolean;
  102674. IMAGEPROCESSINGPOSTPROCESS: boolean;
  102675. /** MISC. */
  102676. BUMPDIRECTUV: number;
  102677. constructor();
  102678. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  102679. }
  102680. /**
  102681. * Class used to configure NodeMaterial
  102682. */
  102683. export interface INodeMaterialOptions {
  102684. /**
  102685. * Defines if blocks should emit comments
  102686. */
  102687. emitComments: boolean;
  102688. }
  102689. /**
  102690. * Class used to create a node based material built by assembling shader blocks
  102691. */
  102692. export class NodeMaterial extends PushMaterial {
  102693. private static _BuildIdGenerator;
  102694. private _options;
  102695. private _vertexCompilationState;
  102696. private _fragmentCompilationState;
  102697. private _sharedData;
  102698. private _buildId;
  102699. private _buildWasSuccessful;
  102700. private _cachedWorldViewMatrix;
  102701. private _cachedWorldViewProjectionMatrix;
  102702. private _optimizers;
  102703. private _animationFrame;
  102704. /** Define the Url to load node editor script */
  102705. static EditorURL: string;
  102706. /** Define the Url to load snippets */
  102707. static SnippetUrl: string;
  102708. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  102709. static IgnoreTexturesAtLoadTime: boolean;
  102710. private BJSNODEMATERIALEDITOR;
  102711. /** Get the inspector from bundle or global */
  102712. private _getGlobalNodeMaterialEditor;
  102713. /**
  102714. * Snippet ID if the material was created from the snippet server
  102715. */
  102716. snippetId: string;
  102717. /**
  102718. * Gets or sets data used by visual editor
  102719. * @see https://nme.babylonjs.com
  102720. */
  102721. editorData: any;
  102722. /**
  102723. * 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)
  102724. */
  102725. ignoreAlpha: boolean;
  102726. /**
  102727. * Defines the maximum number of lights that can be used in the material
  102728. */
  102729. maxSimultaneousLights: number;
  102730. /**
  102731. * Observable raised when the material is built
  102732. */
  102733. onBuildObservable: Observable<NodeMaterial>;
  102734. /**
  102735. * Gets or sets the root nodes of the material vertex shader
  102736. */
  102737. _vertexOutputNodes: NodeMaterialBlock[];
  102738. /**
  102739. * Gets or sets the root nodes of the material fragment (pixel) shader
  102740. */
  102741. _fragmentOutputNodes: NodeMaterialBlock[];
  102742. /** Gets or sets options to control the node material overall behavior */
  102743. get options(): INodeMaterialOptions;
  102744. set options(options: INodeMaterialOptions);
  102745. /**
  102746. * Default configuration related to image processing available in the standard Material.
  102747. */
  102748. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  102749. /**
  102750. * Gets the image processing configuration used either in this material.
  102751. */
  102752. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  102753. /**
  102754. * Sets the Default image processing configuration used either in the this material.
  102755. *
  102756. * If sets to null, the scene one is in use.
  102757. */
  102758. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  102759. /**
  102760. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  102761. */
  102762. attachedBlocks: NodeMaterialBlock[];
  102763. /**
  102764. * Specifies the mode of the node material
  102765. * @hidden
  102766. */
  102767. _mode: NodeMaterialModes;
  102768. /**
  102769. * Gets the mode property
  102770. */
  102771. get mode(): NodeMaterialModes;
  102772. /**
  102773. * Create a new node based material
  102774. * @param name defines the material name
  102775. * @param scene defines the hosting scene
  102776. * @param options defines creation option
  102777. */
  102778. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  102779. /**
  102780. * Gets the current class name of the material e.g. "NodeMaterial"
  102781. * @returns the class name
  102782. */
  102783. getClassName(): string;
  102784. /**
  102785. * Keep track of the image processing observer to allow dispose and replace.
  102786. */
  102787. private _imageProcessingObserver;
  102788. /**
  102789. * Attaches a new image processing configuration to the Standard Material.
  102790. * @param configuration
  102791. */
  102792. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  102793. /**
  102794. * Get a block by its name
  102795. * @param name defines the name of the block to retrieve
  102796. * @returns the required block or null if not found
  102797. */
  102798. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  102799. /**
  102800. * Get a block by its name
  102801. * @param predicate defines the predicate used to find the good candidate
  102802. * @returns the required block or null if not found
  102803. */
  102804. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  102805. /**
  102806. * Get an input block by its name
  102807. * @param predicate defines the predicate used to find the good candidate
  102808. * @returns the required input block or null if not found
  102809. */
  102810. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  102811. /**
  102812. * Gets the list of input blocks attached to this material
  102813. * @returns an array of InputBlocks
  102814. */
  102815. getInputBlocks(): InputBlock[];
  102816. /**
  102817. * Adds a new optimizer to the list of optimizers
  102818. * @param optimizer defines the optimizers to add
  102819. * @returns the current material
  102820. */
  102821. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  102822. /**
  102823. * Remove an optimizer from the list of optimizers
  102824. * @param optimizer defines the optimizers to remove
  102825. * @returns the current material
  102826. */
  102827. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  102828. /**
  102829. * Add a new block to the list of output nodes
  102830. * @param node defines the node to add
  102831. * @returns the current material
  102832. */
  102833. addOutputNode(node: NodeMaterialBlock): this;
  102834. /**
  102835. * Remove a block from the list of root nodes
  102836. * @param node defines the node to remove
  102837. * @returns the current material
  102838. */
  102839. removeOutputNode(node: NodeMaterialBlock): this;
  102840. private _addVertexOutputNode;
  102841. private _removeVertexOutputNode;
  102842. private _addFragmentOutputNode;
  102843. private _removeFragmentOutputNode;
  102844. /**
  102845. * Specifies if the material will require alpha blending
  102846. * @returns a boolean specifying if alpha blending is needed
  102847. */
  102848. needAlphaBlending(): boolean;
  102849. /**
  102850. * Specifies if this material should be rendered in alpha test mode
  102851. * @returns a boolean specifying if an alpha test is needed.
  102852. */
  102853. needAlphaTesting(): boolean;
  102854. private _initializeBlock;
  102855. private _resetDualBlocks;
  102856. /**
  102857. * Remove a block from the current node material
  102858. * @param block defines the block to remove
  102859. */
  102860. removeBlock(block: NodeMaterialBlock): void;
  102861. /**
  102862. * Build the material and generates the inner effect
  102863. * @param verbose defines if the build should log activity
  102864. */
  102865. build(verbose?: boolean): void;
  102866. /**
  102867. * Runs an otpimization phase to try to improve the shader code
  102868. */
  102869. optimize(): void;
  102870. private _prepareDefinesForAttributes;
  102871. /**
  102872. * Create a post process from the material
  102873. * @param camera The camera to apply the render pass to.
  102874. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102875. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102876. * @param engine The engine which the post process will be applied. (default: current engine)
  102877. * @param reusable If the post process can be reused on the same frame. (default: false)
  102878. * @param textureType Type of textures used when performing the post process. (default: 0)
  102879. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  102880. * @returns the post process created
  102881. */
  102882. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): Nullable<PostProcess>;
  102883. /**
  102884. * Create the post process effect from the material
  102885. * @param postProcess The post process to create the effect for
  102886. */
  102887. createEffectForPostProcess(postProcess: PostProcess): void;
  102888. private _createEffectForPostProcess;
  102889. /**
  102890. * Create a new procedural texture based on this node material
  102891. * @param size defines the size of the texture
  102892. * @param scene defines the hosting scene
  102893. * @returns the new procedural texture attached to this node material
  102894. */
  102895. createProceduralTexture(size: number | {
  102896. width: number;
  102897. height: number;
  102898. layers?: number;
  102899. }, scene: Scene): Nullable<ProceduralTexture>;
  102900. private _createEffectForParticles;
  102901. private _checkInternals;
  102902. /**
  102903. * Create the effect to be used as the custom effect for a particle system
  102904. * @param particleSystem Particle system to create the effect for
  102905. * @param onCompiled defines a function to call when the effect creation is successful
  102906. * @param onError defines a function to call when the effect creation has failed
  102907. */
  102908. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102909. private _processDefines;
  102910. /**
  102911. * Get if the submesh is ready to be used and all its information available.
  102912. * Child classes can use it to update shaders
  102913. * @param mesh defines the mesh to check
  102914. * @param subMesh defines which submesh to check
  102915. * @param useInstances specifies that instances should be used
  102916. * @returns a boolean indicating that the submesh is ready or not
  102917. */
  102918. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  102919. /**
  102920. * Get a string representing the shaders built by the current node graph
  102921. */
  102922. get compiledShaders(): string;
  102923. /**
  102924. * Binds the world matrix to the material
  102925. * @param world defines the world transformation matrix
  102926. */
  102927. bindOnlyWorldMatrix(world: Matrix): void;
  102928. /**
  102929. * Binds the submesh to this material by preparing the effect and shader to draw
  102930. * @param world defines the world transformation matrix
  102931. * @param mesh defines the mesh containing the submesh
  102932. * @param subMesh defines the submesh to bind the material to
  102933. */
  102934. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  102935. /**
  102936. * Gets the active textures from the material
  102937. * @returns an array of textures
  102938. */
  102939. getActiveTextures(): BaseTexture[];
  102940. /**
  102941. * Gets the list of texture blocks
  102942. * @returns an array of texture blocks
  102943. */
  102944. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  102945. /**
  102946. * Specifies if the material uses a texture
  102947. * @param texture defines the texture to check against the material
  102948. * @returns a boolean specifying if the material uses the texture
  102949. */
  102950. hasTexture(texture: BaseTexture): boolean;
  102951. /**
  102952. * Disposes the material
  102953. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  102954. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  102955. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  102956. */
  102957. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  102958. /** Creates the node editor window. */
  102959. private _createNodeEditor;
  102960. /**
  102961. * Launch the node material editor
  102962. * @param config Define the configuration of the editor
  102963. * @return a promise fulfilled when the node editor is visible
  102964. */
  102965. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  102966. /**
  102967. * Clear the current material
  102968. */
  102969. clear(): void;
  102970. /**
  102971. * Clear the current material and set it to a default state
  102972. */
  102973. setToDefault(): void;
  102974. /**
  102975. * Clear the current material and set it to a default state for post process
  102976. */
  102977. setToDefaultPostProcess(): void;
  102978. /**
  102979. * Clear the current material and set it to a default state for procedural texture
  102980. */
  102981. setToDefaultProceduralTexture(): void;
  102982. /**
  102983. * Clear the current material and set it to a default state for particle
  102984. */
  102985. setToDefaultParticle(): void;
  102986. /**
  102987. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  102988. * @param url defines the url to load from
  102989. * @returns a promise that will fullfil when the material is fully loaded
  102990. */
  102991. loadAsync(url: string): Promise<void>;
  102992. private _gatherBlocks;
  102993. /**
  102994. * Generate a string containing the code declaration required to create an equivalent of this material
  102995. * @returns a string
  102996. */
  102997. generateCode(): string;
  102998. /**
  102999. * Serializes this material in a JSON representation
  103000. * @returns the serialized material object
  103001. */
  103002. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  103003. private _restoreConnections;
  103004. /**
  103005. * Clear the current graph and load a new one from a serialization object
  103006. * @param source defines the JSON representation of the material
  103007. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  103008. * @param merge defines whether or not the source must be merged or replace the current content
  103009. */
  103010. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  103011. /**
  103012. * Makes a duplicate of the current material.
  103013. * @param name - name to use for the new material.
  103014. */
  103015. clone(name: string): NodeMaterial;
  103016. /**
  103017. * Creates a node material from parsed material data
  103018. * @param source defines the JSON representation of the material
  103019. * @param scene defines the hosting scene
  103020. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  103021. * @returns a new node material
  103022. */
  103023. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  103024. /**
  103025. * Creates a node material from a snippet saved in a remote file
  103026. * @param name defines the name of the material to create
  103027. * @param url defines the url to load from
  103028. * @param scene defines the hosting scene
  103029. * @returns a promise that will resolve to the new node material
  103030. */
  103031. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  103032. /**
  103033. * Creates a node material from a snippet saved by the node material editor
  103034. * @param snippetId defines the snippet to load
  103035. * @param scene defines the hosting scene
  103036. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  103037. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  103038. * @returns a promise that will resolve to the new node material
  103039. */
  103040. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  103041. /**
  103042. * Creates a new node material set to default basic configuration
  103043. * @param name defines the name of the material
  103044. * @param scene defines the hosting scene
  103045. * @returns a new NodeMaterial
  103046. */
  103047. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  103048. }
  103049. }
  103050. declare module BABYLON {
  103051. /**
  103052. * Size options for a post process
  103053. */
  103054. export type PostProcessOptions = {
  103055. width: number;
  103056. height: number;
  103057. };
  103058. /**
  103059. * PostProcess can be used to apply a shader to a texture after it has been rendered
  103060. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  103061. */
  103062. export class PostProcess {
  103063. /**
  103064. * Gets or sets the unique id of the post process
  103065. */
  103066. uniqueId: number;
  103067. /** Name of the PostProcess. */
  103068. name: string;
  103069. /**
  103070. * Width of the texture to apply the post process on
  103071. */
  103072. width: number;
  103073. /**
  103074. * Height of the texture to apply the post process on
  103075. */
  103076. height: number;
  103077. /**
  103078. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  103079. */
  103080. nodeMaterialSource: Nullable<NodeMaterial>;
  103081. /**
  103082. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  103083. * @hidden
  103084. */
  103085. _outputTexture: Nullable<InternalTexture>;
  103086. /**
  103087. * Sampling mode used by the shader
  103088. * See https://doc.babylonjs.com/classes/3.1/texture
  103089. */
  103090. renderTargetSamplingMode: number;
  103091. /**
  103092. * Clear color to use when screen clearing
  103093. */
  103094. clearColor: Color4;
  103095. /**
  103096. * If the buffer needs to be cleared before applying the post process. (default: true)
  103097. * Should be set to false if shader will overwrite all previous pixels.
  103098. */
  103099. autoClear: boolean;
  103100. /**
  103101. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  103102. */
  103103. alphaMode: number;
  103104. /**
  103105. * Sets the setAlphaBlendConstants of the babylon engine
  103106. */
  103107. alphaConstants: Color4;
  103108. /**
  103109. * Animations to be used for the post processing
  103110. */
  103111. animations: Animation[];
  103112. /**
  103113. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  103114. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  103115. */
  103116. enablePixelPerfectMode: boolean;
  103117. /**
  103118. * Force the postprocess to be applied without taking in account viewport
  103119. */
  103120. forceFullscreenViewport: boolean;
  103121. /**
  103122. * List of inspectable custom properties (used by the Inspector)
  103123. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  103124. */
  103125. inspectableCustomProperties: IInspectable[];
  103126. /**
  103127. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  103128. *
  103129. * | Value | Type | Description |
  103130. * | ----- | ----------------------------------- | ----------- |
  103131. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  103132. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  103133. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  103134. *
  103135. */
  103136. scaleMode: number;
  103137. /**
  103138. * Force textures to be a power of two (default: false)
  103139. */
  103140. alwaysForcePOT: boolean;
  103141. private _samples;
  103142. /**
  103143. * Number of sample textures (default: 1)
  103144. */
  103145. get samples(): number;
  103146. set samples(n: number);
  103147. /**
  103148. * Modify the scale of the post process to be the same as the viewport (default: false)
  103149. */
  103150. adaptScaleToCurrentViewport: boolean;
  103151. private _camera;
  103152. protected _scene: Scene;
  103153. private _engine;
  103154. private _options;
  103155. private _reusable;
  103156. private _textureType;
  103157. private _textureFormat;
  103158. /**
  103159. * Smart array of input and output textures for the post process.
  103160. * @hidden
  103161. */
  103162. _textures: SmartArray<InternalTexture>;
  103163. /**
  103164. * The index in _textures that corresponds to the output texture.
  103165. * @hidden
  103166. */
  103167. _currentRenderTextureInd: number;
  103168. private _effect;
  103169. private _samplers;
  103170. private _fragmentUrl;
  103171. private _vertexUrl;
  103172. private _parameters;
  103173. private _scaleRatio;
  103174. protected _indexParameters: any;
  103175. private _shareOutputWithPostProcess;
  103176. private _texelSize;
  103177. private _forcedOutputTexture;
  103178. /**
  103179. * Returns the fragment url or shader name used in the post process.
  103180. * @returns the fragment url or name in the shader store.
  103181. */
  103182. getEffectName(): string;
  103183. /**
  103184. * An event triggered when the postprocess is activated.
  103185. */
  103186. onActivateObservable: Observable<Camera>;
  103187. private _onActivateObserver;
  103188. /**
  103189. * A function that is added to the onActivateObservable
  103190. */
  103191. set onActivate(callback: Nullable<(camera: Camera) => void>);
  103192. /**
  103193. * An event triggered when the postprocess changes its size.
  103194. */
  103195. onSizeChangedObservable: Observable<PostProcess>;
  103196. private _onSizeChangedObserver;
  103197. /**
  103198. * A function that is added to the onSizeChangedObservable
  103199. */
  103200. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  103201. /**
  103202. * An event triggered when the postprocess applies its effect.
  103203. */
  103204. onApplyObservable: Observable<Effect>;
  103205. private _onApplyObserver;
  103206. /**
  103207. * A function that is added to the onApplyObservable
  103208. */
  103209. set onApply(callback: (effect: Effect) => void);
  103210. /**
  103211. * An event triggered before rendering the postprocess
  103212. */
  103213. onBeforeRenderObservable: Observable<Effect>;
  103214. private _onBeforeRenderObserver;
  103215. /**
  103216. * A function that is added to the onBeforeRenderObservable
  103217. */
  103218. set onBeforeRender(callback: (effect: Effect) => void);
  103219. /**
  103220. * An event triggered after rendering the postprocess
  103221. */
  103222. onAfterRenderObservable: Observable<Effect>;
  103223. private _onAfterRenderObserver;
  103224. /**
  103225. * A function that is added to the onAfterRenderObservable
  103226. */
  103227. set onAfterRender(callback: (efect: Effect) => void);
  103228. /**
  103229. * 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
  103230. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  103231. */
  103232. get inputTexture(): InternalTexture;
  103233. set inputTexture(value: InternalTexture);
  103234. /**
  103235. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  103236. * the only way to unset it is to use this function to restore its internal state
  103237. */
  103238. restoreDefaultInputTexture(): void;
  103239. /**
  103240. * Gets the camera which post process is applied to.
  103241. * @returns The camera the post process is applied to.
  103242. */
  103243. getCamera(): Camera;
  103244. /**
  103245. * Gets the texel size of the postprocess.
  103246. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  103247. */
  103248. get texelSize(): Vector2;
  103249. /**
  103250. * Creates a new instance PostProcess
  103251. * @param name The name of the PostProcess.
  103252. * @param fragmentUrl The url of the fragment shader to be used.
  103253. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  103254. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  103255. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  103256. * @param camera The camera to apply the render pass to.
  103257. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  103258. * @param engine The engine which the post process will be applied. (default: current engine)
  103259. * @param reusable If the post process can be reused on the same frame. (default: false)
  103260. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  103261. * @param textureType Type of textures used when performing the post process. (default: 0)
  103262. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  103263. * @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
  103264. * @param blockCompilation If the shader should not be compiled immediatly. (default: false)
  103265. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  103266. */
  103267. 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);
  103268. /**
  103269. * Gets a string identifying the name of the class
  103270. * @returns "PostProcess" string
  103271. */
  103272. getClassName(): string;
  103273. /**
  103274. * Gets the engine which this post process belongs to.
  103275. * @returns The engine the post process was enabled with.
  103276. */
  103277. getEngine(): Engine;
  103278. /**
  103279. * The effect that is created when initializing the post process.
  103280. * @returns The created effect corresponding the the postprocess.
  103281. */
  103282. getEffect(): Effect;
  103283. /**
  103284. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  103285. * @param postProcess The post process to share the output with.
  103286. * @returns This post process.
  103287. */
  103288. shareOutputWith(postProcess: PostProcess): PostProcess;
  103289. /**
  103290. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  103291. * This should be called if the post process that shares output with this post process is disabled/disposed.
  103292. */
  103293. useOwnOutput(): void;
  103294. /**
  103295. * Updates the effect with the current post process compile time values and recompiles the shader.
  103296. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  103297. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  103298. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  103299. * @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
  103300. * @param onCompiled Called when the shader has been compiled.
  103301. * @param onError Called if there is an error when compiling a shader.
  103302. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  103303. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  103304. */
  103305. 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;
  103306. /**
  103307. * The post process is reusable if it can be used multiple times within one frame.
  103308. * @returns If the post process is reusable
  103309. */
  103310. isReusable(): boolean;
  103311. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  103312. markTextureDirty(): void;
  103313. /**
  103314. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  103315. * 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.
  103316. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  103317. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  103318. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  103319. * @returns The target texture that was bound to be written to.
  103320. */
  103321. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  103322. /**
  103323. * If the post process is supported.
  103324. */
  103325. get isSupported(): boolean;
  103326. /**
  103327. * The aspect ratio of the output texture.
  103328. */
  103329. get aspectRatio(): number;
  103330. /**
  103331. * Get a value indicating if the post-process is ready to be used
  103332. * @returns true if the post-process is ready (shader is compiled)
  103333. */
  103334. isReady(): boolean;
  103335. /**
  103336. * Binds all textures and uniforms to the shader, this will be run on every pass.
  103337. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  103338. */
  103339. apply(): Nullable<Effect>;
  103340. private _disposeTextures;
  103341. /**
  103342. * Disposes the post process.
  103343. * @param camera The camera to dispose the post process on.
  103344. */
  103345. dispose(camera?: Camera): void;
  103346. /**
  103347. * Serializes the particle system to a JSON object
  103348. * @returns the JSON object
  103349. */
  103350. serialize(): any;
  103351. /**
  103352. * Creates a material from parsed material data
  103353. * @param parsedPostProcess defines parsed post process data
  103354. * @param scene defines the hosting scene
  103355. * @param rootUrl defines the root URL to use to load textures
  103356. * @returns a new post process
  103357. */
  103358. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  103359. }
  103360. }
  103361. declare module BABYLON {
  103362. /** @hidden */
  103363. export var kernelBlurVaryingDeclaration: {
  103364. name: string;
  103365. shader: string;
  103366. };
  103367. }
  103368. declare module BABYLON {
  103369. /** @hidden */
  103370. export var kernelBlurFragment: {
  103371. name: string;
  103372. shader: string;
  103373. };
  103374. }
  103375. declare module BABYLON {
  103376. /** @hidden */
  103377. export var kernelBlurFragment2: {
  103378. name: string;
  103379. shader: string;
  103380. };
  103381. }
  103382. declare module BABYLON {
  103383. /** @hidden */
  103384. export var kernelBlurPixelShader: {
  103385. name: string;
  103386. shader: string;
  103387. };
  103388. }
  103389. declare module BABYLON {
  103390. /** @hidden */
  103391. export var kernelBlurVertex: {
  103392. name: string;
  103393. shader: string;
  103394. };
  103395. }
  103396. declare module BABYLON {
  103397. /** @hidden */
  103398. export var kernelBlurVertexShader: {
  103399. name: string;
  103400. shader: string;
  103401. };
  103402. }
  103403. declare module BABYLON {
  103404. /**
  103405. * The Blur Post Process which blurs an image based on a kernel and direction.
  103406. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  103407. */
  103408. export class BlurPostProcess extends PostProcess {
  103409. private blockCompilation;
  103410. protected _kernel: number;
  103411. protected _idealKernel: number;
  103412. protected _packedFloat: boolean;
  103413. private _staticDefines;
  103414. /** The direction in which to blur the image. */
  103415. direction: Vector2;
  103416. /**
  103417. * Sets the length in pixels of the blur sample region
  103418. */
  103419. set kernel(v: number);
  103420. /**
  103421. * Gets the length in pixels of the blur sample region
  103422. */
  103423. get kernel(): number;
  103424. /**
  103425. * Sets wether or not the blur needs to unpack/repack floats
  103426. */
  103427. set packedFloat(v: boolean);
  103428. /**
  103429. * Gets wether or not the blur is unpacking/repacking floats
  103430. */
  103431. get packedFloat(): boolean;
  103432. /**
  103433. * Gets a string identifying the name of the class
  103434. * @returns "BlurPostProcess" string
  103435. */
  103436. getClassName(): string;
  103437. /**
  103438. * Creates a new instance BlurPostProcess
  103439. * @param name The name of the effect.
  103440. * @param direction The direction in which to blur the image.
  103441. * @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.
  103442. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  103443. * @param camera The camera to apply the render pass to.
  103444. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  103445. * @param engine The engine which the post process will be applied. (default: current engine)
  103446. * @param reusable If the post process can be reused on the same frame. (default: false)
  103447. * @param textureType Type of textures used when performing the post process. (default: 0)
  103448. * @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)
  103449. */
  103450. 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);
  103451. /**
  103452. * Updates the effect with the current post process compile time values and recompiles the shader.
  103453. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  103454. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  103455. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  103456. * @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
  103457. * @param onCompiled Called when the shader has been compiled.
  103458. * @param onError Called if there is an error when compiling a shader.
  103459. */
  103460. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  103461. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  103462. /**
  103463. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  103464. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  103465. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  103466. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  103467. * The gaps between physical kernels are compensated for in the weighting of the samples
  103468. * @param idealKernel Ideal blur kernel.
  103469. * @return Nearest best kernel.
  103470. */
  103471. protected _nearestBestKernel(idealKernel: number): number;
  103472. /**
  103473. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  103474. * @param x The point on the Gaussian distribution to sample.
  103475. * @return the value of the Gaussian function at x.
  103476. */
  103477. protected _gaussianWeight(x: number): number;
  103478. /**
  103479. * Generates a string that can be used as a floating point number in GLSL.
  103480. * @param x Value to print.
  103481. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  103482. * @return GLSL float string.
  103483. */
  103484. protected _glslFloat(x: number, decimalFigures?: number): string;
  103485. /** @hidden */
  103486. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  103487. }
  103488. }
  103489. declare module BABYLON {
  103490. /**
  103491. * Mirror texture can be used to simulate the view from a mirror in a scene.
  103492. * It will dynamically be rendered every frame to adapt to the camera point of view.
  103493. * You can then easily use it as a reflectionTexture on a flat surface.
  103494. * In case the surface is not a plane, please consider relying on reflection probes.
  103495. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  103496. */
  103497. export class MirrorTexture extends RenderTargetTexture {
  103498. private scene;
  103499. /**
  103500. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  103501. * 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.
  103502. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  103503. */
  103504. mirrorPlane: Plane;
  103505. /**
  103506. * Define the blur ratio used to blur the reflection if needed.
  103507. */
  103508. set blurRatio(value: number);
  103509. get blurRatio(): number;
  103510. /**
  103511. * Define the adaptive blur kernel used to blur the reflection if needed.
  103512. * This will autocompute the closest best match for the `blurKernel`
  103513. */
  103514. set adaptiveBlurKernel(value: number);
  103515. /**
  103516. * Define the blur kernel used to blur the reflection if needed.
  103517. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  103518. */
  103519. set blurKernel(value: number);
  103520. /**
  103521. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  103522. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  103523. */
  103524. set blurKernelX(value: number);
  103525. get blurKernelX(): number;
  103526. /**
  103527. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  103528. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  103529. */
  103530. set blurKernelY(value: number);
  103531. get blurKernelY(): number;
  103532. private _autoComputeBlurKernel;
  103533. protected _onRatioRescale(): void;
  103534. private _updateGammaSpace;
  103535. private _imageProcessingConfigChangeObserver;
  103536. private _transformMatrix;
  103537. private _mirrorMatrix;
  103538. private _savedViewMatrix;
  103539. private _blurX;
  103540. private _blurY;
  103541. private _adaptiveBlurKernel;
  103542. private _blurKernelX;
  103543. private _blurKernelY;
  103544. private _blurRatio;
  103545. /**
  103546. * Instantiates a Mirror Texture.
  103547. * Mirror texture can be used to simulate the view from a mirror in a scene.
  103548. * It will dynamically be rendered every frame to adapt to the camera point of view.
  103549. * You can then easily use it as a reflectionTexture on a flat surface.
  103550. * In case the surface is not a plane, please consider relying on reflection probes.
  103551. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  103552. * @param name
  103553. * @param size
  103554. * @param scene
  103555. * @param generateMipMaps
  103556. * @param type
  103557. * @param samplingMode
  103558. * @param generateDepthBuffer
  103559. */
  103560. constructor(name: string, size: number | {
  103561. width: number;
  103562. height: number;
  103563. } | {
  103564. ratio: number;
  103565. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  103566. private _preparePostProcesses;
  103567. /**
  103568. * Clone the mirror texture.
  103569. * @returns the cloned texture
  103570. */
  103571. clone(): MirrorTexture;
  103572. /**
  103573. * Serialize the texture to a JSON representation you could use in Parse later on
  103574. * @returns the serialized JSON representation
  103575. */
  103576. serialize(): any;
  103577. /**
  103578. * Dispose the texture and release its associated resources.
  103579. */
  103580. dispose(): void;
  103581. }
  103582. }
  103583. declare module BABYLON {
  103584. /**
  103585. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  103586. * @see https://doc.babylonjs.com/babylon101/materials#texture
  103587. */
  103588. export class Texture extends BaseTexture {
  103589. /**
  103590. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  103591. */
  103592. static SerializeBuffers: boolean;
  103593. /** @hidden */
  103594. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  103595. /** @hidden */
  103596. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  103597. /** @hidden */
  103598. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  103599. /** nearest is mag = nearest and min = nearest and mip = linear */
  103600. static readonly NEAREST_SAMPLINGMODE: number;
  103601. /** nearest is mag = nearest and min = nearest and mip = linear */
  103602. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  103603. /** Bilinear is mag = linear and min = linear and mip = nearest */
  103604. static readonly BILINEAR_SAMPLINGMODE: number;
  103605. /** Bilinear is mag = linear and min = linear and mip = nearest */
  103606. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  103607. /** Trilinear is mag = linear and min = linear and mip = linear */
  103608. static readonly TRILINEAR_SAMPLINGMODE: number;
  103609. /** Trilinear is mag = linear and min = linear and mip = linear */
  103610. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  103611. /** mag = nearest and min = nearest and mip = nearest */
  103612. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  103613. /** mag = nearest and min = linear and mip = nearest */
  103614. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  103615. /** mag = nearest and min = linear and mip = linear */
  103616. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  103617. /** mag = nearest and min = linear and mip = none */
  103618. static readonly NEAREST_LINEAR: number;
  103619. /** mag = nearest and min = nearest and mip = none */
  103620. static readonly NEAREST_NEAREST: number;
  103621. /** mag = linear and min = nearest and mip = nearest */
  103622. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  103623. /** mag = linear and min = nearest and mip = linear */
  103624. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  103625. /** mag = linear and min = linear and mip = none */
  103626. static readonly LINEAR_LINEAR: number;
  103627. /** mag = linear and min = nearest and mip = none */
  103628. static readonly LINEAR_NEAREST: number;
  103629. /** Explicit coordinates mode */
  103630. static readonly EXPLICIT_MODE: number;
  103631. /** Spherical coordinates mode */
  103632. static readonly SPHERICAL_MODE: number;
  103633. /** Planar coordinates mode */
  103634. static readonly PLANAR_MODE: number;
  103635. /** Cubic coordinates mode */
  103636. static readonly CUBIC_MODE: number;
  103637. /** Projection coordinates mode */
  103638. static readonly PROJECTION_MODE: number;
  103639. /** Inverse Cubic coordinates mode */
  103640. static readonly SKYBOX_MODE: number;
  103641. /** Inverse Cubic coordinates mode */
  103642. static readonly INVCUBIC_MODE: number;
  103643. /** Equirectangular coordinates mode */
  103644. static readonly EQUIRECTANGULAR_MODE: number;
  103645. /** Equirectangular Fixed coordinates mode */
  103646. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  103647. /** Equirectangular Fixed Mirrored coordinates mode */
  103648. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  103649. /** Texture is not repeating outside of 0..1 UVs */
  103650. static readonly CLAMP_ADDRESSMODE: number;
  103651. /** Texture is repeating outside of 0..1 UVs */
  103652. static readonly WRAP_ADDRESSMODE: number;
  103653. /** Texture is repeating and mirrored */
  103654. static readonly MIRROR_ADDRESSMODE: number;
  103655. /**
  103656. * 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
  103657. */
  103658. static UseSerializedUrlIfAny: boolean;
  103659. /**
  103660. * Define the url of the texture.
  103661. */
  103662. url: Nullable<string>;
  103663. /**
  103664. * Define an offset on the texture to offset the u coordinates of the UVs
  103665. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  103666. */
  103667. uOffset: number;
  103668. /**
  103669. * Define an offset on the texture to offset the v coordinates of the UVs
  103670. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  103671. */
  103672. vOffset: number;
  103673. /**
  103674. * Define an offset on the texture to scale the u coordinates of the UVs
  103675. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  103676. */
  103677. uScale: number;
  103678. /**
  103679. * Define an offset on the texture to scale the v coordinates of the UVs
  103680. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  103681. */
  103682. vScale: number;
  103683. /**
  103684. * Define an offset on the texture to rotate around the u coordinates of the UVs
  103685. * @see https://doc.babylonjs.com/how_to/more_materials
  103686. */
  103687. uAng: number;
  103688. /**
  103689. * Define an offset on the texture to rotate around the v coordinates of the UVs
  103690. * @see https://doc.babylonjs.com/how_to/more_materials
  103691. */
  103692. vAng: number;
  103693. /**
  103694. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  103695. * @see https://doc.babylonjs.com/how_to/more_materials
  103696. */
  103697. wAng: number;
  103698. /**
  103699. * Defines the center of rotation (U)
  103700. */
  103701. uRotationCenter: number;
  103702. /**
  103703. * Defines the center of rotation (V)
  103704. */
  103705. vRotationCenter: number;
  103706. /**
  103707. * Defines the center of rotation (W)
  103708. */
  103709. wRotationCenter: number;
  103710. /**
  103711. * Are mip maps generated for this texture or not.
  103712. */
  103713. get noMipmap(): boolean;
  103714. /**
  103715. * List of inspectable custom properties (used by the Inspector)
  103716. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  103717. */
  103718. inspectableCustomProperties: Nullable<IInspectable[]>;
  103719. private _noMipmap;
  103720. /** @hidden */
  103721. _invertY: boolean;
  103722. private _rowGenerationMatrix;
  103723. private _cachedTextureMatrix;
  103724. private _projectionModeMatrix;
  103725. private _t0;
  103726. private _t1;
  103727. private _t2;
  103728. private _cachedUOffset;
  103729. private _cachedVOffset;
  103730. private _cachedUScale;
  103731. private _cachedVScale;
  103732. private _cachedUAng;
  103733. private _cachedVAng;
  103734. private _cachedWAng;
  103735. private _cachedProjectionMatrixId;
  103736. private _cachedCoordinatesMode;
  103737. /** @hidden */
  103738. protected _initialSamplingMode: number;
  103739. /** @hidden */
  103740. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  103741. private _deleteBuffer;
  103742. protected _format: Nullable<number>;
  103743. private _delayedOnLoad;
  103744. private _delayedOnError;
  103745. private _mimeType?;
  103746. /** Returns the texture mime type if it was defined by a loader (undefined else) */
  103747. get mimeType(): string | undefined;
  103748. /**
  103749. * Observable triggered once the texture has been loaded.
  103750. */
  103751. onLoadObservable: Observable<Texture>;
  103752. protected _isBlocking: boolean;
  103753. /**
  103754. * Is the texture preventing material to render while loading.
  103755. * If false, a default texture will be used instead of the loading one during the preparation step.
  103756. */
  103757. set isBlocking(value: boolean);
  103758. get isBlocking(): boolean;
  103759. /**
  103760. * Get the current sampling mode associated with the texture.
  103761. */
  103762. get samplingMode(): number;
  103763. /**
  103764. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  103765. */
  103766. get invertY(): boolean;
  103767. /**
  103768. * Instantiates a new texture.
  103769. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  103770. * @see https://doc.babylonjs.com/babylon101/materials#texture
  103771. * @param url defines the url of the picture to load as a texture
  103772. * @param sceneOrEngine defines the scene or engine the texture will belong to
  103773. * @param noMipmap defines if the texture will require mip maps or not
  103774. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  103775. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  103776. * @param onLoad defines a callback triggered when the texture has been loaded
  103777. * @param onError defines a callback triggered when an error occurred during the loading session
  103778. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  103779. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  103780. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  103781. * @param mimeType defines an optional mime type information
  103782. */
  103783. 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);
  103784. /**
  103785. * Update the url (and optional buffer) of this texture if url was null during construction.
  103786. * @param url the url of the texture
  103787. * @param buffer the buffer of the texture (defaults to null)
  103788. * @param onLoad callback called when the texture is loaded (defaults to null)
  103789. */
  103790. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  103791. /**
  103792. * Finish the loading sequence of a texture flagged as delayed load.
  103793. * @hidden
  103794. */
  103795. delayLoad(): void;
  103796. private _prepareRowForTextureGeneration;
  103797. /**
  103798. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  103799. * @returns the transform matrix of the texture.
  103800. */
  103801. getTextureMatrix(uBase?: number): Matrix;
  103802. /**
  103803. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  103804. * @returns The reflection texture transform
  103805. */
  103806. getReflectionTextureMatrix(): Matrix;
  103807. /**
  103808. * Clones the texture.
  103809. * @returns the cloned texture
  103810. */
  103811. clone(): Texture;
  103812. /**
  103813. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  103814. * @returns The JSON representation of the texture
  103815. */
  103816. serialize(): any;
  103817. /**
  103818. * Get the current class name of the texture useful for serialization or dynamic coding.
  103819. * @returns "Texture"
  103820. */
  103821. getClassName(): string;
  103822. /**
  103823. * Dispose the texture and release its associated resources.
  103824. */
  103825. dispose(): void;
  103826. /**
  103827. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  103828. * @param parsedTexture Define the JSON representation of the texture
  103829. * @param scene Define the scene the parsed texture should be instantiated in
  103830. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  103831. * @returns The parsed texture if successful
  103832. */
  103833. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  103834. /**
  103835. * Creates a texture from its base 64 representation.
  103836. * @param data Define the base64 payload without the data: prefix
  103837. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  103838. * @param scene Define the scene the texture should belong to
  103839. * @param noMipmap Forces the texture to not create mip map information if true
  103840. * @param invertY define if the texture needs to be inverted on the y axis during loading
  103841. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  103842. * @param onLoad define a callback triggered when the texture has been loaded
  103843. * @param onError define a callback triggered when an error occurred during the loading session
  103844. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  103845. * @returns the created texture
  103846. */
  103847. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  103848. /**
  103849. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  103850. * @param data Define the base64 payload without the data: prefix
  103851. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  103852. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  103853. * @param scene Define the scene the texture should belong to
  103854. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  103855. * @param noMipmap Forces the texture to not create mip map information if true
  103856. * @param invertY define if the texture needs to be inverted on the y axis during loading
  103857. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  103858. * @param onLoad define a callback triggered when the texture has been loaded
  103859. * @param onError define a callback triggered when an error occurred during the loading session
  103860. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  103861. * @returns the created texture
  103862. */
  103863. 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;
  103864. }
  103865. }
  103866. declare module BABYLON {
  103867. /**
  103868. * PostProcessManager is used to manage one or more post processes or post process pipelines
  103869. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  103870. */
  103871. export class PostProcessManager {
  103872. private _scene;
  103873. private _indexBuffer;
  103874. private _vertexBuffers;
  103875. /**
  103876. * Creates a new instance PostProcess
  103877. * @param scene The scene that the post process is associated with.
  103878. */
  103879. constructor(scene: Scene);
  103880. private _prepareBuffers;
  103881. private _buildIndexBuffer;
  103882. /**
  103883. * Rebuilds the vertex buffers of the manager.
  103884. * @hidden
  103885. */
  103886. _rebuild(): void;
  103887. /**
  103888. * Prepares a frame to be run through a post process.
  103889. * @param sourceTexture The input texture to the post procesess. (default: null)
  103890. * @param postProcesses An array of post processes to be run. (default: null)
  103891. * @returns True if the post processes were able to be run.
  103892. * @hidden
  103893. */
  103894. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  103895. /**
  103896. * Manually render a set of post processes to a texture.
  103897. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  103898. * @param postProcesses An array of post processes to be run.
  103899. * @param targetTexture The target texture to render to.
  103900. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  103901. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  103902. * @param lodLevel defines which lod of the texture to render to
  103903. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  103904. */
  103905. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  103906. /**
  103907. * Finalize the result of the output of the postprocesses.
  103908. * @param doNotPresent If true the result will not be displayed to the screen.
  103909. * @param targetTexture The target texture to render to.
  103910. * @param faceIndex The index of the face to bind the target texture to.
  103911. * @param postProcesses The array of post processes to render.
  103912. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  103913. * @hidden
  103914. */
  103915. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  103916. /**
  103917. * Disposes of the post process manager.
  103918. */
  103919. dispose(): void;
  103920. }
  103921. }
  103922. declare module BABYLON {
  103923. /**
  103924. * This Helps creating a texture that will be created from a camera in your scene.
  103925. * It is basically a dynamic texture that could be used to create special effects for instance.
  103926. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  103927. */
  103928. export class RenderTargetTexture extends Texture {
  103929. /**
  103930. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  103931. */
  103932. static readonly REFRESHRATE_RENDER_ONCE: number;
  103933. /**
  103934. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  103935. */
  103936. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  103937. /**
  103938. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  103939. * the central point of your effect and can save a lot of performances.
  103940. */
  103941. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  103942. /**
  103943. * Use this predicate to dynamically define the list of mesh you want to render.
  103944. * If set, the renderList property will be overwritten.
  103945. */
  103946. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  103947. private _renderList;
  103948. /**
  103949. * Use this list to define the list of mesh you want to render.
  103950. */
  103951. get renderList(): Nullable<Array<AbstractMesh>>;
  103952. set renderList(value: Nullable<Array<AbstractMesh>>);
  103953. /**
  103954. * Use this function to overload the renderList array at rendering time.
  103955. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  103956. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  103957. * the cube (if the RTT is a cube, else layerOrFace=0).
  103958. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  103959. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  103960. * hold dummy elements!
  103961. */
  103962. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  103963. private _hookArray;
  103964. /**
  103965. * Define if particles should be rendered in your texture.
  103966. */
  103967. renderParticles: boolean;
  103968. /**
  103969. * Define if sprites should be rendered in your texture.
  103970. */
  103971. renderSprites: boolean;
  103972. /**
  103973. * Define the camera used to render the texture.
  103974. */
  103975. activeCamera: Nullable<Camera>;
  103976. /**
  103977. * Override the mesh isReady function with your own one.
  103978. */
  103979. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  103980. /**
  103981. * Override the render function of the texture with your own one.
  103982. */
  103983. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  103984. /**
  103985. * Define if camera post processes should be use while rendering the texture.
  103986. */
  103987. useCameraPostProcesses: boolean;
  103988. /**
  103989. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  103990. */
  103991. ignoreCameraViewport: boolean;
  103992. private _postProcessManager;
  103993. private _postProcesses;
  103994. private _resizeObserver;
  103995. /**
  103996. * An event triggered when the texture is unbind.
  103997. */
  103998. onBeforeBindObservable: Observable<RenderTargetTexture>;
  103999. /**
  104000. * An event triggered when the texture is unbind.
  104001. */
  104002. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  104003. private _onAfterUnbindObserver;
  104004. /**
  104005. * Set a after unbind callback in the texture.
  104006. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  104007. */
  104008. set onAfterUnbind(callback: () => void);
  104009. /**
  104010. * An event triggered before rendering the texture
  104011. */
  104012. onBeforeRenderObservable: Observable<number>;
  104013. private _onBeforeRenderObserver;
  104014. /**
  104015. * Set a before render callback in the texture.
  104016. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  104017. */
  104018. set onBeforeRender(callback: (faceIndex: number) => void);
  104019. /**
  104020. * An event triggered after rendering the texture
  104021. */
  104022. onAfterRenderObservable: Observable<number>;
  104023. private _onAfterRenderObserver;
  104024. /**
  104025. * Set a after render callback in the texture.
  104026. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  104027. */
  104028. set onAfterRender(callback: (faceIndex: number) => void);
  104029. /**
  104030. * An event triggered after the texture clear
  104031. */
  104032. onClearObservable: Observable<Engine>;
  104033. private _onClearObserver;
  104034. /**
  104035. * Set a clear callback in the texture.
  104036. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  104037. */
  104038. set onClear(callback: (Engine: Engine) => void);
  104039. /**
  104040. * An event triggered when the texture is resized.
  104041. */
  104042. onResizeObservable: Observable<RenderTargetTexture>;
  104043. /**
  104044. * Define the clear color of the Render Target if it should be different from the scene.
  104045. */
  104046. clearColor: Color4;
  104047. protected _size: number | {
  104048. width: number;
  104049. height: number;
  104050. layers?: number;
  104051. };
  104052. protected _initialSizeParameter: number | {
  104053. width: number;
  104054. height: number;
  104055. } | {
  104056. ratio: number;
  104057. };
  104058. protected _sizeRatio: Nullable<number>;
  104059. /** @hidden */
  104060. _generateMipMaps: boolean;
  104061. protected _renderingManager: RenderingManager;
  104062. /** @hidden */
  104063. _waitingRenderList?: string[];
  104064. protected _doNotChangeAspectRatio: boolean;
  104065. protected _currentRefreshId: number;
  104066. protected _refreshRate: number;
  104067. protected _textureMatrix: Matrix;
  104068. protected _samples: number;
  104069. protected _renderTargetOptions: RenderTargetCreationOptions;
  104070. /**
  104071. * Gets render target creation options that were used.
  104072. */
  104073. get renderTargetOptions(): RenderTargetCreationOptions;
  104074. protected _onRatioRescale(): void;
  104075. /**
  104076. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  104077. * It must define where the camera used to render the texture is set
  104078. */
  104079. boundingBoxPosition: Vector3;
  104080. private _boundingBoxSize;
  104081. /**
  104082. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  104083. * When defined, the cubemap will switch to local mode
  104084. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  104085. * @example https://www.babylonjs-playground.com/#RNASML
  104086. */
  104087. set boundingBoxSize(value: Vector3);
  104088. get boundingBoxSize(): Vector3;
  104089. /**
  104090. * In case the RTT has been created with a depth texture, get the associated
  104091. * depth texture.
  104092. * Otherwise, return null.
  104093. */
  104094. get depthStencilTexture(): Nullable<InternalTexture>;
  104095. /**
  104096. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  104097. * or used a shadow, depth texture...
  104098. * @param name The friendly name of the texture
  104099. * @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)
  104100. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  104101. * @param generateMipMaps True if mip maps need to be generated after render.
  104102. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  104103. * @param type The type of the buffer in the RTT (int, half float, float...)
  104104. * @param isCube True if a cube texture needs to be created
  104105. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  104106. * @param generateDepthBuffer True to generate a depth buffer
  104107. * @param generateStencilBuffer True to generate a stencil buffer
  104108. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  104109. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  104110. * @param delayAllocation if the texture allocation should be delayed (default: false)
  104111. */
  104112. constructor(name: string, size: number | {
  104113. width: number;
  104114. height: number;
  104115. layers?: number;
  104116. } | {
  104117. ratio: number;
  104118. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  104119. /**
  104120. * Creates a depth stencil texture.
  104121. * This is only available in WebGL 2 or with the depth texture extension available.
  104122. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  104123. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  104124. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  104125. */
  104126. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  104127. private _processSizeParameter;
  104128. /**
  104129. * Define the number of samples to use in case of MSAA.
  104130. * It defaults to one meaning no MSAA has been enabled.
  104131. */
  104132. get samples(): number;
  104133. set samples(value: number);
  104134. /**
  104135. * Resets the refresh counter of the texture and start bak from scratch.
  104136. * Could be useful to regenerate the texture if it is setup to render only once.
  104137. */
  104138. resetRefreshCounter(): void;
  104139. /**
  104140. * Define the refresh rate of the texture or the rendering frequency.
  104141. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  104142. */
  104143. get refreshRate(): number;
  104144. set refreshRate(value: number);
  104145. /**
  104146. * Adds a post process to the render target rendering passes.
  104147. * @param postProcess define the post process to add
  104148. */
  104149. addPostProcess(postProcess: PostProcess): void;
  104150. /**
  104151. * Clear all the post processes attached to the render target
  104152. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  104153. */
  104154. clearPostProcesses(dispose?: boolean): void;
  104155. /**
  104156. * Remove one of the post process from the list of attached post processes to the texture
  104157. * @param postProcess define the post process to remove from the list
  104158. */
  104159. removePostProcess(postProcess: PostProcess): void;
  104160. /** @hidden */
  104161. _shouldRender(): boolean;
  104162. /**
  104163. * Gets the actual render size of the texture.
  104164. * @returns the width of the render size
  104165. */
  104166. getRenderSize(): number;
  104167. /**
  104168. * Gets the actual render width of the texture.
  104169. * @returns the width of the render size
  104170. */
  104171. getRenderWidth(): number;
  104172. /**
  104173. * Gets the actual render height of the texture.
  104174. * @returns the height of the render size
  104175. */
  104176. getRenderHeight(): number;
  104177. /**
  104178. * Gets the actual number of layers of the texture.
  104179. * @returns the number of layers
  104180. */
  104181. getRenderLayers(): number;
  104182. /**
  104183. * Get if the texture can be rescaled or not.
  104184. */
  104185. get canRescale(): boolean;
  104186. /**
  104187. * Resize the texture using a ratio.
  104188. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  104189. */
  104190. scale(ratio: number): void;
  104191. /**
  104192. * Get the texture reflection matrix used to rotate/transform the reflection.
  104193. * @returns the reflection matrix
  104194. */
  104195. getReflectionTextureMatrix(): Matrix;
  104196. /**
  104197. * Resize the texture to a new desired size.
  104198. * Be carrefull as it will recreate all the data in the new texture.
  104199. * @param size Define the new size. It can be:
  104200. * - a number for squared texture,
  104201. * - an object containing { width: number, height: number }
  104202. * - or an object containing a ratio { ratio: number }
  104203. */
  104204. resize(size: number | {
  104205. width: number;
  104206. height: number;
  104207. } | {
  104208. ratio: number;
  104209. }): void;
  104210. private _defaultRenderListPrepared;
  104211. /**
  104212. * Renders all the objects from the render list into the texture.
  104213. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  104214. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  104215. */
  104216. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  104217. private _bestReflectionRenderTargetDimension;
  104218. private _prepareRenderingManager;
  104219. /**
  104220. * @hidden
  104221. * @param faceIndex face index to bind to if this is a cubetexture
  104222. * @param layer defines the index of the texture to bind in the array
  104223. */
  104224. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  104225. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  104226. private renderToTarget;
  104227. /**
  104228. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  104229. * This allowed control for front to back rendering or reversly depending of the special needs.
  104230. *
  104231. * @param renderingGroupId The rendering group id corresponding to its index
  104232. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  104233. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  104234. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  104235. */
  104236. 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;
  104237. /**
  104238. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  104239. *
  104240. * @param renderingGroupId The rendering group id corresponding to its index
  104241. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  104242. */
  104243. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  104244. /**
  104245. * Clones the texture.
  104246. * @returns the cloned texture
  104247. */
  104248. clone(): RenderTargetTexture;
  104249. /**
  104250. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  104251. * @returns The JSON representation of the texture
  104252. */
  104253. serialize(): any;
  104254. /**
  104255. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  104256. */
  104257. disposeFramebufferObjects(): void;
  104258. /**
  104259. * Dispose the texture and release its associated resources.
  104260. */
  104261. dispose(): void;
  104262. /** @hidden */
  104263. _rebuild(): void;
  104264. /**
  104265. * Clear the info related to rendering groups preventing retention point in material dispose.
  104266. */
  104267. freeRenderingGroups(): void;
  104268. /**
  104269. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  104270. * @returns the view count
  104271. */
  104272. getViewCount(): number;
  104273. }
  104274. }
  104275. declare module BABYLON {
  104276. /**
  104277. * Class used to manipulate GUIDs
  104278. */
  104279. export class GUID {
  104280. /**
  104281. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  104282. * Be aware Math.random() could cause collisions, but:
  104283. * "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"
  104284. * @returns a pseudo random id
  104285. */
  104286. static RandomId(): string;
  104287. }
  104288. }
  104289. declare module BABYLON {
  104290. /**
  104291. * Options to be used when creating a shadow depth material
  104292. */
  104293. export interface IIOptionShadowDepthMaterial {
  104294. /** Variables in the vertex shader code that need to have their names remapped.
  104295. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  104296. * "var_name" should be either: worldPos or vNormalW
  104297. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  104298. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  104299. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  104300. */
  104301. remappedVariables?: string[];
  104302. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  104303. standalone?: boolean;
  104304. }
  104305. /**
  104306. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  104307. */
  104308. export class ShadowDepthWrapper {
  104309. private _scene;
  104310. private _options?;
  104311. private _baseMaterial;
  104312. private _onEffectCreatedObserver;
  104313. private _subMeshToEffect;
  104314. private _subMeshToDepthEffect;
  104315. private _meshes;
  104316. /** @hidden */
  104317. _matriceNames: any;
  104318. /** Gets the standalone status of the wrapper */
  104319. get standalone(): boolean;
  104320. /** Gets the base material the wrapper is built upon */
  104321. get baseMaterial(): Material;
  104322. /**
  104323. * Instantiate a new shadow depth wrapper.
  104324. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  104325. * generate the shadow depth map. For more information, please refer to the documentation:
  104326. * https://doc.babylonjs.com/babylon101/shadows
  104327. * @param baseMaterial Material to wrap
  104328. * @param scene Define the scene the material belongs to
  104329. * @param options Options used to create the wrapper
  104330. */
  104331. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  104332. /**
  104333. * Gets the effect to use to generate the depth map
  104334. * @param subMesh subMesh to get the effect for
  104335. * @param shadowGenerator shadow generator to get the effect for
  104336. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  104337. */
  104338. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  104339. /**
  104340. * Specifies that the submesh is ready to be used for depth rendering
  104341. * @param subMesh submesh to check
  104342. * @param defines the list of defines to take into account when checking the effect
  104343. * @param shadowGenerator combined with subMesh, it defines the effect to check
  104344. * @param useInstances specifies that instances should be used
  104345. * @returns a boolean indicating that the submesh is ready or not
  104346. */
  104347. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  104348. /**
  104349. * Disposes the resources
  104350. */
  104351. dispose(): void;
  104352. private _makeEffect;
  104353. }
  104354. }
  104355. declare module BABYLON {
  104356. interface ThinEngine {
  104357. /**
  104358. * Unbind a list of render target textures from the webGL context
  104359. * This is used only when drawBuffer extension or webGL2 are active
  104360. * @param textures defines the render target textures to unbind
  104361. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  104362. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  104363. */
  104364. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  104365. /**
  104366. * Create a multi render target texture
  104367. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  104368. * @param size defines the size of the texture
  104369. * @param options defines the creation options
  104370. * @returns the cube texture as an InternalTexture
  104371. */
  104372. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  104373. /**
  104374. * Update the sample count for a given multiple render target texture
  104375. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  104376. * @param textures defines the textures to update
  104377. * @param samples defines the sample count to set
  104378. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  104379. */
  104380. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  104381. /**
  104382. * Select a subsets of attachments to draw to.
  104383. * @param attachments gl attachments
  104384. */
  104385. bindAttachments(attachments: number[]): void;
  104386. }
  104387. }
  104388. declare module BABYLON {
  104389. /**
  104390. * Creation options of the multi render target texture.
  104391. */
  104392. export interface IMultiRenderTargetOptions {
  104393. /**
  104394. * Define if the texture needs to create mip maps after render.
  104395. */
  104396. generateMipMaps?: boolean;
  104397. /**
  104398. * Define the types of all the draw buffers we want to create
  104399. */
  104400. types?: number[];
  104401. /**
  104402. * Define the sampling modes of all the draw buffers we want to create
  104403. */
  104404. samplingModes?: number[];
  104405. /**
  104406. * Define if a depth buffer is required
  104407. */
  104408. generateDepthBuffer?: boolean;
  104409. /**
  104410. * Define if a stencil buffer is required
  104411. */
  104412. generateStencilBuffer?: boolean;
  104413. /**
  104414. * Define if a depth texture is required instead of a depth buffer
  104415. */
  104416. generateDepthTexture?: boolean;
  104417. /**
  104418. * Define the number of desired draw buffers
  104419. */
  104420. textureCount?: number;
  104421. /**
  104422. * Define if aspect ratio should be adapted to the texture or stay the scene one
  104423. */
  104424. doNotChangeAspectRatio?: boolean;
  104425. /**
  104426. * Define the default type of the buffers we are creating
  104427. */
  104428. defaultType?: number;
  104429. }
  104430. /**
  104431. * A multi render target, like a render target provides the ability to render to a texture.
  104432. * Unlike the render target, it can render to several draw buffers in one draw.
  104433. * This is specially interesting in deferred rendering or for any effects requiring more than
  104434. * just one color from a single pass.
  104435. */
  104436. export class MultiRenderTarget extends RenderTargetTexture {
  104437. private _internalTextures;
  104438. private _textures;
  104439. private _multiRenderTargetOptions;
  104440. private _count;
  104441. /**
  104442. * Get if draw buffers are currently supported by the used hardware and browser.
  104443. */
  104444. get isSupported(): boolean;
  104445. /**
  104446. * Get the list of textures generated by the multi render target.
  104447. */
  104448. get textures(): Texture[];
  104449. /**
  104450. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  104451. */
  104452. get count(): number;
  104453. /**
  104454. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  104455. */
  104456. get depthTexture(): Texture;
  104457. /**
  104458. * Set the wrapping mode on U of all the textures we are rendering to.
  104459. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  104460. */
  104461. set wrapU(wrap: number);
  104462. /**
  104463. * Set the wrapping mode on V of all the textures we are rendering to.
  104464. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  104465. */
  104466. set wrapV(wrap: number);
  104467. /**
  104468. * Instantiate a new multi render target texture.
  104469. * A multi render target, like a render target provides the ability to render to a texture.
  104470. * Unlike the render target, it can render to several draw buffers in one draw.
  104471. * This is specially interesting in deferred rendering or for any effects requiring more than
  104472. * just one color from a single pass.
  104473. * @param name Define the name of the texture
  104474. * @param size Define the size of the buffers to render to
  104475. * @param count Define the number of target we are rendering into
  104476. * @param scene Define the scene the texture belongs to
  104477. * @param options Define the options used to create the multi render target
  104478. */
  104479. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  104480. private _initTypes;
  104481. /** @hidden */
  104482. _rebuild(forceFullRebuild?: boolean): void;
  104483. private _createInternalTextures;
  104484. private _createTextures;
  104485. /**
  104486. * Define the number of samples used if MSAA is enabled.
  104487. */
  104488. get samples(): number;
  104489. set samples(value: number);
  104490. /**
  104491. * Resize all the textures in the multi render target.
  104492. * Be careful as it will recreate all the data in the new texture.
  104493. * @param size Define the new size
  104494. */
  104495. resize(size: any): void;
  104496. /**
  104497. * Changes the number of render targets in this MRT
  104498. * Be careful as it will recreate all the data in the new texture.
  104499. * @param count new texture count
  104500. * @param options Specifies texture types and sampling modes for new textures
  104501. */
  104502. updateCount(count: number, options?: IMultiRenderTargetOptions): void;
  104503. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  104504. /**
  104505. * Dispose the render targets and their associated resources
  104506. */
  104507. dispose(): void;
  104508. /**
  104509. * Release all the underlying texture used as draw buffers.
  104510. */
  104511. releaseInternalTextures(): void;
  104512. }
  104513. }
  104514. declare module BABYLON {
  104515. /** @hidden */
  104516. export var imageProcessingPixelShader: {
  104517. name: string;
  104518. shader: string;
  104519. };
  104520. }
  104521. declare module BABYLON {
  104522. /**
  104523. * ImageProcessingPostProcess
  104524. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  104525. */
  104526. export class ImageProcessingPostProcess extends PostProcess {
  104527. /**
  104528. * Default configuration related to image processing available in the PBR Material.
  104529. */
  104530. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  104531. /**
  104532. * Gets the image processing configuration used either in this material.
  104533. */
  104534. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  104535. /**
  104536. * Sets the Default image processing configuration used either in the this material.
  104537. *
  104538. * If sets to null, the scene one is in use.
  104539. */
  104540. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  104541. /**
  104542. * Keep track of the image processing observer to allow dispose and replace.
  104543. */
  104544. private _imageProcessingObserver;
  104545. /**
  104546. * Attaches a new image processing configuration to the PBR Material.
  104547. * @param configuration
  104548. */
  104549. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  104550. /**
  104551. * If the post process is supported.
  104552. */
  104553. get isSupported(): boolean;
  104554. /**
  104555. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  104556. */
  104557. get colorCurves(): Nullable<ColorCurves>;
  104558. /**
  104559. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  104560. */
  104561. set colorCurves(value: Nullable<ColorCurves>);
  104562. /**
  104563. * Gets wether the color curves effect is enabled.
  104564. */
  104565. get colorCurvesEnabled(): boolean;
  104566. /**
  104567. * Sets wether the color curves effect is enabled.
  104568. */
  104569. set colorCurvesEnabled(value: boolean);
  104570. /**
  104571. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  104572. */
  104573. get colorGradingTexture(): Nullable<BaseTexture>;
  104574. /**
  104575. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  104576. */
  104577. set colorGradingTexture(value: Nullable<BaseTexture>);
  104578. /**
  104579. * Gets wether the color grading effect is enabled.
  104580. */
  104581. get colorGradingEnabled(): boolean;
  104582. /**
  104583. * Gets wether the color grading effect is enabled.
  104584. */
  104585. set colorGradingEnabled(value: boolean);
  104586. /**
  104587. * Gets exposure used in the effect.
  104588. */
  104589. get exposure(): number;
  104590. /**
  104591. * Sets exposure used in the effect.
  104592. */
  104593. set exposure(value: number);
  104594. /**
  104595. * Gets wether tonemapping is enabled or not.
  104596. */
  104597. get toneMappingEnabled(): boolean;
  104598. /**
  104599. * Sets wether tonemapping is enabled or not
  104600. */
  104601. set toneMappingEnabled(value: boolean);
  104602. /**
  104603. * Gets the type of tone mapping effect.
  104604. */
  104605. get toneMappingType(): number;
  104606. /**
  104607. * Sets the type of tone mapping effect.
  104608. */
  104609. set toneMappingType(value: number);
  104610. /**
  104611. * Gets contrast used in the effect.
  104612. */
  104613. get contrast(): number;
  104614. /**
  104615. * Sets contrast used in the effect.
  104616. */
  104617. set contrast(value: number);
  104618. /**
  104619. * Gets Vignette stretch size.
  104620. */
  104621. get vignetteStretch(): number;
  104622. /**
  104623. * Sets Vignette stretch size.
  104624. */
  104625. set vignetteStretch(value: number);
  104626. /**
  104627. * Gets Vignette centre X Offset.
  104628. */
  104629. get vignetteCentreX(): number;
  104630. /**
  104631. * Sets Vignette centre X Offset.
  104632. */
  104633. set vignetteCentreX(value: number);
  104634. /**
  104635. * Gets Vignette centre Y Offset.
  104636. */
  104637. get vignetteCentreY(): number;
  104638. /**
  104639. * Sets Vignette centre Y Offset.
  104640. */
  104641. set vignetteCentreY(value: number);
  104642. /**
  104643. * Gets Vignette weight or intensity of the vignette effect.
  104644. */
  104645. get vignetteWeight(): number;
  104646. /**
  104647. * Sets Vignette weight or intensity of the vignette effect.
  104648. */
  104649. set vignetteWeight(value: number);
  104650. /**
  104651. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  104652. * if vignetteEnabled is set to true.
  104653. */
  104654. get vignetteColor(): Color4;
  104655. /**
  104656. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  104657. * if vignetteEnabled is set to true.
  104658. */
  104659. set vignetteColor(value: Color4);
  104660. /**
  104661. * Gets Camera field of view used by the Vignette effect.
  104662. */
  104663. get vignetteCameraFov(): number;
  104664. /**
  104665. * Sets Camera field of view used by the Vignette effect.
  104666. */
  104667. set vignetteCameraFov(value: number);
  104668. /**
  104669. * Gets the vignette blend mode allowing different kind of effect.
  104670. */
  104671. get vignetteBlendMode(): number;
  104672. /**
  104673. * Sets the vignette blend mode allowing different kind of effect.
  104674. */
  104675. set vignetteBlendMode(value: number);
  104676. /**
  104677. * Gets wether the vignette effect is enabled.
  104678. */
  104679. get vignetteEnabled(): boolean;
  104680. /**
  104681. * Sets wether the vignette effect is enabled.
  104682. */
  104683. set vignetteEnabled(value: boolean);
  104684. private _fromLinearSpace;
  104685. /**
  104686. * Gets wether the input of the processing is in Gamma or Linear Space.
  104687. */
  104688. get fromLinearSpace(): boolean;
  104689. /**
  104690. * Sets wether the input of the processing is in Gamma or Linear Space.
  104691. */
  104692. set fromLinearSpace(value: boolean);
  104693. /**
  104694. * Defines cache preventing GC.
  104695. */
  104696. private _defines;
  104697. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  104698. /**
  104699. * "ImageProcessingPostProcess"
  104700. * @returns "ImageProcessingPostProcess"
  104701. */
  104702. getClassName(): string;
  104703. /**
  104704. * @hidden
  104705. */
  104706. _updateParameters(): void;
  104707. dispose(camera?: Camera): void;
  104708. }
  104709. }
  104710. declare module BABYLON {
  104711. /**
  104712. * Interface for defining prepass effects in the prepass post-process pipeline
  104713. */
  104714. export interface PrePassEffectConfiguration {
  104715. /**
  104716. * Name of the effect
  104717. */
  104718. name: string;
  104719. /**
  104720. * Post process to attach for this effect
  104721. */
  104722. postProcess?: PostProcess;
  104723. /**
  104724. * Textures required in the MRT
  104725. */
  104726. texturesRequired: number[];
  104727. /**
  104728. * Is the effect enabled
  104729. */
  104730. enabled: boolean;
  104731. /**
  104732. * Disposes the effect configuration
  104733. */
  104734. dispose(): void;
  104735. /**
  104736. * Creates the associated post process
  104737. */
  104738. createPostProcess?: () => PostProcess;
  104739. }
  104740. }
  104741. declare module BABYLON {
  104742. /**
  104743. * Renders a pre pass of the scene
  104744. * This means every mesh in the scene will be rendered to a render target texture
  104745. * And then this texture will be composited to the rendering canvas with post processes
  104746. * It is necessary for effects like subsurface scattering or deferred shading
  104747. */
  104748. export class PrePassRenderer {
  104749. /** @hidden */
  104750. static _SceneComponentInitialization: (scene: Scene) => void;
  104751. private _textureFormats;
  104752. private _textureIndices;
  104753. private _scene;
  104754. private _engine;
  104755. private _isDirty;
  104756. /**
  104757. * Number of textures in the multi render target texture where the scene is directly rendered
  104758. */
  104759. mrtCount: number;
  104760. /**
  104761. * The render target where the scene is directly rendered
  104762. */
  104763. prePassRT: MultiRenderTarget;
  104764. private _multiRenderAttachments;
  104765. private _defaultAttachments;
  104766. private _clearAttachments;
  104767. private _postProcesses;
  104768. private readonly _clearColor;
  104769. /**
  104770. * Image processing post process for composition
  104771. */
  104772. imageProcessingPostProcess: ImageProcessingPostProcess;
  104773. /**
  104774. * Configuration for prepass effects
  104775. */
  104776. private _effectConfigurations;
  104777. /**
  104778. * Should materials render their geometry on the MRT
  104779. */
  104780. materialsShouldRenderGeometry: boolean;
  104781. /**
  104782. * Should materials render the irradiance information on the MRT
  104783. */
  104784. materialsShouldRenderIrradiance: boolean;
  104785. private _mrtFormats;
  104786. private _mrtLayout;
  104787. private _enabled;
  104788. /**
  104789. * Indicates if the prepass is enabled
  104790. */
  104791. get enabled(): boolean;
  104792. /**
  104793. * How many samples are used for MSAA of the scene render target
  104794. */
  104795. get samples(): number;
  104796. set samples(n: number);
  104797. /**
  104798. * Instanciates a prepass renderer
  104799. * @param scene The scene
  104800. */
  104801. constructor(scene: Scene);
  104802. private _initializeAttachments;
  104803. private _createCompositionEffect;
  104804. /**
  104805. * Indicates if rendering a prepass is supported
  104806. */
  104807. get isSupported(): boolean;
  104808. /**
  104809. * Sets the proper output textures to draw in the engine.
  104810. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  104811. */
  104812. bindAttachmentsForEffect(effect: Effect): void;
  104813. /**
  104814. * @hidden
  104815. */
  104816. _beforeCameraDraw(): void;
  104817. /**
  104818. * @hidden
  104819. */
  104820. _afterCameraDraw(): void;
  104821. private _checkRTSize;
  104822. private _bindFrameBuffer;
  104823. /**
  104824. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  104825. */
  104826. clear(): void;
  104827. private _setState;
  104828. private _checkTextureType;
  104829. /**
  104830. * Adds an effect configuration to the prepass.
  104831. * If an effect has already been added, it won't add it twice and will return the configuration
  104832. * already present.
  104833. * @param cfg the effect configuration
  104834. * @return the effect configuration now used by the prepass
  104835. */
  104836. addEffectConfiguration(cfg: PrePassEffectConfiguration): PrePassEffectConfiguration;
  104837. /**
  104838. * Returns the index of a texture in the multi render target texture array.
  104839. * @param type Texture type
  104840. * @return The index
  104841. */
  104842. getIndex(type: number): number;
  104843. private _enable;
  104844. private _disable;
  104845. private _resetLayout;
  104846. private _resetPostProcessChain;
  104847. private _bindPostProcessChain;
  104848. /**
  104849. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  104850. */
  104851. markAsDirty(): void;
  104852. /**
  104853. * Enables a texture on the MultiRenderTarget for prepass
  104854. */
  104855. private _enableTextures;
  104856. private _update;
  104857. /**
  104858. * Disposes the prepass renderer.
  104859. */
  104860. dispose(): void;
  104861. }
  104862. }
  104863. declare module BABYLON {
  104864. /**
  104865. * Options for compiling materials.
  104866. */
  104867. export interface IMaterialCompilationOptions {
  104868. /**
  104869. * Defines whether clip planes are enabled.
  104870. */
  104871. clipPlane: boolean;
  104872. /**
  104873. * Defines whether instances are enabled.
  104874. */
  104875. useInstances: boolean;
  104876. }
  104877. /**
  104878. * Options passed when calling customShaderNameResolve
  104879. */
  104880. export interface ICustomShaderNameResolveOptions {
  104881. /**
  104882. * 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
  104883. */
  104884. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  104885. }
  104886. /**
  104887. * Base class for the main features of a material in Babylon.js
  104888. */
  104889. export class Material implements IAnimatable {
  104890. /**
  104891. * Returns the triangle fill mode
  104892. */
  104893. static readonly TriangleFillMode: number;
  104894. /**
  104895. * Returns the wireframe mode
  104896. */
  104897. static readonly WireFrameFillMode: number;
  104898. /**
  104899. * Returns the point fill mode
  104900. */
  104901. static readonly PointFillMode: number;
  104902. /**
  104903. * Returns the point list draw mode
  104904. */
  104905. static readonly PointListDrawMode: number;
  104906. /**
  104907. * Returns the line list draw mode
  104908. */
  104909. static readonly LineListDrawMode: number;
  104910. /**
  104911. * Returns the line loop draw mode
  104912. */
  104913. static readonly LineLoopDrawMode: number;
  104914. /**
  104915. * Returns the line strip draw mode
  104916. */
  104917. static readonly LineStripDrawMode: number;
  104918. /**
  104919. * Returns the triangle strip draw mode
  104920. */
  104921. static readonly TriangleStripDrawMode: number;
  104922. /**
  104923. * Returns the triangle fan draw mode
  104924. */
  104925. static readonly TriangleFanDrawMode: number;
  104926. /**
  104927. * Stores the clock-wise side orientation
  104928. */
  104929. static readonly ClockWiseSideOrientation: number;
  104930. /**
  104931. * Stores the counter clock-wise side orientation
  104932. */
  104933. static readonly CounterClockWiseSideOrientation: number;
  104934. /**
  104935. * The dirty texture flag value
  104936. */
  104937. static readonly TextureDirtyFlag: number;
  104938. /**
  104939. * The dirty light flag value
  104940. */
  104941. static readonly LightDirtyFlag: number;
  104942. /**
  104943. * The dirty fresnel flag value
  104944. */
  104945. static readonly FresnelDirtyFlag: number;
  104946. /**
  104947. * The dirty attribute flag value
  104948. */
  104949. static readonly AttributesDirtyFlag: number;
  104950. /**
  104951. * The dirty misc flag value
  104952. */
  104953. static readonly MiscDirtyFlag: number;
  104954. /**
  104955. * The all dirty flag value
  104956. */
  104957. static readonly AllDirtyFlag: number;
  104958. /**
  104959. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  104960. */
  104961. static readonly MATERIAL_OPAQUE: number;
  104962. /**
  104963. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  104964. */
  104965. static readonly MATERIAL_ALPHATEST: number;
  104966. /**
  104967. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  104968. */
  104969. static readonly MATERIAL_ALPHABLEND: number;
  104970. /**
  104971. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  104972. * They are also discarded below the alpha cutoff threshold to improve performances.
  104973. */
  104974. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  104975. /**
  104976. * The Whiteout method is used to blend normals.
  104977. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  104978. */
  104979. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  104980. /**
  104981. * The Reoriented Normal Mapping method is used to blend normals.
  104982. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  104983. */
  104984. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  104985. /**
  104986. * Custom callback helping to override the default shader used in the material.
  104987. */
  104988. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  104989. /**
  104990. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  104991. */
  104992. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  104993. /**
  104994. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  104995. * This means that the material can keep using a previous shader while a new one is being compiled.
  104996. * This is mostly used when shader parallel compilation is supported (true by default)
  104997. */
  104998. allowShaderHotSwapping: boolean;
  104999. /**
  105000. * The ID of the material
  105001. */
  105002. id: string;
  105003. /**
  105004. * Gets or sets the unique id of the material
  105005. */
  105006. uniqueId: number;
  105007. /**
  105008. * The name of the material
  105009. */
  105010. name: string;
  105011. /**
  105012. * Gets or sets user defined metadata
  105013. */
  105014. metadata: any;
  105015. /**
  105016. * For internal use only. Please do not use.
  105017. */
  105018. reservedDataStore: any;
  105019. /**
  105020. * Specifies if the ready state should be checked on each call
  105021. */
  105022. checkReadyOnEveryCall: boolean;
  105023. /**
  105024. * Specifies if the ready state should be checked once
  105025. */
  105026. checkReadyOnlyOnce: boolean;
  105027. /**
  105028. * The state of the material
  105029. */
  105030. state: string;
  105031. /**
  105032. * If the material can be rendered to several textures with MRT extension
  105033. */
  105034. get canRenderToMRT(): boolean;
  105035. /**
  105036. * The alpha value of the material
  105037. */
  105038. protected _alpha: number;
  105039. /**
  105040. * List of inspectable custom properties (used by the Inspector)
  105041. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  105042. */
  105043. inspectableCustomProperties: IInspectable[];
  105044. /**
  105045. * Sets the alpha value of the material
  105046. */
  105047. set alpha(value: number);
  105048. /**
  105049. * Gets the alpha value of the material
  105050. */
  105051. get alpha(): number;
  105052. /**
  105053. * Specifies if back face culling is enabled
  105054. */
  105055. protected _backFaceCulling: boolean;
  105056. /**
  105057. * Sets the back-face culling state
  105058. */
  105059. set backFaceCulling(value: boolean);
  105060. /**
  105061. * Gets the back-face culling state
  105062. */
  105063. get backFaceCulling(): boolean;
  105064. /**
  105065. * Stores the value for side orientation
  105066. */
  105067. sideOrientation: number;
  105068. /**
  105069. * Callback triggered when the material is compiled
  105070. */
  105071. onCompiled: Nullable<(effect: Effect) => void>;
  105072. /**
  105073. * Callback triggered when an error occurs
  105074. */
  105075. onError: Nullable<(effect: Effect, errors: string) => void>;
  105076. /**
  105077. * Callback triggered to get the render target textures
  105078. */
  105079. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  105080. /**
  105081. * Gets a boolean indicating that current material needs to register RTT
  105082. */
  105083. get hasRenderTargetTextures(): boolean;
  105084. /**
  105085. * Specifies if the material should be serialized
  105086. */
  105087. doNotSerialize: boolean;
  105088. /**
  105089. * @hidden
  105090. */
  105091. _storeEffectOnSubMeshes: boolean;
  105092. /**
  105093. * Stores the animations for the material
  105094. */
  105095. animations: Nullable<Array<Animation>>;
  105096. /**
  105097. * An event triggered when the material is disposed
  105098. */
  105099. onDisposeObservable: Observable<Material>;
  105100. /**
  105101. * An observer which watches for dispose events
  105102. */
  105103. private _onDisposeObserver;
  105104. private _onUnBindObservable;
  105105. /**
  105106. * Called during a dispose event
  105107. */
  105108. set onDispose(callback: () => void);
  105109. private _onBindObservable;
  105110. /**
  105111. * An event triggered when the material is bound
  105112. */
  105113. get onBindObservable(): Observable<AbstractMesh>;
  105114. /**
  105115. * An observer which watches for bind events
  105116. */
  105117. private _onBindObserver;
  105118. /**
  105119. * Called during a bind event
  105120. */
  105121. set onBind(callback: (Mesh: AbstractMesh) => void);
  105122. /**
  105123. * An event triggered when the material is unbound
  105124. */
  105125. get onUnBindObservable(): Observable<Material>;
  105126. protected _onEffectCreatedObservable: Nullable<Observable<{
  105127. effect: Effect;
  105128. subMesh: Nullable<SubMesh>;
  105129. }>>;
  105130. /**
  105131. * An event triggered when the effect is (re)created
  105132. */
  105133. get onEffectCreatedObservable(): Observable<{
  105134. effect: Effect;
  105135. subMesh: Nullable<SubMesh>;
  105136. }>;
  105137. /**
  105138. * Stores the value of the alpha mode
  105139. */
  105140. private _alphaMode;
  105141. /**
  105142. * Sets the value of the alpha mode.
  105143. *
  105144. * | Value | Type | Description |
  105145. * | --- | --- | --- |
  105146. * | 0 | ALPHA_DISABLE | |
  105147. * | 1 | ALPHA_ADD | |
  105148. * | 2 | ALPHA_COMBINE | |
  105149. * | 3 | ALPHA_SUBTRACT | |
  105150. * | 4 | ALPHA_MULTIPLY | |
  105151. * | 5 | ALPHA_MAXIMIZED | |
  105152. * | 6 | ALPHA_ONEONE | |
  105153. * | 7 | ALPHA_PREMULTIPLIED | |
  105154. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  105155. * | 9 | ALPHA_INTERPOLATE | |
  105156. * | 10 | ALPHA_SCREENMODE | |
  105157. *
  105158. */
  105159. set alphaMode(value: number);
  105160. /**
  105161. * Gets the value of the alpha mode
  105162. */
  105163. get alphaMode(): number;
  105164. /**
  105165. * Stores the state of the need depth pre-pass value
  105166. */
  105167. private _needDepthPrePass;
  105168. /**
  105169. * Sets the need depth pre-pass value
  105170. */
  105171. set needDepthPrePass(value: boolean);
  105172. /**
  105173. * Gets the depth pre-pass value
  105174. */
  105175. get needDepthPrePass(): boolean;
  105176. /**
  105177. * Specifies if depth writing should be disabled
  105178. */
  105179. disableDepthWrite: boolean;
  105180. /**
  105181. * Specifies if color writing should be disabled
  105182. */
  105183. disableColorWrite: boolean;
  105184. /**
  105185. * Specifies if depth writing should be forced
  105186. */
  105187. forceDepthWrite: boolean;
  105188. /**
  105189. * Specifies the depth function that should be used. 0 means the default engine function
  105190. */
  105191. depthFunction: number;
  105192. /**
  105193. * Specifies if there should be a separate pass for culling
  105194. */
  105195. separateCullingPass: boolean;
  105196. /**
  105197. * Stores the state specifing if fog should be enabled
  105198. */
  105199. private _fogEnabled;
  105200. /**
  105201. * Sets the state for enabling fog
  105202. */
  105203. set fogEnabled(value: boolean);
  105204. /**
  105205. * Gets the value of the fog enabled state
  105206. */
  105207. get fogEnabled(): boolean;
  105208. /**
  105209. * Stores the size of points
  105210. */
  105211. pointSize: number;
  105212. /**
  105213. * Stores the z offset value
  105214. */
  105215. zOffset: number;
  105216. get wireframe(): boolean;
  105217. /**
  105218. * Sets the state of wireframe mode
  105219. */
  105220. set wireframe(value: boolean);
  105221. /**
  105222. * Gets the value specifying if point clouds are enabled
  105223. */
  105224. get pointsCloud(): boolean;
  105225. /**
  105226. * Sets the state of point cloud mode
  105227. */
  105228. set pointsCloud(value: boolean);
  105229. /**
  105230. * Gets the material fill mode
  105231. */
  105232. get fillMode(): number;
  105233. /**
  105234. * Sets the material fill mode
  105235. */
  105236. set fillMode(value: number);
  105237. /**
  105238. * @hidden
  105239. * Stores the effects for the material
  105240. */
  105241. _effect: Nullable<Effect>;
  105242. /**
  105243. * Specifies if uniform buffers should be used
  105244. */
  105245. private _useUBO;
  105246. /**
  105247. * Stores a reference to the scene
  105248. */
  105249. private _scene;
  105250. /**
  105251. * Stores the fill mode state
  105252. */
  105253. private _fillMode;
  105254. /**
  105255. * Specifies if the depth write state should be cached
  105256. */
  105257. private _cachedDepthWriteState;
  105258. /**
  105259. * Specifies if the color write state should be cached
  105260. */
  105261. private _cachedColorWriteState;
  105262. /**
  105263. * Specifies if the depth function state should be cached
  105264. */
  105265. private _cachedDepthFunctionState;
  105266. /**
  105267. * Stores the uniform buffer
  105268. */
  105269. protected _uniformBuffer: UniformBuffer;
  105270. /** @hidden */
  105271. _indexInSceneMaterialArray: number;
  105272. /** @hidden */
  105273. meshMap: Nullable<{
  105274. [id: string]: AbstractMesh | undefined;
  105275. }>;
  105276. /**
  105277. * Creates a material instance
  105278. * @param name defines the name of the material
  105279. * @param scene defines the scene to reference
  105280. * @param doNotAdd specifies if the material should be added to the scene
  105281. */
  105282. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  105283. /**
  105284. * Returns a string representation of the current material
  105285. * @param fullDetails defines a boolean indicating which levels of logging is desired
  105286. * @returns a string with material information
  105287. */
  105288. toString(fullDetails?: boolean): string;
  105289. /**
  105290. * Gets the class name of the material
  105291. * @returns a string with the class name of the material
  105292. */
  105293. getClassName(): string;
  105294. /**
  105295. * Specifies if updates for the material been locked
  105296. */
  105297. get isFrozen(): boolean;
  105298. /**
  105299. * Locks updates for the material
  105300. */
  105301. freeze(): void;
  105302. /**
  105303. * Unlocks updates for the material
  105304. */
  105305. unfreeze(): void;
  105306. /**
  105307. * Specifies if the material is ready to be used
  105308. * @param mesh defines the mesh to check
  105309. * @param useInstances specifies if instances should be used
  105310. * @returns a boolean indicating if the material is ready to be used
  105311. */
  105312. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  105313. /**
  105314. * Specifies that the submesh is ready to be used
  105315. * @param mesh defines the mesh to check
  105316. * @param subMesh defines which submesh to check
  105317. * @param useInstances specifies that instances should be used
  105318. * @returns a boolean indicating that the submesh is ready or not
  105319. */
  105320. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  105321. /**
  105322. * Returns the material effect
  105323. * @returns the effect associated with the material
  105324. */
  105325. getEffect(): Nullable<Effect>;
  105326. /**
  105327. * Returns the current scene
  105328. * @returns a Scene
  105329. */
  105330. getScene(): Scene;
  105331. /**
  105332. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  105333. */
  105334. protected _forceAlphaTest: boolean;
  105335. /**
  105336. * The transparency mode of the material.
  105337. */
  105338. protected _transparencyMode: Nullable<number>;
  105339. /**
  105340. * Gets the current transparency mode.
  105341. */
  105342. get transparencyMode(): Nullable<number>;
  105343. /**
  105344. * Sets the transparency mode of the material.
  105345. *
  105346. * | Value | Type | Description |
  105347. * | ----- | ----------------------------------- | ----------- |
  105348. * | 0 | OPAQUE | |
  105349. * | 1 | ALPHATEST | |
  105350. * | 2 | ALPHABLEND | |
  105351. * | 3 | ALPHATESTANDBLEND | |
  105352. *
  105353. */
  105354. set transparencyMode(value: Nullable<number>);
  105355. /**
  105356. * Returns true if alpha blending should be disabled.
  105357. */
  105358. protected get _disableAlphaBlending(): boolean;
  105359. /**
  105360. * Specifies whether or not this material should be rendered in alpha blend mode.
  105361. * @returns a boolean specifying if alpha blending is needed
  105362. */
  105363. needAlphaBlending(): boolean;
  105364. /**
  105365. * Specifies if the mesh will require alpha blending
  105366. * @param mesh defines the mesh to check
  105367. * @returns a boolean specifying if alpha blending is needed for the mesh
  105368. */
  105369. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  105370. /**
  105371. * Specifies whether or not this material should be rendered in alpha test mode.
  105372. * @returns a boolean specifying if an alpha test is needed.
  105373. */
  105374. needAlphaTesting(): boolean;
  105375. /**
  105376. * Specifies if material alpha testing should be turned on for the mesh
  105377. * @param mesh defines the mesh to check
  105378. */
  105379. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  105380. /**
  105381. * Gets the texture used for the alpha test
  105382. * @returns the texture to use for alpha testing
  105383. */
  105384. getAlphaTestTexture(): Nullable<BaseTexture>;
  105385. /**
  105386. * Marks the material to indicate that it needs to be re-calculated
  105387. */
  105388. markDirty(): void;
  105389. /** @hidden */
  105390. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  105391. /**
  105392. * Binds the material to the mesh
  105393. * @param world defines the world transformation matrix
  105394. * @param mesh defines the mesh to bind the material to
  105395. */
  105396. bind(world: Matrix, mesh?: Mesh): void;
  105397. /**
  105398. * Binds the submesh to the material
  105399. * @param world defines the world transformation matrix
  105400. * @param mesh defines the mesh containing the submesh
  105401. * @param subMesh defines the submesh to bind the material to
  105402. */
  105403. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  105404. /**
  105405. * Binds the world matrix to the material
  105406. * @param world defines the world transformation matrix
  105407. */
  105408. bindOnlyWorldMatrix(world: Matrix): void;
  105409. /**
  105410. * Binds the scene's uniform buffer to the effect.
  105411. * @param effect defines the effect to bind to the scene uniform buffer
  105412. * @param sceneUbo defines the uniform buffer storing scene data
  105413. */
  105414. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  105415. /**
  105416. * Binds the view matrix to the effect
  105417. * @param effect defines the effect to bind the view matrix to
  105418. */
  105419. bindView(effect: Effect): void;
  105420. /**
  105421. * Binds the view projection matrix to the effect
  105422. * @param effect defines the effect to bind the view projection matrix to
  105423. */
  105424. bindViewProjection(effect: Effect): void;
  105425. /**
  105426. * Processes to execute after binding the material to a mesh
  105427. * @param mesh defines the rendered mesh
  105428. */
  105429. protected _afterBind(mesh?: Mesh): void;
  105430. /**
  105431. * Unbinds the material from the mesh
  105432. */
  105433. unbind(): void;
  105434. /**
  105435. * Gets the active textures from the material
  105436. * @returns an array of textures
  105437. */
  105438. getActiveTextures(): BaseTexture[];
  105439. /**
  105440. * Specifies if the material uses a texture
  105441. * @param texture defines the texture to check against the material
  105442. * @returns a boolean specifying if the material uses the texture
  105443. */
  105444. hasTexture(texture: BaseTexture): boolean;
  105445. /**
  105446. * Makes a duplicate of the material, and gives it a new name
  105447. * @param name defines the new name for the duplicated material
  105448. * @returns the cloned material
  105449. */
  105450. clone(name: string): Nullable<Material>;
  105451. /**
  105452. * Gets the meshes bound to the material
  105453. * @returns an array of meshes bound to the material
  105454. */
  105455. getBindedMeshes(): AbstractMesh[];
  105456. /**
  105457. * Force shader compilation
  105458. * @param mesh defines the mesh associated with this material
  105459. * @param onCompiled defines a function to execute once the material is compiled
  105460. * @param options defines the options to configure the compilation
  105461. * @param onError defines a function to execute if the material fails compiling
  105462. */
  105463. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  105464. /**
  105465. * Force shader compilation
  105466. * @param mesh defines the mesh that will use this material
  105467. * @param options defines additional options for compiling the shaders
  105468. * @returns a promise that resolves when the compilation completes
  105469. */
  105470. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  105471. private static readonly _AllDirtyCallBack;
  105472. private static readonly _ImageProcessingDirtyCallBack;
  105473. private static readonly _TextureDirtyCallBack;
  105474. private static readonly _FresnelDirtyCallBack;
  105475. private static readonly _MiscDirtyCallBack;
  105476. private static readonly _LightsDirtyCallBack;
  105477. private static readonly _AttributeDirtyCallBack;
  105478. private static _FresnelAndMiscDirtyCallBack;
  105479. private static _TextureAndMiscDirtyCallBack;
  105480. private static readonly _DirtyCallbackArray;
  105481. private static readonly _RunDirtyCallBacks;
  105482. /**
  105483. * Marks a define in the material to indicate that it needs to be re-computed
  105484. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  105485. */
  105486. markAsDirty(flag: number): void;
  105487. /**
  105488. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  105489. * @param func defines a function which checks material defines against the submeshes
  105490. */
  105491. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  105492. /**
  105493. * Indicates that the scene should check if the rendering now needs a prepass
  105494. */
  105495. protected _markScenePrePassDirty(): void;
  105496. /**
  105497. * Indicates that we need to re-calculated for all submeshes
  105498. */
  105499. protected _markAllSubMeshesAsAllDirty(): void;
  105500. /**
  105501. * Indicates that image processing needs to be re-calculated for all submeshes
  105502. */
  105503. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  105504. /**
  105505. * Indicates that textures need to be re-calculated for all submeshes
  105506. */
  105507. protected _markAllSubMeshesAsTexturesDirty(): void;
  105508. /**
  105509. * Indicates that fresnel needs to be re-calculated for all submeshes
  105510. */
  105511. protected _markAllSubMeshesAsFresnelDirty(): void;
  105512. /**
  105513. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  105514. */
  105515. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  105516. /**
  105517. * Indicates that lights need to be re-calculated for all submeshes
  105518. */
  105519. protected _markAllSubMeshesAsLightsDirty(): void;
  105520. /**
  105521. * Indicates that attributes need to be re-calculated for all submeshes
  105522. */
  105523. protected _markAllSubMeshesAsAttributesDirty(): void;
  105524. /**
  105525. * Indicates that misc needs to be re-calculated for all submeshes
  105526. */
  105527. protected _markAllSubMeshesAsMiscDirty(): void;
  105528. /**
  105529. * Indicates that textures and misc need to be re-calculated for all submeshes
  105530. */
  105531. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  105532. /**
  105533. * Sets the required values to the prepass renderer.
  105534. * @param prePassRenderer defines the prepass renderer to setup.
  105535. * @returns true if the pre pass is needed.
  105536. */
  105537. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  105538. /**
  105539. * Disposes the material
  105540. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  105541. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  105542. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  105543. */
  105544. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  105545. /** @hidden */
  105546. private releaseVertexArrayObject;
  105547. /**
  105548. * Serializes this material
  105549. * @returns the serialized material object
  105550. */
  105551. serialize(): any;
  105552. /**
  105553. * Creates a material from parsed material data
  105554. * @param parsedMaterial defines parsed material data
  105555. * @param scene defines the hosting scene
  105556. * @param rootUrl defines the root URL to use to load textures
  105557. * @returns a new material
  105558. */
  105559. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  105560. }
  105561. }
  105562. declare module BABYLON {
  105563. /**
  105564. * A multi-material is used to apply different materials to different parts of the same object without the need of
  105565. * separate meshes. This can be use to improve performances.
  105566. * @see https://doc.babylonjs.com/how_to/multi_materials
  105567. */
  105568. export class MultiMaterial extends Material {
  105569. private _subMaterials;
  105570. /**
  105571. * Gets or Sets the list of Materials used within the multi material.
  105572. * They need to be ordered according to the submeshes order in the associated mesh
  105573. */
  105574. get subMaterials(): Nullable<Material>[];
  105575. set subMaterials(value: Nullable<Material>[]);
  105576. /**
  105577. * Function used to align with Node.getChildren()
  105578. * @returns the list of Materials used within the multi material
  105579. */
  105580. getChildren(): Nullable<Material>[];
  105581. /**
  105582. * Instantiates a new Multi Material
  105583. * A multi-material is used to apply different materials to different parts of the same object without the need of
  105584. * separate meshes. This can be use to improve performances.
  105585. * @see https://doc.babylonjs.com/how_to/multi_materials
  105586. * @param name Define the name in the scene
  105587. * @param scene Define the scene the material belongs to
  105588. */
  105589. constructor(name: string, scene: Scene);
  105590. private _hookArray;
  105591. /**
  105592. * Get one of the submaterial by its index in the submaterials array
  105593. * @param index The index to look the sub material at
  105594. * @returns The Material if the index has been defined
  105595. */
  105596. getSubMaterial(index: number): Nullable<Material>;
  105597. /**
  105598. * Get the list of active textures for the whole sub materials list.
  105599. * @returns All the textures that will be used during the rendering
  105600. */
  105601. getActiveTextures(): BaseTexture[];
  105602. /**
  105603. * Gets the current class name of the material e.g. "MultiMaterial"
  105604. * Mainly use in serialization.
  105605. * @returns the class name
  105606. */
  105607. getClassName(): string;
  105608. /**
  105609. * Checks if the material is ready to render the requested sub mesh
  105610. * @param mesh Define the mesh the submesh belongs to
  105611. * @param subMesh Define the sub mesh to look readyness for
  105612. * @param useInstances Define whether or not the material is used with instances
  105613. * @returns true if ready, otherwise false
  105614. */
  105615. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  105616. /**
  105617. * Clones the current material and its related sub materials
  105618. * @param name Define the name of the newly cloned material
  105619. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  105620. * @returns the cloned material
  105621. */
  105622. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  105623. /**
  105624. * Serializes the materials into a JSON representation.
  105625. * @returns the JSON representation
  105626. */
  105627. serialize(): any;
  105628. /**
  105629. * Dispose the material and release its associated resources
  105630. * @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)
  105631. * @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)
  105632. * @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)
  105633. */
  105634. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  105635. /**
  105636. * Creates a MultiMaterial from parsed MultiMaterial data.
  105637. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  105638. * @param scene defines the hosting scene
  105639. * @returns a new MultiMaterial
  105640. */
  105641. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  105642. }
  105643. }
  105644. declare module BABYLON {
  105645. /**
  105646. * Defines a subdivision inside a mesh
  105647. */
  105648. export class SubMesh implements ICullable {
  105649. /** the material index to use */
  105650. materialIndex: number;
  105651. /** vertex index start */
  105652. verticesStart: number;
  105653. /** vertices count */
  105654. verticesCount: number;
  105655. /** index start */
  105656. indexStart: number;
  105657. /** indices count */
  105658. indexCount: number;
  105659. /** @hidden */
  105660. _materialDefines: Nullable<MaterialDefines>;
  105661. /** @hidden */
  105662. _materialEffect: Nullable<Effect>;
  105663. /** @hidden */
  105664. _effectOverride: Nullable<Effect>;
  105665. /**
  105666. * Gets material defines used by the effect associated to the sub mesh
  105667. */
  105668. get materialDefines(): Nullable<MaterialDefines>;
  105669. /**
  105670. * Sets material defines used by the effect associated to the sub mesh
  105671. */
  105672. set materialDefines(defines: Nullable<MaterialDefines>);
  105673. /**
  105674. * Gets associated effect
  105675. */
  105676. get effect(): Nullable<Effect>;
  105677. /**
  105678. * Sets associated effect (effect used to render this submesh)
  105679. * @param effect defines the effect to associate with
  105680. * @param defines defines the set of defines used to compile this effect
  105681. */
  105682. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  105683. /** @hidden */
  105684. _linesIndexCount: number;
  105685. private _mesh;
  105686. private _renderingMesh;
  105687. private _boundingInfo;
  105688. private _linesIndexBuffer;
  105689. /** @hidden */
  105690. _lastColliderWorldVertices: Nullable<Vector3[]>;
  105691. /** @hidden */
  105692. _trianglePlanes: Plane[];
  105693. /** @hidden */
  105694. _lastColliderTransformMatrix: Nullable<Matrix>;
  105695. /** @hidden */
  105696. _renderId: number;
  105697. /** @hidden */
  105698. _alphaIndex: number;
  105699. /** @hidden */
  105700. _distanceToCamera: number;
  105701. /** @hidden */
  105702. _id: number;
  105703. private _currentMaterial;
  105704. /**
  105705. * Add a new submesh to a mesh
  105706. * @param materialIndex defines the material index to use
  105707. * @param verticesStart defines vertex index start
  105708. * @param verticesCount defines vertices count
  105709. * @param indexStart defines index start
  105710. * @param indexCount defines indices count
  105711. * @param mesh defines the parent mesh
  105712. * @param renderingMesh defines an optional rendering mesh
  105713. * @param createBoundingBox defines if bounding box should be created for this submesh
  105714. * @returns the new submesh
  105715. */
  105716. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  105717. /**
  105718. * Creates a new submesh
  105719. * @param materialIndex defines the material index to use
  105720. * @param verticesStart defines vertex index start
  105721. * @param verticesCount defines vertices count
  105722. * @param indexStart defines index start
  105723. * @param indexCount defines indices count
  105724. * @param mesh defines the parent mesh
  105725. * @param renderingMesh defines an optional rendering mesh
  105726. * @param createBoundingBox defines if bounding box should be created for this submesh
  105727. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  105728. */
  105729. constructor(
  105730. /** the material index to use */
  105731. materialIndex: number,
  105732. /** vertex index start */
  105733. verticesStart: number,
  105734. /** vertices count */
  105735. verticesCount: number,
  105736. /** index start */
  105737. indexStart: number,
  105738. /** indices count */
  105739. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  105740. /**
  105741. * Returns true if this submesh covers the entire parent mesh
  105742. * @ignorenaming
  105743. */
  105744. get IsGlobal(): boolean;
  105745. /**
  105746. * Returns the submesh BoudingInfo object
  105747. * @returns current bounding info (or mesh's one if the submesh is global)
  105748. */
  105749. getBoundingInfo(): BoundingInfo;
  105750. /**
  105751. * Sets the submesh BoundingInfo
  105752. * @param boundingInfo defines the new bounding info to use
  105753. * @returns the SubMesh
  105754. */
  105755. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  105756. /**
  105757. * Returns the mesh of the current submesh
  105758. * @return the parent mesh
  105759. */
  105760. getMesh(): AbstractMesh;
  105761. /**
  105762. * Returns the rendering mesh of the submesh
  105763. * @returns the rendering mesh (could be different from parent mesh)
  105764. */
  105765. getRenderingMesh(): Mesh;
  105766. /**
  105767. * Returns the replacement mesh of the submesh
  105768. * @returns the replacement mesh (could be different from parent mesh)
  105769. */
  105770. getReplacementMesh(): Nullable<AbstractMesh>;
  105771. /**
  105772. * Returns the effective mesh of the submesh
  105773. * @returns the effective mesh (could be different from parent mesh)
  105774. */
  105775. getEffectiveMesh(): AbstractMesh;
  105776. /**
  105777. * Returns the submesh material
  105778. * @returns null or the current material
  105779. */
  105780. getMaterial(): Nullable<Material>;
  105781. private _IsMultiMaterial;
  105782. /**
  105783. * Sets a new updated BoundingInfo object to the submesh
  105784. * @param data defines an optional position array to use to determine the bounding info
  105785. * @returns the SubMesh
  105786. */
  105787. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  105788. /** @hidden */
  105789. _checkCollision(collider: Collider): boolean;
  105790. /**
  105791. * Updates the submesh BoundingInfo
  105792. * @param world defines the world matrix to use to update the bounding info
  105793. * @returns the submesh
  105794. */
  105795. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  105796. /**
  105797. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  105798. * @param frustumPlanes defines the frustum planes
  105799. * @returns true if the submesh is intersecting with the frustum
  105800. */
  105801. isInFrustum(frustumPlanes: Plane[]): boolean;
  105802. /**
  105803. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  105804. * @param frustumPlanes defines the frustum planes
  105805. * @returns true if the submesh is inside the frustum
  105806. */
  105807. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  105808. /**
  105809. * Renders the submesh
  105810. * @param enableAlphaMode defines if alpha needs to be used
  105811. * @returns the submesh
  105812. */
  105813. render(enableAlphaMode: boolean): SubMesh;
  105814. /**
  105815. * @hidden
  105816. */
  105817. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  105818. /**
  105819. * Checks if the submesh intersects with a ray
  105820. * @param ray defines the ray to test
  105821. * @returns true is the passed ray intersects the submesh bounding box
  105822. */
  105823. canIntersects(ray: Ray): boolean;
  105824. /**
  105825. * Intersects current submesh with a ray
  105826. * @param ray defines the ray to test
  105827. * @param positions defines mesh's positions array
  105828. * @param indices defines mesh's indices array
  105829. * @param fastCheck defines if the first intersection will be used (and not the closest)
  105830. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  105831. * @returns intersection info or null if no intersection
  105832. */
  105833. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  105834. /** @hidden */
  105835. private _intersectLines;
  105836. /** @hidden */
  105837. private _intersectUnIndexedLines;
  105838. /** @hidden */
  105839. private _intersectTriangles;
  105840. /** @hidden */
  105841. private _intersectUnIndexedTriangles;
  105842. /** @hidden */
  105843. _rebuild(): void;
  105844. /**
  105845. * Creates a new submesh from the passed mesh
  105846. * @param newMesh defines the new hosting mesh
  105847. * @param newRenderingMesh defines an optional rendering mesh
  105848. * @returns the new submesh
  105849. */
  105850. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  105851. /**
  105852. * Release associated resources
  105853. */
  105854. dispose(): void;
  105855. /**
  105856. * Gets the class name
  105857. * @returns the string "SubMesh".
  105858. */
  105859. getClassName(): string;
  105860. /**
  105861. * Creates a new submesh from indices data
  105862. * @param materialIndex the index of the main mesh material
  105863. * @param startIndex the index where to start the copy in the mesh indices array
  105864. * @param indexCount the number of indices to copy then from the startIndex
  105865. * @param mesh the main mesh to create the submesh from
  105866. * @param renderingMesh the optional rendering mesh
  105867. * @returns a new submesh
  105868. */
  105869. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  105870. }
  105871. }
  105872. declare module BABYLON {
  105873. /**
  105874. * Class used to represent data loading progression
  105875. */
  105876. export class SceneLoaderFlags {
  105877. private static _ForceFullSceneLoadingForIncremental;
  105878. private static _ShowLoadingScreen;
  105879. private static _CleanBoneMatrixWeights;
  105880. private static _loggingLevel;
  105881. /**
  105882. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  105883. */
  105884. static get ForceFullSceneLoadingForIncremental(): boolean;
  105885. static set ForceFullSceneLoadingForIncremental(value: boolean);
  105886. /**
  105887. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  105888. */
  105889. static get ShowLoadingScreen(): boolean;
  105890. static set ShowLoadingScreen(value: boolean);
  105891. /**
  105892. * Defines the current logging level (while loading the scene)
  105893. * @ignorenaming
  105894. */
  105895. static get loggingLevel(): number;
  105896. static set loggingLevel(value: number);
  105897. /**
  105898. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  105899. */
  105900. static get CleanBoneMatrixWeights(): boolean;
  105901. static set CleanBoneMatrixWeights(value: boolean);
  105902. }
  105903. }
  105904. declare module BABYLON {
  105905. /**
  105906. * Class used to store geometry data (vertex buffers + index buffer)
  105907. */
  105908. export class Geometry implements IGetSetVerticesData {
  105909. /**
  105910. * Gets or sets the ID of the geometry
  105911. */
  105912. id: string;
  105913. /**
  105914. * Gets or sets the unique ID of the geometry
  105915. */
  105916. uniqueId: number;
  105917. /**
  105918. * Gets the delay loading state of the geometry (none by default which means not delayed)
  105919. */
  105920. delayLoadState: number;
  105921. /**
  105922. * Gets the file containing the data to load when running in delay load state
  105923. */
  105924. delayLoadingFile: Nullable<string>;
  105925. /**
  105926. * Callback called when the geometry is updated
  105927. */
  105928. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  105929. private _scene;
  105930. private _engine;
  105931. private _meshes;
  105932. private _totalVertices;
  105933. /** @hidden */
  105934. _indices: IndicesArray;
  105935. /** @hidden */
  105936. _vertexBuffers: {
  105937. [key: string]: VertexBuffer;
  105938. };
  105939. private _isDisposed;
  105940. private _extend;
  105941. private _boundingBias;
  105942. /** @hidden */
  105943. _delayInfo: Array<string>;
  105944. private _indexBuffer;
  105945. private _indexBufferIsUpdatable;
  105946. /** @hidden */
  105947. _boundingInfo: Nullable<BoundingInfo>;
  105948. /** @hidden */
  105949. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  105950. /** @hidden */
  105951. _softwareSkinningFrameId: number;
  105952. private _vertexArrayObjects;
  105953. private _updatable;
  105954. /** @hidden */
  105955. _positions: Nullable<Vector3[]>;
  105956. /**
  105957. * 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
  105958. */
  105959. get boundingBias(): Vector2;
  105960. /**
  105961. * 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
  105962. */
  105963. set boundingBias(value: Vector2);
  105964. /**
  105965. * Static function used to attach a new empty geometry to a mesh
  105966. * @param mesh defines the mesh to attach the geometry to
  105967. * @returns the new Geometry
  105968. */
  105969. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  105970. /** Get the list of meshes using this geometry */
  105971. get meshes(): Mesh[];
  105972. /**
  105973. * 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
  105974. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  105975. */
  105976. useBoundingInfoFromGeometry: boolean;
  105977. /**
  105978. * Creates a new geometry
  105979. * @param id defines the unique ID
  105980. * @param scene defines the hosting scene
  105981. * @param vertexData defines the VertexData used to get geometry data
  105982. * @param updatable defines if geometry must be updatable (false by default)
  105983. * @param mesh defines the mesh that will be associated with the geometry
  105984. */
  105985. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  105986. /**
  105987. * Gets the current extend of the geometry
  105988. */
  105989. get extend(): {
  105990. minimum: Vector3;
  105991. maximum: Vector3;
  105992. };
  105993. /**
  105994. * Gets the hosting scene
  105995. * @returns the hosting Scene
  105996. */
  105997. getScene(): Scene;
  105998. /**
  105999. * Gets the hosting engine
  106000. * @returns the hosting Engine
  106001. */
  106002. getEngine(): Engine;
  106003. /**
  106004. * Defines if the geometry is ready to use
  106005. * @returns true if the geometry is ready to be used
  106006. */
  106007. isReady(): boolean;
  106008. /**
  106009. * Gets a value indicating that the geometry should not be serialized
  106010. */
  106011. get doNotSerialize(): boolean;
  106012. /** @hidden */
  106013. _rebuild(): void;
  106014. /**
  106015. * Affects all geometry data in one call
  106016. * @param vertexData defines the geometry data
  106017. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  106018. */
  106019. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  106020. /**
  106021. * Set specific vertex data
  106022. * @param kind defines the data kind (Position, normal, etc...)
  106023. * @param data defines the vertex data to use
  106024. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  106025. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  106026. */
  106027. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  106028. /**
  106029. * Removes a specific vertex data
  106030. * @param kind defines the data kind (Position, normal, etc...)
  106031. */
  106032. removeVerticesData(kind: string): void;
  106033. /**
  106034. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  106035. * @param buffer defines the vertex buffer to use
  106036. * @param totalVertices defines the total number of vertices for position kind (could be null)
  106037. */
  106038. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  106039. /**
  106040. * Update a specific vertex buffer
  106041. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  106042. * It will do nothing if the buffer is not updatable
  106043. * @param kind defines the data kind (Position, normal, etc...)
  106044. * @param data defines the data to use
  106045. * @param offset defines the offset in the target buffer where to store the data
  106046. * @param useBytes set to true if the offset is in bytes
  106047. */
  106048. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  106049. /**
  106050. * Update a specific vertex buffer
  106051. * This function will create a new buffer if the current one is not updatable
  106052. * @param kind defines the data kind (Position, normal, etc...)
  106053. * @param data defines the data to use
  106054. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  106055. */
  106056. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  106057. private _updateBoundingInfo;
  106058. /** @hidden */
  106059. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  106060. /**
  106061. * Gets total number of vertices
  106062. * @returns the total number of vertices
  106063. */
  106064. getTotalVertices(): number;
  106065. /**
  106066. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  106067. * @param kind defines the data kind (Position, normal, etc...)
  106068. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  106069. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  106070. * @returns a float array containing vertex data
  106071. */
  106072. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  106073. /**
  106074. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  106075. * @param kind defines the data kind (Position, normal, etc...)
  106076. * @returns true if the vertex buffer with the specified kind is updatable
  106077. */
  106078. isVertexBufferUpdatable(kind: string): boolean;
  106079. /**
  106080. * Gets a specific vertex buffer
  106081. * @param kind defines the data kind (Position, normal, etc...)
  106082. * @returns a VertexBuffer
  106083. */
  106084. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  106085. /**
  106086. * Returns all vertex buffers
  106087. * @return an object holding all vertex buffers indexed by kind
  106088. */
  106089. getVertexBuffers(): Nullable<{
  106090. [key: string]: VertexBuffer;
  106091. }>;
  106092. /**
  106093. * Gets a boolean indicating if specific vertex buffer is present
  106094. * @param kind defines the data kind (Position, normal, etc...)
  106095. * @returns true if data is present
  106096. */
  106097. isVerticesDataPresent(kind: string): boolean;
  106098. /**
  106099. * Gets a list of all attached data kinds (Position, normal, etc...)
  106100. * @returns a list of string containing all kinds
  106101. */
  106102. getVerticesDataKinds(): string[];
  106103. /**
  106104. * Update index buffer
  106105. * @param indices defines the indices to store in the index buffer
  106106. * @param offset defines the offset in the target buffer where to store the data
  106107. * @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)
  106108. */
  106109. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  106110. /**
  106111. * Creates a new index buffer
  106112. * @param indices defines the indices to store in the index buffer
  106113. * @param totalVertices defines the total number of vertices (could be null)
  106114. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  106115. */
  106116. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  106117. /**
  106118. * Return the total number of indices
  106119. * @returns the total number of indices
  106120. */
  106121. getTotalIndices(): number;
  106122. /**
  106123. * Gets the index buffer array
  106124. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  106125. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  106126. * @returns the index buffer array
  106127. */
  106128. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  106129. /**
  106130. * Gets the index buffer
  106131. * @return the index buffer
  106132. */
  106133. getIndexBuffer(): Nullable<DataBuffer>;
  106134. /** @hidden */
  106135. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  106136. /**
  106137. * Release the associated resources for a specific mesh
  106138. * @param mesh defines the source mesh
  106139. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  106140. */
  106141. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  106142. /**
  106143. * Apply current geometry to a given mesh
  106144. * @param mesh defines the mesh to apply geometry to
  106145. */
  106146. applyToMesh(mesh: Mesh): void;
  106147. private _updateExtend;
  106148. private _applyToMesh;
  106149. private notifyUpdate;
  106150. /**
  106151. * Load the geometry if it was flagged as delay loaded
  106152. * @param scene defines the hosting scene
  106153. * @param onLoaded defines a callback called when the geometry is loaded
  106154. */
  106155. load(scene: Scene, onLoaded?: () => void): void;
  106156. private _queueLoad;
  106157. /**
  106158. * Invert the geometry to move from a right handed system to a left handed one.
  106159. */
  106160. toLeftHanded(): void;
  106161. /** @hidden */
  106162. _resetPointsArrayCache(): void;
  106163. /** @hidden */
  106164. _generatePointsArray(): boolean;
  106165. /**
  106166. * Gets a value indicating if the geometry is disposed
  106167. * @returns true if the geometry was disposed
  106168. */
  106169. isDisposed(): boolean;
  106170. private _disposeVertexArrayObjects;
  106171. /**
  106172. * Free all associated resources
  106173. */
  106174. dispose(): void;
  106175. /**
  106176. * Clone the current geometry into a new geometry
  106177. * @param id defines the unique ID of the new geometry
  106178. * @returns a new geometry object
  106179. */
  106180. copy(id: string): Geometry;
  106181. /**
  106182. * Serialize the current geometry info (and not the vertices data) into a JSON object
  106183. * @return a JSON representation of the current geometry data (without the vertices data)
  106184. */
  106185. serialize(): any;
  106186. private toNumberArray;
  106187. /**
  106188. * Serialize all vertices data into a JSON oject
  106189. * @returns a JSON representation of the current geometry data
  106190. */
  106191. serializeVerticeData(): any;
  106192. /**
  106193. * Extracts a clone of a mesh geometry
  106194. * @param mesh defines the source mesh
  106195. * @param id defines the unique ID of the new geometry object
  106196. * @returns the new geometry object
  106197. */
  106198. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  106199. /**
  106200. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  106201. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  106202. * Be aware Math.random() could cause collisions, but:
  106203. * "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"
  106204. * @returns a string containing a new GUID
  106205. */
  106206. static RandomId(): string;
  106207. /** @hidden */
  106208. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  106209. private static _CleanMatricesWeights;
  106210. /**
  106211. * Create a new geometry from persisted data (Using .babylon file format)
  106212. * @param parsedVertexData defines the persisted data
  106213. * @param scene defines the hosting scene
  106214. * @param rootUrl defines the root url to use to load assets (like delayed data)
  106215. * @returns the new geometry object
  106216. */
  106217. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  106218. }
  106219. }
  106220. declare module BABYLON {
  106221. /**
  106222. * Define an interface for all classes that will get and set the data on vertices
  106223. */
  106224. export interface IGetSetVerticesData {
  106225. /**
  106226. * Gets a boolean indicating if specific vertex data is present
  106227. * @param kind defines the vertex data kind to use
  106228. * @returns true is data kind is present
  106229. */
  106230. isVerticesDataPresent(kind: string): boolean;
  106231. /**
  106232. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  106233. * @param kind defines the data kind (Position, normal, etc...)
  106234. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  106235. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  106236. * @returns a float array containing vertex data
  106237. */
  106238. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  106239. /**
  106240. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  106241. * @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.
  106242. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  106243. * @returns the indices array or an empty array if the mesh has no geometry
  106244. */
  106245. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  106246. /**
  106247. * Set specific vertex data
  106248. * @param kind defines the data kind (Position, normal, etc...)
  106249. * @param data defines the vertex data to use
  106250. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  106251. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  106252. */
  106253. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  106254. /**
  106255. * Update a specific associated vertex buffer
  106256. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  106257. * - VertexBuffer.PositionKind
  106258. * - VertexBuffer.UVKind
  106259. * - VertexBuffer.UV2Kind
  106260. * - VertexBuffer.UV3Kind
  106261. * - VertexBuffer.UV4Kind
  106262. * - VertexBuffer.UV5Kind
  106263. * - VertexBuffer.UV6Kind
  106264. * - VertexBuffer.ColorKind
  106265. * - VertexBuffer.MatricesIndicesKind
  106266. * - VertexBuffer.MatricesIndicesExtraKind
  106267. * - VertexBuffer.MatricesWeightsKind
  106268. * - VertexBuffer.MatricesWeightsExtraKind
  106269. * @param data defines the data source
  106270. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  106271. * @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)
  106272. */
  106273. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  106274. /**
  106275. * Creates a new index buffer
  106276. * @param indices defines the indices to store in the index buffer
  106277. * @param totalVertices defines the total number of vertices (could be null)
  106278. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  106279. */
  106280. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  106281. }
  106282. /**
  106283. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  106284. */
  106285. export class VertexData {
  106286. /**
  106287. * Mesh side orientation : usually the external or front surface
  106288. */
  106289. static readonly FRONTSIDE: number;
  106290. /**
  106291. * Mesh side orientation : usually the internal or back surface
  106292. */
  106293. static readonly BACKSIDE: number;
  106294. /**
  106295. * Mesh side orientation : both internal and external or front and back surfaces
  106296. */
  106297. static readonly DOUBLESIDE: number;
  106298. /**
  106299. * Mesh side orientation : by default, `FRONTSIDE`
  106300. */
  106301. static readonly DEFAULTSIDE: number;
  106302. /**
  106303. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  106304. */
  106305. positions: Nullable<FloatArray>;
  106306. /**
  106307. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  106308. */
  106309. normals: Nullable<FloatArray>;
  106310. /**
  106311. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  106312. */
  106313. tangents: Nullable<FloatArray>;
  106314. /**
  106315. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  106316. */
  106317. uvs: Nullable<FloatArray>;
  106318. /**
  106319. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  106320. */
  106321. uvs2: Nullable<FloatArray>;
  106322. /**
  106323. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  106324. */
  106325. uvs3: Nullable<FloatArray>;
  106326. /**
  106327. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  106328. */
  106329. uvs4: Nullable<FloatArray>;
  106330. /**
  106331. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  106332. */
  106333. uvs5: Nullable<FloatArray>;
  106334. /**
  106335. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  106336. */
  106337. uvs6: Nullable<FloatArray>;
  106338. /**
  106339. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  106340. */
  106341. colors: Nullable<FloatArray>;
  106342. /**
  106343. * 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).
  106344. */
  106345. matricesIndices: Nullable<FloatArray>;
  106346. /**
  106347. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  106348. */
  106349. matricesWeights: Nullable<FloatArray>;
  106350. /**
  106351. * An array extending the number of possible indices
  106352. */
  106353. matricesIndicesExtra: Nullable<FloatArray>;
  106354. /**
  106355. * An array extending the number of possible weights when the number of indices is extended
  106356. */
  106357. matricesWeightsExtra: Nullable<FloatArray>;
  106358. /**
  106359. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  106360. */
  106361. indices: Nullable<IndicesArray>;
  106362. /**
  106363. * Uses the passed data array to set the set the values for the specified kind of data
  106364. * @param data a linear array of floating numbers
  106365. * @param kind the type of data that is being set, eg positions, colors etc
  106366. */
  106367. set(data: FloatArray, kind: string): void;
  106368. /**
  106369. * Associates the vertexData to the passed Mesh.
  106370. * Sets it as updatable or not (default `false`)
  106371. * @param mesh the mesh the vertexData is applied to
  106372. * @param updatable when used and having the value true allows new data to update the vertexData
  106373. * @returns the VertexData
  106374. */
  106375. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  106376. /**
  106377. * Associates the vertexData to the passed Geometry.
  106378. * Sets it as updatable or not (default `false`)
  106379. * @param geometry the geometry the vertexData is applied to
  106380. * @param updatable when used and having the value true allows new data to update the vertexData
  106381. * @returns VertexData
  106382. */
  106383. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  106384. /**
  106385. * Updates the associated mesh
  106386. * @param mesh the mesh to be updated
  106387. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  106388. * @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
  106389. * @returns VertexData
  106390. */
  106391. updateMesh(mesh: Mesh): VertexData;
  106392. /**
  106393. * Updates the associated geometry
  106394. * @param geometry the geometry to be updated
  106395. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  106396. * @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
  106397. * @returns VertexData.
  106398. */
  106399. updateGeometry(geometry: Geometry): VertexData;
  106400. private _applyTo;
  106401. private _update;
  106402. /**
  106403. * Transforms each position and each normal of the vertexData according to the passed Matrix
  106404. * @param matrix the transforming matrix
  106405. * @returns the VertexData
  106406. */
  106407. transform(matrix: Matrix): VertexData;
  106408. /**
  106409. * Merges the passed VertexData into the current one
  106410. * @param other the VertexData to be merged into the current one
  106411. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  106412. * @returns the modified VertexData
  106413. */
  106414. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  106415. private _mergeElement;
  106416. private _validate;
  106417. /**
  106418. * Serializes the VertexData
  106419. * @returns a serialized object
  106420. */
  106421. serialize(): any;
  106422. /**
  106423. * Extracts the vertexData from a mesh
  106424. * @param mesh the mesh from which to extract the VertexData
  106425. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  106426. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  106427. * @returns the object VertexData associated to the passed mesh
  106428. */
  106429. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  106430. /**
  106431. * Extracts the vertexData from the geometry
  106432. * @param geometry the geometry from which to extract the VertexData
  106433. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  106434. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  106435. * @returns the object VertexData associated to the passed mesh
  106436. */
  106437. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  106438. private static _ExtractFrom;
  106439. /**
  106440. * Creates the VertexData for a Ribbon
  106441. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  106442. * * pathArray array of paths, each of which an array of successive Vector3
  106443. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  106444. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  106445. * * 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
  106446. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106447. * * 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)
  106448. * * 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)
  106449. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  106450. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  106451. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  106452. * @returns the VertexData of the ribbon
  106453. */
  106454. static CreateRibbon(options: {
  106455. pathArray: Vector3[][];
  106456. closeArray?: boolean;
  106457. closePath?: boolean;
  106458. offset?: number;
  106459. sideOrientation?: number;
  106460. frontUVs?: Vector4;
  106461. backUVs?: Vector4;
  106462. invertUV?: boolean;
  106463. uvs?: Vector2[];
  106464. colors?: Color4[];
  106465. }): VertexData;
  106466. /**
  106467. * Creates the VertexData for a box
  106468. * @param options an object used to set the following optional parameters for the box, required but can be empty
  106469. * * size sets the width, height and depth of the box to the value of size, optional default 1
  106470. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  106471. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  106472. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  106473. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  106474. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  106475. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106476. * * 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)
  106477. * * 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)
  106478. * @returns the VertexData of the box
  106479. */
  106480. static CreateBox(options: {
  106481. size?: number;
  106482. width?: number;
  106483. height?: number;
  106484. depth?: number;
  106485. faceUV?: Vector4[];
  106486. faceColors?: Color4[];
  106487. sideOrientation?: number;
  106488. frontUVs?: Vector4;
  106489. backUVs?: Vector4;
  106490. }): VertexData;
  106491. /**
  106492. * Creates the VertexData for a tiled box
  106493. * @param options an object used to set the following optional parameters for the box, required but can be empty
  106494. * * faceTiles sets the pattern, tile size and number of tiles for a face
  106495. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  106496. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  106497. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106498. * @returns the VertexData of the box
  106499. */
  106500. static CreateTiledBox(options: {
  106501. pattern?: number;
  106502. width?: number;
  106503. height?: number;
  106504. depth?: number;
  106505. tileSize?: number;
  106506. tileWidth?: number;
  106507. tileHeight?: number;
  106508. alignHorizontal?: number;
  106509. alignVertical?: number;
  106510. faceUV?: Vector4[];
  106511. faceColors?: Color4[];
  106512. sideOrientation?: number;
  106513. }): VertexData;
  106514. /**
  106515. * Creates the VertexData for a tiled plane
  106516. * @param options an object used to set the following optional parameters for the box, required but can be empty
  106517. * * pattern a limited pattern arrangement depending on the number
  106518. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  106519. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  106520. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  106521. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106522. * * 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)
  106523. * * 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)
  106524. * @returns the VertexData of the tiled plane
  106525. */
  106526. static CreateTiledPlane(options: {
  106527. pattern?: number;
  106528. tileSize?: number;
  106529. tileWidth?: number;
  106530. tileHeight?: number;
  106531. size?: number;
  106532. width?: number;
  106533. height?: number;
  106534. alignHorizontal?: number;
  106535. alignVertical?: number;
  106536. sideOrientation?: number;
  106537. frontUVs?: Vector4;
  106538. backUVs?: Vector4;
  106539. }): VertexData;
  106540. /**
  106541. * Creates the VertexData for an ellipsoid, defaults to a sphere
  106542. * @param options an object used to set the following optional parameters for the box, required but can be empty
  106543. * * segments sets the number of horizontal strips optional, default 32
  106544. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  106545. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  106546. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  106547. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  106548. * * 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
  106549. * * 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
  106550. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106551. * * 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)
  106552. * * 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)
  106553. * @returns the VertexData of the ellipsoid
  106554. */
  106555. static CreateSphere(options: {
  106556. segments?: number;
  106557. diameter?: number;
  106558. diameterX?: number;
  106559. diameterY?: number;
  106560. diameterZ?: number;
  106561. arc?: number;
  106562. slice?: number;
  106563. sideOrientation?: number;
  106564. frontUVs?: Vector4;
  106565. backUVs?: Vector4;
  106566. }): VertexData;
  106567. /**
  106568. * Creates the VertexData for a cylinder, cone or prism
  106569. * @param options an object used to set the following optional parameters for the box, required but can be empty
  106570. * * height sets the height (y direction) of the cylinder, optional, default 2
  106571. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  106572. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  106573. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  106574. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  106575. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  106576. * * 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
  106577. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  106578. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  106579. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  106580. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  106581. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106582. * * 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)
  106583. * * 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)
  106584. * @returns the VertexData of the cylinder, cone or prism
  106585. */
  106586. static CreateCylinder(options: {
  106587. height?: number;
  106588. diameterTop?: number;
  106589. diameterBottom?: number;
  106590. diameter?: number;
  106591. tessellation?: number;
  106592. subdivisions?: number;
  106593. arc?: number;
  106594. faceColors?: Color4[];
  106595. faceUV?: Vector4[];
  106596. hasRings?: boolean;
  106597. enclose?: boolean;
  106598. sideOrientation?: number;
  106599. frontUVs?: Vector4;
  106600. backUVs?: Vector4;
  106601. }): VertexData;
  106602. /**
  106603. * Creates the VertexData for a torus
  106604. * @param options an object used to set the following optional parameters for the box, required but can be empty
  106605. * * diameter the diameter of the torus, optional default 1
  106606. * * thickness the diameter of the tube forming the torus, optional default 0.5
  106607. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  106608. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106609. * * 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)
  106610. * * 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)
  106611. * @returns the VertexData of the torus
  106612. */
  106613. static CreateTorus(options: {
  106614. diameter?: number;
  106615. thickness?: number;
  106616. tessellation?: number;
  106617. sideOrientation?: number;
  106618. frontUVs?: Vector4;
  106619. backUVs?: Vector4;
  106620. }): VertexData;
  106621. /**
  106622. * Creates the VertexData of the LineSystem
  106623. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  106624. * - lines an array of lines, each line being an array of successive Vector3
  106625. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  106626. * @returns the VertexData of the LineSystem
  106627. */
  106628. static CreateLineSystem(options: {
  106629. lines: Vector3[][];
  106630. colors?: Nullable<Color4[][]>;
  106631. }): VertexData;
  106632. /**
  106633. * Create the VertexData for a DashedLines
  106634. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  106635. * - points an array successive Vector3
  106636. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  106637. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  106638. * - dashNb the intended total number of dashes, optional, default 200
  106639. * @returns the VertexData for the DashedLines
  106640. */
  106641. static CreateDashedLines(options: {
  106642. points: Vector3[];
  106643. dashSize?: number;
  106644. gapSize?: number;
  106645. dashNb?: number;
  106646. }): VertexData;
  106647. /**
  106648. * Creates the VertexData for a Ground
  106649. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  106650. * - width the width (x direction) of the ground, optional, default 1
  106651. * - height the height (z direction) of the ground, optional, default 1
  106652. * - subdivisions the number of subdivisions per side, optional, default 1
  106653. * @returns the VertexData of the Ground
  106654. */
  106655. static CreateGround(options: {
  106656. width?: number;
  106657. height?: number;
  106658. subdivisions?: number;
  106659. subdivisionsX?: number;
  106660. subdivisionsY?: number;
  106661. }): VertexData;
  106662. /**
  106663. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  106664. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  106665. * * xmin the ground minimum X coordinate, optional, default -1
  106666. * * zmin the ground minimum Z coordinate, optional, default -1
  106667. * * xmax the ground maximum X coordinate, optional, default 1
  106668. * * zmax the ground maximum Z coordinate, optional, default 1
  106669. * * 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}
  106670. * * 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}
  106671. * @returns the VertexData of the TiledGround
  106672. */
  106673. static CreateTiledGround(options: {
  106674. xmin: number;
  106675. zmin: number;
  106676. xmax: number;
  106677. zmax: number;
  106678. subdivisions?: {
  106679. w: number;
  106680. h: number;
  106681. };
  106682. precision?: {
  106683. w: number;
  106684. h: number;
  106685. };
  106686. }): VertexData;
  106687. /**
  106688. * Creates the VertexData of the Ground designed from a heightmap
  106689. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  106690. * * width the width (x direction) of the ground
  106691. * * height the height (z direction) of the ground
  106692. * * subdivisions the number of subdivisions per side
  106693. * * minHeight the minimum altitude on the ground, optional, default 0
  106694. * * maxHeight the maximum altitude on the ground, optional default 1
  106695. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  106696. * * buffer the array holding the image color data
  106697. * * bufferWidth the width of image
  106698. * * bufferHeight the height of image
  106699. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  106700. * @returns the VertexData of the Ground designed from a heightmap
  106701. */
  106702. static CreateGroundFromHeightMap(options: {
  106703. width: number;
  106704. height: number;
  106705. subdivisions: number;
  106706. minHeight: number;
  106707. maxHeight: number;
  106708. colorFilter: Color3;
  106709. buffer: Uint8Array;
  106710. bufferWidth: number;
  106711. bufferHeight: number;
  106712. alphaFilter: number;
  106713. }): VertexData;
  106714. /**
  106715. * Creates the VertexData for a Plane
  106716. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  106717. * * size sets the width and height of the plane to the value of size, optional default 1
  106718. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  106719. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  106720. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106721. * * 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)
  106722. * * 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)
  106723. * @returns the VertexData of the box
  106724. */
  106725. static CreatePlane(options: {
  106726. size?: number;
  106727. width?: number;
  106728. height?: number;
  106729. sideOrientation?: number;
  106730. frontUVs?: Vector4;
  106731. backUVs?: Vector4;
  106732. }): VertexData;
  106733. /**
  106734. * Creates the VertexData of the Disc or regular Polygon
  106735. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  106736. * * radius the radius of the disc, optional default 0.5
  106737. * * tessellation the number of polygon sides, optional, default 64
  106738. * * 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
  106739. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106740. * * 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)
  106741. * * 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)
  106742. * @returns the VertexData of the box
  106743. */
  106744. static CreateDisc(options: {
  106745. radius?: number;
  106746. tessellation?: number;
  106747. arc?: number;
  106748. sideOrientation?: number;
  106749. frontUVs?: Vector4;
  106750. backUVs?: Vector4;
  106751. }): VertexData;
  106752. /**
  106753. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  106754. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  106755. * @param polygon a mesh built from polygonTriangulation.build()
  106756. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106757. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  106758. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  106759. * @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)
  106760. * @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)
  106761. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  106762. * @returns the VertexData of the Polygon
  106763. */
  106764. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  106765. /**
  106766. * Creates the VertexData of the IcoSphere
  106767. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  106768. * * radius the radius of the IcoSphere, optional default 1
  106769. * * radiusX allows stretching in the x direction, optional, default radius
  106770. * * radiusY allows stretching in the y direction, optional, default radius
  106771. * * radiusZ allows stretching in the z direction, optional, default radius
  106772. * * flat when true creates a flat shaded mesh, optional, default true
  106773. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  106774. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106775. * * 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)
  106776. * * 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)
  106777. * @returns the VertexData of the IcoSphere
  106778. */
  106779. static CreateIcoSphere(options: {
  106780. radius?: number;
  106781. radiusX?: number;
  106782. radiusY?: number;
  106783. radiusZ?: number;
  106784. flat?: boolean;
  106785. subdivisions?: number;
  106786. sideOrientation?: number;
  106787. frontUVs?: Vector4;
  106788. backUVs?: Vector4;
  106789. }): VertexData;
  106790. /**
  106791. * Creates the VertexData for a Polyhedron
  106792. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  106793. * * type provided types are:
  106794. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  106795. * * 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)
  106796. * * size the size of the IcoSphere, optional default 1
  106797. * * sizeX allows stretching in the x direction, optional, default size
  106798. * * sizeY allows stretching in the y direction, optional, default size
  106799. * * sizeZ allows stretching in the z direction, optional, default size
  106800. * * 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
  106801. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  106802. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  106803. * * flat when true creates a flat shaded mesh, optional, default true
  106804. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  106805. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106806. * * 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)
  106807. * * 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)
  106808. * @returns the VertexData of the Polyhedron
  106809. */
  106810. static CreatePolyhedron(options: {
  106811. type?: number;
  106812. size?: number;
  106813. sizeX?: number;
  106814. sizeY?: number;
  106815. sizeZ?: number;
  106816. custom?: any;
  106817. faceUV?: Vector4[];
  106818. faceColors?: Color4[];
  106819. flat?: boolean;
  106820. sideOrientation?: number;
  106821. frontUVs?: Vector4;
  106822. backUVs?: Vector4;
  106823. }): VertexData;
  106824. /**
  106825. * Creates the VertexData for a Capsule, inspired from https://github.com/maximeq/three-js-capsule-geometry/blob/master/src/CapsuleBufferGeometry.js
  106826. * @param options an object used to set the following optional parameters for the capsule, required but can be empty
  106827. * @returns the VertexData of the Capsule
  106828. */
  106829. static CreateCapsule(options?: ICreateCapsuleOptions): VertexData;
  106830. /**
  106831. * Creates the VertexData for a TorusKnot
  106832. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  106833. * * radius the radius of the torus knot, optional, default 2
  106834. * * tube the thickness of the tube, optional, default 0.5
  106835. * * radialSegments the number of sides on each tube segments, optional, default 32
  106836. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  106837. * * p the number of windings around the z axis, optional, default 2
  106838. * * q the number of windings around the x axis, optional, default 3
  106839. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106840. * * 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)
  106841. * * 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)
  106842. * @returns the VertexData of the Torus Knot
  106843. */
  106844. static CreateTorusKnot(options: {
  106845. radius?: number;
  106846. tube?: number;
  106847. radialSegments?: number;
  106848. tubularSegments?: number;
  106849. p?: number;
  106850. q?: number;
  106851. sideOrientation?: number;
  106852. frontUVs?: Vector4;
  106853. backUVs?: Vector4;
  106854. }): VertexData;
  106855. /**
  106856. * Compute normals for given positions and indices
  106857. * @param positions an array of vertex positions, [...., x, y, z, ......]
  106858. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  106859. * @param normals an array of vertex normals, [...., x, y, z, ......]
  106860. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  106861. * * facetNormals : optional array of facet normals (vector3)
  106862. * * facetPositions : optional array of facet positions (vector3)
  106863. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  106864. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  106865. * * bInfo : optional bounding info, required for facetPartitioning computation
  106866. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  106867. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  106868. * * useRightHandedSystem: optional boolean to for right handed system computation
  106869. * * depthSort : optional boolean to enable the facet depth sort computation
  106870. * * distanceTo : optional Vector3 to compute the facet depth from this location
  106871. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  106872. */
  106873. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  106874. facetNormals?: any;
  106875. facetPositions?: any;
  106876. facetPartitioning?: any;
  106877. ratio?: number;
  106878. bInfo?: any;
  106879. bbSize?: Vector3;
  106880. subDiv?: any;
  106881. useRightHandedSystem?: boolean;
  106882. depthSort?: boolean;
  106883. distanceTo?: Vector3;
  106884. depthSortedFacets?: any;
  106885. }): void;
  106886. /** @hidden */
  106887. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  106888. /**
  106889. * Applies VertexData created from the imported parameters to the geometry
  106890. * @param parsedVertexData the parsed data from an imported file
  106891. * @param geometry the geometry to apply the VertexData to
  106892. */
  106893. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  106894. }
  106895. }
  106896. declare module BABYLON {
  106897. /**
  106898. * Defines a target to use with MorphTargetManager
  106899. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  106900. */
  106901. export class MorphTarget implements IAnimatable {
  106902. /** defines the name of the target */
  106903. name: string;
  106904. /**
  106905. * Gets or sets the list of animations
  106906. */
  106907. animations: Animation[];
  106908. private _scene;
  106909. private _positions;
  106910. private _normals;
  106911. private _tangents;
  106912. private _uvs;
  106913. private _influence;
  106914. private _uniqueId;
  106915. /**
  106916. * Observable raised when the influence changes
  106917. */
  106918. onInfluenceChanged: Observable<boolean>;
  106919. /** @hidden */
  106920. _onDataLayoutChanged: Observable<void>;
  106921. /**
  106922. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  106923. */
  106924. get influence(): number;
  106925. set influence(influence: number);
  106926. /**
  106927. * Gets or sets the id of the morph Target
  106928. */
  106929. id: string;
  106930. private _animationPropertiesOverride;
  106931. /**
  106932. * Gets or sets the animation properties override
  106933. */
  106934. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  106935. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  106936. /**
  106937. * Creates a new MorphTarget
  106938. * @param name defines the name of the target
  106939. * @param influence defines the influence to use
  106940. * @param scene defines the scene the morphtarget belongs to
  106941. */
  106942. constructor(
  106943. /** defines the name of the target */
  106944. name: string, influence?: number, scene?: Nullable<Scene>);
  106945. /**
  106946. * Gets the unique ID of this manager
  106947. */
  106948. get uniqueId(): number;
  106949. /**
  106950. * Gets a boolean defining if the target contains position data
  106951. */
  106952. get hasPositions(): boolean;
  106953. /**
  106954. * Gets a boolean defining if the target contains normal data
  106955. */
  106956. get hasNormals(): boolean;
  106957. /**
  106958. * Gets a boolean defining if the target contains tangent data
  106959. */
  106960. get hasTangents(): boolean;
  106961. /**
  106962. * Gets a boolean defining if the target contains texture coordinates data
  106963. */
  106964. get hasUVs(): boolean;
  106965. /**
  106966. * Affects position data to this target
  106967. * @param data defines the position data to use
  106968. */
  106969. setPositions(data: Nullable<FloatArray>): void;
  106970. /**
  106971. * Gets the position data stored in this target
  106972. * @returns a FloatArray containing the position data (or null if not present)
  106973. */
  106974. getPositions(): Nullable<FloatArray>;
  106975. /**
  106976. * Affects normal data to this target
  106977. * @param data defines the normal data to use
  106978. */
  106979. setNormals(data: Nullable<FloatArray>): void;
  106980. /**
  106981. * Gets the normal data stored in this target
  106982. * @returns a FloatArray containing the normal data (or null if not present)
  106983. */
  106984. getNormals(): Nullable<FloatArray>;
  106985. /**
  106986. * Affects tangent data to this target
  106987. * @param data defines the tangent data to use
  106988. */
  106989. setTangents(data: Nullable<FloatArray>): void;
  106990. /**
  106991. * Gets the tangent data stored in this target
  106992. * @returns a FloatArray containing the tangent data (or null if not present)
  106993. */
  106994. getTangents(): Nullable<FloatArray>;
  106995. /**
  106996. * Affects texture coordinates data to this target
  106997. * @param data defines the texture coordinates data to use
  106998. */
  106999. setUVs(data: Nullable<FloatArray>): void;
  107000. /**
  107001. * Gets the texture coordinates data stored in this target
  107002. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  107003. */
  107004. getUVs(): Nullable<FloatArray>;
  107005. /**
  107006. * Clone the current target
  107007. * @returns a new MorphTarget
  107008. */
  107009. clone(): MorphTarget;
  107010. /**
  107011. * Serializes the current target into a Serialization object
  107012. * @returns the serialized object
  107013. */
  107014. serialize(): any;
  107015. /**
  107016. * Returns the string "MorphTarget"
  107017. * @returns "MorphTarget"
  107018. */
  107019. getClassName(): string;
  107020. /**
  107021. * Creates a new target from serialized data
  107022. * @param serializationObject defines the serialized data to use
  107023. * @returns a new MorphTarget
  107024. */
  107025. static Parse(serializationObject: any): MorphTarget;
  107026. /**
  107027. * Creates a MorphTarget from mesh data
  107028. * @param mesh defines the source mesh
  107029. * @param name defines the name to use for the new target
  107030. * @param influence defines the influence to attach to the target
  107031. * @returns a new MorphTarget
  107032. */
  107033. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  107034. }
  107035. }
  107036. declare module BABYLON {
  107037. /**
  107038. * This class is used to deform meshes using morphing between different targets
  107039. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  107040. */
  107041. export class MorphTargetManager {
  107042. private _targets;
  107043. private _targetInfluenceChangedObservers;
  107044. private _targetDataLayoutChangedObservers;
  107045. private _activeTargets;
  107046. private _scene;
  107047. private _influences;
  107048. private _supportsNormals;
  107049. private _supportsTangents;
  107050. private _supportsUVs;
  107051. private _vertexCount;
  107052. private _uniqueId;
  107053. private _tempInfluences;
  107054. /**
  107055. * Gets or sets a boolean indicating if normals must be morphed
  107056. */
  107057. enableNormalMorphing: boolean;
  107058. /**
  107059. * Gets or sets a boolean indicating if tangents must be morphed
  107060. */
  107061. enableTangentMorphing: boolean;
  107062. /**
  107063. * Gets or sets a boolean indicating if UV must be morphed
  107064. */
  107065. enableUVMorphing: boolean;
  107066. /**
  107067. * Creates a new MorphTargetManager
  107068. * @param scene defines the current scene
  107069. */
  107070. constructor(scene?: Nullable<Scene>);
  107071. /**
  107072. * Gets the unique ID of this manager
  107073. */
  107074. get uniqueId(): number;
  107075. /**
  107076. * Gets the number of vertices handled by this manager
  107077. */
  107078. get vertexCount(): number;
  107079. /**
  107080. * Gets a boolean indicating if this manager supports morphing of normals
  107081. */
  107082. get supportsNormals(): boolean;
  107083. /**
  107084. * Gets a boolean indicating if this manager supports morphing of tangents
  107085. */
  107086. get supportsTangents(): boolean;
  107087. /**
  107088. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  107089. */
  107090. get supportsUVs(): boolean;
  107091. /**
  107092. * Gets the number of targets stored in this manager
  107093. */
  107094. get numTargets(): number;
  107095. /**
  107096. * Gets the number of influencers (ie. the number of targets with influences > 0)
  107097. */
  107098. get numInfluencers(): number;
  107099. /**
  107100. * Gets the list of influences (one per target)
  107101. */
  107102. get influences(): Float32Array;
  107103. /**
  107104. * Gets the active target at specified index. An active target is a target with an influence > 0
  107105. * @param index defines the index to check
  107106. * @returns the requested target
  107107. */
  107108. getActiveTarget(index: number): MorphTarget;
  107109. /**
  107110. * Gets the target at specified index
  107111. * @param index defines the index to check
  107112. * @returns the requested target
  107113. */
  107114. getTarget(index: number): MorphTarget;
  107115. /**
  107116. * Add a new target to this manager
  107117. * @param target defines the target to add
  107118. */
  107119. addTarget(target: MorphTarget): void;
  107120. /**
  107121. * Removes a target from the manager
  107122. * @param target defines the target to remove
  107123. */
  107124. removeTarget(target: MorphTarget): void;
  107125. /**
  107126. * Clone the current manager
  107127. * @returns a new MorphTargetManager
  107128. */
  107129. clone(): MorphTargetManager;
  107130. /**
  107131. * Serializes the current manager into a Serialization object
  107132. * @returns the serialized object
  107133. */
  107134. serialize(): any;
  107135. private _syncActiveTargets;
  107136. /**
  107137. * Syncrhonize the targets with all the meshes using this morph target manager
  107138. */
  107139. synchronize(): void;
  107140. /**
  107141. * Creates a new MorphTargetManager from serialized data
  107142. * @param serializationObject defines the serialized data
  107143. * @param scene defines the hosting scene
  107144. * @returns the new MorphTargetManager
  107145. */
  107146. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  107147. }
  107148. }
  107149. declare module BABYLON {
  107150. /**
  107151. * Class used to represent a specific level of detail of a mesh
  107152. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107153. */
  107154. export class MeshLODLevel {
  107155. /** Defines the distance where this level should start being displayed */
  107156. distance: number;
  107157. /** Defines the mesh to use to render this level */
  107158. mesh: Nullable<Mesh>;
  107159. /**
  107160. * Creates a new LOD level
  107161. * @param distance defines the distance where this level should star being displayed
  107162. * @param mesh defines the mesh to use to render this level
  107163. */
  107164. constructor(
  107165. /** Defines the distance where this level should start being displayed */
  107166. distance: number,
  107167. /** Defines the mesh to use to render this level */
  107168. mesh: Nullable<Mesh>);
  107169. }
  107170. }
  107171. declare module BABYLON {
  107172. /**
  107173. * Helper class used to generate a canvas to manipulate images
  107174. */
  107175. export class CanvasGenerator {
  107176. /**
  107177. * Create a new canvas (or offscreen canvas depending on the context)
  107178. * @param width defines the expected width
  107179. * @param height defines the expected height
  107180. * @return a new canvas or offscreen canvas
  107181. */
  107182. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  107183. }
  107184. }
  107185. declare module BABYLON {
  107186. /**
  107187. * Mesh representing the gorund
  107188. */
  107189. export class GroundMesh extends Mesh {
  107190. /** If octree should be generated */
  107191. generateOctree: boolean;
  107192. private _heightQuads;
  107193. /** @hidden */
  107194. _subdivisionsX: number;
  107195. /** @hidden */
  107196. _subdivisionsY: number;
  107197. /** @hidden */
  107198. _width: number;
  107199. /** @hidden */
  107200. _height: number;
  107201. /** @hidden */
  107202. _minX: number;
  107203. /** @hidden */
  107204. _maxX: number;
  107205. /** @hidden */
  107206. _minZ: number;
  107207. /** @hidden */
  107208. _maxZ: number;
  107209. constructor(name: string, scene: Scene);
  107210. /**
  107211. * "GroundMesh"
  107212. * @returns "GroundMesh"
  107213. */
  107214. getClassName(): string;
  107215. /**
  107216. * The minimum of x and y subdivisions
  107217. */
  107218. get subdivisions(): number;
  107219. /**
  107220. * X subdivisions
  107221. */
  107222. get subdivisionsX(): number;
  107223. /**
  107224. * Y subdivisions
  107225. */
  107226. get subdivisionsY(): number;
  107227. /**
  107228. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  107229. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  107230. * @param chunksCount the number of subdivisions for x and y
  107231. * @param octreeBlocksSize (Default: 32)
  107232. */
  107233. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  107234. /**
  107235. * Returns a height (y) value in the Worl system :
  107236. * the ground altitude at the coordinates (x, z) expressed in the World system.
  107237. * @param x x coordinate
  107238. * @param z z coordinate
  107239. * @returns the ground y position if (x, z) are outside the ground surface.
  107240. */
  107241. getHeightAtCoordinates(x: number, z: number): number;
  107242. /**
  107243. * Returns a normalized vector (Vector3) orthogonal to the ground
  107244. * at the ground coordinates (x, z) expressed in the World system.
  107245. * @param x x coordinate
  107246. * @param z z coordinate
  107247. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  107248. */
  107249. getNormalAtCoordinates(x: number, z: number): Vector3;
  107250. /**
  107251. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  107252. * at the ground coordinates (x, z) expressed in the World system.
  107253. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  107254. * @param x x coordinate
  107255. * @param z z coordinate
  107256. * @param ref vector to store the result
  107257. * @returns the GroundMesh.
  107258. */
  107259. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  107260. /**
  107261. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  107262. * if the ground has been updated.
  107263. * This can be used in the render loop.
  107264. * @returns the GroundMesh.
  107265. */
  107266. updateCoordinateHeights(): GroundMesh;
  107267. private _getFacetAt;
  107268. private _initHeightQuads;
  107269. private _computeHeightQuads;
  107270. /**
  107271. * Serializes this ground mesh
  107272. * @param serializationObject object to write serialization to
  107273. */
  107274. serialize(serializationObject: any): void;
  107275. /**
  107276. * Parses a serialized ground mesh
  107277. * @param parsedMesh the serialized mesh
  107278. * @param scene the scene to create the ground mesh in
  107279. * @returns the created ground mesh
  107280. */
  107281. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  107282. }
  107283. }
  107284. declare module BABYLON {
  107285. /**
  107286. * Interface for Physics-Joint data
  107287. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107288. */
  107289. export interface PhysicsJointData {
  107290. /**
  107291. * The main pivot of the joint
  107292. */
  107293. mainPivot?: Vector3;
  107294. /**
  107295. * The connected pivot of the joint
  107296. */
  107297. connectedPivot?: Vector3;
  107298. /**
  107299. * The main axis of the joint
  107300. */
  107301. mainAxis?: Vector3;
  107302. /**
  107303. * The connected axis of the joint
  107304. */
  107305. connectedAxis?: Vector3;
  107306. /**
  107307. * The collision of the joint
  107308. */
  107309. collision?: boolean;
  107310. /**
  107311. * Native Oimo/Cannon/Energy data
  107312. */
  107313. nativeParams?: any;
  107314. }
  107315. /**
  107316. * This is a holder class for the physics joint created by the physics plugin
  107317. * It holds a set of functions to control the underlying joint
  107318. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107319. */
  107320. export class PhysicsJoint {
  107321. /**
  107322. * The type of the physics joint
  107323. */
  107324. type: number;
  107325. /**
  107326. * The data for the physics joint
  107327. */
  107328. jointData: PhysicsJointData;
  107329. private _physicsJoint;
  107330. protected _physicsPlugin: IPhysicsEnginePlugin;
  107331. /**
  107332. * Initializes the physics joint
  107333. * @param type The type of the physics joint
  107334. * @param jointData The data for the physics joint
  107335. */
  107336. constructor(
  107337. /**
  107338. * The type of the physics joint
  107339. */
  107340. type: number,
  107341. /**
  107342. * The data for the physics joint
  107343. */
  107344. jointData: PhysicsJointData);
  107345. /**
  107346. * Gets the physics joint
  107347. */
  107348. get physicsJoint(): any;
  107349. /**
  107350. * Sets the physics joint
  107351. */
  107352. set physicsJoint(newJoint: any);
  107353. /**
  107354. * Sets the physics plugin
  107355. */
  107356. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  107357. /**
  107358. * Execute a function that is physics-plugin specific.
  107359. * @param {Function} func the function that will be executed.
  107360. * It accepts two parameters: the physics world and the physics joint
  107361. */
  107362. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  107363. /**
  107364. * Distance-Joint type
  107365. */
  107366. static DistanceJoint: number;
  107367. /**
  107368. * Hinge-Joint type
  107369. */
  107370. static HingeJoint: number;
  107371. /**
  107372. * Ball-and-Socket joint type
  107373. */
  107374. static BallAndSocketJoint: number;
  107375. /**
  107376. * Wheel-Joint type
  107377. */
  107378. static WheelJoint: number;
  107379. /**
  107380. * Slider-Joint type
  107381. */
  107382. static SliderJoint: number;
  107383. /**
  107384. * Prismatic-Joint type
  107385. */
  107386. static PrismaticJoint: number;
  107387. /**
  107388. * Universal-Joint type
  107389. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  107390. */
  107391. static UniversalJoint: number;
  107392. /**
  107393. * Hinge-Joint 2 type
  107394. */
  107395. static Hinge2Joint: number;
  107396. /**
  107397. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  107398. */
  107399. static PointToPointJoint: number;
  107400. /**
  107401. * Spring-Joint type
  107402. */
  107403. static SpringJoint: number;
  107404. /**
  107405. * Lock-Joint type
  107406. */
  107407. static LockJoint: number;
  107408. }
  107409. /**
  107410. * A class representing a physics distance joint
  107411. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107412. */
  107413. export class DistanceJoint extends PhysicsJoint {
  107414. /**
  107415. *
  107416. * @param jointData The data for the Distance-Joint
  107417. */
  107418. constructor(jointData: DistanceJointData);
  107419. /**
  107420. * Update the predefined distance.
  107421. * @param maxDistance The maximum preferred distance
  107422. * @param minDistance The minimum preferred distance
  107423. */
  107424. updateDistance(maxDistance: number, minDistance?: number): void;
  107425. }
  107426. /**
  107427. * Represents a Motor-Enabled Joint
  107428. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107429. */
  107430. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  107431. /**
  107432. * Initializes the Motor-Enabled Joint
  107433. * @param type The type of the joint
  107434. * @param jointData The physica joint data for the joint
  107435. */
  107436. constructor(type: number, jointData: PhysicsJointData);
  107437. /**
  107438. * Set the motor values.
  107439. * Attention, this function is plugin specific. Engines won't react 100% the same.
  107440. * @param force the force to apply
  107441. * @param maxForce max force for this motor.
  107442. */
  107443. setMotor(force?: number, maxForce?: number): void;
  107444. /**
  107445. * Set the motor's limits.
  107446. * Attention, this function is plugin specific. Engines won't react 100% the same.
  107447. * @param upperLimit The upper limit of the motor
  107448. * @param lowerLimit The lower limit of the motor
  107449. */
  107450. setLimit(upperLimit: number, lowerLimit?: number): void;
  107451. }
  107452. /**
  107453. * This class represents a single physics Hinge-Joint
  107454. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107455. */
  107456. export class HingeJoint extends MotorEnabledJoint {
  107457. /**
  107458. * Initializes the Hinge-Joint
  107459. * @param jointData The joint data for the Hinge-Joint
  107460. */
  107461. constructor(jointData: PhysicsJointData);
  107462. /**
  107463. * Set the motor values.
  107464. * Attention, this function is plugin specific. Engines won't react 100% the same.
  107465. * @param {number} force the force to apply
  107466. * @param {number} maxForce max force for this motor.
  107467. */
  107468. setMotor(force?: number, maxForce?: number): void;
  107469. /**
  107470. * Set the motor's limits.
  107471. * Attention, this function is plugin specific. Engines won't react 100% the same.
  107472. * @param upperLimit The upper limit of the motor
  107473. * @param lowerLimit The lower limit of the motor
  107474. */
  107475. setLimit(upperLimit: number, lowerLimit?: number): void;
  107476. }
  107477. /**
  107478. * This class represents a dual hinge physics joint (same as wheel joint)
  107479. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107480. */
  107481. export class Hinge2Joint extends MotorEnabledJoint {
  107482. /**
  107483. * Initializes the Hinge2-Joint
  107484. * @param jointData The joint data for the Hinge2-Joint
  107485. */
  107486. constructor(jointData: PhysicsJointData);
  107487. /**
  107488. * Set the motor values.
  107489. * Attention, this function is plugin specific. Engines won't react 100% the same.
  107490. * @param {number} targetSpeed the speed the motor is to reach
  107491. * @param {number} maxForce max force for this motor.
  107492. * @param {motorIndex} the motor's index, 0 or 1.
  107493. */
  107494. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  107495. /**
  107496. * Set the motor limits.
  107497. * Attention, this function is plugin specific. Engines won't react 100% the same.
  107498. * @param {number} upperLimit the upper limit
  107499. * @param {number} lowerLimit lower limit
  107500. * @param {motorIndex} the motor's index, 0 or 1.
  107501. */
  107502. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  107503. }
  107504. /**
  107505. * Interface for a motor enabled joint
  107506. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107507. */
  107508. export interface IMotorEnabledJoint {
  107509. /**
  107510. * Physics joint
  107511. */
  107512. physicsJoint: any;
  107513. /**
  107514. * Sets the motor of the motor-enabled joint
  107515. * @param force The force of the motor
  107516. * @param maxForce The maximum force of the motor
  107517. * @param motorIndex The index of the motor
  107518. */
  107519. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  107520. /**
  107521. * Sets the limit of the motor
  107522. * @param upperLimit The upper limit of the motor
  107523. * @param lowerLimit The lower limit of the motor
  107524. * @param motorIndex The index of the motor
  107525. */
  107526. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  107527. }
  107528. /**
  107529. * Joint data for a Distance-Joint
  107530. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107531. */
  107532. export interface DistanceJointData extends PhysicsJointData {
  107533. /**
  107534. * Max distance the 2 joint objects can be apart
  107535. */
  107536. maxDistance: number;
  107537. }
  107538. /**
  107539. * Joint data from a spring joint
  107540. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107541. */
  107542. export interface SpringJointData extends PhysicsJointData {
  107543. /**
  107544. * Length of the spring
  107545. */
  107546. length: number;
  107547. /**
  107548. * Stiffness of the spring
  107549. */
  107550. stiffness: number;
  107551. /**
  107552. * Damping of the spring
  107553. */
  107554. damping: number;
  107555. /** this callback will be called when applying the force to the impostors. */
  107556. forceApplicationCallback: () => void;
  107557. }
  107558. }
  107559. declare module BABYLON {
  107560. /**
  107561. * Holds the data for the raycast result
  107562. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107563. */
  107564. export class PhysicsRaycastResult {
  107565. private _hasHit;
  107566. private _hitDistance;
  107567. private _hitNormalWorld;
  107568. private _hitPointWorld;
  107569. private _rayFromWorld;
  107570. private _rayToWorld;
  107571. /**
  107572. * Gets if there was a hit
  107573. */
  107574. get hasHit(): boolean;
  107575. /**
  107576. * Gets the distance from the hit
  107577. */
  107578. get hitDistance(): number;
  107579. /**
  107580. * Gets the hit normal/direction in the world
  107581. */
  107582. get hitNormalWorld(): Vector3;
  107583. /**
  107584. * Gets the hit point in the world
  107585. */
  107586. get hitPointWorld(): Vector3;
  107587. /**
  107588. * Gets the ray "start point" of the ray in the world
  107589. */
  107590. get rayFromWorld(): Vector3;
  107591. /**
  107592. * Gets the ray "end point" of the ray in the world
  107593. */
  107594. get rayToWorld(): Vector3;
  107595. /**
  107596. * Sets the hit data (normal & point in world space)
  107597. * @param hitNormalWorld defines the normal in world space
  107598. * @param hitPointWorld defines the point in world space
  107599. */
  107600. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  107601. /**
  107602. * Sets the distance from the start point to the hit point
  107603. * @param distance
  107604. */
  107605. setHitDistance(distance: number): void;
  107606. /**
  107607. * Calculates the distance manually
  107608. */
  107609. calculateHitDistance(): void;
  107610. /**
  107611. * Resets all the values to default
  107612. * @param from The from point on world space
  107613. * @param to The to point on world space
  107614. */
  107615. reset(from?: Vector3, to?: Vector3): void;
  107616. }
  107617. /**
  107618. * Interface for the size containing width and height
  107619. */
  107620. interface IXYZ {
  107621. /**
  107622. * X
  107623. */
  107624. x: number;
  107625. /**
  107626. * Y
  107627. */
  107628. y: number;
  107629. /**
  107630. * Z
  107631. */
  107632. z: number;
  107633. }
  107634. }
  107635. declare module BABYLON {
  107636. /**
  107637. * Interface used to describe a physics joint
  107638. */
  107639. export interface PhysicsImpostorJoint {
  107640. /** Defines the main impostor to which the joint is linked */
  107641. mainImpostor: PhysicsImpostor;
  107642. /** Defines the impostor that is connected to the main impostor using this joint */
  107643. connectedImpostor: PhysicsImpostor;
  107644. /** Defines the joint itself */
  107645. joint: PhysicsJoint;
  107646. }
  107647. /** @hidden */
  107648. export interface IPhysicsEnginePlugin {
  107649. world: any;
  107650. name: string;
  107651. setGravity(gravity: Vector3): void;
  107652. setTimeStep(timeStep: number): void;
  107653. getTimeStep(): number;
  107654. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  107655. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  107656. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  107657. generatePhysicsBody(impostor: PhysicsImpostor): void;
  107658. removePhysicsBody(impostor: PhysicsImpostor): void;
  107659. generateJoint(joint: PhysicsImpostorJoint): void;
  107660. removeJoint(joint: PhysicsImpostorJoint): void;
  107661. isSupported(): boolean;
  107662. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  107663. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  107664. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  107665. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  107666. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  107667. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  107668. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  107669. getBodyMass(impostor: PhysicsImpostor): number;
  107670. getBodyFriction(impostor: PhysicsImpostor): number;
  107671. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  107672. getBodyRestitution(impostor: PhysicsImpostor): number;
  107673. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  107674. getBodyPressure?(impostor: PhysicsImpostor): number;
  107675. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  107676. getBodyStiffness?(impostor: PhysicsImpostor): number;
  107677. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  107678. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  107679. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  107680. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  107681. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  107682. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  107683. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  107684. sleepBody(impostor: PhysicsImpostor): void;
  107685. wakeUpBody(impostor: PhysicsImpostor): void;
  107686. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  107687. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  107688. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  107689. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  107690. getRadius(impostor: PhysicsImpostor): number;
  107691. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  107692. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  107693. dispose(): void;
  107694. }
  107695. /**
  107696. * Interface used to define a physics engine
  107697. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107698. */
  107699. export interface IPhysicsEngine {
  107700. /**
  107701. * Gets the gravity vector used by the simulation
  107702. */
  107703. gravity: Vector3;
  107704. /**
  107705. * Sets the gravity vector used by the simulation
  107706. * @param gravity defines the gravity vector to use
  107707. */
  107708. setGravity(gravity: Vector3): void;
  107709. /**
  107710. * Set the time step of the physics engine.
  107711. * Default is 1/60.
  107712. * To slow it down, enter 1/600 for example.
  107713. * To speed it up, 1/30
  107714. * @param newTimeStep the new timestep to apply to this world.
  107715. */
  107716. setTimeStep(newTimeStep: number): void;
  107717. /**
  107718. * Get the time step of the physics engine.
  107719. * @returns the current time step
  107720. */
  107721. getTimeStep(): number;
  107722. /**
  107723. * Set the sub time step of the physics engine.
  107724. * Default is 0 meaning there is no sub steps
  107725. * To increase physics resolution precision, set a small value (like 1 ms)
  107726. * @param subTimeStep defines the new sub timestep used for physics resolution.
  107727. */
  107728. setSubTimeStep(subTimeStep: number): void;
  107729. /**
  107730. * Get the sub time step of the physics engine.
  107731. * @returns the current sub time step
  107732. */
  107733. getSubTimeStep(): number;
  107734. /**
  107735. * Release all resources
  107736. */
  107737. dispose(): void;
  107738. /**
  107739. * Gets the name of the current physics plugin
  107740. * @returns the name of the plugin
  107741. */
  107742. getPhysicsPluginName(): string;
  107743. /**
  107744. * Adding a new impostor for the impostor tracking.
  107745. * This will be done by the impostor itself.
  107746. * @param impostor the impostor to add
  107747. */
  107748. addImpostor(impostor: PhysicsImpostor): void;
  107749. /**
  107750. * Remove an impostor from the engine.
  107751. * This impostor and its mesh will not longer be updated by the physics engine.
  107752. * @param impostor the impostor to remove
  107753. */
  107754. removeImpostor(impostor: PhysicsImpostor): void;
  107755. /**
  107756. * Add a joint to the physics engine
  107757. * @param mainImpostor defines the main impostor to which the joint is added.
  107758. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  107759. * @param joint defines the joint that will connect both impostors.
  107760. */
  107761. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  107762. /**
  107763. * Removes a joint from the simulation
  107764. * @param mainImpostor defines the impostor used with the joint
  107765. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  107766. * @param joint defines the joint to remove
  107767. */
  107768. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  107769. /**
  107770. * Gets the current plugin used to run the simulation
  107771. * @returns current plugin
  107772. */
  107773. getPhysicsPlugin(): IPhysicsEnginePlugin;
  107774. /**
  107775. * Gets the list of physic impostors
  107776. * @returns an array of PhysicsImpostor
  107777. */
  107778. getImpostors(): Array<PhysicsImpostor>;
  107779. /**
  107780. * Gets the impostor for a physics enabled object
  107781. * @param object defines the object impersonated by the impostor
  107782. * @returns the PhysicsImpostor or null if not found
  107783. */
  107784. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  107785. /**
  107786. * Gets the impostor for a physics body object
  107787. * @param body defines physics body used by the impostor
  107788. * @returns the PhysicsImpostor or null if not found
  107789. */
  107790. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  107791. /**
  107792. * Does a raycast in the physics world
  107793. * @param from when should the ray start?
  107794. * @param to when should the ray end?
  107795. * @returns PhysicsRaycastResult
  107796. */
  107797. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  107798. /**
  107799. * Called by the scene. No need to call it.
  107800. * @param delta defines the timespam between frames
  107801. */
  107802. _step(delta: number): void;
  107803. }
  107804. }
  107805. declare module BABYLON {
  107806. /**
  107807. * The interface for the physics imposter parameters
  107808. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107809. */
  107810. export interface PhysicsImpostorParameters {
  107811. /**
  107812. * The mass of the physics imposter
  107813. */
  107814. mass: number;
  107815. /**
  107816. * The friction of the physics imposter
  107817. */
  107818. friction?: number;
  107819. /**
  107820. * The coefficient of restitution of the physics imposter
  107821. */
  107822. restitution?: number;
  107823. /**
  107824. * The native options of the physics imposter
  107825. */
  107826. nativeOptions?: any;
  107827. /**
  107828. * Specifies if the parent should be ignored
  107829. */
  107830. ignoreParent?: boolean;
  107831. /**
  107832. * Specifies if bi-directional transformations should be disabled
  107833. */
  107834. disableBidirectionalTransformation?: boolean;
  107835. /**
  107836. * The pressure inside the physics imposter, soft object only
  107837. */
  107838. pressure?: number;
  107839. /**
  107840. * The stiffness the physics imposter, soft object only
  107841. */
  107842. stiffness?: number;
  107843. /**
  107844. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  107845. */
  107846. velocityIterations?: number;
  107847. /**
  107848. * The number of iterations used in maintaining consistent vertex positions, soft object only
  107849. */
  107850. positionIterations?: number;
  107851. /**
  107852. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  107853. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  107854. * Add to fix multiple points
  107855. */
  107856. fixedPoints?: number;
  107857. /**
  107858. * The collision margin around a soft object
  107859. */
  107860. margin?: number;
  107861. /**
  107862. * The collision margin around a soft object
  107863. */
  107864. damping?: number;
  107865. /**
  107866. * The path for a rope based on an extrusion
  107867. */
  107868. path?: any;
  107869. /**
  107870. * The shape of an extrusion used for a rope based on an extrusion
  107871. */
  107872. shape?: any;
  107873. }
  107874. /**
  107875. * Interface for a physics-enabled object
  107876. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107877. */
  107878. export interface IPhysicsEnabledObject {
  107879. /**
  107880. * The position of the physics-enabled object
  107881. */
  107882. position: Vector3;
  107883. /**
  107884. * The rotation of the physics-enabled object
  107885. */
  107886. rotationQuaternion: Nullable<Quaternion>;
  107887. /**
  107888. * The scale of the physics-enabled object
  107889. */
  107890. scaling: Vector3;
  107891. /**
  107892. * The rotation of the physics-enabled object
  107893. */
  107894. rotation?: Vector3;
  107895. /**
  107896. * The parent of the physics-enabled object
  107897. */
  107898. parent?: any;
  107899. /**
  107900. * The bounding info of the physics-enabled object
  107901. * @returns The bounding info of the physics-enabled object
  107902. */
  107903. getBoundingInfo(): BoundingInfo;
  107904. /**
  107905. * Computes the world matrix
  107906. * @param force Specifies if the world matrix should be computed by force
  107907. * @returns A world matrix
  107908. */
  107909. computeWorldMatrix(force: boolean): Matrix;
  107910. /**
  107911. * Gets the world matrix
  107912. * @returns A world matrix
  107913. */
  107914. getWorldMatrix?(): Matrix;
  107915. /**
  107916. * Gets the child meshes
  107917. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  107918. * @returns An array of abstract meshes
  107919. */
  107920. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  107921. /**
  107922. * Gets the vertex data
  107923. * @param kind The type of vertex data
  107924. * @returns A nullable array of numbers, or a float32 array
  107925. */
  107926. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  107927. /**
  107928. * Gets the indices from the mesh
  107929. * @returns A nullable array of index arrays
  107930. */
  107931. getIndices?(): Nullable<IndicesArray>;
  107932. /**
  107933. * Gets the scene from the mesh
  107934. * @returns the indices array or null
  107935. */
  107936. getScene?(): Scene;
  107937. /**
  107938. * Gets the absolute position from the mesh
  107939. * @returns the absolute position
  107940. */
  107941. getAbsolutePosition(): Vector3;
  107942. /**
  107943. * Gets the absolute pivot point from the mesh
  107944. * @returns the absolute pivot point
  107945. */
  107946. getAbsolutePivotPoint(): Vector3;
  107947. /**
  107948. * Rotates the mesh
  107949. * @param axis The axis of rotation
  107950. * @param amount The amount of rotation
  107951. * @param space The space of the rotation
  107952. * @returns The rotation transform node
  107953. */
  107954. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  107955. /**
  107956. * Translates the mesh
  107957. * @param axis The axis of translation
  107958. * @param distance The distance of translation
  107959. * @param space The space of the translation
  107960. * @returns The transform node
  107961. */
  107962. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  107963. /**
  107964. * Sets the absolute position of the mesh
  107965. * @param absolutePosition The absolute position of the mesh
  107966. * @returns The transform node
  107967. */
  107968. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  107969. /**
  107970. * Gets the class name of the mesh
  107971. * @returns The class name
  107972. */
  107973. getClassName(): string;
  107974. }
  107975. /**
  107976. * Represents a physics imposter
  107977. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107978. */
  107979. export class PhysicsImpostor {
  107980. /**
  107981. * The physics-enabled object used as the physics imposter
  107982. */
  107983. object: IPhysicsEnabledObject;
  107984. /**
  107985. * The type of the physics imposter
  107986. */
  107987. type: number;
  107988. private _options;
  107989. private _scene?;
  107990. /**
  107991. * The default object size of the imposter
  107992. */
  107993. static DEFAULT_OBJECT_SIZE: Vector3;
  107994. /**
  107995. * The identity quaternion of the imposter
  107996. */
  107997. static IDENTITY_QUATERNION: Quaternion;
  107998. /** @hidden */
  107999. _pluginData: any;
  108000. private _physicsEngine;
  108001. private _physicsBody;
  108002. private _bodyUpdateRequired;
  108003. private _onBeforePhysicsStepCallbacks;
  108004. private _onAfterPhysicsStepCallbacks;
  108005. /** @hidden */
  108006. _onPhysicsCollideCallbacks: Array<{
  108007. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  108008. otherImpostors: Array<PhysicsImpostor>;
  108009. }>;
  108010. private _deltaPosition;
  108011. private _deltaRotation;
  108012. private _deltaRotationConjugated;
  108013. /** @hidden */
  108014. _isFromLine: boolean;
  108015. private _parent;
  108016. private _isDisposed;
  108017. private static _tmpVecs;
  108018. private static _tmpQuat;
  108019. /**
  108020. * Specifies if the physics imposter is disposed
  108021. */
  108022. get isDisposed(): boolean;
  108023. /**
  108024. * Gets the mass of the physics imposter
  108025. */
  108026. get mass(): number;
  108027. set mass(value: number);
  108028. /**
  108029. * Gets the coefficient of friction
  108030. */
  108031. get friction(): number;
  108032. /**
  108033. * Sets the coefficient of friction
  108034. */
  108035. set friction(value: number);
  108036. /**
  108037. * Gets the coefficient of restitution
  108038. */
  108039. get restitution(): number;
  108040. /**
  108041. * Sets the coefficient of restitution
  108042. */
  108043. set restitution(value: number);
  108044. /**
  108045. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  108046. */
  108047. get pressure(): number;
  108048. /**
  108049. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  108050. */
  108051. set pressure(value: number);
  108052. /**
  108053. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  108054. */
  108055. get stiffness(): number;
  108056. /**
  108057. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  108058. */
  108059. set stiffness(value: number);
  108060. /**
  108061. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  108062. */
  108063. get velocityIterations(): number;
  108064. /**
  108065. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  108066. */
  108067. set velocityIterations(value: number);
  108068. /**
  108069. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  108070. */
  108071. get positionIterations(): number;
  108072. /**
  108073. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  108074. */
  108075. set positionIterations(value: number);
  108076. /**
  108077. * The unique id of the physics imposter
  108078. * set by the physics engine when adding this impostor to the array
  108079. */
  108080. uniqueId: number;
  108081. /**
  108082. * @hidden
  108083. */
  108084. soft: boolean;
  108085. /**
  108086. * @hidden
  108087. */
  108088. segments: number;
  108089. private _joints;
  108090. /**
  108091. * Initializes the physics imposter
  108092. * @param object The physics-enabled object used as the physics imposter
  108093. * @param type The type of the physics imposter
  108094. * @param _options The options for the physics imposter
  108095. * @param _scene The Babylon scene
  108096. */
  108097. constructor(
  108098. /**
  108099. * The physics-enabled object used as the physics imposter
  108100. */
  108101. object: IPhysicsEnabledObject,
  108102. /**
  108103. * The type of the physics imposter
  108104. */
  108105. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  108106. /**
  108107. * This function will completly initialize this impostor.
  108108. * It will create a new body - but only if this mesh has no parent.
  108109. * If it has, this impostor will not be used other than to define the impostor
  108110. * of the child mesh.
  108111. * @hidden
  108112. */
  108113. _init(): void;
  108114. private _getPhysicsParent;
  108115. /**
  108116. * Should a new body be generated.
  108117. * @returns boolean specifying if body initialization is required
  108118. */
  108119. isBodyInitRequired(): boolean;
  108120. /**
  108121. * Sets the updated scaling
  108122. * @param updated Specifies if the scaling is updated
  108123. */
  108124. setScalingUpdated(): void;
  108125. /**
  108126. * Force a regeneration of this or the parent's impostor's body.
  108127. * Use under cautious - This will remove all joints already implemented.
  108128. */
  108129. forceUpdate(): void;
  108130. /**
  108131. * Gets the body that holds this impostor. Either its own, or its parent.
  108132. */
  108133. get physicsBody(): any;
  108134. /**
  108135. * Get the parent of the physics imposter
  108136. * @returns Physics imposter or null
  108137. */
  108138. get parent(): Nullable<PhysicsImpostor>;
  108139. /**
  108140. * Sets the parent of the physics imposter
  108141. */
  108142. set parent(value: Nullable<PhysicsImpostor>);
  108143. /**
  108144. * Set the physics body. Used mainly by the physics engine/plugin
  108145. */
  108146. set physicsBody(physicsBody: any);
  108147. /**
  108148. * Resets the update flags
  108149. */
  108150. resetUpdateFlags(): void;
  108151. /**
  108152. * Gets the object extend size
  108153. * @returns the object extend size
  108154. */
  108155. getObjectExtendSize(): Vector3;
  108156. /**
  108157. * Gets the object center
  108158. * @returns The object center
  108159. */
  108160. getObjectCenter(): Vector3;
  108161. /**
  108162. * Get a specific parameter from the options parameters
  108163. * @param paramName The object parameter name
  108164. * @returns The object parameter
  108165. */
  108166. getParam(paramName: string): any;
  108167. /**
  108168. * Sets a specific parameter in the options given to the physics plugin
  108169. * @param paramName The parameter name
  108170. * @param value The value of the parameter
  108171. */
  108172. setParam(paramName: string, value: number): void;
  108173. /**
  108174. * Specifically change the body's mass option. Won't recreate the physics body object
  108175. * @param mass The mass of the physics imposter
  108176. */
  108177. setMass(mass: number): void;
  108178. /**
  108179. * Gets the linear velocity
  108180. * @returns linear velocity or null
  108181. */
  108182. getLinearVelocity(): Nullable<Vector3>;
  108183. /**
  108184. * Sets the linear velocity
  108185. * @param velocity linear velocity or null
  108186. */
  108187. setLinearVelocity(velocity: Nullable<Vector3>): void;
  108188. /**
  108189. * Gets the angular velocity
  108190. * @returns angular velocity or null
  108191. */
  108192. getAngularVelocity(): Nullable<Vector3>;
  108193. /**
  108194. * Sets the angular velocity
  108195. * @param velocity The velocity or null
  108196. */
  108197. setAngularVelocity(velocity: Nullable<Vector3>): void;
  108198. /**
  108199. * Execute a function with the physics plugin native code
  108200. * Provide a function the will have two variables - the world object and the physics body object
  108201. * @param func The function to execute with the physics plugin native code
  108202. */
  108203. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  108204. /**
  108205. * Register a function that will be executed before the physics world is stepping forward
  108206. * @param func The function to execute before the physics world is stepped forward
  108207. */
  108208. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  108209. /**
  108210. * Unregister a function that will be executed before the physics world is stepping forward
  108211. * @param func The function to execute before the physics world is stepped forward
  108212. */
  108213. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  108214. /**
  108215. * Register a function that will be executed after the physics step
  108216. * @param func The function to execute after physics step
  108217. */
  108218. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  108219. /**
  108220. * Unregisters a function that will be executed after the physics step
  108221. * @param func The function to execute after physics step
  108222. */
  108223. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  108224. /**
  108225. * register a function that will be executed when this impostor collides against a different body
  108226. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  108227. * @param func Callback that is executed on collision
  108228. */
  108229. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  108230. /**
  108231. * Unregisters the physics imposter on contact
  108232. * @param collideAgainst The physics object to collide against
  108233. * @param func Callback to execute on collision
  108234. */
  108235. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  108236. private _tmpQuat;
  108237. private _tmpQuat2;
  108238. /**
  108239. * Get the parent rotation
  108240. * @returns The parent rotation
  108241. */
  108242. getParentsRotation(): Quaternion;
  108243. /**
  108244. * this function is executed by the physics engine.
  108245. */
  108246. beforeStep: () => void;
  108247. /**
  108248. * this function is executed by the physics engine
  108249. */
  108250. afterStep: () => void;
  108251. /**
  108252. * Legacy collision detection event support
  108253. */
  108254. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  108255. /**
  108256. * event and body object due to cannon's event-based architecture.
  108257. */
  108258. onCollide: (e: {
  108259. body: any;
  108260. }) => void;
  108261. /**
  108262. * Apply a force
  108263. * @param force The force to apply
  108264. * @param contactPoint The contact point for the force
  108265. * @returns The physics imposter
  108266. */
  108267. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  108268. /**
  108269. * Apply an impulse
  108270. * @param force The impulse force
  108271. * @param contactPoint The contact point for the impulse force
  108272. * @returns The physics imposter
  108273. */
  108274. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  108275. /**
  108276. * A help function to create a joint
  108277. * @param otherImpostor A physics imposter used to create a joint
  108278. * @param jointType The type of joint
  108279. * @param jointData The data for the joint
  108280. * @returns The physics imposter
  108281. */
  108282. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  108283. /**
  108284. * Add a joint to this impostor with a different impostor
  108285. * @param otherImpostor A physics imposter used to add a joint
  108286. * @param joint The joint to add
  108287. * @returns The physics imposter
  108288. */
  108289. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  108290. /**
  108291. * Add an anchor to a cloth impostor
  108292. * @param otherImpostor rigid impostor to anchor to
  108293. * @param width ratio across width from 0 to 1
  108294. * @param height ratio up height from 0 to 1
  108295. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  108296. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  108297. * @returns impostor the soft imposter
  108298. */
  108299. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  108300. /**
  108301. * Add a hook to a rope impostor
  108302. * @param otherImpostor rigid impostor to anchor to
  108303. * @param length ratio across rope from 0 to 1
  108304. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  108305. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  108306. * @returns impostor the rope imposter
  108307. */
  108308. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  108309. /**
  108310. * Will keep this body still, in a sleep mode.
  108311. * @returns the physics imposter
  108312. */
  108313. sleep(): PhysicsImpostor;
  108314. /**
  108315. * Wake the body up.
  108316. * @returns The physics imposter
  108317. */
  108318. wakeUp(): PhysicsImpostor;
  108319. /**
  108320. * Clones the physics imposter
  108321. * @param newObject The physics imposter clones to this physics-enabled object
  108322. * @returns A nullable physics imposter
  108323. */
  108324. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  108325. /**
  108326. * Disposes the physics imposter
  108327. */
  108328. dispose(): void;
  108329. /**
  108330. * Sets the delta position
  108331. * @param position The delta position amount
  108332. */
  108333. setDeltaPosition(position: Vector3): void;
  108334. /**
  108335. * Sets the delta rotation
  108336. * @param rotation The delta rotation amount
  108337. */
  108338. setDeltaRotation(rotation: Quaternion): void;
  108339. /**
  108340. * Gets the box size of the physics imposter and stores the result in the input parameter
  108341. * @param result Stores the box size
  108342. * @returns The physics imposter
  108343. */
  108344. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  108345. /**
  108346. * Gets the radius of the physics imposter
  108347. * @returns Radius of the physics imposter
  108348. */
  108349. getRadius(): number;
  108350. /**
  108351. * Sync a bone with this impostor
  108352. * @param bone The bone to sync to the impostor.
  108353. * @param boneMesh The mesh that the bone is influencing.
  108354. * @param jointPivot The pivot of the joint / bone in local space.
  108355. * @param distToJoint Optional distance from the impostor to the joint.
  108356. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  108357. */
  108358. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  108359. /**
  108360. * Sync impostor to a bone
  108361. * @param bone The bone that the impostor will be synced to.
  108362. * @param boneMesh The mesh that the bone is influencing.
  108363. * @param jointPivot The pivot of the joint / bone in local space.
  108364. * @param distToJoint Optional distance from the impostor to the joint.
  108365. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  108366. * @param boneAxis Optional vector3 axis the bone is aligned with
  108367. */
  108368. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  108369. /**
  108370. * No-Imposter type
  108371. */
  108372. static NoImpostor: number;
  108373. /**
  108374. * Sphere-Imposter type
  108375. */
  108376. static SphereImpostor: number;
  108377. /**
  108378. * Box-Imposter type
  108379. */
  108380. static BoxImpostor: number;
  108381. /**
  108382. * Plane-Imposter type
  108383. */
  108384. static PlaneImpostor: number;
  108385. /**
  108386. * Mesh-imposter type
  108387. */
  108388. static MeshImpostor: number;
  108389. /**
  108390. * Capsule-Impostor type (Ammo.js plugin only)
  108391. */
  108392. static CapsuleImpostor: number;
  108393. /**
  108394. * Cylinder-Imposter type
  108395. */
  108396. static CylinderImpostor: number;
  108397. /**
  108398. * Particle-Imposter type
  108399. */
  108400. static ParticleImpostor: number;
  108401. /**
  108402. * Heightmap-Imposter type
  108403. */
  108404. static HeightmapImpostor: number;
  108405. /**
  108406. * ConvexHull-Impostor type (Ammo.js plugin only)
  108407. */
  108408. static ConvexHullImpostor: number;
  108409. /**
  108410. * Custom-Imposter type (Ammo.js plugin only)
  108411. */
  108412. static CustomImpostor: number;
  108413. /**
  108414. * Rope-Imposter type
  108415. */
  108416. static RopeImpostor: number;
  108417. /**
  108418. * Cloth-Imposter type
  108419. */
  108420. static ClothImpostor: number;
  108421. /**
  108422. * Softbody-Imposter type
  108423. */
  108424. static SoftbodyImpostor: number;
  108425. }
  108426. }
  108427. declare module BABYLON {
  108428. /**
  108429. * @hidden
  108430. **/
  108431. export class _CreationDataStorage {
  108432. closePath?: boolean;
  108433. closeArray?: boolean;
  108434. idx: number[];
  108435. dashSize: number;
  108436. gapSize: number;
  108437. path3D: Path3D;
  108438. pathArray: Vector3[][];
  108439. arc: number;
  108440. radius: number;
  108441. cap: number;
  108442. tessellation: number;
  108443. }
  108444. /**
  108445. * @hidden
  108446. **/
  108447. class _InstanceDataStorage {
  108448. visibleInstances: any;
  108449. batchCache: _InstancesBatch;
  108450. instancesBufferSize: number;
  108451. instancesBuffer: Nullable<Buffer>;
  108452. instancesData: Float32Array;
  108453. overridenInstanceCount: number;
  108454. isFrozen: boolean;
  108455. previousBatch: Nullable<_InstancesBatch>;
  108456. hardwareInstancedRendering: boolean;
  108457. sideOrientation: number;
  108458. manualUpdate: boolean;
  108459. previousRenderId: number;
  108460. }
  108461. /**
  108462. * @hidden
  108463. **/
  108464. export class _InstancesBatch {
  108465. mustReturn: boolean;
  108466. visibleInstances: Nullable<InstancedMesh[]>[];
  108467. renderSelf: boolean[];
  108468. hardwareInstancedRendering: boolean[];
  108469. }
  108470. /**
  108471. * @hidden
  108472. **/
  108473. class _ThinInstanceDataStorage {
  108474. instancesCount: number;
  108475. matrixBuffer: Nullable<Buffer>;
  108476. matrixBufferSize: number;
  108477. matrixData: Nullable<Float32Array>;
  108478. boundingVectors: Array<Vector3>;
  108479. worldMatrices: Nullable<Matrix[]>;
  108480. }
  108481. /**
  108482. * Class used to represent renderable models
  108483. */
  108484. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  108485. /**
  108486. * Mesh side orientation : usually the external or front surface
  108487. */
  108488. static readonly FRONTSIDE: number;
  108489. /**
  108490. * Mesh side orientation : usually the internal or back surface
  108491. */
  108492. static readonly BACKSIDE: number;
  108493. /**
  108494. * Mesh side orientation : both internal and external or front and back surfaces
  108495. */
  108496. static readonly DOUBLESIDE: number;
  108497. /**
  108498. * Mesh side orientation : by default, `FRONTSIDE`
  108499. */
  108500. static readonly DEFAULTSIDE: number;
  108501. /**
  108502. * Mesh cap setting : no cap
  108503. */
  108504. static readonly NO_CAP: number;
  108505. /**
  108506. * Mesh cap setting : one cap at the beginning of the mesh
  108507. */
  108508. static readonly CAP_START: number;
  108509. /**
  108510. * Mesh cap setting : one cap at the end of the mesh
  108511. */
  108512. static readonly CAP_END: number;
  108513. /**
  108514. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  108515. */
  108516. static readonly CAP_ALL: number;
  108517. /**
  108518. * Mesh pattern setting : no flip or rotate
  108519. */
  108520. static readonly NO_FLIP: number;
  108521. /**
  108522. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  108523. */
  108524. static readonly FLIP_TILE: number;
  108525. /**
  108526. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  108527. */
  108528. static readonly ROTATE_TILE: number;
  108529. /**
  108530. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  108531. */
  108532. static readonly FLIP_ROW: number;
  108533. /**
  108534. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  108535. */
  108536. static readonly ROTATE_ROW: number;
  108537. /**
  108538. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  108539. */
  108540. static readonly FLIP_N_ROTATE_TILE: number;
  108541. /**
  108542. * Mesh pattern setting : rotate pattern and rotate
  108543. */
  108544. static readonly FLIP_N_ROTATE_ROW: number;
  108545. /**
  108546. * Mesh tile positioning : part tiles same on left/right or top/bottom
  108547. */
  108548. static readonly CENTER: number;
  108549. /**
  108550. * Mesh tile positioning : part tiles on left
  108551. */
  108552. static readonly LEFT: number;
  108553. /**
  108554. * Mesh tile positioning : part tiles on right
  108555. */
  108556. static readonly RIGHT: number;
  108557. /**
  108558. * Mesh tile positioning : part tiles on top
  108559. */
  108560. static readonly TOP: number;
  108561. /**
  108562. * Mesh tile positioning : part tiles on bottom
  108563. */
  108564. static readonly BOTTOM: number;
  108565. /**
  108566. * Gets the default side orientation.
  108567. * @param orientation the orientation to value to attempt to get
  108568. * @returns the default orientation
  108569. * @hidden
  108570. */
  108571. static _GetDefaultSideOrientation(orientation?: number): number;
  108572. private _internalMeshDataInfo;
  108573. get computeBonesUsingShaders(): boolean;
  108574. set computeBonesUsingShaders(value: boolean);
  108575. /**
  108576. * An event triggered before rendering the mesh
  108577. */
  108578. get onBeforeRenderObservable(): Observable<Mesh>;
  108579. /**
  108580. * An event triggered before binding the mesh
  108581. */
  108582. get onBeforeBindObservable(): Observable<Mesh>;
  108583. /**
  108584. * An event triggered after rendering the mesh
  108585. */
  108586. get onAfterRenderObservable(): Observable<Mesh>;
  108587. /**
  108588. * An event triggered before drawing the mesh
  108589. */
  108590. get onBeforeDrawObservable(): Observable<Mesh>;
  108591. private _onBeforeDrawObserver;
  108592. /**
  108593. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  108594. */
  108595. set onBeforeDraw(callback: () => void);
  108596. get hasInstances(): boolean;
  108597. get hasThinInstances(): boolean;
  108598. /**
  108599. * Gets the delay loading state of the mesh (when delay loading is turned on)
  108600. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  108601. */
  108602. delayLoadState: number;
  108603. /**
  108604. * Gets the list of instances created from this mesh
  108605. * it is not supposed to be modified manually.
  108606. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  108607. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  108608. */
  108609. instances: InstancedMesh[];
  108610. /**
  108611. * Gets the file containing delay loading data for this mesh
  108612. */
  108613. delayLoadingFile: string;
  108614. /** @hidden */
  108615. _binaryInfo: any;
  108616. /**
  108617. * User defined function used to change how LOD level selection is done
  108618. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108619. */
  108620. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  108621. /**
  108622. * Gets or sets the morph target manager
  108623. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  108624. */
  108625. get morphTargetManager(): Nullable<MorphTargetManager>;
  108626. set morphTargetManager(value: Nullable<MorphTargetManager>);
  108627. /** @hidden */
  108628. _creationDataStorage: Nullable<_CreationDataStorage>;
  108629. /** @hidden */
  108630. _geometry: Nullable<Geometry>;
  108631. /** @hidden */
  108632. _delayInfo: Array<string>;
  108633. /** @hidden */
  108634. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  108635. /** @hidden */
  108636. _instanceDataStorage: _InstanceDataStorage;
  108637. /** @hidden */
  108638. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  108639. private _effectiveMaterial;
  108640. /** @hidden */
  108641. _shouldGenerateFlatShading: boolean;
  108642. /** @hidden */
  108643. _originalBuilderSideOrientation: number;
  108644. /**
  108645. * Use this property to change the original side orientation defined at construction time
  108646. */
  108647. overrideMaterialSideOrientation: Nullable<number>;
  108648. /**
  108649. * Gets the source mesh (the one used to clone this one from)
  108650. */
  108651. get source(): Nullable<Mesh>;
  108652. /**
  108653. * Gets the list of clones of this mesh
  108654. * The scene must have been constructed with useClonedMeshMap=true for this to work!
  108655. * Note that useClonedMeshMap=true is the default setting
  108656. */
  108657. get cloneMeshMap(): Nullable<{
  108658. [id: string]: Mesh | undefined;
  108659. }>;
  108660. /**
  108661. * Gets or sets a boolean indicating that this mesh does not use index buffer
  108662. */
  108663. get isUnIndexed(): boolean;
  108664. set isUnIndexed(value: boolean);
  108665. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  108666. get worldMatrixInstancedBuffer(): Float32Array;
  108667. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  108668. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  108669. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  108670. /**
  108671. * @constructor
  108672. * @param name The value used by scene.getMeshByName() to do a lookup.
  108673. * @param scene The scene to add this mesh to.
  108674. * @param parent The parent of this mesh, if it has one
  108675. * @param source An optional Mesh from which geometry is shared, cloned.
  108676. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  108677. * When false, achieved by calling a clone(), also passing False.
  108678. * This will make creation of children, recursive.
  108679. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  108680. */
  108681. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  108682. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  108683. doNotInstantiate: boolean;
  108684. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  108685. /**
  108686. * Gets the class name
  108687. * @returns the string "Mesh".
  108688. */
  108689. getClassName(): string;
  108690. /** @hidden */
  108691. get _isMesh(): boolean;
  108692. /**
  108693. * Returns a description of this mesh
  108694. * @param fullDetails define if full details about this mesh must be used
  108695. * @returns a descriptive string representing this mesh
  108696. */
  108697. toString(fullDetails?: boolean): string;
  108698. /** @hidden */
  108699. _unBindEffect(): void;
  108700. /**
  108701. * Gets a boolean indicating if this mesh has LOD
  108702. */
  108703. get hasLODLevels(): boolean;
  108704. /**
  108705. * Gets the list of MeshLODLevel associated with the current mesh
  108706. * @returns an array of MeshLODLevel
  108707. */
  108708. getLODLevels(): MeshLODLevel[];
  108709. private _sortLODLevels;
  108710. /**
  108711. * Add a mesh as LOD level triggered at the given distance.
  108712. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108713. * @param distance The distance from the center of the object to show this level
  108714. * @param mesh The mesh to be added as LOD level (can be null)
  108715. * @return This mesh (for chaining)
  108716. */
  108717. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  108718. /**
  108719. * Returns the LOD level mesh at the passed distance or null if not found.
  108720. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108721. * @param distance The distance from the center of the object to show this level
  108722. * @returns a Mesh or `null`
  108723. */
  108724. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  108725. /**
  108726. * Remove a mesh from the LOD array
  108727. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108728. * @param mesh defines the mesh to be removed
  108729. * @return This mesh (for chaining)
  108730. */
  108731. removeLODLevel(mesh: Mesh): Mesh;
  108732. /**
  108733. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  108734. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  108735. * @param camera defines the camera to use to compute distance
  108736. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  108737. * @return This mesh (for chaining)
  108738. */
  108739. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  108740. /**
  108741. * Gets the mesh internal Geometry object
  108742. */
  108743. get geometry(): Nullable<Geometry>;
  108744. /**
  108745. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  108746. * @returns the total number of vertices
  108747. */
  108748. getTotalVertices(): number;
  108749. /**
  108750. * Returns the content of an associated vertex buffer
  108751. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108752. * - VertexBuffer.PositionKind
  108753. * - VertexBuffer.UVKind
  108754. * - VertexBuffer.UV2Kind
  108755. * - VertexBuffer.UV3Kind
  108756. * - VertexBuffer.UV4Kind
  108757. * - VertexBuffer.UV5Kind
  108758. * - VertexBuffer.UV6Kind
  108759. * - VertexBuffer.ColorKind
  108760. * - VertexBuffer.MatricesIndicesKind
  108761. * - VertexBuffer.MatricesIndicesExtraKind
  108762. * - VertexBuffer.MatricesWeightsKind
  108763. * - VertexBuffer.MatricesWeightsExtraKind
  108764. * @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
  108765. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  108766. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  108767. */
  108768. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  108769. /**
  108770. * Returns the mesh VertexBuffer object from the requested `kind`
  108771. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108772. * - VertexBuffer.PositionKind
  108773. * - VertexBuffer.NormalKind
  108774. * - VertexBuffer.UVKind
  108775. * - VertexBuffer.UV2Kind
  108776. * - VertexBuffer.UV3Kind
  108777. * - VertexBuffer.UV4Kind
  108778. * - VertexBuffer.UV5Kind
  108779. * - VertexBuffer.UV6Kind
  108780. * - VertexBuffer.ColorKind
  108781. * - VertexBuffer.MatricesIndicesKind
  108782. * - VertexBuffer.MatricesIndicesExtraKind
  108783. * - VertexBuffer.MatricesWeightsKind
  108784. * - VertexBuffer.MatricesWeightsExtraKind
  108785. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  108786. */
  108787. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  108788. /**
  108789. * Tests if a specific vertex buffer is associated with this mesh
  108790. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  108791. * - VertexBuffer.PositionKind
  108792. * - VertexBuffer.NormalKind
  108793. * - VertexBuffer.UVKind
  108794. * - VertexBuffer.UV2Kind
  108795. * - VertexBuffer.UV3Kind
  108796. * - VertexBuffer.UV4Kind
  108797. * - VertexBuffer.UV5Kind
  108798. * - VertexBuffer.UV6Kind
  108799. * - VertexBuffer.ColorKind
  108800. * - VertexBuffer.MatricesIndicesKind
  108801. * - VertexBuffer.MatricesIndicesExtraKind
  108802. * - VertexBuffer.MatricesWeightsKind
  108803. * - VertexBuffer.MatricesWeightsExtraKind
  108804. * @returns a boolean
  108805. */
  108806. isVerticesDataPresent(kind: string): boolean;
  108807. /**
  108808. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  108809. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  108810. * - VertexBuffer.PositionKind
  108811. * - VertexBuffer.UVKind
  108812. * - VertexBuffer.UV2Kind
  108813. * - VertexBuffer.UV3Kind
  108814. * - VertexBuffer.UV4Kind
  108815. * - VertexBuffer.UV5Kind
  108816. * - VertexBuffer.UV6Kind
  108817. * - VertexBuffer.ColorKind
  108818. * - VertexBuffer.MatricesIndicesKind
  108819. * - VertexBuffer.MatricesIndicesExtraKind
  108820. * - VertexBuffer.MatricesWeightsKind
  108821. * - VertexBuffer.MatricesWeightsExtraKind
  108822. * @returns a boolean
  108823. */
  108824. isVertexBufferUpdatable(kind: string): boolean;
  108825. /**
  108826. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  108827. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108828. * - VertexBuffer.PositionKind
  108829. * - VertexBuffer.NormalKind
  108830. * - VertexBuffer.UVKind
  108831. * - VertexBuffer.UV2Kind
  108832. * - VertexBuffer.UV3Kind
  108833. * - VertexBuffer.UV4Kind
  108834. * - VertexBuffer.UV5Kind
  108835. * - VertexBuffer.UV6Kind
  108836. * - VertexBuffer.ColorKind
  108837. * - VertexBuffer.MatricesIndicesKind
  108838. * - VertexBuffer.MatricesIndicesExtraKind
  108839. * - VertexBuffer.MatricesWeightsKind
  108840. * - VertexBuffer.MatricesWeightsExtraKind
  108841. * @returns an array of strings
  108842. */
  108843. getVerticesDataKinds(): string[];
  108844. /**
  108845. * Returns a positive integer : the total number of indices in this mesh geometry.
  108846. * @returns the numner of indices or zero if the mesh has no geometry.
  108847. */
  108848. getTotalIndices(): number;
  108849. /**
  108850. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  108851. * @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.
  108852. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  108853. * @returns the indices array or an empty array if the mesh has no geometry
  108854. */
  108855. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  108856. get isBlocked(): boolean;
  108857. /**
  108858. * Determine if the current mesh is ready to be rendered
  108859. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  108860. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  108861. * @returns true if all associated assets are ready (material, textures, shaders)
  108862. */
  108863. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  108864. /**
  108865. * 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.
  108866. */
  108867. get areNormalsFrozen(): boolean;
  108868. /**
  108869. * 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.
  108870. * @returns the current mesh
  108871. */
  108872. freezeNormals(): Mesh;
  108873. /**
  108874. * 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
  108875. * @returns the current mesh
  108876. */
  108877. unfreezeNormals(): Mesh;
  108878. /**
  108879. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  108880. */
  108881. set overridenInstanceCount(count: number);
  108882. /** @hidden */
  108883. _preActivate(): Mesh;
  108884. /** @hidden */
  108885. _preActivateForIntermediateRendering(renderId: number): Mesh;
  108886. /** @hidden */
  108887. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  108888. protected _afterComputeWorldMatrix(): void;
  108889. /** @hidden */
  108890. _postActivate(): void;
  108891. /**
  108892. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  108893. * This means the mesh underlying bounding box and sphere are recomputed.
  108894. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  108895. * @returns the current mesh
  108896. */
  108897. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  108898. /** @hidden */
  108899. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  108900. /**
  108901. * This function will subdivide the mesh into multiple submeshes
  108902. * @param count defines the expected number of submeshes
  108903. */
  108904. subdivide(count: number): void;
  108905. /**
  108906. * Copy a FloatArray into a specific associated vertex buffer
  108907. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  108908. * - VertexBuffer.PositionKind
  108909. * - VertexBuffer.UVKind
  108910. * - VertexBuffer.UV2Kind
  108911. * - VertexBuffer.UV3Kind
  108912. * - VertexBuffer.UV4Kind
  108913. * - VertexBuffer.UV5Kind
  108914. * - VertexBuffer.UV6Kind
  108915. * - VertexBuffer.ColorKind
  108916. * - VertexBuffer.MatricesIndicesKind
  108917. * - VertexBuffer.MatricesIndicesExtraKind
  108918. * - VertexBuffer.MatricesWeightsKind
  108919. * - VertexBuffer.MatricesWeightsExtraKind
  108920. * @param data defines the data source
  108921. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  108922. * @param stride defines the data stride size (can be null)
  108923. * @returns the current mesh
  108924. */
  108925. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  108926. /**
  108927. * Delete a vertex buffer associated with this mesh
  108928. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  108929. * - VertexBuffer.PositionKind
  108930. * - VertexBuffer.UVKind
  108931. * - VertexBuffer.UV2Kind
  108932. * - VertexBuffer.UV3Kind
  108933. * - VertexBuffer.UV4Kind
  108934. * - VertexBuffer.UV5Kind
  108935. * - VertexBuffer.UV6Kind
  108936. * - VertexBuffer.ColorKind
  108937. * - VertexBuffer.MatricesIndicesKind
  108938. * - VertexBuffer.MatricesIndicesExtraKind
  108939. * - VertexBuffer.MatricesWeightsKind
  108940. * - VertexBuffer.MatricesWeightsExtraKind
  108941. */
  108942. removeVerticesData(kind: string): void;
  108943. /**
  108944. * Flags an associated vertex buffer as updatable
  108945. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  108946. * - VertexBuffer.PositionKind
  108947. * - VertexBuffer.UVKind
  108948. * - VertexBuffer.UV2Kind
  108949. * - VertexBuffer.UV3Kind
  108950. * - VertexBuffer.UV4Kind
  108951. * - VertexBuffer.UV5Kind
  108952. * - VertexBuffer.UV6Kind
  108953. * - VertexBuffer.ColorKind
  108954. * - VertexBuffer.MatricesIndicesKind
  108955. * - VertexBuffer.MatricesIndicesExtraKind
  108956. * - VertexBuffer.MatricesWeightsKind
  108957. * - VertexBuffer.MatricesWeightsExtraKind
  108958. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  108959. */
  108960. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  108961. /**
  108962. * Sets the mesh global Vertex Buffer
  108963. * @param buffer defines the buffer to use
  108964. * @returns the current mesh
  108965. */
  108966. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  108967. /**
  108968. * Update a specific associated vertex buffer
  108969. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  108970. * - VertexBuffer.PositionKind
  108971. * - VertexBuffer.UVKind
  108972. * - VertexBuffer.UV2Kind
  108973. * - VertexBuffer.UV3Kind
  108974. * - VertexBuffer.UV4Kind
  108975. * - VertexBuffer.UV5Kind
  108976. * - VertexBuffer.UV6Kind
  108977. * - VertexBuffer.ColorKind
  108978. * - VertexBuffer.MatricesIndicesKind
  108979. * - VertexBuffer.MatricesIndicesExtraKind
  108980. * - VertexBuffer.MatricesWeightsKind
  108981. * - VertexBuffer.MatricesWeightsExtraKind
  108982. * @param data defines the data source
  108983. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  108984. * @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)
  108985. * @returns the current mesh
  108986. */
  108987. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  108988. /**
  108989. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  108990. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  108991. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  108992. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  108993. * @returns the current mesh
  108994. */
  108995. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  108996. /**
  108997. * Creates a un-shared specific occurence of the geometry for the mesh.
  108998. * @returns the current mesh
  108999. */
  109000. makeGeometryUnique(): Mesh;
  109001. /**
  109002. * Set the index buffer of this mesh
  109003. * @param indices defines the source data
  109004. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  109005. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  109006. * @returns the current mesh
  109007. */
  109008. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  109009. /**
  109010. * Update the current index buffer
  109011. * @param indices defines the source data
  109012. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  109013. * @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)
  109014. * @returns the current mesh
  109015. */
  109016. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  109017. /**
  109018. * Invert the geometry to move from a right handed system to a left handed one.
  109019. * @returns the current mesh
  109020. */
  109021. toLeftHanded(): Mesh;
  109022. /** @hidden */
  109023. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  109024. /** @hidden */
  109025. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  109026. /**
  109027. * Registers for this mesh a javascript function called just before the rendering process
  109028. * @param func defines the function to call before rendering this mesh
  109029. * @returns the current mesh
  109030. */
  109031. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  109032. /**
  109033. * Disposes a previously registered javascript function called before the rendering
  109034. * @param func defines the function to remove
  109035. * @returns the current mesh
  109036. */
  109037. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  109038. /**
  109039. * Registers for this mesh a javascript function called just after the rendering is complete
  109040. * @param func defines the function to call after rendering this mesh
  109041. * @returns the current mesh
  109042. */
  109043. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  109044. /**
  109045. * Disposes a previously registered javascript function called after the rendering.
  109046. * @param func defines the function to remove
  109047. * @returns the current mesh
  109048. */
  109049. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  109050. /** @hidden */
  109051. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  109052. /** @hidden */
  109053. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  109054. /** @hidden */
  109055. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  109056. /** @hidden */
  109057. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  109058. /** @hidden */
  109059. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  109060. /** @hidden */
  109061. _rebuild(): void;
  109062. /** @hidden */
  109063. _freeze(): void;
  109064. /** @hidden */
  109065. _unFreeze(): void;
  109066. /**
  109067. * 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
  109068. * @param subMesh defines the subMesh to render
  109069. * @param enableAlphaMode defines if alpha mode can be changed
  109070. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  109071. * @returns the current mesh
  109072. */
  109073. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  109074. private _onBeforeDraw;
  109075. /**
  109076. * Renormalize the mesh and patch it up if there are no weights
  109077. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  109078. * However in the case of zero weights then we set just a single influence to 1.
  109079. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  109080. */
  109081. cleanMatrixWeights(): void;
  109082. private normalizeSkinFourWeights;
  109083. private normalizeSkinWeightsAndExtra;
  109084. /**
  109085. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  109086. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  109087. * the user know there was an issue with importing the mesh
  109088. * @returns a validation object with skinned, valid and report string
  109089. */
  109090. validateSkinning(): {
  109091. skinned: boolean;
  109092. valid: boolean;
  109093. report: string;
  109094. };
  109095. /** @hidden */
  109096. _checkDelayState(): Mesh;
  109097. private _queueLoad;
  109098. /**
  109099. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  109100. * A mesh is in the frustum if its bounding box intersects the frustum
  109101. * @param frustumPlanes defines the frustum to test
  109102. * @returns true if the mesh is in the frustum planes
  109103. */
  109104. isInFrustum(frustumPlanes: Plane[]): boolean;
  109105. /**
  109106. * Sets the mesh material by the material or multiMaterial `id` property
  109107. * @param id is a string identifying the material or the multiMaterial
  109108. * @returns the current mesh
  109109. */
  109110. setMaterialByID(id: string): Mesh;
  109111. /**
  109112. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  109113. * @returns an array of IAnimatable
  109114. */
  109115. getAnimatables(): IAnimatable[];
  109116. /**
  109117. * Modifies the mesh geometry according to the passed transformation matrix.
  109118. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  109119. * The mesh normals are modified using the same transformation.
  109120. * Note that, under the hood, this method sets a new VertexBuffer each call.
  109121. * @param transform defines the transform matrix to use
  109122. * @see https://doc.babylonjs.com/resources/baking_transformations
  109123. * @returns the current mesh
  109124. */
  109125. bakeTransformIntoVertices(transform: Matrix): Mesh;
  109126. /**
  109127. * Modifies the mesh geometry according to its own current World Matrix.
  109128. * The mesh World Matrix is then reset.
  109129. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  109130. * Note that, under the hood, this method sets a new VertexBuffer each call.
  109131. * @see https://doc.babylonjs.com/resources/baking_transformations
  109132. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  109133. * @returns the current mesh
  109134. */
  109135. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  109136. /** @hidden */
  109137. get _positions(): Nullable<Vector3[]>;
  109138. /** @hidden */
  109139. _resetPointsArrayCache(): Mesh;
  109140. /** @hidden */
  109141. _generatePointsArray(): boolean;
  109142. /**
  109143. * Returns a new Mesh object generated from the current mesh properties.
  109144. * This method must not get confused with createInstance()
  109145. * @param name is a string, the name given to the new mesh
  109146. * @param newParent can be any Node object (default `null`)
  109147. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  109148. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  109149. * @returns a new mesh
  109150. */
  109151. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  109152. /**
  109153. * Releases resources associated with this mesh.
  109154. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  109155. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  109156. */
  109157. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  109158. /** @hidden */
  109159. _disposeInstanceSpecificData(): void;
  109160. /** @hidden */
  109161. _disposeThinInstanceSpecificData(): void;
  109162. /**
  109163. * Modifies the mesh geometry according to a displacement map.
  109164. * 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.
  109165. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  109166. * @param url is a string, the URL from the image file is to be downloaded.
  109167. * @param minHeight is the lower limit of the displacement.
  109168. * @param maxHeight is the upper limit of the displacement.
  109169. * @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.
  109170. * @param uvOffset is an optional vector2 used to offset UV.
  109171. * @param uvScale is an optional vector2 used to scale UV.
  109172. * @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.
  109173. * @returns the Mesh.
  109174. */
  109175. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  109176. /**
  109177. * Modifies the mesh geometry according to a displacementMap buffer.
  109178. * 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.
  109179. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  109180. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  109181. * @param heightMapWidth is the width of the buffer image.
  109182. * @param heightMapHeight is the height of the buffer image.
  109183. * @param minHeight is the lower limit of the displacement.
  109184. * @param maxHeight is the upper limit of the displacement.
  109185. * @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.
  109186. * @param uvOffset is an optional vector2 used to offset UV.
  109187. * @param uvScale is an optional vector2 used to scale UV.
  109188. * @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.
  109189. * @returns the Mesh.
  109190. */
  109191. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  109192. /**
  109193. * Modify the mesh to get a flat shading rendering.
  109194. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  109195. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  109196. * @returns current mesh
  109197. */
  109198. convertToFlatShadedMesh(): Mesh;
  109199. /**
  109200. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  109201. * In other words, more vertices, no more indices and a single bigger VBO.
  109202. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  109203. * @returns current mesh
  109204. */
  109205. convertToUnIndexedMesh(): Mesh;
  109206. /**
  109207. * Inverses facet orientations.
  109208. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  109209. * @param flipNormals will also inverts the normals
  109210. * @returns current mesh
  109211. */
  109212. flipFaces(flipNormals?: boolean): Mesh;
  109213. /**
  109214. * Increase the number of facets and hence vertices in a mesh
  109215. * Vertex normals are interpolated from existing vertex normals
  109216. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  109217. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  109218. */
  109219. increaseVertices(numberPerEdge: number): void;
  109220. /**
  109221. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  109222. * This will undo any application of covertToFlatShadedMesh
  109223. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  109224. */
  109225. forceSharedVertices(): void;
  109226. /** @hidden */
  109227. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  109228. /** @hidden */
  109229. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  109230. /**
  109231. * Creates a new InstancedMesh object from the mesh model.
  109232. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  109233. * @param name defines the name of the new instance
  109234. * @returns a new InstancedMesh
  109235. */
  109236. createInstance(name: string): InstancedMesh;
  109237. /**
  109238. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  109239. * After this call, all the mesh instances have the same submeshes than the current mesh.
  109240. * @returns the current mesh
  109241. */
  109242. synchronizeInstances(): Mesh;
  109243. /**
  109244. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  109245. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  109246. * This should be used together with the simplification to avoid disappearing triangles.
  109247. * @param successCallback an optional success callback to be called after the optimization finished.
  109248. * @returns the current mesh
  109249. */
  109250. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  109251. /**
  109252. * Serialize current mesh
  109253. * @param serializationObject defines the object which will receive the serialization data
  109254. */
  109255. serialize(serializationObject: any): void;
  109256. /** @hidden */
  109257. _syncGeometryWithMorphTargetManager(): void;
  109258. /** @hidden */
  109259. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  109260. /**
  109261. * Returns a new Mesh object parsed from the source provided.
  109262. * @param parsedMesh is the source
  109263. * @param scene defines the hosting scene
  109264. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  109265. * @returns a new Mesh
  109266. */
  109267. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  109268. /**
  109269. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  109270. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  109271. * @param name defines the name of the mesh to create
  109272. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  109273. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  109274. * @param closePath creates a seam between the first and the last points of each path of the path array
  109275. * @param offset is taken in account only if the `pathArray` is containing a single path
  109276. * @param scene defines the hosting scene
  109277. * @param updatable defines if the mesh must be flagged as updatable
  109278. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109279. * @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)
  109280. * @returns a new Mesh
  109281. */
  109282. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  109283. /**
  109284. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  109285. * @param name defines the name of the mesh to create
  109286. * @param radius sets the radius size (float) of the polygon (default 0.5)
  109287. * @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
  109288. * @param scene defines the hosting scene
  109289. * @param updatable defines if the mesh must be flagged as updatable
  109290. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109291. * @returns a new Mesh
  109292. */
  109293. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  109294. /**
  109295. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  109296. * @param name defines the name of the mesh to create
  109297. * @param size sets the size (float) of each box side (default 1)
  109298. * @param scene defines the hosting scene
  109299. * @param updatable defines if the mesh must be flagged as updatable
  109300. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109301. * @returns a new Mesh
  109302. */
  109303. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  109304. /**
  109305. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  109306. * @param name defines the name of the mesh to create
  109307. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  109308. * @param diameter sets the diameter size (float) of the sphere (default 1)
  109309. * @param scene defines the hosting scene
  109310. * @param updatable defines if the mesh must be flagged as updatable
  109311. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109312. * @returns a new Mesh
  109313. */
  109314. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  109315. /**
  109316. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  109317. * @param name defines the name of the mesh to create
  109318. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  109319. * @param diameter sets the diameter size (float) of the sphere (default 1)
  109320. * @param scene defines the hosting scene
  109321. * @returns a new Mesh
  109322. */
  109323. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  109324. /**
  109325. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  109326. * @param name defines the name of the mesh to create
  109327. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  109328. * @param diameterTop set the top cap diameter (floats, default 1)
  109329. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  109330. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  109331. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  109332. * @param scene defines the hosting scene
  109333. * @param updatable defines if the mesh must be flagged as updatable
  109334. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109335. * @returns a new Mesh
  109336. */
  109337. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  109338. /**
  109339. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  109340. * @param name defines the name of the mesh to create
  109341. * @param diameter sets the diameter size (float) of the torus (default 1)
  109342. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  109343. * @param tessellation sets the number of torus sides (postive integer, default 16)
  109344. * @param scene defines the hosting scene
  109345. * @param updatable defines if the mesh must be flagged as updatable
  109346. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109347. * @returns a new Mesh
  109348. */
  109349. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  109350. /**
  109351. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  109352. * @param name defines the name of the mesh to create
  109353. * @param radius sets the global radius size (float) of the torus knot (default 2)
  109354. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  109355. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  109356. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  109357. * @param p the number of windings on X axis (positive integers, default 2)
  109358. * @param q the number of windings on Y axis (positive integers, default 3)
  109359. * @param scene defines the hosting scene
  109360. * @param updatable defines if the mesh must be flagged as updatable
  109361. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109362. * @returns a new Mesh
  109363. */
  109364. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  109365. /**
  109366. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  109367. * @param name defines the name of the mesh to create
  109368. * @param points is an array successive Vector3
  109369. * @param scene defines the hosting scene
  109370. * @param updatable defines if the mesh must be flagged as updatable
  109371. * @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).
  109372. * @returns a new Mesh
  109373. */
  109374. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  109375. /**
  109376. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  109377. * @param name defines the name of the mesh to create
  109378. * @param points is an array successive Vector3
  109379. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  109380. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  109381. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  109382. * @param scene defines the hosting scene
  109383. * @param updatable defines if the mesh must be flagged as updatable
  109384. * @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)
  109385. * @returns a new Mesh
  109386. */
  109387. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  109388. /**
  109389. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  109390. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  109391. * 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.
  109392. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  109393. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  109394. * Remember you can only change the shape positions, not their number when updating a polygon.
  109395. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  109396. * @param name defines the name of the mesh to create
  109397. * @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
  109398. * @param scene defines the hosting scene
  109399. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  109400. * @param updatable defines if the mesh must be flagged as updatable
  109401. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109402. * @param earcutInjection can be used to inject your own earcut reference
  109403. * @returns a new Mesh
  109404. */
  109405. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  109406. /**
  109407. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  109408. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  109409. * @param name defines the name of the mesh to create
  109410. * @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
  109411. * @param depth defines the height of extrusion
  109412. * @param scene defines the hosting scene
  109413. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  109414. * @param updatable defines if the mesh must be flagged as updatable
  109415. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109416. * @param earcutInjection can be used to inject your own earcut reference
  109417. * @returns a new Mesh
  109418. */
  109419. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  109420. /**
  109421. * Creates an extruded shape mesh.
  109422. * 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
  109423. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  109424. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  109425. * @param name defines the name of the mesh to create
  109426. * @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
  109427. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  109428. * @param scale is the value to scale the shape
  109429. * @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
  109430. * @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
  109431. * @param scene defines the hosting scene
  109432. * @param updatable defines if the mesh must be flagged as updatable
  109433. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109434. * @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)
  109435. * @returns a new Mesh
  109436. */
  109437. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  109438. /**
  109439. * Creates an custom extruded shape mesh.
  109440. * The custom extrusion is a parametric shape.
  109441. * It has no predefined shape. Its final shape will depend on the input parameters.
  109442. * Please consider using the same method from the MeshBuilder class instead
  109443. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  109444. * @param name defines the name of the mesh to create
  109445. * @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
  109446. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  109447. * @param scaleFunction is a custom Javascript function called on each path point
  109448. * @param rotationFunction is a custom Javascript function called on each path point
  109449. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  109450. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  109451. * @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
  109452. * @param scene defines the hosting scene
  109453. * @param updatable defines if the mesh must be flagged as updatable
  109454. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109455. * @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)
  109456. * @returns a new Mesh
  109457. */
  109458. 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;
  109459. /**
  109460. * Creates lathe mesh.
  109461. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  109462. * Please consider using the same method from the MeshBuilder class instead
  109463. * @param name defines the name of the mesh to create
  109464. * @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
  109465. * @param radius is the radius value of the lathe
  109466. * @param tessellation is the side number of the lathe.
  109467. * @param scene defines the hosting scene
  109468. * @param updatable defines if the mesh must be flagged as updatable
  109469. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109470. * @returns a new Mesh
  109471. */
  109472. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  109473. /**
  109474. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  109475. * @param name defines the name of the mesh to create
  109476. * @param size sets the size (float) of both sides of the plane at once (default 1)
  109477. * @param scene defines the hosting scene
  109478. * @param updatable defines if the mesh must be flagged as updatable
  109479. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109480. * @returns a new Mesh
  109481. */
  109482. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  109483. /**
  109484. * Creates a ground mesh.
  109485. * Please consider using the same method from the MeshBuilder class instead
  109486. * @param name defines the name of the mesh to create
  109487. * @param width set the width of the ground
  109488. * @param height set the height of the ground
  109489. * @param subdivisions sets the number of subdivisions per side
  109490. * @param scene defines the hosting scene
  109491. * @param updatable defines if the mesh must be flagged as updatable
  109492. * @returns a new Mesh
  109493. */
  109494. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  109495. /**
  109496. * Creates a tiled ground mesh.
  109497. * Please consider using the same method from the MeshBuilder class instead
  109498. * @param name defines the name of the mesh to create
  109499. * @param xmin set the ground minimum X coordinate
  109500. * @param zmin set the ground minimum Y coordinate
  109501. * @param xmax set the ground maximum X coordinate
  109502. * @param zmax set the ground maximum Z coordinate
  109503. * @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
  109504. * @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
  109505. * @param scene defines the hosting scene
  109506. * @param updatable defines if the mesh must be flagged as updatable
  109507. * @returns a new Mesh
  109508. */
  109509. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  109510. w: number;
  109511. h: number;
  109512. }, precision: {
  109513. w: number;
  109514. h: number;
  109515. }, scene: Scene, updatable?: boolean): Mesh;
  109516. /**
  109517. * Creates a ground mesh from a height map.
  109518. * Please consider using the same method from the MeshBuilder class instead
  109519. * @see https://doc.babylonjs.com/babylon101/height_map
  109520. * @param name defines the name of the mesh to create
  109521. * @param url sets the URL of the height map image resource
  109522. * @param width set the ground width size
  109523. * @param height set the ground height size
  109524. * @param subdivisions sets the number of subdivision per side
  109525. * @param minHeight is the minimum altitude on the ground
  109526. * @param maxHeight is the maximum altitude on the ground
  109527. * @param scene defines the hosting scene
  109528. * @param updatable defines if the mesh must be flagged as updatable
  109529. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  109530. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  109531. * @returns a new Mesh
  109532. */
  109533. 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;
  109534. /**
  109535. * Creates a tube mesh.
  109536. * The tube is a parametric shape.
  109537. * It has no predefined shape. Its final shape will depend on the input parameters.
  109538. * Please consider using the same method from the MeshBuilder class instead
  109539. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  109540. * @param name defines the name of the mesh to create
  109541. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  109542. * @param radius sets the tube radius size
  109543. * @param tessellation is the number of sides on the tubular surface
  109544. * @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
  109545. * @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
  109546. * @param scene defines the hosting scene
  109547. * @param updatable defines if the mesh must be flagged as updatable
  109548. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  109549. * @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)
  109550. * @returns a new Mesh
  109551. */
  109552. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  109553. (i: number, distance: number): number;
  109554. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  109555. /**
  109556. * Creates a polyhedron mesh.
  109557. * Please consider using the same method from the MeshBuilder class instead.
  109558. * * 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
  109559. * * The parameter `size` (positive float, default 1) sets the polygon size
  109560. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  109561. * * 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`
  109562. * * 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
  109563. * * 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)`)
  109564. * * 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
  109565. * * 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
  109566. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  109567. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  109568. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  109569. * @param name defines the name of the mesh to create
  109570. * @param options defines the options used to create the mesh
  109571. * @param scene defines the hosting scene
  109572. * @returns a new Mesh
  109573. */
  109574. static CreatePolyhedron(name: string, options: {
  109575. type?: number;
  109576. size?: number;
  109577. sizeX?: number;
  109578. sizeY?: number;
  109579. sizeZ?: number;
  109580. custom?: any;
  109581. faceUV?: Vector4[];
  109582. faceColors?: Color4[];
  109583. updatable?: boolean;
  109584. sideOrientation?: number;
  109585. }, scene: Scene): Mesh;
  109586. /**
  109587. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  109588. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  109589. * * 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`)
  109590. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  109591. * * 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
  109592. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  109593. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  109594. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  109595. * @param name defines the name of the mesh
  109596. * @param options defines the options used to create the mesh
  109597. * @param scene defines the hosting scene
  109598. * @returns a new Mesh
  109599. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  109600. */
  109601. static CreateIcoSphere(name: string, options: {
  109602. radius?: number;
  109603. flat?: boolean;
  109604. subdivisions?: number;
  109605. sideOrientation?: number;
  109606. updatable?: boolean;
  109607. }, scene: Scene): Mesh;
  109608. /**
  109609. * Creates a decal mesh.
  109610. * Please consider using the same method from the MeshBuilder class instead.
  109611. * A decal is a mesh usually applied as a model onto the surface of another mesh
  109612. * @param name defines the name of the mesh
  109613. * @param sourceMesh defines the mesh receiving the decal
  109614. * @param position sets the position of the decal in world coordinates
  109615. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  109616. * @param size sets the decal scaling
  109617. * @param angle sets the angle to rotate the decal
  109618. * @returns a new Mesh
  109619. */
  109620. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  109621. /** Creates a Capsule Mesh
  109622. * @param name defines the name of the mesh.
  109623. * @param options the constructors options used to shape the mesh.
  109624. * @param scene defines the scene the mesh is scoped to.
  109625. * @returns the capsule mesh
  109626. * @see https://doc.babylonjs.com/how_to/capsule_shape
  109627. */
  109628. static CreateCapsule(name: string, options: ICreateCapsuleOptions, scene: Scene): Mesh;
  109629. /**
  109630. * Prepare internal position array for software CPU skinning
  109631. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  109632. */
  109633. setPositionsForCPUSkinning(): Float32Array;
  109634. /**
  109635. * Prepare internal normal array for software CPU skinning
  109636. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  109637. */
  109638. setNormalsForCPUSkinning(): Float32Array;
  109639. /**
  109640. * Updates the vertex buffer by applying transformation from the bones
  109641. * @param skeleton defines the skeleton to apply to current mesh
  109642. * @returns the current mesh
  109643. */
  109644. applySkeleton(skeleton: Skeleton): Mesh;
  109645. /**
  109646. * 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
  109647. * @param meshes defines the list of meshes to scan
  109648. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  109649. */
  109650. static MinMax(meshes: AbstractMesh[]): {
  109651. min: Vector3;
  109652. max: Vector3;
  109653. };
  109654. /**
  109655. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  109656. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  109657. * @returns a vector3
  109658. */
  109659. static Center(meshesOrMinMaxVector: {
  109660. min: Vector3;
  109661. max: Vector3;
  109662. } | AbstractMesh[]): Vector3;
  109663. /**
  109664. * Merge the array of meshes into a single mesh for performance reasons.
  109665. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  109666. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  109667. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  109668. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  109669. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  109670. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  109671. * @returns a new mesh
  109672. */
  109673. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  109674. /** @hidden */
  109675. addInstance(instance: InstancedMesh): void;
  109676. /** @hidden */
  109677. removeInstance(instance: InstancedMesh): void;
  109678. }
  109679. }
  109680. declare module BABYLON {
  109681. /**
  109682. * This is the base class of all the camera used in the application.
  109683. * @see https://doc.babylonjs.com/features/cameras
  109684. */
  109685. export class Camera extends Node {
  109686. /** @hidden */
  109687. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  109688. /**
  109689. * This is the default projection mode used by the cameras.
  109690. * It helps recreating a feeling of perspective and better appreciate depth.
  109691. * This is the best way to simulate real life cameras.
  109692. */
  109693. static readonly PERSPECTIVE_CAMERA: number;
  109694. /**
  109695. * This helps creating camera with an orthographic mode.
  109696. * 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.
  109697. */
  109698. static readonly ORTHOGRAPHIC_CAMERA: number;
  109699. /**
  109700. * This is the default FOV mode for perspective cameras.
  109701. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  109702. */
  109703. static readonly FOVMODE_VERTICAL_FIXED: number;
  109704. /**
  109705. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  109706. */
  109707. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  109708. /**
  109709. * This specifies ther is no need for a camera rig.
  109710. * Basically only one eye is rendered corresponding to the camera.
  109711. */
  109712. static readonly RIG_MODE_NONE: number;
  109713. /**
  109714. * Simulates a camera Rig with one blue eye and one red eye.
  109715. * This can be use with 3d blue and red glasses.
  109716. */
  109717. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  109718. /**
  109719. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  109720. */
  109721. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  109722. /**
  109723. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  109724. */
  109725. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  109726. /**
  109727. * Defines that both eyes of the camera will be rendered over under each other.
  109728. */
  109729. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  109730. /**
  109731. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  109732. */
  109733. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  109734. /**
  109735. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  109736. */
  109737. static readonly RIG_MODE_VR: number;
  109738. /**
  109739. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  109740. */
  109741. static readonly RIG_MODE_WEBVR: number;
  109742. /**
  109743. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  109744. */
  109745. static readonly RIG_MODE_CUSTOM: number;
  109746. /**
  109747. * Defines if by default attaching controls should prevent the default javascript event to continue.
  109748. */
  109749. static ForceAttachControlToAlwaysPreventDefault: boolean;
  109750. /**
  109751. * Define the input manager associated with the camera.
  109752. */
  109753. inputs: CameraInputsManager<Camera>;
  109754. /** @hidden */
  109755. _position: Vector3;
  109756. /**
  109757. * Define the current local position of the camera in the scene
  109758. */
  109759. get position(): Vector3;
  109760. set position(newPosition: Vector3);
  109761. protected _upVector: Vector3;
  109762. /**
  109763. * The vector the camera should consider as up.
  109764. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  109765. */
  109766. set upVector(vec: Vector3);
  109767. get upVector(): Vector3;
  109768. /**
  109769. * Define the current limit on the left side for an orthographic camera
  109770. * In scene unit
  109771. */
  109772. orthoLeft: Nullable<number>;
  109773. /**
  109774. * Define the current limit on the right side for an orthographic camera
  109775. * In scene unit
  109776. */
  109777. orthoRight: Nullable<number>;
  109778. /**
  109779. * Define the current limit on the bottom side for an orthographic camera
  109780. * In scene unit
  109781. */
  109782. orthoBottom: Nullable<number>;
  109783. /**
  109784. * Define the current limit on the top side for an orthographic camera
  109785. * In scene unit
  109786. */
  109787. orthoTop: Nullable<number>;
  109788. /**
  109789. * Field Of View is set in Radians. (default is 0.8)
  109790. */
  109791. fov: number;
  109792. /**
  109793. * Define the minimum distance the camera can see from.
  109794. * This is important to note that the depth buffer are not infinite and the closer it starts
  109795. * the more your scene might encounter depth fighting issue.
  109796. */
  109797. minZ: number;
  109798. /**
  109799. * Define the maximum distance the camera can see to.
  109800. * This is important to note that the depth buffer are not infinite and the further it end
  109801. * the more your scene might encounter depth fighting issue.
  109802. */
  109803. maxZ: number;
  109804. /**
  109805. * Define the default inertia of the camera.
  109806. * This helps giving a smooth feeling to the camera movement.
  109807. */
  109808. inertia: number;
  109809. /**
  109810. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  109811. */
  109812. mode: number;
  109813. /**
  109814. * Define whether the camera is intermediate.
  109815. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  109816. */
  109817. isIntermediate: boolean;
  109818. /**
  109819. * Define the viewport of the camera.
  109820. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  109821. */
  109822. viewport: Viewport;
  109823. /**
  109824. * Restricts the camera to viewing objects with the same layerMask.
  109825. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  109826. */
  109827. layerMask: number;
  109828. /**
  109829. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  109830. */
  109831. fovMode: number;
  109832. /**
  109833. * Rig mode of the camera.
  109834. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  109835. * This is normally controlled byt the camera themselves as internal use.
  109836. */
  109837. cameraRigMode: number;
  109838. /**
  109839. * Defines the distance between both "eyes" in case of a RIG
  109840. */
  109841. interaxialDistance: number;
  109842. /**
  109843. * Defines if stereoscopic rendering is done side by side or over under.
  109844. */
  109845. isStereoscopicSideBySide: boolean;
  109846. /**
  109847. * 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
  109848. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  109849. * else in the scene. (Eg. security camera)
  109850. *
  109851. * 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)
  109852. */
  109853. customRenderTargets: RenderTargetTexture[];
  109854. /**
  109855. * When set, the camera will render to this render target instead of the default canvas
  109856. *
  109857. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  109858. */
  109859. outputRenderTarget: Nullable<RenderTargetTexture>;
  109860. /**
  109861. * Observable triggered when the camera view matrix has changed.
  109862. */
  109863. onViewMatrixChangedObservable: Observable<Camera>;
  109864. /**
  109865. * Observable triggered when the camera Projection matrix has changed.
  109866. */
  109867. onProjectionMatrixChangedObservable: Observable<Camera>;
  109868. /**
  109869. * Observable triggered when the inputs have been processed.
  109870. */
  109871. onAfterCheckInputsObservable: Observable<Camera>;
  109872. /**
  109873. * Observable triggered when reset has been called and applied to the camera.
  109874. */
  109875. onRestoreStateObservable: Observable<Camera>;
  109876. /**
  109877. * Is this camera a part of a rig system?
  109878. */
  109879. isRigCamera: boolean;
  109880. /**
  109881. * If isRigCamera set to true this will be set with the parent camera.
  109882. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  109883. */
  109884. rigParent?: Camera;
  109885. /** @hidden */
  109886. _cameraRigParams: any;
  109887. /** @hidden */
  109888. _rigCameras: Camera[];
  109889. /** @hidden */
  109890. _rigPostProcess: Nullable<PostProcess>;
  109891. protected _webvrViewMatrix: Matrix;
  109892. /** @hidden */
  109893. _skipRendering: boolean;
  109894. /** @hidden */
  109895. _projectionMatrix: Matrix;
  109896. /** @hidden */
  109897. _postProcesses: Nullable<PostProcess>[];
  109898. /** @hidden */
  109899. _activeMeshes: SmartArray<AbstractMesh>;
  109900. protected _globalPosition: Vector3;
  109901. /** @hidden */
  109902. _computedViewMatrix: Matrix;
  109903. private _doNotComputeProjectionMatrix;
  109904. private _transformMatrix;
  109905. private _frustumPlanes;
  109906. private _refreshFrustumPlanes;
  109907. private _storedFov;
  109908. private _stateStored;
  109909. /**
  109910. * Instantiates a new camera object.
  109911. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  109912. * @see https://doc.babylonjs.com/features/cameras
  109913. * @param name Defines the name of the camera in the scene
  109914. * @param position Defines the position of the camera
  109915. * @param scene Defines the scene the camera belongs too
  109916. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  109917. */
  109918. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  109919. /**
  109920. * Store current camera state (fov, position, etc..)
  109921. * @returns the camera
  109922. */
  109923. storeState(): Camera;
  109924. /**
  109925. * Restores the camera state values if it has been stored. You must call storeState() first
  109926. */
  109927. protected _restoreStateValues(): boolean;
  109928. /**
  109929. * Restored camera state. You must call storeState() first.
  109930. * @returns true if restored and false otherwise
  109931. */
  109932. restoreState(): boolean;
  109933. /**
  109934. * Gets the class name of the camera.
  109935. * @returns the class name
  109936. */
  109937. getClassName(): string;
  109938. /** @hidden */
  109939. readonly _isCamera: boolean;
  109940. /**
  109941. * Gets a string representation of the camera useful for debug purpose.
  109942. * @param fullDetails Defines that a more verboe level of logging is required
  109943. * @returns the string representation
  109944. */
  109945. toString(fullDetails?: boolean): string;
  109946. /**
  109947. * Gets the current world space position of the camera.
  109948. */
  109949. get globalPosition(): Vector3;
  109950. /**
  109951. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  109952. * @returns the active meshe list
  109953. */
  109954. getActiveMeshes(): SmartArray<AbstractMesh>;
  109955. /**
  109956. * Check whether a mesh is part of the current active mesh list of the camera
  109957. * @param mesh Defines the mesh to check
  109958. * @returns true if active, false otherwise
  109959. */
  109960. isActiveMesh(mesh: Mesh): boolean;
  109961. /**
  109962. * Is this camera ready to be used/rendered
  109963. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  109964. * @return true if the camera is ready
  109965. */
  109966. isReady(completeCheck?: boolean): boolean;
  109967. /** @hidden */
  109968. _initCache(): void;
  109969. /** @hidden */
  109970. _updateCache(ignoreParentClass?: boolean): void;
  109971. /** @hidden */
  109972. _isSynchronized(): boolean;
  109973. /** @hidden */
  109974. _isSynchronizedViewMatrix(): boolean;
  109975. /** @hidden */
  109976. _isSynchronizedProjectionMatrix(): boolean;
  109977. /**
  109978. * Attach the input controls to a specific dom element to get the input from.
  109979. * @param element Defines the element the controls should be listened from
  109980. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  109981. */
  109982. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  109983. /**
  109984. * Detach the current controls from the specified dom element.
  109985. * @param element Defines the element to stop listening the inputs from
  109986. */
  109987. detachControl(element: HTMLElement): void;
  109988. /**
  109989. * Update the camera state according to the different inputs gathered during the frame.
  109990. */
  109991. update(): void;
  109992. /** @hidden */
  109993. _checkInputs(): void;
  109994. /** @hidden */
  109995. get rigCameras(): Camera[];
  109996. /**
  109997. * Gets the post process used by the rig cameras
  109998. */
  109999. get rigPostProcess(): Nullable<PostProcess>;
  110000. /**
  110001. * Internal, gets the first post proces.
  110002. * @returns the first post process to be run on this camera.
  110003. */
  110004. _getFirstPostProcess(): Nullable<PostProcess>;
  110005. private _cascadePostProcessesToRigCams;
  110006. /**
  110007. * Attach a post process to the camera.
  110008. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  110009. * @param postProcess The post process to attach to the camera
  110010. * @param insertAt The position of the post process in case several of them are in use in the scene
  110011. * @returns the position the post process has been inserted at
  110012. */
  110013. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  110014. /**
  110015. * Detach a post process to the camera.
  110016. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  110017. * @param postProcess The post process to detach from the camera
  110018. */
  110019. detachPostProcess(postProcess: PostProcess): void;
  110020. /**
  110021. * Gets the current world matrix of the camera
  110022. */
  110023. getWorldMatrix(): Matrix;
  110024. /** @hidden */
  110025. _getViewMatrix(): Matrix;
  110026. /**
  110027. * Gets the current view matrix of the camera.
  110028. * @param force forces the camera to recompute the matrix without looking at the cached state
  110029. * @returns the view matrix
  110030. */
  110031. getViewMatrix(force?: boolean): Matrix;
  110032. /**
  110033. * Freeze the projection matrix.
  110034. * It will prevent the cache check of the camera projection compute and can speed up perf
  110035. * if no parameter of the camera are meant to change
  110036. * @param projection Defines manually a projection if necessary
  110037. */
  110038. freezeProjectionMatrix(projection?: Matrix): void;
  110039. /**
  110040. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  110041. */
  110042. unfreezeProjectionMatrix(): void;
  110043. /**
  110044. * Gets the current projection matrix of the camera.
  110045. * @param force forces the camera to recompute the matrix without looking at the cached state
  110046. * @returns the projection matrix
  110047. */
  110048. getProjectionMatrix(force?: boolean): Matrix;
  110049. /**
  110050. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  110051. * @returns a Matrix
  110052. */
  110053. getTransformationMatrix(): Matrix;
  110054. private _updateFrustumPlanes;
  110055. /**
  110056. * Checks if a cullable object (mesh...) is in the camera frustum
  110057. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  110058. * @param target The object to check
  110059. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  110060. * @returns true if the object is in frustum otherwise false
  110061. */
  110062. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  110063. /**
  110064. * Checks if a cullable object (mesh...) is in the camera frustum
  110065. * Unlike isInFrustum this cheks the full bounding box
  110066. * @param target The object to check
  110067. * @returns true if the object is in frustum otherwise false
  110068. */
  110069. isCompletelyInFrustum(target: ICullable): boolean;
  110070. /**
  110071. * Gets a ray in the forward direction from the camera.
  110072. * @param length Defines the length of the ray to create
  110073. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  110074. * @param origin Defines the start point of the ray which defaults to the camera position
  110075. * @returns the forward ray
  110076. */
  110077. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  110078. /**
  110079. * Gets a ray in the forward direction from the camera.
  110080. * @param refRay the ray to (re)use when setting the values
  110081. * @param length Defines the length of the ray to create
  110082. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  110083. * @param origin Defines the start point of the ray which defaults to the camera position
  110084. * @returns the forward ray
  110085. */
  110086. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  110087. /**
  110088. * Releases resources associated with this node.
  110089. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  110090. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  110091. */
  110092. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  110093. /** @hidden */
  110094. _isLeftCamera: boolean;
  110095. /**
  110096. * Gets the left camera of a rig setup in case of Rigged Camera
  110097. */
  110098. get isLeftCamera(): boolean;
  110099. /** @hidden */
  110100. _isRightCamera: boolean;
  110101. /**
  110102. * Gets the right camera of a rig setup in case of Rigged Camera
  110103. */
  110104. get isRightCamera(): boolean;
  110105. /**
  110106. * Gets the left camera of a rig setup in case of Rigged Camera
  110107. */
  110108. get leftCamera(): Nullable<FreeCamera>;
  110109. /**
  110110. * Gets the right camera of a rig setup in case of Rigged Camera
  110111. */
  110112. get rightCamera(): Nullable<FreeCamera>;
  110113. /**
  110114. * Gets the left camera target of a rig setup in case of Rigged Camera
  110115. * @returns the target position
  110116. */
  110117. getLeftTarget(): Nullable<Vector3>;
  110118. /**
  110119. * Gets the right camera target of a rig setup in case of Rigged Camera
  110120. * @returns the target position
  110121. */
  110122. getRightTarget(): Nullable<Vector3>;
  110123. /**
  110124. * @hidden
  110125. */
  110126. setCameraRigMode(mode: number, rigParams: any): void;
  110127. /** @hidden */
  110128. static _setStereoscopicRigMode(camera: Camera): void;
  110129. /** @hidden */
  110130. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  110131. /** @hidden */
  110132. static _setVRRigMode(camera: Camera, rigParams: any): void;
  110133. /** @hidden */
  110134. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  110135. /** @hidden */
  110136. _getVRProjectionMatrix(): Matrix;
  110137. protected _updateCameraRotationMatrix(): void;
  110138. protected _updateWebVRCameraRotationMatrix(): void;
  110139. /**
  110140. * This function MUST be overwritten by the different WebVR cameras available.
  110141. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  110142. * @hidden
  110143. */
  110144. _getWebVRProjectionMatrix(): Matrix;
  110145. /**
  110146. * This function MUST be overwritten by the different WebVR cameras available.
  110147. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  110148. * @hidden
  110149. */
  110150. _getWebVRViewMatrix(): Matrix;
  110151. /** @hidden */
  110152. setCameraRigParameter(name: string, value: any): void;
  110153. /**
  110154. * needs to be overridden by children so sub has required properties to be copied
  110155. * @hidden
  110156. */
  110157. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  110158. /**
  110159. * May need to be overridden by children
  110160. * @hidden
  110161. */
  110162. _updateRigCameras(): void;
  110163. /** @hidden */
  110164. _setupInputs(): void;
  110165. /**
  110166. * Serialiaze the camera setup to a json represention
  110167. * @returns the JSON representation
  110168. */
  110169. serialize(): any;
  110170. /**
  110171. * Clones the current camera.
  110172. * @param name The cloned camera name
  110173. * @returns the cloned camera
  110174. */
  110175. clone(name: string): Camera;
  110176. /**
  110177. * Gets the direction of the camera relative to a given local axis.
  110178. * @param localAxis Defines the reference axis to provide a relative direction.
  110179. * @return the direction
  110180. */
  110181. getDirection(localAxis: Vector3): Vector3;
  110182. /**
  110183. * Returns the current camera absolute rotation
  110184. */
  110185. get absoluteRotation(): Quaternion;
  110186. /**
  110187. * Gets the direction of the camera relative to a given local axis into a passed vector.
  110188. * @param localAxis Defines the reference axis to provide a relative direction.
  110189. * @param result Defines the vector to store the result in
  110190. */
  110191. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  110192. /**
  110193. * Gets a camera constructor for a given camera type
  110194. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  110195. * @param name The name of the camera the result will be able to instantiate
  110196. * @param scene The scene the result will construct the camera in
  110197. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  110198. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  110199. * @returns a factory method to construc the camera
  110200. */
  110201. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  110202. /**
  110203. * Compute the world matrix of the camera.
  110204. * @returns the camera world matrix
  110205. */
  110206. computeWorldMatrix(): Matrix;
  110207. /**
  110208. * Parse a JSON and creates the camera from the parsed information
  110209. * @param parsedCamera The JSON to parse
  110210. * @param scene The scene to instantiate the camera in
  110211. * @returns the newly constructed camera
  110212. */
  110213. static Parse(parsedCamera: any, scene: Scene): Camera;
  110214. }
  110215. }
  110216. declare module BABYLON {
  110217. /**
  110218. * Class containing static functions to help procedurally build meshes
  110219. */
  110220. export class DiscBuilder {
  110221. /**
  110222. * Creates a plane polygonal mesh. By default, this is a disc
  110223. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  110224. * * 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
  110225. * * 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
  110226. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  110227. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  110228. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  110229. * @param name defines the name of the mesh
  110230. * @param options defines the options used to create the mesh
  110231. * @param scene defines the hosting scene
  110232. * @returns the plane polygonal mesh
  110233. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  110234. */
  110235. static CreateDisc(name: string, options: {
  110236. radius?: number;
  110237. tessellation?: number;
  110238. arc?: number;
  110239. updatable?: boolean;
  110240. sideOrientation?: number;
  110241. frontUVs?: Vector4;
  110242. backUVs?: Vector4;
  110243. }, scene?: Nullable<Scene>): Mesh;
  110244. }
  110245. }
  110246. declare module BABYLON {
  110247. /**
  110248. * Options to be used when creating a FresnelParameters.
  110249. */
  110250. export type IFresnelParametersCreationOptions = {
  110251. /**
  110252. * Define the color used on edges (grazing angle)
  110253. */
  110254. leftColor?: Color3;
  110255. /**
  110256. * Define the color used on center
  110257. */
  110258. rightColor?: Color3;
  110259. /**
  110260. * Define bias applied to computed fresnel term
  110261. */
  110262. bias?: number;
  110263. /**
  110264. * Defined the power exponent applied to fresnel term
  110265. */
  110266. power?: number;
  110267. /**
  110268. * Define if the fresnel effect is enable or not.
  110269. */
  110270. isEnabled?: boolean;
  110271. };
  110272. /**
  110273. * Serialized format for FresnelParameters.
  110274. */
  110275. export type IFresnelParametersSerialized = {
  110276. /**
  110277. * Define the color used on edges (grazing angle) [as an array]
  110278. */
  110279. leftColor: number[];
  110280. /**
  110281. * Define the color used on center [as an array]
  110282. */
  110283. rightColor: number[];
  110284. /**
  110285. * Define bias applied to computed fresnel term
  110286. */
  110287. bias: number;
  110288. /**
  110289. * Defined the power exponent applied to fresnel term
  110290. */
  110291. power?: number;
  110292. /**
  110293. * Define if the fresnel effect is enable or not.
  110294. */
  110295. isEnabled: boolean;
  110296. };
  110297. /**
  110298. * This represents all the required information to add a fresnel effect on a material:
  110299. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110300. */
  110301. export class FresnelParameters {
  110302. private _isEnabled;
  110303. /**
  110304. * Define if the fresnel effect is enable or not.
  110305. */
  110306. get isEnabled(): boolean;
  110307. set isEnabled(value: boolean);
  110308. /**
  110309. * Define the color used on edges (grazing angle)
  110310. */
  110311. leftColor: Color3;
  110312. /**
  110313. * Define the color used on center
  110314. */
  110315. rightColor: Color3;
  110316. /**
  110317. * Define bias applied to computed fresnel term
  110318. */
  110319. bias: number;
  110320. /**
  110321. * Defined the power exponent applied to fresnel term
  110322. */
  110323. power: number;
  110324. /**
  110325. * Creates a new FresnelParameters object.
  110326. *
  110327. * @param options provide your own settings to optionally to override defaults
  110328. */
  110329. constructor(options?: IFresnelParametersCreationOptions);
  110330. /**
  110331. * Clones the current fresnel and its valuues
  110332. * @returns a clone fresnel configuration
  110333. */
  110334. clone(): FresnelParameters;
  110335. /**
  110336. * Determines equality between FresnelParameters objects
  110337. * @param otherFresnelParameters defines the second operand
  110338. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  110339. */
  110340. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  110341. /**
  110342. * Serializes the current fresnel parameters to a JSON representation.
  110343. * @return the JSON serialization
  110344. */
  110345. serialize(): IFresnelParametersSerialized;
  110346. /**
  110347. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  110348. * @param parsedFresnelParameters Define the JSON representation
  110349. * @returns the parsed parameters
  110350. */
  110351. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  110352. }
  110353. }
  110354. declare module BABYLON {
  110355. /**
  110356. * This groups all the flags used to control the materials channel.
  110357. */
  110358. export class MaterialFlags {
  110359. private static _DiffuseTextureEnabled;
  110360. /**
  110361. * Are diffuse textures enabled in the application.
  110362. */
  110363. static get DiffuseTextureEnabled(): boolean;
  110364. static set DiffuseTextureEnabled(value: boolean);
  110365. private static _DetailTextureEnabled;
  110366. /**
  110367. * Are detail textures enabled in the application.
  110368. */
  110369. static get DetailTextureEnabled(): boolean;
  110370. static set DetailTextureEnabled(value: boolean);
  110371. private static _AmbientTextureEnabled;
  110372. /**
  110373. * Are ambient textures enabled in the application.
  110374. */
  110375. static get AmbientTextureEnabled(): boolean;
  110376. static set AmbientTextureEnabled(value: boolean);
  110377. private static _OpacityTextureEnabled;
  110378. /**
  110379. * Are opacity textures enabled in the application.
  110380. */
  110381. static get OpacityTextureEnabled(): boolean;
  110382. static set OpacityTextureEnabled(value: boolean);
  110383. private static _ReflectionTextureEnabled;
  110384. /**
  110385. * Are reflection textures enabled in the application.
  110386. */
  110387. static get ReflectionTextureEnabled(): boolean;
  110388. static set ReflectionTextureEnabled(value: boolean);
  110389. private static _EmissiveTextureEnabled;
  110390. /**
  110391. * Are emissive textures enabled in the application.
  110392. */
  110393. static get EmissiveTextureEnabled(): boolean;
  110394. static set EmissiveTextureEnabled(value: boolean);
  110395. private static _SpecularTextureEnabled;
  110396. /**
  110397. * Are specular textures enabled in the application.
  110398. */
  110399. static get SpecularTextureEnabled(): boolean;
  110400. static set SpecularTextureEnabled(value: boolean);
  110401. private static _BumpTextureEnabled;
  110402. /**
  110403. * Are bump textures enabled in the application.
  110404. */
  110405. static get BumpTextureEnabled(): boolean;
  110406. static set BumpTextureEnabled(value: boolean);
  110407. private static _LightmapTextureEnabled;
  110408. /**
  110409. * Are lightmap textures enabled in the application.
  110410. */
  110411. static get LightmapTextureEnabled(): boolean;
  110412. static set LightmapTextureEnabled(value: boolean);
  110413. private static _RefractionTextureEnabled;
  110414. /**
  110415. * Are refraction textures enabled in the application.
  110416. */
  110417. static get RefractionTextureEnabled(): boolean;
  110418. static set RefractionTextureEnabled(value: boolean);
  110419. private static _ColorGradingTextureEnabled;
  110420. /**
  110421. * Are color grading textures enabled in the application.
  110422. */
  110423. static get ColorGradingTextureEnabled(): boolean;
  110424. static set ColorGradingTextureEnabled(value: boolean);
  110425. private static _FresnelEnabled;
  110426. /**
  110427. * Are fresnels enabled in the application.
  110428. */
  110429. static get FresnelEnabled(): boolean;
  110430. static set FresnelEnabled(value: boolean);
  110431. private static _ClearCoatTextureEnabled;
  110432. /**
  110433. * Are clear coat textures enabled in the application.
  110434. */
  110435. static get ClearCoatTextureEnabled(): boolean;
  110436. static set ClearCoatTextureEnabled(value: boolean);
  110437. private static _ClearCoatBumpTextureEnabled;
  110438. /**
  110439. * Are clear coat bump textures enabled in the application.
  110440. */
  110441. static get ClearCoatBumpTextureEnabled(): boolean;
  110442. static set ClearCoatBumpTextureEnabled(value: boolean);
  110443. private static _ClearCoatTintTextureEnabled;
  110444. /**
  110445. * Are clear coat tint textures enabled in the application.
  110446. */
  110447. static get ClearCoatTintTextureEnabled(): boolean;
  110448. static set ClearCoatTintTextureEnabled(value: boolean);
  110449. private static _SheenTextureEnabled;
  110450. /**
  110451. * Are sheen textures enabled in the application.
  110452. */
  110453. static get SheenTextureEnabled(): boolean;
  110454. static set SheenTextureEnabled(value: boolean);
  110455. private static _AnisotropicTextureEnabled;
  110456. /**
  110457. * Are anisotropic textures enabled in the application.
  110458. */
  110459. static get AnisotropicTextureEnabled(): boolean;
  110460. static set AnisotropicTextureEnabled(value: boolean);
  110461. private static _ThicknessTextureEnabled;
  110462. /**
  110463. * Are thickness textures enabled in the application.
  110464. */
  110465. static get ThicknessTextureEnabled(): boolean;
  110466. static set ThicknessTextureEnabled(value: boolean);
  110467. }
  110468. }
  110469. declare module BABYLON {
  110470. /** @hidden */
  110471. export var defaultFragmentDeclaration: {
  110472. name: string;
  110473. shader: string;
  110474. };
  110475. }
  110476. declare module BABYLON {
  110477. /** @hidden */
  110478. export var defaultUboDeclaration: {
  110479. name: string;
  110480. shader: string;
  110481. };
  110482. }
  110483. declare module BABYLON {
  110484. /** @hidden */
  110485. export var prePassDeclaration: {
  110486. name: string;
  110487. shader: string;
  110488. };
  110489. }
  110490. declare module BABYLON {
  110491. /** @hidden */
  110492. export var lightFragmentDeclaration: {
  110493. name: string;
  110494. shader: string;
  110495. };
  110496. }
  110497. declare module BABYLON {
  110498. /** @hidden */
  110499. export var lightUboDeclaration: {
  110500. name: string;
  110501. shader: string;
  110502. };
  110503. }
  110504. declare module BABYLON {
  110505. /** @hidden */
  110506. export var lightsFragmentFunctions: {
  110507. name: string;
  110508. shader: string;
  110509. };
  110510. }
  110511. declare module BABYLON {
  110512. /** @hidden */
  110513. export var shadowsFragmentFunctions: {
  110514. name: string;
  110515. shader: string;
  110516. };
  110517. }
  110518. declare module BABYLON {
  110519. /** @hidden */
  110520. export var fresnelFunction: {
  110521. name: string;
  110522. shader: string;
  110523. };
  110524. }
  110525. declare module BABYLON {
  110526. /** @hidden */
  110527. export var bumpFragmentMainFunctions: {
  110528. name: string;
  110529. shader: string;
  110530. };
  110531. }
  110532. declare module BABYLON {
  110533. /** @hidden */
  110534. export var bumpFragmentFunctions: {
  110535. name: string;
  110536. shader: string;
  110537. };
  110538. }
  110539. declare module BABYLON {
  110540. /** @hidden */
  110541. export var logDepthDeclaration: {
  110542. name: string;
  110543. shader: string;
  110544. };
  110545. }
  110546. declare module BABYLON {
  110547. /** @hidden */
  110548. export var bumpFragment: {
  110549. name: string;
  110550. shader: string;
  110551. };
  110552. }
  110553. declare module BABYLON {
  110554. /** @hidden */
  110555. export var depthPrePass: {
  110556. name: string;
  110557. shader: string;
  110558. };
  110559. }
  110560. declare module BABYLON {
  110561. /** @hidden */
  110562. export var lightFragment: {
  110563. name: string;
  110564. shader: string;
  110565. };
  110566. }
  110567. declare module BABYLON {
  110568. /** @hidden */
  110569. export var logDepthFragment: {
  110570. name: string;
  110571. shader: string;
  110572. };
  110573. }
  110574. declare module BABYLON {
  110575. /** @hidden */
  110576. export var defaultPixelShader: {
  110577. name: string;
  110578. shader: string;
  110579. };
  110580. }
  110581. declare module BABYLON {
  110582. /** @hidden */
  110583. export var defaultVertexDeclaration: {
  110584. name: string;
  110585. shader: string;
  110586. };
  110587. }
  110588. declare module BABYLON {
  110589. /** @hidden */
  110590. export var bumpVertexDeclaration: {
  110591. name: string;
  110592. shader: string;
  110593. };
  110594. }
  110595. declare module BABYLON {
  110596. /** @hidden */
  110597. export var bumpVertex: {
  110598. name: string;
  110599. shader: string;
  110600. };
  110601. }
  110602. declare module BABYLON {
  110603. /** @hidden */
  110604. export var fogVertex: {
  110605. name: string;
  110606. shader: string;
  110607. };
  110608. }
  110609. declare module BABYLON {
  110610. /** @hidden */
  110611. export var shadowsVertex: {
  110612. name: string;
  110613. shader: string;
  110614. };
  110615. }
  110616. declare module BABYLON {
  110617. /** @hidden */
  110618. export var pointCloudVertex: {
  110619. name: string;
  110620. shader: string;
  110621. };
  110622. }
  110623. declare module BABYLON {
  110624. /** @hidden */
  110625. export var logDepthVertex: {
  110626. name: string;
  110627. shader: string;
  110628. };
  110629. }
  110630. declare module BABYLON {
  110631. /** @hidden */
  110632. export var defaultVertexShader: {
  110633. name: string;
  110634. shader: string;
  110635. };
  110636. }
  110637. declare module BABYLON {
  110638. /**
  110639. * @hidden
  110640. */
  110641. export interface IMaterialDetailMapDefines {
  110642. DETAIL: boolean;
  110643. DETAILDIRECTUV: number;
  110644. DETAIL_NORMALBLENDMETHOD: number;
  110645. /** @hidden */
  110646. _areTexturesDirty: boolean;
  110647. }
  110648. /**
  110649. * Define the code related to the detail map parameters of a material
  110650. *
  110651. * Inspired from:
  110652. * 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
  110653. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  110654. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  110655. */
  110656. export class DetailMapConfiguration {
  110657. private _texture;
  110658. /**
  110659. * The detail texture of the material.
  110660. */
  110661. texture: Nullable<BaseTexture>;
  110662. /**
  110663. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  110664. * Bigger values mean stronger blending
  110665. */
  110666. diffuseBlendLevel: number;
  110667. /**
  110668. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  110669. * Bigger values mean stronger blending. Only used with PBR materials
  110670. */
  110671. roughnessBlendLevel: number;
  110672. /**
  110673. * Defines how strong the bump effect from the detail map is
  110674. * Bigger values mean stronger effect
  110675. */
  110676. bumpLevel: number;
  110677. private _normalBlendMethod;
  110678. /**
  110679. * The method used to blend the bump and detail normals together
  110680. */
  110681. normalBlendMethod: number;
  110682. private _isEnabled;
  110683. /**
  110684. * Enable or disable the detail map on this material
  110685. */
  110686. isEnabled: boolean;
  110687. /** @hidden */
  110688. private _internalMarkAllSubMeshesAsTexturesDirty;
  110689. /** @hidden */
  110690. _markAllSubMeshesAsTexturesDirty(): void;
  110691. /**
  110692. * Instantiate a new detail map
  110693. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  110694. */
  110695. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  110696. /**
  110697. * Gets whether the submesh is ready to be used or not.
  110698. * @param defines the list of "defines" to update.
  110699. * @param scene defines the scene the material belongs to.
  110700. * @returns - boolean indicating that the submesh is ready or not.
  110701. */
  110702. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  110703. /**
  110704. * Update the defines for detail map usage
  110705. * @param defines the list of "defines" to update.
  110706. * @param scene defines the scene the material belongs to.
  110707. */
  110708. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  110709. /**
  110710. * Binds the material data.
  110711. * @param uniformBuffer defines the Uniform buffer to fill in.
  110712. * @param scene defines the scene the material belongs to.
  110713. * @param isFrozen defines whether the material is frozen or not.
  110714. */
  110715. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  110716. /**
  110717. * Checks to see if a texture is used in the material.
  110718. * @param texture - Base texture to use.
  110719. * @returns - Boolean specifying if a texture is used in the material.
  110720. */
  110721. hasTexture(texture: BaseTexture): boolean;
  110722. /**
  110723. * Returns an array of the actively used textures.
  110724. * @param activeTextures Array of BaseTextures
  110725. */
  110726. getActiveTextures(activeTextures: BaseTexture[]): void;
  110727. /**
  110728. * Returns the animatable textures.
  110729. * @param animatables Array of animatable textures.
  110730. */
  110731. getAnimatables(animatables: IAnimatable[]): void;
  110732. /**
  110733. * Disposes the resources of the material.
  110734. * @param forceDisposeTextures - Forces the disposal of all textures.
  110735. */
  110736. dispose(forceDisposeTextures?: boolean): void;
  110737. /**
  110738. * Get the current class name useful for serialization or dynamic coding.
  110739. * @returns "DetailMap"
  110740. */
  110741. getClassName(): string;
  110742. /**
  110743. * Add the required uniforms to the current list.
  110744. * @param uniforms defines the current uniform list.
  110745. */
  110746. static AddUniforms(uniforms: string[]): void;
  110747. /**
  110748. * Add the required samplers to the current list.
  110749. * @param samplers defines the current sampler list.
  110750. */
  110751. static AddSamplers(samplers: string[]): void;
  110752. /**
  110753. * Add the required uniforms to the current buffer.
  110754. * @param uniformBuffer defines the current uniform buffer.
  110755. */
  110756. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  110757. /**
  110758. * Makes a duplicate of the current instance into another one.
  110759. * @param detailMap define the instance where to copy the info
  110760. */
  110761. copyTo(detailMap: DetailMapConfiguration): void;
  110762. /**
  110763. * Serializes this detail map instance
  110764. * @returns - An object with the serialized instance.
  110765. */
  110766. serialize(): any;
  110767. /**
  110768. * Parses a detail map setting from a serialized object.
  110769. * @param source - Serialized object.
  110770. * @param scene Defines the scene we are parsing for
  110771. * @param rootUrl Defines the rootUrl to load from
  110772. */
  110773. parse(source: any, scene: Scene, rootUrl: string): void;
  110774. }
  110775. }
  110776. declare module BABYLON {
  110777. /** @hidden */
  110778. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  110779. MAINUV1: boolean;
  110780. MAINUV2: boolean;
  110781. DIFFUSE: boolean;
  110782. DIFFUSEDIRECTUV: number;
  110783. DETAIL: boolean;
  110784. DETAILDIRECTUV: number;
  110785. DETAIL_NORMALBLENDMETHOD: number;
  110786. AMBIENT: boolean;
  110787. AMBIENTDIRECTUV: number;
  110788. OPACITY: boolean;
  110789. OPACITYDIRECTUV: number;
  110790. OPACITYRGB: boolean;
  110791. REFLECTION: boolean;
  110792. EMISSIVE: boolean;
  110793. EMISSIVEDIRECTUV: number;
  110794. SPECULAR: boolean;
  110795. SPECULARDIRECTUV: number;
  110796. BUMP: boolean;
  110797. BUMPDIRECTUV: number;
  110798. PARALLAX: boolean;
  110799. PARALLAXOCCLUSION: boolean;
  110800. SPECULAROVERALPHA: boolean;
  110801. CLIPPLANE: boolean;
  110802. CLIPPLANE2: boolean;
  110803. CLIPPLANE3: boolean;
  110804. CLIPPLANE4: boolean;
  110805. CLIPPLANE5: boolean;
  110806. CLIPPLANE6: boolean;
  110807. ALPHATEST: boolean;
  110808. DEPTHPREPASS: boolean;
  110809. ALPHAFROMDIFFUSE: boolean;
  110810. POINTSIZE: boolean;
  110811. FOG: boolean;
  110812. SPECULARTERM: boolean;
  110813. DIFFUSEFRESNEL: boolean;
  110814. OPACITYFRESNEL: boolean;
  110815. REFLECTIONFRESNEL: boolean;
  110816. REFRACTIONFRESNEL: boolean;
  110817. EMISSIVEFRESNEL: boolean;
  110818. FRESNEL: boolean;
  110819. NORMAL: boolean;
  110820. UV1: boolean;
  110821. UV2: boolean;
  110822. VERTEXCOLOR: boolean;
  110823. VERTEXALPHA: boolean;
  110824. NUM_BONE_INFLUENCERS: number;
  110825. BonesPerMesh: number;
  110826. BONETEXTURE: boolean;
  110827. INSTANCES: boolean;
  110828. THIN_INSTANCES: boolean;
  110829. GLOSSINESS: boolean;
  110830. ROUGHNESS: boolean;
  110831. EMISSIVEASILLUMINATION: boolean;
  110832. LINKEMISSIVEWITHDIFFUSE: boolean;
  110833. REFLECTIONFRESNELFROMSPECULAR: boolean;
  110834. LIGHTMAP: boolean;
  110835. LIGHTMAPDIRECTUV: number;
  110836. OBJECTSPACE_NORMALMAP: boolean;
  110837. USELIGHTMAPASSHADOWMAP: boolean;
  110838. REFLECTIONMAP_3D: boolean;
  110839. REFLECTIONMAP_SPHERICAL: boolean;
  110840. REFLECTIONMAP_PLANAR: boolean;
  110841. REFLECTIONMAP_CUBIC: boolean;
  110842. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  110843. REFLECTIONMAP_PROJECTION: boolean;
  110844. REFLECTIONMAP_SKYBOX: boolean;
  110845. REFLECTIONMAP_EXPLICIT: boolean;
  110846. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  110847. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  110848. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  110849. INVERTCUBICMAP: boolean;
  110850. LOGARITHMICDEPTH: boolean;
  110851. REFRACTION: boolean;
  110852. REFRACTIONMAP_3D: boolean;
  110853. REFLECTIONOVERALPHA: boolean;
  110854. TWOSIDEDLIGHTING: boolean;
  110855. SHADOWFLOAT: boolean;
  110856. MORPHTARGETS: boolean;
  110857. MORPHTARGETS_NORMAL: boolean;
  110858. MORPHTARGETS_TANGENT: boolean;
  110859. MORPHTARGETS_UV: boolean;
  110860. NUM_MORPH_INFLUENCERS: number;
  110861. NONUNIFORMSCALING: boolean;
  110862. PREMULTIPLYALPHA: boolean;
  110863. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  110864. ALPHABLEND: boolean;
  110865. PREPASS: boolean;
  110866. PREPASS_IRRADIANCE: boolean;
  110867. PREPASS_IRRADIANCE_INDEX: number;
  110868. PREPASS_ALBEDO: boolean;
  110869. PREPASS_ALBEDO_INDEX: number;
  110870. PREPASS_DEPTHNORMAL: boolean;
  110871. PREPASS_DEPTHNORMAL_INDEX: number;
  110872. SCENE_MRT_COUNT: number;
  110873. RGBDLIGHTMAP: boolean;
  110874. RGBDREFLECTION: boolean;
  110875. RGBDREFRACTION: boolean;
  110876. IMAGEPROCESSING: boolean;
  110877. VIGNETTE: boolean;
  110878. VIGNETTEBLENDMODEMULTIPLY: boolean;
  110879. VIGNETTEBLENDMODEOPAQUE: boolean;
  110880. TONEMAPPING: boolean;
  110881. TONEMAPPING_ACES: boolean;
  110882. CONTRAST: boolean;
  110883. COLORCURVES: boolean;
  110884. COLORGRADING: boolean;
  110885. COLORGRADING3D: boolean;
  110886. SAMPLER3DGREENDEPTH: boolean;
  110887. SAMPLER3DBGRMAP: boolean;
  110888. IMAGEPROCESSINGPOSTPROCESS: boolean;
  110889. MULTIVIEW: boolean;
  110890. /**
  110891. * If the reflection texture on this material is in linear color space
  110892. * @hidden
  110893. */
  110894. IS_REFLECTION_LINEAR: boolean;
  110895. /**
  110896. * If the refraction texture on this material is in linear color space
  110897. * @hidden
  110898. */
  110899. IS_REFRACTION_LINEAR: boolean;
  110900. EXPOSURE: boolean;
  110901. constructor();
  110902. setReflectionMode(modeToEnable: string): void;
  110903. }
  110904. /**
  110905. * This is the default material used in Babylon. It is the best trade off between quality
  110906. * and performances.
  110907. * @see https://doc.babylonjs.com/babylon101/materials
  110908. */
  110909. export class StandardMaterial extends PushMaterial {
  110910. private _diffuseTexture;
  110911. /**
  110912. * The basic texture of the material as viewed under a light.
  110913. */
  110914. diffuseTexture: Nullable<BaseTexture>;
  110915. private _ambientTexture;
  110916. /**
  110917. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  110918. */
  110919. ambientTexture: Nullable<BaseTexture>;
  110920. private _opacityTexture;
  110921. /**
  110922. * Define the transparency of the material from a texture.
  110923. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  110924. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  110925. */
  110926. opacityTexture: Nullable<BaseTexture>;
  110927. private _reflectionTexture;
  110928. /**
  110929. * Define the texture used to display the reflection.
  110930. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110931. */
  110932. reflectionTexture: Nullable<BaseTexture>;
  110933. private _emissiveTexture;
  110934. /**
  110935. * Define texture of the material as if self lit.
  110936. * This will be mixed in the final result even in the absence of light.
  110937. */
  110938. emissiveTexture: Nullable<BaseTexture>;
  110939. private _specularTexture;
  110940. /**
  110941. * Define how the color and intensity of the highlight given by the light in the material.
  110942. */
  110943. specularTexture: Nullable<BaseTexture>;
  110944. private _bumpTexture;
  110945. /**
  110946. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  110947. * 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.
  110948. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  110949. */
  110950. bumpTexture: Nullable<BaseTexture>;
  110951. private _lightmapTexture;
  110952. /**
  110953. * Complex lighting can be computationally expensive to compute at runtime.
  110954. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  110955. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  110956. */
  110957. lightmapTexture: Nullable<BaseTexture>;
  110958. private _refractionTexture;
  110959. /**
  110960. * Define the texture used to display the refraction.
  110961. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110962. */
  110963. refractionTexture: Nullable<BaseTexture>;
  110964. /**
  110965. * The color of the material lit by the environmental background lighting.
  110966. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  110967. */
  110968. ambientColor: Color3;
  110969. /**
  110970. * The basic color of the material as viewed under a light.
  110971. */
  110972. diffuseColor: Color3;
  110973. /**
  110974. * Define how the color and intensity of the highlight given by the light in the material.
  110975. */
  110976. specularColor: Color3;
  110977. /**
  110978. * Define the color of the material as if self lit.
  110979. * This will be mixed in the final result even in the absence of light.
  110980. */
  110981. emissiveColor: Color3;
  110982. /**
  110983. * Defines how sharp are the highlights in the material.
  110984. * The bigger the value the sharper giving a more glossy feeling to the result.
  110985. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  110986. */
  110987. specularPower: number;
  110988. private _useAlphaFromDiffuseTexture;
  110989. /**
  110990. * Does the transparency come from the diffuse texture alpha channel.
  110991. */
  110992. useAlphaFromDiffuseTexture: boolean;
  110993. private _useEmissiveAsIllumination;
  110994. /**
  110995. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  110996. */
  110997. useEmissiveAsIllumination: boolean;
  110998. private _linkEmissiveWithDiffuse;
  110999. /**
  111000. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  111001. * the emissive level when the final color is close to one.
  111002. */
  111003. linkEmissiveWithDiffuse: boolean;
  111004. private _useSpecularOverAlpha;
  111005. /**
  111006. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  111007. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  111008. */
  111009. useSpecularOverAlpha: boolean;
  111010. private _useReflectionOverAlpha;
  111011. /**
  111012. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  111013. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  111014. */
  111015. useReflectionOverAlpha: boolean;
  111016. private _disableLighting;
  111017. /**
  111018. * Does lights from the scene impacts this material.
  111019. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  111020. */
  111021. disableLighting: boolean;
  111022. private _useObjectSpaceNormalMap;
  111023. /**
  111024. * Allows using an object space normal map (instead of tangent space).
  111025. */
  111026. useObjectSpaceNormalMap: boolean;
  111027. private _useParallax;
  111028. /**
  111029. * Is parallax enabled or not.
  111030. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  111031. */
  111032. useParallax: boolean;
  111033. private _useParallaxOcclusion;
  111034. /**
  111035. * Is parallax occlusion enabled or not.
  111036. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  111037. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  111038. */
  111039. useParallaxOcclusion: boolean;
  111040. /**
  111041. * 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.
  111042. */
  111043. parallaxScaleBias: number;
  111044. private _roughness;
  111045. /**
  111046. * Helps to define how blurry the reflections should appears in the material.
  111047. */
  111048. roughness: number;
  111049. /**
  111050. * In case of refraction, define the value of the index of refraction.
  111051. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  111052. */
  111053. indexOfRefraction: number;
  111054. /**
  111055. * Invert the refraction texture alongside the y axis.
  111056. * It can be useful with procedural textures or probe for instance.
  111057. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  111058. */
  111059. invertRefractionY: boolean;
  111060. /**
  111061. * Defines the alpha limits in alpha test mode.
  111062. */
  111063. alphaCutOff: number;
  111064. private _useLightmapAsShadowmap;
  111065. /**
  111066. * In case of light mapping, define whether the map contains light or shadow informations.
  111067. */
  111068. useLightmapAsShadowmap: boolean;
  111069. private _diffuseFresnelParameters;
  111070. /**
  111071. * Define the diffuse fresnel parameters of the material.
  111072. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  111073. */
  111074. diffuseFresnelParameters: FresnelParameters;
  111075. private _opacityFresnelParameters;
  111076. /**
  111077. * Define the opacity fresnel parameters of the material.
  111078. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  111079. */
  111080. opacityFresnelParameters: FresnelParameters;
  111081. private _reflectionFresnelParameters;
  111082. /**
  111083. * Define the reflection fresnel parameters of the material.
  111084. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  111085. */
  111086. reflectionFresnelParameters: FresnelParameters;
  111087. private _refractionFresnelParameters;
  111088. /**
  111089. * Define the refraction fresnel parameters of the material.
  111090. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  111091. */
  111092. refractionFresnelParameters: FresnelParameters;
  111093. private _emissiveFresnelParameters;
  111094. /**
  111095. * Define the emissive fresnel parameters of the material.
  111096. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  111097. */
  111098. emissiveFresnelParameters: FresnelParameters;
  111099. private _useReflectionFresnelFromSpecular;
  111100. /**
  111101. * If true automatically deducts the fresnels values from the material specularity.
  111102. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  111103. */
  111104. useReflectionFresnelFromSpecular: boolean;
  111105. private _useGlossinessFromSpecularMapAlpha;
  111106. /**
  111107. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  111108. */
  111109. useGlossinessFromSpecularMapAlpha: boolean;
  111110. private _maxSimultaneousLights;
  111111. /**
  111112. * Defines the maximum number of lights that can be used in the material
  111113. */
  111114. maxSimultaneousLights: number;
  111115. private _invertNormalMapX;
  111116. /**
  111117. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  111118. */
  111119. invertNormalMapX: boolean;
  111120. private _invertNormalMapY;
  111121. /**
  111122. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  111123. */
  111124. invertNormalMapY: boolean;
  111125. private _twoSidedLighting;
  111126. /**
  111127. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  111128. */
  111129. twoSidedLighting: boolean;
  111130. /**
  111131. * Default configuration related to image processing available in the standard Material.
  111132. */
  111133. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  111134. /**
  111135. * Gets the image processing configuration used either in this material.
  111136. */
  111137. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  111138. /**
  111139. * Sets the Default image processing configuration used either in the this material.
  111140. *
  111141. * If sets to null, the scene one is in use.
  111142. */
  111143. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  111144. /**
  111145. * Keep track of the image processing observer to allow dispose and replace.
  111146. */
  111147. private _imageProcessingObserver;
  111148. /**
  111149. * Attaches a new image processing configuration to the Standard Material.
  111150. * @param configuration
  111151. */
  111152. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  111153. /**
  111154. * Gets wether the color curves effect is enabled.
  111155. */
  111156. get cameraColorCurvesEnabled(): boolean;
  111157. /**
  111158. * Sets wether the color curves effect is enabled.
  111159. */
  111160. set cameraColorCurvesEnabled(value: boolean);
  111161. /**
  111162. * Gets wether the color grading effect is enabled.
  111163. */
  111164. get cameraColorGradingEnabled(): boolean;
  111165. /**
  111166. * Gets wether the color grading effect is enabled.
  111167. */
  111168. set cameraColorGradingEnabled(value: boolean);
  111169. /**
  111170. * Gets wether tonemapping is enabled or not.
  111171. */
  111172. get cameraToneMappingEnabled(): boolean;
  111173. /**
  111174. * Sets wether tonemapping is enabled or not
  111175. */
  111176. set cameraToneMappingEnabled(value: boolean);
  111177. /**
  111178. * The camera exposure used on this material.
  111179. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  111180. * This corresponds to a photographic exposure.
  111181. */
  111182. get cameraExposure(): number;
  111183. /**
  111184. * The camera exposure used on this material.
  111185. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  111186. * This corresponds to a photographic exposure.
  111187. */
  111188. set cameraExposure(value: number);
  111189. /**
  111190. * Gets The camera contrast used on this material.
  111191. */
  111192. get cameraContrast(): number;
  111193. /**
  111194. * Sets The camera contrast used on this material.
  111195. */
  111196. set cameraContrast(value: number);
  111197. /**
  111198. * Gets the Color Grading 2D Lookup Texture.
  111199. */
  111200. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  111201. /**
  111202. * Sets the Color Grading 2D Lookup Texture.
  111203. */
  111204. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  111205. /**
  111206. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  111207. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  111208. * 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;
  111209. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  111210. */
  111211. get cameraColorCurves(): Nullable<ColorCurves>;
  111212. /**
  111213. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  111214. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  111215. * 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;
  111216. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  111217. */
  111218. set cameraColorCurves(value: Nullable<ColorCurves>);
  111219. /**
  111220. * Can this material render to several textures at once
  111221. */
  111222. get canRenderToMRT(): boolean;
  111223. /**
  111224. * Defines the detail map parameters for the material.
  111225. */
  111226. readonly detailMap: DetailMapConfiguration;
  111227. protected _renderTargets: SmartArray<RenderTargetTexture>;
  111228. protected _worldViewProjectionMatrix: Matrix;
  111229. protected _globalAmbientColor: Color3;
  111230. protected _useLogarithmicDepth: boolean;
  111231. protected _rebuildInParallel: boolean;
  111232. /**
  111233. * Instantiates a new standard material.
  111234. * This is the default material used in Babylon. It is the best trade off between quality
  111235. * and performances.
  111236. * @see https://doc.babylonjs.com/babylon101/materials
  111237. * @param name Define the name of the material in the scene
  111238. * @param scene Define the scene the material belong to
  111239. */
  111240. constructor(name: string, scene: Scene);
  111241. /**
  111242. * Gets a boolean indicating that current material needs to register RTT
  111243. */
  111244. get hasRenderTargetTextures(): boolean;
  111245. /**
  111246. * Gets the current class name of the material e.g. "StandardMaterial"
  111247. * Mainly use in serialization.
  111248. * @returns the class name
  111249. */
  111250. getClassName(): string;
  111251. /**
  111252. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  111253. * You can try switching to logarithmic depth.
  111254. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  111255. */
  111256. get useLogarithmicDepth(): boolean;
  111257. set useLogarithmicDepth(value: boolean);
  111258. /**
  111259. * Specifies if the material will require alpha blending
  111260. * @returns a boolean specifying if alpha blending is needed
  111261. */
  111262. needAlphaBlending(): boolean;
  111263. /**
  111264. * Specifies if this material should be rendered in alpha test mode
  111265. * @returns a boolean specifying if an alpha test is needed.
  111266. */
  111267. needAlphaTesting(): boolean;
  111268. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  111269. /**
  111270. * Get the texture used for alpha test purpose.
  111271. * @returns the diffuse texture in case of the standard material.
  111272. */
  111273. getAlphaTestTexture(): Nullable<BaseTexture>;
  111274. /**
  111275. * Get if the submesh is ready to be used and all its information available.
  111276. * Child classes can use it to update shaders
  111277. * @param mesh defines the mesh to check
  111278. * @param subMesh defines which submesh to check
  111279. * @param useInstances specifies that instances should be used
  111280. * @returns a boolean indicating that the submesh is ready or not
  111281. */
  111282. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  111283. /**
  111284. * Builds the material UBO layouts.
  111285. * Used internally during the effect preparation.
  111286. */
  111287. buildUniformLayout(): void;
  111288. /**
  111289. * Unbinds the material from the mesh
  111290. */
  111291. unbind(): void;
  111292. /**
  111293. * Binds the submesh to this material by preparing the effect and shader to draw
  111294. * @param world defines the world transformation matrix
  111295. * @param mesh defines the mesh containing the submesh
  111296. * @param subMesh defines the submesh to bind the material to
  111297. */
  111298. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  111299. /**
  111300. * Get the list of animatables in the material.
  111301. * @returns the list of animatables object used in the material
  111302. */
  111303. getAnimatables(): IAnimatable[];
  111304. /**
  111305. * Gets the active textures from the material
  111306. * @returns an array of textures
  111307. */
  111308. getActiveTextures(): BaseTexture[];
  111309. /**
  111310. * Specifies if the material uses a texture
  111311. * @param texture defines the texture to check against the material
  111312. * @returns a boolean specifying if the material uses the texture
  111313. */
  111314. hasTexture(texture: BaseTexture): boolean;
  111315. /**
  111316. * Disposes the material
  111317. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  111318. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  111319. */
  111320. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  111321. /**
  111322. * Makes a duplicate of the material, and gives it a new name
  111323. * @param name defines the new name for the duplicated material
  111324. * @returns the cloned material
  111325. */
  111326. clone(name: string): StandardMaterial;
  111327. /**
  111328. * Serializes this material in a JSON representation
  111329. * @returns the serialized material object
  111330. */
  111331. serialize(): any;
  111332. /**
  111333. * Creates a standard material from parsed material data
  111334. * @param source defines the JSON representation of the material
  111335. * @param scene defines the hosting scene
  111336. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  111337. * @returns a new standard material
  111338. */
  111339. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  111340. /**
  111341. * Are diffuse textures enabled in the application.
  111342. */
  111343. static get DiffuseTextureEnabled(): boolean;
  111344. static set DiffuseTextureEnabled(value: boolean);
  111345. /**
  111346. * Are detail textures enabled in the application.
  111347. */
  111348. static get DetailTextureEnabled(): boolean;
  111349. static set DetailTextureEnabled(value: boolean);
  111350. /**
  111351. * Are ambient textures enabled in the application.
  111352. */
  111353. static get AmbientTextureEnabled(): boolean;
  111354. static set AmbientTextureEnabled(value: boolean);
  111355. /**
  111356. * Are opacity textures enabled in the application.
  111357. */
  111358. static get OpacityTextureEnabled(): boolean;
  111359. static set OpacityTextureEnabled(value: boolean);
  111360. /**
  111361. * Are reflection textures enabled in the application.
  111362. */
  111363. static get ReflectionTextureEnabled(): boolean;
  111364. static set ReflectionTextureEnabled(value: boolean);
  111365. /**
  111366. * Are emissive textures enabled in the application.
  111367. */
  111368. static get EmissiveTextureEnabled(): boolean;
  111369. static set EmissiveTextureEnabled(value: boolean);
  111370. /**
  111371. * Are specular textures enabled in the application.
  111372. */
  111373. static get SpecularTextureEnabled(): boolean;
  111374. static set SpecularTextureEnabled(value: boolean);
  111375. /**
  111376. * Are bump textures enabled in the application.
  111377. */
  111378. static get BumpTextureEnabled(): boolean;
  111379. static set BumpTextureEnabled(value: boolean);
  111380. /**
  111381. * Are lightmap textures enabled in the application.
  111382. */
  111383. static get LightmapTextureEnabled(): boolean;
  111384. static set LightmapTextureEnabled(value: boolean);
  111385. /**
  111386. * Are refraction textures enabled in the application.
  111387. */
  111388. static get RefractionTextureEnabled(): boolean;
  111389. static set RefractionTextureEnabled(value: boolean);
  111390. /**
  111391. * Are color grading textures enabled in the application.
  111392. */
  111393. static get ColorGradingTextureEnabled(): boolean;
  111394. static set ColorGradingTextureEnabled(value: boolean);
  111395. /**
  111396. * Are fresnels enabled in the application.
  111397. */
  111398. static get FresnelEnabled(): boolean;
  111399. static set FresnelEnabled(value: boolean);
  111400. }
  111401. }
  111402. declare module BABYLON {
  111403. /**
  111404. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  111405. *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.
  111406. * The SPS is also a particle system. It provides some methods to manage the particles.
  111407. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  111408. *
  111409. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  111410. */
  111411. export class SolidParticleSystem implements IDisposable {
  111412. /**
  111413. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  111414. * Example : var p = SPS.particles[i];
  111415. */
  111416. particles: SolidParticle[];
  111417. /**
  111418. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  111419. */
  111420. nbParticles: number;
  111421. /**
  111422. * If the particles must ever face the camera (default false). Useful for planar particles.
  111423. */
  111424. billboard: boolean;
  111425. /**
  111426. * Recompute normals when adding a shape
  111427. */
  111428. recomputeNormals: boolean;
  111429. /**
  111430. * This a counter ofr your own usage. It's not set by any SPS functions.
  111431. */
  111432. counter: number;
  111433. /**
  111434. * The SPS name. This name is also given to the underlying mesh.
  111435. */
  111436. name: string;
  111437. /**
  111438. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  111439. */
  111440. mesh: Mesh;
  111441. /**
  111442. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  111443. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  111444. */
  111445. vars: any;
  111446. /**
  111447. * This array is populated when the SPS is set as 'pickable'.
  111448. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  111449. * Each element of this array is an object `{idx: int, faceId: int}`.
  111450. * `idx` is the picked particle index in the `SPS.particles` array
  111451. * `faceId` is the picked face index counted within this particle.
  111452. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  111453. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  111454. * Use the method SPS.pickedParticle(pickingInfo) instead.
  111455. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  111456. */
  111457. pickedParticles: {
  111458. idx: number;
  111459. faceId: number;
  111460. }[];
  111461. /**
  111462. * This array is populated when the SPS is set as 'pickable'
  111463. * Each key of this array is a submesh index.
  111464. * Each element of this array is a second array defined like this :
  111465. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  111466. * Each element of this second array is an object `{idx: int, faceId: int}`.
  111467. * `idx` is the picked particle index in the `SPS.particles` array
  111468. * `faceId` is the picked face index counted within this particle.
  111469. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  111470. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  111471. */
  111472. pickedBySubMesh: {
  111473. idx: number;
  111474. faceId: number;
  111475. }[][];
  111476. /**
  111477. * This array is populated when `enableDepthSort` is set to true.
  111478. * Each element of this array is an instance of the class DepthSortedParticle.
  111479. */
  111480. depthSortedParticles: DepthSortedParticle[];
  111481. /**
  111482. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  111483. * @hidden
  111484. */
  111485. _bSphereOnly: boolean;
  111486. /**
  111487. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  111488. * @hidden
  111489. */
  111490. _bSphereRadiusFactor: number;
  111491. private _scene;
  111492. private _positions;
  111493. private _indices;
  111494. private _normals;
  111495. private _colors;
  111496. private _uvs;
  111497. private _indices32;
  111498. private _positions32;
  111499. private _normals32;
  111500. private _fixedNormal32;
  111501. private _colors32;
  111502. private _uvs32;
  111503. private _index;
  111504. private _updatable;
  111505. private _pickable;
  111506. private _isVisibilityBoxLocked;
  111507. private _alwaysVisible;
  111508. private _depthSort;
  111509. private _expandable;
  111510. private _shapeCounter;
  111511. private _copy;
  111512. private _color;
  111513. private _computeParticleColor;
  111514. private _computeParticleTexture;
  111515. private _computeParticleRotation;
  111516. private _computeParticleVertex;
  111517. private _computeBoundingBox;
  111518. private _depthSortParticles;
  111519. private _camera;
  111520. private _mustUnrotateFixedNormals;
  111521. private _particlesIntersect;
  111522. private _needs32Bits;
  111523. private _isNotBuilt;
  111524. private _lastParticleId;
  111525. private _idxOfId;
  111526. private _multimaterialEnabled;
  111527. private _useModelMaterial;
  111528. private _indicesByMaterial;
  111529. private _materialIndexes;
  111530. private _depthSortFunction;
  111531. private _materialSortFunction;
  111532. private _materials;
  111533. private _multimaterial;
  111534. private _materialIndexesById;
  111535. private _defaultMaterial;
  111536. private _autoUpdateSubMeshes;
  111537. private _tmpVertex;
  111538. /**
  111539. * Creates a SPS (Solid Particle System) object.
  111540. * @param name (String) is the SPS name, this will be the underlying mesh name.
  111541. * @param scene (Scene) is the scene in which the SPS is added.
  111542. * @param options defines the options of the sps e.g.
  111543. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  111544. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  111545. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  111546. * * 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.
  111547. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  111548. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  111549. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  111550. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  111551. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  111552. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  111553. */
  111554. constructor(name: string, scene: Scene, options?: {
  111555. updatable?: boolean;
  111556. isPickable?: boolean;
  111557. enableDepthSort?: boolean;
  111558. particleIntersection?: boolean;
  111559. boundingSphereOnly?: boolean;
  111560. bSphereRadiusFactor?: number;
  111561. expandable?: boolean;
  111562. useModelMaterial?: boolean;
  111563. enableMultiMaterial?: boolean;
  111564. });
  111565. /**
  111566. * Builds the SPS underlying mesh. Returns a standard Mesh.
  111567. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  111568. * @returns the created mesh
  111569. */
  111570. buildMesh(): Mesh;
  111571. /**
  111572. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  111573. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  111574. * Thus the particles generated from `digest()` have their property `position` set yet.
  111575. * @param mesh ( Mesh ) is the mesh to be digested
  111576. * @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
  111577. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  111578. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  111579. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  111580. * @returns the current SPS
  111581. */
  111582. digest(mesh: Mesh, options?: {
  111583. facetNb?: number;
  111584. number?: number;
  111585. delta?: number;
  111586. storage?: [];
  111587. }): SolidParticleSystem;
  111588. /**
  111589. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  111590. * @hidden
  111591. */
  111592. private _unrotateFixedNormals;
  111593. /**
  111594. * Resets the temporary working copy particle
  111595. * @hidden
  111596. */
  111597. private _resetCopy;
  111598. /**
  111599. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  111600. * @param p the current index in the positions array to be updated
  111601. * @param ind the current index in the indices array
  111602. * @param shape a Vector3 array, the shape geometry
  111603. * @param positions the positions array to be updated
  111604. * @param meshInd the shape indices array
  111605. * @param indices the indices array to be updated
  111606. * @param meshUV the shape uv array
  111607. * @param uvs the uv array to be updated
  111608. * @param meshCol the shape color array
  111609. * @param colors the color array to be updated
  111610. * @param meshNor the shape normals array
  111611. * @param normals the normals array to be updated
  111612. * @param idx the particle index
  111613. * @param idxInShape the particle index in its shape
  111614. * @param options the addShape() method passed options
  111615. * @model the particle model
  111616. * @hidden
  111617. */
  111618. private _meshBuilder;
  111619. /**
  111620. * Returns a shape Vector3 array from positions float array
  111621. * @param positions float array
  111622. * @returns a vector3 array
  111623. * @hidden
  111624. */
  111625. private _posToShape;
  111626. /**
  111627. * Returns a shapeUV array from a float uvs (array deep copy)
  111628. * @param uvs as a float array
  111629. * @returns a shapeUV array
  111630. * @hidden
  111631. */
  111632. private _uvsToShapeUV;
  111633. /**
  111634. * Adds a new particle object in the particles array
  111635. * @param idx particle index in particles array
  111636. * @param id particle id
  111637. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  111638. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  111639. * @param model particle ModelShape object
  111640. * @param shapeId model shape identifier
  111641. * @param idxInShape index of the particle in the current model
  111642. * @param bInfo model bounding info object
  111643. * @param storage target storage array, if any
  111644. * @hidden
  111645. */
  111646. private _addParticle;
  111647. /**
  111648. * Adds some particles to the SPS from the model shape. Returns the shape id.
  111649. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  111650. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  111651. * @param nb (positive integer) the number of particles to be created from this model
  111652. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  111653. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  111654. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  111655. * @returns the number of shapes in the system
  111656. */
  111657. addShape(mesh: Mesh, nb: number, options?: {
  111658. positionFunction?: any;
  111659. vertexFunction?: any;
  111660. storage?: [];
  111661. }): number;
  111662. /**
  111663. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  111664. * @hidden
  111665. */
  111666. private _rebuildParticle;
  111667. /**
  111668. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  111669. * @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.
  111670. * @returns the SPS.
  111671. */
  111672. rebuildMesh(reset?: boolean): SolidParticleSystem;
  111673. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  111674. * Returns an array with the removed particles.
  111675. * 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.
  111676. * The SPS can't be empty so at least one particle needs to remain in place.
  111677. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  111678. * @param start index of the first particle to remove
  111679. * @param end index of the last particle to remove (included)
  111680. * @returns an array populated with the removed particles
  111681. */
  111682. removeParticles(start: number, end: number): SolidParticle[];
  111683. /**
  111684. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  111685. * @param solidParticleArray an array populated with Solid Particles objects
  111686. * @returns the SPS
  111687. */
  111688. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  111689. /**
  111690. * Creates a new particle and modifies the SPS mesh geometry :
  111691. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  111692. * - calls _addParticle() to populate the particle array
  111693. * factorized code from addShape() and insertParticlesFromArray()
  111694. * @param idx particle index in the particles array
  111695. * @param i particle index in its shape
  111696. * @param modelShape particle ModelShape object
  111697. * @param shape shape vertex array
  111698. * @param meshInd shape indices array
  111699. * @param meshUV shape uv array
  111700. * @param meshCol shape color array
  111701. * @param meshNor shape normals array
  111702. * @param bbInfo shape bounding info
  111703. * @param storage target particle storage
  111704. * @options addShape() passed options
  111705. * @hidden
  111706. */
  111707. private _insertNewParticle;
  111708. /**
  111709. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  111710. * This method calls `updateParticle()` for each particle of the SPS.
  111711. * For an animated SPS, it is usually called within the render loop.
  111712. * 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.
  111713. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  111714. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  111715. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  111716. * @returns the SPS.
  111717. */
  111718. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  111719. /**
  111720. * Disposes the SPS.
  111721. */
  111722. dispose(): void;
  111723. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  111724. * idx is the particle index in the SPS
  111725. * faceId is the picked face index counted within this particle.
  111726. * Returns null if the pickInfo can't identify a picked particle.
  111727. * @param pickingInfo (PickingInfo object)
  111728. * @returns {idx: number, faceId: number} or null
  111729. */
  111730. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  111731. idx: number;
  111732. faceId: number;
  111733. }>;
  111734. /**
  111735. * Returns a SolidParticle object from its identifier : particle.id
  111736. * @param id (integer) the particle Id
  111737. * @returns the searched particle or null if not found in the SPS.
  111738. */
  111739. getParticleById(id: number): Nullable<SolidParticle>;
  111740. /**
  111741. * Returns a new array populated with the particles having the passed shapeId.
  111742. * @param shapeId (integer) the shape identifier
  111743. * @returns a new solid particle array
  111744. */
  111745. getParticlesByShapeId(shapeId: number): SolidParticle[];
  111746. /**
  111747. * Populates the passed array "ref" with the particles having the passed shapeId.
  111748. * @param shapeId the shape identifier
  111749. * @returns the SPS
  111750. * @param ref
  111751. */
  111752. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  111753. /**
  111754. * Computes the required SubMeshes according the materials assigned to the particles.
  111755. * @returns the solid particle system.
  111756. * Does nothing if called before the SPS mesh is built.
  111757. */
  111758. computeSubMeshes(): SolidParticleSystem;
  111759. /**
  111760. * Sorts the solid particles by material when MultiMaterial is enabled.
  111761. * Updates the indices32 array.
  111762. * Updates the indicesByMaterial array.
  111763. * Updates the mesh indices array.
  111764. * @returns the SPS
  111765. * @hidden
  111766. */
  111767. private _sortParticlesByMaterial;
  111768. /**
  111769. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  111770. * @hidden
  111771. */
  111772. private _setMaterialIndexesById;
  111773. /**
  111774. * Returns an array with unique values of Materials from the passed array
  111775. * @param array the material array to be checked and filtered
  111776. * @hidden
  111777. */
  111778. private _filterUniqueMaterialId;
  111779. /**
  111780. * Sets a new Standard Material as _defaultMaterial if not already set.
  111781. * @hidden
  111782. */
  111783. private _setDefaultMaterial;
  111784. /**
  111785. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  111786. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111787. * @returns the SPS.
  111788. */
  111789. refreshVisibleSize(): SolidParticleSystem;
  111790. /**
  111791. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  111792. * @param size the size (float) of the visibility box
  111793. * note : this doesn't lock the SPS mesh bounding box.
  111794. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111795. */
  111796. setVisibilityBox(size: number): void;
  111797. /**
  111798. * Gets whether the SPS as always visible or not
  111799. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111800. */
  111801. get isAlwaysVisible(): boolean;
  111802. /**
  111803. * Sets the SPS as always visible or not
  111804. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111805. */
  111806. set isAlwaysVisible(val: boolean);
  111807. /**
  111808. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  111809. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111810. */
  111811. set isVisibilityBoxLocked(val: boolean);
  111812. /**
  111813. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  111814. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111815. */
  111816. get isVisibilityBoxLocked(): boolean;
  111817. /**
  111818. * Tells to `setParticles()` to compute the particle rotations or not.
  111819. * Default value : true. The SPS is faster when it's set to false.
  111820. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  111821. */
  111822. set computeParticleRotation(val: boolean);
  111823. /**
  111824. * Tells to `setParticles()` to compute the particle colors or not.
  111825. * Default value : true. The SPS is faster when it's set to false.
  111826. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  111827. */
  111828. set computeParticleColor(val: boolean);
  111829. set computeParticleTexture(val: boolean);
  111830. /**
  111831. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  111832. * Default value : false. The SPS is faster when it's set to false.
  111833. * Note : the particle custom vertex positions aren't stored values.
  111834. */
  111835. set computeParticleVertex(val: boolean);
  111836. /**
  111837. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  111838. */
  111839. set computeBoundingBox(val: boolean);
  111840. /**
  111841. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  111842. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  111843. * Default : `true`
  111844. */
  111845. set depthSortParticles(val: boolean);
  111846. /**
  111847. * Gets if `setParticles()` computes the particle rotations or not.
  111848. * Default value : true. The SPS is faster when it's set to false.
  111849. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  111850. */
  111851. get computeParticleRotation(): boolean;
  111852. /**
  111853. * Gets if `setParticles()` computes the particle colors or not.
  111854. * Default value : true. The SPS is faster when it's set to false.
  111855. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  111856. */
  111857. get computeParticleColor(): boolean;
  111858. /**
  111859. * Gets if `setParticles()` computes the particle textures or not.
  111860. * Default value : true. The SPS is faster when it's set to false.
  111861. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  111862. */
  111863. get computeParticleTexture(): boolean;
  111864. /**
  111865. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  111866. * Default value : false. The SPS is faster when it's set to false.
  111867. * Note : the particle custom vertex positions aren't stored values.
  111868. */
  111869. get computeParticleVertex(): boolean;
  111870. /**
  111871. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  111872. */
  111873. get computeBoundingBox(): boolean;
  111874. /**
  111875. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  111876. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  111877. * Default : `true`
  111878. */
  111879. get depthSortParticles(): boolean;
  111880. /**
  111881. * Gets if the SPS is created as expandable at construction time.
  111882. * Default : `false`
  111883. */
  111884. get expandable(): boolean;
  111885. /**
  111886. * Gets if the SPS supports the Multi Materials
  111887. */
  111888. get multimaterialEnabled(): boolean;
  111889. /**
  111890. * Gets if the SPS uses the model materials for its own multimaterial.
  111891. */
  111892. get useModelMaterial(): boolean;
  111893. /**
  111894. * The SPS used material array.
  111895. */
  111896. get materials(): Material[];
  111897. /**
  111898. * Sets the SPS MultiMaterial from the passed materials.
  111899. * Note : the passed array is internally copied and not used then by reference.
  111900. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  111901. */
  111902. setMultiMaterial(materials: Material[]): void;
  111903. /**
  111904. * The SPS computed multimaterial object
  111905. */
  111906. get multimaterial(): MultiMaterial;
  111907. set multimaterial(mm: MultiMaterial);
  111908. /**
  111909. * If the subMeshes must be updated on the next call to setParticles()
  111910. */
  111911. get autoUpdateSubMeshes(): boolean;
  111912. set autoUpdateSubMeshes(val: boolean);
  111913. /**
  111914. * This function does nothing. It may be overwritten to set all the particle first values.
  111915. * The SPS doesn't call this function, you may have to call it by your own.
  111916. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111917. */
  111918. initParticles(): void;
  111919. /**
  111920. * This function does nothing. It may be overwritten to recycle a particle.
  111921. * The SPS doesn't call this function, you may have to call it by your own.
  111922. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111923. * @param particle The particle to recycle
  111924. * @returns the recycled particle
  111925. */
  111926. recycleParticle(particle: SolidParticle): SolidParticle;
  111927. /**
  111928. * Updates a particle : this function should be overwritten by the user.
  111929. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  111930. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111931. * @example : just set a particle position or velocity and recycle conditions
  111932. * @param particle The particle to update
  111933. * @returns the updated particle
  111934. */
  111935. updateParticle(particle: SolidParticle): SolidParticle;
  111936. /**
  111937. * Updates a vertex of a particle : it can be overwritten by the user.
  111938. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  111939. * @param particle the current particle
  111940. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  111941. * @param pt the index of the current vertex in the particle shape
  111942. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  111943. * @example : just set a vertex particle position or color
  111944. * @returns the sps
  111945. */
  111946. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  111947. /**
  111948. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  111949. * This does nothing and may be overwritten by the user.
  111950. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111951. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111952. * @param update the boolean update value actually passed to setParticles()
  111953. */
  111954. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  111955. /**
  111956. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  111957. * This will be passed three parameters.
  111958. * This does nothing and may be overwritten by the user.
  111959. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111960. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111961. * @param update the boolean update value actually passed to setParticles()
  111962. */
  111963. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  111964. }
  111965. }
  111966. declare module BABYLON {
  111967. /**
  111968. * Represents one particle of a solid particle system.
  111969. */
  111970. export class SolidParticle {
  111971. /**
  111972. * particle global index
  111973. */
  111974. idx: number;
  111975. /**
  111976. * particle identifier
  111977. */
  111978. id: number;
  111979. /**
  111980. * The color of the particle
  111981. */
  111982. color: Nullable<Color4>;
  111983. /**
  111984. * The world space position of the particle.
  111985. */
  111986. position: Vector3;
  111987. /**
  111988. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  111989. */
  111990. rotation: Vector3;
  111991. /**
  111992. * The world space rotation quaternion of the particle.
  111993. */
  111994. rotationQuaternion: Nullable<Quaternion>;
  111995. /**
  111996. * The scaling of the particle.
  111997. */
  111998. scaling: Vector3;
  111999. /**
  112000. * The uvs of the particle.
  112001. */
  112002. uvs: Vector4;
  112003. /**
  112004. * The current speed of the particle.
  112005. */
  112006. velocity: Vector3;
  112007. /**
  112008. * The pivot point in the particle local space.
  112009. */
  112010. pivot: Vector3;
  112011. /**
  112012. * Must the particle be translated from its pivot point in its local space ?
  112013. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  112014. * Default : false
  112015. */
  112016. translateFromPivot: boolean;
  112017. /**
  112018. * Is the particle active or not ?
  112019. */
  112020. alive: boolean;
  112021. /**
  112022. * Is the particle visible or not ?
  112023. */
  112024. isVisible: boolean;
  112025. /**
  112026. * Index of this particle in the global "positions" array (Internal use)
  112027. * @hidden
  112028. */
  112029. _pos: number;
  112030. /**
  112031. * @hidden Index of this particle in the global "indices" array (Internal use)
  112032. */
  112033. _ind: number;
  112034. /**
  112035. * @hidden ModelShape of this particle (Internal use)
  112036. */
  112037. _model: ModelShape;
  112038. /**
  112039. * ModelShape id of this particle
  112040. */
  112041. shapeId: number;
  112042. /**
  112043. * Index of the particle in its shape id
  112044. */
  112045. idxInShape: number;
  112046. /**
  112047. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  112048. */
  112049. _modelBoundingInfo: BoundingInfo;
  112050. /**
  112051. * @hidden Particle BoundingInfo object (Internal use)
  112052. */
  112053. _boundingInfo: BoundingInfo;
  112054. /**
  112055. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  112056. */
  112057. _sps: SolidParticleSystem;
  112058. /**
  112059. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  112060. */
  112061. _stillInvisible: boolean;
  112062. /**
  112063. * @hidden Last computed particle rotation matrix
  112064. */
  112065. _rotationMatrix: number[];
  112066. /**
  112067. * Parent particle Id, if any.
  112068. * Default null.
  112069. */
  112070. parentId: Nullable<number>;
  112071. /**
  112072. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  112073. */
  112074. materialIndex: Nullable<number>;
  112075. /**
  112076. * Custom object or properties.
  112077. */
  112078. props: Nullable<any>;
  112079. /**
  112080. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  112081. * The possible values are :
  112082. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  112083. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  112084. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  112085. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  112086. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  112087. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  112088. * */
  112089. cullingStrategy: number;
  112090. /**
  112091. * @hidden Internal global position in the SPS.
  112092. */
  112093. _globalPosition: Vector3;
  112094. /**
  112095. * Creates a Solid Particle object.
  112096. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  112097. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  112098. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  112099. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  112100. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  112101. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  112102. * @param shapeId (integer) is the model shape identifier in the SPS.
  112103. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  112104. * @param sps defines the sps it is associated to
  112105. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  112106. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  112107. */
  112108. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  112109. /**
  112110. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  112111. * @param target the particle target
  112112. * @returns the current particle
  112113. */
  112114. copyToRef(target: SolidParticle): SolidParticle;
  112115. /**
  112116. * Legacy support, changed scale to scaling
  112117. */
  112118. get scale(): Vector3;
  112119. /**
  112120. * Legacy support, changed scale to scaling
  112121. */
  112122. set scale(scale: Vector3);
  112123. /**
  112124. * Legacy support, changed quaternion to rotationQuaternion
  112125. */
  112126. get quaternion(): Nullable<Quaternion>;
  112127. /**
  112128. * Legacy support, changed quaternion to rotationQuaternion
  112129. */
  112130. set quaternion(q: Nullable<Quaternion>);
  112131. /**
  112132. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  112133. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  112134. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  112135. * @returns true if it intersects
  112136. */
  112137. intersectsMesh(target: Mesh | SolidParticle): boolean;
  112138. /**
  112139. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  112140. * A particle is in the frustum if its bounding box intersects the frustum
  112141. * @param frustumPlanes defines the frustum to test
  112142. * @returns true if the particle is in the frustum planes
  112143. */
  112144. isInFrustum(frustumPlanes: Plane[]): boolean;
  112145. /**
  112146. * get the rotation matrix of the particle
  112147. * @hidden
  112148. */
  112149. getRotationMatrix(m: Matrix): void;
  112150. }
  112151. /**
  112152. * Represents the shape of the model used by one particle of a solid particle system.
  112153. * SPS internal tool, don't use it manually.
  112154. */
  112155. export class ModelShape {
  112156. /**
  112157. * The shape id
  112158. * @hidden
  112159. */
  112160. shapeID: number;
  112161. /**
  112162. * flat array of model positions (internal use)
  112163. * @hidden
  112164. */
  112165. _shape: Vector3[];
  112166. /**
  112167. * flat array of model UVs (internal use)
  112168. * @hidden
  112169. */
  112170. _shapeUV: number[];
  112171. /**
  112172. * color array of the model
  112173. * @hidden
  112174. */
  112175. _shapeColors: number[];
  112176. /**
  112177. * indices array of the model
  112178. * @hidden
  112179. */
  112180. _indices: number[];
  112181. /**
  112182. * normals array of the model
  112183. * @hidden
  112184. */
  112185. _normals: number[];
  112186. /**
  112187. * length of the shape in the model indices array (internal use)
  112188. * @hidden
  112189. */
  112190. _indicesLength: number;
  112191. /**
  112192. * Custom position function (internal use)
  112193. * @hidden
  112194. */
  112195. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  112196. /**
  112197. * Custom vertex function (internal use)
  112198. * @hidden
  112199. */
  112200. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  112201. /**
  112202. * Model material (internal use)
  112203. * @hidden
  112204. */
  112205. _material: Nullable<Material>;
  112206. /**
  112207. * 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.
  112208. * SPS internal tool, don't use it manually.
  112209. * @hidden
  112210. */
  112211. 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>);
  112212. }
  112213. /**
  112214. * Represents a Depth Sorted Particle in the solid particle system.
  112215. * @hidden
  112216. */
  112217. export class DepthSortedParticle {
  112218. /**
  112219. * Particle index
  112220. */
  112221. idx: number;
  112222. /**
  112223. * Index of the particle in the "indices" array
  112224. */
  112225. ind: number;
  112226. /**
  112227. * Length of the particle shape in the "indices" array
  112228. */
  112229. indicesLength: number;
  112230. /**
  112231. * Squared distance from the particle to the camera
  112232. */
  112233. sqDistance: number;
  112234. /**
  112235. * Material index when used with MultiMaterials
  112236. */
  112237. materialIndex: number;
  112238. /**
  112239. * Creates a new sorted particle
  112240. * @param materialIndex
  112241. */
  112242. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  112243. }
  112244. /**
  112245. * Represents a solid particle vertex
  112246. */
  112247. export class SolidParticleVertex {
  112248. /**
  112249. * Vertex position
  112250. */
  112251. position: Vector3;
  112252. /**
  112253. * Vertex color
  112254. */
  112255. color: Color4;
  112256. /**
  112257. * Vertex UV
  112258. */
  112259. uv: Vector2;
  112260. /**
  112261. * Creates a new solid particle vertex
  112262. */
  112263. constructor();
  112264. /** Vertex x coordinate */
  112265. get x(): number;
  112266. set x(val: number);
  112267. /** Vertex y coordinate */
  112268. get y(): number;
  112269. set y(val: number);
  112270. /** Vertex z coordinate */
  112271. get z(): number;
  112272. set z(val: number);
  112273. }
  112274. }
  112275. declare module BABYLON {
  112276. /**
  112277. * @hidden
  112278. */
  112279. export class _MeshCollisionData {
  112280. _checkCollisions: boolean;
  112281. _collisionMask: number;
  112282. _collisionGroup: number;
  112283. _surroundingMeshes: Nullable<AbstractMesh[]>;
  112284. _collider: Nullable<Collider>;
  112285. _oldPositionForCollisions: Vector3;
  112286. _diffPositionForCollisions: Vector3;
  112287. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  112288. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  112289. _collisionResponse: boolean;
  112290. }
  112291. }
  112292. declare module BABYLON {
  112293. /** @hidden */
  112294. class _FacetDataStorage {
  112295. facetPositions: Vector3[];
  112296. facetNormals: Vector3[];
  112297. facetPartitioning: number[][];
  112298. facetNb: number;
  112299. partitioningSubdivisions: number;
  112300. partitioningBBoxRatio: number;
  112301. facetDataEnabled: boolean;
  112302. facetParameters: any;
  112303. bbSize: Vector3;
  112304. subDiv: {
  112305. max: number;
  112306. X: number;
  112307. Y: number;
  112308. Z: number;
  112309. };
  112310. facetDepthSort: boolean;
  112311. facetDepthSortEnabled: boolean;
  112312. depthSortedIndices: IndicesArray;
  112313. depthSortedFacets: {
  112314. ind: number;
  112315. sqDistance: number;
  112316. }[];
  112317. facetDepthSortFunction: (f1: {
  112318. ind: number;
  112319. sqDistance: number;
  112320. }, f2: {
  112321. ind: number;
  112322. sqDistance: number;
  112323. }) => number;
  112324. facetDepthSortFrom: Vector3;
  112325. facetDepthSortOrigin: Vector3;
  112326. invertedMatrix: Matrix;
  112327. }
  112328. /**
  112329. * @hidden
  112330. **/
  112331. class _InternalAbstractMeshDataInfo {
  112332. _hasVertexAlpha: boolean;
  112333. _useVertexColors: boolean;
  112334. _numBoneInfluencers: number;
  112335. _applyFog: boolean;
  112336. _receiveShadows: boolean;
  112337. _facetData: _FacetDataStorage;
  112338. _visibility: number;
  112339. _skeleton: Nullable<Skeleton>;
  112340. _layerMask: number;
  112341. _computeBonesUsingShaders: boolean;
  112342. _isActive: boolean;
  112343. _onlyForInstances: boolean;
  112344. _isActiveIntermediate: boolean;
  112345. _onlyForInstancesIntermediate: boolean;
  112346. _actAsRegularMesh: boolean;
  112347. }
  112348. /**
  112349. * Class used to store all common mesh properties
  112350. */
  112351. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  112352. /** No occlusion */
  112353. static OCCLUSION_TYPE_NONE: number;
  112354. /** Occlusion set to optimisitic */
  112355. static OCCLUSION_TYPE_OPTIMISTIC: number;
  112356. /** Occlusion set to strict */
  112357. static OCCLUSION_TYPE_STRICT: number;
  112358. /** Use an accurante occlusion algorithm */
  112359. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  112360. /** Use a conservative occlusion algorithm */
  112361. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  112362. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  112363. * Test order :
  112364. * Is the bounding sphere outside the frustum ?
  112365. * If not, are the bounding box vertices outside the frustum ?
  112366. * It not, then the cullable object is in the frustum.
  112367. */
  112368. static readonly CULLINGSTRATEGY_STANDARD: number;
  112369. /** Culling strategy : Bounding Sphere Only.
  112370. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  112371. * It's also less accurate than the standard because some not visible objects can still be selected.
  112372. * Test : is the bounding sphere outside the frustum ?
  112373. * If not, then the cullable object is in the frustum.
  112374. */
  112375. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  112376. /** Culling strategy : Optimistic Inclusion.
  112377. * This in an inclusion test first, then the standard exclusion test.
  112378. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  112379. * 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.
  112380. * Anyway, it's as accurate as the standard strategy.
  112381. * Test :
  112382. * Is the cullable object bounding sphere center in the frustum ?
  112383. * If not, apply the default culling strategy.
  112384. */
  112385. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  112386. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  112387. * This in an inclusion test first, then the bounding sphere only exclusion test.
  112388. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  112389. * 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.
  112390. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  112391. * Test :
  112392. * Is the cullable object bounding sphere center in the frustum ?
  112393. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  112394. */
  112395. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  112396. /**
  112397. * No billboard
  112398. */
  112399. static get BILLBOARDMODE_NONE(): number;
  112400. /** Billboard on X axis */
  112401. static get BILLBOARDMODE_X(): number;
  112402. /** Billboard on Y axis */
  112403. static get BILLBOARDMODE_Y(): number;
  112404. /** Billboard on Z axis */
  112405. static get BILLBOARDMODE_Z(): number;
  112406. /** Billboard on all axes */
  112407. static get BILLBOARDMODE_ALL(): number;
  112408. /** Billboard on using position instead of orientation */
  112409. static get BILLBOARDMODE_USE_POSITION(): number;
  112410. /** @hidden */
  112411. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  112412. /**
  112413. * The culling strategy to use to check whether the mesh must be rendered or not.
  112414. * This value can be changed at any time and will be used on the next render mesh selection.
  112415. * The possible values are :
  112416. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  112417. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  112418. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  112419. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  112420. * Please read each static variable documentation to get details about the culling process.
  112421. * */
  112422. cullingStrategy: number;
  112423. /**
  112424. * Gets the number of facets in the mesh
  112425. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  112426. */
  112427. get facetNb(): number;
  112428. /**
  112429. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  112430. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  112431. */
  112432. get partitioningSubdivisions(): number;
  112433. set partitioningSubdivisions(nb: number);
  112434. /**
  112435. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  112436. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  112437. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  112438. */
  112439. get partitioningBBoxRatio(): number;
  112440. set partitioningBBoxRatio(ratio: number);
  112441. /**
  112442. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  112443. * Works only for updatable meshes.
  112444. * Doesn't work with multi-materials
  112445. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  112446. */
  112447. get mustDepthSortFacets(): boolean;
  112448. set mustDepthSortFacets(sort: boolean);
  112449. /**
  112450. * The location (Vector3) where the facet depth sort must be computed from.
  112451. * By default, the active camera position.
  112452. * Used only when facet depth sort is enabled
  112453. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  112454. */
  112455. get facetDepthSortFrom(): Vector3;
  112456. set facetDepthSortFrom(location: Vector3);
  112457. /**
  112458. * gets a boolean indicating if facetData is enabled
  112459. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  112460. */
  112461. get isFacetDataEnabled(): boolean;
  112462. /** @hidden */
  112463. _updateNonUniformScalingState(value: boolean): boolean;
  112464. /**
  112465. * An event triggered when this mesh collides with another one
  112466. */
  112467. onCollideObservable: Observable<AbstractMesh>;
  112468. /** Set a function to call when this mesh collides with another one */
  112469. set onCollide(callback: () => void);
  112470. /**
  112471. * An event triggered when the collision's position changes
  112472. */
  112473. onCollisionPositionChangeObservable: Observable<Vector3>;
  112474. /** Set a function to call when the collision's position changes */
  112475. set onCollisionPositionChange(callback: () => void);
  112476. /**
  112477. * An event triggered when material is changed
  112478. */
  112479. onMaterialChangedObservable: Observable<AbstractMesh>;
  112480. /**
  112481. * Gets or sets the orientation for POV movement & rotation
  112482. */
  112483. definedFacingForward: boolean;
  112484. /** @hidden */
  112485. _occlusionQuery: Nullable<WebGLQuery>;
  112486. /** @hidden */
  112487. _renderingGroup: Nullable<RenderingGroup>;
  112488. /**
  112489. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  112490. */
  112491. get visibility(): number;
  112492. /**
  112493. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  112494. */
  112495. set visibility(value: number);
  112496. /** Gets or sets the alpha index used to sort transparent meshes
  112497. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  112498. */
  112499. alphaIndex: number;
  112500. /**
  112501. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  112502. */
  112503. isVisible: boolean;
  112504. /**
  112505. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  112506. */
  112507. isPickable: boolean;
  112508. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  112509. showSubMeshesBoundingBox: boolean;
  112510. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  112511. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  112512. */
  112513. isBlocker: boolean;
  112514. /**
  112515. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  112516. */
  112517. enablePointerMoveEvents: boolean;
  112518. private _renderingGroupId;
  112519. /**
  112520. * Specifies the rendering group id for this mesh (0 by default)
  112521. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  112522. */
  112523. get renderingGroupId(): number;
  112524. set renderingGroupId(value: number);
  112525. private _material;
  112526. /** Gets or sets current material */
  112527. get material(): Nullable<Material>;
  112528. set material(value: Nullable<Material>);
  112529. /**
  112530. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  112531. * @see https://doc.babylonjs.com/babylon101/shadows
  112532. */
  112533. get receiveShadows(): boolean;
  112534. set receiveShadows(value: boolean);
  112535. /** Defines color to use when rendering outline */
  112536. outlineColor: Color3;
  112537. /** Define width to use when rendering outline */
  112538. outlineWidth: number;
  112539. /** Defines color to use when rendering overlay */
  112540. overlayColor: Color3;
  112541. /** Defines alpha to use when rendering overlay */
  112542. overlayAlpha: number;
  112543. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  112544. get hasVertexAlpha(): boolean;
  112545. set hasVertexAlpha(value: boolean);
  112546. /** 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) */
  112547. get useVertexColors(): boolean;
  112548. set useVertexColors(value: boolean);
  112549. /**
  112550. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  112551. */
  112552. get computeBonesUsingShaders(): boolean;
  112553. set computeBonesUsingShaders(value: boolean);
  112554. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  112555. get numBoneInfluencers(): number;
  112556. set numBoneInfluencers(value: number);
  112557. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  112558. get applyFog(): boolean;
  112559. set applyFog(value: boolean);
  112560. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  112561. useOctreeForRenderingSelection: boolean;
  112562. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  112563. useOctreeForPicking: boolean;
  112564. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  112565. useOctreeForCollisions: boolean;
  112566. /**
  112567. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  112568. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  112569. */
  112570. get layerMask(): number;
  112571. set layerMask(value: number);
  112572. /**
  112573. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  112574. */
  112575. alwaysSelectAsActiveMesh: boolean;
  112576. /**
  112577. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  112578. */
  112579. doNotSyncBoundingInfo: boolean;
  112580. /**
  112581. * Gets or sets the current action manager
  112582. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  112583. */
  112584. actionManager: Nullable<AbstractActionManager>;
  112585. private _meshCollisionData;
  112586. /**
  112587. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  112588. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112589. */
  112590. ellipsoid: Vector3;
  112591. /**
  112592. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  112593. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112594. */
  112595. ellipsoidOffset: Vector3;
  112596. /**
  112597. * Gets or sets a collision mask used to mask collisions (default is -1).
  112598. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  112599. */
  112600. get collisionMask(): number;
  112601. set collisionMask(mask: number);
  112602. /**
  112603. * Gets or sets a collision response flag (default is true).
  112604. * when collisionResponse is false, events are still triggered but colliding entity has no response
  112605. * This helps creating trigger volume when user wants collision feedback events but not position/velocity
  112606. * to respond to the collision.
  112607. */
  112608. get collisionResponse(): boolean;
  112609. set collisionResponse(response: boolean);
  112610. /**
  112611. * Gets or sets the current collision group mask (-1 by default).
  112612. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  112613. */
  112614. get collisionGroup(): number;
  112615. set collisionGroup(mask: number);
  112616. /**
  112617. * Gets or sets current surrounding meshes (null by default).
  112618. *
  112619. * By default collision detection is tested against every mesh in the scene.
  112620. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  112621. * meshes will be tested for the collision.
  112622. *
  112623. * Note: if set to an empty array no collision will happen when this mesh is moved.
  112624. */
  112625. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  112626. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  112627. /**
  112628. * Defines edge width used when edgesRenderer is enabled
  112629. * @see https://www.babylonjs-playground.com/#10OJSG#13
  112630. */
  112631. edgesWidth: number;
  112632. /**
  112633. * Defines edge color used when edgesRenderer is enabled
  112634. * @see https://www.babylonjs-playground.com/#10OJSG#13
  112635. */
  112636. edgesColor: Color4;
  112637. /** @hidden */
  112638. _edgesRenderer: Nullable<IEdgesRenderer>;
  112639. /** @hidden */
  112640. _masterMesh: Nullable<AbstractMesh>;
  112641. /** @hidden */
  112642. _boundingInfo: Nullable<BoundingInfo>;
  112643. /** @hidden */
  112644. _renderId: number;
  112645. /**
  112646. * Gets or sets the list of subMeshes
  112647. * @see https://doc.babylonjs.com/how_to/multi_materials
  112648. */
  112649. subMeshes: SubMesh[];
  112650. /** @hidden */
  112651. _intersectionsInProgress: AbstractMesh[];
  112652. /** @hidden */
  112653. _unIndexed: boolean;
  112654. /** @hidden */
  112655. _lightSources: Light[];
  112656. /** Gets the list of lights affecting that mesh */
  112657. get lightSources(): Light[];
  112658. /** @hidden */
  112659. get _positions(): Nullable<Vector3[]>;
  112660. /** @hidden */
  112661. _waitingData: {
  112662. lods: Nullable<any>;
  112663. actions: Nullable<any>;
  112664. freezeWorldMatrix: Nullable<boolean>;
  112665. };
  112666. /** @hidden */
  112667. _bonesTransformMatrices: Nullable<Float32Array>;
  112668. /** @hidden */
  112669. _transformMatrixTexture: Nullable<RawTexture>;
  112670. /**
  112671. * Gets or sets a skeleton to apply skining transformations
  112672. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  112673. */
  112674. set skeleton(value: Nullable<Skeleton>);
  112675. get skeleton(): Nullable<Skeleton>;
  112676. /**
  112677. * An event triggered when the mesh is rebuilt.
  112678. */
  112679. onRebuildObservable: Observable<AbstractMesh>;
  112680. /**
  112681. * Creates a new AbstractMesh
  112682. * @param name defines the name of the mesh
  112683. * @param scene defines the hosting scene
  112684. */
  112685. constructor(name: string, scene?: Nullable<Scene>);
  112686. /**
  112687. * Returns the string "AbstractMesh"
  112688. * @returns "AbstractMesh"
  112689. */
  112690. getClassName(): string;
  112691. /**
  112692. * Gets a string representation of the current mesh
  112693. * @param fullDetails defines a boolean indicating if full details must be included
  112694. * @returns a string representation of the current mesh
  112695. */
  112696. toString(fullDetails?: boolean): string;
  112697. /**
  112698. * @hidden
  112699. */
  112700. protected _getEffectiveParent(): Nullable<Node>;
  112701. /** @hidden */
  112702. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  112703. /** @hidden */
  112704. _rebuild(): void;
  112705. /** @hidden */
  112706. _resyncLightSources(): void;
  112707. /** @hidden */
  112708. _resyncLightSource(light: Light): void;
  112709. /** @hidden */
  112710. _unBindEffect(): void;
  112711. /** @hidden */
  112712. _removeLightSource(light: Light, dispose: boolean): void;
  112713. private _markSubMeshesAsDirty;
  112714. /** @hidden */
  112715. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  112716. /** @hidden */
  112717. _markSubMeshesAsAttributesDirty(): void;
  112718. /** @hidden */
  112719. _markSubMeshesAsMiscDirty(): void;
  112720. /**
  112721. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  112722. */
  112723. get scaling(): Vector3;
  112724. set scaling(newScaling: Vector3);
  112725. /**
  112726. * Returns true if the mesh is blocked. Implemented by child classes
  112727. */
  112728. get isBlocked(): boolean;
  112729. /**
  112730. * Returns the mesh itself by default. Implemented by child classes
  112731. * @param camera defines the camera to use to pick the right LOD level
  112732. * @returns the currentAbstractMesh
  112733. */
  112734. getLOD(camera: Camera): Nullable<AbstractMesh>;
  112735. /**
  112736. * Returns 0 by default. Implemented by child classes
  112737. * @returns an integer
  112738. */
  112739. getTotalVertices(): number;
  112740. /**
  112741. * Returns a positive integer : the total number of indices in this mesh geometry.
  112742. * @returns the numner of indices or zero if the mesh has no geometry.
  112743. */
  112744. getTotalIndices(): number;
  112745. /**
  112746. * Returns null by default. Implemented by child classes
  112747. * @returns null
  112748. */
  112749. getIndices(): Nullable<IndicesArray>;
  112750. /**
  112751. * Returns the array of the requested vertex data kind. Implemented by child classes
  112752. * @param kind defines the vertex data kind to use
  112753. * @returns null
  112754. */
  112755. getVerticesData(kind: string): Nullable<FloatArray>;
  112756. /**
  112757. * Sets the vertex data of the mesh geometry for the requested `kind`.
  112758. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  112759. * Note that a new underlying VertexBuffer object is created each call.
  112760. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  112761. * @param kind defines vertex data kind:
  112762. * * VertexBuffer.PositionKind
  112763. * * VertexBuffer.UVKind
  112764. * * VertexBuffer.UV2Kind
  112765. * * VertexBuffer.UV3Kind
  112766. * * VertexBuffer.UV4Kind
  112767. * * VertexBuffer.UV5Kind
  112768. * * VertexBuffer.UV6Kind
  112769. * * VertexBuffer.ColorKind
  112770. * * VertexBuffer.MatricesIndicesKind
  112771. * * VertexBuffer.MatricesIndicesExtraKind
  112772. * * VertexBuffer.MatricesWeightsKind
  112773. * * VertexBuffer.MatricesWeightsExtraKind
  112774. * @param data defines the data source
  112775. * @param updatable defines if the data must be flagged as updatable (or static)
  112776. * @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
  112777. * @returns the current mesh
  112778. */
  112779. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  112780. /**
  112781. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  112782. * If the mesh has no geometry, it is simply returned as it is.
  112783. * @param kind defines vertex data kind:
  112784. * * VertexBuffer.PositionKind
  112785. * * VertexBuffer.UVKind
  112786. * * VertexBuffer.UV2Kind
  112787. * * VertexBuffer.UV3Kind
  112788. * * VertexBuffer.UV4Kind
  112789. * * VertexBuffer.UV5Kind
  112790. * * VertexBuffer.UV6Kind
  112791. * * VertexBuffer.ColorKind
  112792. * * VertexBuffer.MatricesIndicesKind
  112793. * * VertexBuffer.MatricesIndicesExtraKind
  112794. * * VertexBuffer.MatricesWeightsKind
  112795. * * VertexBuffer.MatricesWeightsExtraKind
  112796. * @param data defines the data source
  112797. * @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
  112798. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  112799. * @returns the current mesh
  112800. */
  112801. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  112802. /**
  112803. * Sets the mesh indices,
  112804. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  112805. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  112806. * @param totalVertices Defines the total number of vertices
  112807. * @returns the current mesh
  112808. */
  112809. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  112810. /**
  112811. * Gets a boolean indicating if specific vertex data is present
  112812. * @param kind defines the vertex data kind to use
  112813. * @returns true is data kind is present
  112814. */
  112815. isVerticesDataPresent(kind: string): boolean;
  112816. /**
  112817. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  112818. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  112819. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  112820. * @returns a BoundingInfo
  112821. */
  112822. getBoundingInfo(): BoundingInfo;
  112823. /**
  112824. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  112825. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  112826. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  112827. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  112828. * @returns the current mesh
  112829. */
  112830. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  112831. /**
  112832. * Overwrite the current bounding info
  112833. * @param boundingInfo defines the new bounding info
  112834. * @returns the current mesh
  112835. */
  112836. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  112837. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  112838. get useBones(): boolean;
  112839. /** @hidden */
  112840. _preActivate(): void;
  112841. /** @hidden */
  112842. _preActivateForIntermediateRendering(renderId: number): void;
  112843. /** @hidden */
  112844. _activate(renderId: number, intermediateRendering: boolean): boolean;
  112845. /** @hidden */
  112846. _postActivate(): void;
  112847. /** @hidden */
  112848. _freeze(): void;
  112849. /** @hidden */
  112850. _unFreeze(): void;
  112851. /**
  112852. * Gets the current world matrix
  112853. * @returns a Matrix
  112854. */
  112855. getWorldMatrix(): Matrix;
  112856. /** @hidden */
  112857. _getWorldMatrixDeterminant(): number;
  112858. /**
  112859. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  112860. */
  112861. get isAnInstance(): boolean;
  112862. /**
  112863. * Gets a boolean indicating if this mesh has instances
  112864. */
  112865. get hasInstances(): boolean;
  112866. /**
  112867. * Gets a boolean indicating if this mesh has thin instances
  112868. */
  112869. get hasThinInstances(): boolean;
  112870. /**
  112871. * Perform relative position change from the point of view of behind the front of the mesh.
  112872. * This is performed taking into account the meshes current rotation, so you do not have to care.
  112873. * Supports definition of mesh facing forward or backward
  112874. * @param amountRight defines the distance on the right axis
  112875. * @param amountUp defines the distance on the up axis
  112876. * @param amountForward defines the distance on the forward axis
  112877. * @returns the current mesh
  112878. */
  112879. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  112880. /**
  112881. * Calculate relative position change from the point of view of behind the front of the mesh.
  112882. * This is performed taking into account the meshes current rotation, so you do not have to care.
  112883. * Supports definition of mesh facing forward or backward
  112884. * @param amountRight defines the distance on the right axis
  112885. * @param amountUp defines the distance on the up axis
  112886. * @param amountForward defines the distance on the forward axis
  112887. * @returns the new displacement vector
  112888. */
  112889. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  112890. /**
  112891. * Perform relative rotation change from the point of view of behind the front of the mesh.
  112892. * Supports definition of mesh facing forward or backward
  112893. * @param flipBack defines the flip
  112894. * @param twirlClockwise defines the twirl
  112895. * @param tiltRight defines the tilt
  112896. * @returns the current mesh
  112897. */
  112898. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  112899. /**
  112900. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  112901. * Supports definition of mesh facing forward or backward.
  112902. * @param flipBack defines the flip
  112903. * @param twirlClockwise defines the twirl
  112904. * @param tiltRight defines the tilt
  112905. * @returns the new rotation vector
  112906. */
  112907. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  112908. /**
  112909. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  112910. * This means the mesh underlying bounding box and sphere are recomputed.
  112911. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  112912. * @returns the current mesh
  112913. */
  112914. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  112915. /** @hidden */
  112916. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  112917. /** @hidden */
  112918. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  112919. /** @hidden */
  112920. _updateBoundingInfo(): AbstractMesh;
  112921. /** @hidden */
  112922. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  112923. /** @hidden */
  112924. protected _afterComputeWorldMatrix(): void;
  112925. /** @hidden */
  112926. get _effectiveMesh(): AbstractMesh;
  112927. /**
  112928. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  112929. * A mesh is in the frustum if its bounding box intersects the frustum
  112930. * @param frustumPlanes defines the frustum to test
  112931. * @returns true if the mesh is in the frustum planes
  112932. */
  112933. isInFrustum(frustumPlanes: Plane[]): boolean;
  112934. /**
  112935. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  112936. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  112937. * @param frustumPlanes defines the frustum to test
  112938. * @returns true if the mesh is completely in the frustum planes
  112939. */
  112940. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  112941. /**
  112942. * True if the mesh intersects another mesh or a SolidParticle object
  112943. * @param mesh defines a target mesh or SolidParticle to test
  112944. * @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)
  112945. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  112946. * @returns true if there is an intersection
  112947. */
  112948. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  112949. /**
  112950. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  112951. * @param point defines the point to test
  112952. * @returns true if there is an intersection
  112953. */
  112954. intersectsPoint(point: Vector3): boolean;
  112955. /**
  112956. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  112957. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112958. */
  112959. get checkCollisions(): boolean;
  112960. set checkCollisions(collisionEnabled: boolean);
  112961. /**
  112962. * Gets Collider object used to compute collisions (not physics)
  112963. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112964. */
  112965. get collider(): Nullable<Collider>;
  112966. /**
  112967. * Move the mesh using collision engine
  112968. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112969. * @param displacement defines the requested displacement vector
  112970. * @returns the current mesh
  112971. */
  112972. moveWithCollisions(displacement: Vector3): AbstractMesh;
  112973. private _onCollisionPositionChange;
  112974. /** @hidden */
  112975. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  112976. /** @hidden */
  112977. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  112978. /** @hidden */
  112979. _checkCollision(collider: Collider): AbstractMesh;
  112980. /** @hidden */
  112981. _generatePointsArray(): boolean;
  112982. /**
  112983. * Checks if the passed Ray intersects with the mesh
  112984. * @param ray defines the ray to use
  112985. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  112986. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  112987. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  112988. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  112989. * @returns the picking info
  112990. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  112991. */
  112992. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  112993. /**
  112994. * Clones the current mesh
  112995. * @param name defines the mesh name
  112996. * @param newParent defines the new mesh parent
  112997. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  112998. * @returns the new mesh
  112999. */
  113000. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  113001. /**
  113002. * Disposes all the submeshes of the current meshnp
  113003. * @returns the current mesh
  113004. */
  113005. releaseSubMeshes(): AbstractMesh;
  113006. /**
  113007. * Releases resources associated with this abstract mesh.
  113008. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  113009. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  113010. */
  113011. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  113012. /**
  113013. * Adds the passed mesh as a child to the current mesh
  113014. * @param mesh defines the child mesh
  113015. * @returns the current mesh
  113016. */
  113017. addChild(mesh: AbstractMesh): AbstractMesh;
  113018. /**
  113019. * Removes the passed mesh from the current mesh children list
  113020. * @param mesh defines the child mesh
  113021. * @returns the current mesh
  113022. */
  113023. removeChild(mesh: AbstractMesh): AbstractMesh;
  113024. /** @hidden */
  113025. private _initFacetData;
  113026. /**
  113027. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  113028. * This method can be called within the render loop.
  113029. * 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
  113030. * @returns the current mesh
  113031. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113032. */
  113033. updateFacetData(): AbstractMesh;
  113034. /**
  113035. * Returns the facetLocalNormals array.
  113036. * The normals are expressed in the mesh local spac
  113037. * @returns an array of Vector3
  113038. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113039. */
  113040. getFacetLocalNormals(): Vector3[];
  113041. /**
  113042. * Returns the facetLocalPositions array.
  113043. * The facet positions are expressed in the mesh local space
  113044. * @returns an array of Vector3
  113045. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113046. */
  113047. getFacetLocalPositions(): Vector3[];
  113048. /**
  113049. * Returns the facetLocalPartioning array
  113050. * @returns an array of array of numbers
  113051. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113052. */
  113053. getFacetLocalPartitioning(): number[][];
  113054. /**
  113055. * Returns the i-th facet position in the world system.
  113056. * This method allocates a new Vector3 per call
  113057. * @param i defines the facet index
  113058. * @returns a new Vector3
  113059. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113060. */
  113061. getFacetPosition(i: number): Vector3;
  113062. /**
  113063. * Sets the reference Vector3 with the i-th facet position in the world system
  113064. * @param i defines the facet index
  113065. * @param ref defines the target vector
  113066. * @returns the current mesh
  113067. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113068. */
  113069. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  113070. /**
  113071. * Returns the i-th facet normal in the world system.
  113072. * This method allocates a new Vector3 per call
  113073. * @param i defines the facet index
  113074. * @returns a new Vector3
  113075. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113076. */
  113077. getFacetNormal(i: number): Vector3;
  113078. /**
  113079. * Sets the reference Vector3 with the i-th facet normal in the world system
  113080. * @param i defines the facet index
  113081. * @param ref defines the target vector
  113082. * @returns the current mesh
  113083. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113084. */
  113085. getFacetNormalToRef(i: number, ref: Vector3): this;
  113086. /**
  113087. * 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)
  113088. * @param x defines x coordinate
  113089. * @param y defines y coordinate
  113090. * @param z defines z coordinate
  113091. * @returns the array of facet indexes
  113092. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113093. */
  113094. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  113095. /**
  113096. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  113097. * @param projected sets as the (x,y,z) world projection on the facet
  113098. * @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
  113099. * @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
  113100. * @param x defines x coordinate
  113101. * @param y defines y coordinate
  113102. * @param z defines z coordinate
  113103. * @returns the face index if found (or null instead)
  113104. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113105. */
  113106. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  113107. /**
  113108. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  113109. * @param projected sets as the (x,y,z) local projection on the facet
  113110. * @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
  113111. * @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
  113112. * @param x defines x coordinate
  113113. * @param y defines y coordinate
  113114. * @param z defines z coordinate
  113115. * @returns the face index if found (or null instead)
  113116. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113117. */
  113118. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  113119. /**
  113120. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  113121. * @returns the parameters
  113122. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113123. */
  113124. getFacetDataParameters(): any;
  113125. /**
  113126. * Disables the feature FacetData and frees the related memory
  113127. * @returns the current mesh
  113128. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  113129. */
  113130. disableFacetData(): AbstractMesh;
  113131. /**
  113132. * Updates the AbstractMesh indices array
  113133. * @param indices defines the data source
  113134. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  113135. * @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)
  113136. * @returns the current mesh
  113137. */
  113138. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  113139. /**
  113140. * Creates new normals data for the mesh
  113141. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  113142. * @returns the current mesh
  113143. */
  113144. createNormals(updatable: boolean): AbstractMesh;
  113145. /**
  113146. * Align the mesh with a normal
  113147. * @param normal defines the normal to use
  113148. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  113149. * @returns the current mesh
  113150. */
  113151. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  113152. /** @hidden */
  113153. _checkOcclusionQuery(): boolean;
  113154. /**
  113155. * Disables the mesh edge rendering mode
  113156. * @returns the currentAbstractMesh
  113157. */
  113158. disableEdgesRendering(): AbstractMesh;
  113159. /**
  113160. * Enables the edge rendering mode on the mesh.
  113161. * This mode makes the mesh edges visible
  113162. * @param epsilon defines the maximal distance between two angles to detect a face
  113163. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  113164. * @returns the currentAbstractMesh
  113165. * @see https://www.babylonjs-playground.com/#19O9TU#0
  113166. */
  113167. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  113168. /**
  113169. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  113170. * @returns an array of particle systems in the scene that use the mesh as an emitter
  113171. */
  113172. getConnectedParticleSystems(): IParticleSystem[];
  113173. }
  113174. }
  113175. declare module BABYLON {
  113176. /**
  113177. * Interface used to define ActionEvent
  113178. */
  113179. export interface IActionEvent {
  113180. /** The mesh or sprite that triggered the action */
  113181. source: any;
  113182. /** The X mouse cursor position at the time of the event */
  113183. pointerX: number;
  113184. /** The Y mouse cursor position at the time of the event */
  113185. pointerY: number;
  113186. /** The mesh that is currently pointed at (can be null) */
  113187. meshUnderPointer: Nullable<AbstractMesh>;
  113188. /** the original (browser) event that triggered the ActionEvent */
  113189. sourceEvent?: any;
  113190. /** additional data for the event */
  113191. additionalData?: any;
  113192. }
  113193. /**
  113194. * ActionEvent is the event being sent when an action is triggered.
  113195. */
  113196. export class ActionEvent implements IActionEvent {
  113197. /** The mesh or sprite that triggered the action */
  113198. source: any;
  113199. /** The X mouse cursor position at the time of the event */
  113200. pointerX: number;
  113201. /** The Y mouse cursor position at the time of the event */
  113202. pointerY: number;
  113203. /** The mesh that is currently pointed at (can be null) */
  113204. meshUnderPointer: Nullable<AbstractMesh>;
  113205. /** the original (browser) event that triggered the ActionEvent */
  113206. sourceEvent?: any;
  113207. /** additional data for the event */
  113208. additionalData?: any;
  113209. /**
  113210. * Creates a new ActionEvent
  113211. * @param source The mesh or sprite that triggered the action
  113212. * @param pointerX The X mouse cursor position at the time of the event
  113213. * @param pointerY The Y mouse cursor position at the time of the event
  113214. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  113215. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  113216. * @param additionalData additional data for the event
  113217. */
  113218. constructor(
  113219. /** The mesh or sprite that triggered the action */
  113220. source: any,
  113221. /** The X mouse cursor position at the time of the event */
  113222. pointerX: number,
  113223. /** The Y mouse cursor position at the time of the event */
  113224. pointerY: number,
  113225. /** The mesh that is currently pointed at (can be null) */
  113226. meshUnderPointer: Nullable<AbstractMesh>,
  113227. /** the original (browser) event that triggered the ActionEvent */
  113228. sourceEvent?: any,
  113229. /** additional data for the event */
  113230. additionalData?: any);
  113231. /**
  113232. * Helper function to auto-create an ActionEvent from a source mesh.
  113233. * @param source The source mesh that triggered the event
  113234. * @param evt The original (browser) event
  113235. * @param additionalData additional data for the event
  113236. * @returns the new ActionEvent
  113237. */
  113238. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  113239. /**
  113240. * Helper function to auto-create an ActionEvent from a source sprite
  113241. * @param source The source sprite that triggered the event
  113242. * @param scene Scene associated with the sprite
  113243. * @param evt The original (browser) event
  113244. * @param additionalData additional data for the event
  113245. * @returns the new ActionEvent
  113246. */
  113247. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  113248. /**
  113249. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  113250. * @param scene the scene where the event occurred
  113251. * @param evt The original (browser) event
  113252. * @returns the new ActionEvent
  113253. */
  113254. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  113255. /**
  113256. * Helper function to auto-create an ActionEvent from a primitive
  113257. * @param prim defines the target primitive
  113258. * @param pointerPos defines the pointer position
  113259. * @param evt The original (browser) event
  113260. * @param additionalData additional data for the event
  113261. * @returns the new ActionEvent
  113262. */
  113263. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  113264. }
  113265. }
  113266. declare module BABYLON {
  113267. /**
  113268. * Abstract class used to decouple action Manager from scene and meshes.
  113269. * Do not instantiate.
  113270. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  113271. */
  113272. export abstract class AbstractActionManager implements IDisposable {
  113273. /** Gets the list of active triggers */
  113274. static Triggers: {
  113275. [key: string]: number;
  113276. };
  113277. /** Gets the cursor to use when hovering items */
  113278. hoverCursor: string;
  113279. /** Gets the list of actions */
  113280. actions: IAction[];
  113281. /**
  113282. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  113283. */
  113284. isRecursive: boolean;
  113285. /**
  113286. * Releases all associated resources
  113287. */
  113288. abstract dispose(): void;
  113289. /**
  113290. * Does this action manager has pointer triggers
  113291. */
  113292. abstract get hasPointerTriggers(): boolean;
  113293. /**
  113294. * Does this action manager has pick triggers
  113295. */
  113296. abstract get hasPickTriggers(): boolean;
  113297. /**
  113298. * Process a specific trigger
  113299. * @param trigger defines the trigger to process
  113300. * @param evt defines the event details to be processed
  113301. */
  113302. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  113303. /**
  113304. * Does this action manager handles actions of any of the given triggers
  113305. * @param triggers defines the triggers to be tested
  113306. * @return a boolean indicating whether one (or more) of the triggers is handled
  113307. */
  113308. abstract hasSpecificTriggers(triggers: number[]): boolean;
  113309. /**
  113310. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  113311. * speed.
  113312. * @param triggerA defines the trigger to be tested
  113313. * @param triggerB defines the trigger to be tested
  113314. * @return a boolean indicating whether one (or more) of the triggers is handled
  113315. */
  113316. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  113317. /**
  113318. * Does this action manager handles actions of a given trigger
  113319. * @param trigger defines the trigger to be tested
  113320. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  113321. * @return whether the trigger is handled
  113322. */
  113323. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  113324. /**
  113325. * Serialize this manager to a JSON object
  113326. * @param name defines the property name to store this manager
  113327. * @returns a JSON representation of this manager
  113328. */
  113329. abstract serialize(name: string): any;
  113330. /**
  113331. * Registers an action to this action manager
  113332. * @param action defines the action to be registered
  113333. * @return the action amended (prepared) after registration
  113334. */
  113335. abstract registerAction(action: IAction): Nullable<IAction>;
  113336. /**
  113337. * Unregisters an action to this action manager
  113338. * @param action defines the action to be unregistered
  113339. * @return a boolean indicating whether the action has been unregistered
  113340. */
  113341. abstract unregisterAction(action: IAction): Boolean;
  113342. /**
  113343. * Does exist one action manager with at least one trigger
  113344. **/
  113345. static get HasTriggers(): boolean;
  113346. /**
  113347. * Does exist one action manager with at least one pick trigger
  113348. **/
  113349. static get HasPickTriggers(): boolean;
  113350. /**
  113351. * Does exist one action manager that handles actions of a given trigger
  113352. * @param trigger defines the trigger to be tested
  113353. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  113354. **/
  113355. static HasSpecificTrigger(trigger: number): boolean;
  113356. }
  113357. }
  113358. declare module BABYLON {
  113359. /**
  113360. * Defines how a node can be built from a string name.
  113361. */
  113362. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  113363. /**
  113364. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  113365. */
  113366. export class Node implements IBehaviorAware<Node> {
  113367. /** @hidden */
  113368. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  113369. private static _NodeConstructors;
  113370. /**
  113371. * Add a new node constructor
  113372. * @param type defines the type name of the node to construct
  113373. * @param constructorFunc defines the constructor function
  113374. */
  113375. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  113376. /**
  113377. * Returns a node constructor based on type name
  113378. * @param type defines the type name
  113379. * @param name defines the new node name
  113380. * @param scene defines the hosting scene
  113381. * @param options defines optional options to transmit to constructors
  113382. * @returns the new constructor or null
  113383. */
  113384. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  113385. /**
  113386. * Gets or sets the name of the node
  113387. */
  113388. name: string;
  113389. /**
  113390. * Gets or sets the id of the node
  113391. */
  113392. id: string;
  113393. /**
  113394. * Gets or sets the unique id of the node
  113395. */
  113396. uniqueId: number;
  113397. /**
  113398. * Gets or sets a string used to store user defined state for the node
  113399. */
  113400. state: string;
  113401. /**
  113402. * Gets or sets an object used to store user defined information for the node
  113403. */
  113404. metadata: any;
  113405. /**
  113406. * For internal use only. Please do not use.
  113407. */
  113408. reservedDataStore: any;
  113409. /**
  113410. * List of inspectable custom properties (used by the Inspector)
  113411. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  113412. */
  113413. inspectableCustomProperties: IInspectable[];
  113414. private _doNotSerialize;
  113415. /**
  113416. * Gets or sets a boolean used to define if the node must be serialized
  113417. */
  113418. get doNotSerialize(): boolean;
  113419. set doNotSerialize(value: boolean);
  113420. /** @hidden */
  113421. _isDisposed: boolean;
  113422. /**
  113423. * Gets a list of Animations associated with the node
  113424. */
  113425. animations: Animation[];
  113426. protected _ranges: {
  113427. [name: string]: Nullable<AnimationRange>;
  113428. };
  113429. /**
  113430. * Callback raised when the node is ready to be used
  113431. */
  113432. onReady: Nullable<(node: Node) => void>;
  113433. private _isEnabled;
  113434. private _isParentEnabled;
  113435. private _isReady;
  113436. /** @hidden */
  113437. _currentRenderId: number;
  113438. private _parentUpdateId;
  113439. /** @hidden */
  113440. _childUpdateId: number;
  113441. /** @hidden */
  113442. _waitingParentId: Nullable<string>;
  113443. /** @hidden */
  113444. _scene: Scene;
  113445. /** @hidden */
  113446. _cache: any;
  113447. private _parentNode;
  113448. private _children;
  113449. /** @hidden */
  113450. _worldMatrix: Matrix;
  113451. /** @hidden */
  113452. _worldMatrixDeterminant: number;
  113453. /** @hidden */
  113454. _worldMatrixDeterminantIsDirty: boolean;
  113455. /** @hidden */
  113456. private _sceneRootNodesIndex;
  113457. /**
  113458. * Gets a boolean indicating if the node has been disposed
  113459. * @returns true if the node was disposed
  113460. */
  113461. isDisposed(): boolean;
  113462. /**
  113463. * Gets or sets the parent of the node (without keeping the current position in the scene)
  113464. * @see https://doc.babylonjs.com/how_to/parenting
  113465. */
  113466. set parent(parent: Nullable<Node>);
  113467. get parent(): Nullable<Node>;
  113468. /** @hidden */
  113469. _addToSceneRootNodes(): void;
  113470. /** @hidden */
  113471. _removeFromSceneRootNodes(): void;
  113472. private _animationPropertiesOverride;
  113473. /**
  113474. * Gets or sets the animation properties override
  113475. */
  113476. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  113477. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  113478. /**
  113479. * Gets a string identifying the name of the class
  113480. * @returns "Node" string
  113481. */
  113482. getClassName(): string;
  113483. /** @hidden */
  113484. readonly _isNode: boolean;
  113485. /**
  113486. * An event triggered when the mesh is disposed
  113487. */
  113488. onDisposeObservable: Observable<Node>;
  113489. private _onDisposeObserver;
  113490. /**
  113491. * Sets a callback that will be raised when the node will be disposed
  113492. */
  113493. set onDispose(callback: () => void);
  113494. /**
  113495. * Creates a new Node
  113496. * @param name the name and id to be given to this node
  113497. * @param scene the scene this node will be added to
  113498. */
  113499. constructor(name: string, scene?: Nullable<Scene>);
  113500. /**
  113501. * Gets the scene of the node
  113502. * @returns a scene
  113503. */
  113504. getScene(): Scene;
  113505. /**
  113506. * Gets the engine of the node
  113507. * @returns a Engine
  113508. */
  113509. getEngine(): Engine;
  113510. private _behaviors;
  113511. /**
  113512. * Attach a behavior to the node
  113513. * @see https://doc.babylonjs.com/features/behaviour
  113514. * @param behavior defines the behavior to attach
  113515. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  113516. * @returns the current Node
  113517. */
  113518. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  113519. /**
  113520. * Remove an attached behavior
  113521. * @see https://doc.babylonjs.com/features/behaviour
  113522. * @param behavior defines the behavior to attach
  113523. * @returns the current Node
  113524. */
  113525. removeBehavior(behavior: Behavior<Node>): Node;
  113526. /**
  113527. * Gets the list of attached behaviors
  113528. * @see https://doc.babylonjs.com/features/behaviour
  113529. */
  113530. get behaviors(): Behavior<Node>[];
  113531. /**
  113532. * Gets an attached behavior by name
  113533. * @param name defines the name of the behavior to look for
  113534. * @see https://doc.babylonjs.com/features/behaviour
  113535. * @returns null if behavior was not found else the requested behavior
  113536. */
  113537. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  113538. /**
  113539. * Returns the latest update of the World matrix
  113540. * @returns a Matrix
  113541. */
  113542. getWorldMatrix(): Matrix;
  113543. /** @hidden */
  113544. _getWorldMatrixDeterminant(): number;
  113545. /**
  113546. * Returns directly the latest state of the mesh World matrix.
  113547. * A Matrix is returned.
  113548. */
  113549. get worldMatrixFromCache(): Matrix;
  113550. /** @hidden */
  113551. _initCache(): void;
  113552. /** @hidden */
  113553. updateCache(force?: boolean): void;
  113554. /** @hidden */
  113555. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  113556. /** @hidden */
  113557. _updateCache(ignoreParentClass?: boolean): void;
  113558. /** @hidden */
  113559. _isSynchronized(): boolean;
  113560. /** @hidden */
  113561. _markSyncedWithParent(): void;
  113562. /** @hidden */
  113563. isSynchronizedWithParent(): boolean;
  113564. /** @hidden */
  113565. isSynchronized(): boolean;
  113566. /**
  113567. * Is this node ready to be used/rendered
  113568. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  113569. * @return true if the node is ready
  113570. */
  113571. isReady(completeCheck?: boolean): boolean;
  113572. /**
  113573. * Is this node enabled?
  113574. * 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
  113575. * @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
  113576. * @return whether this node (and its parent) is enabled
  113577. */
  113578. isEnabled(checkAncestors?: boolean): boolean;
  113579. /** @hidden */
  113580. protected _syncParentEnabledState(): void;
  113581. /**
  113582. * Set the enabled state of this node
  113583. * @param value defines the new enabled state
  113584. */
  113585. setEnabled(value: boolean): void;
  113586. /**
  113587. * Is this node a descendant of the given node?
  113588. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  113589. * @param ancestor defines the parent node to inspect
  113590. * @returns a boolean indicating if this node is a descendant of the given node
  113591. */
  113592. isDescendantOf(ancestor: Node): boolean;
  113593. /** @hidden */
  113594. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  113595. /**
  113596. * Will return all nodes that have this node as ascendant
  113597. * @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
  113598. * @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
  113599. * @return all children nodes of all types
  113600. */
  113601. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  113602. /**
  113603. * Get all child-meshes of this node
  113604. * @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)
  113605. * @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
  113606. * @returns an array of AbstractMesh
  113607. */
  113608. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  113609. /**
  113610. * Get all direct children of this node
  113611. * @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
  113612. * @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)
  113613. * @returns an array of Node
  113614. */
  113615. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  113616. /** @hidden */
  113617. _setReady(state: boolean): void;
  113618. /**
  113619. * Get an animation by name
  113620. * @param name defines the name of the animation to look for
  113621. * @returns null if not found else the requested animation
  113622. */
  113623. getAnimationByName(name: string): Nullable<Animation>;
  113624. /**
  113625. * Creates an animation range for this node
  113626. * @param name defines the name of the range
  113627. * @param from defines the starting key
  113628. * @param to defines the end key
  113629. */
  113630. createAnimationRange(name: string, from: number, to: number): void;
  113631. /**
  113632. * Delete a specific animation range
  113633. * @param name defines the name of the range to delete
  113634. * @param deleteFrames defines if animation frames from the range must be deleted as well
  113635. */
  113636. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  113637. /**
  113638. * Get an animation range by name
  113639. * @param name defines the name of the animation range to look for
  113640. * @returns null if not found else the requested animation range
  113641. */
  113642. getAnimationRange(name: string): Nullable<AnimationRange>;
  113643. /**
  113644. * Gets the list of all animation ranges defined on this node
  113645. * @returns an array
  113646. */
  113647. getAnimationRanges(): Nullable<AnimationRange>[];
  113648. /**
  113649. * Will start the animation sequence
  113650. * @param name defines the range frames for animation sequence
  113651. * @param loop defines if the animation should loop (false by default)
  113652. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  113653. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  113654. * @returns the object created for this animation. If range does not exist, it will return null
  113655. */
  113656. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  113657. /**
  113658. * Serialize animation ranges into a JSON compatible object
  113659. * @returns serialization object
  113660. */
  113661. serializeAnimationRanges(): any;
  113662. /**
  113663. * Computes the world matrix of the node
  113664. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  113665. * @returns the world matrix
  113666. */
  113667. computeWorldMatrix(force?: boolean): Matrix;
  113668. /**
  113669. * Releases resources associated with this node.
  113670. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  113671. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  113672. */
  113673. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  113674. /**
  113675. * Parse animation range data from a serialization object and store them into a given node
  113676. * @param node defines where to store the animation ranges
  113677. * @param parsedNode defines the serialization object to read data from
  113678. * @param scene defines the hosting scene
  113679. */
  113680. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  113681. /**
  113682. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  113683. * @param includeDescendants Include bounding info from descendants as well (true by default)
  113684. * @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
  113685. * @returns the new bounding vectors
  113686. */
  113687. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  113688. min: Vector3;
  113689. max: Vector3;
  113690. };
  113691. }
  113692. }
  113693. declare module BABYLON {
  113694. /**
  113695. * @hidden
  113696. */
  113697. export class _IAnimationState {
  113698. key: number;
  113699. repeatCount: number;
  113700. workValue?: any;
  113701. loopMode?: number;
  113702. offsetValue?: any;
  113703. highLimitValue?: any;
  113704. }
  113705. /**
  113706. * Class used to store any kind of animation
  113707. */
  113708. export class Animation {
  113709. /**Name of the animation */
  113710. name: string;
  113711. /**Property to animate */
  113712. targetProperty: string;
  113713. /**The frames per second of the animation */
  113714. framePerSecond: number;
  113715. /**The data type of the animation */
  113716. dataType: number;
  113717. /**The loop mode of the animation */
  113718. loopMode?: number | undefined;
  113719. /**Specifies if blending should be enabled */
  113720. enableBlending?: boolean | undefined;
  113721. /**
  113722. * Use matrix interpolation instead of using direct key value when animating matrices
  113723. */
  113724. static AllowMatricesInterpolation: boolean;
  113725. /**
  113726. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  113727. */
  113728. static AllowMatrixDecomposeForInterpolation: boolean;
  113729. /** Define the Url to load snippets */
  113730. static SnippetUrl: string;
  113731. /** Snippet ID if the animation was created from the snippet server */
  113732. snippetId: string;
  113733. /**
  113734. * Stores the key frames of the animation
  113735. */
  113736. private _keys;
  113737. /**
  113738. * Stores the easing function of the animation
  113739. */
  113740. private _easingFunction;
  113741. /**
  113742. * @hidden Internal use only
  113743. */
  113744. _runtimeAnimations: RuntimeAnimation[];
  113745. /**
  113746. * The set of event that will be linked to this animation
  113747. */
  113748. private _events;
  113749. /**
  113750. * Stores an array of target property paths
  113751. */
  113752. targetPropertyPath: string[];
  113753. /**
  113754. * Stores the blending speed of the animation
  113755. */
  113756. blendingSpeed: number;
  113757. /**
  113758. * Stores the animation ranges for the animation
  113759. */
  113760. private _ranges;
  113761. /**
  113762. * @hidden Internal use
  113763. */
  113764. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  113765. /**
  113766. * Sets up an animation
  113767. * @param property The property to animate
  113768. * @param animationType The animation type to apply
  113769. * @param framePerSecond The frames per second of the animation
  113770. * @param easingFunction The easing function used in the animation
  113771. * @returns The created animation
  113772. */
  113773. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  113774. /**
  113775. * Create and start an animation on a node
  113776. * @param name defines the name of the global animation that will be run on all nodes
  113777. * @param node defines the root node where the animation will take place
  113778. * @param targetProperty defines property to animate
  113779. * @param framePerSecond defines the number of frame per second yo use
  113780. * @param totalFrame defines the number of frames in total
  113781. * @param from defines the initial value
  113782. * @param to defines the final value
  113783. * @param loopMode defines which loop mode you want to use (off by default)
  113784. * @param easingFunction defines the easing function to use (linear by default)
  113785. * @param onAnimationEnd defines the callback to call when animation end
  113786. * @returns the animatable created for this animation
  113787. */
  113788. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  113789. /**
  113790. * Create and start an animation on a node and its descendants
  113791. * @param name defines the name of the global animation that will be run on all nodes
  113792. * @param node defines the root node where the animation will take place
  113793. * @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
  113794. * @param targetProperty defines property to animate
  113795. * @param framePerSecond defines the number of frame per second to use
  113796. * @param totalFrame defines the number of frames in total
  113797. * @param from defines the initial value
  113798. * @param to defines the final value
  113799. * @param loopMode defines which loop mode you want to use (off by default)
  113800. * @param easingFunction defines the easing function to use (linear by default)
  113801. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  113802. * @returns the list of animatables created for all nodes
  113803. * @example https://www.babylonjs-playground.com/#MH0VLI
  113804. */
  113805. 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[]>;
  113806. /**
  113807. * Creates a new animation, merges it with the existing animations and starts it
  113808. * @param name Name of the animation
  113809. * @param node Node which contains the scene that begins the animations
  113810. * @param targetProperty Specifies which property to animate
  113811. * @param framePerSecond The frames per second of the animation
  113812. * @param totalFrame The total number of frames
  113813. * @param from The frame at the beginning of the animation
  113814. * @param to The frame at the end of the animation
  113815. * @param loopMode Specifies the loop mode of the animation
  113816. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  113817. * @param onAnimationEnd Callback to run once the animation is complete
  113818. * @returns Nullable animation
  113819. */
  113820. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  113821. /**
  113822. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  113823. * @param sourceAnimation defines the Animation containing keyframes to convert
  113824. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  113825. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  113826. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  113827. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  113828. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  113829. */
  113830. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  113831. /**
  113832. * Transition property of an host to the target Value
  113833. * @param property The property to transition
  113834. * @param targetValue The target Value of the property
  113835. * @param host The object where the property to animate belongs
  113836. * @param scene Scene used to run the animation
  113837. * @param frameRate Framerate (in frame/s) to use
  113838. * @param transition The transition type we want to use
  113839. * @param duration The duration of the animation, in milliseconds
  113840. * @param onAnimationEnd Callback trigger at the end of the animation
  113841. * @returns Nullable animation
  113842. */
  113843. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  113844. /**
  113845. * Return the array of runtime animations currently using this animation
  113846. */
  113847. get runtimeAnimations(): RuntimeAnimation[];
  113848. /**
  113849. * Specifies if any of the runtime animations are currently running
  113850. */
  113851. get hasRunningRuntimeAnimations(): boolean;
  113852. /**
  113853. * Initializes the animation
  113854. * @param name Name of the animation
  113855. * @param targetProperty Property to animate
  113856. * @param framePerSecond The frames per second of the animation
  113857. * @param dataType The data type of the animation
  113858. * @param loopMode The loop mode of the animation
  113859. * @param enableBlending Specifies if blending should be enabled
  113860. */
  113861. constructor(
  113862. /**Name of the animation */
  113863. name: string,
  113864. /**Property to animate */
  113865. targetProperty: string,
  113866. /**The frames per second of the animation */
  113867. framePerSecond: number,
  113868. /**The data type of the animation */
  113869. dataType: number,
  113870. /**The loop mode of the animation */
  113871. loopMode?: number | undefined,
  113872. /**Specifies if blending should be enabled */
  113873. enableBlending?: boolean | undefined);
  113874. /**
  113875. * Converts the animation to a string
  113876. * @param fullDetails support for multiple levels of logging within scene loading
  113877. * @returns String form of the animation
  113878. */
  113879. toString(fullDetails?: boolean): string;
  113880. /**
  113881. * Add an event to this animation
  113882. * @param event Event to add
  113883. */
  113884. addEvent(event: AnimationEvent): void;
  113885. /**
  113886. * Remove all events found at the given frame
  113887. * @param frame The frame to remove events from
  113888. */
  113889. removeEvents(frame: number): void;
  113890. /**
  113891. * Retrieves all the events from the animation
  113892. * @returns Events from the animation
  113893. */
  113894. getEvents(): AnimationEvent[];
  113895. /**
  113896. * Creates an animation range
  113897. * @param name Name of the animation range
  113898. * @param from Starting frame of the animation range
  113899. * @param to Ending frame of the animation
  113900. */
  113901. createRange(name: string, from: number, to: number): void;
  113902. /**
  113903. * Deletes an animation range by name
  113904. * @param name Name of the animation range to delete
  113905. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  113906. */
  113907. deleteRange(name: string, deleteFrames?: boolean): void;
  113908. /**
  113909. * Gets the animation range by name, or null if not defined
  113910. * @param name Name of the animation range
  113911. * @returns Nullable animation range
  113912. */
  113913. getRange(name: string): Nullable<AnimationRange>;
  113914. /**
  113915. * Gets the key frames from the animation
  113916. * @returns The key frames of the animation
  113917. */
  113918. getKeys(): Array<IAnimationKey>;
  113919. /**
  113920. * Gets the highest frame rate of the animation
  113921. * @returns Highest frame rate of the animation
  113922. */
  113923. getHighestFrame(): number;
  113924. /**
  113925. * Gets the easing function of the animation
  113926. * @returns Easing function of the animation
  113927. */
  113928. getEasingFunction(): IEasingFunction;
  113929. /**
  113930. * Sets the easing function of the animation
  113931. * @param easingFunction A custom mathematical formula for animation
  113932. */
  113933. setEasingFunction(easingFunction: EasingFunction): void;
  113934. /**
  113935. * Interpolates a scalar linearly
  113936. * @param startValue Start value of the animation curve
  113937. * @param endValue End value of the animation curve
  113938. * @param gradient Scalar amount to interpolate
  113939. * @returns Interpolated scalar value
  113940. */
  113941. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  113942. /**
  113943. * Interpolates a scalar cubically
  113944. * @param startValue Start value of the animation curve
  113945. * @param outTangent End tangent of the animation
  113946. * @param endValue End value of the animation curve
  113947. * @param inTangent Start tangent of the animation curve
  113948. * @param gradient Scalar amount to interpolate
  113949. * @returns Interpolated scalar value
  113950. */
  113951. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  113952. /**
  113953. * Interpolates a quaternion using a spherical linear interpolation
  113954. * @param startValue Start value of the animation curve
  113955. * @param endValue End value of the animation curve
  113956. * @param gradient Scalar amount to interpolate
  113957. * @returns Interpolated quaternion value
  113958. */
  113959. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  113960. /**
  113961. * Interpolates a quaternion cubically
  113962. * @param startValue Start value of the animation curve
  113963. * @param outTangent End tangent of the animation curve
  113964. * @param endValue End value of the animation curve
  113965. * @param inTangent Start tangent of the animation curve
  113966. * @param gradient Scalar amount to interpolate
  113967. * @returns Interpolated quaternion value
  113968. */
  113969. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  113970. /**
  113971. * Interpolates a Vector3 linearl
  113972. * @param startValue Start value of the animation curve
  113973. * @param endValue End value of the animation curve
  113974. * @param gradient Scalar amount to interpolate
  113975. * @returns Interpolated scalar value
  113976. */
  113977. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  113978. /**
  113979. * Interpolates a Vector3 cubically
  113980. * @param startValue Start value of the animation curve
  113981. * @param outTangent End tangent of the animation
  113982. * @param endValue End value of the animation curve
  113983. * @param inTangent Start tangent of the animation curve
  113984. * @param gradient Scalar amount to interpolate
  113985. * @returns InterpolatedVector3 value
  113986. */
  113987. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  113988. /**
  113989. * Interpolates a Vector2 linearly
  113990. * @param startValue Start value of the animation curve
  113991. * @param endValue End value of the animation curve
  113992. * @param gradient Scalar amount to interpolate
  113993. * @returns Interpolated Vector2 value
  113994. */
  113995. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  113996. /**
  113997. * Interpolates a Vector2 cubically
  113998. * @param startValue Start value of the animation curve
  113999. * @param outTangent End tangent of the animation
  114000. * @param endValue End value of the animation curve
  114001. * @param inTangent Start tangent of the animation curve
  114002. * @param gradient Scalar amount to interpolate
  114003. * @returns Interpolated Vector2 value
  114004. */
  114005. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  114006. /**
  114007. * Interpolates a size linearly
  114008. * @param startValue Start value of the animation curve
  114009. * @param endValue End value of the animation curve
  114010. * @param gradient Scalar amount to interpolate
  114011. * @returns Interpolated Size value
  114012. */
  114013. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  114014. /**
  114015. * Interpolates a Color3 linearly
  114016. * @param startValue Start value of the animation curve
  114017. * @param endValue End value of the animation curve
  114018. * @param gradient Scalar amount to interpolate
  114019. * @returns Interpolated Color3 value
  114020. */
  114021. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  114022. /**
  114023. * Interpolates a Color4 linearly
  114024. * @param startValue Start value of the animation curve
  114025. * @param endValue End value of the animation curve
  114026. * @param gradient Scalar amount to interpolate
  114027. * @returns Interpolated Color3 value
  114028. */
  114029. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  114030. /**
  114031. * @hidden Internal use only
  114032. */
  114033. _getKeyValue(value: any): any;
  114034. /**
  114035. * @hidden Internal use only
  114036. */
  114037. _interpolate(currentFrame: number, state: _IAnimationState): any;
  114038. /**
  114039. * Defines the function to use to interpolate matrices
  114040. * @param startValue defines the start matrix
  114041. * @param endValue defines the end matrix
  114042. * @param gradient defines the gradient between both matrices
  114043. * @param result defines an optional target matrix where to store the interpolation
  114044. * @returns the interpolated matrix
  114045. */
  114046. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  114047. /**
  114048. * Makes a copy of the animation
  114049. * @returns Cloned animation
  114050. */
  114051. clone(): Animation;
  114052. /**
  114053. * Sets the key frames of the animation
  114054. * @param values The animation key frames to set
  114055. */
  114056. setKeys(values: Array<IAnimationKey>): void;
  114057. /**
  114058. * Serializes the animation to an object
  114059. * @returns Serialized object
  114060. */
  114061. serialize(): any;
  114062. /**
  114063. * Float animation type
  114064. */
  114065. static readonly ANIMATIONTYPE_FLOAT: number;
  114066. /**
  114067. * Vector3 animation type
  114068. */
  114069. static readonly ANIMATIONTYPE_VECTOR3: number;
  114070. /**
  114071. * Quaternion animation type
  114072. */
  114073. static readonly ANIMATIONTYPE_QUATERNION: number;
  114074. /**
  114075. * Matrix animation type
  114076. */
  114077. static readonly ANIMATIONTYPE_MATRIX: number;
  114078. /**
  114079. * Color3 animation type
  114080. */
  114081. static readonly ANIMATIONTYPE_COLOR3: number;
  114082. /**
  114083. * Color3 animation type
  114084. */
  114085. static readonly ANIMATIONTYPE_COLOR4: number;
  114086. /**
  114087. * Vector2 animation type
  114088. */
  114089. static readonly ANIMATIONTYPE_VECTOR2: number;
  114090. /**
  114091. * Size animation type
  114092. */
  114093. static readonly ANIMATIONTYPE_SIZE: number;
  114094. /**
  114095. * Relative Loop Mode
  114096. */
  114097. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  114098. /**
  114099. * Cycle Loop Mode
  114100. */
  114101. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  114102. /**
  114103. * Constant Loop Mode
  114104. */
  114105. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  114106. /** @hidden */
  114107. static _UniversalLerp(left: any, right: any, amount: number): any;
  114108. /**
  114109. * Parses an animation object and creates an animation
  114110. * @param parsedAnimation Parsed animation object
  114111. * @returns Animation object
  114112. */
  114113. static Parse(parsedAnimation: any): Animation;
  114114. /**
  114115. * Appends the serialized animations from the source animations
  114116. * @param source Source containing the animations
  114117. * @param destination Target to store the animations
  114118. */
  114119. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  114120. /**
  114121. * Creates a new animation or an array of animations from a snippet saved in a remote file
  114122. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  114123. * @param url defines the url to load from
  114124. * @returns a promise that will resolve to the new animation or an array of animations
  114125. */
  114126. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  114127. /**
  114128. * Creates an animation or an array of animations from a snippet saved by the Inspector
  114129. * @param snippetId defines the snippet to load
  114130. * @returns a promise that will resolve to the new animation or a new array of animations
  114131. */
  114132. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  114133. }
  114134. }
  114135. declare module BABYLON {
  114136. /**
  114137. * Interface containing an array of animations
  114138. */
  114139. export interface IAnimatable {
  114140. /**
  114141. * Array of animations
  114142. */
  114143. animations: Nullable<Array<Animation>>;
  114144. }
  114145. }
  114146. declare module BABYLON {
  114147. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  114148. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114149. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114150. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114151. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114152. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114153. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114154. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114155. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114156. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114157. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114158. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114159. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114160. /**
  114161. * Decorator used to define property that can be serialized as reference to a camera
  114162. * @param sourceName defines the name of the property to decorate
  114163. */
  114164. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  114165. /**
  114166. * Class used to help serialization objects
  114167. */
  114168. export class SerializationHelper {
  114169. /** @hidden */
  114170. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  114171. /** @hidden */
  114172. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  114173. /** @hidden */
  114174. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  114175. /** @hidden */
  114176. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  114177. /**
  114178. * Appends the serialized animations from the source animations
  114179. * @param source Source containing the animations
  114180. * @param destination Target to store the animations
  114181. */
  114182. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  114183. /**
  114184. * Static function used to serialized a specific entity
  114185. * @param entity defines the entity to serialize
  114186. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  114187. * @returns a JSON compatible object representing the serialization of the entity
  114188. */
  114189. static Serialize<T>(entity: T, serializationObject?: any): any;
  114190. /**
  114191. * Creates a new entity from a serialization data object
  114192. * @param creationFunction defines a function used to instanciated the new entity
  114193. * @param source defines the source serialization data
  114194. * @param scene defines the hosting scene
  114195. * @param rootUrl defines the root url for resources
  114196. * @returns a new entity
  114197. */
  114198. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  114199. /**
  114200. * Clones an object
  114201. * @param creationFunction defines the function used to instanciate the new object
  114202. * @param source defines the source object
  114203. * @returns the cloned object
  114204. */
  114205. static Clone<T>(creationFunction: () => T, source: T): T;
  114206. /**
  114207. * Instanciates a new object based on a source one (some data will be shared between both object)
  114208. * @param creationFunction defines the function used to instanciate the new object
  114209. * @param source defines the source object
  114210. * @returns the new object
  114211. */
  114212. static Instanciate<T>(creationFunction: () => T, source: T): T;
  114213. }
  114214. }
  114215. declare module BABYLON {
  114216. /**
  114217. * Base class of all the textures in babylon.
  114218. * It groups all the common properties the materials, post process, lights... might need
  114219. * in order to make a correct use of the texture.
  114220. */
  114221. export class BaseTexture implements IAnimatable {
  114222. /**
  114223. * Default anisotropic filtering level for the application.
  114224. * It is set to 4 as a good tradeoff between perf and quality.
  114225. */
  114226. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  114227. /**
  114228. * Gets or sets the unique id of the texture
  114229. */
  114230. uniqueId: number;
  114231. /**
  114232. * Define the name of the texture.
  114233. */
  114234. name: string;
  114235. /**
  114236. * Gets or sets an object used to store user defined information.
  114237. */
  114238. metadata: any;
  114239. /**
  114240. * For internal use only. Please do not use.
  114241. */
  114242. reservedDataStore: any;
  114243. private _hasAlpha;
  114244. /**
  114245. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  114246. */
  114247. set hasAlpha(value: boolean);
  114248. get hasAlpha(): boolean;
  114249. /**
  114250. * Defines if the alpha value should be determined via the rgb values.
  114251. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  114252. */
  114253. getAlphaFromRGB: boolean;
  114254. /**
  114255. * Intensity or strength of the texture.
  114256. * It is commonly used by materials to fine tune the intensity of the texture
  114257. */
  114258. level: number;
  114259. /**
  114260. * Define the UV chanel to use starting from 0 and defaulting to 0.
  114261. * This is part of the texture as textures usually maps to one uv set.
  114262. */
  114263. coordinatesIndex: number;
  114264. protected _coordinatesMode: number;
  114265. /**
  114266. * How a texture is mapped.
  114267. *
  114268. * | Value | Type | Description |
  114269. * | ----- | ----------------------------------- | ----------- |
  114270. * | 0 | EXPLICIT_MODE | |
  114271. * | 1 | SPHERICAL_MODE | |
  114272. * | 2 | PLANAR_MODE | |
  114273. * | 3 | CUBIC_MODE | |
  114274. * | 4 | PROJECTION_MODE | |
  114275. * | 5 | SKYBOX_MODE | |
  114276. * | 6 | INVCUBIC_MODE | |
  114277. * | 7 | EQUIRECTANGULAR_MODE | |
  114278. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  114279. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  114280. */
  114281. set coordinatesMode(value: number);
  114282. get coordinatesMode(): number;
  114283. private _wrapU;
  114284. /**
  114285. * | Value | Type | Description |
  114286. * | ----- | ------------------ | ----------- |
  114287. * | 0 | CLAMP_ADDRESSMODE | |
  114288. * | 1 | WRAP_ADDRESSMODE | |
  114289. * | 2 | MIRROR_ADDRESSMODE | |
  114290. */
  114291. get wrapU(): number;
  114292. set wrapU(value: number);
  114293. private _wrapV;
  114294. /**
  114295. * | Value | Type | Description |
  114296. * | ----- | ------------------ | ----------- |
  114297. * | 0 | CLAMP_ADDRESSMODE | |
  114298. * | 1 | WRAP_ADDRESSMODE | |
  114299. * | 2 | MIRROR_ADDRESSMODE | |
  114300. */
  114301. get wrapV(): number;
  114302. set wrapV(value: number);
  114303. /**
  114304. * | Value | Type | Description |
  114305. * | ----- | ------------------ | ----------- |
  114306. * | 0 | CLAMP_ADDRESSMODE | |
  114307. * | 1 | WRAP_ADDRESSMODE | |
  114308. * | 2 | MIRROR_ADDRESSMODE | |
  114309. */
  114310. wrapR: number;
  114311. /**
  114312. * With compliant hardware and browser (supporting anisotropic filtering)
  114313. * this defines the level of anisotropic filtering in the texture.
  114314. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  114315. */
  114316. anisotropicFilteringLevel: number;
  114317. /**
  114318. * Define if the texture is a cube texture or if false a 2d texture.
  114319. */
  114320. get isCube(): boolean;
  114321. set isCube(value: boolean);
  114322. /**
  114323. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  114324. */
  114325. get is3D(): boolean;
  114326. set is3D(value: boolean);
  114327. /**
  114328. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  114329. */
  114330. get is2DArray(): boolean;
  114331. set is2DArray(value: boolean);
  114332. private _gammaSpace;
  114333. /**
  114334. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  114335. * HDR texture are usually stored in linear space.
  114336. * This only impacts the PBR and Background materials
  114337. */
  114338. get gammaSpace(): boolean;
  114339. set gammaSpace(gamma: boolean);
  114340. /**
  114341. * Gets or sets whether or not the texture contains RGBD data.
  114342. */
  114343. get isRGBD(): boolean;
  114344. set isRGBD(value: boolean);
  114345. /**
  114346. * Is Z inverted in the texture (useful in a cube texture).
  114347. */
  114348. invertZ: boolean;
  114349. /**
  114350. * Are mip maps generated for this texture or not.
  114351. */
  114352. get noMipmap(): boolean;
  114353. /**
  114354. * @hidden
  114355. */
  114356. lodLevelInAlpha: boolean;
  114357. /**
  114358. * With prefiltered texture, defined the offset used during the prefiltering steps.
  114359. */
  114360. get lodGenerationOffset(): number;
  114361. set lodGenerationOffset(value: number);
  114362. /**
  114363. * With prefiltered texture, defined the scale used during the prefiltering steps.
  114364. */
  114365. get lodGenerationScale(): number;
  114366. set lodGenerationScale(value: number);
  114367. /**
  114368. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  114369. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  114370. * average roughness values.
  114371. */
  114372. get linearSpecularLOD(): boolean;
  114373. set linearSpecularLOD(value: boolean);
  114374. /**
  114375. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  114376. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  114377. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  114378. */
  114379. get irradianceTexture(): Nullable<BaseTexture>;
  114380. set irradianceTexture(value: Nullable<BaseTexture>);
  114381. /**
  114382. * Define if the texture is a render target.
  114383. */
  114384. isRenderTarget: boolean;
  114385. /**
  114386. * Define the unique id of the texture in the scene.
  114387. */
  114388. get uid(): string;
  114389. /** @hidden */
  114390. _prefiltered: boolean;
  114391. /**
  114392. * Return a string representation of the texture.
  114393. * @returns the texture as a string
  114394. */
  114395. toString(): string;
  114396. /**
  114397. * Get the class name of the texture.
  114398. * @returns "BaseTexture"
  114399. */
  114400. getClassName(): string;
  114401. /**
  114402. * Define the list of animation attached to the texture.
  114403. */
  114404. animations: Animation[];
  114405. /**
  114406. * An event triggered when the texture is disposed.
  114407. */
  114408. onDisposeObservable: Observable<BaseTexture>;
  114409. private _onDisposeObserver;
  114410. /**
  114411. * Callback triggered when the texture has been disposed.
  114412. * Kept for back compatibility, you can use the onDisposeObservable instead.
  114413. */
  114414. set onDispose(callback: () => void);
  114415. /**
  114416. * Define the current state of the loading sequence when in delayed load mode.
  114417. */
  114418. delayLoadState: number;
  114419. protected _scene: Nullable<Scene>;
  114420. protected _engine: Nullable<ThinEngine>;
  114421. /** @hidden */
  114422. _texture: Nullable<InternalTexture>;
  114423. private _uid;
  114424. /**
  114425. * Define if the texture is preventinga material to render or not.
  114426. * If not and the texture is not ready, the engine will use a default black texture instead.
  114427. */
  114428. get isBlocking(): boolean;
  114429. /**
  114430. * Instantiates a new BaseTexture.
  114431. * Base class of all the textures in babylon.
  114432. * It groups all the common properties the materials, post process, lights... might need
  114433. * in order to make a correct use of the texture.
  114434. * @param sceneOrEngine Define the scene or engine the texture blongs to
  114435. */
  114436. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  114437. /**
  114438. * Get the scene the texture belongs to.
  114439. * @returns the scene or null if undefined
  114440. */
  114441. getScene(): Nullable<Scene>;
  114442. /** @hidden */
  114443. protected _getEngine(): Nullable<ThinEngine>;
  114444. /**
  114445. * Get the texture transform matrix used to offset tile the texture for istance.
  114446. * @returns the transformation matrix
  114447. */
  114448. getTextureMatrix(): Matrix;
  114449. /**
  114450. * Get the texture reflection matrix used to rotate/transform the reflection.
  114451. * @returns the reflection matrix
  114452. */
  114453. getReflectionTextureMatrix(): Matrix;
  114454. /**
  114455. * Get the underlying lower level texture from Babylon.
  114456. * @returns the insternal texture
  114457. */
  114458. getInternalTexture(): Nullable<InternalTexture>;
  114459. /**
  114460. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  114461. * @returns true if ready or not blocking
  114462. */
  114463. isReadyOrNotBlocking(): boolean;
  114464. /**
  114465. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  114466. * @returns true if fully ready
  114467. */
  114468. isReady(): boolean;
  114469. private _cachedSize;
  114470. /**
  114471. * Get the size of the texture.
  114472. * @returns the texture size.
  114473. */
  114474. getSize(): ISize;
  114475. /**
  114476. * Get the base size of the texture.
  114477. * It can be different from the size if the texture has been resized for POT for instance
  114478. * @returns the base size
  114479. */
  114480. getBaseSize(): ISize;
  114481. /**
  114482. * Update the sampling mode of the texture.
  114483. * Default is Trilinear mode.
  114484. *
  114485. * | Value | Type | Description |
  114486. * | ----- | ------------------ | ----------- |
  114487. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  114488. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  114489. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  114490. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  114491. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  114492. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  114493. * | 7 | NEAREST_LINEAR | |
  114494. * | 8 | NEAREST_NEAREST | |
  114495. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  114496. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  114497. * | 11 | LINEAR_LINEAR | |
  114498. * | 12 | LINEAR_NEAREST | |
  114499. *
  114500. * > _mag_: magnification filter (close to the viewer)
  114501. * > _min_: minification filter (far from the viewer)
  114502. * > _mip_: filter used between mip map levels
  114503. *@param samplingMode Define the new sampling mode of the texture
  114504. */
  114505. updateSamplingMode(samplingMode: number): void;
  114506. /**
  114507. * Scales the texture if is `canRescale()`
  114508. * @param ratio the resize factor we want to use to rescale
  114509. */
  114510. scale(ratio: number): void;
  114511. /**
  114512. * Get if the texture can rescale.
  114513. */
  114514. get canRescale(): boolean;
  114515. /** @hidden */
  114516. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  114517. /** @hidden */
  114518. _rebuild(): void;
  114519. /**
  114520. * Triggers the load sequence in delayed load mode.
  114521. */
  114522. delayLoad(): void;
  114523. /**
  114524. * Clones the texture.
  114525. * @returns the cloned texture
  114526. */
  114527. clone(): Nullable<BaseTexture>;
  114528. /**
  114529. * Get the texture underlying type (INT, FLOAT...)
  114530. */
  114531. get textureType(): number;
  114532. /**
  114533. * Get the texture underlying format (RGB, RGBA...)
  114534. */
  114535. get textureFormat(): number;
  114536. /**
  114537. * Indicates that textures need to be re-calculated for all materials
  114538. */
  114539. protected _markAllSubMeshesAsTexturesDirty(): void;
  114540. /**
  114541. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  114542. * This will returns an RGBA array buffer containing either in values (0-255) or
  114543. * float values (0-1) depending of the underlying buffer type.
  114544. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  114545. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  114546. * @param buffer defines a user defined buffer to fill with data (can be null)
  114547. * @returns The Array buffer containing the pixels data.
  114548. */
  114549. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  114550. /**
  114551. * Release and destroy the underlying lower level texture aka internalTexture.
  114552. */
  114553. releaseInternalTexture(): void;
  114554. /** @hidden */
  114555. get _lodTextureHigh(): Nullable<BaseTexture>;
  114556. /** @hidden */
  114557. get _lodTextureMid(): Nullable<BaseTexture>;
  114558. /** @hidden */
  114559. get _lodTextureLow(): Nullable<BaseTexture>;
  114560. /**
  114561. * Dispose the texture and release its associated resources.
  114562. */
  114563. dispose(): void;
  114564. /**
  114565. * Serialize the texture into a JSON representation that can be parsed later on.
  114566. * @returns the JSON representation of the texture
  114567. */
  114568. serialize(): any;
  114569. /**
  114570. * Helper function to be called back once a list of texture contains only ready textures.
  114571. * @param textures Define the list of textures to wait for
  114572. * @param callback Define the callback triggered once the entire list will be ready
  114573. */
  114574. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  114575. private static _isScene;
  114576. }
  114577. }
  114578. declare module BABYLON {
  114579. /**
  114580. * Options to be used when creating an effect.
  114581. */
  114582. export interface IEffectCreationOptions {
  114583. /**
  114584. * Atrributes that will be used in the shader.
  114585. */
  114586. attributes: string[];
  114587. /**
  114588. * Uniform varible names that will be set in the shader.
  114589. */
  114590. uniformsNames: string[];
  114591. /**
  114592. * Uniform buffer variable names that will be set in the shader.
  114593. */
  114594. uniformBuffersNames: string[];
  114595. /**
  114596. * Sampler texture variable names that will be set in the shader.
  114597. */
  114598. samplers: string[];
  114599. /**
  114600. * Define statements that will be set in the shader.
  114601. */
  114602. defines: any;
  114603. /**
  114604. * Possible fallbacks for this effect to improve performance when needed.
  114605. */
  114606. fallbacks: Nullable<IEffectFallbacks>;
  114607. /**
  114608. * Callback that will be called when the shader is compiled.
  114609. */
  114610. onCompiled: Nullable<(effect: Effect) => void>;
  114611. /**
  114612. * Callback that will be called if an error occurs during shader compilation.
  114613. */
  114614. onError: Nullable<(effect: Effect, errors: string) => void>;
  114615. /**
  114616. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  114617. */
  114618. indexParameters?: any;
  114619. /**
  114620. * Max number of lights that can be used in the shader.
  114621. */
  114622. maxSimultaneousLights?: number;
  114623. /**
  114624. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  114625. */
  114626. transformFeedbackVaryings?: Nullable<string[]>;
  114627. /**
  114628. * 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
  114629. */
  114630. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  114631. /**
  114632. * Is this effect rendering to several color attachments ?
  114633. */
  114634. multiTarget?: boolean;
  114635. }
  114636. /**
  114637. * Effect containing vertex and fragment shader that can be executed on an object.
  114638. */
  114639. export class Effect implements IDisposable {
  114640. /**
  114641. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  114642. */
  114643. static ShadersRepository: string;
  114644. /**
  114645. * Enable logging of the shader code when a compilation error occurs
  114646. */
  114647. static LogShaderCodeOnCompilationError: boolean;
  114648. /**
  114649. * Name of the effect.
  114650. */
  114651. name: any;
  114652. /**
  114653. * String container all the define statements that should be set on the shader.
  114654. */
  114655. defines: string;
  114656. /**
  114657. * Callback that will be called when the shader is compiled.
  114658. */
  114659. onCompiled: Nullable<(effect: Effect) => void>;
  114660. /**
  114661. * Callback that will be called if an error occurs during shader compilation.
  114662. */
  114663. onError: Nullable<(effect: Effect, errors: string) => void>;
  114664. /**
  114665. * Callback that will be called when effect is bound.
  114666. */
  114667. onBind: Nullable<(effect: Effect) => void>;
  114668. /**
  114669. * Unique ID of the effect.
  114670. */
  114671. uniqueId: number;
  114672. /**
  114673. * Observable that will be called when the shader is compiled.
  114674. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  114675. */
  114676. onCompileObservable: Observable<Effect>;
  114677. /**
  114678. * Observable that will be called if an error occurs during shader compilation.
  114679. */
  114680. onErrorObservable: Observable<Effect>;
  114681. /** @hidden */
  114682. _onBindObservable: Nullable<Observable<Effect>>;
  114683. /**
  114684. * @hidden
  114685. * Specifies if the effect was previously ready
  114686. */
  114687. _wasPreviouslyReady: boolean;
  114688. /**
  114689. * Observable that will be called when effect is bound.
  114690. */
  114691. get onBindObservable(): Observable<Effect>;
  114692. /** @hidden */
  114693. _bonesComputationForcedToCPU: boolean;
  114694. /** @hidden */
  114695. _multiTarget: boolean;
  114696. private static _uniqueIdSeed;
  114697. private _engine;
  114698. private _uniformBuffersNames;
  114699. private _uniformBuffersNamesList;
  114700. private _uniformsNames;
  114701. private _samplerList;
  114702. private _samplers;
  114703. private _isReady;
  114704. private _compilationError;
  114705. private _allFallbacksProcessed;
  114706. private _attributesNames;
  114707. private _attributes;
  114708. private _attributeLocationByName;
  114709. private _uniforms;
  114710. /**
  114711. * Key for the effect.
  114712. * @hidden
  114713. */
  114714. _key: string;
  114715. private _indexParameters;
  114716. private _fallbacks;
  114717. private _vertexSourceCode;
  114718. private _fragmentSourceCode;
  114719. private _vertexSourceCodeOverride;
  114720. private _fragmentSourceCodeOverride;
  114721. private _transformFeedbackVaryings;
  114722. /**
  114723. * Compiled shader to webGL program.
  114724. * @hidden
  114725. */
  114726. _pipelineContext: Nullable<IPipelineContext>;
  114727. private _valueCache;
  114728. private static _baseCache;
  114729. /**
  114730. * Instantiates an effect.
  114731. * An effect can be used to create/manage/execute vertex and fragment shaders.
  114732. * @param baseName Name of the effect.
  114733. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  114734. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  114735. * @param samplers List of sampler variables that will be passed to the shader.
  114736. * @param engine Engine to be used to render the effect
  114737. * @param defines Define statements to be added to the shader.
  114738. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  114739. * @param onCompiled Callback that will be called when the shader is compiled.
  114740. * @param onError Callback that will be called if an error occurs during shader compilation.
  114741. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  114742. */
  114743. 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);
  114744. private _useFinalCode;
  114745. /**
  114746. * Unique key for this effect
  114747. */
  114748. get key(): string;
  114749. /**
  114750. * If the effect has been compiled and prepared.
  114751. * @returns if the effect is compiled and prepared.
  114752. */
  114753. isReady(): boolean;
  114754. private _isReadyInternal;
  114755. /**
  114756. * The engine the effect was initialized with.
  114757. * @returns the engine.
  114758. */
  114759. getEngine(): Engine;
  114760. /**
  114761. * The pipeline context for this effect
  114762. * @returns the associated pipeline context
  114763. */
  114764. getPipelineContext(): Nullable<IPipelineContext>;
  114765. /**
  114766. * The set of names of attribute variables for the shader.
  114767. * @returns An array of attribute names.
  114768. */
  114769. getAttributesNames(): string[];
  114770. /**
  114771. * Returns the attribute at the given index.
  114772. * @param index The index of the attribute.
  114773. * @returns The location of the attribute.
  114774. */
  114775. getAttributeLocation(index: number): number;
  114776. /**
  114777. * Returns the attribute based on the name of the variable.
  114778. * @param name of the attribute to look up.
  114779. * @returns the attribute location.
  114780. */
  114781. getAttributeLocationByName(name: string): number;
  114782. /**
  114783. * The number of attributes.
  114784. * @returns the numnber of attributes.
  114785. */
  114786. getAttributesCount(): number;
  114787. /**
  114788. * Gets the index of a uniform variable.
  114789. * @param uniformName of the uniform to look up.
  114790. * @returns the index.
  114791. */
  114792. getUniformIndex(uniformName: string): number;
  114793. /**
  114794. * Returns the attribute based on the name of the variable.
  114795. * @param uniformName of the uniform to look up.
  114796. * @returns the location of the uniform.
  114797. */
  114798. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  114799. /**
  114800. * Returns an array of sampler variable names
  114801. * @returns The array of sampler variable names.
  114802. */
  114803. getSamplers(): string[];
  114804. /**
  114805. * Returns an array of uniform variable names
  114806. * @returns The array of uniform variable names.
  114807. */
  114808. getUniformNames(): string[];
  114809. /**
  114810. * Returns an array of uniform buffer variable names
  114811. * @returns The array of uniform buffer variable names.
  114812. */
  114813. getUniformBuffersNames(): string[];
  114814. /**
  114815. * Returns the index parameters used to create the effect
  114816. * @returns The index parameters object
  114817. */
  114818. getIndexParameters(): any;
  114819. /**
  114820. * The error from the last compilation.
  114821. * @returns the error string.
  114822. */
  114823. getCompilationError(): string;
  114824. /**
  114825. * Gets a boolean indicating that all fallbacks were used during compilation
  114826. * @returns true if all fallbacks were used
  114827. */
  114828. allFallbacksProcessed(): boolean;
  114829. /**
  114830. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  114831. * @param func The callback to be used.
  114832. */
  114833. executeWhenCompiled(func: (effect: Effect) => void): void;
  114834. private _checkIsReady;
  114835. private _loadShader;
  114836. /**
  114837. * Gets the vertex shader source code of this effect
  114838. */
  114839. get vertexSourceCode(): string;
  114840. /**
  114841. * Gets the fragment shader source code of this effect
  114842. */
  114843. get fragmentSourceCode(): string;
  114844. /**
  114845. * Recompiles the webGL program
  114846. * @param vertexSourceCode The source code for the vertex shader.
  114847. * @param fragmentSourceCode The source code for the fragment shader.
  114848. * @param onCompiled Callback called when completed.
  114849. * @param onError Callback called on error.
  114850. * @hidden
  114851. */
  114852. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  114853. /**
  114854. * Prepares the effect
  114855. * @hidden
  114856. */
  114857. _prepareEffect(): void;
  114858. private _getShaderCodeAndErrorLine;
  114859. private _processCompilationErrors;
  114860. /**
  114861. * Checks if the effect is supported. (Must be called after compilation)
  114862. */
  114863. get isSupported(): boolean;
  114864. /**
  114865. * Binds a texture to the engine to be used as output of the shader.
  114866. * @param channel Name of the output variable.
  114867. * @param texture Texture to bind.
  114868. * @hidden
  114869. */
  114870. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  114871. /**
  114872. * Sets a texture on the engine to be used in the shader.
  114873. * @param channel Name of the sampler variable.
  114874. * @param texture Texture to set.
  114875. */
  114876. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  114877. /**
  114878. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  114879. * @param channel Name of the sampler variable.
  114880. * @param texture Texture to set.
  114881. */
  114882. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  114883. /**
  114884. * Sets an array of textures on the engine to be used in the shader.
  114885. * @param channel Name of the variable.
  114886. * @param textures Textures to set.
  114887. */
  114888. setTextureArray(channel: string, textures: BaseTexture[]): void;
  114889. /**
  114890. * 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)
  114891. * @param channel Name of the sampler variable.
  114892. * @param postProcess Post process to get the input texture from.
  114893. */
  114894. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  114895. /**
  114896. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  114897. * 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)
  114898. * @param channel Name of the sampler variable.
  114899. * @param postProcess Post process to get the output texture from.
  114900. */
  114901. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  114902. /** @hidden */
  114903. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  114904. /** @hidden */
  114905. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  114906. /** @hidden */
  114907. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  114908. /** @hidden */
  114909. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  114910. /**
  114911. * Binds a buffer to a uniform.
  114912. * @param buffer Buffer to bind.
  114913. * @param name Name of the uniform variable to bind to.
  114914. */
  114915. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  114916. /**
  114917. * Binds block to a uniform.
  114918. * @param blockName Name of the block to bind.
  114919. * @param index Index to bind.
  114920. */
  114921. bindUniformBlock(blockName: string, index: number): void;
  114922. /**
  114923. * Sets an interger value on a uniform variable.
  114924. * @param uniformName Name of the variable.
  114925. * @param value Value to be set.
  114926. * @returns this effect.
  114927. */
  114928. setInt(uniformName: string, value: number): Effect;
  114929. /**
  114930. * Sets an int array on a uniform variable.
  114931. * @param uniformName Name of the variable.
  114932. * @param array array to be set.
  114933. * @returns this effect.
  114934. */
  114935. setIntArray(uniformName: string, array: Int32Array): Effect;
  114936. /**
  114937. * 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)
  114938. * @param uniformName Name of the variable.
  114939. * @param array array to be set.
  114940. * @returns this effect.
  114941. */
  114942. setIntArray2(uniformName: string, array: Int32Array): Effect;
  114943. /**
  114944. * 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)
  114945. * @param uniformName Name of the variable.
  114946. * @param array array to be set.
  114947. * @returns this effect.
  114948. */
  114949. setIntArray3(uniformName: string, array: Int32Array): Effect;
  114950. /**
  114951. * 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)
  114952. * @param uniformName Name of the variable.
  114953. * @param array array to be set.
  114954. * @returns this effect.
  114955. */
  114956. setIntArray4(uniformName: string, array: Int32Array): Effect;
  114957. /**
  114958. * Sets an float array on a uniform variable.
  114959. * @param uniformName Name of the variable.
  114960. * @param array array to be set.
  114961. * @returns this effect.
  114962. */
  114963. setFloatArray(uniformName: string, array: Float32Array): Effect;
  114964. /**
  114965. * 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)
  114966. * @param uniformName Name of the variable.
  114967. * @param array array to be set.
  114968. * @returns this effect.
  114969. */
  114970. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  114971. /**
  114972. * 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)
  114973. * @param uniformName Name of the variable.
  114974. * @param array array to be set.
  114975. * @returns this effect.
  114976. */
  114977. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  114978. /**
  114979. * 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)
  114980. * @param uniformName Name of the variable.
  114981. * @param array array to be set.
  114982. * @returns this effect.
  114983. */
  114984. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  114985. /**
  114986. * Sets an array on a uniform variable.
  114987. * @param uniformName Name of the variable.
  114988. * @param array array to be set.
  114989. * @returns this effect.
  114990. */
  114991. setArray(uniformName: string, array: number[]): Effect;
  114992. /**
  114993. * 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)
  114994. * @param uniformName Name of the variable.
  114995. * @param array array to be set.
  114996. * @returns this effect.
  114997. */
  114998. setArray2(uniformName: string, array: number[]): Effect;
  114999. /**
  115000. * 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)
  115001. * @param uniformName Name of the variable.
  115002. * @param array array to be set.
  115003. * @returns this effect.
  115004. */
  115005. setArray3(uniformName: string, array: number[]): Effect;
  115006. /**
  115007. * 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)
  115008. * @param uniformName Name of the variable.
  115009. * @param array array to be set.
  115010. * @returns this effect.
  115011. */
  115012. setArray4(uniformName: string, array: number[]): Effect;
  115013. /**
  115014. * Sets matrices on a uniform variable.
  115015. * @param uniformName Name of the variable.
  115016. * @param matrices matrices to be set.
  115017. * @returns this effect.
  115018. */
  115019. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  115020. /**
  115021. * Sets matrix on a uniform variable.
  115022. * @param uniformName Name of the variable.
  115023. * @param matrix matrix to be set.
  115024. * @returns this effect.
  115025. */
  115026. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  115027. /**
  115028. * 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)
  115029. * @param uniformName Name of the variable.
  115030. * @param matrix matrix to be set.
  115031. * @returns this effect.
  115032. */
  115033. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  115034. /**
  115035. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  115036. * @param uniformName Name of the variable.
  115037. * @param matrix matrix to be set.
  115038. * @returns this effect.
  115039. */
  115040. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  115041. /**
  115042. * Sets a float on a uniform variable.
  115043. * @param uniformName Name of the variable.
  115044. * @param value value to be set.
  115045. * @returns this effect.
  115046. */
  115047. setFloat(uniformName: string, value: number): Effect;
  115048. /**
  115049. * Sets a boolean on a uniform variable.
  115050. * @param uniformName Name of the variable.
  115051. * @param bool value to be set.
  115052. * @returns this effect.
  115053. */
  115054. setBool(uniformName: string, bool: boolean): Effect;
  115055. /**
  115056. * Sets a Vector2 on a uniform variable.
  115057. * @param uniformName Name of the variable.
  115058. * @param vector2 vector2 to be set.
  115059. * @returns this effect.
  115060. */
  115061. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  115062. /**
  115063. * Sets a float2 on a uniform variable.
  115064. * @param uniformName Name of the variable.
  115065. * @param x First float in float2.
  115066. * @param y Second float in float2.
  115067. * @returns this effect.
  115068. */
  115069. setFloat2(uniformName: string, x: number, y: number): Effect;
  115070. /**
  115071. * Sets a Vector3 on a uniform variable.
  115072. * @param uniformName Name of the variable.
  115073. * @param vector3 Value to be set.
  115074. * @returns this effect.
  115075. */
  115076. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  115077. /**
  115078. * Sets a float3 on a uniform variable.
  115079. * @param uniformName Name of the variable.
  115080. * @param x First float in float3.
  115081. * @param y Second float in float3.
  115082. * @param z Third float in float3.
  115083. * @returns this effect.
  115084. */
  115085. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  115086. /**
  115087. * Sets a Vector4 on a uniform variable.
  115088. * @param uniformName Name of the variable.
  115089. * @param vector4 Value to be set.
  115090. * @returns this effect.
  115091. */
  115092. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  115093. /**
  115094. * Sets a float4 on a uniform variable.
  115095. * @param uniformName Name of the variable.
  115096. * @param x First float in float4.
  115097. * @param y Second float in float4.
  115098. * @param z Third float in float4.
  115099. * @param w Fourth float in float4.
  115100. * @returns this effect.
  115101. */
  115102. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  115103. /**
  115104. * Sets a Color3 on a uniform variable.
  115105. * @param uniformName Name of the variable.
  115106. * @param color3 Value to be set.
  115107. * @returns this effect.
  115108. */
  115109. setColor3(uniformName: string, color3: IColor3Like): Effect;
  115110. /**
  115111. * Sets a Color4 on a uniform variable.
  115112. * @param uniformName Name of the variable.
  115113. * @param color3 Value to be set.
  115114. * @param alpha Alpha value to be set.
  115115. * @returns this effect.
  115116. */
  115117. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  115118. /**
  115119. * Sets a Color4 on a uniform variable
  115120. * @param uniformName defines the name of the variable
  115121. * @param color4 defines the value to be set
  115122. * @returns this effect.
  115123. */
  115124. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  115125. /** Release all associated resources */
  115126. dispose(): void;
  115127. /**
  115128. * This function will add a new shader to the shader store
  115129. * @param name the name of the shader
  115130. * @param pixelShader optional pixel shader content
  115131. * @param vertexShader optional vertex shader content
  115132. */
  115133. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  115134. /**
  115135. * Store of each shader (The can be looked up using effect.key)
  115136. */
  115137. static ShadersStore: {
  115138. [key: string]: string;
  115139. };
  115140. /**
  115141. * Store of each included file for a shader (The can be looked up using effect.key)
  115142. */
  115143. static IncludesShadersStore: {
  115144. [key: string]: string;
  115145. };
  115146. /**
  115147. * Resets the cache of effects.
  115148. */
  115149. static ResetCache(): void;
  115150. }
  115151. }
  115152. declare module BABYLON {
  115153. /**
  115154. * Interface used to describe the capabilities of the engine relatively to the current browser
  115155. */
  115156. export interface EngineCapabilities {
  115157. /** Maximum textures units per fragment shader */
  115158. maxTexturesImageUnits: number;
  115159. /** Maximum texture units per vertex shader */
  115160. maxVertexTextureImageUnits: number;
  115161. /** Maximum textures units in the entire pipeline */
  115162. maxCombinedTexturesImageUnits: number;
  115163. /** Maximum texture size */
  115164. maxTextureSize: number;
  115165. /** Maximum texture samples */
  115166. maxSamples?: number;
  115167. /** Maximum cube texture size */
  115168. maxCubemapTextureSize: number;
  115169. /** Maximum render texture size */
  115170. maxRenderTextureSize: number;
  115171. /** Maximum number of vertex attributes */
  115172. maxVertexAttribs: number;
  115173. /** Maximum number of varyings */
  115174. maxVaryingVectors: number;
  115175. /** Maximum number of uniforms per vertex shader */
  115176. maxVertexUniformVectors: number;
  115177. /** Maximum number of uniforms per fragment shader */
  115178. maxFragmentUniformVectors: number;
  115179. /** Defines if standard derivates (dx/dy) are supported */
  115180. standardDerivatives: boolean;
  115181. /** Defines if s3tc texture compression is supported */
  115182. s3tc?: WEBGL_compressed_texture_s3tc;
  115183. /** Defines if pvrtc texture compression is supported */
  115184. pvrtc: any;
  115185. /** Defines if etc1 texture compression is supported */
  115186. etc1: any;
  115187. /** Defines if etc2 texture compression is supported */
  115188. etc2: any;
  115189. /** Defines if astc texture compression is supported */
  115190. astc: any;
  115191. /** Defines if bptc texture compression is supported */
  115192. bptc: any;
  115193. /** Defines if float textures are supported */
  115194. textureFloat: boolean;
  115195. /** Defines if vertex array objects are supported */
  115196. vertexArrayObject: boolean;
  115197. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  115198. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  115199. /** Gets the maximum level of anisotropy supported */
  115200. maxAnisotropy: number;
  115201. /** Defines if instancing is supported */
  115202. instancedArrays: boolean;
  115203. /** Defines if 32 bits indices are supported */
  115204. uintIndices: boolean;
  115205. /** Defines if high precision shaders are supported */
  115206. highPrecisionShaderSupported: boolean;
  115207. /** Defines if depth reading in the fragment shader is supported */
  115208. fragmentDepthSupported: boolean;
  115209. /** Defines if float texture linear filtering is supported*/
  115210. textureFloatLinearFiltering: boolean;
  115211. /** Defines if rendering to float textures is supported */
  115212. textureFloatRender: boolean;
  115213. /** Defines if half float textures are supported*/
  115214. textureHalfFloat: boolean;
  115215. /** Defines if half float texture linear filtering is supported*/
  115216. textureHalfFloatLinearFiltering: boolean;
  115217. /** Defines if rendering to half float textures is supported */
  115218. textureHalfFloatRender: boolean;
  115219. /** Defines if textureLOD shader command is supported */
  115220. textureLOD: boolean;
  115221. /** Defines if draw buffers extension is supported */
  115222. drawBuffersExtension: boolean;
  115223. /** Defines if depth textures are supported */
  115224. depthTextureExtension: boolean;
  115225. /** Defines if float color buffer are supported */
  115226. colorBufferFloat: boolean;
  115227. /** Gets disjoint timer query extension (null if not supported) */
  115228. timerQuery?: EXT_disjoint_timer_query;
  115229. /** Defines if timestamp can be used with timer query */
  115230. canUseTimestampForTimerQuery: boolean;
  115231. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  115232. multiview?: any;
  115233. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  115234. oculusMultiview?: any;
  115235. /** Function used to let the system compiles shaders in background */
  115236. parallelShaderCompile?: {
  115237. COMPLETION_STATUS_KHR: number;
  115238. };
  115239. /** Max number of texture samples for MSAA */
  115240. maxMSAASamples: number;
  115241. /** Defines if the blend min max extension is supported */
  115242. blendMinMax: boolean;
  115243. }
  115244. }
  115245. declare module BABYLON {
  115246. /**
  115247. * @hidden
  115248. **/
  115249. export class DepthCullingState {
  115250. private _isDepthTestDirty;
  115251. private _isDepthMaskDirty;
  115252. private _isDepthFuncDirty;
  115253. private _isCullFaceDirty;
  115254. private _isCullDirty;
  115255. private _isZOffsetDirty;
  115256. private _isFrontFaceDirty;
  115257. private _depthTest;
  115258. private _depthMask;
  115259. private _depthFunc;
  115260. private _cull;
  115261. private _cullFace;
  115262. private _zOffset;
  115263. private _frontFace;
  115264. /**
  115265. * Initializes the state.
  115266. */
  115267. constructor();
  115268. get isDirty(): boolean;
  115269. get zOffset(): number;
  115270. set zOffset(value: number);
  115271. get cullFace(): Nullable<number>;
  115272. set cullFace(value: Nullable<number>);
  115273. get cull(): Nullable<boolean>;
  115274. set cull(value: Nullable<boolean>);
  115275. get depthFunc(): Nullable<number>;
  115276. set depthFunc(value: Nullable<number>);
  115277. get depthMask(): boolean;
  115278. set depthMask(value: boolean);
  115279. get depthTest(): boolean;
  115280. set depthTest(value: boolean);
  115281. get frontFace(): Nullable<number>;
  115282. set frontFace(value: Nullable<number>);
  115283. reset(): void;
  115284. apply(gl: WebGLRenderingContext): void;
  115285. }
  115286. }
  115287. declare module BABYLON {
  115288. /**
  115289. * @hidden
  115290. **/
  115291. export class StencilState {
  115292. /** 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 */
  115293. static readonly ALWAYS: number;
  115294. /** Passed to stencilOperation to specify that stencil value must be kept */
  115295. static readonly KEEP: number;
  115296. /** Passed to stencilOperation to specify that stencil value must be replaced */
  115297. static readonly REPLACE: number;
  115298. private _isStencilTestDirty;
  115299. private _isStencilMaskDirty;
  115300. private _isStencilFuncDirty;
  115301. private _isStencilOpDirty;
  115302. private _stencilTest;
  115303. private _stencilMask;
  115304. private _stencilFunc;
  115305. private _stencilFuncRef;
  115306. private _stencilFuncMask;
  115307. private _stencilOpStencilFail;
  115308. private _stencilOpDepthFail;
  115309. private _stencilOpStencilDepthPass;
  115310. get isDirty(): boolean;
  115311. get stencilFunc(): number;
  115312. set stencilFunc(value: number);
  115313. get stencilFuncRef(): number;
  115314. set stencilFuncRef(value: number);
  115315. get stencilFuncMask(): number;
  115316. set stencilFuncMask(value: number);
  115317. get stencilOpStencilFail(): number;
  115318. set stencilOpStencilFail(value: number);
  115319. get stencilOpDepthFail(): number;
  115320. set stencilOpDepthFail(value: number);
  115321. get stencilOpStencilDepthPass(): number;
  115322. set stencilOpStencilDepthPass(value: number);
  115323. get stencilMask(): number;
  115324. set stencilMask(value: number);
  115325. get stencilTest(): boolean;
  115326. set stencilTest(value: boolean);
  115327. constructor();
  115328. reset(): void;
  115329. apply(gl: WebGLRenderingContext): void;
  115330. }
  115331. }
  115332. declare module BABYLON {
  115333. /**
  115334. * @hidden
  115335. **/
  115336. export class AlphaState {
  115337. private _isAlphaBlendDirty;
  115338. private _isBlendFunctionParametersDirty;
  115339. private _isBlendEquationParametersDirty;
  115340. private _isBlendConstantsDirty;
  115341. private _alphaBlend;
  115342. private _blendFunctionParameters;
  115343. private _blendEquationParameters;
  115344. private _blendConstants;
  115345. /**
  115346. * Initializes the state.
  115347. */
  115348. constructor();
  115349. get isDirty(): boolean;
  115350. get alphaBlend(): boolean;
  115351. set alphaBlend(value: boolean);
  115352. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  115353. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  115354. setAlphaEquationParameters(rgb: number, alpha: number): void;
  115355. reset(): void;
  115356. apply(gl: WebGLRenderingContext): void;
  115357. }
  115358. }
  115359. declare module BABYLON {
  115360. /** @hidden */
  115361. export class WebGL2ShaderProcessor implements IShaderProcessor {
  115362. attributeProcessor(attribute: string): string;
  115363. varyingProcessor(varying: string, isFragment: boolean): string;
  115364. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  115365. }
  115366. }
  115367. declare module BABYLON {
  115368. /**
  115369. * Interface for attribute information associated with buffer instanciation
  115370. */
  115371. export interface InstancingAttributeInfo {
  115372. /**
  115373. * Name of the GLSL attribute
  115374. * if attribute index is not specified, this is used to retrieve the index from the effect
  115375. */
  115376. attributeName: string;
  115377. /**
  115378. * Index/offset of the attribute in the vertex shader
  115379. * if not specified, this will be computes from the name.
  115380. */
  115381. index?: number;
  115382. /**
  115383. * size of the attribute, 1, 2, 3 or 4
  115384. */
  115385. attributeSize: number;
  115386. /**
  115387. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  115388. */
  115389. offset: number;
  115390. /**
  115391. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  115392. * default to 1
  115393. */
  115394. divisor?: number;
  115395. /**
  115396. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  115397. * default is FLOAT
  115398. */
  115399. attributeType?: number;
  115400. /**
  115401. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  115402. */
  115403. normalized?: boolean;
  115404. }
  115405. }
  115406. declare module BABYLON {
  115407. interface ThinEngine {
  115408. /**
  115409. * Update a video texture
  115410. * @param texture defines the texture to update
  115411. * @param video defines the video element to use
  115412. * @param invertY defines if data must be stored with Y axis inverted
  115413. */
  115414. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  115415. }
  115416. }
  115417. declare module BABYLON {
  115418. interface ThinEngine {
  115419. /**
  115420. * Creates a dynamic texture
  115421. * @param width defines the width of the texture
  115422. * @param height defines the height of the texture
  115423. * @param generateMipMaps defines if the engine should generate the mip levels
  115424. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  115425. * @returns the dynamic texture inside an InternalTexture
  115426. */
  115427. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  115428. /**
  115429. * Update the content of a dynamic texture
  115430. * @param texture defines the texture to update
  115431. * @param canvas defines the canvas containing the source
  115432. * @param invertY defines if data must be stored with Y axis inverted
  115433. * @param premulAlpha defines if alpha is stored as premultiplied
  115434. * @param format defines the format of the data
  115435. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  115436. */
  115437. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  115438. }
  115439. }
  115440. declare module BABYLON {
  115441. /**
  115442. * Settings for finer control over video usage
  115443. */
  115444. export interface VideoTextureSettings {
  115445. /**
  115446. * Applies `autoplay` to video, if specified
  115447. */
  115448. autoPlay?: boolean;
  115449. /**
  115450. * Applies `loop` to video, if specified
  115451. */
  115452. loop?: boolean;
  115453. /**
  115454. * Automatically updates internal texture from video at every frame in the render loop
  115455. */
  115456. autoUpdateTexture: boolean;
  115457. /**
  115458. * Image src displayed during the video loading or until the user interacts with the video.
  115459. */
  115460. poster?: string;
  115461. }
  115462. /**
  115463. * If you want to display a video in your scene, this is the special texture for that.
  115464. * This special texture works similar to other textures, with the exception of a few parameters.
  115465. * @see https://doc.babylonjs.com/how_to/video_texture
  115466. */
  115467. export class VideoTexture extends Texture {
  115468. /**
  115469. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  115470. */
  115471. readonly autoUpdateTexture: boolean;
  115472. /**
  115473. * The video instance used by the texture internally
  115474. */
  115475. readonly video: HTMLVideoElement;
  115476. private _onUserActionRequestedObservable;
  115477. /**
  115478. * Event triggerd when a dom action is required by the user to play the video.
  115479. * This happens due to recent changes in browser policies preventing video to auto start.
  115480. */
  115481. get onUserActionRequestedObservable(): Observable<Texture>;
  115482. private _generateMipMaps;
  115483. private _stillImageCaptured;
  115484. private _displayingPosterTexture;
  115485. private _settings;
  115486. private _createInternalTextureOnEvent;
  115487. private _frameId;
  115488. private _currentSrc;
  115489. /**
  115490. * Creates a video texture.
  115491. * If you want to display a video in your scene, this is the special texture for that.
  115492. * This special texture works similar to other textures, with the exception of a few parameters.
  115493. * @see https://doc.babylonjs.com/how_to/video_texture
  115494. * @param name optional name, will detect from video source, if not defined
  115495. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  115496. * @param scene is obviously the current scene.
  115497. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  115498. * @param invertY is false by default but can be used to invert video on Y axis
  115499. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  115500. * @param settings allows finer control over video usage
  115501. */
  115502. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  115503. private _getName;
  115504. private _getVideo;
  115505. private _createInternalTexture;
  115506. private reset;
  115507. /**
  115508. * @hidden Internal method to initiate `update`.
  115509. */
  115510. _rebuild(): void;
  115511. /**
  115512. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  115513. */
  115514. update(): void;
  115515. /**
  115516. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  115517. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  115518. */
  115519. updateTexture(isVisible: boolean): void;
  115520. protected _updateInternalTexture: () => void;
  115521. /**
  115522. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  115523. * @param url New url.
  115524. */
  115525. updateURL(url: string): void;
  115526. /**
  115527. * Clones the texture.
  115528. * @returns the cloned texture
  115529. */
  115530. clone(): VideoTexture;
  115531. /**
  115532. * Dispose the texture and release its associated resources.
  115533. */
  115534. dispose(): void;
  115535. /**
  115536. * Creates a video texture straight from a stream.
  115537. * @param scene Define the scene the texture should be created in
  115538. * @param stream Define the stream the texture should be created from
  115539. * @returns The created video texture as a promise
  115540. */
  115541. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  115542. /**
  115543. * Creates a video texture straight from your WebCam video feed.
  115544. * @param scene Define the scene the texture should be created in
  115545. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  115546. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  115547. * @returns The created video texture as a promise
  115548. */
  115549. static CreateFromWebCamAsync(scene: Scene, constraints: {
  115550. minWidth: number;
  115551. maxWidth: number;
  115552. minHeight: number;
  115553. maxHeight: number;
  115554. deviceId: string;
  115555. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  115556. /**
  115557. * Creates a video texture straight from your WebCam video feed.
  115558. * @param scene Define the scene the texture should be created in
  115559. * @param onReady Define a callback to triggered once the texture will be ready
  115560. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  115561. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  115562. */
  115563. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  115564. minWidth: number;
  115565. maxWidth: number;
  115566. minHeight: number;
  115567. maxHeight: number;
  115568. deviceId: string;
  115569. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  115570. }
  115571. }
  115572. declare module BABYLON {
  115573. /**
  115574. * Defines the interface used by objects working like Scene
  115575. * @hidden
  115576. */
  115577. export interface ISceneLike {
  115578. _addPendingData(data: any): void;
  115579. _removePendingData(data: any): void;
  115580. offlineProvider: IOfflineProvider;
  115581. }
  115582. /**
  115583. * Information about the current host
  115584. */
  115585. export interface HostInformation {
  115586. /**
  115587. * Defines if the current host is a mobile
  115588. */
  115589. isMobile: boolean;
  115590. }
  115591. /** Interface defining initialization parameters for Engine class */
  115592. export interface EngineOptions extends WebGLContextAttributes {
  115593. /**
  115594. * Defines if the engine should no exceed a specified device ratio
  115595. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  115596. */
  115597. limitDeviceRatio?: number;
  115598. /**
  115599. * Defines if webvr should be enabled automatically
  115600. * @see https://doc.babylonjs.com/how_to/webvr_camera
  115601. */
  115602. autoEnableWebVR?: boolean;
  115603. /**
  115604. * Defines if webgl2 should be turned off even if supported
  115605. * @see https://doc.babylonjs.com/features/webgl2
  115606. */
  115607. disableWebGL2Support?: boolean;
  115608. /**
  115609. * Defines if webaudio should be initialized as well
  115610. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  115611. */
  115612. audioEngine?: boolean;
  115613. /**
  115614. * Defines if animations should run using a deterministic lock step
  115615. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  115616. */
  115617. deterministicLockstep?: boolean;
  115618. /** Defines the maximum steps to use with deterministic lock step mode */
  115619. lockstepMaxSteps?: number;
  115620. /** Defines the seconds between each deterministic lock step */
  115621. timeStep?: number;
  115622. /**
  115623. * Defines that engine should ignore context lost events
  115624. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  115625. */
  115626. doNotHandleContextLost?: boolean;
  115627. /**
  115628. * Defines that engine should ignore modifying touch action attribute and style
  115629. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  115630. */
  115631. doNotHandleTouchAction?: boolean;
  115632. /**
  115633. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  115634. */
  115635. useHighPrecisionFloats?: boolean;
  115636. /**
  115637. * Make the canvas XR Compatible for XR sessions
  115638. */
  115639. xrCompatible?: boolean;
  115640. /**
  115641. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  115642. */
  115643. useHighPrecisionMatrix?: boolean;
  115644. }
  115645. /**
  115646. * The base engine class (root of all engines)
  115647. */
  115648. export class ThinEngine {
  115649. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  115650. static ExceptionList: ({
  115651. key: string;
  115652. capture: string;
  115653. captureConstraint: number;
  115654. targets: string[];
  115655. } | {
  115656. key: string;
  115657. capture: null;
  115658. captureConstraint: null;
  115659. targets: string[];
  115660. })[];
  115661. /** @hidden */
  115662. static _TextureLoaders: IInternalTextureLoader[];
  115663. /**
  115664. * Returns the current npm package of the sdk
  115665. */
  115666. static get NpmPackage(): string;
  115667. /**
  115668. * Returns the current version of the framework
  115669. */
  115670. static get Version(): string;
  115671. /**
  115672. * Returns a string describing the current engine
  115673. */
  115674. get description(): string;
  115675. /**
  115676. * Gets or sets the epsilon value used by collision engine
  115677. */
  115678. static CollisionsEpsilon: number;
  115679. /**
  115680. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  115681. */
  115682. static get ShadersRepository(): string;
  115683. static set ShadersRepository(value: string);
  115684. /** @hidden */
  115685. _shaderProcessor: IShaderProcessor;
  115686. /**
  115687. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  115688. */
  115689. forcePOTTextures: boolean;
  115690. /**
  115691. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  115692. */
  115693. isFullscreen: boolean;
  115694. /**
  115695. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  115696. */
  115697. cullBackFaces: boolean;
  115698. /**
  115699. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  115700. */
  115701. renderEvenInBackground: boolean;
  115702. /**
  115703. * Gets or sets a boolean indicating that cache can be kept between frames
  115704. */
  115705. preventCacheWipeBetweenFrames: boolean;
  115706. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  115707. validateShaderPrograms: boolean;
  115708. /**
  115709. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  115710. * This can provide greater z depth for distant objects.
  115711. */
  115712. useReverseDepthBuffer: boolean;
  115713. /**
  115714. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  115715. */
  115716. disableUniformBuffers: boolean;
  115717. /** @hidden */
  115718. _uniformBuffers: UniformBuffer[];
  115719. /**
  115720. * Gets a boolean indicating that the engine supports uniform buffers
  115721. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  115722. */
  115723. get supportsUniformBuffers(): boolean;
  115724. /** @hidden */
  115725. _gl: WebGLRenderingContext;
  115726. /** @hidden */
  115727. _webGLVersion: number;
  115728. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  115729. protected _windowIsBackground: boolean;
  115730. protected _creationOptions: EngineOptions;
  115731. protected _highPrecisionShadersAllowed: boolean;
  115732. /** @hidden */
  115733. get _shouldUseHighPrecisionShader(): boolean;
  115734. /**
  115735. * Gets a boolean indicating that only power of 2 textures are supported
  115736. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  115737. */
  115738. get needPOTTextures(): boolean;
  115739. /** @hidden */
  115740. _badOS: boolean;
  115741. /** @hidden */
  115742. _badDesktopOS: boolean;
  115743. private _hardwareScalingLevel;
  115744. /** @hidden */
  115745. _caps: EngineCapabilities;
  115746. private _isStencilEnable;
  115747. private _glVersion;
  115748. private _glRenderer;
  115749. private _glVendor;
  115750. /** @hidden */
  115751. _videoTextureSupported: boolean;
  115752. protected _renderingQueueLaunched: boolean;
  115753. protected _activeRenderLoops: (() => void)[];
  115754. /**
  115755. * Observable signaled when a context lost event is raised
  115756. */
  115757. onContextLostObservable: Observable<ThinEngine>;
  115758. /**
  115759. * Observable signaled when a context restored event is raised
  115760. */
  115761. onContextRestoredObservable: Observable<ThinEngine>;
  115762. private _onContextLost;
  115763. private _onContextRestored;
  115764. protected _contextWasLost: boolean;
  115765. /** @hidden */
  115766. _doNotHandleContextLost: boolean;
  115767. /**
  115768. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  115769. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  115770. */
  115771. get doNotHandleContextLost(): boolean;
  115772. set doNotHandleContextLost(value: boolean);
  115773. /**
  115774. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  115775. */
  115776. disableVertexArrayObjects: boolean;
  115777. /** @hidden */
  115778. protected _colorWrite: boolean;
  115779. /** @hidden */
  115780. protected _colorWriteChanged: boolean;
  115781. /** @hidden */
  115782. protected _depthCullingState: DepthCullingState;
  115783. /** @hidden */
  115784. protected _stencilState: StencilState;
  115785. /** @hidden */
  115786. _alphaState: AlphaState;
  115787. /** @hidden */
  115788. _alphaMode: number;
  115789. /** @hidden */
  115790. _alphaEquation: number;
  115791. /** @hidden */
  115792. _internalTexturesCache: InternalTexture[];
  115793. /** @hidden */
  115794. protected _activeChannel: number;
  115795. private _currentTextureChannel;
  115796. /** @hidden */
  115797. protected _boundTexturesCache: {
  115798. [key: string]: Nullable<InternalTexture>;
  115799. };
  115800. /** @hidden */
  115801. protected _currentEffect: Nullable<Effect>;
  115802. /** @hidden */
  115803. protected _currentProgram: Nullable<WebGLProgram>;
  115804. private _compiledEffects;
  115805. private _vertexAttribArraysEnabled;
  115806. /** @hidden */
  115807. protected _cachedViewport: Nullable<IViewportLike>;
  115808. private _cachedVertexArrayObject;
  115809. /** @hidden */
  115810. protected _cachedVertexBuffers: any;
  115811. /** @hidden */
  115812. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  115813. /** @hidden */
  115814. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  115815. /** @hidden */
  115816. _currentRenderTarget: Nullable<InternalTexture>;
  115817. private _uintIndicesCurrentlySet;
  115818. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  115819. /** @hidden */
  115820. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  115821. /** @hidden */
  115822. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  115823. private _currentBufferPointers;
  115824. private _currentInstanceLocations;
  115825. private _currentInstanceBuffers;
  115826. private _textureUnits;
  115827. /** @hidden */
  115828. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  115829. /** @hidden */
  115830. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  115831. /** @hidden */
  115832. _boundRenderFunction: any;
  115833. private _vaoRecordInProgress;
  115834. private _mustWipeVertexAttributes;
  115835. private _emptyTexture;
  115836. private _emptyCubeTexture;
  115837. private _emptyTexture3D;
  115838. private _emptyTexture2DArray;
  115839. /** @hidden */
  115840. _frameHandler: number;
  115841. private _nextFreeTextureSlots;
  115842. private _maxSimultaneousTextures;
  115843. private _activeRequests;
  115844. /** @hidden */
  115845. _transformTextureUrl: Nullable<(url: string) => string>;
  115846. /**
  115847. * Gets information about the current host
  115848. */
  115849. hostInformation: HostInformation;
  115850. protected get _supportsHardwareTextureRescaling(): boolean;
  115851. private _framebufferDimensionsObject;
  115852. /**
  115853. * sets the object from which width and height will be taken from when getting render width and height
  115854. * Will fallback to the gl object
  115855. * @param dimensions the framebuffer width and height that will be used.
  115856. */
  115857. set framebufferDimensionsObject(dimensions: Nullable<{
  115858. framebufferWidth: number;
  115859. framebufferHeight: number;
  115860. }>);
  115861. /**
  115862. * Gets the current viewport
  115863. */
  115864. get currentViewport(): Nullable<IViewportLike>;
  115865. /**
  115866. * Gets the default empty texture
  115867. */
  115868. get emptyTexture(): InternalTexture;
  115869. /**
  115870. * Gets the default empty 3D texture
  115871. */
  115872. get emptyTexture3D(): InternalTexture;
  115873. /**
  115874. * Gets the default empty 2D array texture
  115875. */
  115876. get emptyTexture2DArray(): InternalTexture;
  115877. /**
  115878. * Gets the default empty cube texture
  115879. */
  115880. get emptyCubeTexture(): InternalTexture;
  115881. /**
  115882. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  115883. */
  115884. readonly premultipliedAlpha: boolean;
  115885. /**
  115886. * Observable event triggered before each texture is initialized
  115887. */
  115888. onBeforeTextureInitObservable: Observable<Texture>;
  115889. /**
  115890. * Creates a new engine
  115891. * @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
  115892. * @param antialias defines enable antialiasing (default: false)
  115893. * @param options defines further options to be sent to the getContext() function
  115894. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  115895. */
  115896. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  115897. private _rebuildInternalTextures;
  115898. private _rebuildEffects;
  115899. /**
  115900. * Gets a boolean indicating if all created effects are ready
  115901. * @returns true if all effects are ready
  115902. */
  115903. areAllEffectsReady(): boolean;
  115904. protected _rebuildBuffers(): void;
  115905. protected _initGLContext(): void;
  115906. /**
  115907. * Gets version of the current webGL context
  115908. */
  115909. get webGLVersion(): number;
  115910. /**
  115911. * Gets a string identifying the name of the class
  115912. * @returns "Engine" string
  115913. */
  115914. getClassName(): string;
  115915. /**
  115916. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  115917. */
  115918. get isStencilEnable(): boolean;
  115919. /** @hidden */
  115920. _prepareWorkingCanvas(): void;
  115921. /**
  115922. * Reset the texture cache to empty state
  115923. */
  115924. resetTextureCache(): void;
  115925. /**
  115926. * Gets an object containing information about the current webGL context
  115927. * @returns an object containing the vender, the renderer and the version of the current webGL context
  115928. */
  115929. getGlInfo(): {
  115930. vendor: string;
  115931. renderer: string;
  115932. version: string;
  115933. };
  115934. /**
  115935. * Defines the hardware scaling level.
  115936. * By default the hardware scaling level is computed from the window device ratio.
  115937. * 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.
  115938. * @param level defines the level to use
  115939. */
  115940. setHardwareScalingLevel(level: number): void;
  115941. /**
  115942. * Gets the current hardware scaling level.
  115943. * By default the hardware scaling level is computed from the window device ratio.
  115944. * 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.
  115945. * @returns a number indicating the current hardware scaling level
  115946. */
  115947. getHardwareScalingLevel(): number;
  115948. /**
  115949. * Gets the list of loaded textures
  115950. * @returns an array containing all loaded textures
  115951. */
  115952. getLoadedTexturesCache(): InternalTexture[];
  115953. /**
  115954. * Gets the object containing all engine capabilities
  115955. * @returns the EngineCapabilities object
  115956. */
  115957. getCaps(): EngineCapabilities;
  115958. /**
  115959. * stop executing a render loop function and remove it from the execution array
  115960. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  115961. */
  115962. stopRenderLoop(renderFunction?: () => void): void;
  115963. /** @hidden */
  115964. _renderLoop(): void;
  115965. /**
  115966. * Gets the HTML canvas attached with the current webGL context
  115967. * @returns a HTML canvas
  115968. */
  115969. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  115970. /**
  115971. * Gets host window
  115972. * @returns the host window object
  115973. */
  115974. getHostWindow(): Nullable<Window>;
  115975. /**
  115976. * Gets the current render width
  115977. * @param useScreen defines if screen size must be used (or the current render target if any)
  115978. * @returns a number defining the current render width
  115979. */
  115980. getRenderWidth(useScreen?: boolean): number;
  115981. /**
  115982. * Gets the current render height
  115983. * @param useScreen defines if screen size must be used (or the current render target if any)
  115984. * @returns a number defining the current render height
  115985. */
  115986. getRenderHeight(useScreen?: boolean): number;
  115987. /**
  115988. * Can be used to override the current requestAnimationFrame requester.
  115989. * @hidden
  115990. */
  115991. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  115992. /**
  115993. * Register and execute a render loop. The engine can have more than one render function
  115994. * @param renderFunction defines the function to continuously execute
  115995. */
  115996. runRenderLoop(renderFunction: () => void): void;
  115997. /**
  115998. * Clear the current render buffer or the current render target (if any is set up)
  115999. * @param color defines the color to use
  116000. * @param backBuffer defines if the back buffer must be cleared
  116001. * @param depth defines if the depth buffer must be cleared
  116002. * @param stencil defines if the stencil buffer must be cleared
  116003. */
  116004. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  116005. private _viewportCached;
  116006. /** @hidden */
  116007. _viewport(x: number, y: number, width: number, height: number): void;
  116008. /**
  116009. * Set the WebGL's viewport
  116010. * @param viewport defines the viewport element to be used
  116011. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  116012. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  116013. */
  116014. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  116015. /**
  116016. * Begin a new frame
  116017. */
  116018. beginFrame(): void;
  116019. /**
  116020. * Enf the current frame
  116021. */
  116022. endFrame(): void;
  116023. /**
  116024. * Resize the view according to the canvas' size
  116025. */
  116026. resize(): void;
  116027. /**
  116028. * Force a specific size of the canvas
  116029. * @param width defines the new canvas' width
  116030. * @param height defines the new canvas' height
  116031. * @returns true if the size was changed
  116032. */
  116033. setSize(width: number, height: number): boolean;
  116034. /**
  116035. * Binds the frame buffer to the specified texture.
  116036. * @param texture The texture to render to or null for the default canvas
  116037. * @param faceIndex The face of the texture to render to in case of cube texture
  116038. * @param requiredWidth The width of the target to render to
  116039. * @param requiredHeight The height of the target to render to
  116040. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  116041. * @param lodLevel defines the lod level to bind to the frame buffer
  116042. * @param layer defines the 2d array index to bind to frame buffer to
  116043. */
  116044. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  116045. /** @hidden */
  116046. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  116047. /**
  116048. * Unbind the current render target texture from the webGL context
  116049. * @param texture defines the render target texture to unbind
  116050. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  116051. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  116052. */
  116053. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  116054. /**
  116055. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  116056. */
  116057. flushFramebuffer(): void;
  116058. /**
  116059. * Unbind the current render target and bind the default framebuffer
  116060. */
  116061. restoreDefaultFramebuffer(): void;
  116062. /** @hidden */
  116063. protected _resetVertexBufferBinding(): void;
  116064. /**
  116065. * Creates a vertex buffer
  116066. * @param data the data for the vertex buffer
  116067. * @returns the new WebGL static buffer
  116068. */
  116069. createVertexBuffer(data: DataArray): DataBuffer;
  116070. private _createVertexBuffer;
  116071. /**
  116072. * Creates a dynamic vertex buffer
  116073. * @param data the data for the dynamic vertex buffer
  116074. * @returns the new WebGL dynamic buffer
  116075. */
  116076. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  116077. protected _resetIndexBufferBinding(): void;
  116078. /**
  116079. * Creates a new index buffer
  116080. * @param indices defines the content of the index buffer
  116081. * @param updatable defines if the index buffer must be updatable
  116082. * @returns a new webGL buffer
  116083. */
  116084. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  116085. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  116086. /**
  116087. * Bind a webGL buffer to the webGL context
  116088. * @param buffer defines the buffer to bind
  116089. */
  116090. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  116091. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  116092. private bindBuffer;
  116093. /**
  116094. * update the bound buffer with the given data
  116095. * @param data defines the data to update
  116096. */
  116097. updateArrayBuffer(data: Float32Array): void;
  116098. private _vertexAttribPointer;
  116099. /** @hidden */
  116100. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  116101. private _bindVertexBuffersAttributes;
  116102. /**
  116103. * Records a vertex array object
  116104. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  116105. * @param vertexBuffers defines the list of vertex buffers to store
  116106. * @param indexBuffer defines the index buffer to store
  116107. * @param effect defines the effect to store
  116108. * @returns the new vertex array object
  116109. */
  116110. recordVertexArrayObject(vertexBuffers: {
  116111. [key: string]: VertexBuffer;
  116112. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  116113. /**
  116114. * Bind a specific vertex array object
  116115. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  116116. * @param vertexArrayObject defines the vertex array object to bind
  116117. * @param indexBuffer defines the index buffer to bind
  116118. */
  116119. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  116120. /**
  116121. * Bind webGl buffers directly to the webGL context
  116122. * @param vertexBuffer defines the vertex buffer to bind
  116123. * @param indexBuffer defines the index buffer to bind
  116124. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  116125. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  116126. * @param effect defines the effect associated with the vertex buffer
  116127. */
  116128. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  116129. private _unbindVertexArrayObject;
  116130. /**
  116131. * Bind a list of vertex buffers to the webGL context
  116132. * @param vertexBuffers defines the list of vertex buffers to bind
  116133. * @param indexBuffer defines the index buffer to bind
  116134. * @param effect defines the effect associated with the vertex buffers
  116135. */
  116136. bindBuffers(vertexBuffers: {
  116137. [key: string]: Nullable<VertexBuffer>;
  116138. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  116139. /**
  116140. * Unbind all instance attributes
  116141. */
  116142. unbindInstanceAttributes(): void;
  116143. /**
  116144. * Release and free the memory of a vertex array object
  116145. * @param vao defines the vertex array object to delete
  116146. */
  116147. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  116148. /** @hidden */
  116149. _releaseBuffer(buffer: DataBuffer): boolean;
  116150. protected _deleteBuffer(buffer: DataBuffer): void;
  116151. /**
  116152. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  116153. * @param instancesBuffer defines the webGL buffer to update and bind
  116154. * @param data defines the data to store in the buffer
  116155. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  116156. */
  116157. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  116158. /**
  116159. * Bind the content of a webGL buffer used with instantiation
  116160. * @param instancesBuffer defines the webGL buffer to bind
  116161. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  116162. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  116163. */
  116164. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  116165. /**
  116166. * Disable the instance attribute corresponding to the name in parameter
  116167. * @param name defines the name of the attribute to disable
  116168. */
  116169. disableInstanceAttributeByName(name: string): void;
  116170. /**
  116171. * Disable the instance attribute corresponding to the location in parameter
  116172. * @param attributeLocation defines the attribute location of the attribute to disable
  116173. */
  116174. disableInstanceAttribute(attributeLocation: number): void;
  116175. /**
  116176. * Disable the attribute corresponding to the location in parameter
  116177. * @param attributeLocation defines the attribute location of the attribute to disable
  116178. */
  116179. disableAttributeByIndex(attributeLocation: number): void;
  116180. /**
  116181. * Send a draw order
  116182. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  116183. * @param indexStart defines the starting index
  116184. * @param indexCount defines the number of index to draw
  116185. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  116186. */
  116187. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  116188. /**
  116189. * Draw a list of points
  116190. * @param verticesStart defines the index of first vertex to draw
  116191. * @param verticesCount defines the count of vertices to draw
  116192. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  116193. */
  116194. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  116195. /**
  116196. * Draw a list of unindexed primitives
  116197. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  116198. * @param verticesStart defines the index of first vertex to draw
  116199. * @param verticesCount defines the count of vertices to draw
  116200. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  116201. */
  116202. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  116203. /**
  116204. * Draw a list of indexed primitives
  116205. * @param fillMode defines the primitive to use
  116206. * @param indexStart defines the starting index
  116207. * @param indexCount defines the number of index to draw
  116208. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  116209. */
  116210. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  116211. /**
  116212. * Draw a list of unindexed primitives
  116213. * @param fillMode defines the primitive to use
  116214. * @param verticesStart defines the index of first vertex to draw
  116215. * @param verticesCount defines the count of vertices to draw
  116216. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  116217. */
  116218. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  116219. private _drawMode;
  116220. /** @hidden */
  116221. protected _reportDrawCall(): void;
  116222. /** @hidden */
  116223. _releaseEffect(effect: Effect): void;
  116224. /** @hidden */
  116225. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  116226. /**
  116227. * Create a new effect (used to store vertex/fragment shaders)
  116228. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  116229. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  116230. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  116231. * @param samplers defines an array of string used to represent textures
  116232. * @param defines defines the string containing the defines to use to compile the shaders
  116233. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  116234. * @param onCompiled defines a function to call when the effect creation is successful
  116235. * @param onError defines a function to call when the effect creation has failed
  116236. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  116237. * @returns the new Effect
  116238. */
  116239. 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;
  116240. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  116241. private _compileShader;
  116242. private _compileRawShader;
  116243. /** @hidden */
  116244. _getShaderSource(shader: WebGLShader): Nullable<string>;
  116245. /**
  116246. * Directly creates a webGL program
  116247. * @param pipelineContext defines the pipeline context to attach to
  116248. * @param vertexCode defines the vertex shader code to use
  116249. * @param fragmentCode defines the fragment shader code to use
  116250. * @param context defines the webGL context to use (if not set, the current one will be used)
  116251. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  116252. * @returns the new webGL program
  116253. */
  116254. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  116255. /**
  116256. * Creates a webGL program
  116257. * @param pipelineContext defines the pipeline context to attach to
  116258. * @param vertexCode defines the vertex shader code to use
  116259. * @param fragmentCode defines the fragment shader code to use
  116260. * @param defines defines the string containing the defines to use to compile the shaders
  116261. * @param context defines the webGL context to use (if not set, the current one will be used)
  116262. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  116263. * @returns the new webGL program
  116264. */
  116265. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  116266. /**
  116267. * Creates a new pipeline context
  116268. * @returns the new pipeline
  116269. */
  116270. createPipelineContext(): IPipelineContext;
  116271. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  116272. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  116273. /** @hidden */
  116274. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  116275. /** @hidden */
  116276. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  116277. /** @hidden */
  116278. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  116279. /**
  116280. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  116281. * @param pipelineContext defines the pipeline context to use
  116282. * @param uniformsNames defines the list of uniform names
  116283. * @returns an array of webGL uniform locations
  116284. */
  116285. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  116286. /**
  116287. * Gets the lsit of active attributes for a given webGL program
  116288. * @param pipelineContext defines the pipeline context to use
  116289. * @param attributesNames defines the list of attribute names to get
  116290. * @returns an array of indices indicating the offset of each attribute
  116291. */
  116292. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  116293. /**
  116294. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  116295. * @param effect defines the effect to activate
  116296. */
  116297. enableEffect(effect: Nullable<Effect>): void;
  116298. /**
  116299. * Set the value of an uniform to a number (int)
  116300. * @param uniform defines the webGL uniform location where to store the value
  116301. * @param value defines the int number to store
  116302. * @returns true if the value was set
  116303. */
  116304. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): boolean;
  116305. /**
  116306. * Set the value of an uniform to an array of int32
  116307. * @param uniform defines the webGL uniform location where to store the value
  116308. * @param array defines the array of int32 to store
  116309. * @returns true if the value was set
  116310. */
  116311. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  116312. /**
  116313. * Set the value of an uniform to an array of int32 (stored as vec2)
  116314. * @param uniform defines the webGL uniform location where to store the value
  116315. * @param array defines the array of int32 to store
  116316. * @returns true if the value was set
  116317. */
  116318. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  116319. /**
  116320. * Set the value of an uniform to an array of int32 (stored as vec3)
  116321. * @param uniform defines the webGL uniform location where to store the value
  116322. * @param array defines the array of int32 to store
  116323. * @returns true if the value was set
  116324. */
  116325. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  116326. /**
  116327. * Set the value of an uniform to an array of int32 (stored as vec4)
  116328. * @param uniform defines the webGL uniform location where to store the value
  116329. * @param array defines the array of int32 to store
  116330. * @returns true if the value was set
  116331. */
  116332. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  116333. /**
  116334. * Set the value of an uniform to an array of number
  116335. * @param uniform defines the webGL uniform location where to store the value
  116336. * @param array defines the array of number to store
  116337. * @returns true if the value was set
  116338. */
  116339. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  116340. /**
  116341. * Set the value of an uniform to an array of number (stored as vec2)
  116342. * @param uniform defines the webGL uniform location where to store the value
  116343. * @param array defines the array of number to store
  116344. * @returns true if the value was set
  116345. */
  116346. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  116347. /**
  116348. * Set the value of an uniform to an array of number (stored as vec3)
  116349. * @param uniform defines the webGL uniform location where to store the value
  116350. * @param array defines the array of number to store
  116351. * @returns true if the value was set
  116352. */
  116353. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  116354. /**
  116355. * Set the value of an uniform to an array of number (stored as vec4)
  116356. * @param uniform defines the webGL uniform location where to store the value
  116357. * @param array defines the array of number to store
  116358. * @returns true if the value was set
  116359. */
  116360. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  116361. /**
  116362. * Set the value of an uniform to an array of float32 (stored as matrices)
  116363. * @param uniform defines the webGL uniform location where to store the value
  116364. * @param matrices defines the array of float32 to store
  116365. * @returns true if the value was set
  116366. */
  116367. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): boolean;
  116368. /**
  116369. * Set the value of an uniform to a matrix (3x3)
  116370. * @param uniform defines the webGL uniform location where to store the value
  116371. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  116372. * @returns true if the value was set
  116373. */
  116374. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): boolean;
  116375. /**
  116376. * Set the value of an uniform to a matrix (2x2)
  116377. * @param uniform defines the webGL uniform location where to store the value
  116378. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  116379. * @returns true if the value was set
  116380. */
  116381. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): boolean;
  116382. /**
  116383. * Set the value of an uniform to a number (float)
  116384. * @param uniform defines the webGL uniform location where to store the value
  116385. * @param value defines the float number to store
  116386. * @returns true if the value was transfered
  116387. */
  116388. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): boolean;
  116389. /**
  116390. * Set the value of an uniform to a vec2
  116391. * @param uniform defines the webGL uniform location where to store the value
  116392. * @param x defines the 1st component of the value
  116393. * @param y defines the 2nd component of the value
  116394. * @returns true if the value was set
  116395. */
  116396. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): boolean;
  116397. /**
  116398. * Set the value of an uniform to a vec3
  116399. * @param uniform defines the webGL uniform location where to store the value
  116400. * @param x defines the 1st component of the value
  116401. * @param y defines the 2nd component of the value
  116402. * @param z defines the 3rd component of the value
  116403. * @returns true if the value was set
  116404. */
  116405. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): boolean;
  116406. /**
  116407. * Set the value of an uniform to a vec4
  116408. * @param uniform defines the webGL uniform location where to store the value
  116409. * @param x defines the 1st component of the value
  116410. * @param y defines the 2nd component of the value
  116411. * @param z defines the 3rd component of the value
  116412. * @param w defines the 4th component of the value
  116413. * @returns true if the value was set
  116414. */
  116415. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): boolean;
  116416. /**
  116417. * Apply all cached states (depth, culling, stencil and alpha)
  116418. */
  116419. applyStates(): void;
  116420. /**
  116421. * Enable or disable color writing
  116422. * @param enable defines the state to set
  116423. */
  116424. setColorWrite(enable: boolean): void;
  116425. /**
  116426. * Gets a boolean indicating if color writing is enabled
  116427. * @returns the current color writing state
  116428. */
  116429. getColorWrite(): boolean;
  116430. /**
  116431. * Gets the depth culling state manager
  116432. */
  116433. get depthCullingState(): DepthCullingState;
  116434. /**
  116435. * Gets the alpha state manager
  116436. */
  116437. get alphaState(): AlphaState;
  116438. /**
  116439. * Gets the stencil state manager
  116440. */
  116441. get stencilState(): StencilState;
  116442. /**
  116443. * Clears the list of texture accessible through engine.
  116444. * This can help preventing texture load conflict due to name collision.
  116445. */
  116446. clearInternalTexturesCache(): void;
  116447. /**
  116448. * Force the entire cache to be cleared
  116449. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  116450. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  116451. */
  116452. wipeCaches(bruteForce?: boolean): void;
  116453. /** @hidden */
  116454. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  116455. min: number;
  116456. mag: number;
  116457. };
  116458. /** @hidden */
  116459. _createTexture(): WebGLTexture;
  116460. /**
  116461. * Usually called from Texture.ts.
  116462. * Passed information to create a WebGLTexture
  116463. * @param url defines a value which contains one of the following:
  116464. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  116465. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  116466. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  116467. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  116468. * @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)
  116469. * @param scene needed for loading to the correct scene
  116470. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  116471. * @param onLoad optional callback to be called upon successful completion
  116472. * @param onError optional callback to be called upon failure
  116473. * @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
  116474. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  116475. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  116476. * @param forcedExtension defines the extension to use to pick the right loader
  116477. * @param mimeType defines an optional mime type
  116478. * @returns a InternalTexture for assignment back into BABYLON.Texture
  116479. */
  116480. 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;
  116481. /**
  116482. * Loads an image as an HTMLImageElement.
  116483. * @param input url string, ArrayBuffer, or Blob to load
  116484. * @param onLoad callback called when the image successfully loads
  116485. * @param onError callback called when the image fails to load
  116486. * @param offlineProvider offline provider for caching
  116487. * @param mimeType optional mime type
  116488. * @returns the HTMLImageElement of the loaded image
  116489. * @hidden
  116490. */
  116491. 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>;
  116492. /**
  116493. * @hidden
  116494. */
  116495. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  116496. private _unpackFlipYCached;
  116497. /**
  116498. * In case you are sharing the context with other applications, it might
  116499. * be interested to not cache the unpack flip y state to ensure a consistent
  116500. * value would be set.
  116501. */
  116502. enableUnpackFlipYCached: boolean;
  116503. /** @hidden */
  116504. _unpackFlipY(value: boolean): void;
  116505. /** @hidden */
  116506. _getUnpackAlignement(): number;
  116507. private _getTextureTarget;
  116508. /**
  116509. * Update the sampling mode of a given texture
  116510. * @param samplingMode defines the required sampling mode
  116511. * @param texture defines the texture to update
  116512. * @param generateMipMaps defines whether to generate mipmaps for the texture
  116513. */
  116514. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  116515. /**
  116516. * Update the sampling mode of a given texture
  116517. * @param texture defines the texture to update
  116518. * @param wrapU defines the texture wrap mode of the u coordinates
  116519. * @param wrapV defines the texture wrap mode of the v coordinates
  116520. * @param wrapR defines the texture wrap mode of the r coordinates
  116521. */
  116522. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  116523. /** @hidden */
  116524. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  116525. width: number;
  116526. height: number;
  116527. layers?: number;
  116528. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  116529. /** @hidden */
  116530. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  116531. /** @hidden */
  116532. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  116533. /**
  116534. * Update a portion of an internal texture
  116535. * @param texture defines the texture to update
  116536. * @param imageData defines the data to store into the texture
  116537. * @param xOffset defines the x coordinates of the update rectangle
  116538. * @param yOffset defines the y coordinates of the update rectangle
  116539. * @param width defines the width of the update rectangle
  116540. * @param height defines the height of the update rectangle
  116541. * @param faceIndex defines the face index if texture is a cube (0 by default)
  116542. * @param lod defines the lod level to update (0 by default)
  116543. */
  116544. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  116545. /** @hidden */
  116546. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  116547. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  116548. private _prepareWebGLTexture;
  116549. /** @hidden */
  116550. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  116551. private _getDepthStencilBuffer;
  116552. /** @hidden */
  116553. _releaseFramebufferObjects(texture: InternalTexture): void;
  116554. /** @hidden */
  116555. _releaseTexture(texture: InternalTexture): void;
  116556. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  116557. protected _setProgram(program: WebGLProgram): void;
  116558. protected _boundUniforms: {
  116559. [key: number]: WebGLUniformLocation;
  116560. };
  116561. /**
  116562. * Binds an effect to the webGL context
  116563. * @param effect defines the effect to bind
  116564. */
  116565. bindSamplers(effect: Effect): void;
  116566. private _activateCurrentTexture;
  116567. /** @hidden */
  116568. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  116569. /** @hidden */
  116570. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  116571. /**
  116572. * Unbind all textures from the webGL context
  116573. */
  116574. unbindAllTextures(): void;
  116575. /**
  116576. * Sets a texture to the according uniform.
  116577. * @param channel The texture channel
  116578. * @param uniform The uniform to set
  116579. * @param texture The texture to apply
  116580. */
  116581. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  116582. private _bindSamplerUniformToChannel;
  116583. private _getTextureWrapMode;
  116584. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  116585. /**
  116586. * Sets an array of texture to the webGL context
  116587. * @param channel defines the channel where the texture array must be set
  116588. * @param uniform defines the associated uniform location
  116589. * @param textures defines the array of textures to bind
  116590. */
  116591. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  116592. /** @hidden */
  116593. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  116594. private _setTextureParameterFloat;
  116595. private _setTextureParameterInteger;
  116596. /**
  116597. * Unbind all vertex attributes from the webGL context
  116598. */
  116599. unbindAllAttributes(): void;
  116600. /**
  116601. * 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
  116602. */
  116603. releaseEffects(): void;
  116604. /**
  116605. * Dispose and release all associated resources
  116606. */
  116607. dispose(): void;
  116608. /**
  116609. * Attach a new callback raised when context lost event is fired
  116610. * @param callback defines the callback to call
  116611. */
  116612. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  116613. /**
  116614. * Attach a new callback raised when context restored event is fired
  116615. * @param callback defines the callback to call
  116616. */
  116617. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  116618. /**
  116619. * Get the current error code of the webGL context
  116620. * @returns the error code
  116621. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  116622. */
  116623. getError(): number;
  116624. private _canRenderToFloatFramebuffer;
  116625. private _canRenderToHalfFloatFramebuffer;
  116626. private _canRenderToFramebuffer;
  116627. /** @hidden */
  116628. _getWebGLTextureType(type: number): number;
  116629. /** @hidden */
  116630. _getInternalFormat(format: number): number;
  116631. /** @hidden */
  116632. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  116633. /** @hidden */
  116634. _getRGBAMultiSampleBufferFormat(type: number): number;
  116635. /** @hidden */
  116636. _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;
  116637. /**
  116638. * Loads a file from a url
  116639. * @param url url to load
  116640. * @param onSuccess callback called when the file successfully loads
  116641. * @param onProgress callback called while file is loading (if the server supports this mode)
  116642. * @param offlineProvider defines the offline provider for caching
  116643. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  116644. * @param onError callback called when the file fails to load
  116645. * @returns a file request object
  116646. * @hidden
  116647. */
  116648. 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;
  116649. /**
  116650. * Reads pixels from the current frame buffer. Please note that this function can be slow
  116651. * @param x defines the x coordinate of the rectangle where pixels must be read
  116652. * @param y defines the y coordinate of the rectangle where pixels must be read
  116653. * @param width defines the width of the rectangle where pixels must be read
  116654. * @param height defines the height of the rectangle where pixels must be read
  116655. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  116656. * @returns a Uint8Array containing RGBA colors
  116657. */
  116658. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  116659. private static _isSupported;
  116660. /**
  116661. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  116662. * @returns true if the engine can be created
  116663. * @ignorenaming
  116664. */
  116665. static isSupported(): boolean;
  116666. /**
  116667. * Find the next highest power of two.
  116668. * @param x Number to start search from.
  116669. * @return Next highest power of two.
  116670. */
  116671. static CeilingPOT(x: number): number;
  116672. /**
  116673. * Find the next lowest power of two.
  116674. * @param x Number to start search from.
  116675. * @return Next lowest power of two.
  116676. */
  116677. static FloorPOT(x: number): number;
  116678. /**
  116679. * Find the nearest power of two.
  116680. * @param x Number to start search from.
  116681. * @return Next nearest power of two.
  116682. */
  116683. static NearestPOT(x: number): number;
  116684. /**
  116685. * Get the closest exponent of two
  116686. * @param value defines the value to approximate
  116687. * @param max defines the maximum value to return
  116688. * @param mode defines how to define the closest value
  116689. * @returns closest exponent of two of the given value
  116690. */
  116691. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  116692. /**
  116693. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  116694. * @param func - the function to be called
  116695. * @param requester - the object that will request the next frame. Falls back to window.
  116696. * @returns frame number
  116697. */
  116698. static QueueNewFrame(func: () => void, requester?: any): number;
  116699. /**
  116700. * Gets host document
  116701. * @returns the host document object
  116702. */
  116703. getHostDocument(): Nullable<Document>;
  116704. }
  116705. }
  116706. declare module BABYLON {
  116707. /**
  116708. * Class representing spherical harmonics coefficients to the 3rd degree
  116709. */
  116710. export class SphericalHarmonics {
  116711. /**
  116712. * Defines whether or not the harmonics have been prescaled for rendering.
  116713. */
  116714. preScaled: boolean;
  116715. /**
  116716. * The l0,0 coefficients of the spherical harmonics
  116717. */
  116718. l00: Vector3;
  116719. /**
  116720. * The l1,-1 coefficients of the spherical harmonics
  116721. */
  116722. l1_1: Vector3;
  116723. /**
  116724. * The l1,0 coefficients of the spherical harmonics
  116725. */
  116726. l10: Vector3;
  116727. /**
  116728. * The l1,1 coefficients of the spherical harmonics
  116729. */
  116730. l11: Vector3;
  116731. /**
  116732. * The l2,-2 coefficients of the spherical harmonics
  116733. */
  116734. l2_2: Vector3;
  116735. /**
  116736. * The l2,-1 coefficients of the spherical harmonics
  116737. */
  116738. l2_1: Vector3;
  116739. /**
  116740. * The l2,0 coefficients of the spherical harmonics
  116741. */
  116742. l20: Vector3;
  116743. /**
  116744. * The l2,1 coefficients of the spherical harmonics
  116745. */
  116746. l21: Vector3;
  116747. /**
  116748. * The l2,2 coefficients of the spherical harmonics
  116749. */
  116750. l22: Vector3;
  116751. /**
  116752. * Adds a light to the spherical harmonics
  116753. * @param direction the direction of the light
  116754. * @param color the color of the light
  116755. * @param deltaSolidAngle the delta solid angle of the light
  116756. */
  116757. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  116758. /**
  116759. * Scales the spherical harmonics by the given amount
  116760. * @param scale the amount to scale
  116761. */
  116762. scaleInPlace(scale: number): void;
  116763. /**
  116764. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  116765. *
  116766. * ```
  116767. * E_lm = A_l * L_lm
  116768. * ```
  116769. *
  116770. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  116771. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  116772. * the scaling factors are given in equation 9.
  116773. */
  116774. convertIncidentRadianceToIrradiance(): void;
  116775. /**
  116776. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  116777. *
  116778. * ```
  116779. * L = (1/pi) * E * rho
  116780. * ```
  116781. *
  116782. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  116783. */
  116784. convertIrradianceToLambertianRadiance(): void;
  116785. /**
  116786. * Integrates the reconstruction coefficients directly in to the SH preventing further
  116787. * required operations at run time.
  116788. *
  116789. * This is simply done by scaling back the SH with Ylm constants parameter.
  116790. * The trigonometric part being applied by the shader at run time.
  116791. */
  116792. preScaleForRendering(): void;
  116793. /**
  116794. * Constructs a spherical harmonics from an array.
  116795. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  116796. * @returns the spherical harmonics
  116797. */
  116798. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  116799. /**
  116800. * Gets the spherical harmonics from polynomial
  116801. * @param polynomial the spherical polynomial
  116802. * @returns the spherical harmonics
  116803. */
  116804. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  116805. }
  116806. /**
  116807. * Class representing spherical polynomial coefficients to the 3rd degree
  116808. */
  116809. export class SphericalPolynomial {
  116810. private _harmonics;
  116811. /**
  116812. * The spherical harmonics used to create the polynomials.
  116813. */
  116814. get preScaledHarmonics(): SphericalHarmonics;
  116815. /**
  116816. * The x coefficients of the spherical polynomial
  116817. */
  116818. x: Vector3;
  116819. /**
  116820. * The y coefficients of the spherical polynomial
  116821. */
  116822. y: Vector3;
  116823. /**
  116824. * The z coefficients of the spherical polynomial
  116825. */
  116826. z: Vector3;
  116827. /**
  116828. * The xx coefficients of the spherical polynomial
  116829. */
  116830. xx: Vector3;
  116831. /**
  116832. * The yy coefficients of the spherical polynomial
  116833. */
  116834. yy: Vector3;
  116835. /**
  116836. * The zz coefficients of the spherical polynomial
  116837. */
  116838. zz: Vector3;
  116839. /**
  116840. * The xy coefficients of the spherical polynomial
  116841. */
  116842. xy: Vector3;
  116843. /**
  116844. * The yz coefficients of the spherical polynomial
  116845. */
  116846. yz: Vector3;
  116847. /**
  116848. * The zx coefficients of the spherical polynomial
  116849. */
  116850. zx: Vector3;
  116851. /**
  116852. * Adds an ambient color to the spherical polynomial
  116853. * @param color the color to add
  116854. */
  116855. addAmbient(color: Color3): void;
  116856. /**
  116857. * Scales the spherical polynomial by the given amount
  116858. * @param scale the amount to scale
  116859. */
  116860. scaleInPlace(scale: number): void;
  116861. /**
  116862. * Gets the spherical polynomial from harmonics
  116863. * @param harmonics the spherical harmonics
  116864. * @returns the spherical polynomial
  116865. */
  116866. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  116867. /**
  116868. * Constructs a spherical polynomial from an array.
  116869. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  116870. * @returns the spherical polynomial
  116871. */
  116872. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  116873. }
  116874. }
  116875. declare module BABYLON {
  116876. /**
  116877. * Defines the source of the internal texture
  116878. */
  116879. export enum InternalTextureSource {
  116880. /**
  116881. * The source of the texture data is unknown
  116882. */
  116883. Unknown = 0,
  116884. /**
  116885. * Texture data comes from an URL
  116886. */
  116887. Url = 1,
  116888. /**
  116889. * Texture data is only used for temporary storage
  116890. */
  116891. Temp = 2,
  116892. /**
  116893. * Texture data comes from raw data (ArrayBuffer)
  116894. */
  116895. Raw = 3,
  116896. /**
  116897. * Texture content is dynamic (video or dynamic texture)
  116898. */
  116899. Dynamic = 4,
  116900. /**
  116901. * Texture content is generated by rendering to it
  116902. */
  116903. RenderTarget = 5,
  116904. /**
  116905. * Texture content is part of a multi render target process
  116906. */
  116907. MultiRenderTarget = 6,
  116908. /**
  116909. * Texture data comes from a cube data file
  116910. */
  116911. Cube = 7,
  116912. /**
  116913. * Texture data comes from a raw cube data
  116914. */
  116915. CubeRaw = 8,
  116916. /**
  116917. * Texture data come from a prefiltered cube data file
  116918. */
  116919. CubePrefiltered = 9,
  116920. /**
  116921. * Texture content is raw 3D data
  116922. */
  116923. Raw3D = 10,
  116924. /**
  116925. * Texture content is raw 2D array data
  116926. */
  116927. Raw2DArray = 11,
  116928. /**
  116929. * Texture content is a depth texture
  116930. */
  116931. Depth = 12,
  116932. /**
  116933. * Texture data comes from a raw cube data encoded with RGBD
  116934. */
  116935. CubeRawRGBD = 13
  116936. }
  116937. /**
  116938. * Class used to store data associated with WebGL texture data for the engine
  116939. * This class should not be used directly
  116940. */
  116941. export class InternalTexture {
  116942. /** @hidden */
  116943. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  116944. /**
  116945. * Defines if the texture is ready
  116946. */
  116947. isReady: boolean;
  116948. /**
  116949. * Defines if the texture is a cube texture
  116950. */
  116951. isCube: boolean;
  116952. /**
  116953. * Defines if the texture contains 3D data
  116954. */
  116955. is3D: boolean;
  116956. /**
  116957. * Defines if the texture contains 2D array data
  116958. */
  116959. is2DArray: boolean;
  116960. /**
  116961. * Defines if the texture contains multiview data
  116962. */
  116963. isMultiview: boolean;
  116964. /**
  116965. * Gets the URL used to load this texture
  116966. */
  116967. url: string;
  116968. /**
  116969. * Gets the sampling mode of the texture
  116970. */
  116971. samplingMode: number;
  116972. /**
  116973. * Gets a boolean indicating if the texture needs mipmaps generation
  116974. */
  116975. generateMipMaps: boolean;
  116976. /**
  116977. * Gets the number of samples used by the texture (WebGL2+ only)
  116978. */
  116979. samples: number;
  116980. /**
  116981. * Gets the type of the texture (int, float...)
  116982. */
  116983. type: number;
  116984. /**
  116985. * Gets the format of the texture (RGB, RGBA...)
  116986. */
  116987. format: number;
  116988. /**
  116989. * Observable called when the texture is loaded
  116990. */
  116991. onLoadedObservable: Observable<InternalTexture>;
  116992. /**
  116993. * Gets the width of the texture
  116994. */
  116995. width: number;
  116996. /**
  116997. * Gets the height of the texture
  116998. */
  116999. height: number;
  117000. /**
  117001. * Gets the depth of the texture
  117002. */
  117003. depth: number;
  117004. /**
  117005. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  117006. */
  117007. baseWidth: number;
  117008. /**
  117009. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  117010. */
  117011. baseHeight: number;
  117012. /**
  117013. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  117014. */
  117015. baseDepth: number;
  117016. /**
  117017. * Gets a boolean indicating if the texture is inverted on Y axis
  117018. */
  117019. invertY: boolean;
  117020. /** @hidden */
  117021. _invertVScale: boolean;
  117022. /** @hidden */
  117023. _associatedChannel: number;
  117024. /** @hidden */
  117025. _source: InternalTextureSource;
  117026. /** @hidden */
  117027. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  117028. /** @hidden */
  117029. _bufferView: Nullable<ArrayBufferView>;
  117030. /** @hidden */
  117031. _bufferViewArray: Nullable<ArrayBufferView[]>;
  117032. /** @hidden */
  117033. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  117034. /** @hidden */
  117035. _size: number;
  117036. /** @hidden */
  117037. _extension: string;
  117038. /** @hidden */
  117039. _files: Nullable<string[]>;
  117040. /** @hidden */
  117041. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  117042. /** @hidden */
  117043. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  117044. /** @hidden */
  117045. _framebuffer: Nullable<WebGLFramebuffer>;
  117046. /** @hidden */
  117047. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  117048. /** @hidden */
  117049. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  117050. /** @hidden */
  117051. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  117052. /** @hidden */
  117053. _attachments: Nullable<number[]>;
  117054. /** @hidden */
  117055. _textureArray: Nullable<InternalTexture[]>;
  117056. /** @hidden */
  117057. _cachedCoordinatesMode: Nullable<number>;
  117058. /** @hidden */
  117059. _cachedWrapU: Nullable<number>;
  117060. /** @hidden */
  117061. _cachedWrapV: Nullable<number>;
  117062. /** @hidden */
  117063. _cachedWrapR: Nullable<number>;
  117064. /** @hidden */
  117065. _cachedAnisotropicFilteringLevel: Nullable<number>;
  117066. /** @hidden */
  117067. _isDisabled: boolean;
  117068. /** @hidden */
  117069. _compression: Nullable<string>;
  117070. /** @hidden */
  117071. _generateStencilBuffer: boolean;
  117072. /** @hidden */
  117073. _generateDepthBuffer: boolean;
  117074. /** @hidden */
  117075. _comparisonFunction: number;
  117076. /** @hidden */
  117077. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  117078. /** @hidden */
  117079. _lodGenerationScale: number;
  117080. /** @hidden */
  117081. _lodGenerationOffset: number;
  117082. /** @hidden */
  117083. _depthStencilTexture: Nullable<InternalTexture>;
  117084. /** @hidden */
  117085. _colorTextureArray: Nullable<WebGLTexture>;
  117086. /** @hidden */
  117087. _depthStencilTextureArray: Nullable<WebGLTexture>;
  117088. /** @hidden */
  117089. _lodTextureHigh: Nullable<BaseTexture>;
  117090. /** @hidden */
  117091. _lodTextureMid: Nullable<BaseTexture>;
  117092. /** @hidden */
  117093. _lodTextureLow: Nullable<BaseTexture>;
  117094. /** @hidden */
  117095. _isRGBD: boolean;
  117096. /** @hidden */
  117097. _linearSpecularLOD: boolean;
  117098. /** @hidden */
  117099. _irradianceTexture: Nullable<BaseTexture>;
  117100. /** @hidden */
  117101. _webGLTexture: Nullable<WebGLTexture>;
  117102. /** @hidden */
  117103. _references: number;
  117104. /** @hidden */
  117105. _gammaSpace: Nullable<boolean>;
  117106. private _engine;
  117107. /**
  117108. * Gets the Engine the texture belongs to.
  117109. * @returns The babylon engine
  117110. */
  117111. getEngine(): ThinEngine;
  117112. /**
  117113. * Gets the data source type of the texture
  117114. */
  117115. get source(): InternalTextureSource;
  117116. /**
  117117. * Creates a new InternalTexture
  117118. * @param engine defines the engine to use
  117119. * @param source defines the type of data that will be used
  117120. * @param delayAllocation if the texture allocation should be delayed (default: false)
  117121. */
  117122. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  117123. /**
  117124. * Increments the number of references (ie. the number of Texture that point to it)
  117125. */
  117126. incrementReferences(): void;
  117127. /**
  117128. * Change the size of the texture (not the size of the content)
  117129. * @param width defines the new width
  117130. * @param height defines the new height
  117131. * @param depth defines the new depth (1 by default)
  117132. */
  117133. updateSize(width: int, height: int, depth?: int): void;
  117134. /** @hidden */
  117135. _rebuild(): void;
  117136. /** @hidden */
  117137. _swapAndDie(target: InternalTexture): void;
  117138. /**
  117139. * Dispose the current allocated resources
  117140. */
  117141. dispose(): void;
  117142. }
  117143. }
  117144. declare module BABYLON {
  117145. /**
  117146. * Class used to work with sound analyzer using fast fourier transform (FFT)
  117147. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  117148. */
  117149. export class Analyser {
  117150. /**
  117151. * Gets or sets the smoothing
  117152. * @ignorenaming
  117153. */
  117154. SMOOTHING: number;
  117155. /**
  117156. * Gets or sets the FFT table size
  117157. * @ignorenaming
  117158. */
  117159. FFT_SIZE: number;
  117160. /**
  117161. * Gets or sets the bar graph amplitude
  117162. * @ignorenaming
  117163. */
  117164. BARGRAPHAMPLITUDE: number;
  117165. /**
  117166. * Gets or sets the position of the debug canvas
  117167. * @ignorenaming
  117168. */
  117169. DEBUGCANVASPOS: {
  117170. x: number;
  117171. y: number;
  117172. };
  117173. /**
  117174. * Gets or sets the debug canvas size
  117175. * @ignorenaming
  117176. */
  117177. DEBUGCANVASSIZE: {
  117178. width: number;
  117179. height: number;
  117180. };
  117181. private _byteFreqs;
  117182. private _byteTime;
  117183. private _floatFreqs;
  117184. private _webAudioAnalyser;
  117185. private _debugCanvas;
  117186. private _debugCanvasContext;
  117187. private _scene;
  117188. private _registerFunc;
  117189. private _audioEngine;
  117190. /**
  117191. * Creates a new analyser
  117192. * @param scene defines hosting scene
  117193. */
  117194. constructor(scene: Scene);
  117195. /**
  117196. * Get the number of data values you will have to play with for the visualization
  117197. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  117198. * @returns a number
  117199. */
  117200. getFrequencyBinCount(): number;
  117201. /**
  117202. * Gets the current frequency data as a byte array
  117203. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  117204. * @returns a Uint8Array
  117205. */
  117206. getByteFrequencyData(): Uint8Array;
  117207. /**
  117208. * Gets the current waveform as a byte array
  117209. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  117210. * @returns a Uint8Array
  117211. */
  117212. getByteTimeDomainData(): Uint8Array;
  117213. /**
  117214. * Gets the current frequency data as a float array
  117215. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  117216. * @returns a Float32Array
  117217. */
  117218. getFloatFrequencyData(): Float32Array;
  117219. /**
  117220. * Renders the debug canvas
  117221. */
  117222. drawDebugCanvas(): void;
  117223. /**
  117224. * Stops rendering the debug canvas and removes it
  117225. */
  117226. stopDebugCanvas(): void;
  117227. /**
  117228. * Connects two audio nodes
  117229. * @param inputAudioNode defines first node to connect
  117230. * @param outputAudioNode defines second node to connect
  117231. */
  117232. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  117233. /**
  117234. * Releases all associated resources
  117235. */
  117236. dispose(): void;
  117237. }
  117238. }
  117239. declare module BABYLON {
  117240. /**
  117241. * This represents an audio engine and it is responsible
  117242. * to play, synchronize and analyse sounds throughout the application.
  117243. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  117244. */
  117245. export interface IAudioEngine extends IDisposable {
  117246. /**
  117247. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  117248. */
  117249. readonly canUseWebAudio: boolean;
  117250. /**
  117251. * Gets the current AudioContext if available.
  117252. */
  117253. readonly audioContext: Nullable<AudioContext>;
  117254. /**
  117255. * The master gain node defines the global audio volume of your audio engine.
  117256. */
  117257. readonly masterGain: GainNode;
  117258. /**
  117259. * Gets whether or not mp3 are supported by your browser.
  117260. */
  117261. readonly isMP3supported: boolean;
  117262. /**
  117263. * Gets whether or not ogg are supported by your browser.
  117264. */
  117265. readonly isOGGsupported: boolean;
  117266. /**
  117267. * Defines if Babylon should emit a warning if WebAudio is not supported.
  117268. * @ignoreNaming
  117269. */
  117270. WarnedWebAudioUnsupported: boolean;
  117271. /**
  117272. * Defines if the audio engine relies on a custom unlocked button.
  117273. * In this case, the embedded button will not be displayed.
  117274. */
  117275. useCustomUnlockedButton: boolean;
  117276. /**
  117277. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  117278. */
  117279. readonly unlocked: boolean;
  117280. /**
  117281. * Event raised when audio has been unlocked on the browser.
  117282. */
  117283. onAudioUnlockedObservable: Observable<AudioEngine>;
  117284. /**
  117285. * Event raised when audio has been locked on the browser.
  117286. */
  117287. onAudioLockedObservable: Observable<AudioEngine>;
  117288. /**
  117289. * Flags the audio engine in Locked state.
  117290. * This happens due to new browser policies preventing audio to autoplay.
  117291. */
  117292. lock(): void;
  117293. /**
  117294. * Unlocks the audio engine once a user action has been done on the dom.
  117295. * This is helpful to resume play once browser policies have been satisfied.
  117296. */
  117297. unlock(): void;
  117298. /**
  117299. * Gets the global volume sets on the master gain.
  117300. * @returns the global volume if set or -1 otherwise
  117301. */
  117302. getGlobalVolume(): number;
  117303. /**
  117304. * Sets the global volume of your experience (sets on the master gain).
  117305. * @param newVolume Defines the new global volume of the application
  117306. */
  117307. setGlobalVolume(newVolume: number): void;
  117308. /**
  117309. * Connect the audio engine to an audio analyser allowing some amazing
  117310. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  117311. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  117312. * @param analyser The analyser to connect to the engine
  117313. */
  117314. connectToAnalyser(analyser: Analyser): void;
  117315. }
  117316. /**
  117317. * This represents the default audio engine used in babylon.
  117318. * It is responsible to play, synchronize and analyse sounds throughout the application.
  117319. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  117320. */
  117321. export class AudioEngine implements IAudioEngine {
  117322. private _audioContext;
  117323. private _audioContextInitialized;
  117324. private _muteButton;
  117325. private _hostElement;
  117326. /**
  117327. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  117328. */
  117329. canUseWebAudio: boolean;
  117330. /**
  117331. * The master gain node defines the global audio volume of your audio engine.
  117332. */
  117333. masterGain: GainNode;
  117334. /**
  117335. * Defines if Babylon should emit a warning if WebAudio is not supported.
  117336. * @ignoreNaming
  117337. */
  117338. WarnedWebAudioUnsupported: boolean;
  117339. /**
  117340. * Gets whether or not mp3 are supported by your browser.
  117341. */
  117342. isMP3supported: boolean;
  117343. /**
  117344. * Gets whether or not ogg are supported by your browser.
  117345. */
  117346. isOGGsupported: boolean;
  117347. /**
  117348. * Gets whether audio has been unlocked on the device.
  117349. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  117350. * a user interaction has happened.
  117351. */
  117352. unlocked: boolean;
  117353. /**
  117354. * Defines if the audio engine relies on a custom unlocked button.
  117355. * In this case, the embedded button will not be displayed.
  117356. */
  117357. useCustomUnlockedButton: boolean;
  117358. /**
  117359. * Event raised when audio has been unlocked on the browser.
  117360. */
  117361. onAudioUnlockedObservable: Observable<AudioEngine>;
  117362. /**
  117363. * Event raised when audio has been locked on the browser.
  117364. */
  117365. onAudioLockedObservable: Observable<AudioEngine>;
  117366. /**
  117367. * Gets the current AudioContext if available.
  117368. */
  117369. get audioContext(): Nullable<AudioContext>;
  117370. private _connectedAnalyser;
  117371. /**
  117372. * Instantiates a new audio engine.
  117373. *
  117374. * There should be only one per page as some browsers restrict the number
  117375. * of audio contexts you can create.
  117376. * @param hostElement defines the host element where to display the mute icon if necessary
  117377. */
  117378. constructor(hostElement?: Nullable<HTMLElement>);
  117379. /**
  117380. * Flags the audio engine in Locked state.
  117381. * This happens due to new browser policies preventing audio to autoplay.
  117382. */
  117383. lock(): void;
  117384. /**
  117385. * Unlocks the audio engine once a user action has been done on the dom.
  117386. * This is helpful to resume play once browser policies have been satisfied.
  117387. */
  117388. unlock(): void;
  117389. private _resumeAudioContext;
  117390. private _initializeAudioContext;
  117391. private _tryToRun;
  117392. private _triggerRunningState;
  117393. private _triggerSuspendedState;
  117394. private _displayMuteButton;
  117395. private _moveButtonToTopLeft;
  117396. private _onResize;
  117397. private _hideMuteButton;
  117398. /**
  117399. * Destroy and release the resources associated with the audio ccontext.
  117400. */
  117401. dispose(): void;
  117402. /**
  117403. * Gets the global volume sets on the master gain.
  117404. * @returns the global volume if set or -1 otherwise
  117405. */
  117406. getGlobalVolume(): number;
  117407. /**
  117408. * Sets the global volume of your experience (sets on the master gain).
  117409. * @param newVolume Defines the new global volume of the application
  117410. */
  117411. setGlobalVolume(newVolume: number): void;
  117412. /**
  117413. * Connect the audio engine to an audio analyser allowing some amazing
  117414. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  117415. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  117416. * @param analyser The analyser to connect to the engine
  117417. */
  117418. connectToAnalyser(analyser: Analyser): void;
  117419. }
  117420. }
  117421. declare module BABYLON {
  117422. /**
  117423. * Interface used to present a loading screen while loading a scene
  117424. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117425. */
  117426. export interface ILoadingScreen {
  117427. /**
  117428. * Function called to display the loading screen
  117429. */
  117430. displayLoadingUI: () => void;
  117431. /**
  117432. * Function called to hide the loading screen
  117433. */
  117434. hideLoadingUI: () => void;
  117435. /**
  117436. * Gets or sets the color to use for the background
  117437. */
  117438. loadingUIBackgroundColor: string;
  117439. /**
  117440. * Gets or sets the text to display while loading
  117441. */
  117442. loadingUIText: string;
  117443. }
  117444. /**
  117445. * Class used for the default loading screen
  117446. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117447. */
  117448. export class DefaultLoadingScreen implements ILoadingScreen {
  117449. private _renderingCanvas;
  117450. private _loadingText;
  117451. private _loadingDivBackgroundColor;
  117452. private _loadingDiv;
  117453. private _loadingTextDiv;
  117454. /** Gets or sets the logo url to use for the default loading screen */
  117455. static DefaultLogoUrl: string;
  117456. /** Gets or sets the spinner url to use for the default loading screen */
  117457. static DefaultSpinnerUrl: string;
  117458. /**
  117459. * Creates a new default loading screen
  117460. * @param _renderingCanvas defines the canvas used to render the scene
  117461. * @param _loadingText defines the default text to display
  117462. * @param _loadingDivBackgroundColor defines the default background color
  117463. */
  117464. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  117465. /**
  117466. * Function called to display the loading screen
  117467. */
  117468. displayLoadingUI(): void;
  117469. /**
  117470. * Function called to hide the loading screen
  117471. */
  117472. hideLoadingUI(): void;
  117473. /**
  117474. * Gets or sets the text to display while loading
  117475. */
  117476. set loadingUIText(text: string);
  117477. get loadingUIText(): string;
  117478. /**
  117479. * Gets or sets the color to use for the background
  117480. */
  117481. get loadingUIBackgroundColor(): string;
  117482. set loadingUIBackgroundColor(color: string);
  117483. private _resizeLoadingUI;
  117484. }
  117485. }
  117486. declare module BABYLON {
  117487. /**
  117488. * Interface for any object that can request an animation frame
  117489. */
  117490. export interface ICustomAnimationFrameRequester {
  117491. /**
  117492. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  117493. */
  117494. renderFunction?: Function;
  117495. /**
  117496. * Called to request the next frame to render to
  117497. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  117498. */
  117499. requestAnimationFrame: Function;
  117500. /**
  117501. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  117502. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  117503. */
  117504. requestID?: number;
  117505. }
  117506. }
  117507. declare module BABYLON {
  117508. /**
  117509. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  117510. */
  117511. export class PerformanceMonitor {
  117512. private _enabled;
  117513. private _rollingFrameTime;
  117514. private _lastFrameTimeMs;
  117515. /**
  117516. * constructor
  117517. * @param frameSampleSize The number of samples required to saturate the sliding window
  117518. */
  117519. constructor(frameSampleSize?: number);
  117520. /**
  117521. * Samples current frame
  117522. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  117523. */
  117524. sampleFrame(timeMs?: number): void;
  117525. /**
  117526. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  117527. */
  117528. get averageFrameTime(): number;
  117529. /**
  117530. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  117531. */
  117532. get averageFrameTimeVariance(): number;
  117533. /**
  117534. * Returns the frame time of the most recent frame
  117535. */
  117536. get instantaneousFrameTime(): number;
  117537. /**
  117538. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  117539. */
  117540. get averageFPS(): number;
  117541. /**
  117542. * Returns the average framerate in frames per second using the most recent frame time
  117543. */
  117544. get instantaneousFPS(): number;
  117545. /**
  117546. * Returns true if enough samples have been taken to completely fill the sliding window
  117547. */
  117548. get isSaturated(): boolean;
  117549. /**
  117550. * Enables contributions to the sliding window sample set
  117551. */
  117552. enable(): void;
  117553. /**
  117554. * Disables contributions to the sliding window sample set
  117555. * Samples will not be interpolated over the disabled period
  117556. */
  117557. disable(): void;
  117558. /**
  117559. * Returns true if sampling is enabled
  117560. */
  117561. get isEnabled(): boolean;
  117562. /**
  117563. * Resets performance monitor
  117564. */
  117565. reset(): void;
  117566. }
  117567. /**
  117568. * RollingAverage
  117569. *
  117570. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  117571. */
  117572. export class RollingAverage {
  117573. /**
  117574. * Current average
  117575. */
  117576. average: number;
  117577. /**
  117578. * Current variance
  117579. */
  117580. variance: number;
  117581. protected _samples: Array<number>;
  117582. protected _sampleCount: number;
  117583. protected _pos: number;
  117584. protected _m2: number;
  117585. /**
  117586. * constructor
  117587. * @param length The number of samples required to saturate the sliding window
  117588. */
  117589. constructor(length: number);
  117590. /**
  117591. * Adds a sample to the sample set
  117592. * @param v The sample value
  117593. */
  117594. add(v: number): void;
  117595. /**
  117596. * Returns previously added values or null if outside of history or outside the sliding window domain
  117597. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  117598. * @return Value previously recorded with add() or null if outside of range
  117599. */
  117600. history(i: number): number;
  117601. /**
  117602. * Returns true if enough samples have been taken to completely fill the sliding window
  117603. * @return true if sample-set saturated
  117604. */
  117605. isSaturated(): boolean;
  117606. /**
  117607. * Resets the rolling average (equivalent to 0 samples taken so far)
  117608. */
  117609. reset(): void;
  117610. /**
  117611. * Wraps a value around the sample range boundaries
  117612. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  117613. * @return Wrapped position in sample range
  117614. */
  117615. protected _wrapPosition(i: number): number;
  117616. }
  117617. }
  117618. declare module BABYLON {
  117619. /**
  117620. * This class is used to track a performance counter which is number based.
  117621. * The user has access to many properties which give statistics of different nature.
  117622. *
  117623. * The implementer can track two kinds of Performance Counter: time and count.
  117624. * 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.
  117625. * 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.
  117626. */
  117627. export class PerfCounter {
  117628. /**
  117629. * Gets or sets a global boolean to turn on and off all the counters
  117630. */
  117631. static Enabled: boolean;
  117632. /**
  117633. * Returns the smallest value ever
  117634. */
  117635. get min(): number;
  117636. /**
  117637. * Returns the biggest value ever
  117638. */
  117639. get max(): number;
  117640. /**
  117641. * Returns the average value since the performance counter is running
  117642. */
  117643. get average(): number;
  117644. /**
  117645. * Returns the average value of the last second the counter was monitored
  117646. */
  117647. get lastSecAverage(): number;
  117648. /**
  117649. * Returns the current value
  117650. */
  117651. get current(): number;
  117652. /**
  117653. * Gets the accumulated total
  117654. */
  117655. get total(): number;
  117656. /**
  117657. * Gets the total value count
  117658. */
  117659. get count(): number;
  117660. /**
  117661. * Creates a new counter
  117662. */
  117663. constructor();
  117664. /**
  117665. * Call this method to start monitoring a new frame.
  117666. * 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.
  117667. */
  117668. fetchNewFrame(): void;
  117669. /**
  117670. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  117671. * @param newCount the count value to add to the monitored count
  117672. * @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.
  117673. */
  117674. addCount(newCount: number, fetchResult: boolean): void;
  117675. /**
  117676. * Start monitoring this performance counter
  117677. */
  117678. beginMonitoring(): void;
  117679. /**
  117680. * Compute the time lapsed since the previous beginMonitoring() call.
  117681. * @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
  117682. */
  117683. endMonitoring(newFrame?: boolean): void;
  117684. private _fetchResult;
  117685. private _startMonitoringTime;
  117686. private _min;
  117687. private _max;
  117688. private _average;
  117689. private _current;
  117690. private _totalValueCount;
  117691. private _totalAccumulated;
  117692. private _lastSecAverage;
  117693. private _lastSecAccumulated;
  117694. private _lastSecTime;
  117695. private _lastSecValueCount;
  117696. }
  117697. }
  117698. declare module BABYLON {
  117699. interface ThinEngine {
  117700. /** @hidden */
  117701. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  117702. }
  117703. }
  117704. declare module BABYLON {
  117705. /**
  117706. * Defines the interface used by display changed events
  117707. */
  117708. export interface IDisplayChangedEventArgs {
  117709. /** Gets the vrDisplay object (if any) */
  117710. vrDisplay: Nullable<any>;
  117711. /** Gets a boolean indicating if webVR is supported */
  117712. vrSupported: boolean;
  117713. }
  117714. /**
  117715. * Defines the interface used by objects containing a viewport (like a camera)
  117716. */
  117717. interface IViewportOwnerLike {
  117718. /**
  117719. * Gets or sets the viewport
  117720. */
  117721. viewport: IViewportLike;
  117722. }
  117723. /**
  117724. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  117725. */
  117726. export class Engine extends ThinEngine {
  117727. /** Defines that alpha blending is disabled */
  117728. static readonly ALPHA_DISABLE: number;
  117729. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  117730. static readonly ALPHA_ADD: number;
  117731. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  117732. static readonly ALPHA_COMBINE: number;
  117733. /** Defines that alpha blending to DEST - SRC * DEST */
  117734. static readonly ALPHA_SUBTRACT: number;
  117735. /** Defines that alpha blending to SRC * DEST */
  117736. static readonly ALPHA_MULTIPLY: number;
  117737. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  117738. static readonly ALPHA_MAXIMIZED: number;
  117739. /** Defines that alpha blending to SRC + DEST */
  117740. static readonly ALPHA_ONEONE: number;
  117741. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  117742. static readonly ALPHA_PREMULTIPLIED: number;
  117743. /**
  117744. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  117745. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  117746. */
  117747. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  117748. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  117749. static readonly ALPHA_INTERPOLATE: number;
  117750. /**
  117751. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  117752. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  117753. */
  117754. static readonly ALPHA_SCREENMODE: number;
  117755. /** Defines that the ressource is not delayed*/
  117756. static readonly DELAYLOADSTATE_NONE: number;
  117757. /** Defines that the ressource was successfully delay loaded */
  117758. static readonly DELAYLOADSTATE_LOADED: number;
  117759. /** Defines that the ressource is currently delay loading */
  117760. static readonly DELAYLOADSTATE_LOADING: number;
  117761. /** Defines that the ressource is delayed and has not started loading */
  117762. static readonly DELAYLOADSTATE_NOTLOADED: number;
  117763. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  117764. static readonly NEVER: number;
  117765. /** 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 */
  117766. static readonly ALWAYS: number;
  117767. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  117768. static readonly LESS: number;
  117769. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  117770. static readonly EQUAL: number;
  117771. /** 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 */
  117772. static readonly LEQUAL: number;
  117773. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  117774. static readonly GREATER: number;
  117775. /** 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 */
  117776. static readonly GEQUAL: number;
  117777. /** 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 */
  117778. static readonly NOTEQUAL: number;
  117779. /** Passed to stencilOperation to specify that stencil value must be kept */
  117780. static readonly KEEP: number;
  117781. /** Passed to stencilOperation to specify that stencil value must be replaced */
  117782. static readonly REPLACE: number;
  117783. /** Passed to stencilOperation to specify that stencil value must be incremented */
  117784. static readonly INCR: number;
  117785. /** Passed to stencilOperation to specify that stencil value must be decremented */
  117786. static readonly DECR: number;
  117787. /** Passed to stencilOperation to specify that stencil value must be inverted */
  117788. static readonly INVERT: number;
  117789. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  117790. static readonly INCR_WRAP: number;
  117791. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  117792. static readonly DECR_WRAP: number;
  117793. /** Texture is not repeating outside of 0..1 UVs */
  117794. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  117795. /** Texture is repeating outside of 0..1 UVs */
  117796. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  117797. /** Texture is repeating and mirrored */
  117798. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  117799. /** ALPHA */
  117800. static readonly TEXTUREFORMAT_ALPHA: number;
  117801. /** LUMINANCE */
  117802. static readonly TEXTUREFORMAT_LUMINANCE: number;
  117803. /** LUMINANCE_ALPHA */
  117804. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  117805. /** RGB */
  117806. static readonly TEXTUREFORMAT_RGB: number;
  117807. /** RGBA */
  117808. static readonly TEXTUREFORMAT_RGBA: number;
  117809. /** RED */
  117810. static readonly TEXTUREFORMAT_RED: number;
  117811. /** RED (2nd reference) */
  117812. static readonly TEXTUREFORMAT_R: number;
  117813. /** RG */
  117814. static readonly TEXTUREFORMAT_RG: number;
  117815. /** RED_INTEGER */
  117816. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  117817. /** RED_INTEGER (2nd reference) */
  117818. static readonly TEXTUREFORMAT_R_INTEGER: number;
  117819. /** RG_INTEGER */
  117820. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  117821. /** RGB_INTEGER */
  117822. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  117823. /** RGBA_INTEGER */
  117824. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  117825. /** UNSIGNED_BYTE */
  117826. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  117827. /** UNSIGNED_BYTE (2nd reference) */
  117828. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  117829. /** FLOAT */
  117830. static readonly TEXTURETYPE_FLOAT: number;
  117831. /** HALF_FLOAT */
  117832. static readonly TEXTURETYPE_HALF_FLOAT: number;
  117833. /** BYTE */
  117834. static readonly TEXTURETYPE_BYTE: number;
  117835. /** SHORT */
  117836. static readonly TEXTURETYPE_SHORT: number;
  117837. /** UNSIGNED_SHORT */
  117838. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  117839. /** INT */
  117840. static readonly TEXTURETYPE_INT: number;
  117841. /** UNSIGNED_INT */
  117842. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  117843. /** UNSIGNED_SHORT_4_4_4_4 */
  117844. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  117845. /** UNSIGNED_SHORT_5_5_5_1 */
  117846. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  117847. /** UNSIGNED_SHORT_5_6_5 */
  117848. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  117849. /** UNSIGNED_INT_2_10_10_10_REV */
  117850. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  117851. /** UNSIGNED_INT_24_8 */
  117852. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  117853. /** UNSIGNED_INT_10F_11F_11F_REV */
  117854. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  117855. /** UNSIGNED_INT_5_9_9_9_REV */
  117856. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  117857. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  117858. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  117859. /** nearest is mag = nearest and min = nearest and mip = linear */
  117860. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  117861. /** Bilinear is mag = linear and min = linear and mip = nearest */
  117862. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  117863. /** Trilinear is mag = linear and min = linear and mip = linear */
  117864. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  117865. /** nearest is mag = nearest and min = nearest and mip = linear */
  117866. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  117867. /** Bilinear is mag = linear and min = linear and mip = nearest */
  117868. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  117869. /** Trilinear is mag = linear and min = linear and mip = linear */
  117870. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  117871. /** mag = nearest and min = nearest and mip = nearest */
  117872. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  117873. /** mag = nearest and min = linear and mip = nearest */
  117874. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  117875. /** mag = nearest and min = linear and mip = linear */
  117876. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  117877. /** mag = nearest and min = linear and mip = none */
  117878. static readonly TEXTURE_NEAREST_LINEAR: number;
  117879. /** mag = nearest and min = nearest and mip = none */
  117880. static readonly TEXTURE_NEAREST_NEAREST: number;
  117881. /** mag = linear and min = nearest and mip = nearest */
  117882. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  117883. /** mag = linear and min = nearest and mip = linear */
  117884. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  117885. /** mag = linear and min = linear and mip = none */
  117886. static readonly TEXTURE_LINEAR_LINEAR: number;
  117887. /** mag = linear and min = nearest and mip = none */
  117888. static readonly TEXTURE_LINEAR_NEAREST: number;
  117889. /** Explicit coordinates mode */
  117890. static readonly TEXTURE_EXPLICIT_MODE: number;
  117891. /** Spherical coordinates mode */
  117892. static readonly TEXTURE_SPHERICAL_MODE: number;
  117893. /** Planar coordinates mode */
  117894. static readonly TEXTURE_PLANAR_MODE: number;
  117895. /** Cubic coordinates mode */
  117896. static readonly TEXTURE_CUBIC_MODE: number;
  117897. /** Projection coordinates mode */
  117898. static readonly TEXTURE_PROJECTION_MODE: number;
  117899. /** Skybox coordinates mode */
  117900. static readonly TEXTURE_SKYBOX_MODE: number;
  117901. /** Inverse Cubic coordinates mode */
  117902. static readonly TEXTURE_INVCUBIC_MODE: number;
  117903. /** Equirectangular coordinates mode */
  117904. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  117905. /** Equirectangular Fixed coordinates mode */
  117906. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  117907. /** Equirectangular Fixed Mirrored coordinates mode */
  117908. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  117909. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  117910. static readonly SCALEMODE_FLOOR: number;
  117911. /** Defines that texture rescaling will look for the nearest power of 2 size */
  117912. static readonly SCALEMODE_NEAREST: number;
  117913. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  117914. static readonly SCALEMODE_CEILING: number;
  117915. /**
  117916. * Returns the current npm package of the sdk
  117917. */
  117918. static get NpmPackage(): string;
  117919. /**
  117920. * Returns the current version of the framework
  117921. */
  117922. static get Version(): string;
  117923. /** Gets the list of created engines */
  117924. static get Instances(): Engine[];
  117925. /**
  117926. * Gets the latest created engine
  117927. */
  117928. static get LastCreatedEngine(): Nullable<Engine>;
  117929. /**
  117930. * Gets the latest created scene
  117931. */
  117932. static get LastCreatedScene(): Nullable<Scene>;
  117933. /**
  117934. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  117935. * @param flag defines which part of the materials must be marked as dirty
  117936. * @param predicate defines a predicate used to filter which materials should be affected
  117937. */
  117938. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  117939. /**
  117940. * Method called to create the default loading screen.
  117941. * This can be overriden in your own app.
  117942. * @param canvas The rendering canvas element
  117943. * @returns The loading screen
  117944. */
  117945. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  117946. /**
  117947. * Method called to create the default rescale post process on each engine.
  117948. */
  117949. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  117950. /**
  117951. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  117952. **/
  117953. enableOfflineSupport: boolean;
  117954. /**
  117955. * 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)
  117956. **/
  117957. disableManifestCheck: boolean;
  117958. /**
  117959. * Gets the list of created scenes
  117960. */
  117961. scenes: Scene[];
  117962. /**
  117963. * Event raised when a new scene is created
  117964. */
  117965. onNewSceneAddedObservable: Observable<Scene>;
  117966. /**
  117967. * Gets the list of created postprocesses
  117968. */
  117969. postProcesses: PostProcess[];
  117970. /**
  117971. * Gets a boolean indicating if the pointer is currently locked
  117972. */
  117973. isPointerLock: boolean;
  117974. /**
  117975. * Observable event triggered each time the rendering canvas is resized
  117976. */
  117977. onResizeObservable: Observable<Engine>;
  117978. /**
  117979. * Observable event triggered each time the canvas loses focus
  117980. */
  117981. onCanvasBlurObservable: Observable<Engine>;
  117982. /**
  117983. * Observable event triggered each time the canvas gains focus
  117984. */
  117985. onCanvasFocusObservable: Observable<Engine>;
  117986. /**
  117987. * Observable event triggered each time the canvas receives pointerout event
  117988. */
  117989. onCanvasPointerOutObservable: Observable<PointerEvent>;
  117990. /**
  117991. * Observable raised when the engine begins a new frame
  117992. */
  117993. onBeginFrameObservable: Observable<Engine>;
  117994. /**
  117995. * If set, will be used to request the next animation frame for the render loop
  117996. */
  117997. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  117998. /**
  117999. * Observable raised when the engine ends the current frame
  118000. */
  118001. onEndFrameObservable: Observable<Engine>;
  118002. /**
  118003. * Observable raised when the engine is about to compile a shader
  118004. */
  118005. onBeforeShaderCompilationObservable: Observable<Engine>;
  118006. /**
  118007. * Observable raised when the engine has jsut compiled a shader
  118008. */
  118009. onAfterShaderCompilationObservable: Observable<Engine>;
  118010. /**
  118011. * Gets the audio engine
  118012. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  118013. * @ignorenaming
  118014. */
  118015. static audioEngine: IAudioEngine;
  118016. /**
  118017. * Default AudioEngine factory responsible of creating the Audio Engine.
  118018. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  118019. */
  118020. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  118021. /**
  118022. * Default offline support factory responsible of creating a tool used to store data locally.
  118023. * By default, this will create a Database object if the workload has been embedded.
  118024. */
  118025. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  118026. private _loadingScreen;
  118027. private _pointerLockRequested;
  118028. private _rescalePostProcess;
  118029. private _deterministicLockstep;
  118030. private _lockstepMaxSteps;
  118031. private _timeStep;
  118032. protected get _supportsHardwareTextureRescaling(): boolean;
  118033. private _fps;
  118034. private _deltaTime;
  118035. /** @hidden */
  118036. _drawCalls: PerfCounter;
  118037. /** 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 */
  118038. canvasTabIndex: number;
  118039. /**
  118040. * Turn this value on if you want to pause FPS computation when in background
  118041. */
  118042. disablePerformanceMonitorInBackground: boolean;
  118043. private _performanceMonitor;
  118044. /**
  118045. * Gets the performance monitor attached to this engine
  118046. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  118047. */
  118048. get performanceMonitor(): PerformanceMonitor;
  118049. private _onFocus;
  118050. private _onBlur;
  118051. private _onCanvasPointerOut;
  118052. private _onCanvasBlur;
  118053. private _onCanvasFocus;
  118054. private _onFullscreenChange;
  118055. private _onPointerLockChange;
  118056. /**
  118057. * Gets the HTML element used to attach event listeners
  118058. * @returns a HTML element
  118059. */
  118060. getInputElement(): Nullable<HTMLElement>;
  118061. /**
  118062. * Creates a new engine
  118063. * @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
  118064. * @param antialias defines enable antialiasing (default: false)
  118065. * @param options defines further options to be sent to the getContext() function
  118066. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  118067. */
  118068. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  118069. /**
  118070. * Gets current aspect ratio
  118071. * @param viewportOwner defines the camera to use to get the aspect ratio
  118072. * @param useScreen defines if screen size must be used (or the current render target if any)
  118073. * @returns a number defining the aspect ratio
  118074. */
  118075. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  118076. /**
  118077. * Gets current screen aspect ratio
  118078. * @returns a number defining the aspect ratio
  118079. */
  118080. getScreenAspectRatio(): number;
  118081. /**
  118082. * Gets the client rect of the HTML canvas attached with the current webGL context
  118083. * @returns a client rectanglee
  118084. */
  118085. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  118086. /**
  118087. * Gets the client rect of the HTML element used for events
  118088. * @returns a client rectanglee
  118089. */
  118090. getInputElementClientRect(): Nullable<ClientRect>;
  118091. /**
  118092. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  118093. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118094. * @returns true if engine is in deterministic lock step mode
  118095. */
  118096. isDeterministicLockStep(): boolean;
  118097. /**
  118098. * Gets the max steps when engine is running in deterministic lock step
  118099. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118100. * @returns the max steps
  118101. */
  118102. getLockstepMaxSteps(): number;
  118103. /**
  118104. * Returns the time in ms between steps when using deterministic lock step.
  118105. * @returns time step in (ms)
  118106. */
  118107. getTimeStep(): number;
  118108. /**
  118109. * Force the mipmap generation for the given render target texture
  118110. * @param texture defines the render target texture to use
  118111. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  118112. */
  118113. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  118114. /** States */
  118115. /**
  118116. * Set various states to the webGL context
  118117. * @param culling defines backface culling state
  118118. * @param zOffset defines the value to apply to zOffset (0 by default)
  118119. * @param force defines if states must be applied even if cache is up to date
  118120. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  118121. */
  118122. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  118123. /**
  118124. * Set the z offset to apply to current rendering
  118125. * @param value defines the offset to apply
  118126. */
  118127. setZOffset(value: number): void;
  118128. /**
  118129. * Gets the current value of the zOffset
  118130. * @returns the current zOffset state
  118131. */
  118132. getZOffset(): number;
  118133. /**
  118134. * Enable or disable depth buffering
  118135. * @param enable defines the state to set
  118136. */
  118137. setDepthBuffer(enable: boolean): void;
  118138. /**
  118139. * Gets a boolean indicating if depth writing is enabled
  118140. * @returns the current depth writing state
  118141. */
  118142. getDepthWrite(): boolean;
  118143. /**
  118144. * Enable or disable depth writing
  118145. * @param enable defines the state to set
  118146. */
  118147. setDepthWrite(enable: boolean): void;
  118148. /**
  118149. * Gets a boolean indicating if stencil buffer is enabled
  118150. * @returns the current stencil buffer state
  118151. */
  118152. getStencilBuffer(): boolean;
  118153. /**
  118154. * Enable or disable the stencil buffer
  118155. * @param enable defines if the stencil buffer must be enabled or disabled
  118156. */
  118157. setStencilBuffer(enable: boolean): void;
  118158. /**
  118159. * Gets the current stencil mask
  118160. * @returns a number defining the new stencil mask to use
  118161. */
  118162. getStencilMask(): number;
  118163. /**
  118164. * Sets the current stencil mask
  118165. * @param mask defines the new stencil mask to use
  118166. */
  118167. setStencilMask(mask: number): void;
  118168. /**
  118169. * Gets the current stencil function
  118170. * @returns a number defining the stencil function to use
  118171. */
  118172. getStencilFunction(): number;
  118173. /**
  118174. * Gets the current stencil reference value
  118175. * @returns a number defining the stencil reference value to use
  118176. */
  118177. getStencilFunctionReference(): number;
  118178. /**
  118179. * Gets the current stencil mask
  118180. * @returns a number defining the stencil mask to use
  118181. */
  118182. getStencilFunctionMask(): number;
  118183. /**
  118184. * Sets the current stencil function
  118185. * @param stencilFunc defines the new stencil function to use
  118186. */
  118187. setStencilFunction(stencilFunc: number): void;
  118188. /**
  118189. * Sets the current stencil reference
  118190. * @param reference defines the new stencil reference to use
  118191. */
  118192. setStencilFunctionReference(reference: number): void;
  118193. /**
  118194. * Sets the current stencil mask
  118195. * @param mask defines the new stencil mask to use
  118196. */
  118197. setStencilFunctionMask(mask: number): void;
  118198. /**
  118199. * Gets the current stencil operation when stencil fails
  118200. * @returns a number defining stencil operation to use when stencil fails
  118201. */
  118202. getStencilOperationFail(): number;
  118203. /**
  118204. * Gets the current stencil operation when depth fails
  118205. * @returns a number defining stencil operation to use when depth fails
  118206. */
  118207. getStencilOperationDepthFail(): number;
  118208. /**
  118209. * Gets the current stencil operation when stencil passes
  118210. * @returns a number defining stencil operation to use when stencil passes
  118211. */
  118212. getStencilOperationPass(): number;
  118213. /**
  118214. * Sets the stencil operation to use when stencil fails
  118215. * @param operation defines the stencil operation to use when stencil fails
  118216. */
  118217. setStencilOperationFail(operation: number): void;
  118218. /**
  118219. * Sets the stencil operation to use when depth fails
  118220. * @param operation defines the stencil operation to use when depth fails
  118221. */
  118222. setStencilOperationDepthFail(operation: number): void;
  118223. /**
  118224. * Sets the stencil operation to use when stencil passes
  118225. * @param operation defines the stencil operation to use when stencil passes
  118226. */
  118227. setStencilOperationPass(operation: number): void;
  118228. /**
  118229. * Sets a boolean indicating if the dithering state is enabled or disabled
  118230. * @param value defines the dithering state
  118231. */
  118232. setDitheringState(value: boolean): void;
  118233. /**
  118234. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  118235. * @param value defines the rasterizer state
  118236. */
  118237. setRasterizerState(value: boolean): void;
  118238. /**
  118239. * Gets the current depth function
  118240. * @returns a number defining the depth function
  118241. */
  118242. getDepthFunction(): Nullable<number>;
  118243. /**
  118244. * Sets the current depth function
  118245. * @param depthFunc defines the function to use
  118246. */
  118247. setDepthFunction(depthFunc: number): void;
  118248. /**
  118249. * Sets the current depth function to GREATER
  118250. */
  118251. setDepthFunctionToGreater(): void;
  118252. /**
  118253. * Sets the current depth function to GEQUAL
  118254. */
  118255. setDepthFunctionToGreaterOrEqual(): void;
  118256. /**
  118257. * Sets the current depth function to LESS
  118258. */
  118259. setDepthFunctionToLess(): void;
  118260. /**
  118261. * Sets the current depth function to LEQUAL
  118262. */
  118263. setDepthFunctionToLessOrEqual(): void;
  118264. private _cachedStencilBuffer;
  118265. private _cachedStencilFunction;
  118266. private _cachedStencilMask;
  118267. private _cachedStencilOperationPass;
  118268. private _cachedStencilOperationFail;
  118269. private _cachedStencilOperationDepthFail;
  118270. private _cachedStencilReference;
  118271. /**
  118272. * Caches the the state of the stencil buffer
  118273. */
  118274. cacheStencilState(): void;
  118275. /**
  118276. * Restores the state of the stencil buffer
  118277. */
  118278. restoreStencilState(): void;
  118279. /**
  118280. * Directly set the WebGL Viewport
  118281. * @param x defines the x coordinate of the viewport (in screen space)
  118282. * @param y defines the y coordinate of the viewport (in screen space)
  118283. * @param width defines the width of the viewport (in screen space)
  118284. * @param height defines the height of the viewport (in screen space)
  118285. * @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
  118286. */
  118287. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  118288. /**
  118289. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  118290. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  118291. * @param y defines the y-coordinate of the corner of the clear rectangle
  118292. * @param width defines the width of the clear rectangle
  118293. * @param height defines the height of the clear rectangle
  118294. * @param clearColor defines the clear color
  118295. */
  118296. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  118297. /**
  118298. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  118299. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  118300. * @param y defines the y-coordinate of the corner of the clear rectangle
  118301. * @param width defines the width of the clear rectangle
  118302. * @param height defines the height of the clear rectangle
  118303. */
  118304. enableScissor(x: number, y: number, width: number, height: number): void;
  118305. /**
  118306. * Disable previously set scissor test rectangle
  118307. */
  118308. disableScissor(): void;
  118309. protected _reportDrawCall(): void;
  118310. /**
  118311. * Initializes a webVR display and starts listening to display change events
  118312. * The onVRDisplayChangedObservable will be notified upon these changes
  118313. * @returns The onVRDisplayChangedObservable
  118314. */
  118315. initWebVR(): Observable<IDisplayChangedEventArgs>;
  118316. /** @hidden */
  118317. _prepareVRComponent(): void;
  118318. /** @hidden */
  118319. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  118320. /** @hidden */
  118321. _submitVRFrame(): void;
  118322. /**
  118323. * Call this function to leave webVR mode
  118324. * Will do nothing if webVR is not supported or if there is no webVR device
  118325. * @see https://doc.babylonjs.com/how_to/webvr_camera
  118326. */
  118327. disableVR(): void;
  118328. /**
  118329. * Gets a boolean indicating that the system is in VR mode and is presenting
  118330. * @returns true if VR mode is engaged
  118331. */
  118332. isVRPresenting(): boolean;
  118333. /** @hidden */
  118334. _requestVRFrame(): void;
  118335. /** @hidden */
  118336. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  118337. /**
  118338. * Gets the source code of the vertex shader associated with a specific webGL program
  118339. * @param program defines the program to use
  118340. * @returns a string containing the source code of the vertex shader associated with the program
  118341. */
  118342. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  118343. /**
  118344. * Gets the source code of the fragment shader associated with a specific webGL program
  118345. * @param program defines the program to use
  118346. * @returns a string containing the source code of the fragment shader associated with the program
  118347. */
  118348. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  118349. /**
  118350. * Sets a depth stencil texture from a render target to the according uniform.
  118351. * @param channel The texture channel
  118352. * @param uniform The uniform to set
  118353. * @param texture The render target texture containing the depth stencil texture to apply
  118354. */
  118355. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  118356. /**
  118357. * Sets a texture to the webGL context from a postprocess
  118358. * @param channel defines the channel to use
  118359. * @param postProcess defines the source postprocess
  118360. */
  118361. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  118362. /**
  118363. * Binds the output of the passed in post process to the texture channel specified
  118364. * @param channel The channel the texture should be bound to
  118365. * @param postProcess The post process which's output should be bound
  118366. */
  118367. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  118368. protected _rebuildBuffers(): void;
  118369. /** @hidden */
  118370. _renderFrame(): void;
  118371. _renderLoop(): void;
  118372. /** @hidden */
  118373. _renderViews(): boolean;
  118374. /**
  118375. * Toggle full screen mode
  118376. * @param requestPointerLock defines if a pointer lock should be requested from the user
  118377. */
  118378. switchFullscreen(requestPointerLock: boolean): void;
  118379. /**
  118380. * Enters full screen mode
  118381. * @param requestPointerLock defines if a pointer lock should be requested from the user
  118382. */
  118383. enterFullscreen(requestPointerLock: boolean): void;
  118384. /**
  118385. * Exits full screen mode
  118386. */
  118387. exitFullscreen(): void;
  118388. /**
  118389. * Enters Pointerlock mode
  118390. */
  118391. enterPointerlock(): void;
  118392. /**
  118393. * Exits Pointerlock mode
  118394. */
  118395. exitPointerlock(): void;
  118396. /**
  118397. * Begin a new frame
  118398. */
  118399. beginFrame(): void;
  118400. /**
  118401. * Enf the current frame
  118402. */
  118403. endFrame(): void;
  118404. resize(): void;
  118405. /**
  118406. * Force a specific size of the canvas
  118407. * @param width defines the new canvas' width
  118408. * @param height defines the new canvas' height
  118409. * @returns true if the size was changed
  118410. */
  118411. setSize(width: number, height: number): boolean;
  118412. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  118413. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  118414. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  118415. _releaseTexture(texture: InternalTexture): void;
  118416. /**
  118417. * @hidden
  118418. * Rescales a texture
  118419. * @param source input texutre
  118420. * @param destination destination texture
  118421. * @param scene scene to use to render the resize
  118422. * @param internalFormat format to use when resizing
  118423. * @param onComplete callback to be called when resize has completed
  118424. */
  118425. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  118426. /**
  118427. * Gets the current framerate
  118428. * @returns a number representing the framerate
  118429. */
  118430. getFps(): number;
  118431. /**
  118432. * Gets the time spent between current and previous frame
  118433. * @returns a number representing the delta time in ms
  118434. */
  118435. getDeltaTime(): number;
  118436. private _measureFps;
  118437. /** @hidden */
  118438. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  118439. /**
  118440. * Updates the sample count of a render target texture
  118441. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  118442. * @param texture defines the texture to update
  118443. * @param samples defines the sample count to set
  118444. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  118445. */
  118446. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  118447. /**
  118448. * Updates a depth texture Comparison Mode and Function.
  118449. * If the comparison Function is equal to 0, the mode will be set to none.
  118450. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  118451. * @param texture The texture to set the comparison function for
  118452. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  118453. */
  118454. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  118455. /**
  118456. * Creates a webGL buffer to use with instanciation
  118457. * @param capacity defines the size of the buffer
  118458. * @returns the webGL buffer
  118459. */
  118460. createInstancesBuffer(capacity: number): DataBuffer;
  118461. /**
  118462. * Delete a webGL buffer used with instanciation
  118463. * @param buffer defines the webGL buffer to delete
  118464. */
  118465. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  118466. private _clientWaitAsync;
  118467. /** @hidden */
  118468. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  118469. dispose(): void;
  118470. private _disableTouchAction;
  118471. /**
  118472. * Display the loading screen
  118473. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  118474. */
  118475. displayLoadingUI(): void;
  118476. /**
  118477. * Hide the loading screen
  118478. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  118479. */
  118480. hideLoadingUI(): void;
  118481. /**
  118482. * Gets the current loading screen object
  118483. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  118484. */
  118485. get loadingScreen(): ILoadingScreen;
  118486. /**
  118487. * Sets the current loading screen object
  118488. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  118489. */
  118490. set loadingScreen(loadingScreen: ILoadingScreen);
  118491. /**
  118492. * Sets the current loading screen text
  118493. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  118494. */
  118495. set loadingUIText(text: string);
  118496. /**
  118497. * Sets the current loading screen background color
  118498. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  118499. */
  118500. set loadingUIBackgroundColor(color: string);
  118501. /** Pointerlock and fullscreen */
  118502. /**
  118503. * Ask the browser to promote the current element to pointerlock mode
  118504. * @param element defines the DOM element to promote
  118505. */
  118506. static _RequestPointerlock(element: HTMLElement): void;
  118507. /**
  118508. * Asks the browser to exit pointerlock mode
  118509. */
  118510. static _ExitPointerlock(): void;
  118511. /**
  118512. * Ask the browser to promote the current element to fullscreen rendering mode
  118513. * @param element defines the DOM element to promote
  118514. */
  118515. static _RequestFullscreen(element: HTMLElement): void;
  118516. /**
  118517. * Asks the browser to exit fullscreen mode
  118518. */
  118519. static _ExitFullscreen(): void;
  118520. }
  118521. }
  118522. declare module BABYLON {
  118523. /**
  118524. * The engine store class is responsible to hold all the instances of Engine and Scene created
  118525. * during the life time of the application.
  118526. */
  118527. export class EngineStore {
  118528. /** Gets the list of created engines */
  118529. static Instances: Engine[];
  118530. /** @hidden */
  118531. static _LastCreatedScene: Nullable<Scene>;
  118532. /**
  118533. * Gets the latest created engine
  118534. */
  118535. static get LastCreatedEngine(): Nullable<Engine>;
  118536. /**
  118537. * Gets the latest created scene
  118538. */
  118539. static get LastCreatedScene(): Nullable<Scene>;
  118540. /**
  118541. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  118542. * @ignorenaming
  118543. */
  118544. static UseFallbackTexture: boolean;
  118545. /**
  118546. * Texture content used if a texture cannot loaded
  118547. * @ignorenaming
  118548. */
  118549. static FallbackTexture: string;
  118550. }
  118551. }
  118552. declare module BABYLON {
  118553. /**
  118554. * Helper class that provides a small promise polyfill
  118555. */
  118556. export class PromisePolyfill {
  118557. /**
  118558. * Static function used to check if the polyfill is required
  118559. * If this is the case then the function will inject the polyfill to window.Promise
  118560. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  118561. */
  118562. static Apply(force?: boolean): void;
  118563. }
  118564. }
  118565. declare module BABYLON {
  118566. /**
  118567. * Interface for screenshot methods with describe argument called `size` as object with options
  118568. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  118569. */
  118570. export interface IScreenshotSize {
  118571. /**
  118572. * number in pixels for canvas height
  118573. */
  118574. height?: number;
  118575. /**
  118576. * multiplier allowing render at a higher or lower resolution
  118577. * If value is defined then height and width will be ignored and taken from camera
  118578. */
  118579. precision?: number;
  118580. /**
  118581. * number in pixels for canvas width
  118582. */
  118583. width?: number;
  118584. }
  118585. }
  118586. declare module BABYLON {
  118587. interface IColor4Like {
  118588. r: float;
  118589. g: float;
  118590. b: float;
  118591. a: float;
  118592. }
  118593. /**
  118594. * Class containing a set of static utilities functions
  118595. */
  118596. export class Tools {
  118597. /**
  118598. * Gets or sets the base URL to use to load assets
  118599. */
  118600. static get BaseUrl(): string;
  118601. static set BaseUrl(value: string);
  118602. /**
  118603. * Enable/Disable Custom HTTP Request Headers globally.
  118604. * default = false
  118605. * @see CustomRequestHeaders
  118606. */
  118607. static UseCustomRequestHeaders: boolean;
  118608. /**
  118609. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  118610. * i.e. when loading files, where the server/service expects an Authorization header
  118611. */
  118612. static CustomRequestHeaders: {
  118613. [key: string]: string;
  118614. };
  118615. /**
  118616. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  118617. */
  118618. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  118619. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  118620. /**
  118621. * Default behaviour for cors in the application.
  118622. * It can be a string if the expected behavior is identical in the entire app.
  118623. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  118624. */
  118625. static get CorsBehavior(): string | ((url: string | string[]) => string);
  118626. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  118627. /**
  118628. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  118629. * @ignorenaming
  118630. */
  118631. static get UseFallbackTexture(): boolean;
  118632. static set UseFallbackTexture(value: boolean);
  118633. /**
  118634. * Use this object to register external classes like custom textures or material
  118635. * to allow the laoders to instantiate them
  118636. */
  118637. static get RegisteredExternalClasses(): {
  118638. [key: string]: Object;
  118639. };
  118640. static set RegisteredExternalClasses(classes: {
  118641. [key: string]: Object;
  118642. });
  118643. /**
  118644. * Texture content used if a texture cannot loaded
  118645. * @ignorenaming
  118646. */
  118647. static get fallbackTexture(): string;
  118648. static set fallbackTexture(value: string);
  118649. /**
  118650. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  118651. * @param u defines the coordinate on X axis
  118652. * @param v defines the coordinate on Y axis
  118653. * @param width defines the width of the source data
  118654. * @param height defines the height of the source data
  118655. * @param pixels defines the source byte array
  118656. * @param color defines the output color
  118657. */
  118658. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  118659. /**
  118660. * Interpolates between a and b via alpha
  118661. * @param a The lower value (returned when alpha = 0)
  118662. * @param b The upper value (returned when alpha = 1)
  118663. * @param alpha The interpolation-factor
  118664. * @return The mixed value
  118665. */
  118666. static Mix(a: number, b: number, alpha: number): number;
  118667. /**
  118668. * Tries to instantiate a new object from a given class name
  118669. * @param className defines the class name to instantiate
  118670. * @returns the new object or null if the system was not able to do the instantiation
  118671. */
  118672. static Instantiate(className: string): any;
  118673. /**
  118674. * Provides a slice function that will work even on IE
  118675. * @param data defines the array to slice
  118676. * @param start defines the start of the data (optional)
  118677. * @param end defines the end of the data (optional)
  118678. * @returns the new sliced array
  118679. */
  118680. static Slice<T>(data: T, start?: number, end?: number): T;
  118681. /**
  118682. * Polyfill for setImmediate
  118683. * @param action defines the action to execute after the current execution block
  118684. */
  118685. static SetImmediate(action: () => void): void;
  118686. /**
  118687. * Function indicating if a number is an exponent of 2
  118688. * @param value defines the value to test
  118689. * @returns true if the value is an exponent of 2
  118690. */
  118691. static IsExponentOfTwo(value: number): boolean;
  118692. private static _tmpFloatArray;
  118693. /**
  118694. * Returns the nearest 32-bit single precision float representation of a Number
  118695. * @param value A Number. If the parameter is of a different type, it will get converted
  118696. * to a number or to NaN if it cannot be converted
  118697. * @returns number
  118698. */
  118699. static FloatRound(value: number): number;
  118700. /**
  118701. * Extracts the filename from a path
  118702. * @param path defines the path to use
  118703. * @returns the filename
  118704. */
  118705. static GetFilename(path: string): string;
  118706. /**
  118707. * Extracts the "folder" part of a path (everything before the filename).
  118708. * @param uri The URI to extract the info from
  118709. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  118710. * @returns The "folder" part of the path
  118711. */
  118712. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  118713. /**
  118714. * Extracts text content from a DOM element hierarchy
  118715. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  118716. */
  118717. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  118718. /**
  118719. * Convert an angle in radians to degrees
  118720. * @param angle defines the angle to convert
  118721. * @returns the angle in degrees
  118722. */
  118723. static ToDegrees(angle: number): number;
  118724. /**
  118725. * Convert an angle in degrees to radians
  118726. * @param angle defines the angle to convert
  118727. * @returns the angle in radians
  118728. */
  118729. static ToRadians(angle: number): number;
  118730. /**
  118731. * Returns an array if obj is not an array
  118732. * @param obj defines the object to evaluate as an array
  118733. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  118734. * @returns either obj directly if obj is an array or a new array containing obj
  118735. */
  118736. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  118737. /**
  118738. * Gets the pointer prefix to use
  118739. * @param engine defines the engine we are finding the prefix for
  118740. * @returns "pointer" if touch is enabled. Else returns "mouse"
  118741. */
  118742. static GetPointerPrefix(engine: Engine): string;
  118743. /**
  118744. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  118745. * @param url define the url we are trying
  118746. * @param element define the dom element where to configure the cors policy
  118747. */
  118748. static SetCorsBehavior(url: string | string[], element: {
  118749. crossOrigin: string | null;
  118750. }): void;
  118751. /**
  118752. * Removes unwanted characters from an url
  118753. * @param url defines the url to clean
  118754. * @returns the cleaned url
  118755. */
  118756. static CleanUrl(url: string): string;
  118757. /**
  118758. * Gets or sets a function used to pre-process url before using them to load assets
  118759. */
  118760. static get PreprocessUrl(): (url: string) => string;
  118761. static set PreprocessUrl(processor: (url: string) => string);
  118762. /**
  118763. * Loads an image as an HTMLImageElement.
  118764. * @param input url string, ArrayBuffer, or Blob to load
  118765. * @param onLoad callback called when the image successfully loads
  118766. * @param onError callback called when the image fails to load
  118767. * @param offlineProvider offline provider for caching
  118768. * @param mimeType optional mime type
  118769. * @returns the HTMLImageElement of the loaded image
  118770. */
  118771. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  118772. /**
  118773. * Loads a file from a url
  118774. * @param url url string, ArrayBuffer, or Blob to load
  118775. * @param onSuccess callback called when the file successfully loads
  118776. * @param onProgress callback called while file is loading (if the server supports this mode)
  118777. * @param offlineProvider defines the offline provider for caching
  118778. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  118779. * @param onError callback called when the file fails to load
  118780. * @returns a file request object
  118781. */
  118782. 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;
  118783. /**
  118784. * Loads a file from a url
  118785. * @param url the file url to load
  118786. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  118787. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  118788. */
  118789. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  118790. /**
  118791. * Load a script (identified by an url). When the url returns, the
  118792. * content of this file is added into a new script element, attached to the DOM (body element)
  118793. * @param scriptUrl defines the url of the script to laod
  118794. * @param onSuccess defines the callback called when the script is loaded
  118795. * @param onError defines the callback to call if an error occurs
  118796. * @param scriptId defines the id of the script element
  118797. */
  118798. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  118799. /**
  118800. * Load an asynchronous script (identified by an url). When the url returns, the
  118801. * content of this file is added into a new script element, attached to the DOM (body element)
  118802. * @param scriptUrl defines the url of the script to laod
  118803. * @param scriptId defines the id of the script element
  118804. * @returns a promise request object
  118805. */
  118806. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  118807. /**
  118808. * Loads a file from a blob
  118809. * @param fileToLoad defines the blob to use
  118810. * @param callback defines the callback to call when data is loaded
  118811. * @param progressCallback defines the callback to call during loading process
  118812. * @returns a file request object
  118813. */
  118814. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  118815. /**
  118816. * Reads a file from a File object
  118817. * @param file defines the file to load
  118818. * @param onSuccess defines the callback to call when data is loaded
  118819. * @param onProgress defines the callback to call during loading process
  118820. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  118821. * @param onError defines the callback to call when an error occurs
  118822. * @returns a file request object
  118823. */
  118824. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  118825. /**
  118826. * Creates a data url from a given string content
  118827. * @param content defines the content to convert
  118828. * @returns the new data url link
  118829. */
  118830. static FileAsURL(content: string): string;
  118831. /**
  118832. * Format the given number to a specific decimal format
  118833. * @param value defines the number to format
  118834. * @param decimals defines the number of decimals to use
  118835. * @returns the formatted string
  118836. */
  118837. static Format(value: number, decimals?: number): string;
  118838. /**
  118839. * Tries to copy an object by duplicating every property
  118840. * @param source defines the source object
  118841. * @param destination defines the target object
  118842. * @param doNotCopyList defines a list of properties to avoid
  118843. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  118844. */
  118845. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  118846. /**
  118847. * Gets a boolean indicating if the given object has no own property
  118848. * @param obj defines the object to test
  118849. * @returns true if object has no own property
  118850. */
  118851. static IsEmpty(obj: any): boolean;
  118852. /**
  118853. * Function used to register events at window level
  118854. * @param windowElement defines the Window object to use
  118855. * @param events defines the events to register
  118856. */
  118857. static RegisterTopRootEvents(windowElement: Window, events: {
  118858. name: string;
  118859. handler: Nullable<(e: FocusEvent) => any>;
  118860. }[]): void;
  118861. /**
  118862. * Function used to unregister events from window level
  118863. * @param windowElement defines the Window object to use
  118864. * @param events defines the events to unregister
  118865. */
  118866. static UnregisterTopRootEvents(windowElement: Window, events: {
  118867. name: string;
  118868. handler: Nullable<(e: FocusEvent) => any>;
  118869. }[]): void;
  118870. /**
  118871. * @ignore
  118872. */
  118873. static _ScreenshotCanvas: HTMLCanvasElement;
  118874. /**
  118875. * Dumps the current bound framebuffer
  118876. * @param width defines the rendering width
  118877. * @param height defines the rendering height
  118878. * @param engine defines the hosting engine
  118879. * @param successCallback defines the callback triggered once the data are available
  118880. * @param mimeType defines the mime type of the result
  118881. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  118882. */
  118883. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  118884. /**
  118885. * Converts the canvas data to blob.
  118886. * This acts as a polyfill for browsers not supporting the to blob function.
  118887. * @param canvas Defines the canvas to extract the data from
  118888. * @param successCallback Defines the callback triggered once the data are available
  118889. * @param mimeType Defines the mime type of the result
  118890. */
  118891. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  118892. /**
  118893. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  118894. * @param successCallback defines the callback triggered once the data are available
  118895. * @param mimeType defines the mime type of the result
  118896. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  118897. */
  118898. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  118899. /**
  118900. * Downloads a blob in the browser
  118901. * @param blob defines the blob to download
  118902. * @param fileName defines the name of the downloaded file
  118903. */
  118904. static Download(blob: Blob, fileName: string): void;
  118905. /**
  118906. * Captures a screenshot of the current rendering
  118907. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118908. * @param engine defines the rendering engine
  118909. * @param camera defines the source camera
  118910. * @param size This parameter can be set to a single number or to an object with the
  118911. * following (optional) properties: precision, width, height. If a single number is passed,
  118912. * it will be used for both width and height. If an object is passed, the screenshot size
  118913. * will be derived from the parameters. The precision property is a multiplier allowing
  118914. * rendering at a higher or lower resolution
  118915. * @param successCallback defines the callback receives a single parameter which contains the
  118916. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  118917. * src parameter of an <img> to display it
  118918. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  118919. * Check your browser for supported MIME types
  118920. */
  118921. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  118922. /**
  118923. * Captures a screenshot of the current rendering
  118924. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118925. * @param engine defines the rendering engine
  118926. * @param camera defines the source camera
  118927. * @param size This parameter can be set to a single number or to an object with the
  118928. * following (optional) properties: precision, width, height. If a single number is passed,
  118929. * it will be used for both width and height. If an object is passed, the screenshot size
  118930. * will be derived from the parameters. The precision property is a multiplier allowing
  118931. * rendering at a higher or lower resolution
  118932. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  118933. * Check your browser for supported MIME types
  118934. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  118935. * to the src parameter of an <img> to display it
  118936. */
  118937. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  118938. /**
  118939. * Generates an image screenshot from the specified camera.
  118940. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118941. * @param engine The engine to use for rendering
  118942. * @param camera The camera to use for rendering
  118943. * @param size This parameter can be set to a single number or to an object with the
  118944. * following (optional) properties: precision, width, height. If a single number is passed,
  118945. * it will be used for both width and height. If an object is passed, the screenshot size
  118946. * will be derived from the parameters. The precision property is a multiplier allowing
  118947. * rendering at a higher or lower resolution
  118948. * @param successCallback The callback receives a single parameter which contains the
  118949. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  118950. * src parameter of an <img> to display it
  118951. * @param mimeType The MIME type of the screenshot image (default: image/png).
  118952. * Check your browser for supported MIME types
  118953. * @param samples Texture samples (default: 1)
  118954. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  118955. * @param fileName A name for for the downloaded file.
  118956. */
  118957. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  118958. /**
  118959. * Generates an image screenshot from the specified camera.
  118960. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118961. * @param engine The engine to use for rendering
  118962. * @param camera The camera to use for rendering
  118963. * @param size This parameter can be set to a single number or to an object with the
  118964. * following (optional) properties: precision, width, height. If a single number is passed,
  118965. * it will be used for both width and height. If an object is passed, the screenshot size
  118966. * will be derived from the parameters. The precision property is a multiplier allowing
  118967. * rendering at a higher or lower resolution
  118968. * @param mimeType The MIME type of the screenshot image (default: image/png).
  118969. * Check your browser for supported MIME types
  118970. * @param samples Texture samples (default: 1)
  118971. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  118972. * @param fileName A name for for the downloaded file.
  118973. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  118974. * to the src parameter of an <img> to display it
  118975. */
  118976. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  118977. /**
  118978. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  118979. * Be aware Math.random() could cause collisions, but:
  118980. * "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"
  118981. * @returns a pseudo random id
  118982. */
  118983. static RandomId(): string;
  118984. /**
  118985. * Test if the given uri is a base64 string
  118986. * @param uri The uri to test
  118987. * @return True if the uri is a base64 string or false otherwise
  118988. */
  118989. static IsBase64(uri: string): boolean;
  118990. /**
  118991. * Decode the given base64 uri.
  118992. * @param uri The uri to decode
  118993. * @return The decoded base64 data.
  118994. */
  118995. static DecodeBase64(uri: string): ArrayBuffer;
  118996. /**
  118997. * Gets the absolute url.
  118998. * @param url the input url
  118999. * @return the absolute url
  119000. */
  119001. static GetAbsoluteUrl(url: string): string;
  119002. /**
  119003. * No log
  119004. */
  119005. static readonly NoneLogLevel: number;
  119006. /**
  119007. * Only message logs
  119008. */
  119009. static readonly MessageLogLevel: number;
  119010. /**
  119011. * Only warning logs
  119012. */
  119013. static readonly WarningLogLevel: number;
  119014. /**
  119015. * Only error logs
  119016. */
  119017. static readonly ErrorLogLevel: number;
  119018. /**
  119019. * All logs
  119020. */
  119021. static readonly AllLogLevel: number;
  119022. /**
  119023. * Gets a value indicating the number of loading errors
  119024. * @ignorenaming
  119025. */
  119026. static get errorsCount(): number;
  119027. /**
  119028. * Callback called when a new log is added
  119029. */
  119030. static OnNewCacheEntry: (entry: string) => void;
  119031. /**
  119032. * Log a message to the console
  119033. * @param message defines the message to log
  119034. */
  119035. static Log(message: string): void;
  119036. /**
  119037. * Write a warning message to the console
  119038. * @param message defines the message to log
  119039. */
  119040. static Warn(message: string): void;
  119041. /**
  119042. * Write an error message to the console
  119043. * @param message defines the message to log
  119044. */
  119045. static Error(message: string): void;
  119046. /**
  119047. * Gets current log cache (list of logs)
  119048. */
  119049. static get LogCache(): string;
  119050. /**
  119051. * Clears the log cache
  119052. */
  119053. static ClearLogCache(): void;
  119054. /**
  119055. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  119056. */
  119057. static set LogLevels(level: number);
  119058. /**
  119059. * Checks if the window object exists
  119060. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  119061. */
  119062. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  119063. /**
  119064. * No performance log
  119065. */
  119066. static readonly PerformanceNoneLogLevel: number;
  119067. /**
  119068. * Use user marks to log performance
  119069. */
  119070. static readonly PerformanceUserMarkLogLevel: number;
  119071. /**
  119072. * Log performance to the console
  119073. */
  119074. static readonly PerformanceConsoleLogLevel: number;
  119075. private static _performance;
  119076. /**
  119077. * Sets the current performance log level
  119078. */
  119079. static set PerformanceLogLevel(level: number);
  119080. private static _StartPerformanceCounterDisabled;
  119081. private static _EndPerformanceCounterDisabled;
  119082. private static _StartUserMark;
  119083. private static _EndUserMark;
  119084. private static _StartPerformanceConsole;
  119085. private static _EndPerformanceConsole;
  119086. /**
  119087. * Starts a performance counter
  119088. */
  119089. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  119090. /**
  119091. * Ends a specific performance coutner
  119092. */
  119093. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  119094. /**
  119095. * Gets either window.performance.now() if supported or Date.now() else
  119096. */
  119097. static get Now(): number;
  119098. /**
  119099. * This method will return the name of the class used to create the instance of the given object.
  119100. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  119101. * @param object the object to get the class name from
  119102. * @param isType defines if the object is actually a type
  119103. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  119104. */
  119105. static GetClassName(object: any, isType?: boolean): string;
  119106. /**
  119107. * Gets the first element of an array satisfying a given predicate
  119108. * @param array defines the array to browse
  119109. * @param predicate defines the predicate to use
  119110. * @returns null if not found or the element
  119111. */
  119112. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  119113. /**
  119114. * This method will return the name of the full name of the class, including its owning module (if any).
  119115. * 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).
  119116. * @param object the object to get the class name from
  119117. * @param isType defines if the object is actually a type
  119118. * @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.
  119119. * @ignorenaming
  119120. */
  119121. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  119122. /**
  119123. * Returns a promise that resolves after the given amount of time.
  119124. * @param delay Number of milliseconds to delay
  119125. * @returns Promise that resolves after the given amount of time
  119126. */
  119127. static DelayAsync(delay: number): Promise<void>;
  119128. /**
  119129. * Utility function to detect if the current user agent is Safari
  119130. * @returns whether or not the current user agent is safari
  119131. */
  119132. static IsSafari(): boolean;
  119133. }
  119134. /**
  119135. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  119136. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  119137. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  119138. * @param name The name of the class, case should be preserved
  119139. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  119140. */
  119141. export function className(name: string, module?: string): (target: Object) => void;
  119142. /**
  119143. * An implementation of a loop for asynchronous functions.
  119144. */
  119145. export class AsyncLoop {
  119146. /**
  119147. * Defines the number of iterations for the loop
  119148. */
  119149. iterations: number;
  119150. /**
  119151. * Defines the current index of the loop.
  119152. */
  119153. index: number;
  119154. private _done;
  119155. private _fn;
  119156. private _successCallback;
  119157. /**
  119158. * Constructor.
  119159. * @param iterations the number of iterations.
  119160. * @param func the function to run each iteration
  119161. * @param successCallback the callback that will be called upon succesful execution
  119162. * @param offset starting offset.
  119163. */
  119164. constructor(
  119165. /**
  119166. * Defines the number of iterations for the loop
  119167. */
  119168. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  119169. /**
  119170. * Execute the next iteration. Must be called after the last iteration was finished.
  119171. */
  119172. executeNext(): void;
  119173. /**
  119174. * Break the loop and run the success callback.
  119175. */
  119176. breakLoop(): void;
  119177. /**
  119178. * Create and run an async loop.
  119179. * @param iterations the number of iterations.
  119180. * @param fn the function to run each iteration
  119181. * @param successCallback the callback that will be called upon succesful execution
  119182. * @param offset starting offset.
  119183. * @returns the created async loop object
  119184. */
  119185. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  119186. /**
  119187. * A for-loop that will run a given number of iterations synchronous and the rest async.
  119188. * @param iterations total number of iterations
  119189. * @param syncedIterations number of synchronous iterations in each async iteration.
  119190. * @param fn the function to call each iteration.
  119191. * @param callback a success call back that will be called when iterating stops.
  119192. * @param breakFunction a break condition (optional)
  119193. * @param timeout timeout settings for the setTimeout function. default - 0.
  119194. * @returns the created async loop object
  119195. */
  119196. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  119197. }
  119198. }
  119199. declare module BABYLON {
  119200. /**
  119201. * This class implement a typical dictionary using a string as key and the generic type T as value.
  119202. * The underlying implementation relies on an associative array to ensure the best performances.
  119203. * The value can be anything including 'null' but except 'undefined'
  119204. */
  119205. export class StringDictionary<T> {
  119206. /**
  119207. * This will clear this dictionary and copy the content from the 'source' one.
  119208. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  119209. * @param source the dictionary to take the content from and copy to this dictionary
  119210. */
  119211. copyFrom(source: StringDictionary<T>): void;
  119212. /**
  119213. * Get a value based from its key
  119214. * @param key the given key to get the matching value from
  119215. * @return the value if found, otherwise undefined is returned
  119216. */
  119217. get(key: string): T | undefined;
  119218. /**
  119219. * Get a value from its key or add it if it doesn't exist.
  119220. * This method will ensure you that a given key/data will be present in the dictionary.
  119221. * @param key the given key to get the matching value from
  119222. * @param factory the factory that will create the value if the key is not present in the dictionary.
  119223. * The factory will only be invoked if there's no data for the given key.
  119224. * @return the value corresponding to the key.
  119225. */
  119226. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  119227. /**
  119228. * Get a value from its key if present in the dictionary otherwise add it
  119229. * @param key the key to get the value from
  119230. * @param val if there's no such key/value pair in the dictionary add it with this value
  119231. * @return the value corresponding to the key
  119232. */
  119233. getOrAdd(key: string, val: T): T;
  119234. /**
  119235. * Check if there's a given key in the dictionary
  119236. * @param key the key to check for
  119237. * @return true if the key is present, false otherwise
  119238. */
  119239. contains(key: string): boolean;
  119240. /**
  119241. * Add a new key and its corresponding value
  119242. * @param key the key to add
  119243. * @param value the value corresponding to the key
  119244. * @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
  119245. */
  119246. add(key: string, value: T): boolean;
  119247. /**
  119248. * Update a specific value associated to a key
  119249. * @param key defines the key to use
  119250. * @param value defines the value to store
  119251. * @returns true if the value was updated (or false if the key was not found)
  119252. */
  119253. set(key: string, value: T): boolean;
  119254. /**
  119255. * Get the element of the given key and remove it from the dictionary
  119256. * @param key defines the key to search
  119257. * @returns the value associated with the key or null if not found
  119258. */
  119259. getAndRemove(key: string): Nullable<T>;
  119260. /**
  119261. * Remove a key/value from the dictionary.
  119262. * @param key the key to remove
  119263. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  119264. */
  119265. remove(key: string): boolean;
  119266. /**
  119267. * Clear the whole content of the dictionary
  119268. */
  119269. clear(): void;
  119270. /**
  119271. * Gets the current count
  119272. */
  119273. get count(): number;
  119274. /**
  119275. * Execute a callback on each key/val of the dictionary.
  119276. * Note that you can remove any element in this dictionary in the callback implementation
  119277. * @param callback the callback to execute on a given key/value pair
  119278. */
  119279. forEach(callback: (key: string, val: T) => void): void;
  119280. /**
  119281. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  119282. * If the callback returns null or undefined the method will iterate to the next key/value pair
  119283. * Note that you can remove any element in this dictionary in the callback implementation
  119284. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  119285. * @returns the first item
  119286. */
  119287. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  119288. private _count;
  119289. private _data;
  119290. }
  119291. }
  119292. declare module BABYLON {
  119293. /** @hidden */
  119294. export interface ICollisionCoordinator {
  119295. createCollider(): Collider;
  119296. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  119297. init(scene: Scene): void;
  119298. }
  119299. /** @hidden */
  119300. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  119301. private _scene;
  119302. private _scaledPosition;
  119303. private _scaledVelocity;
  119304. private _finalPosition;
  119305. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  119306. createCollider(): Collider;
  119307. init(scene: Scene): void;
  119308. private _collideWithWorld;
  119309. }
  119310. }
  119311. declare module BABYLON {
  119312. /**
  119313. * Class used to manage all inputs for the scene.
  119314. */
  119315. export class InputManager {
  119316. /** The distance in pixel that you have to move to prevent some events */
  119317. static DragMovementThreshold: number;
  119318. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  119319. static LongPressDelay: number;
  119320. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  119321. static DoubleClickDelay: number;
  119322. /** If you need to check double click without raising a single click at first click, enable this flag */
  119323. static ExclusiveDoubleClickMode: boolean;
  119324. /** 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. */
  119325. private _alreadyAttached;
  119326. private _wheelEventName;
  119327. private _onPointerMove;
  119328. private _onPointerDown;
  119329. private _onPointerUp;
  119330. private _initClickEvent;
  119331. private _initActionManager;
  119332. private _delayedSimpleClick;
  119333. private _delayedSimpleClickTimeout;
  119334. private _previousDelayedSimpleClickTimeout;
  119335. private _meshPickProceed;
  119336. private _previousButtonPressed;
  119337. private _currentPickResult;
  119338. private _previousPickResult;
  119339. private _totalPointersPressed;
  119340. private _doubleClickOccured;
  119341. private _pointerOverMesh;
  119342. private _pickedDownMesh;
  119343. private _pickedUpMesh;
  119344. private _pointerX;
  119345. private _pointerY;
  119346. private _unTranslatedPointerX;
  119347. private _unTranslatedPointerY;
  119348. private _startingPointerPosition;
  119349. private _previousStartingPointerPosition;
  119350. private _startingPointerTime;
  119351. private _previousStartingPointerTime;
  119352. private _pointerCaptures;
  119353. private _meshUnderPointerId;
  119354. private _onKeyDown;
  119355. private _onKeyUp;
  119356. private _onCanvasFocusObserver;
  119357. private _onCanvasBlurObserver;
  119358. private _scene;
  119359. /**
  119360. * Creates a new InputManager
  119361. * @param scene defines the hosting scene
  119362. */
  119363. constructor(scene: Scene);
  119364. /**
  119365. * Gets the mesh that is currently under the pointer
  119366. */
  119367. get meshUnderPointer(): Nullable<AbstractMesh>;
  119368. /**
  119369. * When using more than one pointer (for example in XR) you can get the mesh under the specific pointer
  119370. * @param pointerId the pointer id to use
  119371. * @returns The mesh under this pointer id or null if not found
  119372. */
  119373. getMeshUnderPointerByPointerId(pointerId: number): Nullable<AbstractMesh>;
  119374. /**
  119375. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  119376. */
  119377. get unTranslatedPointer(): Vector2;
  119378. /**
  119379. * Gets or sets the current on-screen X position of the pointer
  119380. */
  119381. get pointerX(): number;
  119382. set pointerX(value: number);
  119383. /**
  119384. * Gets or sets the current on-screen Y position of the pointer
  119385. */
  119386. get pointerY(): number;
  119387. set pointerY(value: number);
  119388. private _updatePointerPosition;
  119389. private _processPointerMove;
  119390. private _setRayOnPointerInfo;
  119391. private _checkPrePointerObservable;
  119392. /**
  119393. * Use this method to simulate a pointer move on a mesh
  119394. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119395. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119396. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119397. */
  119398. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  119399. /**
  119400. * Use this method to simulate a pointer down on a mesh
  119401. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119402. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119403. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119404. */
  119405. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  119406. private _processPointerDown;
  119407. /** @hidden */
  119408. _isPointerSwiping(): boolean;
  119409. /**
  119410. * Use this method to simulate a pointer up on a mesh
  119411. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119412. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119413. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119414. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  119415. */
  119416. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  119417. private _processPointerUp;
  119418. /**
  119419. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  119420. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  119421. * @returns true if the pointer was captured
  119422. */
  119423. isPointerCaptured(pointerId?: number): boolean;
  119424. /**
  119425. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  119426. * @param attachUp defines if you want to attach events to pointerup
  119427. * @param attachDown defines if you want to attach events to pointerdown
  119428. * @param attachMove defines if you want to attach events to pointermove
  119429. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  119430. */
  119431. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  119432. /**
  119433. * Detaches all event handlers
  119434. */
  119435. detachControl(): void;
  119436. /**
  119437. * Force the value of meshUnderPointer
  119438. * @param mesh defines the mesh to use
  119439. * @param pointerId optional pointer id when using more than one pointer. Defaults to 0
  119440. */
  119441. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  119442. /**
  119443. * Gets the mesh under the pointer
  119444. * @returns a Mesh or null if no mesh is under the pointer
  119445. */
  119446. getPointerOverMesh(): Nullable<AbstractMesh>;
  119447. }
  119448. }
  119449. declare module BABYLON {
  119450. /**
  119451. * This class defines the direct association between an animation and a target
  119452. */
  119453. export class TargetedAnimation {
  119454. /**
  119455. * Animation to perform
  119456. */
  119457. animation: Animation;
  119458. /**
  119459. * Target to animate
  119460. */
  119461. target: any;
  119462. /**
  119463. * Returns the string "TargetedAnimation"
  119464. * @returns "TargetedAnimation"
  119465. */
  119466. getClassName(): string;
  119467. /**
  119468. * Serialize the object
  119469. * @returns the JSON object representing the current entity
  119470. */
  119471. serialize(): any;
  119472. }
  119473. /**
  119474. * Use this class to create coordinated animations on multiple targets
  119475. */
  119476. export class AnimationGroup implements IDisposable {
  119477. /** The name of the animation group */
  119478. name: string;
  119479. private _scene;
  119480. private _targetedAnimations;
  119481. private _animatables;
  119482. private _from;
  119483. private _to;
  119484. private _isStarted;
  119485. private _isPaused;
  119486. private _speedRatio;
  119487. private _loopAnimation;
  119488. private _isAdditive;
  119489. /**
  119490. * Gets or sets the unique id of the node
  119491. */
  119492. uniqueId: number;
  119493. /**
  119494. * This observable will notify when one animation have ended
  119495. */
  119496. onAnimationEndObservable: Observable<TargetedAnimation>;
  119497. /**
  119498. * Observer raised when one animation loops
  119499. */
  119500. onAnimationLoopObservable: Observable<TargetedAnimation>;
  119501. /**
  119502. * Observer raised when all animations have looped
  119503. */
  119504. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  119505. /**
  119506. * This observable will notify when all animations have ended.
  119507. */
  119508. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  119509. /**
  119510. * This observable will notify when all animations have paused.
  119511. */
  119512. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  119513. /**
  119514. * This observable will notify when all animations are playing.
  119515. */
  119516. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  119517. /**
  119518. * Gets the first frame
  119519. */
  119520. get from(): number;
  119521. /**
  119522. * Gets the last frame
  119523. */
  119524. get to(): number;
  119525. /**
  119526. * Define if the animations are started
  119527. */
  119528. get isStarted(): boolean;
  119529. /**
  119530. * Gets a value indicating that the current group is playing
  119531. */
  119532. get isPlaying(): boolean;
  119533. /**
  119534. * Gets or sets the speed ratio to use for all animations
  119535. */
  119536. get speedRatio(): number;
  119537. /**
  119538. * Gets or sets the speed ratio to use for all animations
  119539. */
  119540. set speedRatio(value: number);
  119541. /**
  119542. * Gets or sets if all animations should loop or not
  119543. */
  119544. get loopAnimation(): boolean;
  119545. set loopAnimation(value: boolean);
  119546. /**
  119547. * Gets or sets if all animations should be evaluated additively
  119548. */
  119549. get isAdditive(): boolean;
  119550. set isAdditive(value: boolean);
  119551. /**
  119552. * Gets the targeted animations for this animation group
  119553. */
  119554. get targetedAnimations(): Array<TargetedAnimation>;
  119555. /**
  119556. * returning the list of animatables controlled by this animation group.
  119557. */
  119558. get animatables(): Array<Animatable>;
  119559. /**
  119560. * Gets the list of target animations
  119561. */
  119562. get children(): TargetedAnimation[];
  119563. /**
  119564. * Instantiates a new Animation Group.
  119565. * This helps managing several animations at once.
  119566. * @see https://doc.babylonjs.com/how_to/group
  119567. * @param name Defines the name of the group
  119568. * @param scene Defines the scene the group belongs to
  119569. */
  119570. constructor(
  119571. /** The name of the animation group */
  119572. name: string, scene?: Nullable<Scene>);
  119573. /**
  119574. * Add an animation (with its target) in the group
  119575. * @param animation defines the animation we want to add
  119576. * @param target defines the target of the animation
  119577. * @returns the TargetedAnimation object
  119578. */
  119579. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  119580. /**
  119581. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  119582. * It can add constant keys at begin or end
  119583. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  119584. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  119585. * @returns the animation group
  119586. */
  119587. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  119588. private _animationLoopCount;
  119589. private _animationLoopFlags;
  119590. private _processLoop;
  119591. /**
  119592. * Start all animations on given targets
  119593. * @param loop defines if animations must loop
  119594. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  119595. * @param from defines the from key (optional)
  119596. * @param to defines the to key (optional)
  119597. * @param isAdditive defines the additive state for the resulting animatables (optional)
  119598. * @returns the current animation group
  119599. */
  119600. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  119601. /**
  119602. * Pause all animations
  119603. * @returns the animation group
  119604. */
  119605. pause(): AnimationGroup;
  119606. /**
  119607. * Play all animations to initial state
  119608. * This function will start() the animations if they were not started or will restart() them if they were paused
  119609. * @param loop defines if animations must loop
  119610. * @returns the animation group
  119611. */
  119612. play(loop?: boolean): AnimationGroup;
  119613. /**
  119614. * Reset all animations to initial state
  119615. * @returns the animation group
  119616. */
  119617. reset(): AnimationGroup;
  119618. /**
  119619. * Restart animations from key 0
  119620. * @returns the animation group
  119621. */
  119622. restart(): AnimationGroup;
  119623. /**
  119624. * Stop all animations
  119625. * @returns the animation group
  119626. */
  119627. stop(): AnimationGroup;
  119628. /**
  119629. * Set animation weight for all animatables
  119630. * @param weight defines the weight to use
  119631. * @return the animationGroup
  119632. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  119633. */
  119634. setWeightForAllAnimatables(weight: number): AnimationGroup;
  119635. /**
  119636. * Synchronize and normalize all animatables with a source animatable
  119637. * @param root defines the root animatable to synchronize with
  119638. * @return the animationGroup
  119639. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  119640. */
  119641. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  119642. /**
  119643. * Goes to a specific frame in this animation group
  119644. * @param frame the frame number to go to
  119645. * @return the animationGroup
  119646. */
  119647. goToFrame(frame: number): AnimationGroup;
  119648. /**
  119649. * Dispose all associated resources
  119650. */
  119651. dispose(): void;
  119652. private _checkAnimationGroupEnded;
  119653. /**
  119654. * Clone the current animation group and returns a copy
  119655. * @param newName defines the name of the new group
  119656. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  119657. * @returns the new aniamtion group
  119658. */
  119659. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  119660. /**
  119661. * Serializes the animationGroup to an object
  119662. * @returns Serialized object
  119663. */
  119664. serialize(): any;
  119665. /**
  119666. * Returns a new AnimationGroup object parsed from the source provided.
  119667. * @param parsedAnimationGroup defines the source
  119668. * @param scene defines the scene that will receive the animationGroup
  119669. * @returns a new AnimationGroup
  119670. */
  119671. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  119672. /**
  119673. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  119674. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  119675. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  119676. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  119677. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  119678. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  119679. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  119680. */
  119681. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  119682. /**
  119683. * Returns the string "AnimationGroup"
  119684. * @returns "AnimationGroup"
  119685. */
  119686. getClassName(): string;
  119687. /**
  119688. * Creates a detailled string about the object
  119689. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  119690. * @returns a string representing the object
  119691. */
  119692. toString(fullDetails?: boolean): string;
  119693. }
  119694. }
  119695. declare module BABYLON {
  119696. /**
  119697. * Define an interface for all classes that will hold resources
  119698. */
  119699. export interface IDisposable {
  119700. /**
  119701. * Releases all held resources
  119702. */
  119703. dispose(): void;
  119704. }
  119705. /** Interface defining initialization parameters for Scene class */
  119706. export interface SceneOptions {
  119707. /**
  119708. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  119709. * It will improve performance when the number of geometries becomes important.
  119710. */
  119711. useGeometryUniqueIdsMap?: boolean;
  119712. /**
  119713. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  119714. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  119715. */
  119716. useMaterialMeshMap?: boolean;
  119717. /**
  119718. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  119719. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  119720. */
  119721. useClonedMeshMap?: boolean;
  119722. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  119723. virtual?: boolean;
  119724. }
  119725. /**
  119726. * Represents a scene to be rendered by the engine.
  119727. * @see https://doc.babylonjs.com/features/scene
  119728. */
  119729. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  119730. /** The fog is deactivated */
  119731. static readonly FOGMODE_NONE: number;
  119732. /** The fog density is following an exponential function */
  119733. static readonly FOGMODE_EXP: number;
  119734. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  119735. static readonly FOGMODE_EXP2: number;
  119736. /** The fog density is following a linear function. */
  119737. static readonly FOGMODE_LINEAR: number;
  119738. /**
  119739. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  119740. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119741. */
  119742. static MinDeltaTime: number;
  119743. /**
  119744. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  119745. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119746. */
  119747. static MaxDeltaTime: number;
  119748. /**
  119749. * Factory used to create the default material.
  119750. * @param name The name of the material to create
  119751. * @param scene The scene to create the material for
  119752. * @returns The default material
  119753. */
  119754. static DefaultMaterialFactory(scene: Scene): Material;
  119755. /**
  119756. * Factory used to create the a collision coordinator.
  119757. * @returns The collision coordinator
  119758. */
  119759. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  119760. /** @hidden */
  119761. _inputManager: InputManager;
  119762. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  119763. cameraToUseForPointers: Nullable<Camera>;
  119764. /** @hidden */
  119765. readonly _isScene: boolean;
  119766. /** @hidden */
  119767. _blockEntityCollection: boolean;
  119768. /**
  119769. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  119770. */
  119771. autoClear: boolean;
  119772. /**
  119773. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  119774. */
  119775. autoClearDepthAndStencil: boolean;
  119776. /**
  119777. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  119778. */
  119779. clearColor: Color4;
  119780. /**
  119781. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  119782. */
  119783. ambientColor: Color3;
  119784. /**
  119785. * This is use to store the default BRDF lookup for PBR materials in your scene.
  119786. * It should only be one of the following (if not the default embedded one):
  119787. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  119788. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  119789. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  119790. * The material properties need to be setup according to the type of texture in use.
  119791. */
  119792. environmentBRDFTexture: BaseTexture;
  119793. /**
  119794. * Texture used in all pbr material as the reflection texture.
  119795. * As in the majority of the scene they are the same (exception for multi room and so on),
  119796. * this is easier to reference from here than from all the materials.
  119797. */
  119798. get environmentTexture(): Nullable<BaseTexture>;
  119799. /**
  119800. * Texture used in all pbr material as the reflection texture.
  119801. * As in the majority of the scene they are the same (exception for multi room and so on),
  119802. * this is easier to set here than in all the materials.
  119803. */
  119804. set environmentTexture(value: Nullable<BaseTexture>);
  119805. /** @hidden */
  119806. protected _environmentIntensity: number;
  119807. /**
  119808. * Intensity of the environment in all pbr material.
  119809. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  119810. * As in the majority of the scene they are the same (exception for multi room and so on),
  119811. * this is easier to reference from here than from all the materials.
  119812. */
  119813. get environmentIntensity(): number;
  119814. /**
  119815. * Intensity of the environment in all pbr material.
  119816. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  119817. * As in the majority of the scene they are the same (exception for multi room and so on),
  119818. * this is easier to set here than in all the materials.
  119819. */
  119820. set environmentIntensity(value: number);
  119821. /** @hidden */
  119822. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  119823. /**
  119824. * Default image processing configuration used either in the rendering
  119825. * Forward main pass or through the imageProcessingPostProcess if present.
  119826. * As in the majority of the scene they are the same (exception for multi camera),
  119827. * this is easier to reference from here than from all the materials and post process.
  119828. *
  119829. * No setter as we it is a shared configuration, you can set the values instead.
  119830. */
  119831. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  119832. private _forceWireframe;
  119833. /**
  119834. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  119835. */
  119836. set forceWireframe(value: boolean);
  119837. get forceWireframe(): boolean;
  119838. private _skipFrustumClipping;
  119839. /**
  119840. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  119841. */
  119842. set skipFrustumClipping(value: boolean);
  119843. get skipFrustumClipping(): boolean;
  119844. private _forcePointsCloud;
  119845. /**
  119846. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  119847. */
  119848. set forcePointsCloud(value: boolean);
  119849. get forcePointsCloud(): boolean;
  119850. /**
  119851. * Gets or sets the active clipplane 1
  119852. */
  119853. clipPlane: Nullable<Plane>;
  119854. /**
  119855. * Gets or sets the active clipplane 2
  119856. */
  119857. clipPlane2: Nullable<Plane>;
  119858. /**
  119859. * Gets or sets the active clipplane 3
  119860. */
  119861. clipPlane3: Nullable<Plane>;
  119862. /**
  119863. * Gets or sets the active clipplane 4
  119864. */
  119865. clipPlane4: Nullable<Plane>;
  119866. /**
  119867. * Gets or sets the active clipplane 5
  119868. */
  119869. clipPlane5: Nullable<Plane>;
  119870. /**
  119871. * Gets or sets the active clipplane 6
  119872. */
  119873. clipPlane6: Nullable<Plane>;
  119874. /**
  119875. * Gets or sets a boolean indicating if animations are enabled
  119876. */
  119877. animationsEnabled: boolean;
  119878. private _animationPropertiesOverride;
  119879. /**
  119880. * Gets or sets the animation properties override
  119881. */
  119882. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  119883. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  119884. /**
  119885. * Gets or sets a boolean indicating if a constant deltatime has to be used
  119886. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  119887. */
  119888. useConstantAnimationDeltaTime: boolean;
  119889. /**
  119890. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  119891. * Please note that it requires to run a ray cast through the scene on every frame
  119892. */
  119893. constantlyUpdateMeshUnderPointer: boolean;
  119894. /**
  119895. * Defines the HTML cursor to use when hovering over interactive elements
  119896. */
  119897. hoverCursor: string;
  119898. /**
  119899. * Defines the HTML default cursor to use (empty by default)
  119900. */
  119901. defaultCursor: string;
  119902. /**
  119903. * Defines whether cursors are handled by the scene.
  119904. */
  119905. doNotHandleCursors: boolean;
  119906. /**
  119907. * This is used to call preventDefault() on pointer down
  119908. * in order to block unwanted artifacts like system double clicks
  119909. */
  119910. preventDefaultOnPointerDown: boolean;
  119911. /**
  119912. * This is used to call preventDefault() on pointer up
  119913. * in order to block unwanted artifacts like system double clicks
  119914. */
  119915. preventDefaultOnPointerUp: boolean;
  119916. /**
  119917. * Gets or sets user defined metadata
  119918. */
  119919. metadata: any;
  119920. /**
  119921. * For internal use only. Please do not use.
  119922. */
  119923. reservedDataStore: any;
  119924. /**
  119925. * Gets the name of the plugin used to load this scene (null by default)
  119926. */
  119927. loadingPluginName: string;
  119928. /**
  119929. * Use this array to add regular expressions used to disable offline support for specific urls
  119930. */
  119931. disableOfflineSupportExceptionRules: RegExp[];
  119932. /**
  119933. * An event triggered when the scene is disposed.
  119934. */
  119935. onDisposeObservable: Observable<Scene>;
  119936. private _onDisposeObserver;
  119937. /** Sets a function to be executed when this scene is disposed. */
  119938. set onDispose(callback: () => void);
  119939. /**
  119940. * An event triggered before rendering the scene (right after animations and physics)
  119941. */
  119942. onBeforeRenderObservable: Observable<Scene>;
  119943. private _onBeforeRenderObserver;
  119944. /** Sets a function to be executed before rendering this scene */
  119945. set beforeRender(callback: Nullable<() => void>);
  119946. /**
  119947. * An event triggered after rendering the scene
  119948. */
  119949. onAfterRenderObservable: Observable<Scene>;
  119950. /**
  119951. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  119952. */
  119953. onAfterRenderCameraObservable: Observable<Camera>;
  119954. private _onAfterRenderObserver;
  119955. /** Sets a function to be executed after rendering this scene */
  119956. set afterRender(callback: Nullable<() => void>);
  119957. /**
  119958. * An event triggered before animating the scene
  119959. */
  119960. onBeforeAnimationsObservable: Observable<Scene>;
  119961. /**
  119962. * An event triggered after animations processing
  119963. */
  119964. onAfterAnimationsObservable: Observable<Scene>;
  119965. /**
  119966. * An event triggered before draw calls are ready to be sent
  119967. */
  119968. onBeforeDrawPhaseObservable: Observable<Scene>;
  119969. /**
  119970. * An event triggered after draw calls have been sent
  119971. */
  119972. onAfterDrawPhaseObservable: Observable<Scene>;
  119973. /**
  119974. * An event triggered when the scene is ready
  119975. */
  119976. onReadyObservable: Observable<Scene>;
  119977. /**
  119978. * An event triggered before rendering a camera
  119979. */
  119980. onBeforeCameraRenderObservable: Observable<Camera>;
  119981. private _onBeforeCameraRenderObserver;
  119982. /** Sets a function to be executed before rendering a camera*/
  119983. set beforeCameraRender(callback: () => void);
  119984. /**
  119985. * An event triggered after rendering a camera
  119986. */
  119987. onAfterCameraRenderObservable: Observable<Camera>;
  119988. private _onAfterCameraRenderObserver;
  119989. /** Sets a function to be executed after rendering a camera*/
  119990. set afterCameraRender(callback: () => void);
  119991. /**
  119992. * An event triggered when active meshes evaluation is about to start
  119993. */
  119994. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  119995. /**
  119996. * An event triggered when active meshes evaluation is done
  119997. */
  119998. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  119999. /**
  120000. * An event triggered when particles rendering is about to start
  120001. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  120002. */
  120003. onBeforeParticlesRenderingObservable: Observable<Scene>;
  120004. /**
  120005. * An event triggered when particles rendering is done
  120006. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  120007. */
  120008. onAfterParticlesRenderingObservable: Observable<Scene>;
  120009. /**
  120010. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  120011. */
  120012. onDataLoadedObservable: Observable<Scene>;
  120013. /**
  120014. * An event triggered when a camera is created
  120015. */
  120016. onNewCameraAddedObservable: Observable<Camera>;
  120017. /**
  120018. * An event triggered when a camera is removed
  120019. */
  120020. onCameraRemovedObservable: Observable<Camera>;
  120021. /**
  120022. * An event triggered when a light is created
  120023. */
  120024. onNewLightAddedObservable: Observable<Light>;
  120025. /**
  120026. * An event triggered when a light is removed
  120027. */
  120028. onLightRemovedObservable: Observable<Light>;
  120029. /**
  120030. * An event triggered when a geometry is created
  120031. */
  120032. onNewGeometryAddedObservable: Observable<Geometry>;
  120033. /**
  120034. * An event triggered when a geometry is removed
  120035. */
  120036. onGeometryRemovedObservable: Observable<Geometry>;
  120037. /**
  120038. * An event triggered when a transform node is created
  120039. */
  120040. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  120041. /**
  120042. * An event triggered when a transform node is removed
  120043. */
  120044. onTransformNodeRemovedObservable: Observable<TransformNode>;
  120045. /**
  120046. * An event triggered when a mesh is created
  120047. */
  120048. onNewMeshAddedObservable: Observable<AbstractMesh>;
  120049. /**
  120050. * An event triggered when a mesh is removed
  120051. */
  120052. onMeshRemovedObservable: Observable<AbstractMesh>;
  120053. /**
  120054. * An event triggered when a skeleton is created
  120055. */
  120056. onNewSkeletonAddedObservable: Observable<Skeleton>;
  120057. /**
  120058. * An event triggered when a skeleton is removed
  120059. */
  120060. onSkeletonRemovedObservable: Observable<Skeleton>;
  120061. /**
  120062. * An event triggered when a material is created
  120063. */
  120064. onNewMaterialAddedObservable: Observable<Material>;
  120065. /**
  120066. * An event triggered when a material is removed
  120067. */
  120068. onMaterialRemovedObservable: Observable<Material>;
  120069. /**
  120070. * An event triggered when a texture is created
  120071. */
  120072. onNewTextureAddedObservable: Observable<BaseTexture>;
  120073. /**
  120074. * An event triggered when a texture is removed
  120075. */
  120076. onTextureRemovedObservable: Observable<BaseTexture>;
  120077. /**
  120078. * An event triggered when render targets are about to be rendered
  120079. * Can happen multiple times per frame.
  120080. */
  120081. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  120082. /**
  120083. * An event triggered when render targets were rendered.
  120084. * Can happen multiple times per frame.
  120085. */
  120086. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  120087. /**
  120088. * An event triggered before calculating deterministic simulation step
  120089. */
  120090. onBeforeStepObservable: Observable<Scene>;
  120091. /**
  120092. * An event triggered after calculating deterministic simulation step
  120093. */
  120094. onAfterStepObservable: Observable<Scene>;
  120095. /**
  120096. * An event triggered when the activeCamera property is updated
  120097. */
  120098. onActiveCameraChanged: Observable<Scene>;
  120099. /**
  120100. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  120101. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  120102. * 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)
  120103. */
  120104. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  120105. /**
  120106. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  120107. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  120108. * 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)
  120109. */
  120110. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  120111. /**
  120112. * This Observable will when a mesh has been imported into the scene.
  120113. */
  120114. onMeshImportedObservable: Observable<AbstractMesh>;
  120115. /**
  120116. * This Observable will when an animation file has been imported into the scene.
  120117. */
  120118. onAnimationFileImportedObservable: Observable<Scene>;
  120119. /**
  120120. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  120121. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  120122. */
  120123. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  120124. /** @hidden */
  120125. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  120126. /**
  120127. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  120128. */
  120129. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  120130. /**
  120131. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  120132. */
  120133. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  120134. /**
  120135. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  120136. */
  120137. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  120138. /** Callback called when a pointer move is detected */
  120139. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  120140. /** Callback called when a pointer down is detected */
  120141. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  120142. /** Callback called when a pointer up is detected */
  120143. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  120144. /** Callback called when a pointer pick is detected */
  120145. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  120146. /**
  120147. * 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).
  120148. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  120149. */
  120150. onPrePointerObservable: Observable<PointerInfoPre>;
  120151. /**
  120152. * Observable event triggered each time an input event is received from the rendering canvas
  120153. */
  120154. onPointerObservable: Observable<PointerInfo>;
  120155. /**
  120156. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  120157. */
  120158. get unTranslatedPointer(): Vector2;
  120159. /**
  120160. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  120161. */
  120162. static get DragMovementThreshold(): number;
  120163. static set DragMovementThreshold(value: number);
  120164. /**
  120165. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  120166. */
  120167. static get LongPressDelay(): number;
  120168. static set LongPressDelay(value: number);
  120169. /**
  120170. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  120171. */
  120172. static get DoubleClickDelay(): number;
  120173. static set DoubleClickDelay(value: number);
  120174. /** If you need to check double click without raising a single click at first click, enable this flag */
  120175. static get ExclusiveDoubleClickMode(): boolean;
  120176. static set ExclusiveDoubleClickMode(value: boolean);
  120177. /** @hidden */
  120178. _mirroredCameraPosition: Nullable<Vector3>;
  120179. /**
  120180. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  120181. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  120182. */
  120183. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  120184. /**
  120185. * Observable event triggered each time an keyboard event is received from the hosting window
  120186. */
  120187. onKeyboardObservable: Observable<KeyboardInfo>;
  120188. private _useRightHandedSystem;
  120189. /**
  120190. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  120191. */
  120192. set useRightHandedSystem(value: boolean);
  120193. get useRightHandedSystem(): boolean;
  120194. private _timeAccumulator;
  120195. private _currentStepId;
  120196. private _currentInternalStep;
  120197. /**
  120198. * Sets the step Id used by deterministic lock step
  120199. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  120200. * @param newStepId defines the step Id
  120201. */
  120202. setStepId(newStepId: number): void;
  120203. /**
  120204. * Gets the step Id used by deterministic lock step
  120205. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  120206. * @returns the step Id
  120207. */
  120208. getStepId(): number;
  120209. /**
  120210. * Gets the internal step used by deterministic lock step
  120211. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  120212. * @returns the internal step
  120213. */
  120214. getInternalStep(): number;
  120215. private _fogEnabled;
  120216. /**
  120217. * Gets or sets a boolean indicating if fog is enabled on this scene
  120218. * @see https://doc.babylonjs.com/babylon101/environment#fog
  120219. * (Default is true)
  120220. */
  120221. set fogEnabled(value: boolean);
  120222. get fogEnabled(): boolean;
  120223. private _fogMode;
  120224. /**
  120225. * Gets or sets the fog mode to use
  120226. * @see https://doc.babylonjs.com/babylon101/environment#fog
  120227. * | mode | value |
  120228. * | --- | --- |
  120229. * | FOGMODE_NONE | 0 |
  120230. * | FOGMODE_EXP | 1 |
  120231. * | FOGMODE_EXP2 | 2 |
  120232. * | FOGMODE_LINEAR | 3 |
  120233. */
  120234. set fogMode(value: number);
  120235. get fogMode(): number;
  120236. /**
  120237. * Gets or sets the fog color to use
  120238. * @see https://doc.babylonjs.com/babylon101/environment#fog
  120239. * (Default is Color3(0.2, 0.2, 0.3))
  120240. */
  120241. fogColor: Color3;
  120242. /**
  120243. * Gets or sets the fog density to use
  120244. * @see https://doc.babylonjs.com/babylon101/environment#fog
  120245. * (Default is 0.1)
  120246. */
  120247. fogDensity: number;
  120248. /**
  120249. * Gets or sets the fog start distance to use
  120250. * @see https://doc.babylonjs.com/babylon101/environment#fog
  120251. * (Default is 0)
  120252. */
  120253. fogStart: number;
  120254. /**
  120255. * Gets or sets the fog end distance to use
  120256. * @see https://doc.babylonjs.com/babylon101/environment#fog
  120257. * (Default is 1000)
  120258. */
  120259. fogEnd: number;
  120260. /**
  120261. * Flag indicating that the frame buffer binding is handled by another component
  120262. */
  120263. prePass: boolean;
  120264. private _shadowsEnabled;
  120265. /**
  120266. * Gets or sets a boolean indicating if shadows are enabled on this scene
  120267. */
  120268. set shadowsEnabled(value: boolean);
  120269. get shadowsEnabled(): boolean;
  120270. private _lightsEnabled;
  120271. /**
  120272. * Gets or sets a boolean indicating if lights are enabled on this scene
  120273. */
  120274. set lightsEnabled(value: boolean);
  120275. get lightsEnabled(): boolean;
  120276. /** All of the active cameras added to this scene. */
  120277. activeCameras: Camera[];
  120278. /** @hidden */
  120279. _activeCamera: Nullable<Camera>;
  120280. /** Gets or sets the current active camera */
  120281. get activeCamera(): Nullable<Camera>;
  120282. set activeCamera(value: Nullable<Camera>);
  120283. private _defaultMaterial;
  120284. /** The default material used on meshes when no material is affected */
  120285. get defaultMaterial(): Material;
  120286. /** The default material used on meshes when no material is affected */
  120287. set defaultMaterial(value: Material);
  120288. private _texturesEnabled;
  120289. /**
  120290. * Gets or sets a boolean indicating if textures are enabled on this scene
  120291. */
  120292. set texturesEnabled(value: boolean);
  120293. get texturesEnabled(): boolean;
  120294. /**
  120295. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  120296. */
  120297. physicsEnabled: boolean;
  120298. /**
  120299. * Gets or sets a boolean indicating if particles are enabled on this scene
  120300. */
  120301. particlesEnabled: boolean;
  120302. /**
  120303. * Gets or sets a boolean indicating if sprites are enabled on this scene
  120304. */
  120305. spritesEnabled: boolean;
  120306. private _skeletonsEnabled;
  120307. /**
  120308. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  120309. */
  120310. set skeletonsEnabled(value: boolean);
  120311. get skeletonsEnabled(): boolean;
  120312. /**
  120313. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  120314. */
  120315. lensFlaresEnabled: boolean;
  120316. /**
  120317. * Gets or sets a boolean indicating if collisions are enabled on this scene
  120318. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  120319. */
  120320. collisionsEnabled: boolean;
  120321. private _collisionCoordinator;
  120322. /** @hidden */
  120323. get collisionCoordinator(): ICollisionCoordinator;
  120324. /**
  120325. * Defines the gravity applied to this scene (used only for collisions)
  120326. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  120327. */
  120328. gravity: Vector3;
  120329. /**
  120330. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  120331. */
  120332. postProcessesEnabled: boolean;
  120333. /**
  120334. * Gets the current postprocess manager
  120335. */
  120336. postProcessManager: PostProcessManager;
  120337. /**
  120338. * Gets or sets a boolean indicating if render targets are enabled on this scene
  120339. */
  120340. renderTargetsEnabled: boolean;
  120341. /**
  120342. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  120343. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  120344. */
  120345. dumpNextRenderTargets: boolean;
  120346. /**
  120347. * The list of user defined render targets added to the scene
  120348. */
  120349. customRenderTargets: RenderTargetTexture[];
  120350. /**
  120351. * Defines if texture loading must be delayed
  120352. * If true, textures will only be loaded when they need to be rendered
  120353. */
  120354. useDelayedTextureLoading: boolean;
  120355. /**
  120356. * Gets the list of meshes imported to the scene through SceneLoader
  120357. */
  120358. importedMeshesFiles: String[];
  120359. /**
  120360. * Gets or sets a boolean indicating if probes are enabled on this scene
  120361. */
  120362. probesEnabled: boolean;
  120363. /**
  120364. * Gets or sets the current offline provider to use to store scene data
  120365. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  120366. */
  120367. offlineProvider: IOfflineProvider;
  120368. /**
  120369. * Gets or sets the action manager associated with the scene
  120370. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  120371. */
  120372. actionManager: AbstractActionManager;
  120373. private _meshesForIntersections;
  120374. /**
  120375. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  120376. */
  120377. proceduralTexturesEnabled: boolean;
  120378. private _engine;
  120379. private _totalVertices;
  120380. /** @hidden */
  120381. _activeIndices: PerfCounter;
  120382. /** @hidden */
  120383. _activeParticles: PerfCounter;
  120384. /** @hidden */
  120385. _activeBones: PerfCounter;
  120386. private _animationRatio;
  120387. /** @hidden */
  120388. _animationTimeLast: number;
  120389. /** @hidden */
  120390. _animationTime: number;
  120391. /**
  120392. * Gets or sets a general scale for animation speed
  120393. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  120394. */
  120395. animationTimeScale: number;
  120396. /** @hidden */
  120397. _cachedMaterial: Nullable<Material>;
  120398. /** @hidden */
  120399. _cachedEffect: Nullable<Effect>;
  120400. /** @hidden */
  120401. _cachedVisibility: Nullable<number>;
  120402. private _renderId;
  120403. private _frameId;
  120404. private _executeWhenReadyTimeoutId;
  120405. private _intermediateRendering;
  120406. private _viewUpdateFlag;
  120407. private _projectionUpdateFlag;
  120408. /** @hidden */
  120409. _toBeDisposed: Nullable<IDisposable>[];
  120410. private _activeRequests;
  120411. /** @hidden */
  120412. _pendingData: any[];
  120413. private _isDisposed;
  120414. /**
  120415. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  120416. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  120417. */
  120418. dispatchAllSubMeshesOfActiveMeshes: boolean;
  120419. private _activeMeshes;
  120420. private _processedMaterials;
  120421. private _renderTargets;
  120422. /** @hidden */
  120423. _activeParticleSystems: SmartArray<IParticleSystem>;
  120424. private _activeSkeletons;
  120425. private _softwareSkinnedMeshes;
  120426. private _renderingManager;
  120427. /** @hidden */
  120428. _activeAnimatables: Animatable[];
  120429. private _transformMatrix;
  120430. private _sceneUbo;
  120431. /** @hidden */
  120432. _viewMatrix: Matrix;
  120433. private _projectionMatrix;
  120434. /** @hidden */
  120435. _forcedViewPosition: Nullable<Vector3>;
  120436. /** @hidden */
  120437. _frustumPlanes: Plane[];
  120438. /**
  120439. * Gets the list of frustum planes (built from the active camera)
  120440. */
  120441. get frustumPlanes(): Plane[];
  120442. /**
  120443. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  120444. * This is useful if there are more lights that the maximum simulteanous authorized
  120445. */
  120446. requireLightSorting: boolean;
  120447. /** @hidden */
  120448. readonly useMaterialMeshMap: boolean;
  120449. /** @hidden */
  120450. readonly useClonedMeshMap: boolean;
  120451. private _externalData;
  120452. private _uid;
  120453. /**
  120454. * @hidden
  120455. * Backing store of defined scene components.
  120456. */
  120457. _components: ISceneComponent[];
  120458. /**
  120459. * @hidden
  120460. * Backing store of defined scene components.
  120461. */
  120462. _serializableComponents: ISceneSerializableComponent[];
  120463. /**
  120464. * List of components to register on the next registration step.
  120465. */
  120466. private _transientComponents;
  120467. /**
  120468. * Registers the transient components if needed.
  120469. */
  120470. private _registerTransientComponents;
  120471. /**
  120472. * @hidden
  120473. * Add a component to the scene.
  120474. * Note that the ccomponent could be registered on th next frame if this is called after
  120475. * the register component stage.
  120476. * @param component Defines the component to add to the scene
  120477. */
  120478. _addComponent(component: ISceneComponent): void;
  120479. /**
  120480. * @hidden
  120481. * Gets a component from the scene.
  120482. * @param name defines the name of the component to retrieve
  120483. * @returns the component or null if not present
  120484. */
  120485. _getComponent(name: string): Nullable<ISceneComponent>;
  120486. /**
  120487. * @hidden
  120488. * Defines the actions happening before camera updates.
  120489. */
  120490. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  120491. /**
  120492. * @hidden
  120493. * Defines the actions happening before clear the canvas.
  120494. */
  120495. _beforeClearStage: Stage<SimpleStageAction>;
  120496. /**
  120497. * @hidden
  120498. * Defines the actions when collecting render targets for the frame.
  120499. */
  120500. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  120501. /**
  120502. * @hidden
  120503. * Defines the actions happening for one camera in the frame.
  120504. */
  120505. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  120506. /**
  120507. * @hidden
  120508. * Defines the actions happening during the per mesh ready checks.
  120509. */
  120510. _isReadyForMeshStage: Stage<MeshStageAction>;
  120511. /**
  120512. * @hidden
  120513. * Defines the actions happening before evaluate active mesh checks.
  120514. */
  120515. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  120516. /**
  120517. * @hidden
  120518. * Defines the actions happening during the evaluate sub mesh checks.
  120519. */
  120520. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  120521. /**
  120522. * @hidden
  120523. * Defines the actions happening during the active mesh stage.
  120524. */
  120525. _activeMeshStage: Stage<ActiveMeshStageAction>;
  120526. /**
  120527. * @hidden
  120528. * Defines the actions happening during the per camera render target step.
  120529. */
  120530. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  120531. /**
  120532. * @hidden
  120533. * Defines the actions happening just before the active camera is drawing.
  120534. */
  120535. _beforeCameraDrawStage: Stage<CameraStageAction>;
  120536. /**
  120537. * @hidden
  120538. * Defines the actions happening just before a render target is drawing.
  120539. */
  120540. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  120541. /**
  120542. * @hidden
  120543. * Defines the actions happening just before a rendering group is drawing.
  120544. */
  120545. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  120546. /**
  120547. * @hidden
  120548. * Defines the actions happening just before a mesh is drawing.
  120549. */
  120550. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  120551. /**
  120552. * @hidden
  120553. * Defines the actions happening just after a mesh has been drawn.
  120554. */
  120555. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  120556. /**
  120557. * @hidden
  120558. * Defines the actions happening just after a rendering group has been drawn.
  120559. */
  120560. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  120561. /**
  120562. * @hidden
  120563. * Defines the actions happening just after the active camera has been drawn.
  120564. */
  120565. _afterCameraDrawStage: Stage<CameraStageAction>;
  120566. /**
  120567. * @hidden
  120568. * Defines the actions happening just after a render target has been drawn.
  120569. */
  120570. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  120571. /**
  120572. * @hidden
  120573. * Defines the actions happening just after rendering all cameras and computing intersections.
  120574. */
  120575. _afterRenderStage: Stage<SimpleStageAction>;
  120576. /**
  120577. * @hidden
  120578. * Defines the actions happening when a pointer move event happens.
  120579. */
  120580. _pointerMoveStage: Stage<PointerMoveStageAction>;
  120581. /**
  120582. * @hidden
  120583. * Defines the actions happening when a pointer down event happens.
  120584. */
  120585. _pointerDownStage: Stage<PointerUpDownStageAction>;
  120586. /**
  120587. * @hidden
  120588. * Defines the actions happening when a pointer up event happens.
  120589. */
  120590. _pointerUpStage: Stage<PointerUpDownStageAction>;
  120591. /**
  120592. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  120593. */
  120594. private geometriesByUniqueId;
  120595. /**
  120596. * Creates a new Scene
  120597. * @param engine defines the engine to use to render this scene
  120598. * @param options defines the scene options
  120599. */
  120600. constructor(engine: Engine, options?: SceneOptions);
  120601. /**
  120602. * Gets a string identifying the name of the class
  120603. * @returns "Scene" string
  120604. */
  120605. getClassName(): string;
  120606. private _defaultMeshCandidates;
  120607. /**
  120608. * @hidden
  120609. */
  120610. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  120611. private _defaultSubMeshCandidates;
  120612. /**
  120613. * @hidden
  120614. */
  120615. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  120616. /**
  120617. * Sets the default candidate providers for the scene.
  120618. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  120619. * and getCollidingSubMeshCandidates to their default function
  120620. */
  120621. setDefaultCandidateProviders(): void;
  120622. /**
  120623. * Gets the mesh that is currently under the pointer
  120624. */
  120625. get meshUnderPointer(): Nullable<AbstractMesh>;
  120626. /**
  120627. * Gets or sets the current on-screen X position of the pointer
  120628. */
  120629. get pointerX(): number;
  120630. set pointerX(value: number);
  120631. /**
  120632. * Gets or sets the current on-screen Y position of the pointer
  120633. */
  120634. get pointerY(): number;
  120635. set pointerY(value: number);
  120636. /**
  120637. * Gets the cached material (ie. the latest rendered one)
  120638. * @returns the cached material
  120639. */
  120640. getCachedMaterial(): Nullable<Material>;
  120641. /**
  120642. * Gets the cached effect (ie. the latest rendered one)
  120643. * @returns the cached effect
  120644. */
  120645. getCachedEffect(): Nullable<Effect>;
  120646. /**
  120647. * Gets the cached visibility state (ie. the latest rendered one)
  120648. * @returns the cached visibility state
  120649. */
  120650. getCachedVisibility(): Nullable<number>;
  120651. /**
  120652. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  120653. * @param material defines the current material
  120654. * @param effect defines the current effect
  120655. * @param visibility defines the current visibility state
  120656. * @returns true if one parameter is not cached
  120657. */
  120658. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  120659. /**
  120660. * Gets the engine associated with the scene
  120661. * @returns an Engine
  120662. */
  120663. getEngine(): Engine;
  120664. /**
  120665. * Gets the total number of vertices rendered per frame
  120666. * @returns the total number of vertices rendered per frame
  120667. */
  120668. getTotalVertices(): number;
  120669. /**
  120670. * Gets the performance counter for total vertices
  120671. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  120672. */
  120673. get totalVerticesPerfCounter(): PerfCounter;
  120674. /**
  120675. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  120676. * @returns the total number of active indices rendered per frame
  120677. */
  120678. getActiveIndices(): number;
  120679. /**
  120680. * Gets the performance counter for active indices
  120681. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  120682. */
  120683. get totalActiveIndicesPerfCounter(): PerfCounter;
  120684. /**
  120685. * Gets the total number of active particles rendered per frame
  120686. * @returns the total number of active particles rendered per frame
  120687. */
  120688. getActiveParticles(): number;
  120689. /**
  120690. * Gets the performance counter for active particles
  120691. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  120692. */
  120693. get activeParticlesPerfCounter(): PerfCounter;
  120694. /**
  120695. * Gets the total number of active bones rendered per frame
  120696. * @returns the total number of active bones rendered per frame
  120697. */
  120698. getActiveBones(): number;
  120699. /**
  120700. * Gets the performance counter for active bones
  120701. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  120702. */
  120703. get activeBonesPerfCounter(): PerfCounter;
  120704. /**
  120705. * Gets the array of active meshes
  120706. * @returns an array of AbstractMesh
  120707. */
  120708. getActiveMeshes(): SmartArray<AbstractMesh>;
  120709. /**
  120710. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  120711. * @returns a number
  120712. */
  120713. getAnimationRatio(): number;
  120714. /**
  120715. * Gets an unique Id for the current render phase
  120716. * @returns a number
  120717. */
  120718. getRenderId(): number;
  120719. /**
  120720. * Gets an unique Id for the current frame
  120721. * @returns a number
  120722. */
  120723. getFrameId(): number;
  120724. /** Call this function if you want to manually increment the render Id*/
  120725. incrementRenderId(): void;
  120726. private _createUbo;
  120727. /**
  120728. * Use this method to simulate a pointer move on a mesh
  120729. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  120730. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  120731. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  120732. * @returns the current scene
  120733. */
  120734. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  120735. /**
  120736. * Use this method to simulate a pointer down on a mesh
  120737. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  120738. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  120739. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  120740. * @returns the current scene
  120741. */
  120742. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  120743. /**
  120744. * Use this method to simulate a pointer up on a mesh
  120745. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  120746. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  120747. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  120748. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  120749. * @returns the current scene
  120750. */
  120751. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  120752. /**
  120753. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  120754. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  120755. * @returns true if the pointer was captured
  120756. */
  120757. isPointerCaptured(pointerId?: number): boolean;
  120758. /**
  120759. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  120760. * @param attachUp defines if you want to attach events to pointerup
  120761. * @param attachDown defines if you want to attach events to pointerdown
  120762. * @param attachMove defines if you want to attach events to pointermove
  120763. */
  120764. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  120765. /** Detaches all event handlers*/
  120766. detachControl(): void;
  120767. /**
  120768. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  120769. * Delay loaded resources are not taking in account
  120770. * @return true if all required resources are ready
  120771. */
  120772. isReady(): boolean;
  120773. /** Resets all cached information relative to material (including effect and visibility) */
  120774. resetCachedMaterial(): void;
  120775. /**
  120776. * Registers a function to be called before every frame render
  120777. * @param func defines the function to register
  120778. */
  120779. registerBeforeRender(func: () => void): void;
  120780. /**
  120781. * Unregisters a function called before every frame render
  120782. * @param func defines the function to unregister
  120783. */
  120784. unregisterBeforeRender(func: () => void): void;
  120785. /**
  120786. * Registers a function to be called after every frame render
  120787. * @param func defines the function to register
  120788. */
  120789. registerAfterRender(func: () => void): void;
  120790. /**
  120791. * Unregisters a function called after every frame render
  120792. * @param func defines the function to unregister
  120793. */
  120794. unregisterAfterRender(func: () => void): void;
  120795. private _executeOnceBeforeRender;
  120796. /**
  120797. * The provided function will run before render once and will be disposed afterwards.
  120798. * A timeout delay can be provided so that the function will be executed in N ms.
  120799. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  120800. * @param func The function to be executed.
  120801. * @param timeout optional delay in ms
  120802. */
  120803. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  120804. /** @hidden */
  120805. _addPendingData(data: any): void;
  120806. /** @hidden */
  120807. _removePendingData(data: any): void;
  120808. /**
  120809. * Returns the number of items waiting to be loaded
  120810. * @returns the number of items waiting to be loaded
  120811. */
  120812. getWaitingItemsCount(): number;
  120813. /**
  120814. * Returns a boolean indicating if the scene is still loading data
  120815. */
  120816. get isLoading(): boolean;
  120817. /**
  120818. * Registers a function to be executed when the scene is ready
  120819. * @param {Function} func - the function to be executed
  120820. */
  120821. executeWhenReady(func: () => void): void;
  120822. /**
  120823. * Returns a promise that resolves when the scene is ready
  120824. * @returns A promise that resolves when the scene is ready
  120825. */
  120826. whenReadyAsync(): Promise<void>;
  120827. /** @hidden */
  120828. _checkIsReady(): void;
  120829. /**
  120830. * Gets all animatable attached to the scene
  120831. */
  120832. get animatables(): Animatable[];
  120833. /**
  120834. * Resets the last animation time frame.
  120835. * Useful to override when animations start running when loading a scene for the first time.
  120836. */
  120837. resetLastAnimationTimeFrame(): void;
  120838. /**
  120839. * Gets the current view matrix
  120840. * @returns a Matrix
  120841. */
  120842. getViewMatrix(): Matrix;
  120843. /**
  120844. * Gets the current projection matrix
  120845. * @returns a Matrix
  120846. */
  120847. getProjectionMatrix(): Matrix;
  120848. /**
  120849. * Gets the current transform matrix
  120850. * @returns a Matrix made of View * Projection
  120851. */
  120852. getTransformMatrix(): Matrix;
  120853. /**
  120854. * Sets the current transform matrix
  120855. * @param viewL defines the View matrix to use
  120856. * @param projectionL defines the Projection matrix to use
  120857. * @param viewR defines the right View matrix to use (if provided)
  120858. * @param projectionR defines the right Projection matrix to use (if provided)
  120859. */
  120860. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  120861. /**
  120862. * Gets the uniform buffer used to store scene data
  120863. * @returns a UniformBuffer
  120864. */
  120865. getSceneUniformBuffer(): UniformBuffer;
  120866. /**
  120867. * Gets an unique (relatively to the current scene) Id
  120868. * @returns an unique number for the scene
  120869. */
  120870. getUniqueId(): number;
  120871. /**
  120872. * Add a mesh to the list of scene's meshes
  120873. * @param newMesh defines the mesh to add
  120874. * @param recursive if all child meshes should also be added to the scene
  120875. */
  120876. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  120877. /**
  120878. * Remove a mesh for the list of scene's meshes
  120879. * @param toRemove defines the mesh to remove
  120880. * @param recursive if all child meshes should also be removed from the scene
  120881. * @returns the index where the mesh was in the mesh list
  120882. */
  120883. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  120884. /**
  120885. * Add a transform node to the list of scene's transform nodes
  120886. * @param newTransformNode defines the transform node to add
  120887. */
  120888. addTransformNode(newTransformNode: TransformNode): void;
  120889. /**
  120890. * Remove a transform node for the list of scene's transform nodes
  120891. * @param toRemove defines the transform node to remove
  120892. * @returns the index where the transform node was in the transform node list
  120893. */
  120894. removeTransformNode(toRemove: TransformNode): number;
  120895. /**
  120896. * Remove a skeleton for the list of scene's skeletons
  120897. * @param toRemove defines the skeleton to remove
  120898. * @returns the index where the skeleton was in the skeleton list
  120899. */
  120900. removeSkeleton(toRemove: Skeleton): number;
  120901. /**
  120902. * Remove a morph target for the list of scene's morph targets
  120903. * @param toRemove defines the morph target to remove
  120904. * @returns the index where the morph target was in the morph target list
  120905. */
  120906. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  120907. /**
  120908. * Remove a light for the list of scene's lights
  120909. * @param toRemove defines the light to remove
  120910. * @returns the index where the light was in the light list
  120911. */
  120912. removeLight(toRemove: Light): number;
  120913. /**
  120914. * Remove a camera for the list of scene's cameras
  120915. * @param toRemove defines the camera to remove
  120916. * @returns the index where the camera was in the camera list
  120917. */
  120918. removeCamera(toRemove: Camera): number;
  120919. /**
  120920. * Remove a particle system for the list of scene's particle systems
  120921. * @param toRemove defines the particle system to remove
  120922. * @returns the index where the particle system was in the particle system list
  120923. */
  120924. removeParticleSystem(toRemove: IParticleSystem): number;
  120925. /**
  120926. * Remove a animation for the list of scene's animations
  120927. * @param toRemove defines the animation to remove
  120928. * @returns the index where the animation was in the animation list
  120929. */
  120930. removeAnimation(toRemove: Animation): number;
  120931. /**
  120932. * Will stop the animation of the given target
  120933. * @param target - the target
  120934. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  120935. * @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)
  120936. */
  120937. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  120938. /**
  120939. * Removes the given animation group from this scene.
  120940. * @param toRemove The animation group to remove
  120941. * @returns The index of the removed animation group
  120942. */
  120943. removeAnimationGroup(toRemove: AnimationGroup): number;
  120944. /**
  120945. * Removes the given multi-material from this scene.
  120946. * @param toRemove The multi-material to remove
  120947. * @returns The index of the removed multi-material
  120948. */
  120949. removeMultiMaterial(toRemove: MultiMaterial): number;
  120950. /**
  120951. * Removes the given material from this scene.
  120952. * @param toRemove The material to remove
  120953. * @returns The index of the removed material
  120954. */
  120955. removeMaterial(toRemove: Material): number;
  120956. /**
  120957. * Removes the given action manager from this scene.
  120958. * @param toRemove The action manager to remove
  120959. * @returns The index of the removed action manager
  120960. */
  120961. removeActionManager(toRemove: AbstractActionManager): number;
  120962. /**
  120963. * Removes the given texture from this scene.
  120964. * @param toRemove The texture to remove
  120965. * @returns The index of the removed texture
  120966. */
  120967. removeTexture(toRemove: BaseTexture): number;
  120968. /**
  120969. * Adds the given light to this scene
  120970. * @param newLight The light to add
  120971. */
  120972. addLight(newLight: Light): void;
  120973. /**
  120974. * Sorts the list list based on light priorities
  120975. */
  120976. sortLightsByPriority(): void;
  120977. /**
  120978. * Adds the given camera to this scene
  120979. * @param newCamera The camera to add
  120980. */
  120981. addCamera(newCamera: Camera): void;
  120982. /**
  120983. * Adds the given skeleton to this scene
  120984. * @param newSkeleton The skeleton to add
  120985. */
  120986. addSkeleton(newSkeleton: Skeleton): void;
  120987. /**
  120988. * Adds the given particle system to this scene
  120989. * @param newParticleSystem The particle system to add
  120990. */
  120991. addParticleSystem(newParticleSystem: IParticleSystem): void;
  120992. /**
  120993. * Adds the given animation to this scene
  120994. * @param newAnimation The animation to add
  120995. */
  120996. addAnimation(newAnimation: Animation): void;
  120997. /**
  120998. * Adds the given animation group to this scene.
  120999. * @param newAnimationGroup The animation group to add
  121000. */
  121001. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  121002. /**
  121003. * Adds the given multi-material to this scene
  121004. * @param newMultiMaterial The multi-material to add
  121005. */
  121006. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  121007. /**
  121008. * Adds the given material to this scene
  121009. * @param newMaterial The material to add
  121010. */
  121011. addMaterial(newMaterial: Material): void;
  121012. /**
  121013. * Adds the given morph target to this scene
  121014. * @param newMorphTargetManager The morph target to add
  121015. */
  121016. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  121017. /**
  121018. * Adds the given geometry to this scene
  121019. * @param newGeometry The geometry to add
  121020. */
  121021. addGeometry(newGeometry: Geometry): void;
  121022. /**
  121023. * Adds the given action manager to this scene
  121024. * @param newActionManager The action manager to add
  121025. */
  121026. addActionManager(newActionManager: AbstractActionManager): void;
  121027. /**
  121028. * Adds the given texture to this scene.
  121029. * @param newTexture The texture to add
  121030. */
  121031. addTexture(newTexture: BaseTexture): void;
  121032. /**
  121033. * Switch active camera
  121034. * @param newCamera defines the new active camera
  121035. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  121036. */
  121037. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  121038. /**
  121039. * sets the active camera of the scene using its ID
  121040. * @param id defines the camera's ID
  121041. * @return the new active camera or null if none found.
  121042. */
  121043. setActiveCameraByID(id: string): Nullable<Camera>;
  121044. /**
  121045. * sets the active camera of the scene using its name
  121046. * @param name defines the camera's name
  121047. * @returns the new active camera or null if none found.
  121048. */
  121049. setActiveCameraByName(name: string): Nullable<Camera>;
  121050. /**
  121051. * get an animation group using its name
  121052. * @param name defines the material's name
  121053. * @return the animation group or null if none found.
  121054. */
  121055. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  121056. /**
  121057. * Get a material using its unique id
  121058. * @param uniqueId defines the material's unique id
  121059. * @return the material or null if none found.
  121060. */
  121061. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  121062. /**
  121063. * get a material using its id
  121064. * @param id defines the material's ID
  121065. * @return the material or null if none found.
  121066. */
  121067. getMaterialByID(id: string): Nullable<Material>;
  121068. /**
  121069. * Gets a the last added material using a given id
  121070. * @param id defines the material's ID
  121071. * @return the last material with the given id or null if none found.
  121072. */
  121073. getLastMaterialByID(id: string): Nullable<Material>;
  121074. /**
  121075. * Gets a material using its name
  121076. * @param name defines the material's name
  121077. * @return the material or null if none found.
  121078. */
  121079. getMaterialByName(name: string): Nullable<Material>;
  121080. /**
  121081. * Get a texture using its unique id
  121082. * @param uniqueId defines the texture's unique id
  121083. * @return the texture or null if none found.
  121084. */
  121085. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  121086. /**
  121087. * Gets a camera using its id
  121088. * @param id defines the id to look for
  121089. * @returns the camera or null if not found
  121090. */
  121091. getCameraByID(id: string): Nullable<Camera>;
  121092. /**
  121093. * Gets a camera using its unique id
  121094. * @param uniqueId defines the unique id to look for
  121095. * @returns the camera or null if not found
  121096. */
  121097. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  121098. /**
  121099. * Gets a camera using its name
  121100. * @param name defines the camera's name
  121101. * @return the camera or null if none found.
  121102. */
  121103. getCameraByName(name: string): Nullable<Camera>;
  121104. /**
  121105. * Gets a bone using its id
  121106. * @param id defines the bone's id
  121107. * @return the bone or null if not found
  121108. */
  121109. getBoneByID(id: string): Nullable<Bone>;
  121110. /**
  121111. * Gets a bone using its id
  121112. * @param name defines the bone's name
  121113. * @return the bone or null if not found
  121114. */
  121115. getBoneByName(name: string): Nullable<Bone>;
  121116. /**
  121117. * Gets a light node using its name
  121118. * @param name defines the the light's name
  121119. * @return the light or null if none found.
  121120. */
  121121. getLightByName(name: string): Nullable<Light>;
  121122. /**
  121123. * Gets a light node using its id
  121124. * @param id defines the light's id
  121125. * @return the light or null if none found.
  121126. */
  121127. getLightByID(id: string): Nullable<Light>;
  121128. /**
  121129. * Gets a light node using its scene-generated unique ID
  121130. * @param uniqueId defines the light's unique id
  121131. * @return the light or null if none found.
  121132. */
  121133. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  121134. /**
  121135. * Gets a particle system by id
  121136. * @param id defines the particle system id
  121137. * @return the corresponding system or null if none found
  121138. */
  121139. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  121140. /**
  121141. * Gets a geometry using its ID
  121142. * @param id defines the geometry's id
  121143. * @return the geometry or null if none found.
  121144. */
  121145. getGeometryByID(id: string): Nullable<Geometry>;
  121146. private _getGeometryByUniqueID;
  121147. /**
  121148. * Add a new geometry to this scene
  121149. * @param geometry defines the geometry to be added to the scene.
  121150. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  121151. * @return a boolean defining if the geometry was added or not
  121152. */
  121153. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  121154. /**
  121155. * Removes an existing geometry
  121156. * @param geometry defines the geometry to be removed from the scene
  121157. * @return a boolean defining if the geometry was removed or not
  121158. */
  121159. removeGeometry(geometry: Geometry): boolean;
  121160. /**
  121161. * Gets the list of geometries attached to the scene
  121162. * @returns an array of Geometry
  121163. */
  121164. getGeometries(): Geometry[];
  121165. /**
  121166. * Gets the first added mesh found of a given ID
  121167. * @param id defines the id to search for
  121168. * @return the mesh found or null if not found at all
  121169. */
  121170. getMeshByID(id: string): Nullable<AbstractMesh>;
  121171. /**
  121172. * Gets a list of meshes using their id
  121173. * @param id defines the id to search for
  121174. * @returns a list of meshes
  121175. */
  121176. getMeshesByID(id: string): Array<AbstractMesh>;
  121177. /**
  121178. * Gets the first added transform node found of a given ID
  121179. * @param id defines the id to search for
  121180. * @return the found transform node or null if not found at all.
  121181. */
  121182. getTransformNodeByID(id: string): Nullable<TransformNode>;
  121183. /**
  121184. * Gets a transform node with its auto-generated unique id
  121185. * @param uniqueId efines the unique id to search for
  121186. * @return the found transform node or null if not found at all.
  121187. */
  121188. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  121189. /**
  121190. * Gets a list of transform nodes using their id
  121191. * @param id defines the id to search for
  121192. * @returns a list of transform nodes
  121193. */
  121194. getTransformNodesByID(id: string): Array<TransformNode>;
  121195. /**
  121196. * Gets a mesh with its auto-generated unique id
  121197. * @param uniqueId defines the unique id to search for
  121198. * @return the found mesh or null if not found at all.
  121199. */
  121200. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  121201. /**
  121202. * Gets a the last added mesh using a given id
  121203. * @param id defines the id to search for
  121204. * @return the found mesh or null if not found at all.
  121205. */
  121206. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  121207. /**
  121208. * Gets a the last added node (Mesh, Camera, Light) using a given id
  121209. * @param id defines the id to search for
  121210. * @return the found node or null if not found at all
  121211. */
  121212. getLastEntryByID(id: string): Nullable<Node>;
  121213. /**
  121214. * Gets a node (Mesh, Camera, Light) using a given id
  121215. * @param id defines the id to search for
  121216. * @return the found node or null if not found at all
  121217. */
  121218. getNodeByID(id: string): Nullable<Node>;
  121219. /**
  121220. * Gets a node (Mesh, Camera, Light) using a given name
  121221. * @param name defines the name to search for
  121222. * @return the found node or null if not found at all.
  121223. */
  121224. getNodeByName(name: string): Nullable<Node>;
  121225. /**
  121226. * Gets a mesh using a given name
  121227. * @param name defines the name to search for
  121228. * @return the found mesh or null if not found at all.
  121229. */
  121230. getMeshByName(name: string): Nullable<AbstractMesh>;
  121231. /**
  121232. * Gets a transform node using a given name
  121233. * @param name defines the name to search for
  121234. * @return the found transform node or null if not found at all.
  121235. */
  121236. getTransformNodeByName(name: string): Nullable<TransformNode>;
  121237. /**
  121238. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  121239. * @param id defines the id to search for
  121240. * @return the found skeleton or null if not found at all.
  121241. */
  121242. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  121243. /**
  121244. * Gets a skeleton using a given auto generated unique id
  121245. * @param uniqueId defines the unique id to search for
  121246. * @return the found skeleton or null if not found at all.
  121247. */
  121248. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  121249. /**
  121250. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  121251. * @param id defines the id to search for
  121252. * @return the found skeleton or null if not found at all.
  121253. */
  121254. getSkeletonById(id: string): Nullable<Skeleton>;
  121255. /**
  121256. * Gets a skeleton using a given name
  121257. * @param name defines the name to search for
  121258. * @return the found skeleton or null if not found at all.
  121259. */
  121260. getSkeletonByName(name: string): Nullable<Skeleton>;
  121261. /**
  121262. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  121263. * @param id defines the id to search for
  121264. * @return the found morph target manager or null if not found at all.
  121265. */
  121266. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  121267. /**
  121268. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  121269. * @param id defines the id to search for
  121270. * @return the found morph target or null if not found at all.
  121271. */
  121272. getMorphTargetById(id: string): Nullable<MorphTarget>;
  121273. /**
  121274. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  121275. * @param name defines the name to search for
  121276. * @return the found morph target or null if not found at all.
  121277. */
  121278. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  121279. /**
  121280. * Gets a post process using a given name (if many are found, this function will pick the first one)
  121281. * @param name defines the name to search for
  121282. * @return the found post process or null if not found at all.
  121283. */
  121284. getPostProcessByName(name: string): Nullable<PostProcess>;
  121285. /**
  121286. * Gets a boolean indicating if the given mesh is active
  121287. * @param mesh defines the mesh to look for
  121288. * @returns true if the mesh is in the active list
  121289. */
  121290. isActiveMesh(mesh: AbstractMesh): boolean;
  121291. /**
  121292. * Return a unique id as a string which can serve as an identifier for the scene
  121293. */
  121294. get uid(): string;
  121295. /**
  121296. * Add an externaly attached data from its key.
  121297. * This method call will fail and return false, if such key already exists.
  121298. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  121299. * @param key the unique key that identifies the data
  121300. * @param data the data object to associate to the key for this Engine instance
  121301. * @return true if no such key were already present and the data was added successfully, false otherwise
  121302. */
  121303. addExternalData<T>(key: string, data: T): boolean;
  121304. /**
  121305. * Get an externaly attached data from its key
  121306. * @param key the unique key that identifies the data
  121307. * @return the associated data, if present (can be null), or undefined if not present
  121308. */
  121309. getExternalData<T>(key: string): Nullable<T>;
  121310. /**
  121311. * Get an externaly attached data from its key, create it using a factory if it's not already present
  121312. * @param key the unique key that identifies the data
  121313. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  121314. * @return the associated data, can be null if the factory returned null.
  121315. */
  121316. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  121317. /**
  121318. * Remove an externaly attached data from the Engine instance
  121319. * @param key the unique key that identifies the data
  121320. * @return true if the data was successfully removed, false if it doesn't exist
  121321. */
  121322. removeExternalData(key: string): boolean;
  121323. private _evaluateSubMesh;
  121324. /**
  121325. * Clear the processed materials smart array preventing retention point in material dispose.
  121326. */
  121327. freeProcessedMaterials(): void;
  121328. private _preventFreeActiveMeshesAndRenderingGroups;
  121329. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  121330. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  121331. * when disposing several meshes in a row or a hierarchy of meshes.
  121332. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  121333. */
  121334. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  121335. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  121336. /**
  121337. * Clear the active meshes smart array preventing retention point in mesh dispose.
  121338. */
  121339. freeActiveMeshes(): void;
  121340. /**
  121341. * Clear the info related to rendering groups preventing retention points during dispose.
  121342. */
  121343. freeRenderingGroups(): void;
  121344. /** @hidden */
  121345. _isInIntermediateRendering(): boolean;
  121346. /**
  121347. * Lambda returning the list of potentially active meshes.
  121348. */
  121349. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  121350. /**
  121351. * Lambda returning the list of potentially active sub meshes.
  121352. */
  121353. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  121354. /**
  121355. * Lambda returning the list of potentially intersecting sub meshes.
  121356. */
  121357. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  121358. /**
  121359. * Lambda returning the list of potentially colliding sub meshes.
  121360. */
  121361. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  121362. private _activeMeshesFrozen;
  121363. private _skipEvaluateActiveMeshesCompletely;
  121364. /**
  121365. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  121366. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  121367. * @returns the current scene
  121368. */
  121369. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  121370. /**
  121371. * Use this function to restart evaluating active meshes on every frame
  121372. * @returns the current scene
  121373. */
  121374. unfreezeActiveMeshes(): Scene;
  121375. private _evaluateActiveMeshes;
  121376. private _activeMesh;
  121377. /**
  121378. * Update the transform matrix to update from the current active camera
  121379. * @param force defines a boolean used to force the update even if cache is up to date
  121380. */
  121381. updateTransformMatrix(force?: boolean): void;
  121382. private _bindFrameBuffer;
  121383. /** @hidden */
  121384. _allowPostProcessClearColor: boolean;
  121385. /** @hidden */
  121386. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  121387. private _processSubCameras;
  121388. private _checkIntersections;
  121389. /** @hidden */
  121390. _advancePhysicsEngineStep(step: number): void;
  121391. /**
  121392. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  121393. */
  121394. getDeterministicFrameTime: () => number;
  121395. /** @hidden */
  121396. _animate(): void;
  121397. /** Execute all animations (for a frame) */
  121398. animate(): void;
  121399. /**
  121400. * Render the scene
  121401. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  121402. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  121403. */
  121404. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  121405. /**
  121406. * Freeze all materials
  121407. * A frozen material will not be updatable but should be faster to render
  121408. */
  121409. freezeMaterials(): void;
  121410. /**
  121411. * Unfreeze all materials
  121412. * A frozen material will not be updatable but should be faster to render
  121413. */
  121414. unfreezeMaterials(): void;
  121415. /**
  121416. * Releases all held ressources
  121417. */
  121418. dispose(): void;
  121419. /**
  121420. * Gets if the scene is already disposed
  121421. */
  121422. get isDisposed(): boolean;
  121423. /**
  121424. * Call this function to reduce memory footprint of the scene.
  121425. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  121426. */
  121427. clearCachedVertexData(): void;
  121428. /**
  121429. * This function will remove the local cached buffer data from texture.
  121430. * It will save memory but will prevent the texture from being rebuilt
  121431. */
  121432. cleanCachedTextureBuffer(): void;
  121433. /**
  121434. * Get the world extend vectors with an optional filter
  121435. *
  121436. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  121437. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  121438. */
  121439. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  121440. min: Vector3;
  121441. max: Vector3;
  121442. };
  121443. /**
  121444. * Creates a ray that can be used to pick in the scene
  121445. * @param x defines the x coordinate of the origin (on-screen)
  121446. * @param y defines the y coordinate of the origin (on-screen)
  121447. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  121448. * @param camera defines the camera to use for the picking
  121449. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  121450. * @returns a Ray
  121451. */
  121452. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  121453. /**
  121454. * Creates a ray that can be used to pick in the scene
  121455. * @param x defines the x coordinate of the origin (on-screen)
  121456. * @param y defines the y coordinate of the origin (on-screen)
  121457. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  121458. * @param result defines the ray where to store the picking ray
  121459. * @param camera defines the camera to use for the picking
  121460. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  121461. * @returns the current scene
  121462. */
  121463. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  121464. /**
  121465. * Creates a ray that can be used to pick in the scene
  121466. * @param x defines the x coordinate of the origin (on-screen)
  121467. * @param y defines the y coordinate of the origin (on-screen)
  121468. * @param camera defines the camera to use for the picking
  121469. * @returns a Ray
  121470. */
  121471. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  121472. /**
  121473. * Creates a ray that can be used to pick in the scene
  121474. * @param x defines the x coordinate of the origin (on-screen)
  121475. * @param y defines the y coordinate of the origin (on-screen)
  121476. * @param result defines the ray where to store the picking ray
  121477. * @param camera defines the camera to use for the picking
  121478. * @returns the current scene
  121479. */
  121480. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  121481. /** Launch a ray to try to pick a mesh in the scene
  121482. * @param x position on screen
  121483. * @param y position on screen
  121484. * @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
  121485. * @param fastCheck defines if the first intersection will be used (and not the closest)
  121486. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  121487. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  121488. * @returns a PickingInfo
  121489. */
  121490. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  121491. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  121492. * @param x position on screen
  121493. * @param y position on screen
  121494. * @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
  121495. * @param fastCheck defines if the first intersection will be used (and not the closest)
  121496. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  121497. * @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)
  121498. */
  121499. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  121500. /** Use the given ray to pick a mesh in the scene
  121501. * @param ray The ray to use to pick meshes
  121502. * @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
  121503. * @param fastCheck defines if the first intersection will be used (and not the closest)
  121504. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  121505. * @returns a PickingInfo
  121506. */
  121507. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  121508. /**
  121509. * Launch a ray to try to pick a mesh in the scene
  121510. * @param x X position on screen
  121511. * @param y Y position on screen
  121512. * @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
  121513. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  121514. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  121515. * @returns an array of PickingInfo
  121516. */
  121517. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  121518. /**
  121519. * Launch a ray to try to pick a mesh in the scene
  121520. * @param ray Ray to use
  121521. * @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
  121522. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  121523. * @returns an array of PickingInfo
  121524. */
  121525. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  121526. /**
  121527. * Force the value of meshUnderPointer
  121528. * @param mesh defines the mesh to use
  121529. * @param pointerId optional pointer id when using more than one pointer
  121530. */
  121531. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  121532. /**
  121533. * Gets the mesh under the pointer
  121534. * @returns a Mesh or null if no mesh is under the pointer
  121535. */
  121536. getPointerOverMesh(): Nullable<AbstractMesh>;
  121537. /** @hidden */
  121538. _rebuildGeometries(): void;
  121539. /** @hidden */
  121540. _rebuildTextures(): void;
  121541. private _getByTags;
  121542. /**
  121543. * Get a list of meshes by tags
  121544. * @param tagsQuery defines the tags query to use
  121545. * @param forEach defines a predicate used to filter results
  121546. * @returns an array of Mesh
  121547. */
  121548. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  121549. /**
  121550. * Get a list of cameras by tags
  121551. * @param tagsQuery defines the tags query to use
  121552. * @param forEach defines a predicate used to filter results
  121553. * @returns an array of Camera
  121554. */
  121555. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  121556. /**
  121557. * Get a list of lights by tags
  121558. * @param tagsQuery defines the tags query to use
  121559. * @param forEach defines a predicate used to filter results
  121560. * @returns an array of Light
  121561. */
  121562. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  121563. /**
  121564. * Get a list of materials by tags
  121565. * @param tagsQuery defines the tags query to use
  121566. * @param forEach defines a predicate used to filter results
  121567. * @returns an array of Material
  121568. */
  121569. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  121570. /**
  121571. * Get a list of transform nodes by tags
  121572. * @param tagsQuery defines the tags query to use
  121573. * @param forEach defines a predicate used to filter results
  121574. * @returns an array of TransformNode
  121575. */
  121576. getTransformNodesByTags(tagsQuery: string, forEach?: (transform: TransformNode) => void): TransformNode[];
  121577. /**
  121578. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  121579. * This allowed control for front to back rendering or reversly depending of the special needs.
  121580. *
  121581. * @param renderingGroupId The rendering group id corresponding to its index
  121582. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  121583. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  121584. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  121585. */
  121586. 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;
  121587. /**
  121588. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  121589. *
  121590. * @param renderingGroupId The rendering group id corresponding to its index
  121591. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  121592. * @param depth Automatically clears depth between groups if true and autoClear is true.
  121593. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  121594. */
  121595. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  121596. /**
  121597. * Gets the current auto clear configuration for one rendering group of the rendering
  121598. * manager.
  121599. * @param index the rendering group index to get the information for
  121600. * @returns The auto clear setup for the requested rendering group
  121601. */
  121602. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  121603. private _blockMaterialDirtyMechanism;
  121604. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  121605. get blockMaterialDirtyMechanism(): boolean;
  121606. set blockMaterialDirtyMechanism(value: boolean);
  121607. /**
  121608. * Will flag all materials as dirty to trigger new shader compilation
  121609. * @param flag defines the flag used to specify which material part must be marked as dirty
  121610. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  121611. */
  121612. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  121613. /** @hidden */
  121614. _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;
  121615. /** @hidden */
  121616. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  121617. /** @hidden */
  121618. _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;
  121619. /** @hidden */
  121620. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  121621. /** @hidden */
  121622. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  121623. /** @hidden */
  121624. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  121625. }
  121626. }
  121627. declare module BABYLON {
  121628. /**
  121629. * Set of assets to keep when moving a scene into an asset container.
  121630. */
  121631. export class KeepAssets extends AbstractScene {
  121632. }
  121633. /**
  121634. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  121635. */
  121636. export class InstantiatedEntries {
  121637. /**
  121638. * List of new root nodes (eg. nodes with no parent)
  121639. */
  121640. rootNodes: TransformNode[];
  121641. /**
  121642. * List of new skeletons
  121643. */
  121644. skeletons: Skeleton[];
  121645. /**
  121646. * List of new animation groups
  121647. */
  121648. animationGroups: AnimationGroup[];
  121649. }
  121650. /**
  121651. * Container with a set of assets that can be added or removed from a scene.
  121652. */
  121653. export class AssetContainer extends AbstractScene {
  121654. private _wasAddedToScene;
  121655. /**
  121656. * The scene the AssetContainer belongs to.
  121657. */
  121658. scene: Scene;
  121659. /**
  121660. * Instantiates an AssetContainer.
  121661. * @param scene The scene the AssetContainer belongs to.
  121662. */
  121663. constructor(scene: Scene);
  121664. /**
  121665. * Instantiate or clone all meshes and add the new ones to the scene.
  121666. * Skeletons and animation groups will all be cloned
  121667. * @param nameFunction defines an optional function used to get new names for clones
  121668. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  121669. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  121670. */
  121671. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  121672. /**
  121673. * Adds all the assets from the container to the scene.
  121674. */
  121675. addAllToScene(): void;
  121676. /**
  121677. * Removes all the assets in the container from the scene
  121678. */
  121679. removeAllFromScene(): void;
  121680. /**
  121681. * Disposes all the assets in the container
  121682. */
  121683. dispose(): void;
  121684. private _moveAssets;
  121685. /**
  121686. * Removes all the assets contained in the scene and adds them to the container.
  121687. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  121688. */
  121689. moveAllFromScene(keepAssets?: KeepAssets): void;
  121690. /**
  121691. * 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.
  121692. * @returns the root mesh
  121693. */
  121694. createRootMesh(): Mesh;
  121695. /**
  121696. * Merge animations (direct and animation groups) from this asset container into a scene
  121697. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  121698. * @param animatables set of animatables to retarget to a node from the scene
  121699. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  121700. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  121701. */
  121702. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  121703. }
  121704. }
  121705. declare module BABYLON {
  121706. /**
  121707. * Defines how the parser contract is defined.
  121708. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  121709. */
  121710. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  121711. /**
  121712. * Defines how the individual parser contract is defined.
  121713. * These parser can parse an individual asset
  121714. */
  121715. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  121716. /**
  121717. * Base class of the scene acting as a container for the different elements composing a scene.
  121718. * This class is dynamically extended by the different components of the scene increasing
  121719. * flexibility and reducing coupling
  121720. */
  121721. export abstract class AbstractScene {
  121722. /**
  121723. * Stores the list of available parsers in the application.
  121724. */
  121725. private static _BabylonFileParsers;
  121726. /**
  121727. * Stores the list of available individual parsers in the application.
  121728. */
  121729. private static _IndividualBabylonFileParsers;
  121730. /**
  121731. * Adds a parser in the list of available ones
  121732. * @param name Defines the name of the parser
  121733. * @param parser Defines the parser to add
  121734. */
  121735. static AddParser(name: string, parser: BabylonFileParser): void;
  121736. /**
  121737. * Gets a general parser from the list of avaialble ones
  121738. * @param name Defines the name of the parser
  121739. * @returns the requested parser or null
  121740. */
  121741. static GetParser(name: string): Nullable<BabylonFileParser>;
  121742. /**
  121743. * Adds n individual parser in the list of available ones
  121744. * @param name Defines the name of the parser
  121745. * @param parser Defines the parser to add
  121746. */
  121747. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  121748. /**
  121749. * Gets an individual parser from the list of avaialble ones
  121750. * @param name Defines the name of the parser
  121751. * @returns the requested parser or null
  121752. */
  121753. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  121754. /**
  121755. * Parser json data and populate both a scene and its associated container object
  121756. * @param jsonData Defines the data to parse
  121757. * @param scene Defines the scene to parse the data for
  121758. * @param container Defines the container attached to the parsing sequence
  121759. * @param rootUrl Defines the root url of the data
  121760. */
  121761. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  121762. /**
  121763. * Gets the list of root nodes (ie. nodes with no parent)
  121764. */
  121765. rootNodes: Node[];
  121766. /** All of the cameras added to this scene
  121767. * @see https://doc.babylonjs.com/babylon101/cameras
  121768. */
  121769. cameras: Camera[];
  121770. /**
  121771. * All of the lights added to this scene
  121772. * @see https://doc.babylonjs.com/babylon101/lights
  121773. */
  121774. lights: Light[];
  121775. /**
  121776. * All of the (abstract) meshes added to this scene
  121777. */
  121778. meshes: AbstractMesh[];
  121779. /**
  121780. * The list of skeletons added to the scene
  121781. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  121782. */
  121783. skeletons: Skeleton[];
  121784. /**
  121785. * All of the particle systems added to this scene
  121786. * @see https://doc.babylonjs.com/babylon101/particles
  121787. */
  121788. particleSystems: IParticleSystem[];
  121789. /**
  121790. * Gets a list of Animations associated with the scene
  121791. */
  121792. animations: Animation[];
  121793. /**
  121794. * All of the animation groups added to this scene
  121795. * @see https://doc.babylonjs.com/how_to/group
  121796. */
  121797. animationGroups: AnimationGroup[];
  121798. /**
  121799. * All of the multi-materials added to this scene
  121800. * @see https://doc.babylonjs.com/how_to/multi_materials
  121801. */
  121802. multiMaterials: MultiMaterial[];
  121803. /**
  121804. * All of the materials added to this scene
  121805. * In the context of a Scene, it is not supposed to be modified manually.
  121806. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  121807. * Note also that the order of the Material within the array is not significant and might change.
  121808. * @see https://doc.babylonjs.com/babylon101/materials
  121809. */
  121810. materials: Material[];
  121811. /**
  121812. * The list of morph target managers added to the scene
  121813. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  121814. */
  121815. morphTargetManagers: MorphTargetManager[];
  121816. /**
  121817. * The list of geometries used in the scene.
  121818. */
  121819. geometries: Geometry[];
  121820. /**
  121821. * All of the tranform nodes added to this scene
  121822. * In the context of a Scene, it is not supposed to be modified manually.
  121823. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  121824. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  121825. * @see https://doc.babylonjs.com/how_to/transformnode
  121826. */
  121827. transformNodes: TransformNode[];
  121828. /**
  121829. * ActionManagers available on the scene.
  121830. */
  121831. actionManagers: AbstractActionManager[];
  121832. /**
  121833. * Textures to keep.
  121834. */
  121835. textures: BaseTexture[];
  121836. /** @hidden */
  121837. protected _environmentTexture: Nullable<BaseTexture>;
  121838. /**
  121839. * Texture used in all pbr material as the reflection texture.
  121840. * As in the majority of the scene they are the same (exception for multi room and so on),
  121841. * this is easier to reference from here than from all the materials.
  121842. */
  121843. get environmentTexture(): Nullable<BaseTexture>;
  121844. set environmentTexture(value: Nullable<BaseTexture>);
  121845. /**
  121846. * The list of postprocesses added to the scene
  121847. */
  121848. postProcesses: PostProcess[];
  121849. /**
  121850. * @returns all meshes, lights, cameras, transformNodes and bones
  121851. */
  121852. getNodes(): Array<Node>;
  121853. }
  121854. }
  121855. declare module BABYLON {
  121856. /**
  121857. * Interface used to define options for Sound class
  121858. */
  121859. export interface ISoundOptions {
  121860. /**
  121861. * Does the sound autoplay once loaded.
  121862. */
  121863. autoplay?: boolean;
  121864. /**
  121865. * Does the sound loop after it finishes playing once.
  121866. */
  121867. loop?: boolean;
  121868. /**
  121869. * Sound's volume
  121870. */
  121871. volume?: number;
  121872. /**
  121873. * Is it a spatial sound?
  121874. */
  121875. spatialSound?: boolean;
  121876. /**
  121877. * Maximum distance to hear that sound
  121878. */
  121879. maxDistance?: number;
  121880. /**
  121881. * Uses user defined attenuation function
  121882. */
  121883. useCustomAttenuation?: boolean;
  121884. /**
  121885. * Define the roll off factor of spatial sounds.
  121886. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121887. */
  121888. rolloffFactor?: number;
  121889. /**
  121890. * Define the reference distance the sound should be heard perfectly.
  121891. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121892. */
  121893. refDistance?: number;
  121894. /**
  121895. * Define the distance attenuation model the sound will follow.
  121896. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121897. */
  121898. distanceModel?: string;
  121899. /**
  121900. * Defines the playback speed (1 by default)
  121901. */
  121902. playbackRate?: number;
  121903. /**
  121904. * Defines if the sound is from a streaming source
  121905. */
  121906. streaming?: boolean;
  121907. /**
  121908. * Defines an optional length (in seconds) inside the sound file
  121909. */
  121910. length?: number;
  121911. /**
  121912. * Defines an optional offset (in seconds) inside the sound file
  121913. */
  121914. offset?: number;
  121915. /**
  121916. * If true, URLs will not be required to state the audio file codec to use.
  121917. */
  121918. skipCodecCheck?: boolean;
  121919. }
  121920. /**
  121921. * Defines a sound that can be played in the application.
  121922. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  121923. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121924. */
  121925. export class Sound {
  121926. /**
  121927. * The name of the sound in the scene.
  121928. */
  121929. name: string;
  121930. /**
  121931. * Does the sound autoplay once loaded.
  121932. */
  121933. autoplay: boolean;
  121934. /**
  121935. * Does the sound loop after it finishes playing once.
  121936. */
  121937. loop: boolean;
  121938. /**
  121939. * Does the sound use a custom attenuation curve to simulate the falloff
  121940. * happening when the source gets further away from the camera.
  121941. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  121942. */
  121943. useCustomAttenuation: boolean;
  121944. /**
  121945. * The sound track id this sound belongs to.
  121946. */
  121947. soundTrackId: number;
  121948. /**
  121949. * Is this sound currently played.
  121950. */
  121951. isPlaying: boolean;
  121952. /**
  121953. * Is this sound currently paused.
  121954. */
  121955. isPaused: boolean;
  121956. /**
  121957. * Does this sound enables spatial sound.
  121958. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121959. */
  121960. spatialSound: boolean;
  121961. /**
  121962. * Define the reference distance the sound should be heard perfectly.
  121963. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121964. */
  121965. refDistance: number;
  121966. /**
  121967. * Define the roll off factor of spatial sounds.
  121968. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121969. */
  121970. rolloffFactor: number;
  121971. /**
  121972. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  121973. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121974. */
  121975. maxDistance: number;
  121976. /**
  121977. * Define the distance attenuation model the sound will follow.
  121978. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121979. */
  121980. distanceModel: string;
  121981. /**
  121982. * @hidden
  121983. * Back Compat
  121984. **/
  121985. onended: () => any;
  121986. /**
  121987. * Gets or sets an object used to store user defined information for the sound.
  121988. */
  121989. metadata: any;
  121990. /**
  121991. * Observable event when the current playing sound finishes.
  121992. */
  121993. onEndedObservable: Observable<Sound>;
  121994. private _panningModel;
  121995. private _playbackRate;
  121996. private _streaming;
  121997. private _startTime;
  121998. private _startOffset;
  121999. private _position;
  122000. /** @hidden */
  122001. _positionInEmitterSpace: boolean;
  122002. private _localDirection;
  122003. private _volume;
  122004. private _isReadyToPlay;
  122005. private _isDirectional;
  122006. private _readyToPlayCallback;
  122007. private _audioBuffer;
  122008. private _soundSource;
  122009. private _streamingSource;
  122010. private _soundPanner;
  122011. private _soundGain;
  122012. private _inputAudioNode;
  122013. private _outputAudioNode;
  122014. private _coneInnerAngle;
  122015. private _coneOuterAngle;
  122016. private _coneOuterGain;
  122017. private _scene;
  122018. private _connectedTransformNode;
  122019. private _customAttenuationFunction;
  122020. private _registerFunc;
  122021. private _isOutputConnected;
  122022. private _htmlAudioElement;
  122023. private _urlType;
  122024. private _length?;
  122025. private _offset?;
  122026. /** @hidden */
  122027. static _SceneComponentInitialization: (scene: Scene) => void;
  122028. /**
  122029. * Create a sound and attach it to a scene
  122030. * @param name Name of your sound
  122031. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  122032. * @param scene defines the scene the sound belongs to
  122033. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  122034. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  122035. */
  122036. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  122037. /**
  122038. * Release the sound and its associated resources
  122039. */
  122040. dispose(): void;
  122041. /**
  122042. * Gets if the sounds is ready to be played or not.
  122043. * @returns true if ready, otherwise false
  122044. */
  122045. isReady(): boolean;
  122046. private _soundLoaded;
  122047. /**
  122048. * Sets the data of the sound from an audiobuffer
  122049. * @param audioBuffer The audioBuffer containing the data
  122050. */
  122051. setAudioBuffer(audioBuffer: AudioBuffer): void;
  122052. /**
  122053. * Updates the current sounds options such as maxdistance, loop...
  122054. * @param options A JSON object containing values named as the object properties
  122055. */
  122056. updateOptions(options: ISoundOptions): void;
  122057. private _createSpatialParameters;
  122058. private _updateSpatialParameters;
  122059. /**
  122060. * Switch the panning model to HRTF:
  122061. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  122062. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  122063. */
  122064. switchPanningModelToHRTF(): void;
  122065. /**
  122066. * Switch the panning model to Equal Power:
  122067. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  122068. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  122069. */
  122070. switchPanningModelToEqualPower(): void;
  122071. private _switchPanningModel;
  122072. /**
  122073. * Connect this sound to a sound track audio node like gain...
  122074. * @param soundTrackAudioNode the sound track audio node to connect to
  122075. */
  122076. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  122077. /**
  122078. * Transform this sound into a directional source
  122079. * @param coneInnerAngle Size of the inner cone in degree
  122080. * @param coneOuterAngle Size of the outer cone in degree
  122081. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  122082. */
  122083. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  122084. /**
  122085. * Gets or sets the inner angle for the directional cone.
  122086. */
  122087. get directionalConeInnerAngle(): number;
  122088. /**
  122089. * Gets or sets the inner angle for the directional cone.
  122090. */
  122091. set directionalConeInnerAngle(value: number);
  122092. /**
  122093. * Gets or sets the outer angle for the directional cone.
  122094. */
  122095. get directionalConeOuterAngle(): number;
  122096. /**
  122097. * Gets or sets the outer angle for the directional cone.
  122098. */
  122099. set directionalConeOuterAngle(value: number);
  122100. /**
  122101. * Sets the position of the emitter if spatial sound is enabled
  122102. * @param newPosition Defines the new posisiton
  122103. */
  122104. setPosition(newPosition: Vector3): void;
  122105. /**
  122106. * Sets the local direction of the emitter if spatial sound is enabled
  122107. * @param newLocalDirection Defines the new local direction
  122108. */
  122109. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  122110. private _updateDirection;
  122111. /** @hidden */
  122112. updateDistanceFromListener(): void;
  122113. /**
  122114. * Sets a new custom attenuation function for the sound.
  122115. * @param callback Defines the function used for the attenuation
  122116. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  122117. */
  122118. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  122119. /**
  122120. * Play the sound
  122121. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  122122. * @param offset (optional) Start the sound at a specific time in seconds
  122123. * @param length (optional) Sound duration (in seconds)
  122124. */
  122125. play(time?: number, offset?: number, length?: number): void;
  122126. private _onended;
  122127. /**
  122128. * Stop the sound
  122129. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  122130. */
  122131. stop(time?: number): void;
  122132. /**
  122133. * Put the sound in pause
  122134. */
  122135. pause(): void;
  122136. /**
  122137. * Sets a dedicated volume for this sounds
  122138. * @param newVolume Define the new volume of the sound
  122139. * @param time Define time for gradual change to new volume
  122140. */
  122141. setVolume(newVolume: number, time?: number): void;
  122142. /**
  122143. * Set the sound play back rate
  122144. * @param newPlaybackRate Define the playback rate the sound should be played at
  122145. */
  122146. setPlaybackRate(newPlaybackRate: number): void;
  122147. /**
  122148. * Gets the volume of the sound.
  122149. * @returns the volume of the sound
  122150. */
  122151. getVolume(): number;
  122152. /**
  122153. * Attach the sound to a dedicated mesh
  122154. * @param transformNode The transform node to connect the sound with
  122155. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  122156. */
  122157. attachToMesh(transformNode: TransformNode): void;
  122158. /**
  122159. * Detach the sound from the previously attached mesh
  122160. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  122161. */
  122162. detachFromMesh(): void;
  122163. private _onRegisterAfterWorldMatrixUpdate;
  122164. /**
  122165. * Clone the current sound in the scene.
  122166. * @returns the new sound clone
  122167. */
  122168. clone(): Nullable<Sound>;
  122169. /**
  122170. * Gets the current underlying audio buffer containing the data
  122171. * @returns the audio buffer
  122172. */
  122173. getAudioBuffer(): Nullable<AudioBuffer>;
  122174. /**
  122175. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  122176. * @returns the source node
  122177. */
  122178. getSoundSource(): Nullable<AudioBufferSourceNode>;
  122179. /**
  122180. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  122181. * @returns the gain node
  122182. */
  122183. getSoundGain(): Nullable<GainNode>;
  122184. /**
  122185. * Serializes the Sound in a JSON representation
  122186. * @returns the JSON representation of the sound
  122187. */
  122188. serialize(): any;
  122189. /**
  122190. * Parse a JSON representation of a sound to innstantiate in a given scene
  122191. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  122192. * @param scene Define the scene the new parsed sound should be created in
  122193. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  122194. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  122195. * @returns the newly parsed sound
  122196. */
  122197. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  122198. }
  122199. }
  122200. declare module BABYLON {
  122201. /**
  122202. * This defines an action helpful to play a defined sound on a triggered action.
  122203. */
  122204. export class PlaySoundAction extends Action {
  122205. private _sound;
  122206. /**
  122207. * Instantiate the action
  122208. * @param triggerOptions defines the trigger options
  122209. * @param sound defines the sound to play
  122210. * @param condition defines the trigger related conditions
  122211. */
  122212. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  122213. /** @hidden */
  122214. _prepare(): void;
  122215. /**
  122216. * Execute the action and play the sound.
  122217. */
  122218. execute(): void;
  122219. /**
  122220. * Serializes the actions and its related information.
  122221. * @param parent defines the object to serialize in
  122222. * @returns the serialized object
  122223. */
  122224. serialize(parent: any): any;
  122225. }
  122226. /**
  122227. * This defines an action helpful to stop a defined sound on a triggered action.
  122228. */
  122229. export class StopSoundAction extends Action {
  122230. private _sound;
  122231. /**
  122232. * Instantiate the action
  122233. * @param triggerOptions defines the trigger options
  122234. * @param sound defines the sound to stop
  122235. * @param condition defines the trigger related conditions
  122236. */
  122237. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  122238. /** @hidden */
  122239. _prepare(): void;
  122240. /**
  122241. * Execute the action and stop the sound.
  122242. */
  122243. execute(): void;
  122244. /**
  122245. * Serializes the actions and its related information.
  122246. * @param parent defines the object to serialize in
  122247. * @returns the serialized object
  122248. */
  122249. serialize(parent: any): any;
  122250. }
  122251. }
  122252. declare module BABYLON {
  122253. /**
  122254. * This defines an action responsible to change the value of a property
  122255. * by interpolating between its current value and the newly set one once triggered.
  122256. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  122257. */
  122258. export class InterpolateValueAction extends Action {
  122259. /**
  122260. * Defines the path of the property where the value should be interpolated
  122261. */
  122262. propertyPath: string;
  122263. /**
  122264. * Defines the target value at the end of the interpolation.
  122265. */
  122266. value: any;
  122267. /**
  122268. * Defines the time it will take for the property to interpolate to the value.
  122269. */
  122270. duration: number;
  122271. /**
  122272. * Defines if the other scene animations should be stopped when the action has been triggered
  122273. */
  122274. stopOtherAnimations?: boolean;
  122275. /**
  122276. * Defines a callback raised once the interpolation animation has been done.
  122277. */
  122278. onInterpolationDone?: () => void;
  122279. /**
  122280. * Observable triggered once the interpolation animation has been done.
  122281. */
  122282. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  122283. private _target;
  122284. private _effectiveTarget;
  122285. private _property;
  122286. /**
  122287. * Instantiate the action
  122288. * @param triggerOptions defines the trigger options
  122289. * @param target defines the object containing the value to interpolate
  122290. * @param propertyPath defines the path to the property in the target object
  122291. * @param value defines the target value at the end of the interpolation
  122292. * @param duration deines the time it will take for the property to interpolate to the value.
  122293. * @param condition defines the trigger related conditions
  122294. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  122295. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  122296. */
  122297. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  122298. /** @hidden */
  122299. _prepare(): void;
  122300. /**
  122301. * Execute the action starts the value interpolation.
  122302. */
  122303. execute(): void;
  122304. /**
  122305. * Serializes the actions and its related information.
  122306. * @param parent defines the object to serialize in
  122307. * @returns the serialized object
  122308. */
  122309. serialize(parent: any): any;
  122310. }
  122311. }
  122312. declare module BABYLON {
  122313. /**
  122314. * Options allowed during the creation of a sound track.
  122315. */
  122316. export interface ISoundTrackOptions {
  122317. /**
  122318. * The volume the sound track should take during creation
  122319. */
  122320. volume?: number;
  122321. /**
  122322. * Define if the sound track is the main sound track of the scene
  122323. */
  122324. mainTrack?: boolean;
  122325. }
  122326. /**
  122327. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  122328. * It will be also used in a future release to apply effects on a specific track.
  122329. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  122330. */
  122331. export class SoundTrack {
  122332. /**
  122333. * The unique identifier of the sound track in the scene.
  122334. */
  122335. id: number;
  122336. /**
  122337. * The list of sounds included in the sound track.
  122338. */
  122339. soundCollection: Array<Sound>;
  122340. private _outputAudioNode;
  122341. private _scene;
  122342. private _connectedAnalyser;
  122343. private _options;
  122344. private _isInitialized;
  122345. /**
  122346. * Creates a new sound track.
  122347. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  122348. * @param scene Define the scene the sound track belongs to
  122349. * @param options
  122350. */
  122351. constructor(scene: Scene, options?: ISoundTrackOptions);
  122352. private _initializeSoundTrackAudioGraph;
  122353. /**
  122354. * Release the sound track and its associated resources
  122355. */
  122356. dispose(): void;
  122357. /**
  122358. * Adds a sound to this sound track
  122359. * @param sound define the cound to add
  122360. * @ignoreNaming
  122361. */
  122362. AddSound(sound: Sound): void;
  122363. /**
  122364. * Removes a sound to this sound track
  122365. * @param sound define the cound to remove
  122366. * @ignoreNaming
  122367. */
  122368. RemoveSound(sound: Sound): void;
  122369. /**
  122370. * Set a global volume for the full sound track.
  122371. * @param newVolume Define the new volume of the sound track
  122372. */
  122373. setVolume(newVolume: number): void;
  122374. /**
  122375. * Switch the panning model to HRTF:
  122376. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  122377. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  122378. */
  122379. switchPanningModelToHRTF(): void;
  122380. /**
  122381. * Switch the panning model to Equal Power:
  122382. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  122383. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  122384. */
  122385. switchPanningModelToEqualPower(): void;
  122386. /**
  122387. * Connect the sound track to an audio analyser allowing some amazing
  122388. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  122389. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  122390. * @param analyser The analyser to connect to the engine
  122391. */
  122392. connectToAnalyser(analyser: Analyser): void;
  122393. }
  122394. }
  122395. declare module BABYLON {
  122396. interface AbstractScene {
  122397. /**
  122398. * The list of sounds used in the scene.
  122399. */
  122400. sounds: Nullable<Array<Sound>>;
  122401. }
  122402. interface Scene {
  122403. /**
  122404. * @hidden
  122405. * Backing field
  122406. */
  122407. _mainSoundTrack: SoundTrack;
  122408. /**
  122409. * The main sound track played by the scene.
  122410. * It cotains your primary collection of sounds.
  122411. */
  122412. mainSoundTrack: SoundTrack;
  122413. /**
  122414. * The list of sound tracks added to the scene
  122415. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  122416. */
  122417. soundTracks: Nullable<Array<SoundTrack>>;
  122418. /**
  122419. * Gets a sound using a given name
  122420. * @param name defines the name to search for
  122421. * @return the found sound or null if not found at all.
  122422. */
  122423. getSoundByName(name: string): Nullable<Sound>;
  122424. /**
  122425. * Gets or sets if audio support is enabled
  122426. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  122427. */
  122428. audioEnabled: boolean;
  122429. /**
  122430. * Gets or sets if audio will be output to headphones
  122431. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  122432. */
  122433. headphone: boolean;
  122434. /**
  122435. * Gets or sets custom audio listener position provider
  122436. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  122437. */
  122438. audioListenerPositionProvider: Nullable<() => Vector3>;
  122439. /**
  122440. * Gets or sets a refresh rate when using 3D audio positioning
  122441. */
  122442. audioPositioningRefreshRate: number;
  122443. }
  122444. /**
  122445. * Defines the sound scene component responsible to manage any sounds
  122446. * in a given scene.
  122447. */
  122448. export class AudioSceneComponent implements ISceneSerializableComponent {
  122449. private static _CameraDirectionLH;
  122450. private static _CameraDirectionRH;
  122451. /**
  122452. * The component name helpfull to identify the component in the list of scene components.
  122453. */
  122454. readonly name: string;
  122455. /**
  122456. * The scene the component belongs to.
  122457. */
  122458. scene: Scene;
  122459. private _audioEnabled;
  122460. /**
  122461. * Gets whether audio is enabled or not.
  122462. * Please use related enable/disable method to switch state.
  122463. */
  122464. get audioEnabled(): boolean;
  122465. private _headphone;
  122466. /**
  122467. * Gets whether audio is outputing to headphone or not.
  122468. * Please use the according Switch methods to change output.
  122469. */
  122470. get headphone(): boolean;
  122471. /**
  122472. * Gets or sets a refresh rate when using 3D audio positioning
  122473. */
  122474. audioPositioningRefreshRate: number;
  122475. private _audioListenerPositionProvider;
  122476. /**
  122477. * Gets the current audio listener position provider
  122478. */
  122479. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  122480. /**
  122481. * Sets a custom listener position for all sounds in the scene
  122482. * By default, this is the position of the first active camera
  122483. */
  122484. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  122485. /**
  122486. * Creates a new instance of the component for the given scene
  122487. * @param scene Defines the scene to register the component in
  122488. */
  122489. constructor(scene: Scene);
  122490. /**
  122491. * Registers the component in a given scene
  122492. */
  122493. register(): void;
  122494. /**
  122495. * Rebuilds the elements related to this component in case of
  122496. * context lost for instance.
  122497. */
  122498. rebuild(): void;
  122499. /**
  122500. * Serializes the component data to the specified json object
  122501. * @param serializationObject The object to serialize to
  122502. */
  122503. serialize(serializationObject: any): void;
  122504. /**
  122505. * Adds all the elements from the container to the scene
  122506. * @param container the container holding the elements
  122507. */
  122508. addFromContainer(container: AbstractScene): void;
  122509. /**
  122510. * Removes all the elements in the container from the scene
  122511. * @param container contains the elements to remove
  122512. * @param dispose if the removed element should be disposed (default: false)
  122513. */
  122514. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  122515. /**
  122516. * Disposes the component and the associated ressources.
  122517. */
  122518. dispose(): void;
  122519. /**
  122520. * Disables audio in the associated scene.
  122521. */
  122522. disableAudio(): void;
  122523. /**
  122524. * Enables audio in the associated scene.
  122525. */
  122526. enableAudio(): void;
  122527. /**
  122528. * Switch audio to headphone output.
  122529. */
  122530. switchAudioModeForHeadphones(): void;
  122531. /**
  122532. * Switch audio to normal speakers.
  122533. */
  122534. switchAudioModeForNormalSpeakers(): void;
  122535. private _cachedCameraDirection;
  122536. private _cachedCameraPosition;
  122537. private _lastCheck;
  122538. private _afterRender;
  122539. }
  122540. }
  122541. declare module BABYLON {
  122542. /**
  122543. * Wraps one or more Sound objects and selects one with random weight for playback.
  122544. */
  122545. export class WeightedSound {
  122546. /** When true a Sound will be selected and played when the current playing Sound completes. */
  122547. loop: boolean;
  122548. private _coneInnerAngle;
  122549. private _coneOuterAngle;
  122550. private _volume;
  122551. /** A Sound is currently playing. */
  122552. isPlaying: boolean;
  122553. /** A Sound is currently paused. */
  122554. isPaused: boolean;
  122555. private _sounds;
  122556. private _weights;
  122557. private _currentIndex?;
  122558. /**
  122559. * Creates a new WeightedSound from the list of sounds given.
  122560. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  122561. * @param sounds Array of Sounds that will be selected from.
  122562. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  122563. */
  122564. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  122565. /**
  122566. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  122567. */
  122568. get directionalConeInnerAngle(): number;
  122569. /**
  122570. * The size of cone in degress for a directional sound in which there will be no attenuation.
  122571. */
  122572. set directionalConeInnerAngle(value: number);
  122573. /**
  122574. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  122575. * Listener angles between innerAngle and outerAngle will falloff linearly.
  122576. */
  122577. get directionalConeOuterAngle(): number;
  122578. /**
  122579. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  122580. * Listener angles between innerAngle and outerAngle will falloff linearly.
  122581. */
  122582. set directionalConeOuterAngle(value: number);
  122583. /**
  122584. * Playback volume.
  122585. */
  122586. get volume(): number;
  122587. /**
  122588. * Playback volume.
  122589. */
  122590. set volume(value: number);
  122591. private _onended;
  122592. /**
  122593. * Suspend playback
  122594. */
  122595. pause(): void;
  122596. /**
  122597. * Stop playback
  122598. */
  122599. stop(): void;
  122600. /**
  122601. * Start playback.
  122602. * @param startOffset Position the clip head at a specific time in seconds.
  122603. */
  122604. play(startOffset?: number): void;
  122605. }
  122606. }
  122607. declare module BABYLON {
  122608. /**
  122609. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  122610. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  122611. */
  122612. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  122613. /**
  122614. * Gets the name of the behavior.
  122615. */
  122616. get name(): string;
  122617. /**
  122618. * The easing function used by animations
  122619. */
  122620. static EasingFunction: BackEase;
  122621. /**
  122622. * The easing mode used by animations
  122623. */
  122624. static EasingMode: number;
  122625. /**
  122626. * The duration of the animation, in milliseconds
  122627. */
  122628. transitionDuration: number;
  122629. /**
  122630. * Length of the distance animated by the transition when lower radius is reached
  122631. */
  122632. lowerRadiusTransitionRange: number;
  122633. /**
  122634. * Length of the distance animated by the transition when upper radius is reached
  122635. */
  122636. upperRadiusTransitionRange: number;
  122637. private _autoTransitionRange;
  122638. /**
  122639. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  122640. */
  122641. get autoTransitionRange(): boolean;
  122642. /**
  122643. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  122644. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  122645. */
  122646. set autoTransitionRange(value: boolean);
  122647. private _attachedCamera;
  122648. private _onAfterCheckInputsObserver;
  122649. private _onMeshTargetChangedObserver;
  122650. /**
  122651. * Initializes the behavior.
  122652. */
  122653. init(): void;
  122654. /**
  122655. * Attaches the behavior to its arc rotate camera.
  122656. * @param camera Defines the camera to attach the behavior to
  122657. */
  122658. attach(camera: ArcRotateCamera): void;
  122659. /**
  122660. * Detaches the behavior from its current arc rotate camera.
  122661. */
  122662. detach(): void;
  122663. private _radiusIsAnimating;
  122664. private _radiusBounceTransition;
  122665. private _animatables;
  122666. private _cachedWheelPrecision;
  122667. /**
  122668. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  122669. * @param radiusLimit The limit to check against.
  122670. * @return Bool to indicate if at limit.
  122671. */
  122672. private _isRadiusAtLimit;
  122673. /**
  122674. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  122675. * @param radiusDelta The delta by which to animate to. Can be negative.
  122676. */
  122677. private _applyBoundRadiusAnimation;
  122678. /**
  122679. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  122680. */
  122681. protected _clearAnimationLocks(): void;
  122682. /**
  122683. * Stops and removes all animations that have been applied to the camera
  122684. */
  122685. stopAllAnimations(): void;
  122686. }
  122687. }
  122688. declare module BABYLON {
  122689. /**
  122690. * 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.
  122691. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  122692. */
  122693. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  122694. /**
  122695. * Gets the name of the behavior.
  122696. */
  122697. get name(): string;
  122698. private _mode;
  122699. private _radiusScale;
  122700. private _positionScale;
  122701. private _defaultElevation;
  122702. private _elevationReturnTime;
  122703. private _elevationReturnWaitTime;
  122704. private _zoomStopsAnimation;
  122705. private _framingTime;
  122706. /**
  122707. * The easing function used by animations
  122708. */
  122709. static EasingFunction: ExponentialEase;
  122710. /**
  122711. * The easing mode used by animations
  122712. */
  122713. static EasingMode: number;
  122714. /**
  122715. * Sets the current mode used by the behavior
  122716. */
  122717. set mode(mode: number);
  122718. /**
  122719. * Gets current mode used by the behavior.
  122720. */
  122721. get mode(): number;
  122722. /**
  122723. * Sets the scale applied to the radius (1 by default)
  122724. */
  122725. set radiusScale(radius: number);
  122726. /**
  122727. * Gets the scale applied to the radius
  122728. */
  122729. get radiusScale(): number;
  122730. /**
  122731. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  122732. */
  122733. set positionScale(scale: number);
  122734. /**
  122735. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  122736. */
  122737. get positionScale(): number;
  122738. /**
  122739. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  122740. * behaviour is triggered, in radians.
  122741. */
  122742. set defaultElevation(elevation: number);
  122743. /**
  122744. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  122745. * behaviour is triggered, in radians.
  122746. */
  122747. get defaultElevation(): number;
  122748. /**
  122749. * Sets the time (in milliseconds) taken to return to the default beta position.
  122750. * Negative value indicates camera should not return to default.
  122751. */
  122752. set elevationReturnTime(speed: number);
  122753. /**
  122754. * Gets the time (in milliseconds) taken to return to the default beta position.
  122755. * Negative value indicates camera should not return to default.
  122756. */
  122757. get elevationReturnTime(): number;
  122758. /**
  122759. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  122760. */
  122761. set elevationReturnWaitTime(time: number);
  122762. /**
  122763. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  122764. */
  122765. get elevationReturnWaitTime(): number;
  122766. /**
  122767. * Sets the flag that indicates if user zooming should stop animation.
  122768. */
  122769. set zoomStopsAnimation(flag: boolean);
  122770. /**
  122771. * Gets the flag that indicates if user zooming should stop animation.
  122772. */
  122773. get zoomStopsAnimation(): boolean;
  122774. /**
  122775. * Sets the transition time when framing the mesh, in milliseconds
  122776. */
  122777. set framingTime(time: number);
  122778. /**
  122779. * Gets the transition time when framing the mesh, in milliseconds
  122780. */
  122781. get framingTime(): number;
  122782. /**
  122783. * Define if the behavior should automatically change the configured
  122784. * camera limits and sensibilities.
  122785. */
  122786. autoCorrectCameraLimitsAndSensibility: boolean;
  122787. private _onPrePointerObservableObserver;
  122788. private _onAfterCheckInputsObserver;
  122789. private _onMeshTargetChangedObserver;
  122790. private _attachedCamera;
  122791. private _isPointerDown;
  122792. private _lastInteractionTime;
  122793. /**
  122794. * Initializes the behavior.
  122795. */
  122796. init(): void;
  122797. /**
  122798. * Attaches the behavior to its arc rotate camera.
  122799. * @param camera Defines the camera to attach the behavior to
  122800. */
  122801. attach(camera: ArcRotateCamera): void;
  122802. /**
  122803. * Detaches the behavior from its current arc rotate camera.
  122804. */
  122805. detach(): void;
  122806. private _animatables;
  122807. private _betaIsAnimating;
  122808. private _betaTransition;
  122809. private _radiusTransition;
  122810. private _vectorTransition;
  122811. /**
  122812. * Targets the given mesh and updates zoom level accordingly.
  122813. * @param mesh The mesh to target.
  122814. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122815. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122816. */
  122817. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122818. /**
  122819. * Targets the given mesh with its children and updates zoom level accordingly.
  122820. * @param mesh The mesh to target.
  122821. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122822. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122823. */
  122824. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122825. /**
  122826. * Targets the given meshes with their children and updates zoom level accordingly.
  122827. * @param meshes The mesh to target.
  122828. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122829. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122830. */
  122831. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122832. /**
  122833. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  122834. * @param minimumWorld Determines the smaller position of the bounding box extend
  122835. * @param maximumWorld Determines the bigger position of the bounding box extend
  122836. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122837. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122838. */
  122839. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122840. /**
  122841. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  122842. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  122843. * frustum width.
  122844. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  122845. * to fully enclose the mesh in the viewing frustum.
  122846. */
  122847. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  122848. /**
  122849. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  122850. * is automatically returned to its default position (expected to be above ground plane).
  122851. */
  122852. private _maintainCameraAboveGround;
  122853. /**
  122854. * Returns the frustum slope based on the canvas ratio and camera FOV
  122855. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  122856. */
  122857. private _getFrustumSlope;
  122858. /**
  122859. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  122860. */
  122861. private _clearAnimationLocks;
  122862. /**
  122863. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  122864. */
  122865. private _applyUserInteraction;
  122866. /**
  122867. * Stops and removes all animations that have been applied to the camera
  122868. */
  122869. stopAllAnimations(): void;
  122870. /**
  122871. * Gets a value indicating if the user is moving the camera
  122872. */
  122873. get isUserIsMoving(): boolean;
  122874. /**
  122875. * The camera can move all the way towards the mesh.
  122876. */
  122877. static IgnoreBoundsSizeMode: number;
  122878. /**
  122879. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  122880. */
  122881. static FitFrustumSidesMode: number;
  122882. }
  122883. }
  122884. declare module BABYLON {
  122885. /**
  122886. * Base class for Camera Pointer Inputs.
  122887. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  122888. * for example usage.
  122889. */
  122890. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  122891. /**
  122892. * Defines the camera the input is attached to.
  122893. */
  122894. abstract camera: Camera;
  122895. /**
  122896. * Whether keyboard modifier keys are pressed at time of last mouse event.
  122897. */
  122898. protected _altKey: boolean;
  122899. protected _ctrlKey: boolean;
  122900. protected _metaKey: boolean;
  122901. protected _shiftKey: boolean;
  122902. /**
  122903. * Which mouse buttons were pressed at time of last mouse event.
  122904. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  122905. */
  122906. protected _buttonsPressed: number;
  122907. /**
  122908. * Defines the buttons associated with the input to handle camera move.
  122909. */
  122910. buttons: number[];
  122911. /**
  122912. * Attach the input controls to a specific dom element to get the input from.
  122913. * @param element Defines the element the controls should be listened from
  122914. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122915. */
  122916. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122917. /**
  122918. * Detach the current controls from the specified dom element.
  122919. * @param element Defines the element to stop listening the inputs from
  122920. */
  122921. detachControl(element: Nullable<HTMLElement>): void;
  122922. /**
  122923. * Gets the class name of the current input.
  122924. * @returns the class name
  122925. */
  122926. getClassName(): string;
  122927. /**
  122928. * Get the friendly name associated with the input class.
  122929. * @returns the input friendly name
  122930. */
  122931. getSimpleName(): string;
  122932. /**
  122933. * Called on pointer POINTERDOUBLETAP event.
  122934. * Override this method to provide functionality on POINTERDOUBLETAP event.
  122935. */
  122936. protected onDoubleTap(type: string): void;
  122937. /**
  122938. * Called on pointer POINTERMOVE event if only a single touch is active.
  122939. * Override this method to provide functionality.
  122940. */
  122941. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  122942. /**
  122943. * Called on pointer POINTERMOVE event if multiple touches are active.
  122944. * Override this method to provide functionality.
  122945. */
  122946. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  122947. /**
  122948. * Called on JS contextmenu event.
  122949. * Override this method to provide functionality.
  122950. */
  122951. protected onContextMenu(evt: PointerEvent): void;
  122952. /**
  122953. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  122954. * press.
  122955. * Override this method to provide functionality.
  122956. */
  122957. protected onButtonDown(evt: PointerEvent): void;
  122958. /**
  122959. * Called each time a new POINTERUP event occurs. Ie, for each button
  122960. * release.
  122961. * Override this method to provide functionality.
  122962. */
  122963. protected onButtonUp(evt: PointerEvent): void;
  122964. /**
  122965. * Called when window becomes inactive.
  122966. * Override this method to provide functionality.
  122967. */
  122968. protected onLostFocus(): void;
  122969. private _pointerInput;
  122970. private _observer;
  122971. private _onLostFocus;
  122972. private pointA;
  122973. private pointB;
  122974. }
  122975. }
  122976. declare module BABYLON {
  122977. /**
  122978. * Manage the pointers inputs to control an arc rotate camera.
  122979. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122980. */
  122981. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  122982. /**
  122983. * Defines the camera the input is attached to.
  122984. */
  122985. camera: ArcRotateCamera;
  122986. /**
  122987. * Gets the class name of the current input.
  122988. * @returns the class name
  122989. */
  122990. getClassName(): string;
  122991. /**
  122992. * Defines the buttons associated with the input to handle camera move.
  122993. */
  122994. buttons: number[];
  122995. /**
  122996. * Defines the pointer angular sensibility along the X axis or how fast is
  122997. * the camera rotating.
  122998. */
  122999. angularSensibilityX: number;
  123000. /**
  123001. * Defines the pointer angular sensibility along the Y axis or how fast is
  123002. * the camera rotating.
  123003. */
  123004. angularSensibilityY: number;
  123005. /**
  123006. * Defines the pointer pinch precision or how fast is the camera zooming.
  123007. */
  123008. pinchPrecision: number;
  123009. /**
  123010. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  123011. * from 0.
  123012. * It defines the percentage of current camera.radius to use as delta when
  123013. * pinch zoom is used.
  123014. */
  123015. pinchDeltaPercentage: number;
  123016. /**
  123017. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  123018. * that any object in the plane at the camera's target point will scale
  123019. * perfectly with finger motion.
  123020. * Overrides pinchDeltaPercentage and pinchPrecision.
  123021. */
  123022. useNaturalPinchZoom: boolean;
  123023. /**
  123024. * Defines the pointer panning sensibility or how fast is the camera moving.
  123025. */
  123026. panningSensibility: number;
  123027. /**
  123028. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  123029. */
  123030. multiTouchPanning: boolean;
  123031. /**
  123032. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  123033. * zoom (pinch) through multitouch.
  123034. */
  123035. multiTouchPanAndZoom: boolean;
  123036. /**
  123037. * Revers pinch action direction.
  123038. */
  123039. pinchInwards: boolean;
  123040. private _isPanClick;
  123041. private _twoFingerActivityCount;
  123042. private _isPinching;
  123043. /**
  123044. * Called on pointer POINTERMOVE event if only a single touch is active.
  123045. */
  123046. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  123047. /**
  123048. * Called on pointer POINTERDOUBLETAP event.
  123049. */
  123050. protected onDoubleTap(type: string): void;
  123051. /**
  123052. * Called on pointer POINTERMOVE event if multiple touches are active.
  123053. */
  123054. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  123055. /**
  123056. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  123057. * press.
  123058. */
  123059. protected onButtonDown(evt: PointerEvent): void;
  123060. /**
  123061. * Called each time a new POINTERUP event occurs. Ie, for each button
  123062. * release.
  123063. */
  123064. protected onButtonUp(evt: PointerEvent): void;
  123065. /**
  123066. * Called when window becomes inactive.
  123067. */
  123068. protected onLostFocus(): void;
  123069. }
  123070. }
  123071. declare module BABYLON {
  123072. /**
  123073. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  123074. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123075. */
  123076. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  123077. /**
  123078. * Defines the camera the input is attached to.
  123079. */
  123080. camera: ArcRotateCamera;
  123081. /**
  123082. * Defines the list of key codes associated with the up action (increase alpha)
  123083. */
  123084. keysUp: number[];
  123085. /**
  123086. * Defines the list of key codes associated with the down action (decrease alpha)
  123087. */
  123088. keysDown: number[];
  123089. /**
  123090. * Defines the list of key codes associated with the left action (increase beta)
  123091. */
  123092. keysLeft: number[];
  123093. /**
  123094. * Defines the list of key codes associated with the right action (decrease beta)
  123095. */
  123096. keysRight: number[];
  123097. /**
  123098. * Defines the list of key codes associated with the reset action.
  123099. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  123100. */
  123101. keysReset: number[];
  123102. /**
  123103. * Defines the panning sensibility of the inputs.
  123104. * (How fast is the camera panning)
  123105. */
  123106. panningSensibility: number;
  123107. /**
  123108. * Defines the zooming sensibility of the inputs.
  123109. * (How fast is the camera zooming)
  123110. */
  123111. zoomingSensibility: number;
  123112. /**
  123113. * Defines whether maintaining the alt key down switch the movement mode from
  123114. * orientation to zoom.
  123115. */
  123116. useAltToZoom: boolean;
  123117. /**
  123118. * Rotation speed of the camera
  123119. */
  123120. angularSpeed: number;
  123121. private _keys;
  123122. private _ctrlPressed;
  123123. private _altPressed;
  123124. private _onCanvasBlurObserver;
  123125. private _onKeyboardObserver;
  123126. private _engine;
  123127. private _scene;
  123128. /**
  123129. * Attach the input controls to a specific dom element to get the input from.
  123130. * @param element Defines the element the controls should be listened from
  123131. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123132. */
  123133. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123134. /**
  123135. * Detach the current controls from the specified dom element.
  123136. * @param element Defines the element to stop listening the inputs from
  123137. */
  123138. detachControl(element: Nullable<HTMLElement>): void;
  123139. /**
  123140. * Update the current camera state depending on the inputs that have been used this frame.
  123141. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123142. */
  123143. checkInputs(): void;
  123144. /**
  123145. * Gets the class name of the current intput.
  123146. * @returns the class name
  123147. */
  123148. getClassName(): string;
  123149. /**
  123150. * Get the friendly name associated with the input class.
  123151. * @returns the input friendly name
  123152. */
  123153. getSimpleName(): string;
  123154. }
  123155. }
  123156. declare module BABYLON {
  123157. /**
  123158. * Manage the mouse wheel inputs to control an arc rotate camera.
  123159. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123160. */
  123161. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  123162. /**
  123163. * Defines the camera the input is attached to.
  123164. */
  123165. camera: ArcRotateCamera;
  123166. /**
  123167. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  123168. */
  123169. wheelPrecision: number;
  123170. /**
  123171. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  123172. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  123173. */
  123174. wheelDeltaPercentage: number;
  123175. private _wheel;
  123176. private _observer;
  123177. private computeDeltaFromMouseWheelLegacyEvent;
  123178. /**
  123179. * Attach the input controls to a specific dom element to get the input from.
  123180. * @param element Defines the element the controls should be listened from
  123181. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123182. */
  123183. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123184. /**
  123185. * Detach the current controls from the specified dom element.
  123186. * @param element Defines the element to stop listening the inputs from
  123187. */
  123188. detachControl(element: Nullable<HTMLElement>): void;
  123189. /**
  123190. * Gets the class name of the current intput.
  123191. * @returns the class name
  123192. */
  123193. getClassName(): string;
  123194. /**
  123195. * Get the friendly name associated with the input class.
  123196. * @returns the input friendly name
  123197. */
  123198. getSimpleName(): string;
  123199. }
  123200. }
  123201. declare module BABYLON {
  123202. /**
  123203. * Default Inputs manager for the ArcRotateCamera.
  123204. * It groups all the default supported inputs for ease of use.
  123205. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123206. */
  123207. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  123208. /**
  123209. * Instantiates a new ArcRotateCameraInputsManager.
  123210. * @param camera Defines the camera the inputs belong to
  123211. */
  123212. constructor(camera: ArcRotateCamera);
  123213. /**
  123214. * Add mouse wheel input support to the input manager.
  123215. * @returns the current input manager
  123216. */
  123217. addMouseWheel(): ArcRotateCameraInputsManager;
  123218. /**
  123219. * Add pointers input support to the input manager.
  123220. * @returns the current input manager
  123221. */
  123222. addPointers(): ArcRotateCameraInputsManager;
  123223. /**
  123224. * Add keyboard input support to the input manager.
  123225. * @returns the current input manager
  123226. */
  123227. addKeyboard(): ArcRotateCameraInputsManager;
  123228. }
  123229. }
  123230. declare module BABYLON {
  123231. /**
  123232. * This represents an orbital type of camera.
  123233. *
  123234. * 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.
  123235. * 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.
  123236. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  123237. */
  123238. export class ArcRotateCamera extends TargetCamera {
  123239. /**
  123240. * Defines the rotation angle of the camera along the longitudinal axis.
  123241. */
  123242. alpha: number;
  123243. /**
  123244. * Defines the rotation angle of the camera along the latitudinal axis.
  123245. */
  123246. beta: number;
  123247. /**
  123248. * Defines the radius of the camera from it s target point.
  123249. */
  123250. radius: number;
  123251. protected _target: Vector3;
  123252. protected _targetHost: Nullable<AbstractMesh>;
  123253. /**
  123254. * Defines the target point of the camera.
  123255. * The camera looks towards it form the radius distance.
  123256. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  123257. */
  123258. get target(): Vector3;
  123259. set target(value: Vector3);
  123260. /**
  123261. * Define the current local position of the camera in the scene
  123262. */
  123263. get position(): Vector3;
  123264. set position(newPosition: Vector3);
  123265. protected _upToYMatrix: Matrix;
  123266. protected _YToUpMatrix: Matrix;
  123267. /**
  123268. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  123269. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  123270. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  123271. */
  123272. set upVector(vec: Vector3);
  123273. get upVector(): Vector3;
  123274. /**
  123275. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  123276. */
  123277. setMatUp(): void;
  123278. /**
  123279. * Current inertia value on the longitudinal axis.
  123280. * The bigger this number the longer it will take for the camera to stop.
  123281. */
  123282. inertialAlphaOffset: number;
  123283. /**
  123284. * Current inertia value on the latitudinal axis.
  123285. * The bigger this number the longer it will take for the camera to stop.
  123286. */
  123287. inertialBetaOffset: number;
  123288. /**
  123289. * Current inertia value on the radius axis.
  123290. * The bigger this number the longer it will take for the camera to stop.
  123291. */
  123292. inertialRadiusOffset: number;
  123293. /**
  123294. * Minimum allowed angle on the longitudinal axis.
  123295. * This can help limiting how the Camera is able to move in the scene.
  123296. */
  123297. lowerAlphaLimit: Nullable<number>;
  123298. /**
  123299. * Maximum allowed angle on the longitudinal axis.
  123300. * This can help limiting how the Camera is able to move in the scene.
  123301. */
  123302. upperAlphaLimit: Nullable<number>;
  123303. /**
  123304. * Minimum allowed angle on the latitudinal axis.
  123305. * This can help limiting how the Camera is able to move in the scene.
  123306. */
  123307. lowerBetaLimit: number;
  123308. /**
  123309. * Maximum allowed angle on the latitudinal axis.
  123310. * This can help limiting how the Camera is able to move in the scene.
  123311. */
  123312. upperBetaLimit: number;
  123313. /**
  123314. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  123315. * This can help limiting how the Camera is able to move in the scene.
  123316. */
  123317. lowerRadiusLimit: Nullable<number>;
  123318. /**
  123319. * Maximum allowed distance of the camera to the target (The camera can not get further).
  123320. * This can help limiting how the Camera is able to move in the scene.
  123321. */
  123322. upperRadiusLimit: Nullable<number>;
  123323. /**
  123324. * Defines the current inertia value used during panning of the camera along the X axis.
  123325. */
  123326. inertialPanningX: number;
  123327. /**
  123328. * Defines the current inertia value used during panning of the camera along the Y axis.
  123329. */
  123330. inertialPanningY: number;
  123331. /**
  123332. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  123333. * Basically if your fingers moves away from more than this distance you will be considered
  123334. * in pinch mode.
  123335. */
  123336. pinchToPanMaxDistance: number;
  123337. /**
  123338. * Defines the maximum distance the camera can pan.
  123339. * This could help keeping the cammera always in your scene.
  123340. */
  123341. panningDistanceLimit: Nullable<number>;
  123342. /**
  123343. * Defines the target of the camera before paning.
  123344. */
  123345. panningOriginTarget: Vector3;
  123346. /**
  123347. * Defines the value of the inertia used during panning.
  123348. * 0 would mean stop inertia and one would mean no decelleration at all.
  123349. */
  123350. panningInertia: number;
  123351. /**
  123352. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  123353. */
  123354. get angularSensibilityX(): number;
  123355. set angularSensibilityX(value: number);
  123356. /**
  123357. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  123358. */
  123359. get angularSensibilityY(): number;
  123360. set angularSensibilityY(value: number);
  123361. /**
  123362. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  123363. */
  123364. get pinchPrecision(): number;
  123365. set pinchPrecision(value: number);
  123366. /**
  123367. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  123368. * It will be used instead of pinchDeltaPrecision if different from 0.
  123369. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  123370. */
  123371. get pinchDeltaPercentage(): number;
  123372. set pinchDeltaPercentage(value: number);
  123373. /**
  123374. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  123375. * and pinch delta percentage.
  123376. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  123377. * that any object in the plane at the camera's target point will scale
  123378. * perfectly with finger motion.
  123379. */
  123380. get useNaturalPinchZoom(): boolean;
  123381. set useNaturalPinchZoom(value: boolean);
  123382. /**
  123383. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  123384. */
  123385. get panningSensibility(): number;
  123386. set panningSensibility(value: number);
  123387. /**
  123388. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  123389. */
  123390. get keysUp(): number[];
  123391. set keysUp(value: number[]);
  123392. /**
  123393. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  123394. */
  123395. get keysDown(): number[];
  123396. set keysDown(value: number[]);
  123397. /**
  123398. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  123399. */
  123400. get keysLeft(): number[];
  123401. set keysLeft(value: number[]);
  123402. /**
  123403. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  123404. */
  123405. get keysRight(): number[];
  123406. set keysRight(value: number[]);
  123407. /**
  123408. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  123409. */
  123410. get wheelPrecision(): number;
  123411. set wheelPrecision(value: number);
  123412. /**
  123413. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  123414. * It will be used instead of pinchDeltaPrecision if different from 0.
  123415. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  123416. */
  123417. get wheelDeltaPercentage(): number;
  123418. set wheelDeltaPercentage(value: number);
  123419. /**
  123420. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  123421. */
  123422. zoomOnFactor: number;
  123423. /**
  123424. * Defines a screen offset for the camera position.
  123425. */
  123426. targetScreenOffset: Vector2;
  123427. /**
  123428. * Allows the camera to be completely reversed.
  123429. * If false the camera can not arrive upside down.
  123430. */
  123431. allowUpsideDown: boolean;
  123432. /**
  123433. * Define if double tap/click is used to restore the previously saved state of the camera.
  123434. */
  123435. useInputToRestoreState: boolean;
  123436. /** @hidden */
  123437. _viewMatrix: Matrix;
  123438. /** @hidden */
  123439. _useCtrlForPanning: boolean;
  123440. /** @hidden */
  123441. _panningMouseButton: number;
  123442. /**
  123443. * Defines the input associated to the camera.
  123444. */
  123445. inputs: ArcRotateCameraInputsManager;
  123446. /** @hidden */
  123447. _reset: () => void;
  123448. /**
  123449. * Defines the allowed panning axis.
  123450. */
  123451. panningAxis: Vector3;
  123452. protected _localDirection: Vector3;
  123453. protected _transformedDirection: Vector3;
  123454. private _bouncingBehavior;
  123455. /**
  123456. * Gets the bouncing behavior of the camera if it has been enabled.
  123457. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  123458. */
  123459. get bouncingBehavior(): Nullable<BouncingBehavior>;
  123460. /**
  123461. * Defines if the bouncing behavior of the camera is enabled on the camera.
  123462. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  123463. */
  123464. get useBouncingBehavior(): boolean;
  123465. set useBouncingBehavior(value: boolean);
  123466. private _framingBehavior;
  123467. /**
  123468. * Gets the framing behavior of the camera if it has been enabled.
  123469. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  123470. */
  123471. get framingBehavior(): Nullable<FramingBehavior>;
  123472. /**
  123473. * Defines if the framing behavior of the camera is enabled on the camera.
  123474. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  123475. */
  123476. get useFramingBehavior(): boolean;
  123477. set useFramingBehavior(value: boolean);
  123478. private _autoRotationBehavior;
  123479. /**
  123480. * Gets the auto rotation behavior of the camera if it has been enabled.
  123481. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  123482. */
  123483. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  123484. /**
  123485. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  123486. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  123487. */
  123488. get useAutoRotationBehavior(): boolean;
  123489. set useAutoRotationBehavior(value: boolean);
  123490. /**
  123491. * Observable triggered when the mesh target has been changed on the camera.
  123492. */
  123493. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  123494. /**
  123495. * Event raised when the camera is colliding with a mesh.
  123496. */
  123497. onCollide: (collidedMesh: AbstractMesh) => void;
  123498. /**
  123499. * Defines whether the camera should check collision with the objects oh the scene.
  123500. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  123501. */
  123502. checkCollisions: boolean;
  123503. /**
  123504. * Defines the collision radius of the camera.
  123505. * This simulates a sphere around the camera.
  123506. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  123507. */
  123508. collisionRadius: Vector3;
  123509. protected _collider: Collider;
  123510. protected _previousPosition: Vector3;
  123511. protected _collisionVelocity: Vector3;
  123512. protected _newPosition: Vector3;
  123513. protected _previousAlpha: number;
  123514. protected _previousBeta: number;
  123515. protected _previousRadius: number;
  123516. protected _collisionTriggered: boolean;
  123517. protected _targetBoundingCenter: Nullable<Vector3>;
  123518. private _computationVector;
  123519. /**
  123520. * Instantiates a new ArcRotateCamera in a given scene
  123521. * @param name Defines the name of the camera
  123522. * @param alpha Defines the camera rotation along the logitudinal axis
  123523. * @param beta Defines the camera rotation along the latitudinal axis
  123524. * @param radius Defines the camera distance from its target
  123525. * @param target Defines the camera target
  123526. * @param scene Defines the scene the camera belongs to
  123527. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  123528. */
  123529. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  123530. /** @hidden */
  123531. _initCache(): void;
  123532. /** @hidden */
  123533. _updateCache(ignoreParentClass?: boolean): void;
  123534. protected _getTargetPosition(): Vector3;
  123535. private _storedAlpha;
  123536. private _storedBeta;
  123537. private _storedRadius;
  123538. private _storedTarget;
  123539. private _storedTargetScreenOffset;
  123540. /**
  123541. * Stores the current state of the camera (alpha, beta, radius and target)
  123542. * @returns the camera itself
  123543. */
  123544. storeState(): Camera;
  123545. /**
  123546. * @hidden
  123547. * Restored camera state. You must call storeState() first
  123548. */
  123549. _restoreStateValues(): boolean;
  123550. /** @hidden */
  123551. _isSynchronizedViewMatrix(): boolean;
  123552. /**
  123553. * Attached controls to the current camera.
  123554. * @param element Defines the element the controls should be listened from
  123555. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123556. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  123557. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  123558. */
  123559. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  123560. /**
  123561. * Detach the current controls from the camera.
  123562. * The camera will stop reacting to inputs.
  123563. * @param element Defines the element to stop listening the inputs from
  123564. */
  123565. detachControl(element: HTMLElement): void;
  123566. /** @hidden */
  123567. _checkInputs(): void;
  123568. protected _checkLimits(): void;
  123569. /**
  123570. * Rebuilds angles (alpha, beta) and radius from the give position and target
  123571. */
  123572. rebuildAnglesAndRadius(): void;
  123573. /**
  123574. * Use a position to define the current camera related information like alpha, beta and radius
  123575. * @param position Defines the position to set the camera at
  123576. */
  123577. setPosition(position: Vector3): void;
  123578. /**
  123579. * Defines the target the camera should look at.
  123580. * This will automatically adapt alpha beta and radius to fit within the new target.
  123581. * @param target Defines the new target as a Vector or a mesh
  123582. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  123583. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  123584. */
  123585. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  123586. /** @hidden */
  123587. _getViewMatrix(): Matrix;
  123588. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  123589. /**
  123590. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  123591. * @param meshes Defines the mesh to zoom on
  123592. * @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)
  123593. */
  123594. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  123595. /**
  123596. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  123597. * The target will be changed but the radius
  123598. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  123599. * @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)
  123600. */
  123601. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  123602. min: Vector3;
  123603. max: Vector3;
  123604. distance: number;
  123605. }, doNotUpdateMaxZ?: boolean): void;
  123606. /**
  123607. * @override
  123608. * Override Camera.createRigCamera
  123609. */
  123610. createRigCamera(name: string, cameraIndex: number): Camera;
  123611. /**
  123612. * @hidden
  123613. * @override
  123614. * Override Camera._updateRigCameras
  123615. */
  123616. _updateRigCameras(): void;
  123617. /**
  123618. * Destroy the camera and release the current resources hold by it.
  123619. */
  123620. dispose(): void;
  123621. /**
  123622. * Gets the current object class name.
  123623. * @return the class name
  123624. */
  123625. getClassName(): string;
  123626. }
  123627. }
  123628. declare module BABYLON {
  123629. /**
  123630. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  123631. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  123632. */
  123633. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  123634. /**
  123635. * Gets the name of the behavior.
  123636. */
  123637. get name(): string;
  123638. private _zoomStopsAnimation;
  123639. private _idleRotationSpeed;
  123640. private _idleRotationWaitTime;
  123641. private _idleRotationSpinupTime;
  123642. /**
  123643. * Sets the flag that indicates if user zooming should stop animation.
  123644. */
  123645. set zoomStopsAnimation(flag: boolean);
  123646. /**
  123647. * Gets the flag that indicates if user zooming should stop animation.
  123648. */
  123649. get zoomStopsAnimation(): boolean;
  123650. /**
  123651. * Sets the default speed at which the camera rotates around the model.
  123652. */
  123653. set idleRotationSpeed(speed: number);
  123654. /**
  123655. * Gets the default speed at which the camera rotates around the model.
  123656. */
  123657. get idleRotationSpeed(): number;
  123658. /**
  123659. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  123660. */
  123661. set idleRotationWaitTime(time: number);
  123662. /**
  123663. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  123664. */
  123665. get idleRotationWaitTime(): number;
  123666. /**
  123667. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  123668. */
  123669. set idleRotationSpinupTime(time: number);
  123670. /**
  123671. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  123672. */
  123673. get idleRotationSpinupTime(): number;
  123674. /**
  123675. * Gets a value indicating if the camera is currently rotating because of this behavior
  123676. */
  123677. get rotationInProgress(): boolean;
  123678. private _onPrePointerObservableObserver;
  123679. private _onAfterCheckInputsObserver;
  123680. private _attachedCamera;
  123681. private _isPointerDown;
  123682. private _lastFrameTime;
  123683. private _lastInteractionTime;
  123684. private _cameraRotationSpeed;
  123685. /**
  123686. * Initializes the behavior.
  123687. */
  123688. init(): void;
  123689. /**
  123690. * Attaches the behavior to its arc rotate camera.
  123691. * @param camera Defines the camera to attach the behavior to
  123692. */
  123693. attach(camera: ArcRotateCamera): void;
  123694. /**
  123695. * Detaches the behavior from its current arc rotate camera.
  123696. */
  123697. detach(): void;
  123698. /**
  123699. * Returns true if user is scrolling.
  123700. * @return true if user is scrolling.
  123701. */
  123702. private _userIsZooming;
  123703. private _lastFrameRadius;
  123704. private _shouldAnimationStopForInteraction;
  123705. /**
  123706. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  123707. */
  123708. private _applyUserInteraction;
  123709. private _userIsMoving;
  123710. }
  123711. }
  123712. declare module BABYLON {
  123713. /**
  123714. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  123715. */
  123716. export class AttachToBoxBehavior implements Behavior<Mesh> {
  123717. private ui;
  123718. /**
  123719. * The name of the behavior
  123720. */
  123721. name: string;
  123722. /**
  123723. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  123724. */
  123725. distanceAwayFromFace: number;
  123726. /**
  123727. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  123728. */
  123729. distanceAwayFromBottomOfFace: number;
  123730. private _faceVectors;
  123731. private _target;
  123732. private _scene;
  123733. private _onRenderObserver;
  123734. private _tmpMatrix;
  123735. private _tmpVector;
  123736. /**
  123737. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  123738. * @param ui The transform node that should be attched to the mesh
  123739. */
  123740. constructor(ui: TransformNode);
  123741. /**
  123742. * Initializes the behavior
  123743. */
  123744. init(): void;
  123745. private _closestFace;
  123746. private _zeroVector;
  123747. private _lookAtTmpMatrix;
  123748. private _lookAtToRef;
  123749. /**
  123750. * Attaches the AttachToBoxBehavior to the passed in mesh
  123751. * @param target The mesh that the specified node will be attached to
  123752. */
  123753. attach(target: Mesh): void;
  123754. /**
  123755. * Detaches the behavior from the mesh
  123756. */
  123757. detach(): void;
  123758. }
  123759. }
  123760. declare module BABYLON {
  123761. /**
  123762. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  123763. */
  123764. export class FadeInOutBehavior implements Behavior<Mesh> {
  123765. /**
  123766. * Time in milliseconds to delay before fading in (Default: 0)
  123767. */
  123768. delay: number;
  123769. /**
  123770. * Time in milliseconds for the mesh to fade in (Default: 300)
  123771. */
  123772. fadeInTime: number;
  123773. private _millisecondsPerFrame;
  123774. private _hovered;
  123775. private _hoverValue;
  123776. private _ownerNode;
  123777. /**
  123778. * Instatiates the FadeInOutBehavior
  123779. */
  123780. constructor();
  123781. /**
  123782. * The name of the behavior
  123783. */
  123784. get name(): string;
  123785. /**
  123786. * Initializes the behavior
  123787. */
  123788. init(): void;
  123789. /**
  123790. * Attaches the fade behavior on the passed in mesh
  123791. * @param ownerNode The mesh that will be faded in/out once attached
  123792. */
  123793. attach(ownerNode: Mesh): void;
  123794. /**
  123795. * Detaches the behavior from the mesh
  123796. */
  123797. detach(): void;
  123798. /**
  123799. * Triggers the mesh to begin fading in or out
  123800. * @param value if the object should fade in or out (true to fade in)
  123801. */
  123802. fadeIn(value: boolean): void;
  123803. private _update;
  123804. private _setAllVisibility;
  123805. }
  123806. }
  123807. declare module BABYLON {
  123808. /**
  123809. * Class containing a set of static utilities functions for managing Pivots
  123810. * @hidden
  123811. */
  123812. export class PivotTools {
  123813. private static _PivotCached;
  123814. private static _OldPivotPoint;
  123815. private static _PivotTranslation;
  123816. private static _PivotTmpVector;
  123817. private static _PivotPostMultiplyPivotMatrix;
  123818. /** @hidden */
  123819. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  123820. /** @hidden */
  123821. static _RestorePivotPoint(mesh: AbstractMesh): void;
  123822. }
  123823. }
  123824. declare module BABYLON {
  123825. /**
  123826. * Class containing static functions to help procedurally build meshes
  123827. */
  123828. export class PlaneBuilder {
  123829. /**
  123830. * Creates a plane mesh
  123831. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  123832. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  123833. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  123834. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  123835. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  123836. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  123837. * @param name defines the name of the mesh
  123838. * @param options defines the options used to create the mesh
  123839. * @param scene defines the hosting scene
  123840. * @returns the plane mesh
  123841. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  123842. */
  123843. static CreatePlane(name: string, options: {
  123844. size?: number;
  123845. width?: number;
  123846. height?: number;
  123847. sideOrientation?: number;
  123848. frontUVs?: Vector4;
  123849. backUVs?: Vector4;
  123850. updatable?: boolean;
  123851. sourcePlane?: Plane;
  123852. }, scene?: Nullable<Scene>): Mesh;
  123853. }
  123854. }
  123855. declare module BABYLON {
  123856. /**
  123857. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  123858. */
  123859. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  123860. private static _AnyMouseID;
  123861. /**
  123862. * Abstract mesh the behavior is set on
  123863. */
  123864. attachedNode: AbstractMesh;
  123865. private _dragPlane;
  123866. private _scene;
  123867. private _pointerObserver;
  123868. private _beforeRenderObserver;
  123869. private static _planeScene;
  123870. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  123871. /**
  123872. * 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)
  123873. */
  123874. maxDragAngle: number;
  123875. /**
  123876. * @hidden
  123877. */
  123878. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  123879. /**
  123880. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  123881. */
  123882. currentDraggingPointerID: number;
  123883. /**
  123884. * The last position where the pointer hit the drag plane in world space
  123885. */
  123886. lastDragPosition: Vector3;
  123887. /**
  123888. * If the behavior is currently in a dragging state
  123889. */
  123890. dragging: boolean;
  123891. /**
  123892. * 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)
  123893. */
  123894. dragDeltaRatio: number;
  123895. /**
  123896. * If the drag plane orientation should be updated during the dragging (Default: true)
  123897. */
  123898. updateDragPlane: boolean;
  123899. private _debugMode;
  123900. private _moving;
  123901. /**
  123902. * Fires each time the attached mesh is dragged with the pointer
  123903. * * delta between last drag position and current drag position in world space
  123904. * * dragDistance along the drag axis
  123905. * * dragPlaneNormal normal of the current drag plane used during the drag
  123906. * * dragPlanePoint in world space where the drag intersects the drag plane
  123907. */
  123908. onDragObservable: Observable<{
  123909. delta: Vector3;
  123910. dragPlanePoint: Vector3;
  123911. dragPlaneNormal: Vector3;
  123912. dragDistance: number;
  123913. pointerId: number;
  123914. }>;
  123915. /**
  123916. * Fires each time a drag begins (eg. mouse down on mesh)
  123917. */
  123918. onDragStartObservable: Observable<{
  123919. dragPlanePoint: Vector3;
  123920. pointerId: number;
  123921. }>;
  123922. /**
  123923. * Fires each time a drag ends (eg. mouse release after drag)
  123924. */
  123925. onDragEndObservable: Observable<{
  123926. dragPlanePoint: Vector3;
  123927. pointerId: number;
  123928. }>;
  123929. /**
  123930. * If the attached mesh should be moved when dragged
  123931. */
  123932. moveAttached: boolean;
  123933. /**
  123934. * If the drag behavior will react to drag events (Default: true)
  123935. */
  123936. enabled: boolean;
  123937. /**
  123938. * If pointer events should start and release the drag (Default: true)
  123939. */
  123940. startAndReleaseDragOnPointerEvents: boolean;
  123941. /**
  123942. * If camera controls should be detached during the drag
  123943. */
  123944. detachCameraControls: boolean;
  123945. /**
  123946. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  123947. */
  123948. useObjectOrientationForDragging: boolean;
  123949. private _options;
  123950. /**
  123951. * Gets the options used by the behavior
  123952. */
  123953. get options(): {
  123954. dragAxis?: Vector3;
  123955. dragPlaneNormal?: Vector3;
  123956. };
  123957. /**
  123958. * Sets the options used by the behavior
  123959. */
  123960. set options(options: {
  123961. dragAxis?: Vector3;
  123962. dragPlaneNormal?: Vector3;
  123963. });
  123964. /**
  123965. * Creates a pointer drag behavior that can be attached to a mesh
  123966. * @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)
  123967. */
  123968. constructor(options?: {
  123969. dragAxis?: Vector3;
  123970. dragPlaneNormal?: Vector3;
  123971. });
  123972. /**
  123973. * Predicate to determine if it is valid to move the object to a new position when it is moved
  123974. */
  123975. validateDrag: (targetPosition: Vector3) => boolean;
  123976. /**
  123977. * The name of the behavior
  123978. */
  123979. get name(): string;
  123980. /**
  123981. * Initializes the behavior
  123982. */
  123983. init(): void;
  123984. private _tmpVector;
  123985. private _alternatePickedPoint;
  123986. private _worldDragAxis;
  123987. private _targetPosition;
  123988. private _attachedElement;
  123989. /**
  123990. * Attaches the drag behavior the passed in mesh
  123991. * @param ownerNode The mesh that will be dragged around once attached
  123992. * @param predicate Predicate to use for pick filtering
  123993. */
  123994. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  123995. /**
  123996. * Force relase the drag action by code.
  123997. */
  123998. releaseDrag(): void;
  123999. private _startDragRay;
  124000. private _lastPointerRay;
  124001. /**
  124002. * Simulates the start of a pointer drag event on the behavior
  124003. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  124004. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  124005. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  124006. */
  124007. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  124008. protected _startDrag(pointerId: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  124009. private _dragDelta;
  124010. protected _moveDrag(ray: Ray): void;
  124011. private _pickWithRayOnDragPlane;
  124012. private _pointA;
  124013. private _pointC;
  124014. private _localAxis;
  124015. private _lookAt;
  124016. private _updateDragPlanePosition;
  124017. /**
  124018. * Detaches the behavior from the mesh
  124019. */
  124020. detach(): void;
  124021. }
  124022. }
  124023. declare module BABYLON {
  124024. /**
  124025. * A behavior that when attached to a mesh will allow the mesh to be scaled
  124026. */
  124027. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  124028. private _dragBehaviorA;
  124029. private _dragBehaviorB;
  124030. private _startDistance;
  124031. private _initialScale;
  124032. private _targetScale;
  124033. private _ownerNode;
  124034. private _sceneRenderObserver;
  124035. /**
  124036. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  124037. */
  124038. constructor();
  124039. /**
  124040. * The name of the behavior
  124041. */
  124042. get name(): string;
  124043. /**
  124044. * Initializes the behavior
  124045. */
  124046. init(): void;
  124047. private _getCurrentDistance;
  124048. /**
  124049. * Attaches the scale behavior the passed in mesh
  124050. * @param ownerNode The mesh that will be scaled around once attached
  124051. */
  124052. attach(ownerNode: Mesh): void;
  124053. /**
  124054. * Detaches the behavior from the mesh
  124055. */
  124056. detach(): void;
  124057. }
  124058. }
  124059. declare module BABYLON {
  124060. /**
  124061. * 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
  124062. */
  124063. export class SixDofDragBehavior implements Behavior<Mesh> {
  124064. private static _virtualScene;
  124065. private _ownerNode;
  124066. private _sceneRenderObserver;
  124067. private _scene;
  124068. private _targetPosition;
  124069. private _virtualOriginMesh;
  124070. private _virtualDragMesh;
  124071. private _pointerObserver;
  124072. private _moving;
  124073. private _startingOrientation;
  124074. private _attachedElement;
  124075. /**
  124076. * 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)
  124077. */
  124078. private zDragFactor;
  124079. /**
  124080. * If the object should rotate to face the drag origin
  124081. */
  124082. rotateDraggedObject: boolean;
  124083. /**
  124084. * If the behavior is currently in a dragging state
  124085. */
  124086. dragging: boolean;
  124087. /**
  124088. * 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)
  124089. */
  124090. dragDeltaRatio: number;
  124091. /**
  124092. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  124093. */
  124094. currentDraggingPointerID: number;
  124095. /**
  124096. * If camera controls should be detached during the drag
  124097. */
  124098. detachCameraControls: boolean;
  124099. /**
  124100. * Fires each time a drag starts
  124101. */
  124102. onDragStartObservable: Observable<{}>;
  124103. /**
  124104. * Fires each time a drag ends (eg. mouse release after drag)
  124105. */
  124106. onDragEndObservable: Observable<{}>;
  124107. /**
  124108. * 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
  124109. */
  124110. constructor();
  124111. /**
  124112. * The name of the behavior
  124113. */
  124114. get name(): string;
  124115. /**
  124116. * Initializes the behavior
  124117. */
  124118. init(): void;
  124119. /**
  124120. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  124121. */
  124122. private get _pointerCamera();
  124123. /**
  124124. * Attaches the scale behavior the passed in mesh
  124125. * @param ownerNode The mesh that will be scaled around once attached
  124126. */
  124127. attach(ownerNode: Mesh): void;
  124128. /**
  124129. * Detaches the behavior from the mesh
  124130. */
  124131. detach(): void;
  124132. }
  124133. }
  124134. declare module BABYLON {
  124135. /**
  124136. * Class used to apply inverse kinematics to bones
  124137. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  124138. */
  124139. export class BoneIKController {
  124140. private static _tmpVecs;
  124141. private static _tmpQuat;
  124142. private static _tmpMats;
  124143. /**
  124144. * Gets or sets the target mesh
  124145. */
  124146. targetMesh: AbstractMesh;
  124147. /** Gets or sets the mesh used as pole */
  124148. poleTargetMesh: AbstractMesh;
  124149. /**
  124150. * Gets or sets the bone used as pole
  124151. */
  124152. poleTargetBone: Nullable<Bone>;
  124153. /**
  124154. * Gets or sets the target position
  124155. */
  124156. targetPosition: Vector3;
  124157. /**
  124158. * Gets or sets the pole target position
  124159. */
  124160. poleTargetPosition: Vector3;
  124161. /**
  124162. * Gets or sets the pole target local offset
  124163. */
  124164. poleTargetLocalOffset: Vector3;
  124165. /**
  124166. * Gets or sets the pole angle
  124167. */
  124168. poleAngle: number;
  124169. /**
  124170. * Gets or sets the mesh associated with the controller
  124171. */
  124172. mesh: AbstractMesh;
  124173. /**
  124174. * 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)
  124175. */
  124176. slerpAmount: number;
  124177. private _bone1Quat;
  124178. private _bone1Mat;
  124179. private _bone2Ang;
  124180. private _bone1;
  124181. private _bone2;
  124182. private _bone1Length;
  124183. private _bone2Length;
  124184. private _maxAngle;
  124185. private _maxReach;
  124186. private _rightHandedSystem;
  124187. private _bendAxis;
  124188. private _slerping;
  124189. private _adjustRoll;
  124190. /**
  124191. * Gets or sets maximum allowed angle
  124192. */
  124193. get maxAngle(): number;
  124194. set maxAngle(value: number);
  124195. /**
  124196. * Creates a new BoneIKController
  124197. * @param mesh defines the mesh to control
  124198. * @param bone defines the bone to control
  124199. * @param options defines options to set up the controller
  124200. */
  124201. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  124202. targetMesh?: AbstractMesh;
  124203. poleTargetMesh?: AbstractMesh;
  124204. poleTargetBone?: Bone;
  124205. poleTargetLocalOffset?: Vector3;
  124206. poleAngle?: number;
  124207. bendAxis?: Vector3;
  124208. maxAngle?: number;
  124209. slerpAmount?: number;
  124210. });
  124211. private _setMaxAngle;
  124212. /**
  124213. * Force the controller to update the bones
  124214. */
  124215. update(): void;
  124216. }
  124217. }
  124218. declare module BABYLON {
  124219. /**
  124220. * Class used to make a bone look toward a point in space
  124221. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  124222. */
  124223. export class BoneLookController {
  124224. private static _tmpVecs;
  124225. private static _tmpQuat;
  124226. private static _tmpMats;
  124227. /**
  124228. * The target Vector3 that the bone will look at
  124229. */
  124230. target: Vector3;
  124231. /**
  124232. * The mesh that the bone is attached to
  124233. */
  124234. mesh: AbstractMesh;
  124235. /**
  124236. * The bone that will be looking to the target
  124237. */
  124238. bone: Bone;
  124239. /**
  124240. * The up axis of the coordinate system that is used when the bone is rotated
  124241. */
  124242. upAxis: Vector3;
  124243. /**
  124244. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  124245. */
  124246. upAxisSpace: Space;
  124247. /**
  124248. * Used to make an adjustment to the yaw of the bone
  124249. */
  124250. adjustYaw: number;
  124251. /**
  124252. * Used to make an adjustment to the pitch of the bone
  124253. */
  124254. adjustPitch: number;
  124255. /**
  124256. * Used to make an adjustment to the roll of the bone
  124257. */
  124258. adjustRoll: number;
  124259. /**
  124260. * 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)
  124261. */
  124262. slerpAmount: number;
  124263. private _minYaw;
  124264. private _maxYaw;
  124265. private _minPitch;
  124266. private _maxPitch;
  124267. private _minYawSin;
  124268. private _minYawCos;
  124269. private _maxYawSin;
  124270. private _maxYawCos;
  124271. private _midYawConstraint;
  124272. private _minPitchTan;
  124273. private _maxPitchTan;
  124274. private _boneQuat;
  124275. private _slerping;
  124276. private _transformYawPitch;
  124277. private _transformYawPitchInv;
  124278. private _firstFrameSkipped;
  124279. private _yawRange;
  124280. private _fowardAxis;
  124281. /**
  124282. * Gets or sets the minimum yaw angle that the bone can look to
  124283. */
  124284. get minYaw(): number;
  124285. set minYaw(value: number);
  124286. /**
  124287. * Gets or sets the maximum yaw angle that the bone can look to
  124288. */
  124289. get maxYaw(): number;
  124290. set maxYaw(value: number);
  124291. /**
  124292. * Gets or sets the minimum pitch angle that the bone can look to
  124293. */
  124294. get minPitch(): number;
  124295. set minPitch(value: number);
  124296. /**
  124297. * Gets or sets the maximum pitch angle that the bone can look to
  124298. */
  124299. get maxPitch(): number;
  124300. set maxPitch(value: number);
  124301. /**
  124302. * Create a BoneLookController
  124303. * @param mesh the mesh that the bone belongs to
  124304. * @param bone the bone that will be looking to the target
  124305. * @param target the target Vector3 to look at
  124306. * @param options optional settings:
  124307. * * maxYaw: the maximum angle the bone will yaw to
  124308. * * minYaw: the minimum angle the bone will yaw to
  124309. * * maxPitch: the maximum angle the bone will pitch to
  124310. * * minPitch: the minimum angle the bone will yaw to
  124311. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  124312. * * upAxis: the up axis of the coordinate system
  124313. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  124314. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  124315. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  124316. * * adjustYaw: used to make an adjustment to the yaw of the bone
  124317. * * adjustPitch: used to make an adjustment to the pitch of the bone
  124318. * * adjustRoll: used to make an adjustment to the roll of the bone
  124319. **/
  124320. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  124321. maxYaw?: number;
  124322. minYaw?: number;
  124323. maxPitch?: number;
  124324. minPitch?: number;
  124325. slerpAmount?: number;
  124326. upAxis?: Vector3;
  124327. upAxisSpace?: Space;
  124328. yawAxis?: Vector3;
  124329. pitchAxis?: Vector3;
  124330. adjustYaw?: number;
  124331. adjustPitch?: number;
  124332. adjustRoll?: number;
  124333. });
  124334. /**
  124335. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  124336. */
  124337. update(): void;
  124338. private _getAngleDiff;
  124339. private _getAngleBetween;
  124340. private _isAngleBetween;
  124341. }
  124342. }
  124343. declare module BABYLON {
  124344. /**
  124345. * Manage the gamepad inputs to control an arc rotate camera.
  124346. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124347. */
  124348. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  124349. /**
  124350. * Defines the camera the input is attached to.
  124351. */
  124352. camera: ArcRotateCamera;
  124353. /**
  124354. * Defines the gamepad the input is gathering event from.
  124355. */
  124356. gamepad: Nullable<Gamepad>;
  124357. /**
  124358. * Defines the gamepad rotation sensiblity.
  124359. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  124360. */
  124361. gamepadRotationSensibility: number;
  124362. /**
  124363. * Defines the gamepad move sensiblity.
  124364. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  124365. */
  124366. gamepadMoveSensibility: number;
  124367. private _yAxisScale;
  124368. /**
  124369. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  124370. */
  124371. get invertYAxis(): boolean;
  124372. set invertYAxis(value: boolean);
  124373. private _onGamepadConnectedObserver;
  124374. private _onGamepadDisconnectedObserver;
  124375. /**
  124376. * Attach the input controls to a specific dom element to get the input from.
  124377. * @param element Defines the element the controls should be listened from
  124378. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124379. */
  124380. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124381. /**
  124382. * Detach the current controls from the specified dom element.
  124383. * @param element Defines the element to stop listening the inputs from
  124384. */
  124385. detachControl(element: Nullable<HTMLElement>): void;
  124386. /**
  124387. * Update the current camera state depending on the inputs that have been used this frame.
  124388. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124389. */
  124390. checkInputs(): void;
  124391. /**
  124392. * Gets the class name of the current intput.
  124393. * @returns the class name
  124394. */
  124395. getClassName(): string;
  124396. /**
  124397. * Get the friendly name associated with the input class.
  124398. * @returns the input friendly name
  124399. */
  124400. getSimpleName(): string;
  124401. }
  124402. }
  124403. declare module BABYLON {
  124404. interface ArcRotateCameraInputsManager {
  124405. /**
  124406. * Add orientation input support to the input manager.
  124407. * @returns the current input manager
  124408. */
  124409. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  124410. }
  124411. /**
  124412. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  124413. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124414. */
  124415. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  124416. /**
  124417. * Defines the camera the input is attached to.
  124418. */
  124419. camera: ArcRotateCamera;
  124420. /**
  124421. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  124422. */
  124423. alphaCorrection: number;
  124424. /**
  124425. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  124426. */
  124427. gammaCorrection: number;
  124428. private _alpha;
  124429. private _gamma;
  124430. private _dirty;
  124431. private _deviceOrientationHandler;
  124432. /**
  124433. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  124434. */
  124435. constructor();
  124436. /**
  124437. * Attach the input controls to a specific dom element to get the input from.
  124438. * @param element Defines the element the controls should be listened from
  124439. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124440. */
  124441. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124442. /** @hidden */
  124443. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  124444. /**
  124445. * Update the current camera state depending on the inputs that have been used this frame.
  124446. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124447. */
  124448. checkInputs(): void;
  124449. /**
  124450. * Detach the current controls from the specified dom element.
  124451. * @param element Defines the element to stop listening the inputs from
  124452. */
  124453. detachControl(element: Nullable<HTMLElement>): void;
  124454. /**
  124455. * Gets the class name of the current intput.
  124456. * @returns the class name
  124457. */
  124458. getClassName(): string;
  124459. /**
  124460. * Get the friendly name associated with the input class.
  124461. * @returns the input friendly name
  124462. */
  124463. getSimpleName(): string;
  124464. }
  124465. }
  124466. declare module BABYLON {
  124467. /**
  124468. * Listen to mouse events to control the camera.
  124469. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124470. */
  124471. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  124472. /**
  124473. * Defines the camera the input is attached to.
  124474. */
  124475. camera: FlyCamera;
  124476. /**
  124477. * Defines if touch is enabled. (Default is true.)
  124478. */
  124479. touchEnabled: boolean;
  124480. /**
  124481. * Defines the buttons associated with the input to handle camera rotation.
  124482. */
  124483. buttons: number[];
  124484. /**
  124485. * Assign buttons for Yaw control.
  124486. */
  124487. buttonsYaw: number[];
  124488. /**
  124489. * Assign buttons for Pitch control.
  124490. */
  124491. buttonsPitch: number[];
  124492. /**
  124493. * Assign buttons for Roll control.
  124494. */
  124495. buttonsRoll: number[];
  124496. /**
  124497. * Detect if any button is being pressed while mouse is moved.
  124498. * -1 = Mouse locked.
  124499. * 0 = Left button.
  124500. * 1 = Middle Button.
  124501. * 2 = Right Button.
  124502. */
  124503. activeButton: number;
  124504. /**
  124505. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  124506. * Higher values reduce its sensitivity.
  124507. */
  124508. angularSensibility: number;
  124509. private _mousemoveCallback;
  124510. private _observer;
  124511. private _rollObserver;
  124512. private previousPosition;
  124513. private noPreventDefault;
  124514. private element;
  124515. /**
  124516. * Listen to mouse events to control the camera.
  124517. * @param touchEnabled Define if touch is enabled. (Default is true.)
  124518. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124519. */
  124520. constructor(touchEnabled?: boolean);
  124521. /**
  124522. * Attach the mouse control to the HTML DOM element.
  124523. * @param element Defines the element that listens to the input events.
  124524. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  124525. */
  124526. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124527. /**
  124528. * Detach the current controls from the specified dom element.
  124529. * @param element Defines the element to stop listening the inputs from
  124530. */
  124531. detachControl(element: Nullable<HTMLElement>): void;
  124532. /**
  124533. * Gets the class name of the current input.
  124534. * @returns the class name.
  124535. */
  124536. getClassName(): string;
  124537. /**
  124538. * Get the friendly name associated with the input class.
  124539. * @returns the input's friendly name.
  124540. */
  124541. getSimpleName(): string;
  124542. private _pointerInput;
  124543. private _onMouseMove;
  124544. /**
  124545. * Rotate camera by mouse offset.
  124546. */
  124547. private rotateCamera;
  124548. }
  124549. }
  124550. declare module BABYLON {
  124551. /**
  124552. * Default Inputs manager for the FlyCamera.
  124553. * It groups all the default supported inputs for ease of use.
  124554. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124555. */
  124556. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  124557. /**
  124558. * Instantiates a new FlyCameraInputsManager.
  124559. * @param camera Defines the camera the inputs belong to.
  124560. */
  124561. constructor(camera: FlyCamera);
  124562. /**
  124563. * Add keyboard input support to the input manager.
  124564. * @returns the new FlyCameraKeyboardMoveInput().
  124565. */
  124566. addKeyboard(): FlyCameraInputsManager;
  124567. /**
  124568. * Add mouse input support to the input manager.
  124569. * @param touchEnabled Enable touch screen support.
  124570. * @returns the new FlyCameraMouseInput().
  124571. */
  124572. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  124573. }
  124574. }
  124575. declare module BABYLON {
  124576. /**
  124577. * This is a flying camera, designed for 3D movement and rotation in all directions,
  124578. * such as in a 3D Space Shooter or a Flight Simulator.
  124579. */
  124580. export class FlyCamera extends TargetCamera {
  124581. /**
  124582. * Define the collision ellipsoid of the camera.
  124583. * This is helpful for simulating a camera body, like a player's body.
  124584. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  124585. */
  124586. ellipsoid: Vector3;
  124587. /**
  124588. * Define an offset for the position of the ellipsoid around the camera.
  124589. * This can be helpful if the camera is attached away from the player's body center,
  124590. * such as at its head.
  124591. */
  124592. ellipsoidOffset: Vector3;
  124593. /**
  124594. * Enable or disable collisions of the camera with the rest of the scene objects.
  124595. */
  124596. checkCollisions: boolean;
  124597. /**
  124598. * Enable or disable gravity on the camera.
  124599. */
  124600. applyGravity: boolean;
  124601. /**
  124602. * Define the current direction the camera is moving to.
  124603. */
  124604. cameraDirection: Vector3;
  124605. /**
  124606. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  124607. * This overrides and empties cameraRotation.
  124608. */
  124609. rotationQuaternion: Quaternion;
  124610. /**
  124611. * Track Roll to maintain the wanted Rolling when looking around.
  124612. */
  124613. _trackRoll: number;
  124614. /**
  124615. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  124616. */
  124617. rollCorrect: number;
  124618. /**
  124619. * Mimic a banked turn, Rolling the camera when Yawing.
  124620. * It's recommended to use rollCorrect = 10 for faster banking correction.
  124621. */
  124622. bankedTurn: boolean;
  124623. /**
  124624. * Limit in radians for how much Roll banking will add. (Default: 90°)
  124625. */
  124626. bankedTurnLimit: number;
  124627. /**
  124628. * Value of 0 disables the banked Roll.
  124629. * Value of 1 is equal to the Yaw angle in radians.
  124630. */
  124631. bankedTurnMultiplier: number;
  124632. /**
  124633. * The inputs manager loads all the input sources, such as keyboard and mouse.
  124634. */
  124635. inputs: FlyCameraInputsManager;
  124636. /**
  124637. * Gets the input sensibility for mouse input.
  124638. * Higher values reduce sensitivity.
  124639. */
  124640. get angularSensibility(): number;
  124641. /**
  124642. * Sets the input sensibility for a mouse input.
  124643. * Higher values reduce sensitivity.
  124644. */
  124645. set angularSensibility(value: number);
  124646. /**
  124647. * Get the keys for camera movement forward.
  124648. */
  124649. get keysForward(): number[];
  124650. /**
  124651. * Set the keys for camera movement forward.
  124652. */
  124653. set keysForward(value: number[]);
  124654. /**
  124655. * Get the keys for camera movement backward.
  124656. */
  124657. get keysBackward(): number[];
  124658. set keysBackward(value: number[]);
  124659. /**
  124660. * Get the keys for camera movement up.
  124661. */
  124662. get keysUp(): number[];
  124663. /**
  124664. * Set the keys for camera movement up.
  124665. */
  124666. set keysUp(value: number[]);
  124667. /**
  124668. * Get the keys for camera movement down.
  124669. */
  124670. get keysDown(): number[];
  124671. /**
  124672. * Set the keys for camera movement down.
  124673. */
  124674. set keysDown(value: number[]);
  124675. /**
  124676. * Get the keys for camera movement left.
  124677. */
  124678. get keysLeft(): number[];
  124679. /**
  124680. * Set the keys for camera movement left.
  124681. */
  124682. set keysLeft(value: number[]);
  124683. /**
  124684. * Set the keys for camera movement right.
  124685. */
  124686. get keysRight(): number[];
  124687. /**
  124688. * Set the keys for camera movement right.
  124689. */
  124690. set keysRight(value: number[]);
  124691. /**
  124692. * Event raised when the camera collides with a mesh in the scene.
  124693. */
  124694. onCollide: (collidedMesh: AbstractMesh) => void;
  124695. private _collider;
  124696. private _needMoveForGravity;
  124697. private _oldPosition;
  124698. private _diffPosition;
  124699. private _newPosition;
  124700. /** @hidden */
  124701. _localDirection: Vector3;
  124702. /** @hidden */
  124703. _transformedDirection: Vector3;
  124704. /**
  124705. * Instantiates a FlyCamera.
  124706. * This is a flying camera, designed for 3D movement and rotation in all directions,
  124707. * such as in a 3D Space Shooter or a Flight Simulator.
  124708. * @param name Define the name of the camera in the scene.
  124709. * @param position Define the starting position of the camera in the scene.
  124710. * @param scene Define the scene the camera belongs to.
  124711. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  124712. */
  124713. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  124714. /**
  124715. * Attach a control to the HTML DOM element.
  124716. * @param element Defines the element that listens to the input events.
  124717. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  124718. */
  124719. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124720. /**
  124721. * Detach a control from the HTML DOM element.
  124722. * The camera will stop reacting to that input.
  124723. * @param element Defines the element that listens to the input events.
  124724. */
  124725. detachControl(element: HTMLElement): void;
  124726. private _collisionMask;
  124727. /**
  124728. * Get the mask that the camera ignores in collision events.
  124729. */
  124730. get collisionMask(): number;
  124731. /**
  124732. * Set the mask that the camera ignores in collision events.
  124733. */
  124734. set collisionMask(mask: number);
  124735. /** @hidden */
  124736. _collideWithWorld(displacement: Vector3): void;
  124737. /** @hidden */
  124738. private _onCollisionPositionChange;
  124739. /** @hidden */
  124740. _checkInputs(): void;
  124741. /** @hidden */
  124742. _decideIfNeedsToMove(): boolean;
  124743. /** @hidden */
  124744. _updatePosition(): void;
  124745. /**
  124746. * Restore the Roll to its target value at the rate specified.
  124747. * @param rate - Higher means slower restoring.
  124748. * @hidden
  124749. */
  124750. restoreRoll(rate: number): void;
  124751. /**
  124752. * Destroy the camera and release the current resources held by it.
  124753. */
  124754. dispose(): void;
  124755. /**
  124756. * Get the current object class name.
  124757. * @returns the class name.
  124758. */
  124759. getClassName(): string;
  124760. }
  124761. }
  124762. declare module BABYLON {
  124763. /**
  124764. * Listen to keyboard events to control the camera.
  124765. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124766. */
  124767. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  124768. /**
  124769. * Defines the camera the input is attached to.
  124770. */
  124771. camera: FlyCamera;
  124772. /**
  124773. * The list of keyboard keys used to control the forward move of the camera.
  124774. */
  124775. keysForward: number[];
  124776. /**
  124777. * The list of keyboard keys used to control the backward move of the camera.
  124778. */
  124779. keysBackward: number[];
  124780. /**
  124781. * The list of keyboard keys used to control the forward move of the camera.
  124782. */
  124783. keysUp: number[];
  124784. /**
  124785. * The list of keyboard keys used to control the backward move of the camera.
  124786. */
  124787. keysDown: number[];
  124788. /**
  124789. * The list of keyboard keys used to control the right strafe move of the camera.
  124790. */
  124791. keysRight: number[];
  124792. /**
  124793. * The list of keyboard keys used to control the left strafe move of the camera.
  124794. */
  124795. keysLeft: number[];
  124796. private _keys;
  124797. private _onCanvasBlurObserver;
  124798. private _onKeyboardObserver;
  124799. private _engine;
  124800. private _scene;
  124801. /**
  124802. * Attach the input controls to a specific dom element to get the input from.
  124803. * @param element Defines the element the controls should be listened from
  124804. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124805. */
  124806. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124807. /**
  124808. * Detach the current controls from the specified dom element.
  124809. * @param element Defines the element to stop listening the inputs from
  124810. */
  124811. detachControl(element: Nullable<HTMLElement>): void;
  124812. /**
  124813. * Gets the class name of the current intput.
  124814. * @returns the class name
  124815. */
  124816. getClassName(): string;
  124817. /** @hidden */
  124818. _onLostFocus(e: FocusEvent): void;
  124819. /**
  124820. * Get the friendly name associated with the input class.
  124821. * @returns the input friendly name
  124822. */
  124823. getSimpleName(): string;
  124824. /**
  124825. * Update the current camera state depending on the inputs that have been used this frame.
  124826. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124827. */
  124828. checkInputs(): void;
  124829. }
  124830. }
  124831. declare module BABYLON {
  124832. /**
  124833. * Manage the mouse wheel inputs to control a follow camera.
  124834. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124835. */
  124836. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  124837. /**
  124838. * Defines the camera the input is attached to.
  124839. */
  124840. camera: FollowCamera;
  124841. /**
  124842. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  124843. */
  124844. axisControlRadius: boolean;
  124845. /**
  124846. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  124847. */
  124848. axisControlHeight: boolean;
  124849. /**
  124850. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  124851. */
  124852. axisControlRotation: boolean;
  124853. /**
  124854. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  124855. * relation to mouseWheel events.
  124856. */
  124857. wheelPrecision: number;
  124858. /**
  124859. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  124860. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  124861. */
  124862. wheelDeltaPercentage: number;
  124863. private _wheel;
  124864. private _observer;
  124865. /**
  124866. * Attach the input controls to a specific dom element to get the input from.
  124867. * @param element Defines the element the controls should be listened from
  124868. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124869. */
  124870. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124871. /**
  124872. * Detach the current controls from the specified dom element.
  124873. * @param element Defines the element to stop listening the inputs from
  124874. */
  124875. detachControl(element: Nullable<HTMLElement>): void;
  124876. /**
  124877. * Gets the class name of the current intput.
  124878. * @returns the class name
  124879. */
  124880. getClassName(): string;
  124881. /**
  124882. * Get the friendly name associated with the input class.
  124883. * @returns the input friendly name
  124884. */
  124885. getSimpleName(): string;
  124886. }
  124887. }
  124888. declare module BABYLON {
  124889. /**
  124890. * Manage the pointers inputs to control an follow camera.
  124891. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124892. */
  124893. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  124894. /**
  124895. * Defines the camera the input is attached to.
  124896. */
  124897. camera: FollowCamera;
  124898. /**
  124899. * Gets the class name of the current input.
  124900. * @returns the class name
  124901. */
  124902. getClassName(): string;
  124903. /**
  124904. * Defines the pointer angular sensibility along the X axis or how fast is
  124905. * the camera rotating.
  124906. * A negative number will reverse the axis direction.
  124907. */
  124908. angularSensibilityX: number;
  124909. /**
  124910. * Defines the pointer angular sensibility along the Y axis or how fast is
  124911. * the camera rotating.
  124912. * A negative number will reverse the axis direction.
  124913. */
  124914. angularSensibilityY: number;
  124915. /**
  124916. * Defines the pointer pinch precision or how fast is the camera zooming.
  124917. * A negative number will reverse the axis direction.
  124918. */
  124919. pinchPrecision: number;
  124920. /**
  124921. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  124922. * from 0.
  124923. * It defines the percentage of current camera.radius to use as delta when
  124924. * pinch zoom is used.
  124925. */
  124926. pinchDeltaPercentage: number;
  124927. /**
  124928. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  124929. */
  124930. axisXControlRadius: boolean;
  124931. /**
  124932. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  124933. */
  124934. axisXControlHeight: boolean;
  124935. /**
  124936. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  124937. */
  124938. axisXControlRotation: boolean;
  124939. /**
  124940. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  124941. */
  124942. axisYControlRadius: boolean;
  124943. /**
  124944. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  124945. */
  124946. axisYControlHeight: boolean;
  124947. /**
  124948. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  124949. */
  124950. axisYControlRotation: boolean;
  124951. /**
  124952. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  124953. */
  124954. axisPinchControlRadius: boolean;
  124955. /**
  124956. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  124957. */
  124958. axisPinchControlHeight: boolean;
  124959. /**
  124960. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  124961. */
  124962. axisPinchControlRotation: boolean;
  124963. /**
  124964. * Log error messages if basic misconfiguration has occurred.
  124965. */
  124966. warningEnable: boolean;
  124967. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  124968. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  124969. private _warningCounter;
  124970. private _warning;
  124971. }
  124972. }
  124973. declare module BABYLON {
  124974. /**
  124975. * Default Inputs manager for the FollowCamera.
  124976. * It groups all the default supported inputs for ease of use.
  124977. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124978. */
  124979. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  124980. /**
  124981. * Instantiates a new FollowCameraInputsManager.
  124982. * @param camera Defines the camera the inputs belong to
  124983. */
  124984. constructor(camera: FollowCamera);
  124985. /**
  124986. * Add keyboard input support to the input manager.
  124987. * @returns the current input manager
  124988. */
  124989. addKeyboard(): FollowCameraInputsManager;
  124990. /**
  124991. * Add mouse wheel input support to the input manager.
  124992. * @returns the current input manager
  124993. */
  124994. addMouseWheel(): FollowCameraInputsManager;
  124995. /**
  124996. * Add pointers input support to the input manager.
  124997. * @returns the current input manager
  124998. */
  124999. addPointers(): FollowCameraInputsManager;
  125000. /**
  125001. * Add orientation input support to the input manager.
  125002. * @returns the current input manager
  125003. */
  125004. addVRDeviceOrientation(): FollowCameraInputsManager;
  125005. }
  125006. }
  125007. declare module BABYLON {
  125008. /**
  125009. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  125010. * an arc rotate version arcFollowCamera are available.
  125011. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  125012. */
  125013. export class FollowCamera extends TargetCamera {
  125014. /**
  125015. * Distance the follow camera should follow an object at
  125016. */
  125017. radius: number;
  125018. /**
  125019. * Minimum allowed distance of the camera to the axis of rotation
  125020. * (The camera can not get closer).
  125021. * This can help limiting how the Camera is able to move in the scene.
  125022. */
  125023. lowerRadiusLimit: Nullable<number>;
  125024. /**
  125025. * Maximum allowed distance of the camera to the axis of rotation
  125026. * (The camera can not get further).
  125027. * This can help limiting how the Camera is able to move in the scene.
  125028. */
  125029. upperRadiusLimit: Nullable<number>;
  125030. /**
  125031. * Define a rotation offset between the camera and the object it follows
  125032. */
  125033. rotationOffset: number;
  125034. /**
  125035. * Minimum allowed angle to camera position relative to target object.
  125036. * This can help limiting how the Camera is able to move in the scene.
  125037. */
  125038. lowerRotationOffsetLimit: Nullable<number>;
  125039. /**
  125040. * Maximum allowed angle to camera position relative to target object.
  125041. * This can help limiting how the Camera is able to move in the scene.
  125042. */
  125043. upperRotationOffsetLimit: Nullable<number>;
  125044. /**
  125045. * Define a height offset between the camera and the object it follows.
  125046. * It can help following an object from the top (like a car chaing a plane)
  125047. */
  125048. heightOffset: number;
  125049. /**
  125050. * Minimum allowed height of camera position relative to target object.
  125051. * This can help limiting how the Camera is able to move in the scene.
  125052. */
  125053. lowerHeightOffsetLimit: Nullable<number>;
  125054. /**
  125055. * Maximum allowed height of camera position relative to target object.
  125056. * This can help limiting how the Camera is able to move in the scene.
  125057. */
  125058. upperHeightOffsetLimit: Nullable<number>;
  125059. /**
  125060. * Define how fast the camera can accelerate to follow it s target.
  125061. */
  125062. cameraAcceleration: number;
  125063. /**
  125064. * Define the speed limit of the camera following an object.
  125065. */
  125066. maxCameraSpeed: number;
  125067. /**
  125068. * Define the target of the camera.
  125069. */
  125070. lockedTarget: Nullable<AbstractMesh>;
  125071. /**
  125072. * Defines the input associated with the camera.
  125073. */
  125074. inputs: FollowCameraInputsManager;
  125075. /**
  125076. * Instantiates the follow camera.
  125077. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  125078. * @param name Define the name of the camera in the scene
  125079. * @param position Define the position of the camera
  125080. * @param scene Define the scene the camera belong to
  125081. * @param lockedTarget Define the target of the camera
  125082. */
  125083. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  125084. private _follow;
  125085. /**
  125086. * Attached controls to the current camera.
  125087. * @param element Defines the element the controls should be listened from
  125088. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  125089. */
  125090. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  125091. /**
  125092. * Detach the current controls from the camera.
  125093. * The camera will stop reacting to inputs.
  125094. * @param element Defines the element to stop listening the inputs from
  125095. */
  125096. detachControl(element: HTMLElement): void;
  125097. /** @hidden */
  125098. _checkInputs(): void;
  125099. private _checkLimits;
  125100. /**
  125101. * Gets the camera class name.
  125102. * @returns the class name
  125103. */
  125104. getClassName(): string;
  125105. }
  125106. /**
  125107. * Arc Rotate version of the follow camera.
  125108. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  125109. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  125110. */
  125111. export class ArcFollowCamera extends TargetCamera {
  125112. /** The longitudinal angle of the camera */
  125113. alpha: number;
  125114. /** The latitudinal angle of the camera */
  125115. beta: number;
  125116. /** The radius of the camera from its target */
  125117. radius: number;
  125118. private _cartesianCoordinates;
  125119. /** Define the camera target (the mesh it should follow) */
  125120. private _meshTarget;
  125121. /**
  125122. * Instantiates a new ArcFollowCamera
  125123. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  125124. * @param name Define the name of the camera
  125125. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  125126. * @param beta Define the rotation angle of the camera around the elevation axis
  125127. * @param radius Define the radius of the camera from its target point
  125128. * @param target Define the target of the camera
  125129. * @param scene Define the scene the camera belongs to
  125130. */
  125131. constructor(name: string,
  125132. /** The longitudinal angle of the camera */
  125133. alpha: number,
  125134. /** The latitudinal angle of the camera */
  125135. beta: number,
  125136. /** The radius of the camera from its target */
  125137. radius: number,
  125138. /** Define the camera target (the mesh it should follow) */
  125139. target: Nullable<AbstractMesh>, scene: Scene);
  125140. private _follow;
  125141. /** @hidden */
  125142. _checkInputs(): void;
  125143. /**
  125144. * Returns the class name of the object.
  125145. * It is mostly used internally for serialization purposes.
  125146. */
  125147. getClassName(): string;
  125148. }
  125149. }
  125150. declare module BABYLON {
  125151. /**
  125152. * Manage the keyboard inputs to control the movement of a follow camera.
  125153. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  125154. */
  125155. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  125156. /**
  125157. * Defines the camera the input is attached to.
  125158. */
  125159. camera: FollowCamera;
  125160. /**
  125161. * Defines the list of key codes associated with the up action (increase heightOffset)
  125162. */
  125163. keysHeightOffsetIncr: number[];
  125164. /**
  125165. * Defines the list of key codes associated with the down action (decrease heightOffset)
  125166. */
  125167. keysHeightOffsetDecr: number[];
  125168. /**
  125169. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  125170. */
  125171. keysHeightOffsetModifierAlt: boolean;
  125172. /**
  125173. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  125174. */
  125175. keysHeightOffsetModifierCtrl: boolean;
  125176. /**
  125177. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  125178. */
  125179. keysHeightOffsetModifierShift: boolean;
  125180. /**
  125181. * Defines the list of key codes associated with the left action (increase rotationOffset)
  125182. */
  125183. keysRotationOffsetIncr: number[];
  125184. /**
  125185. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  125186. */
  125187. keysRotationOffsetDecr: number[];
  125188. /**
  125189. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  125190. */
  125191. keysRotationOffsetModifierAlt: boolean;
  125192. /**
  125193. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  125194. */
  125195. keysRotationOffsetModifierCtrl: boolean;
  125196. /**
  125197. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  125198. */
  125199. keysRotationOffsetModifierShift: boolean;
  125200. /**
  125201. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  125202. */
  125203. keysRadiusIncr: number[];
  125204. /**
  125205. * Defines the list of key codes associated with the zoom-out action (increase radius)
  125206. */
  125207. keysRadiusDecr: number[];
  125208. /**
  125209. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  125210. */
  125211. keysRadiusModifierAlt: boolean;
  125212. /**
  125213. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  125214. */
  125215. keysRadiusModifierCtrl: boolean;
  125216. /**
  125217. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  125218. */
  125219. keysRadiusModifierShift: boolean;
  125220. /**
  125221. * Defines the rate of change of heightOffset.
  125222. */
  125223. heightSensibility: number;
  125224. /**
  125225. * Defines the rate of change of rotationOffset.
  125226. */
  125227. rotationSensibility: number;
  125228. /**
  125229. * Defines the rate of change of radius.
  125230. */
  125231. radiusSensibility: number;
  125232. private _keys;
  125233. private _ctrlPressed;
  125234. private _altPressed;
  125235. private _shiftPressed;
  125236. private _onCanvasBlurObserver;
  125237. private _onKeyboardObserver;
  125238. private _engine;
  125239. private _scene;
  125240. /**
  125241. * Attach the input controls to a specific dom element to get the input from.
  125242. * @param element Defines the element the controls should be listened from
  125243. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  125244. */
  125245. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  125246. /**
  125247. * Detach the current controls from the specified dom element.
  125248. * @param element Defines the element to stop listening the inputs from
  125249. */
  125250. detachControl(element: Nullable<HTMLElement>): void;
  125251. /**
  125252. * Update the current camera state depending on the inputs that have been used this frame.
  125253. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  125254. */
  125255. checkInputs(): void;
  125256. /**
  125257. * Gets the class name of the current input.
  125258. * @returns the class name
  125259. */
  125260. getClassName(): string;
  125261. /**
  125262. * Get the friendly name associated with the input class.
  125263. * @returns the input friendly name
  125264. */
  125265. getSimpleName(): string;
  125266. /**
  125267. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  125268. * allow modification of the heightOffset value.
  125269. */
  125270. private _modifierHeightOffset;
  125271. /**
  125272. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  125273. * allow modification of the rotationOffset value.
  125274. */
  125275. private _modifierRotationOffset;
  125276. /**
  125277. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  125278. * allow modification of the radius value.
  125279. */
  125280. private _modifierRadius;
  125281. }
  125282. }
  125283. declare module BABYLON {
  125284. interface FreeCameraInputsManager {
  125285. /**
  125286. * @hidden
  125287. */
  125288. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  125289. /**
  125290. * Add orientation input support to the input manager.
  125291. * @returns the current input manager
  125292. */
  125293. addDeviceOrientation(): FreeCameraInputsManager;
  125294. }
  125295. /**
  125296. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  125297. * Screen rotation is taken into account.
  125298. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  125299. */
  125300. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  125301. private _camera;
  125302. private _screenOrientationAngle;
  125303. private _constantTranform;
  125304. private _screenQuaternion;
  125305. private _alpha;
  125306. private _beta;
  125307. private _gamma;
  125308. /**
  125309. * Can be used to detect if a device orientation sensor is available on a device
  125310. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  125311. * @returns a promise that will resolve on orientation change
  125312. */
  125313. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  125314. /**
  125315. * @hidden
  125316. */
  125317. _onDeviceOrientationChangedObservable: Observable<void>;
  125318. /**
  125319. * Instantiates a new input
  125320. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  125321. */
  125322. constructor();
  125323. /**
  125324. * Define the camera controlled by the input.
  125325. */
  125326. get camera(): FreeCamera;
  125327. set camera(camera: FreeCamera);
  125328. /**
  125329. * Attach the input controls to a specific dom element to get the input from.
  125330. * @param element Defines the element the controls should be listened from
  125331. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  125332. */
  125333. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  125334. private _orientationChanged;
  125335. private _deviceOrientation;
  125336. /**
  125337. * Detach the current controls from the specified dom element.
  125338. * @param element Defines the element to stop listening the inputs from
  125339. */
  125340. detachControl(element: Nullable<HTMLElement>): void;
  125341. /**
  125342. * Update the current camera state depending on the inputs that have been used this frame.
  125343. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  125344. */
  125345. checkInputs(): void;
  125346. /**
  125347. * Gets the class name of the current intput.
  125348. * @returns the class name
  125349. */
  125350. getClassName(): string;
  125351. /**
  125352. * Get the friendly name associated with the input class.
  125353. * @returns the input friendly name
  125354. */
  125355. getSimpleName(): string;
  125356. }
  125357. }
  125358. declare module BABYLON {
  125359. /**
  125360. * Manage the gamepad inputs to control a free camera.
  125361. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  125362. */
  125363. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  125364. /**
  125365. * Define the camera the input is attached to.
  125366. */
  125367. camera: FreeCamera;
  125368. /**
  125369. * Define the Gamepad controlling the input
  125370. */
  125371. gamepad: Nullable<Gamepad>;
  125372. /**
  125373. * Defines the gamepad rotation sensiblity.
  125374. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  125375. */
  125376. gamepadAngularSensibility: number;
  125377. /**
  125378. * Defines the gamepad move sensiblity.
  125379. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  125380. */
  125381. gamepadMoveSensibility: number;
  125382. private _yAxisScale;
  125383. /**
  125384. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  125385. */
  125386. get invertYAxis(): boolean;
  125387. set invertYAxis(value: boolean);
  125388. private _onGamepadConnectedObserver;
  125389. private _onGamepadDisconnectedObserver;
  125390. private _cameraTransform;
  125391. private _deltaTransform;
  125392. private _vector3;
  125393. private _vector2;
  125394. /**
  125395. * Attach the input controls to a specific dom element to get the input from.
  125396. * @param element Defines the element the controls should be listened from
  125397. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  125398. */
  125399. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  125400. /**
  125401. * Detach the current controls from the specified dom element.
  125402. * @param element Defines the element to stop listening the inputs from
  125403. */
  125404. detachControl(element: Nullable<HTMLElement>): void;
  125405. /**
  125406. * Update the current camera state depending on the inputs that have been used this frame.
  125407. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  125408. */
  125409. checkInputs(): void;
  125410. /**
  125411. * Gets the class name of the current intput.
  125412. * @returns the class name
  125413. */
  125414. getClassName(): string;
  125415. /**
  125416. * Get the friendly name associated with the input class.
  125417. * @returns the input friendly name
  125418. */
  125419. getSimpleName(): string;
  125420. }
  125421. }
  125422. declare module BABYLON {
  125423. /**
  125424. * Defines the potential axis of a Joystick
  125425. */
  125426. export enum JoystickAxis {
  125427. /** X axis */
  125428. X = 0,
  125429. /** Y axis */
  125430. Y = 1,
  125431. /** Z axis */
  125432. Z = 2
  125433. }
  125434. /**
  125435. * Represents the different customization options available
  125436. * for VirtualJoystick
  125437. */
  125438. interface VirtualJoystickCustomizations {
  125439. /**
  125440. * Size of the joystick's puck
  125441. */
  125442. puckSize: number;
  125443. /**
  125444. * Size of the joystick's container
  125445. */
  125446. containerSize: number;
  125447. /**
  125448. * Color of the joystick && puck
  125449. */
  125450. color: string;
  125451. /**
  125452. * Image URL for the joystick's puck
  125453. */
  125454. puckImage?: string;
  125455. /**
  125456. * Image URL for the joystick's container
  125457. */
  125458. containerImage?: string;
  125459. /**
  125460. * Defines the unmoving position of the joystick container
  125461. */
  125462. position?: {
  125463. x: number;
  125464. y: number;
  125465. };
  125466. /**
  125467. * Defines whether or not the joystick container is always visible
  125468. */
  125469. alwaysVisible: boolean;
  125470. /**
  125471. * Defines whether or not to limit the movement of the puck to the joystick's container
  125472. */
  125473. limitToContainer: boolean;
  125474. }
  125475. /**
  125476. * Class used to define virtual joystick (used in touch mode)
  125477. */
  125478. export class VirtualJoystick {
  125479. /**
  125480. * Gets or sets a boolean indicating that left and right values must be inverted
  125481. */
  125482. reverseLeftRight: boolean;
  125483. /**
  125484. * Gets or sets a boolean indicating that up and down values must be inverted
  125485. */
  125486. reverseUpDown: boolean;
  125487. /**
  125488. * Gets the offset value for the position (ie. the change of the position value)
  125489. */
  125490. deltaPosition: Vector3;
  125491. /**
  125492. * Gets a boolean indicating if the virtual joystick was pressed
  125493. */
  125494. pressed: boolean;
  125495. /**
  125496. * Canvas the virtual joystick will render onto, default z-index of this is 5
  125497. */
  125498. static Canvas: Nullable<HTMLCanvasElement>;
  125499. /**
  125500. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  125501. */
  125502. limitToContainer: boolean;
  125503. private static _globalJoystickIndex;
  125504. private static _alwaysVisibleSticks;
  125505. private static vjCanvasContext;
  125506. private static vjCanvasWidth;
  125507. private static vjCanvasHeight;
  125508. private static halfWidth;
  125509. private static _GetDefaultOptions;
  125510. private _action;
  125511. private _axisTargetedByLeftAndRight;
  125512. private _axisTargetedByUpAndDown;
  125513. private _joystickSensibility;
  125514. private _inversedSensibility;
  125515. private _joystickPointerID;
  125516. private _joystickColor;
  125517. private _joystickPointerPos;
  125518. private _joystickPreviousPointerPos;
  125519. private _joystickPointerStartPos;
  125520. private _deltaJoystickVector;
  125521. private _leftJoystick;
  125522. private _touches;
  125523. private _joystickPosition;
  125524. private _alwaysVisible;
  125525. private _puckImage;
  125526. private _containerImage;
  125527. private _joystickPuckSize;
  125528. private _joystickContainerSize;
  125529. private _clearPuckSize;
  125530. private _clearContainerSize;
  125531. private _clearPuckSizeOffset;
  125532. private _clearContainerSizeOffset;
  125533. private _onPointerDownHandlerRef;
  125534. private _onPointerMoveHandlerRef;
  125535. private _onPointerUpHandlerRef;
  125536. private _onResize;
  125537. /**
  125538. * Creates a new virtual joystick
  125539. * @param leftJoystick defines that the joystick is for left hand (false by default)
  125540. * @param customizations Defines the options we want to customize the VirtualJoystick
  125541. */
  125542. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  125543. /**
  125544. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  125545. * @param newJoystickSensibility defines the new sensibility
  125546. */
  125547. setJoystickSensibility(newJoystickSensibility: number): void;
  125548. private _onPointerDown;
  125549. private _onPointerMove;
  125550. private _onPointerUp;
  125551. /**
  125552. * Change the color of the virtual joystick
  125553. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  125554. */
  125555. setJoystickColor(newColor: string): void;
  125556. /**
  125557. * Size of the joystick's container
  125558. */
  125559. set containerSize(newSize: number);
  125560. get containerSize(): number;
  125561. /**
  125562. * Size of the joystick's puck
  125563. */
  125564. set puckSize(newSize: number);
  125565. get puckSize(): number;
  125566. /**
  125567. * Clears the set position of the joystick
  125568. */
  125569. clearPosition(): void;
  125570. /**
  125571. * Defines whether or not the joystick container is always visible
  125572. */
  125573. set alwaysVisible(value: boolean);
  125574. get alwaysVisible(): boolean;
  125575. /**
  125576. * Sets the constant position of the Joystick container
  125577. * @param x X axis coordinate
  125578. * @param y Y axis coordinate
  125579. */
  125580. setPosition(x: number, y: number): void;
  125581. /**
  125582. * Defines a callback to call when the joystick is touched
  125583. * @param action defines the callback
  125584. */
  125585. setActionOnTouch(action: () => any): void;
  125586. /**
  125587. * Defines which axis you'd like to control for left & right
  125588. * @param axis defines the axis to use
  125589. */
  125590. setAxisForLeftRight(axis: JoystickAxis): void;
  125591. /**
  125592. * Defines which axis you'd like to control for up & down
  125593. * @param axis defines the axis to use
  125594. */
  125595. setAxisForUpDown(axis: JoystickAxis): void;
  125596. /**
  125597. * Clears the canvas from the previous puck / container draw
  125598. */
  125599. private _clearPreviousDraw;
  125600. /**
  125601. * Loads `urlPath` to be used for the container's image
  125602. * @param urlPath defines the urlPath of an image to use
  125603. */
  125604. setContainerImage(urlPath: string): void;
  125605. /**
  125606. * Loads `urlPath` to be used for the puck's image
  125607. * @param urlPath defines the urlPath of an image to use
  125608. */
  125609. setPuckImage(urlPath: string): void;
  125610. /**
  125611. * Draws the Virtual Joystick's container
  125612. */
  125613. private _drawContainer;
  125614. /**
  125615. * Draws the Virtual Joystick's puck
  125616. */
  125617. private _drawPuck;
  125618. private _drawVirtualJoystick;
  125619. /**
  125620. * Release internal HTML canvas
  125621. */
  125622. releaseCanvas(): void;
  125623. }
  125624. }
  125625. declare module BABYLON {
  125626. interface FreeCameraInputsManager {
  125627. /**
  125628. * Add virtual joystick input support to the input manager.
  125629. * @returns the current input manager
  125630. */
  125631. addVirtualJoystick(): FreeCameraInputsManager;
  125632. }
  125633. /**
  125634. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  125635. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  125636. */
  125637. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  125638. /**
  125639. * Defines the camera the input is attached to.
  125640. */
  125641. camera: FreeCamera;
  125642. private _leftjoystick;
  125643. private _rightjoystick;
  125644. /**
  125645. * Gets the left stick of the virtual joystick.
  125646. * @returns The virtual Joystick
  125647. */
  125648. getLeftJoystick(): VirtualJoystick;
  125649. /**
  125650. * Gets the right stick of the virtual joystick.
  125651. * @returns The virtual Joystick
  125652. */
  125653. getRightJoystick(): VirtualJoystick;
  125654. /**
  125655. * Update the current camera state depending on the inputs that have been used this frame.
  125656. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  125657. */
  125658. checkInputs(): void;
  125659. /**
  125660. * Attach the input controls to a specific dom element to get the input from.
  125661. * @param element Defines the element the controls should be listened from
  125662. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  125663. */
  125664. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  125665. /**
  125666. * Detach the current controls from the specified dom element.
  125667. * @param element Defines the element to stop listening the inputs from
  125668. */
  125669. detachControl(element: Nullable<HTMLElement>): void;
  125670. /**
  125671. * Gets the class name of the current intput.
  125672. * @returns the class name
  125673. */
  125674. getClassName(): string;
  125675. /**
  125676. * Get the friendly name associated with the input class.
  125677. * @returns the input friendly name
  125678. */
  125679. getSimpleName(): string;
  125680. }
  125681. }
  125682. declare module BABYLON {
  125683. /**
  125684. * This represents a FPS type of camera controlled by touch.
  125685. * This is like a universal camera minus the Gamepad controls.
  125686. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125687. */
  125688. export class TouchCamera extends FreeCamera {
  125689. /**
  125690. * Defines the touch sensibility for rotation.
  125691. * The higher the faster.
  125692. */
  125693. get touchAngularSensibility(): number;
  125694. set touchAngularSensibility(value: number);
  125695. /**
  125696. * Defines the touch sensibility for move.
  125697. * The higher the faster.
  125698. */
  125699. get touchMoveSensibility(): number;
  125700. set touchMoveSensibility(value: number);
  125701. /**
  125702. * Instantiates a new touch camera.
  125703. * This represents a FPS type of camera controlled by touch.
  125704. * This is like a universal camera minus the Gamepad controls.
  125705. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125706. * @param name Define the name of the camera in the scene
  125707. * @param position Define the start position of the camera in the scene
  125708. * @param scene Define the scene the camera belongs to
  125709. */
  125710. constructor(name: string, position: Vector3, scene: Scene);
  125711. /**
  125712. * Gets the current object class name.
  125713. * @return the class name
  125714. */
  125715. getClassName(): string;
  125716. /** @hidden */
  125717. _setupInputs(): void;
  125718. }
  125719. }
  125720. declare module BABYLON {
  125721. /**
  125722. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  125723. * being tilted forward or back and left or right.
  125724. */
  125725. export class DeviceOrientationCamera extends FreeCamera {
  125726. private _initialQuaternion;
  125727. private _quaternionCache;
  125728. private _tmpDragQuaternion;
  125729. private _disablePointerInputWhenUsingDeviceOrientation;
  125730. /**
  125731. * Creates a new device orientation camera
  125732. * @param name The name of the camera
  125733. * @param position The start position camera
  125734. * @param scene The scene the camera belongs to
  125735. */
  125736. constructor(name: string, position: Vector3, scene: Scene);
  125737. /**
  125738. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  125739. */
  125740. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  125741. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  125742. private _dragFactor;
  125743. /**
  125744. * Enabled turning on the y axis when the orientation sensor is active
  125745. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  125746. */
  125747. enableHorizontalDragging(dragFactor?: number): void;
  125748. /**
  125749. * Gets the current instance class name ("DeviceOrientationCamera").
  125750. * This helps avoiding instanceof at run time.
  125751. * @returns the class name
  125752. */
  125753. getClassName(): string;
  125754. /**
  125755. * @hidden
  125756. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  125757. */
  125758. _checkInputs(): void;
  125759. /**
  125760. * Reset the camera to its default orientation on the specified axis only.
  125761. * @param axis The axis to reset
  125762. */
  125763. resetToCurrentRotation(axis?: Axis): void;
  125764. }
  125765. }
  125766. declare module BABYLON {
  125767. /**
  125768. * Defines supported buttons for XBox360 compatible gamepads
  125769. */
  125770. export enum Xbox360Button {
  125771. /** A */
  125772. A = 0,
  125773. /** B */
  125774. B = 1,
  125775. /** X */
  125776. X = 2,
  125777. /** Y */
  125778. Y = 3,
  125779. /** Left button */
  125780. LB = 4,
  125781. /** Right button */
  125782. RB = 5,
  125783. /** Back */
  125784. Back = 8,
  125785. /** Start */
  125786. Start = 9,
  125787. /** Left stick */
  125788. LeftStick = 10,
  125789. /** Right stick */
  125790. RightStick = 11
  125791. }
  125792. /** Defines values for XBox360 DPad */
  125793. export enum Xbox360Dpad {
  125794. /** Up */
  125795. Up = 12,
  125796. /** Down */
  125797. Down = 13,
  125798. /** Left */
  125799. Left = 14,
  125800. /** Right */
  125801. Right = 15
  125802. }
  125803. /**
  125804. * Defines a XBox360 gamepad
  125805. */
  125806. export class Xbox360Pad extends Gamepad {
  125807. private _leftTrigger;
  125808. private _rightTrigger;
  125809. private _onlefttriggerchanged;
  125810. private _onrighttriggerchanged;
  125811. private _onbuttondown;
  125812. private _onbuttonup;
  125813. private _ondpaddown;
  125814. private _ondpadup;
  125815. /** Observable raised when a button is pressed */
  125816. onButtonDownObservable: Observable<Xbox360Button>;
  125817. /** Observable raised when a button is released */
  125818. onButtonUpObservable: Observable<Xbox360Button>;
  125819. /** Observable raised when a pad is pressed */
  125820. onPadDownObservable: Observable<Xbox360Dpad>;
  125821. /** Observable raised when a pad is released */
  125822. onPadUpObservable: Observable<Xbox360Dpad>;
  125823. private _buttonA;
  125824. private _buttonB;
  125825. private _buttonX;
  125826. private _buttonY;
  125827. private _buttonBack;
  125828. private _buttonStart;
  125829. private _buttonLB;
  125830. private _buttonRB;
  125831. private _buttonLeftStick;
  125832. private _buttonRightStick;
  125833. private _dPadUp;
  125834. private _dPadDown;
  125835. private _dPadLeft;
  125836. private _dPadRight;
  125837. private _isXboxOnePad;
  125838. /**
  125839. * Creates a new XBox360 gamepad object
  125840. * @param id defines the id of this gamepad
  125841. * @param index defines its index
  125842. * @param gamepad defines the internal HTML gamepad object
  125843. * @param xboxOne defines if it is a XBox One gamepad
  125844. */
  125845. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  125846. /**
  125847. * Defines the callback to call when left trigger is pressed
  125848. * @param callback defines the callback to use
  125849. */
  125850. onlefttriggerchanged(callback: (value: number) => void): void;
  125851. /**
  125852. * Defines the callback to call when right trigger is pressed
  125853. * @param callback defines the callback to use
  125854. */
  125855. onrighttriggerchanged(callback: (value: number) => void): void;
  125856. /**
  125857. * Gets the left trigger value
  125858. */
  125859. get leftTrigger(): number;
  125860. /**
  125861. * Sets the left trigger value
  125862. */
  125863. set leftTrigger(newValue: number);
  125864. /**
  125865. * Gets the right trigger value
  125866. */
  125867. get rightTrigger(): number;
  125868. /**
  125869. * Sets the right trigger value
  125870. */
  125871. set rightTrigger(newValue: number);
  125872. /**
  125873. * Defines the callback to call when a button is pressed
  125874. * @param callback defines the callback to use
  125875. */
  125876. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  125877. /**
  125878. * Defines the callback to call when a button is released
  125879. * @param callback defines the callback to use
  125880. */
  125881. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  125882. /**
  125883. * Defines the callback to call when a pad is pressed
  125884. * @param callback defines the callback to use
  125885. */
  125886. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  125887. /**
  125888. * Defines the callback to call when a pad is released
  125889. * @param callback defines the callback to use
  125890. */
  125891. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  125892. private _setButtonValue;
  125893. private _setDPadValue;
  125894. /**
  125895. * Gets the value of the `A` button
  125896. */
  125897. get buttonA(): number;
  125898. /**
  125899. * Sets the value of the `A` button
  125900. */
  125901. set buttonA(value: number);
  125902. /**
  125903. * Gets the value of the `B` button
  125904. */
  125905. get buttonB(): number;
  125906. /**
  125907. * Sets the value of the `B` button
  125908. */
  125909. set buttonB(value: number);
  125910. /**
  125911. * Gets the value of the `X` button
  125912. */
  125913. get buttonX(): number;
  125914. /**
  125915. * Sets the value of the `X` button
  125916. */
  125917. set buttonX(value: number);
  125918. /**
  125919. * Gets the value of the `Y` button
  125920. */
  125921. get buttonY(): number;
  125922. /**
  125923. * Sets the value of the `Y` button
  125924. */
  125925. set buttonY(value: number);
  125926. /**
  125927. * Gets the value of the `Start` button
  125928. */
  125929. get buttonStart(): number;
  125930. /**
  125931. * Sets the value of the `Start` button
  125932. */
  125933. set buttonStart(value: number);
  125934. /**
  125935. * Gets the value of the `Back` button
  125936. */
  125937. get buttonBack(): number;
  125938. /**
  125939. * Sets the value of the `Back` button
  125940. */
  125941. set buttonBack(value: number);
  125942. /**
  125943. * Gets the value of the `Left` button
  125944. */
  125945. get buttonLB(): number;
  125946. /**
  125947. * Sets the value of the `Left` button
  125948. */
  125949. set buttonLB(value: number);
  125950. /**
  125951. * Gets the value of the `Right` button
  125952. */
  125953. get buttonRB(): number;
  125954. /**
  125955. * Sets the value of the `Right` button
  125956. */
  125957. set buttonRB(value: number);
  125958. /**
  125959. * Gets the value of the Left joystick
  125960. */
  125961. get buttonLeftStick(): number;
  125962. /**
  125963. * Sets the value of the Left joystick
  125964. */
  125965. set buttonLeftStick(value: number);
  125966. /**
  125967. * Gets the value of the Right joystick
  125968. */
  125969. get buttonRightStick(): number;
  125970. /**
  125971. * Sets the value of the Right joystick
  125972. */
  125973. set buttonRightStick(value: number);
  125974. /**
  125975. * Gets the value of D-pad up
  125976. */
  125977. get dPadUp(): number;
  125978. /**
  125979. * Sets the value of D-pad up
  125980. */
  125981. set dPadUp(value: number);
  125982. /**
  125983. * Gets the value of D-pad down
  125984. */
  125985. get dPadDown(): number;
  125986. /**
  125987. * Sets the value of D-pad down
  125988. */
  125989. set dPadDown(value: number);
  125990. /**
  125991. * Gets the value of D-pad left
  125992. */
  125993. get dPadLeft(): number;
  125994. /**
  125995. * Sets the value of D-pad left
  125996. */
  125997. set dPadLeft(value: number);
  125998. /**
  125999. * Gets the value of D-pad right
  126000. */
  126001. get dPadRight(): number;
  126002. /**
  126003. * Sets the value of D-pad right
  126004. */
  126005. set dPadRight(value: number);
  126006. /**
  126007. * Force the gamepad to synchronize with device values
  126008. */
  126009. update(): void;
  126010. /**
  126011. * Disposes the gamepad
  126012. */
  126013. dispose(): void;
  126014. }
  126015. }
  126016. declare module BABYLON {
  126017. /**
  126018. * Defines supported buttons for DualShock compatible gamepads
  126019. */
  126020. export enum DualShockButton {
  126021. /** Cross */
  126022. Cross = 0,
  126023. /** Circle */
  126024. Circle = 1,
  126025. /** Square */
  126026. Square = 2,
  126027. /** Triangle */
  126028. Triangle = 3,
  126029. /** L1 */
  126030. L1 = 4,
  126031. /** R1 */
  126032. R1 = 5,
  126033. /** Share */
  126034. Share = 8,
  126035. /** Options */
  126036. Options = 9,
  126037. /** Left stick */
  126038. LeftStick = 10,
  126039. /** Right stick */
  126040. RightStick = 11
  126041. }
  126042. /** Defines values for DualShock DPad */
  126043. export enum DualShockDpad {
  126044. /** Up */
  126045. Up = 12,
  126046. /** Down */
  126047. Down = 13,
  126048. /** Left */
  126049. Left = 14,
  126050. /** Right */
  126051. Right = 15
  126052. }
  126053. /**
  126054. * Defines a DualShock gamepad
  126055. */
  126056. export class DualShockPad extends Gamepad {
  126057. private _leftTrigger;
  126058. private _rightTrigger;
  126059. private _onlefttriggerchanged;
  126060. private _onrighttriggerchanged;
  126061. private _onbuttondown;
  126062. private _onbuttonup;
  126063. private _ondpaddown;
  126064. private _ondpadup;
  126065. /** Observable raised when a button is pressed */
  126066. onButtonDownObservable: Observable<DualShockButton>;
  126067. /** Observable raised when a button is released */
  126068. onButtonUpObservable: Observable<DualShockButton>;
  126069. /** Observable raised when a pad is pressed */
  126070. onPadDownObservable: Observable<DualShockDpad>;
  126071. /** Observable raised when a pad is released */
  126072. onPadUpObservable: Observable<DualShockDpad>;
  126073. private _buttonCross;
  126074. private _buttonCircle;
  126075. private _buttonSquare;
  126076. private _buttonTriangle;
  126077. private _buttonShare;
  126078. private _buttonOptions;
  126079. private _buttonL1;
  126080. private _buttonR1;
  126081. private _buttonLeftStick;
  126082. private _buttonRightStick;
  126083. private _dPadUp;
  126084. private _dPadDown;
  126085. private _dPadLeft;
  126086. private _dPadRight;
  126087. /**
  126088. * Creates a new DualShock gamepad object
  126089. * @param id defines the id of this gamepad
  126090. * @param index defines its index
  126091. * @param gamepad defines the internal HTML gamepad object
  126092. */
  126093. constructor(id: string, index: number, gamepad: any);
  126094. /**
  126095. * Defines the callback to call when left trigger is pressed
  126096. * @param callback defines the callback to use
  126097. */
  126098. onlefttriggerchanged(callback: (value: number) => void): void;
  126099. /**
  126100. * Defines the callback to call when right trigger is pressed
  126101. * @param callback defines the callback to use
  126102. */
  126103. onrighttriggerchanged(callback: (value: number) => void): void;
  126104. /**
  126105. * Gets the left trigger value
  126106. */
  126107. get leftTrigger(): number;
  126108. /**
  126109. * Sets the left trigger value
  126110. */
  126111. set leftTrigger(newValue: number);
  126112. /**
  126113. * Gets the right trigger value
  126114. */
  126115. get rightTrigger(): number;
  126116. /**
  126117. * Sets the right trigger value
  126118. */
  126119. set rightTrigger(newValue: number);
  126120. /**
  126121. * Defines the callback to call when a button is pressed
  126122. * @param callback defines the callback to use
  126123. */
  126124. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  126125. /**
  126126. * Defines the callback to call when a button is released
  126127. * @param callback defines the callback to use
  126128. */
  126129. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  126130. /**
  126131. * Defines the callback to call when a pad is pressed
  126132. * @param callback defines the callback to use
  126133. */
  126134. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  126135. /**
  126136. * Defines the callback to call when a pad is released
  126137. * @param callback defines the callback to use
  126138. */
  126139. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  126140. private _setButtonValue;
  126141. private _setDPadValue;
  126142. /**
  126143. * Gets the value of the `Cross` button
  126144. */
  126145. get buttonCross(): number;
  126146. /**
  126147. * Sets the value of the `Cross` button
  126148. */
  126149. set buttonCross(value: number);
  126150. /**
  126151. * Gets the value of the `Circle` button
  126152. */
  126153. get buttonCircle(): number;
  126154. /**
  126155. * Sets the value of the `Circle` button
  126156. */
  126157. set buttonCircle(value: number);
  126158. /**
  126159. * Gets the value of the `Square` button
  126160. */
  126161. get buttonSquare(): number;
  126162. /**
  126163. * Sets the value of the `Square` button
  126164. */
  126165. set buttonSquare(value: number);
  126166. /**
  126167. * Gets the value of the `Triangle` button
  126168. */
  126169. get buttonTriangle(): number;
  126170. /**
  126171. * Sets the value of the `Triangle` button
  126172. */
  126173. set buttonTriangle(value: number);
  126174. /**
  126175. * Gets the value of the `Options` button
  126176. */
  126177. get buttonOptions(): number;
  126178. /**
  126179. * Sets the value of the `Options` button
  126180. */
  126181. set buttonOptions(value: number);
  126182. /**
  126183. * Gets the value of the `Share` button
  126184. */
  126185. get buttonShare(): number;
  126186. /**
  126187. * Sets the value of the `Share` button
  126188. */
  126189. set buttonShare(value: number);
  126190. /**
  126191. * Gets the value of the `L1` button
  126192. */
  126193. get buttonL1(): number;
  126194. /**
  126195. * Sets the value of the `L1` button
  126196. */
  126197. set buttonL1(value: number);
  126198. /**
  126199. * Gets the value of the `R1` button
  126200. */
  126201. get buttonR1(): number;
  126202. /**
  126203. * Sets the value of the `R1` button
  126204. */
  126205. set buttonR1(value: number);
  126206. /**
  126207. * Gets the value of the Left joystick
  126208. */
  126209. get buttonLeftStick(): number;
  126210. /**
  126211. * Sets the value of the Left joystick
  126212. */
  126213. set buttonLeftStick(value: number);
  126214. /**
  126215. * Gets the value of the Right joystick
  126216. */
  126217. get buttonRightStick(): number;
  126218. /**
  126219. * Sets the value of the Right joystick
  126220. */
  126221. set buttonRightStick(value: number);
  126222. /**
  126223. * Gets the value of D-pad up
  126224. */
  126225. get dPadUp(): number;
  126226. /**
  126227. * Sets the value of D-pad up
  126228. */
  126229. set dPadUp(value: number);
  126230. /**
  126231. * Gets the value of D-pad down
  126232. */
  126233. get dPadDown(): number;
  126234. /**
  126235. * Sets the value of D-pad down
  126236. */
  126237. set dPadDown(value: number);
  126238. /**
  126239. * Gets the value of D-pad left
  126240. */
  126241. get dPadLeft(): number;
  126242. /**
  126243. * Sets the value of D-pad left
  126244. */
  126245. set dPadLeft(value: number);
  126246. /**
  126247. * Gets the value of D-pad right
  126248. */
  126249. get dPadRight(): number;
  126250. /**
  126251. * Sets the value of D-pad right
  126252. */
  126253. set dPadRight(value: number);
  126254. /**
  126255. * Force the gamepad to synchronize with device values
  126256. */
  126257. update(): void;
  126258. /**
  126259. * Disposes the gamepad
  126260. */
  126261. dispose(): void;
  126262. }
  126263. }
  126264. declare module BABYLON {
  126265. /**
  126266. * Manager for handling gamepads
  126267. */
  126268. export class GamepadManager {
  126269. private _scene?;
  126270. private _babylonGamepads;
  126271. private _oneGamepadConnected;
  126272. /** @hidden */
  126273. _isMonitoring: boolean;
  126274. private _gamepadEventSupported;
  126275. private _gamepadSupport?;
  126276. /**
  126277. * observable to be triggered when the gamepad controller has been connected
  126278. */
  126279. onGamepadConnectedObservable: Observable<Gamepad>;
  126280. /**
  126281. * observable to be triggered when the gamepad controller has been disconnected
  126282. */
  126283. onGamepadDisconnectedObservable: Observable<Gamepad>;
  126284. private _onGamepadConnectedEvent;
  126285. private _onGamepadDisconnectedEvent;
  126286. /**
  126287. * Initializes the gamepad manager
  126288. * @param _scene BabylonJS scene
  126289. */
  126290. constructor(_scene?: Scene | undefined);
  126291. /**
  126292. * The gamepads in the game pad manager
  126293. */
  126294. get gamepads(): Gamepad[];
  126295. /**
  126296. * Get the gamepad controllers based on type
  126297. * @param type The type of gamepad controller
  126298. * @returns Nullable gamepad
  126299. */
  126300. getGamepadByType(type?: number): Nullable<Gamepad>;
  126301. /**
  126302. * Disposes the gamepad manager
  126303. */
  126304. dispose(): void;
  126305. private _addNewGamepad;
  126306. private _startMonitoringGamepads;
  126307. private _stopMonitoringGamepads;
  126308. /** @hidden */
  126309. _checkGamepadsStatus(): void;
  126310. private _updateGamepadObjects;
  126311. }
  126312. }
  126313. declare module BABYLON {
  126314. interface Scene {
  126315. /** @hidden */
  126316. _gamepadManager: Nullable<GamepadManager>;
  126317. /**
  126318. * Gets the gamepad manager associated with the scene
  126319. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  126320. */
  126321. gamepadManager: GamepadManager;
  126322. }
  126323. /**
  126324. * Interface representing a free camera inputs manager
  126325. */
  126326. interface FreeCameraInputsManager {
  126327. /**
  126328. * Adds gamepad input support to the FreeCameraInputsManager.
  126329. * @returns the FreeCameraInputsManager
  126330. */
  126331. addGamepad(): FreeCameraInputsManager;
  126332. }
  126333. /**
  126334. * Interface representing an arc rotate camera inputs manager
  126335. */
  126336. interface ArcRotateCameraInputsManager {
  126337. /**
  126338. * Adds gamepad input support to the ArcRotateCamera InputManager.
  126339. * @returns the camera inputs manager
  126340. */
  126341. addGamepad(): ArcRotateCameraInputsManager;
  126342. }
  126343. /**
  126344. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  126345. */
  126346. export class GamepadSystemSceneComponent implements ISceneComponent {
  126347. /**
  126348. * The component name helpfull to identify the component in the list of scene components.
  126349. */
  126350. readonly name: string;
  126351. /**
  126352. * The scene the component belongs to.
  126353. */
  126354. scene: Scene;
  126355. /**
  126356. * Creates a new instance of the component for the given scene
  126357. * @param scene Defines the scene to register the component in
  126358. */
  126359. constructor(scene: Scene);
  126360. /**
  126361. * Registers the component in a given scene
  126362. */
  126363. register(): void;
  126364. /**
  126365. * Rebuilds the elements related to this component in case of
  126366. * context lost for instance.
  126367. */
  126368. rebuild(): void;
  126369. /**
  126370. * Disposes the component and the associated ressources
  126371. */
  126372. dispose(): void;
  126373. private _beforeCameraUpdate;
  126374. }
  126375. }
  126376. declare module BABYLON {
  126377. /**
  126378. * 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,
  126379. * which still works and will still be found in many Playgrounds.
  126380. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  126381. */
  126382. export class UniversalCamera extends TouchCamera {
  126383. /**
  126384. * Defines the gamepad rotation sensiblity.
  126385. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  126386. */
  126387. get gamepadAngularSensibility(): number;
  126388. set gamepadAngularSensibility(value: number);
  126389. /**
  126390. * Defines the gamepad move sensiblity.
  126391. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  126392. */
  126393. get gamepadMoveSensibility(): number;
  126394. set gamepadMoveSensibility(value: number);
  126395. /**
  126396. * 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,
  126397. * which still works and will still be found in many Playgrounds.
  126398. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  126399. * @param name Define the name of the camera in the scene
  126400. * @param position Define the start position of the camera in the scene
  126401. * @param scene Define the scene the camera belongs to
  126402. */
  126403. constructor(name: string, position: Vector3, scene: Scene);
  126404. /**
  126405. * Gets the current object class name.
  126406. * @return the class name
  126407. */
  126408. getClassName(): string;
  126409. }
  126410. }
  126411. declare module BABYLON {
  126412. /**
  126413. * This represents a FPS type of camera. This is only here for back compat purpose.
  126414. * Please use the UniversalCamera instead as both are identical.
  126415. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  126416. */
  126417. export class GamepadCamera extends UniversalCamera {
  126418. /**
  126419. * Instantiates a new Gamepad Camera
  126420. * This represents a FPS type of camera. This is only here for back compat purpose.
  126421. * Please use the UniversalCamera instead as both are identical.
  126422. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  126423. * @param name Define the name of the camera in the scene
  126424. * @param position Define the start position of the camera in the scene
  126425. * @param scene Define the scene the camera belongs to
  126426. */
  126427. constructor(name: string, position: Vector3, scene: Scene);
  126428. /**
  126429. * Gets the current object class name.
  126430. * @return the class name
  126431. */
  126432. getClassName(): string;
  126433. }
  126434. }
  126435. declare module BABYLON {
  126436. /** @hidden */
  126437. export var passPixelShader: {
  126438. name: string;
  126439. shader: string;
  126440. };
  126441. }
  126442. declare module BABYLON {
  126443. /** @hidden */
  126444. export var passCubePixelShader: {
  126445. name: string;
  126446. shader: string;
  126447. };
  126448. }
  126449. declare module BABYLON {
  126450. /**
  126451. * PassPostProcess which produces an output the same as it's input
  126452. */
  126453. export class PassPostProcess extends PostProcess {
  126454. /**
  126455. * Gets a string identifying the name of the class
  126456. * @returns "PassPostProcess" string
  126457. */
  126458. getClassName(): string;
  126459. /**
  126460. * Creates the PassPostProcess
  126461. * @param name The name of the effect.
  126462. * @param options The required width/height ratio to downsize to before computing the render pass.
  126463. * @param camera The camera to apply the render pass to.
  126464. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  126465. * @param engine The engine which the post process will be applied. (default: current engine)
  126466. * @param reusable If the post process can be reused on the same frame. (default: false)
  126467. * @param textureType The type of texture to be used when performing the post processing.
  126468. * @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)
  126469. */
  126470. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  126471. /** @hidden */
  126472. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  126473. }
  126474. /**
  126475. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  126476. */
  126477. export class PassCubePostProcess extends PostProcess {
  126478. private _face;
  126479. /**
  126480. * Gets or sets the cube face to display.
  126481. * * 0 is +X
  126482. * * 1 is -X
  126483. * * 2 is +Y
  126484. * * 3 is -Y
  126485. * * 4 is +Z
  126486. * * 5 is -Z
  126487. */
  126488. get face(): number;
  126489. set face(value: number);
  126490. /**
  126491. * Gets a string identifying the name of the class
  126492. * @returns "PassCubePostProcess" string
  126493. */
  126494. getClassName(): string;
  126495. /**
  126496. * Creates the PassCubePostProcess
  126497. * @param name The name of the effect.
  126498. * @param options The required width/height ratio to downsize to before computing the render pass.
  126499. * @param camera The camera to apply the render pass to.
  126500. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  126501. * @param engine The engine which the post process will be applied. (default: current engine)
  126502. * @param reusable If the post process can be reused on the same frame. (default: false)
  126503. * @param textureType The type of texture to be used when performing the post processing.
  126504. * @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)
  126505. */
  126506. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  126507. /** @hidden */
  126508. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  126509. }
  126510. }
  126511. declare module BABYLON {
  126512. /** @hidden */
  126513. export var anaglyphPixelShader: {
  126514. name: string;
  126515. shader: string;
  126516. };
  126517. }
  126518. declare module BABYLON {
  126519. /**
  126520. * Postprocess used to generate anaglyphic rendering
  126521. */
  126522. export class AnaglyphPostProcess extends PostProcess {
  126523. private _passedProcess;
  126524. /**
  126525. * Gets a string identifying the name of the class
  126526. * @returns "AnaglyphPostProcess" string
  126527. */
  126528. getClassName(): string;
  126529. /**
  126530. * Creates a new AnaglyphPostProcess
  126531. * @param name defines postprocess name
  126532. * @param options defines creation options or target ratio scale
  126533. * @param rigCameras defines cameras using this postprocess
  126534. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  126535. * @param engine defines hosting engine
  126536. * @param reusable defines if the postprocess will be reused multiple times per frame
  126537. */
  126538. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  126539. }
  126540. }
  126541. declare module BABYLON {
  126542. /**
  126543. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  126544. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  126545. */
  126546. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  126547. /**
  126548. * Creates a new AnaglyphArcRotateCamera
  126549. * @param name defines camera name
  126550. * @param alpha defines alpha angle (in radians)
  126551. * @param beta defines beta angle (in radians)
  126552. * @param radius defines radius
  126553. * @param target defines camera target
  126554. * @param interaxialDistance defines distance between each color axis
  126555. * @param scene defines the hosting scene
  126556. */
  126557. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  126558. /**
  126559. * Gets camera class name
  126560. * @returns AnaglyphArcRotateCamera
  126561. */
  126562. getClassName(): string;
  126563. }
  126564. }
  126565. declare module BABYLON {
  126566. /**
  126567. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  126568. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  126569. */
  126570. export class AnaglyphFreeCamera extends FreeCamera {
  126571. /**
  126572. * Creates a new AnaglyphFreeCamera
  126573. * @param name defines camera name
  126574. * @param position defines initial position
  126575. * @param interaxialDistance defines distance between each color axis
  126576. * @param scene defines the hosting scene
  126577. */
  126578. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  126579. /**
  126580. * Gets camera class name
  126581. * @returns AnaglyphFreeCamera
  126582. */
  126583. getClassName(): string;
  126584. }
  126585. }
  126586. declare module BABYLON {
  126587. /**
  126588. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  126589. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  126590. */
  126591. export class AnaglyphGamepadCamera extends GamepadCamera {
  126592. /**
  126593. * Creates a new AnaglyphGamepadCamera
  126594. * @param name defines camera name
  126595. * @param position defines initial position
  126596. * @param interaxialDistance defines distance between each color axis
  126597. * @param scene defines the hosting scene
  126598. */
  126599. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  126600. /**
  126601. * Gets camera class name
  126602. * @returns AnaglyphGamepadCamera
  126603. */
  126604. getClassName(): string;
  126605. }
  126606. }
  126607. declare module BABYLON {
  126608. /**
  126609. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  126610. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  126611. */
  126612. export class AnaglyphUniversalCamera extends UniversalCamera {
  126613. /**
  126614. * Creates a new AnaglyphUniversalCamera
  126615. * @param name defines camera name
  126616. * @param position defines initial position
  126617. * @param interaxialDistance defines distance between each color axis
  126618. * @param scene defines the hosting scene
  126619. */
  126620. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  126621. /**
  126622. * Gets camera class name
  126623. * @returns AnaglyphUniversalCamera
  126624. */
  126625. getClassName(): string;
  126626. }
  126627. }
  126628. declare module BABYLON {
  126629. /**
  126630. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  126631. * @see https://doc.babylonjs.com/features/cameras
  126632. */
  126633. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  126634. /**
  126635. * Creates a new StereoscopicArcRotateCamera
  126636. * @param name defines camera name
  126637. * @param alpha defines alpha angle (in radians)
  126638. * @param beta defines beta angle (in radians)
  126639. * @param radius defines radius
  126640. * @param target defines camera target
  126641. * @param interaxialDistance defines distance between each color axis
  126642. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  126643. * @param scene defines the hosting scene
  126644. */
  126645. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  126646. /**
  126647. * Gets camera class name
  126648. * @returns StereoscopicArcRotateCamera
  126649. */
  126650. getClassName(): string;
  126651. }
  126652. }
  126653. declare module BABYLON {
  126654. /**
  126655. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  126656. * @see https://doc.babylonjs.com/features/cameras
  126657. */
  126658. export class StereoscopicFreeCamera extends FreeCamera {
  126659. /**
  126660. * Creates a new StereoscopicFreeCamera
  126661. * @param name defines camera name
  126662. * @param position defines initial position
  126663. * @param interaxialDistance defines distance between each color axis
  126664. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  126665. * @param scene defines the hosting scene
  126666. */
  126667. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  126668. /**
  126669. * Gets camera class name
  126670. * @returns StereoscopicFreeCamera
  126671. */
  126672. getClassName(): string;
  126673. }
  126674. }
  126675. declare module BABYLON {
  126676. /**
  126677. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  126678. * @see https://doc.babylonjs.com/features/cameras
  126679. */
  126680. export class StereoscopicGamepadCamera extends GamepadCamera {
  126681. /**
  126682. * Creates a new StereoscopicGamepadCamera
  126683. * @param name defines camera name
  126684. * @param position defines initial position
  126685. * @param interaxialDistance defines distance between each color axis
  126686. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  126687. * @param scene defines the hosting scene
  126688. */
  126689. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  126690. /**
  126691. * Gets camera class name
  126692. * @returns StereoscopicGamepadCamera
  126693. */
  126694. getClassName(): string;
  126695. }
  126696. }
  126697. declare module BABYLON {
  126698. /**
  126699. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  126700. * @see https://doc.babylonjs.com/features/cameras
  126701. */
  126702. export class StereoscopicUniversalCamera extends UniversalCamera {
  126703. /**
  126704. * Creates a new StereoscopicUniversalCamera
  126705. * @param name defines camera name
  126706. * @param position defines initial position
  126707. * @param interaxialDistance defines distance between each color axis
  126708. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  126709. * @param scene defines the hosting scene
  126710. */
  126711. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  126712. /**
  126713. * Gets camera class name
  126714. * @returns StereoscopicUniversalCamera
  126715. */
  126716. getClassName(): string;
  126717. }
  126718. }
  126719. declare module BABYLON {
  126720. /**
  126721. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  126722. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  126723. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  126724. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  126725. */
  126726. export class VirtualJoysticksCamera extends FreeCamera {
  126727. /**
  126728. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  126729. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  126730. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  126731. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  126732. * @param name Define the name of the camera in the scene
  126733. * @param position Define the start position of the camera in the scene
  126734. * @param scene Define the scene the camera belongs to
  126735. */
  126736. constructor(name: string, position: Vector3, scene: Scene);
  126737. /**
  126738. * Gets the current object class name.
  126739. * @return the class name
  126740. */
  126741. getClassName(): string;
  126742. }
  126743. }
  126744. declare module BABYLON {
  126745. /**
  126746. * This represents all the required metrics to create a VR camera.
  126747. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  126748. */
  126749. export class VRCameraMetrics {
  126750. /**
  126751. * Define the horizontal resolution off the screen.
  126752. */
  126753. hResolution: number;
  126754. /**
  126755. * Define the vertical resolution off the screen.
  126756. */
  126757. vResolution: number;
  126758. /**
  126759. * Define the horizontal screen size.
  126760. */
  126761. hScreenSize: number;
  126762. /**
  126763. * Define the vertical screen size.
  126764. */
  126765. vScreenSize: number;
  126766. /**
  126767. * Define the vertical screen center position.
  126768. */
  126769. vScreenCenter: number;
  126770. /**
  126771. * Define the distance of the eyes to the screen.
  126772. */
  126773. eyeToScreenDistance: number;
  126774. /**
  126775. * Define the distance between both lenses
  126776. */
  126777. lensSeparationDistance: number;
  126778. /**
  126779. * Define the distance between both viewer's eyes.
  126780. */
  126781. interpupillaryDistance: number;
  126782. /**
  126783. * Define the distortion factor of the VR postprocess.
  126784. * Please, touch with care.
  126785. */
  126786. distortionK: number[];
  126787. /**
  126788. * Define the chromatic aberration correction factors for the VR post process.
  126789. */
  126790. chromaAbCorrection: number[];
  126791. /**
  126792. * Define the scale factor of the post process.
  126793. * The smaller the better but the slower.
  126794. */
  126795. postProcessScaleFactor: number;
  126796. /**
  126797. * Define an offset for the lens center.
  126798. */
  126799. lensCenterOffset: number;
  126800. /**
  126801. * Define if the current vr camera should compensate the distortion of the lense or not.
  126802. */
  126803. compensateDistortion: boolean;
  126804. /**
  126805. * Defines if multiview should be enabled when rendering (Default: false)
  126806. */
  126807. multiviewEnabled: boolean;
  126808. /**
  126809. * Gets the rendering aspect ratio based on the provided resolutions.
  126810. */
  126811. get aspectRatio(): number;
  126812. /**
  126813. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  126814. */
  126815. get aspectRatioFov(): number;
  126816. /**
  126817. * @hidden
  126818. */
  126819. get leftHMatrix(): Matrix;
  126820. /**
  126821. * @hidden
  126822. */
  126823. get rightHMatrix(): Matrix;
  126824. /**
  126825. * @hidden
  126826. */
  126827. get leftPreViewMatrix(): Matrix;
  126828. /**
  126829. * @hidden
  126830. */
  126831. get rightPreViewMatrix(): Matrix;
  126832. /**
  126833. * Get the default VRMetrics based on the most generic setup.
  126834. * @returns the default vr metrics
  126835. */
  126836. static GetDefault(): VRCameraMetrics;
  126837. }
  126838. }
  126839. declare module BABYLON {
  126840. /** @hidden */
  126841. export var vrDistortionCorrectionPixelShader: {
  126842. name: string;
  126843. shader: string;
  126844. };
  126845. }
  126846. declare module BABYLON {
  126847. /**
  126848. * VRDistortionCorrectionPostProcess used for mobile VR
  126849. */
  126850. export class VRDistortionCorrectionPostProcess extends PostProcess {
  126851. private _isRightEye;
  126852. private _distortionFactors;
  126853. private _postProcessScaleFactor;
  126854. private _lensCenterOffset;
  126855. private _scaleIn;
  126856. private _scaleFactor;
  126857. private _lensCenter;
  126858. /**
  126859. * Gets a string identifying the name of the class
  126860. * @returns "VRDistortionCorrectionPostProcess" string
  126861. */
  126862. getClassName(): string;
  126863. /**
  126864. * Initializes the VRDistortionCorrectionPostProcess
  126865. * @param name The name of the effect.
  126866. * @param camera The camera to apply the render pass to.
  126867. * @param isRightEye If this is for the right eye distortion
  126868. * @param vrMetrics All the required metrics for the VR camera
  126869. */
  126870. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  126871. }
  126872. }
  126873. declare module BABYLON {
  126874. /**
  126875. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  126876. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126877. */
  126878. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  126879. /**
  126880. * Creates a new VRDeviceOrientationArcRotateCamera
  126881. * @param name defines camera name
  126882. * @param alpha defines the camera rotation along the logitudinal axis
  126883. * @param beta defines the camera rotation along the latitudinal axis
  126884. * @param radius defines the camera distance from its target
  126885. * @param target defines the camera target
  126886. * @param scene defines the scene the camera belongs to
  126887. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126888. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126889. */
  126890. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126891. /**
  126892. * Gets camera class name
  126893. * @returns VRDeviceOrientationArcRotateCamera
  126894. */
  126895. getClassName(): string;
  126896. }
  126897. }
  126898. declare module BABYLON {
  126899. /**
  126900. * Camera used to simulate VR rendering (based on FreeCamera)
  126901. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126902. */
  126903. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  126904. /**
  126905. * Creates a new VRDeviceOrientationFreeCamera
  126906. * @param name defines camera name
  126907. * @param position defines the start position of the camera
  126908. * @param scene defines the scene the camera belongs to
  126909. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126910. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126911. */
  126912. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126913. /**
  126914. * Gets camera class name
  126915. * @returns VRDeviceOrientationFreeCamera
  126916. */
  126917. getClassName(): string;
  126918. }
  126919. }
  126920. declare module BABYLON {
  126921. /**
  126922. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  126923. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126924. */
  126925. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  126926. /**
  126927. * Creates a new VRDeviceOrientationGamepadCamera
  126928. * @param name defines camera name
  126929. * @param position defines the start position of the camera
  126930. * @param scene defines the scene the camera belongs to
  126931. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126932. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126933. */
  126934. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126935. /**
  126936. * Gets camera class name
  126937. * @returns VRDeviceOrientationGamepadCamera
  126938. */
  126939. getClassName(): string;
  126940. }
  126941. }
  126942. declare module BABYLON {
  126943. /**
  126944. * A class extending Texture allowing drawing on a texture
  126945. * @see https://doc.babylonjs.com/how_to/dynamictexture
  126946. */
  126947. export class DynamicTexture extends Texture {
  126948. private _generateMipMaps;
  126949. private _canvas;
  126950. private _context;
  126951. /**
  126952. * Creates a DynamicTexture
  126953. * @param name defines the name of the texture
  126954. * @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
  126955. * @param scene defines the scene where you want the texture
  126956. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  126957. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  126958. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  126959. */
  126960. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  126961. /**
  126962. * Get the current class name of the texture useful for serialization or dynamic coding.
  126963. * @returns "DynamicTexture"
  126964. */
  126965. getClassName(): string;
  126966. /**
  126967. * Gets the current state of canRescale
  126968. */
  126969. get canRescale(): boolean;
  126970. private _recreate;
  126971. /**
  126972. * Scales the texture
  126973. * @param ratio the scale factor to apply to both width and height
  126974. */
  126975. scale(ratio: number): void;
  126976. /**
  126977. * Resizes the texture
  126978. * @param width the new width
  126979. * @param height the new height
  126980. */
  126981. scaleTo(width: number, height: number): void;
  126982. /**
  126983. * Gets the context of the canvas used by the texture
  126984. * @returns the canvas context of the dynamic texture
  126985. */
  126986. getContext(): CanvasRenderingContext2D;
  126987. /**
  126988. * Clears the texture
  126989. */
  126990. clear(): void;
  126991. /**
  126992. * Updates the texture
  126993. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  126994. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  126995. */
  126996. update(invertY?: boolean, premulAlpha?: boolean): void;
  126997. /**
  126998. * Draws text onto the texture
  126999. * @param text defines the text to be drawn
  127000. * @param x defines the placement of the text from the left
  127001. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  127002. * @param font defines the font to be used with font-style, font-size, font-name
  127003. * @param color defines the color used for the text
  127004. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  127005. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  127006. * @param update defines whether texture is immediately update (default is true)
  127007. */
  127008. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  127009. /**
  127010. * Clones the texture
  127011. * @returns the clone of the texture.
  127012. */
  127013. clone(): DynamicTexture;
  127014. /**
  127015. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  127016. * @returns a serialized dynamic texture object
  127017. */
  127018. serialize(): any;
  127019. private _IsCanvasElement;
  127020. /** @hidden */
  127021. _rebuild(): void;
  127022. }
  127023. }
  127024. declare module BABYLON {
  127025. /**
  127026. * Class containing static functions to help procedurally build meshes
  127027. */
  127028. export class GroundBuilder {
  127029. /**
  127030. * Creates a ground mesh
  127031. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  127032. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  127033. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  127034. * @param name defines the name of the mesh
  127035. * @param options defines the options used to create the mesh
  127036. * @param scene defines the hosting scene
  127037. * @returns the ground mesh
  127038. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  127039. */
  127040. static CreateGround(name: string, options: {
  127041. width?: number;
  127042. height?: number;
  127043. subdivisions?: number;
  127044. subdivisionsX?: number;
  127045. subdivisionsY?: number;
  127046. updatable?: boolean;
  127047. }, scene: any): Mesh;
  127048. /**
  127049. * Creates a tiled ground mesh
  127050. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  127051. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  127052. * * 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
  127053. * * 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
  127054. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  127055. * @param name defines the name of the mesh
  127056. * @param options defines the options used to create the mesh
  127057. * @param scene defines the hosting scene
  127058. * @returns the tiled ground mesh
  127059. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  127060. */
  127061. static CreateTiledGround(name: string, options: {
  127062. xmin: number;
  127063. zmin: number;
  127064. xmax: number;
  127065. zmax: number;
  127066. subdivisions?: {
  127067. w: number;
  127068. h: number;
  127069. };
  127070. precision?: {
  127071. w: number;
  127072. h: number;
  127073. };
  127074. updatable?: boolean;
  127075. }, scene?: Nullable<Scene>): Mesh;
  127076. /**
  127077. * Creates a ground mesh from a height map
  127078. * * The parameter `url` sets the URL of the height map image resource.
  127079. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  127080. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  127081. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  127082. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  127083. * * 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.
  127084. * * 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).
  127085. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  127086. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  127087. * @param name defines the name of the mesh
  127088. * @param url defines the url to the height map
  127089. * @param options defines the options used to create the mesh
  127090. * @param scene defines the hosting scene
  127091. * @returns the ground mesh
  127092. * @see https://doc.babylonjs.com/babylon101/height_map
  127093. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  127094. */
  127095. static CreateGroundFromHeightMap(name: string, url: string, options: {
  127096. width?: number;
  127097. height?: number;
  127098. subdivisions?: number;
  127099. minHeight?: number;
  127100. maxHeight?: number;
  127101. colorFilter?: Color3;
  127102. alphaFilter?: number;
  127103. updatable?: boolean;
  127104. onReady?: (mesh: GroundMesh) => void;
  127105. }, scene?: Nullable<Scene>): GroundMesh;
  127106. }
  127107. }
  127108. declare module BABYLON {
  127109. /**
  127110. * Class containing static functions to help procedurally build meshes
  127111. */
  127112. export class TorusBuilder {
  127113. /**
  127114. * Creates a torus mesh
  127115. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  127116. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  127117. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  127118. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  127119. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  127120. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  127121. * @param name defines the name of the mesh
  127122. * @param options defines the options used to create the mesh
  127123. * @param scene defines the hosting scene
  127124. * @returns the torus mesh
  127125. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  127126. */
  127127. static CreateTorus(name: string, options: {
  127128. diameter?: number;
  127129. thickness?: number;
  127130. tessellation?: number;
  127131. updatable?: boolean;
  127132. sideOrientation?: number;
  127133. frontUVs?: Vector4;
  127134. backUVs?: Vector4;
  127135. }, scene: any): Mesh;
  127136. }
  127137. }
  127138. declare module BABYLON {
  127139. /**
  127140. * Class containing static functions to help procedurally build meshes
  127141. */
  127142. export class CylinderBuilder {
  127143. /**
  127144. * Creates a cylinder or a cone mesh
  127145. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  127146. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  127147. * * 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.
  127148. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  127149. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  127150. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  127151. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  127152. * * 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).
  127153. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  127154. * * 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).
  127155. * * 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
  127156. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  127157. * * 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
  127158. * * 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.
  127159. * * If `enclose` is false, a ring surface is one element.
  127160. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  127161. * * 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
  127162. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  127163. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  127164. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  127165. * @param name defines the name of the mesh
  127166. * @param options defines the options used to create the mesh
  127167. * @param scene defines the hosting scene
  127168. * @returns the cylinder mesh
  127169. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  127170. */
  127171. static CreateCylinder(name: string, options: {
  127172. height?: number;
  127173. diameterTop?: number;
  127174. diameterBottom?: number;
  127175. diameter?: number;
  127176. tessellation?: number;
  127177. subdivisions?: number;
  127178. arc?: number;
  127179. faceColors?: Color4[];
  127180. faceUV?: Vector4[];
  127181. updatable?: boolean;
  127182. hasRings?: boolean;
  127183. enclose?: boolean;
  127184. cap?: number;
  127185. sideOrientation?: number;
  127186. frontUVs?: Vector4;
  127187. backUVs?: Vector4;
  127188. }, scene: any): Mesh;
  127189. }
  127190. }
  127191. declare module BABYLON {
  127192. /**
  127193. * States of the webXR experience
  127194. */
  127195. export enum WebXRState {
  127196. /**
  127197. * Transitioning to being in XR mode
  127198. */
  127199. ENTERING_XR = 0,
  127200. /**
  127201. * Transitioning to non XR mode
  127202. */
  127203. EXITING_XR = 1,
  127204. /**
  127205. * In XR mode and presenting
  127206. */
  127207. IN_XR = 2,
  127208. /**
  127209. * Not entered XR mode
  127210. */
  127211. NOT_IN_XR = 3
  127212. }
  127213. /**
  127214. * Abstraction of the XR render target
  127215. */
  127216. export interface WebXRRenderTarget extends IDisposable {
  127217. /**
  127218. * xrpresent context of the canvas which can be used to display/mirror xr content
  127219. */
  127220. canvasContext: WebGLRenderingContext;
  127221. /**
  127222. * xr layer for the canvas
  127223. */
  127224. xrLayer: Nullable<XRWebGLLayer>;
  127225. /**
  127226. * Initializes the xr layer for the session
  127227. * @param xrSession xr session
  127228. * @returns a promise that will resolve once the XR Layer has been created
  127229. */
  127230. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  127231. }
  127232. }
  127233. declare module BABYLON {
  127234. /**
  127235. * COnfiguration object for WebXR output canvas
  127236. */
  127237. export class WebXRManagedOutputCanvasOptions {
  127238. /**
  127239. * An optional canvas in case you wish to create it yourself and provide it here.
  127240. * If not provided, a new canvas will be created
  127241. */
  127242. canvasElement?: HTMLCanvasElement;
  127243. /**
  127244. * Options for this XR Layer output
  127245. */
  127246. canvasOptions?: XRWebGLLayerOptions;
  127247. /**
  127248. * CSS styling for a newly created canvas (if not provided)
  127249. */
  127250. newCanvasCssStyle?: string;
  127251. /**
  127252. * Get the default values of the configuration object
  127253. * @param engine defines the engine to use (can be null)
  127254. * @returns default values of this configuration object
  127255. */
  127256. static GetDefaults(engine?: ThinEngine): WebXRManagedOutputCanvasOptions;
  127257. }
  127258. /**
  127259. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  127260. */
  127261. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  127262. private _options;
  127263. private _canvas;
  127264. private _engine;
  127265. private _originalCanvasSize;
  127266. /**
  127267. * Rendering context of the canvas which can be used to display/mirror xr content
  127268. */
  127269. canvasContext: WebGLRenderingContext;
  127270. /**
  127271. * xr layer for the canvas
  127272. */
  127273. xrLayer: Nullable<XRWebGLLayer>;
  127274. /**
  127275. * Obseervers registered here will be triggered when the xr layer was initialized
  127276. */
  127277. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  127278. /**
  127279. * Initializes the canvas to be added/removed upon entering/exiting xr
  127280. * @param _xrSessionManager The XR Session manager
  127281. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  127282. */
  127283. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  127284. /**
  127285. * Disposes of the object
  127286. */
  127287. dispose(): void;
  127288. /**
  127289. * Initializes the xr layer for the session
  127290. * @param xrSession xr session
  127291. * @returns a promise that will resolve once the XR Layer has been created
  127292. */
  127293. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  127294. private _addCanvas;
  127295. private _removeCanvas;
  127296. private _setCanvasSize;
  127297. private _setManagedOutputCanvas;
  127298. }
  127299. }
  127300. declare module BABYLON {
  127301. /**
  127302. * Manages an XRSession to work with Babylon's engine
  127303. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  127304. */
  127305. export class WebXRSessionManager implements IDisposable {
  127306. /** The scene which the session should be created for */
  127307. scene: Scene;
  127308. private _referenceSpace;
  127309. private _rttProvider;
  127310. private _sessionEnded;
  127311. private _xrNavigator;
  127312. private baseLayer;
  127313. /**
  127314. * The base reference space from which the session started. good if you want to reset your
  127315. * reference space
  127316. */
  127317. baseReferenceSpace: XRReferenceSpace;
  127318. /**
  127319. * Current XR frame
  127320. */
  127321. currentFrame: Nullable<XRFrame>;
  127322. /** WebXR timestamp updated every frame */
  127323. currentTimestamp: number;
  127324. /**
  127325. * Used just in case of a failure to initialize an immersive session.
  127326. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  127327. */
  127328. defaultHeightCompensation: number;
  127329. /**
  127330. * Fires every time a new xrFrame arrives which can be used to update the camera
  127331. */
  127332. onXRFrameObservable: Observable<XRFrame>;
  127333. /**
  127334. * Fires when the reference space changed
  127335. */
  127336. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  127337. /**
  127338. * Fires when the xr session is ended either by the device or manually done
  127339. */
  127340. onXRSessionEnded: Observable<any>;
  127341. /**
  127342. * Fires when the xr session is ended either by the device or manually done
  127343. */
  127344. onXRSessionInit: Observable<XRSession>;
  127345. /**
  127346. * Underlying xr session
  127347. */
  127348. session: XRSession;
  127349. /**
  127350. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  127351. * or get the offset the player is currently at.
  127352. */
  127353. viewerReferenceSpace: XRReferenceSpace;
  127354. /**
  127355. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  127356. * @param scene The scene which the session should be created for
  127357. */
  127358. constructor(
  127359. /** The scene which the session should be created for */
  127360. scene: Scene);
  127361. /**
  127362. * The current reference space used in this session. This reference space can constantly change!
  127363. * It is mainly used to offset the camera's position.
  127364. */
  127365. get referenceSpace(): XRReferenceSpace;
  127366. /**
  127367. * Set a new reference space and triggers the observable
  127368. */
  127369. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  127370. /**
  127371. * Disposes of the session manager
  127372. */
  127373. dispose(): void;
  127374. /**
  127375. * Stops the xrSession and restores the render loop
  127376. * @returns Promise which resolves after it exits XR
  127377. */
  127378. exitXRAsync(): Promise<void>;
  127379. /**
  127380. * Gets the correct render target texture to be rendered this frame for this eye
  127381. * @param eye the eye for which to get the render target
  127382. * @returns the render target for the specified eye
  127383. */
  127384. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  127385. /**
  127386. * Creates a WebXRRenderTarget object for the XR session
  127387. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  127388. * @param options optional options to provide when creating a new render target
  127389. * @returns a WebXR render target to which the session can render
  127390. */
  127391. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  127392. /**
  127393. * Initializes the manager
  127394. * After initialization enterXR can be called to start an XR session
  127395. * @returns Promise which resolves after it is initialized
  127396. */
  127397. initializeAsync(): Promise<void>;
  127398. /**
  127399. * Initializes an xr session
  127400. * @param xrSessionMode mode to initialize
  127401. * @param xrSessionInit defines optional and required values to pass to the session builder
  127402. * @returns a promise which will resolve once the session has been initialized
  127403. */
  127404. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  127405. /**
  127406. * Checks if a session would be supported for the creation options specified
  127407. * @param sessionMode session mode to check if supported eg. immersive-vr
  127408. * @returns A Promise that resolves to true if supported and false if not
  127409. */
  127410. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  127411. /**
  127412. * Resets the reference space to the one started the session
  127413. */
  127414. resetReferenceSpace(): void;
  127415. /**
  127416. * Starts rendering to the xr layer
  127417. */
  127418. runXRRenderLoop(): void;
  127419. /**
  127420. * Sets the reference space on the xr session
  127421. * @param referenceSpaceType space to set
  127422. * @returns a promise that will resolve once the reference space has been set
  127423. */
  127424. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  127425. /**
  127426. * Updates the render state of the session
  127427. * @param state state to set
  127428. * @returns a promise that resolves once the render state has been updated
  127429. */
  127430. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  127431. /**
  127432. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  127433. * @param sessionMode defines the session to test
  127434. * @returns a promise with boolean as final value
  127435. */
  127436. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  127437. private _createRenderTargetTexture;
  127438. }
  127439. }
  127440. declare module BABYLON {
  127441. /**
  127442. * WebXR Camera which holds the views for the xrSession
  127443. * @see https://doc.babylonjs.com/how_to/webxr_camera
  127444. */
  127445. export class WebXRCamera extends FreeCamera {
  127446. private _xrSessionManager;
  127447. private _firstFrame;
  127448. private _referenceQuaternion;
  127449. private _referencedPosition;
  127450. private _xrInvPositionCache;
  127451. private _xrInvQuaternionCache;
  127452. /**
  127453. * Observable raised before camera teleportation
  127454. */
  127455. onBeforeCameraTeleport: Observable<Vector3>;
  127456. /**
  127457. * Observable raised after camera teleportation
  127458. */
  127459. onAfterCameraTeleport: Observable<Vector3>;
  127460. /**
  127461. * Should position compensation execute on first frame.
  127462. * This is used when copying the position from a native (non XR) camera
  127463. */
  127464. compensateOnFirstFrame: boolean;
  127465. /**
  127466. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  127467. * @param name the name of the camera
  127468. * @param scene the scene to add the camera to
  127469. * @param _xrSessionManager a constructed xr session manager
  127470. */
  127471. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  127472. /**
  127473. * Return the user's height, unrelated to the current ground.
  127474. * This will be the y position of this camera, when ground level is 0.
  127475. */
  127476. get realWorldHeight(): number;
  127477. /** @hidden */
  127478. _updateForDualEyeDebugging(): void;
  127479. /**
  127480. * Sets this camera's transformation based on a non-vr camera
  127481. * @param otherCamera the non-vr camera to copy the transformation from
  127482. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  127483. */
  127484. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  127485. /**
  127486. * Gets the current instance class name ("WebXRCamera").
  127487. * @returns the class name
  127488. */
  127489. getClassName(): string;
  127490. private _rotate180;
  127491. private _updateFromXRSession;
  127492. private _updateNumberOfRigCameras;
  127493. private _updateReferenceSpace;
  127494. private _updateReferenceSpaceOffset;
  127495. }
  127496. }
  127497. declare module BABYLON {
  127498. /**
  127499. * Defining the interface required for a (webxr) feature
  127500. */
  127501. export interface IWebXRFeature extends IDisposable {
  127502. /**
  127503. * Is this feature attached
  127504. */
  127505. attached: boolean;
  127506. /**
  127507. * Should auto-attach be disabled?
  127508. */
  127509. disableAutoAttach: boolean;
  127510. /**
  127511. * Attach the feature to the session
  127512. * Will usually be called by the features manager
  127513. *
  127514. * @param force should attachment be forced (even when already attached)
  127515. * @returns true if successful.
  127516. */
  127517. attach(force?: boolean): boolean;
  127518. /**
  127519. * Detach the feature from the session
  127520. * Will usually be called by the features manager
  127521. *
  127522. * @returns true if successful.
  127523. */
  127524. detach(): boolean;
  127525. /**
  127526. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  127527. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  127528. *
  127529. * @returns whether or not the feature is compatible in this environment
  127530. */
  127531. isCompatible(): boolean;
  127532. /**
  127533. * Was this feature disposed;
  127534. */
  127535. isDisposed: boolean;
  127536. /**
  127537. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  127538. */
  127539. xrNativeFeatureName?: string;
  127540. /**
  127541. * A list of (Babylon WebXR) features this feature depends on
  127542. */
  127543. dependsOn?: string[];
  127544. }
  127545. /**
  127546. * A list of the currently available features without referencing them
  127547. */
  127548. export class WebXRFeatureName {
  127549. /**
  127550. * The name of the anchor system feature
  127551. */
  127552. static readonly ANCHOR_SYSTEM: string;
  127553. /**
  127554. * The name of the background remover feature
  127555. */
  127556. static readonly BACKGROUND_REMOVER: string;
  127557. /**
  127558. * The name of the hit test feature
  127559. */
  127560. static readonly HIT_TEST: string;
  127561. /**
  127562. * physics impostors for xr controllers feature
  127563. */
  127564. static readonly PHYSICS_CONTROLLERS: string;
  127565. /**
  127566. * The name of the plane detection feature
  127567. */
  127568. static readonly PLANE_DETECTION: string;
  127569. /**
  127570. * The name of the pointer selection feature
  127571. */
  127572. static readonly POINTER_SELECTION: string;
  127573. /**
  127574. * The name of the teleportation feature
  127575. */
  127576. static readonly TELEPORTATION: string;
  127577. /**
  127578. * The name of the feature points feature.
  127579. */
  127580. static readonly FEATURE_POINTS: string;
  127581. /**
  127582. * The name of the hand tracking feature.
  127583. */
  127584. static readonly HAND_TRACKING: string;
  127585. }
  127586. /**
  127587. * Defining the constructor of a feature. Used to register the modules.
  127588. */
  127589. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  127590. /**
  127591. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  127592. * It is mainly used in AR sessions.
  127593. *
  127594. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  127595. */
  127596. export class WebXRFeaturesManager implements IDisposable {
  127597. private _xrSessionManager;
  127598. private static readonly _AvailableFeatures;
  127599. private _features;
  127600. /**
  127601. * constructs a new features manages.
  127602. *
  127603. * @param _xrSessionManager an instance of WebXRSessionManager
  127604. */
  127605. constructor(_xrSessionManager: WebXRSessionManager);
  127606. /**
  127607. * Used to register a module. After calling this function a developer can use this feature in the scene.
  127608. * Mainly used internally.
  127609. *
  127610. * @param featureName the name of the feature to register
  127611. * @param constructorFunction the function used to construct the module
  127612. * @param version the (babylon) version of the module
  127613. * @param stable is that a stable version of this module
  127614. */
  127615. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  127616. /**
  127617. * Returns a constructor of a specific feature.
  127618. *
  127619. * @param featureName the name of the feature to construct
  127620. * @param version the version of the feature to load
  127621. * @param xrSessionManager the xrSessionManager. Used to construct the module
  127622. * @param options optional options provided to the module.
  127623. * @returns a function that, when called, will return a new instance of this feature
  127624. */
  127625. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  127626. /**
  127627. * Can be used to return the list of features currently registered
  127628. *
  127629. * @returns an Array of available features
  127630. */
  127631. static GetAvailableFeatures(): string[];
  127632. /**
  127633. * Gets the versions available for a specific feature
  127634. * @param featureName the name of the feature
  127635. * @returns an array with the available versions
  127636. */
  127637. static GetAvailableVersions(featureName: string): string[];
  127638. /**
  127639. * Return the latest unstable version of this feature
  127640. * @param featureName the name of the feature to search
  127641. * @returns the version number. if not found will return -1
  127642. */
  127643. static GetLatestVersionOfFeature(featureName: string): number;
  127644. /**
  127645. * Return the latest stable version of this feature
  127646. * @param featureName the name of the feature to search
  127647. * @returns the version number. if not found will return -1
  127648. */
  127649. static GetStableVersionOfFeature(featureName: string): number;
  127650. /**
  127651. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  127652. * Can be used during a session to start a feature
  127653. * @param featureName the name of feature to attach
  127654. */
  127655. attachFeature(featureName: string): void;
  127656. /**
  127657. * Can be used inside a session or when the session ends to detach a specific feature
  127658. * @param featureName the name of the feature to detach
  127659. */
  127660. detachFeature(featureName: string): void;
  127661. /**
  127662. * Used to disable an already-enabled feature
  127663. * The feature will be disposed and will be recreated once enabled.
  127664. * @param featureName the feature to disable
  127665. * @returns true if disable was successful
  127666. */
  127667. disableFeature(featureName: string | {
  127668. Name: string;
  127669. }): boolean;
  127670. /**
  127671. * dispose this features manager
  127672. */
  127673. dispose(): void;
  127674. /**
  127675. * 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.
  127676. * 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.
  127677. *
  127678. * @param featureName the name of the feature to load or the class of the feature
  127679. * @param version optional version to load. if not provided the latest version will be enabled
  127680. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  127681. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  127682. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  127683. * @returns a new constructed feature or throws an error if feature not found.
  127684. */
  127685. enableFeature(featureName: string | {
  127686. Name: string;
  127687. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  127688. /**
  127689. * get the implementation of an enabled feature.
  127690. * @param featureName the name of the feature to load
  127691. * @returns the feature class, if found
  127692. */
  127693. getEnabledFeature(featureName: string): IWebXRFeature;
  127694. /**
  127695. * Get the list of enabled features
  127696. * @returns an array of enabled features
  127697. */
  127698. getEnabledFeatures(): string[];
  127699. /**
  127700. * This function will exten the session creation configuration object with enabled features.
  127701. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  127702. * according to the defined "required" variable, provided during enableFeature call
  127703. * @param xrSessionInit the xr Session init object to extend
  127704. *
  127705. * @returns an extended XRSessionInit object
  127706. */
  127707. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  127708. }
  127709. }
  127710. declare module BABYLON {
  127711. /**
  127712. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  127713. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  127714. */
  127715. export class WebXRExperienceHelper implements IDisposable {
  127716. private scene;
  127717. private _nonVRCamera;
  127718. private _originalSceneAutoClear;
  127719. private _supported;
  127720. /**
  127721. * Camera used to render xr content
  127722. */
  127723. camera: WebXRCamera;
  127724. /** A features manager for this xr session */
  127725. featuresManager: WebXRFeaturesManager;
  127726. /**
  127727. * Observers registered here will be triggered after the camera's initial transformation is set
  127728. * This can be used to set a different ground level or an extra rotation.
  127729. *
  127730. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  127731. * to the position set after this observable is done executing.
  127732. */
  127733. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  127734. /**
  127735. * Fires when the state of the experience helper has changed
  127736. */
  127737. onStateChangedObservable: Observable<WebXRState>;
  127738. /** Session manager used to keep track of xr session */
  127739. sessionManager: WebXRSessionManager;
  127740. /**
  127741. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  127742. */
  127743. state: WebXRState;
  127744. /**
  127745. * Creates a WebXRExperienceHelper
  127746. * @param scene The scene the helper should be created in
  127747. */
  127748. private constructor();
  127749. /**
  127750. * Creates the experience helper
  127751. * @param scene the scene to attach the experience helper to
  127752. * @returns a promise for the experience helper
  127753. */
  127754. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  127755. /**
  127756. * Disposes of the experience helper
  127757. */
  127758. dispose(): void;
  127759. /**
  127760. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  127761. * @param sessionMode options for the XR session
  127762. * @param referenceSpaceType frame of reference of the XR session
  127763. * @param renderTarget the output canvas that will be used to enter XR mode
  127764. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  127765. * @returns promise that resolves after xr mode has entered
  127766. */
  127767. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  127768. /**
  127769. * Exits XR mode and returns the scene to its original state
  127770. * @returns promise that resolves after xr mode has exited
  127771. */
  127772. exitXRAsync(): Promise<void>;
  127773. private _nonXRToXRCamera;
  127774. private _setState;
  127775. }
  127776. }
  127777. declare module BABYLON {
  127778. /**
  127779. * X-Y values for axes in WebXR
  127780. */
  127781. export interface IWebXRMotionControllerAxesValue {
  127782. /**
  127783. * The value of the x axis
  127784. */
  127785. x: number;
  127786. /**
  127787. * The value of the y-axis
  127788. */
  127789. y: number;
  127790. }
  127791. /**
  127792. * changed / previous values for the values of this component
  127793. */
  127794. export interface IWebXRMotionControllerComponentChangesValues<T> {
  127795. /**
  127796. * current (this frame) value
  127797. */
  127798. current: T;
  127799. /**
  127800. * previous (last change) value
  127801. */
  127802. previous: T;
  127803. }
  127804. /**
  127805. * Represents changes in the component between current frame and last values recorded
  127806. */
  127807. export interface IWebXRMotionControllerComponentChanges {
  127808. /**
  127809. * will be populated with previous and current values if axes changed
  127810. */
  127811. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  127812. /**
  127813. * will be populated with previous and current values if pressed changed
  127814. */
  127815. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  127816. /**
  127817. * will be populated with previous and current values if touched changed
  127818. */
  127819. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  127820. /**
  127821. * will be populated with previous and current values if value changed
  127822. */
  127823. value?: IWebXRMotionControllerComponentChangesValues<number>;
  127824. }
  127825. /**
  127826. * This class represents a single component (for example button or thumbstick) of a motion controller
  127827. */
  127828. export class WebXRControllerComponent implements IDisposable {
  127829. /**
  127830. * the id of this component
  127831. */
  127832. id: string;
  127833. /**
  127834. * the type of the component
  127835. */
  127836. type: MotionControllerComponentType;
  127837. private _buttonIndex;
  127838. private _axesIndices;
  127839. private _axes;
  127840. private _changes;
  127841. private _currentValue;
  127842. private _hasChanges;
  127843. private _pressed;
  127844. private _touched;
  127845. /**
  127846. * button component type
  127847. */
  127848. static BUTTON_TYPE: MotionControllerComponentType;
  127849. /**
  127850. * squeeze component type
  127851. */
  127852. static SQUEEZE_TYPE: MotionControllerComponentType;
  127853. /**
  127854. * Thumbstick component type
  127855. */
  127856. static THUMBSTICK_TYPE: MotionControllerComponentType;
  127857. /**
  127858. * Touchpad component type
  127859. */
  127860. static TOUCHPAD_TYPE: MotionControllerComponentType;
  127861. /**
  127862. * trigger component type
  127863. */
  127864. static TRIGGER_TYPE: MotionControllerComponentType;
  127865. /**
  127866. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  127867. * the axes data changes
  127868. */
  127869. onAxisValueChangedObservable: Observable<{
  127870. x: number;
  127871. y: number;
  127872. }>;
  127873. /**
  127874. * Observers registered here will be triggered when the state of a button changes
  127875. * State change is either pressed / touched / value
  127876. */
  127877. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  127878. /**
  127879. * Creates a new component for a motion controller.
  127880. * It is created by the motion controller itself
  127881. *
  127882. * @param id the id of this component
  127883. * @param type the type of the component
  127884. * @param _buttonIndex index in the buttons array of the gamepad
  127885. * @param _axesIndices indices of the values in the axes array of the gamepad
  127886. */
  127887. constructor(
  127888. /**
  127889. * the id of this component
  127890. */
  127891. id: string,
  127892. /**
  127893. * the type of the component
  127894. */
  127895. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  127896. /**
  127897. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  127898. */
  127899. get axes(): IWebXRMotionControllerAxesValue;
  127900. /**
  127901. * Get the changes. Elements will be populated only if they changed with their previous and current value
  127902. */
  127903. get changes(): IWebXRMotionControllerComponentChanges;
  127904. /**
  127905. * Return whether or not the component changed the last frame
  127906. */
  127907. get hasChanges(): boolean;
  127908. /**
  127909. * is the button currently pressed
  127910. */
  127911. get pressed(): boolean;
  127912. /**
  127913. * is the button currently touched
  127914. */
  127915. get touched(): boolean;
  127916. /**
  127917. * Get the current value of this component
  127918. */
  127919. get value(): number;
  127920. /**
  127921. * Dispose this component
  127922. */
  127923. dispose(): void;
  127924. /**
  127925. * Are there axes correlating to this component
  127926. * @return true is axes data is available
  127927. */
  127928. isAxes(): boolean;
  127929. /**
  127930. * Is this component a button (hence - pressable)
  127931. * @returns true if can be pressed
  127932. */
  127933. isButton(): boolean;
  127934. /**
  127935. * update this component using the gamepad object it is in. Called on every frame
  127936. * @param nativeController the native gamepad controller object
  127937. */
  127938. update(nativeController: IMinimalMotionControllerObject): void;
  127939. }
  127940. }
  127941. declare module BABYLON {
  127942. /**
  127943. * Interface used to represent data loading progression
  127944. */
  127945. export interface ISceneLoaderProgressEvent {
  127946. /**
  127947. * Defines if data length to load can be evaluated
  127948. */
  127949. readonly lengthComputable: boolean;
  127950. /**
  127951. * Defines the loaded data length
  127952. */
  127953. readonly loaded: number;
  127954. /**
  127955. * Defines the data length to load
  127956. */
  127957. readonly total: number;
  127958. }
  127959. /**
  127960. * Interface used by SceneLoader plugins to define supported file extensions
  127961. */
  127962. export interface ISceneLoaderPluginExtensions {
  127963. /**
  127964. * Defines the list of supported extensions
  127965. */
  127966. [extension: string]: {
  127967. isBinary: boolean;
  127968. };
  127969. }
  127970. /**
  127971. * Interface used by SceneLoader plugin factory
  127972. */
  127973. export interface ISceneLoaderPluginFactory {
  127974. /**
  127975. * Defines the name of the factory
  127976. */
  127977. name: string;
  127978. /**
  127979. * Function called to create a new plugin
  127980. * @return the new plugin
  127981. */
  127982. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  127983. /**
  127984. * The callback that returns true if the data can be directly loaded.
  127985. * @param data string containing the file data
  127986. * @returns if the data can be loaded directly
  127987. */
  127988. canDirectLoad?(data: string): boolean;
  127989. }
  127990. /**
  127991. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  127992. */
  127993. export interface ISceneLoaderPluginBase {
  127994. /**
  127995. * The friendly name of this plugin.
  127996. */
  127997. name: string;
  127998. /**
  127999. * The file extensions supported by this plugin.
  128000. */
  128001. extensions: string | ISceneLoaderPluginExtensions;
  128002. /**
  128003. * The callback called when loading from a url.
  128004. * @param scene scene loading this url
  128005. * @param url url to load
  128006. * @param onSuccess callback called when the file successfully loads
  128007. * @param onProgress callback called while file is loading (if the server supports this mode)
  128008. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  128009. * @param onError callback called when the file fails to load
  128010. * @returns a file request object
  128011. */
  128012. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  128013. /**
  128014. * The callback called when loading from a file object.
  128015. * @param scene scene loading this file
  128016. * @param file defines the file to load
  128017. * @param onSuccess defines the callback to call when data is loaded
  128018. * @param onProgress defines the callback to call during loading process
  128019. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  128020. * @param onError defines the callback to call when an error occurs
  128021. * @returns a file request object
  128022. */
  128023. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  128024. /**
  128025. * The callback that returns true if the data can be directly loaded.
  128026. * @param data string containing the file data
  128027. * @returns if the data can be loaded directly
  128028. */
  128029. canDirectLoad?(data: string): boolean;
  128030. /**
  128031. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  128032. * @param scene scene loading this data
  128033. * @param data string containing the data
  128034. * @returns data to pass to the plugin
  128035. */
  128036. directLoad?(scene: Scene, data: string): any;
  128037. /**
  128038. * The callback that allows custom handling of the root url based on the response url.
  128039. * @param rootUrl the original root url
  128040. * @param responseURL the response url if available
  128041. * @returns the new root url
  128042. */
  128043. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  128044. }
  128045. /**
  128046. * Interface used to define a SceneLoader plugin
  128047. */
  128048. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  128049. /**
  128050. * Import meshes into a scene.
  128051. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  128052. * @param scene The scene to import into
  128053. * @param data The data to import
  128054. * @param rootUrl The root url for scene and resources
  128055. * @param meshes The meshes array to import into
  128056. * @param particleSystems The particle systems array to import into
  128057. * @param skeletons The skeletons array to import into
  128058. * @param onError The callback when import fails
  128059. * @returns True if successful or false otherwise
  128060. */
  128061. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  128062. /**
  128063. * Load into a scene.
  128064. * @param scene The scene to load into
  128065. * @param data The data to import
  128066. * @param rootUrl The root url for scene and resources
  128067. * @param onError The callback when import fails
  128068. * @returns True if successful or false otherwise
  128069. */
  128070. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  128071. /**
  128072. * Load into an asset container.
  128073. * @param scene The scene to load into
  128074. * @param data The data to import
  128075. * @param rootUrl The root url for scene and resources
  128076. * @param onError The callback when import fails
  128077. * @returns The loaded asset container
  128078. */
  128079. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  128080. }
  128081. /**
  128082. * Interface used to define an async SceneLoader plugin
  128083. */
  128084. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  128085. /**
  128086. * Import meshes into a scene.
  128087. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  128088. * @param scene The scene to import into
  128089. * @param data The data to import
  128090. * @param rootUrl The root url for scene and resources
  128091. * @param onProgress The callback when the load progresses
  128092. * @param fileName Defines the name of the file to load
  128093. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  128094. */
  128095. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  128096. meshes: AbstractMesh[];
  128097. particleSystems: IParticleSystem[];
  128098. skeletons: Skeleton[];
  128099. animationGroups: AnimationGroup[];
  128100. }>;
  128101. /**
  128102. * Load into a scene.
  128103. * @param scene The scene to load into
  128104. * @param data The data to import
  128105. * @param rootUrl The root url for scene and resources
  128106. * @param onProgress The callback when the load progresses
  128107. * @param fileName Defines the name of the file to load
  128108. * @returns Nothing
  128109. */
  128110. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  128111. /**
  128112. * Load into an asset container.
  128113. * @param scene The scene to load into
  128114. * @param data The data to import
  128115. * @param rootUrl The root url for scene and resources
  128116. * @param onProgress The callback when the load progresses
  128117. * @param fileName Defines the name of the file to load
  128118. * @returns The loaded asset container
  128119. */
  128120. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  128121. }
  128122. /**
  128123. * Mode that determines how to handle old animation groups before loading new ones.
  128124. */
  128125. export enum SceneLoaderAnimationGroupLoadingMode {
  128126. /**
  128127. * Reset all old animations to initial state then dispose them.
  128128. */
  128129. Clean = 0,
  128130. /**
  128131. * Stop all old animations.
  128132. */
  128133. Stop = 1,
  128134. /**
  128135. * Restart old animations from first frame.
  128136. */
  128137. Sync = 2,
  128138. /**
  128139. * Old animations remains untouched.
  128140. */
  128141. NoSync = 3
  128142. }
  128143. /**
  128144. * Defines a plugin registered by the SceneLoader
  128145. */
  128146. interface IRegisteredPlugin {
  128147. /**
  128148. * Defines the plugin to use
  128149. */
  128150. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  128151. /**
  128152. * Defines if the plugin supports binary data
  128153. */
  128154. isBinary: boolean;
  128155. }
  128156. /**
  128157. * Class used to load scene from various file formats using registered plugins
  128158. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  128159. */
  128160. export class SceneLoader {
  128161. /**
  128162. * No logging while loading
  128163. */
  128164. static readonly NO_LOGGING: number;
  128165. /**
  128166. * Minimal logging while loading
  128167. */
  128168. static readonly MINIMAL_LOGGING: number;
  128169. /**
  128170. * Summary logging while loading
  128171. */
  128172. static readonly SUMMARY_LOGGING: number;
  128173. /**
  128174. * Detailled logging while loading
  128175. */
  128176. static readonly DETAILED_LOGGING: number;
  128177. /**
  128178. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  128179. */
  128180. static get ForceFullSceneLoadingForIncremental(): boolean;
  128181. static set ForceFullSceneLoadingForIncremental(value: boolean);
  128182. /**
  128183. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  128184. */
  128185. static get ShowLoadingScreen(): boolean;
  128186. static set ShowLoadingScreen(value: boolean);
  128187. /**
  128188. * Defines the current logging level (while loading the scene)
  128189. * @ignorenaming
  128190. */
  128191. static get loggingLevel(): number;
  128192. static set loggingLevel(value: number);
  128193. /**
  128194. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  128195. */
  128196. static get CleanBoneMatrixWeights(): boolean;
  128197. static set CleanBoneMatrixWeights(value: boolean);
  128198. /**
  128199. * Event raised when a plugin is used to load a scene
  128200. */
  128201. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  128202. private static _registeredPlugins;
  128203. private static _showingLoadingScreen;
  128204. /**
  128205. * Gets the default plugin (used to load Babylon files)
  128206. * @returns the .babylon plugin
  128207. */
  128208. static GetDefaultPlugin(): IRegisteredPlugin;
  128209. private static _GetPluginForExtension;
  128210. private static _GetPluginForDirectLoad;
  128211. private static _GetPluginForFilename;
  128212. private static _GetDirectLoad;
  128213. private static _LoadData;
  128214. private static _GetFileInfo;
  128215. /**
  128216. * Gets a plugin that can load the given extension
  128217. * @param extension defines the extension to load
  128218. * @returns a plugin or null if none works
  128219. */
  128220. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  128221. /**
  128222. * Gets a boolean indicating that the given extension can be loaded
  128223. * @param extension defines the extension to load
  128224. * @returns true if the extension is supported
  128225. */
  128226. static IsPluginForExtensionAvailable(extension: string): boolean;
  128227. /**
  128228. * Adds a new plugin to the list of registered plugins
  128229. * @param plugin defines the plugin to add
  128230. */
  128231. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  128232. /**
  128233. * Import meshes into a scene
  128234. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  128235. * @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)
  128236. * @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)
  128237. * @param scene the instance of BABYLON.Scene to append to
  128238. * @param onSuccess a callback with a list of imported meshes, particleSystems, skeletons, and animationGroups when import succeeds
  128239. * @param onProgress a callback with a progress event for each file being loaded
  128240. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  128241. * @param pluginExtension the extension used to determine the plugin
  128242. * @returns The loaded plugin
  128243. */
  128244. 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>;
  128245. /**
  128246. * Import meshes into a scene
  128247. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  128248. * @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)
  128249. * @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)
  128250. * @param scene the instance of BABYLON.Scene to append to
  128251. * @param onProgress a callback with a progress event for each file being loaded
  128252. * @param pluginExtension the extension used to determine the plugin
  128253. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  128254. */
  128255. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  128256. meshes: AbstractMesh[];
  128257. particleSystems: IParticleSystem[];
  128258. skeletons: Skeleton[];
  128259. animationGroups: AnimationGroup[];
  128260. }>;
  128261. /**
  128262. * Load a scene
  128263. * @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)
  128264. * @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)
  128265. * @param engine is the instance of BABYLON.Engine to use to create the scene
  128266. * @param onSuccess a callback with the scene when import succeeds
  128267. * @param onProgress a callback with a progress event for each file being loaded
  128268. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  128269. * @param pluginExtension the extension used to determine the plugin
  128270. * @returns The loaded plugin
  128271. */
  128272. 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>;
  128273. /**
  128274. * Load a scene
  128275. * @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)
  128276. * @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)
  128277. * @param engine is the instance of BABYLON.Engine to use to create the scene
  128278. * @param onProgress a callback with a progress event for each file being loaded
  128279. * @param pluginExtension the extension used to determine the plugin
  128280. * @returns The loaded scene
  128281. */
  128282. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  128283. /**
  128284. * Append a scene
  128285. * @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)
  128286. * @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)
  128287. * @param scene is the instance of BABYLON.Scene to append to
  128288. * @param onSuccess a callback with the scene when import succeeds
  128289. * @param onProgress a callback with a progress event for each file being loaded
  128290. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  128291. * @param pluginExtension the extension used to determine the plugin
  128292. * @returns The loaded plugin
  128293. */
  128294. 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>;
  128295. /**
  128296. * Append a scene
  128297. * @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)
  128298. * @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)
  128299. * @param scene is the instance of BABYLON.Scene to append to
  128300. * @param onProgress a callback with a progress event for each file being loaded
  128301. * @param pluginExtension the extension used to determine the plugin
  128302. * @returns The given scene
  128303. */
  128304. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  128305. /**
  128306. * Load a scene into an asset container
  128307. * @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)
  128308. * @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)
  128309. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  128310. * @param onSuccess a callback with the scene when import succeeds
  128311. * @param onProgress a callback with a progress event for each file being loaded
  128312. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  128313. * @param pluginExtension the extension used to determine the plugin
  128314. * @returns The loaded plugin
  128315. */
  128316. 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>;
  128317. /**
  128318. * Load a scene into an asset container
  128319. * @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)
  128320. * @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)
  128321. * @param scene is the instance of Scene to append to
  128322. * @param onProgress a callback with a progress event for each file being loaded
  128323. * @param pluginExtension the extension used to determine the plugin
  128324. * @returns The loaded asset container
  128325. */
  128326. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  128327. /**
  128328. * Import animations from a file into a scene
  128329. * @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)
  128330. * @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)
  128331. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  128332. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  128333. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  128334. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  128335. * @param onSuccess a callback with the scene when import succeeds
  128336. * @param onProgress a callback with a progress event for each file being loaded
  128337. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  128338. * @param pluginExtension the extension used to determine the plugin
  128339. */
  128340. 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;
  128341. /**
  128342. * Import animations from a file into a scene
  128343. * @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)
  128344. * @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)
  128345. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  128346. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  128347. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  128348. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  128349. * @param onSuccess a callback with the scene when import succeeds
  128350. * @param onProgress a callback with a progress event for each file being loaded
  128351. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  128352. * @param pluginExtension the extension used to determine the plugin
  128353. * @returns the updated scene with imported animations
  128354. */
  128355. 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>;
  128356. }
  128357. }
  128358. declare module BABYLON {
  128359. /**
  128360. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  128361. */
  128362. export type MotionControllerHandedness = "none" | "left" | "right";
  128363. /**
  128364. * The type of components available in motion controllers.
  128365. * This is not the name of the component.
  128366. */
  128367. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  128368. /**
  128369. * The state of a controller component
  128370. */
  128371. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  128372. /**
  128373. * The schema of motion controller layout.
  128374. * No object will be initialized using this interface
  128375. * This is used just to define the profile.
  128376. */
  128377. export interface IMotionControllerLayout {
  128378. /**
  128379. * Path to load the assets. Usually relative to the base path
  128380. */
  128381. assetPath: string;
  128382. /**
  128383. * Available components (unsorted)
  128384. */
  128385. components: {
  128386. /**
  128387. * A map of component Ids
  128388. */
  128389. [componentId: string]: {
  128390. /**
  128391. * The type of input the component outputs
  128392. */
  128393. type: MotionControllerComponentType;
  128394. /**
  128395. * The indices of this component in the gamepad object
  128396. */
  128397. gamepadIndices: {
  128398. /**
  128399. * Index of button
  128400. */
  128401. button?: number;
  128402. /**
  128403. * If available, index of x-axis
  128404. */
  128405. xAxis?: number;
  128406. /**
  128407. * If available, index of y-axis
  128408. */
  128409. yAxis?: number;
  128410. };
  128411. /**
  128412. * The mesh's root node name
  128413. */
  128414. rootNodeName: string;
  128415. /**
  128416. * Animation definitions for this model
  128417. */
  128418. visualResponses: {
  128419. [stateKey: string]: {
  128420. /**
  128421. * What property will be animated
  128422. */
  128423. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  128424. /**
  128425. * What states influence this visual response
  128426. */
  128427. states: MotionControllerComponentStateType[];
  128428. /**
  128429. * Type of animation - movement or visibility
  128430. */
  128431. valueNodeProperty: "transform" | "visibility";
  128432. /**
  128433. * Base node name to move. Its position will be calculated according to the min and max nodes
  128434. */
  128435. valueNodeName?: string;
  128436. /**
  128437. * Minimum movement node
  128438. */
  128439. minNodeName?: string;
  128440. /**
  128441. * Max movement node
  128442. */
  128443. maxNodeName?: string;
  128444. };
  128445. };
  128446. /**
  128447. * If touch enabled, what is the name of node to display user feedback
  128448. */
  128449. touchPointNodeName?: string;
  128450. };
  128451. };
  128452. /**
  128453. * Is it xr standard mapping or not
  128454. */
  128455. gamepadMapping: "" | "xr-standard";
  128456. /**
  128457. * Base root node of this entire model
  128458. */
  128459. rootNodeName: string;
  128460. /**
  128461. * Defines the main button component id
  128462. */
  128463. selectComponentId: string;
  128464. }
  128465. /**
  128466. * A definition for the layout map in the input profile
  128467. */
  128468. export interface IMotionControllerLayoutMap {
  128469. /**
  128470. * Layouts with handedness type as a key
  128471. */
  128472. [handedness: string]: IMotionControllerLayout;
  128473. }
  128474. /**
  128475. * The XR Input profile schema
  128476. * Profiles can be found here:
  128477. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  128478. */
  128479. export interface IMotionControllerProfile {
  128480. /**
  128481. * fallback profiles for this profileId
  128482. */
  128483. fallbackProfileIds: string[];
  128484. /**
  128485. * The layout map, with handedness as key
  128486. */
  128487. layouts: IMotionControllerLayoutMap;
  128488. /**
  128489. * The id of this profile
  128490. * correlates to the profile(s) in the xrInput.profiles array
  128491. */
  128492. profileId: string;
  128493. }
  128494. /**
  128495. * A helper-interface for the 3 meshes needed for controller button animation
  128496. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  128497. */
  128498. export interface IMotionControllerButtonMeshMap {
  128499. /**
  128500. * the mesh that defines the pressed value mesh position.
  128501. * This is used to find the max-position of this button
  128502. */
  128503. pressedMesh: AbstractMesh;
  128504. /**
  128505. * the mesh that defines the unpressed value mesh position.
  128506. * This is used to find the min (or initial) position of this button
  128507. */
  128508. unpressedMesh: AbstractMesh;
  128509. /**
  128510. * The mesh that will be changed when value changes
  128511. */
  128512. valueMesh: AbstractMesh;
  128513. }
  128514. /**
  128515. * A helper-interface for the 3 meshes needed for controller axis animation.
  128516. * This will be expanded when touchpad animations are fully supported
  128517. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  128518. */
  128519. export interface IMotionControllerMeshMap {
  128520. /**
  128521. * the mesh that defines the maximum value mesh position.
  128522. */
  128523. maxMesh?: AbstractMesh;
  128524. /**
  128525. * the mesh that defines the minimum value mesh position.
  128526. */
  128527. minMesh?: AbstractMesh;
  128528. /**
  128529. * The mesh that will be changed when axis value changes
  128530. */
  128531. valueMesh?: AbstractMesh;
  128532. }
  128533. /**
  128534. * The elements needed for change-detection of the gamepad objects in motion controllers
  128535. */
  128536. export interface IMinimalMotionControllerObject {
  128537. /**
  128538. * Available axes of this controller
  128539. */
  128540. axes: number[];
  128541. /**
  128542. * An array of available buttons
  128543. */
  128544. buttons: Array<{
  128545. /**
  128546. * Value of the button/trigger
  128547. */
  128548. value: number;
  128549. /**
  128550. * If the button/trigger is currently touched
  128551. */
  128552. touched: boolean;
  128553. /**
  128554. * If the button/trigger is currently pressed
  128555. */
  128556. pressed: boolean;
  128557. }>;
  128558. /**
  128559. * EXPERIMENTAL haptic support.
  128560. */
  128561. hapticActuators?: Array<{
  128562. pulse: (value: number, duration: number) => Promise<boolean>;
  128563. }>;
  128564. }
  128565. /**
  128566. * An Abstract Motion controller
  128567. * This class receives an xrInput and a profile layout and uses those to initialize the components
  128568. * Each component has an observable to check for changes in value and state
  128569. */
  128570. export abstract class WebXRAbstractMotionController implements IDisposable {
  128571. protected scene: Scene;
  128572. protected layout: IMotionControllerLayout;
  128573. /**
  128574. * The gamepad object correlating to this controller
  128575. */
  128576. gamepadObject: IMinimalMotionControllerObject;
  128577. /**
  128578. * handedness (left/right/none) of this controller
  128579. */
  128580. handedness: MotionControllerHandedness;
  128581. private _initComponent;
  128582. private _modelReady;
  128583. /**
  128584. * A map of components (WebXRControllerComponent) in this motion controller
  128585. * Components have a ComponentType and can also have both button and axis definitions
  128586. */
  128587. readonly components: {
  128588. [id: string]: WebXRControllerComponent;
  128589. };
  128590. /**
  128591. * Disable the model's animation. Can be set at any time.
  128592. */
  128593. disableAnimation: boolean;
  128594. /**
  128595. * Observers registered here will be triggered when the model of this controller is done loading
  128596. */
  128597. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  128598. /**
  128599. * The profile id of this motion controller
  128600. */
  128601. abstract profileId: string;
  128602. /**
  128603. * The root mesh of the model. It is null if the model was not yet initialized
  128604. */
  128605. rootMesh: Nullable<AbstractMesh>;
  128606. /**
  128607. * constructs a new abstract motion controller
  128608. * @param scene the scene to which the model of the controller will be added
  128609. * @param layout The profile layout to load
  128610. * @param gamepadObject The gamepad object correlating to this controller
  128611. * @param handedness handedness (left/right/none) of this controller
  128612. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  128613. */
  128614. constructor(scene: Scene, layout: IMotionControllerLayout,
  128615. /**
  128616. * The gamepad object correlating to this controller
  128617. */
  128618. gamepadObject: IMinimalMotionControllerObject,
  128619. /**
  128620. * handedness (left/right/none) of this controller
  128621. */
  128622. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  128623. /**
  128624. * Dispose this controller, the model mesh and all its components
  128625. */
  128626. dispose(): void;
  128627. /**
  128628. * Returns all components of specific type
  128629. * @param type the type to search for
  128630. * @return an array of components with this type
  128631. */
  128632. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  128633. /**
  128634. * get a component based an its component id as defined in layout.components
  128635. * @param id the id of the component
  128636. * @returns the component correlates to the id or undefined if not found
  128637. */
  128638. getComponent(id: string): WebXRControllerComponent;
  128639. /**
  128640. * Get the list of components available in this motion controller
  128641. * @returns an array of strings correlating to available components
  128642. */
  128643. getComponentIds(): string[];
  128644. /**
  128645. * Get the first component of specific type
  128646. * @param type type of component to find
  128647. * @return a controller component or null if not found
  128648. */
  128649. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  128650. /**
  128651. * Get the main (Select) component of this controller as defined in the layout
  128652. * @returns the main component of this controller
  128653. */
  128654. getMainComponent(): WebXRControllerComponent;
  128655. /**
  128656. * Loads the model correlating to this controller
  128657. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  128658. * @returns A promise fulfilled with the result of the model loading
  128659. */
  128660. loadModel(): Promise<boolean>;
  128661. /**
  128662. * Update this model using the current XRFrame
  128663. * @param xrFrame the current xr frame to use and update the model
  128664. */
  128665. updateFromXRFrame(xrFrame: XRFrame): void;
  128666. /**
  128667. * Backwards compatibility due to a deeply-integrated typo
  128668. */
  128669. get handness(): XREye;
  128670. /**
  128671. * Pulse (vibrate) this controller
  128672. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  128673. * Consecutive calls to this function will cancel the last pulse call
  128674. *
  128675. * @param value the strength of the pulse in 0.0...1.0 range
  128676. * @param duration Duration of the pulse in milliseconds
  128677. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  128678. * @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
  128679. */
  128680. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  128681. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  128682. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  128683. /**
  128684. * Moves the axis on the controller mesh based on its current state
  128685. * @param axis the index of the axis
  128686. * @param axisValue the value of the axis which determines the meshes new position
  128687. * @hidden
  128688. */
  128689. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  128690. /**
  128691. * Update the model itself with the current frame data
  128692. * @param xrFrame the frame to use for updating the model mesh
  128693. */
  128694. protected updateModel(xrFrame: XRFrame): void;
  128695. /**
  128696. * Get the filename and path for this controller's model
  128697. * @returns a map of filename and path
  128698. */
  128699. protected abstract _getFilenameAndPath(): {
  128700. filename: string;
  128701. path: string;
  128702. };
  128703. /**
  128704. * This function is called before the mesh is loaded. It checks for loading constraints.
  128705. * For example, this function can check if the GLB loader is available
  128706. * If this function returns false, the generic controller will be loaded instead
  128707. * @returns Is the client ready to load the mesh
  128708. */
  128709. protected abstract _getModelLoadingConstraints(): boolean;
  128710. /**
  128711. * This function will be called after the model was successfully loaded and can be used
  128712. * for mesh transformations before it is available for the user
  128713. * @param meshes the loaded meshes
  128714. */
  128715. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  128716. /**
  128717. * Set the root mesh for this controller. Important for the WebXR controller class
  128718. * @param meshes the loaded meshes
  128719. */
  128720. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  128721. /**
  128722. * A function executed each frame that updates the mesh (if needed)
  128723. * @param xrFrame the current xrFrame
  128724. */
  128725. protected abstract _updateModel(xrFrame: XRFrame): void;
  128726. private _getGenericFilenameAndPath;
  128727. private _getGenericParentMesh;
  128728. }
  128729. }
  128730. declare module BABYLON {
  128731. /**
  128732. * A generic trigger-only motion controller for WebXR
  128733. */
  128734. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  128735. /**
  128736. * Static version of the profile id of this controller
  128737. */
  128738. static ProfileId: string;
  128739. profileId: string;
  128740. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  128741. protected _getFilenameAndPath(): {
  128742. filename: string;
  128743. path: string;
  128744. };
  128745. protected _getModelLoadingConstraints(): boolean;
  128746. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  128747. protected _setRootMesh(meshes: AbstractMesh[]): void;
  128748. protected _updateModel(): void;
  128749. }
  128750. }
  128751. declare module BABYLON {
  128752. /**
  128753. * Class containing static functions to help procedurally build meshes
  128754. */
  128755. export class SphereBuilder {
  128756. /**
  128757. * Creates a sphere mesh
  128758. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  128759. * * 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`)
  128760. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  128761. * * 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
  128762. * * 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)
  128763. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  128764. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  128765. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128766. * @param name defines the name of the mesh
  128767. * @param options defines the options used to create the mesh
  128768. * @param scene defines the hosting scene
  128769. * @returns the sphere mesh
  128770. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  128771. */
  128772. static CreateSphere(name: string, options: {
  128773. segments?: number;
  128774. diameter?: number;
  128775. diameterX?: number;
  128776. diameterY?: number;
  128777. diameterZ?: number;
  128778. arc?: number;
  128779. slice?: number;
  128780. sideOrientation?: number;
  128781. frontUVs?: Vector4;
  128782. backUVs?: Vector4;
  128783. updatable?: boolean;
  128784. }, scene?: Nullable<Scene>): Mesh;
  128785. }
  128786. }
  128787. declare module BABYLON {
  128788. /**
  128789. * A profiled motion controller has its profile loaded from an online repository.
  128790. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  128791. */
  128792. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  128793. private _repositoryUrl;
  128794. private _buttonMeshMapping;
  128795. private _touchDots;
  128796. /**
  128797. * The profile ID of this controller. Will be populated when the controller initializes.
  128798. */
  128799. profileId: string;
  128800. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  128801. dispose(): void;
  128802. protected _getFilenameAndPath(): {
  128803. filename: string;
  128804. path: string;
  128805. };
  128806. protected _getModelLoadingConstraints(): boolean;
  128807. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  128808. protected _setRootMesh(meshes: AbstractMesh[]): void;
  128809. protected _updateModel(_xrFrame: XRFrame): void;
  128810. }
  128811. }
  128812. declare module BABYLON {
  128813. /**
  128814. * A construction function type to create a new controller based on an xrInput object
  128815. */
  128816. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  128817. /**
  128818. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  128819. *
  128820. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  128821. * it should be replaced with auto-loaded controllers.
  128822. *
  128823. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  128824. */
  128825. export class WebXRMotionControllerManager {
  128826. private static _AvailableControllers;
  128827. private static _Fallbacks;
  128828. private static _ProfileLoadingPromises;
  128829. private static _ProfilesList;
  128830. /**
  128831. * The base URL of the online controller repository. Can be changed at any time.
  128832. */
  128833. static BaseRepositoryUrl: string;
  128834. /**
  128835. * Which repository gets priority - local or online
  128836. */
  128837. static PrioritizeOnlineRepository: boolean;
  128838. /**
  128839. * Use the online repository, or use only locally-defined controllers
  128840. */
  128841. static UseOnlineRepository: boolean;
  128842. /**
  128843. * Clear the cache used for profile loading and reload when requested again
  128844. */
  128845. static ClearProfilesCache(): void;
  128846. /**
  128847. * Register the default fallbacks.
  128848. * This function is called automatically when this file is imported.
  128849. */
  128850. static DefaultFallbacks(): void;
  128851. /**
  128852. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  128853. * @param profileId the profile to which a fallback needs to be found
  128854. * @return an array with corresponding fallback profiles
  128855. */
  128856. static FindFallbackWithProfileId(profileId: string): string[];
  128857. /**
  128858. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  128859. * The order of search:
  128860. *
  128861. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  128862. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  128863. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  128864. * 4) return the generic trigger controller if none were found
  128865. *
  128866. * @param xrInput the xrInput to which a new controller is initialized
  128867. * @param scene the scene to which the model will be added
  128868. * @param forceProfile force a certain profile for this controller
  128869. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  128870. */
  128871. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  128872. /**
  128873. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  128874. *
  128875. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  128876. *
  128877. * @param type the profile type to register
  128878. * @param constructFunction the function to be called when loading this profile
  128879. */
  128880. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  128881. /**
  128882. * Register a fallback to a specific profile.
  128883. * @param profileId the profileId that will receive the fallbacks
  128884. * @param fallbacks A list of fallback profiles
  128885. */
  128886. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  128887. /**
  128888. * Will update the list of profiles available in the repository
  128889. * @return a promise that resolves to a map of profiles available online
  128890. */
  128891. static UpdateProfilesList(): Promise<{
  128892. [profile: string]: string;
  128893. }>;
  128894. private static _LoadProfileFromRepository;
  128895. private static _LoadProfilesFromAvailableControllers;
  128896. }
  128897. }
  128898. declare module BABYLON {
  128899. /**
  128900. * Configuration options for the WebXR controller creation
  128901. */
  128902. export interface IWebXRControllerOptions {
  128903. /**
  128904. * Should the controller mesh be animated when a user interacts with it
  128905. * The pressed buttons / thumbstick and touchpad animations will be disabled
  128906. */
  128907. disableMotionControllerAnimation?: boolean;
  128908. /**
  128909. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  128910. */
  128911. doNotLoadControllerMesh?: boolean;
  128912. /**
  128913. * Force a specific controller type for this controller.
  128914. * This can be used when creating your own profile or when testing different controllers
  128915. */
  128916. forceControllerProfile?: string;
  128917. /**
  128918. * Defines a rendering group ID for meshes that will be loaded.
  128919. * This is for the default controllers only.
  128920. */
  128921. renderingGroupId?: number;
  128922. }
  128923. /**
  128924. * Represents an XR controller
  128925. */
  128926. export class WebXRInputSource {
  128927. private _scene;
  128928. /** The underlying input source for the controller */
  128929. inputSource: XRInputSource;
  128930. private _options;
  128931. private _tmpVector;
  128932. private _uniqueId;
  128933. private _disposed;
  128934. /**
  128935. * 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
  128936. */
  128937. grip?: AbstractMesh;
  128938. /**
  128939. * If available, this is the gamepad object related to this controller.
  128940. * Using this object it is possible to get click events and trackpad changes of the
  128941. * webxr controller that is currently being used.
  128942. */
  128943. motionController?: WebXRAbstractMotionController;
  128944. /**
  128945. * Event that fires when the controller is removed/disposed.
  128946. * The object provided as event data is this controller, after associated assets were disposed.
  128947. * uniqueId is still available.
  128948. */
  128949. onDisposeObservable: Observable<WebXRInputSource>;
  128950. /**
  128951. * Will be triggered when the mesh associated with the motion controller is done loading.
  128952. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  128953. * A shortened version of controller -> motion controller -> on mesh loaded.
  128954. */
  128955. onMeshLoadedObservable: Observable<AbstractMesh>;
  128956. /**
  128957. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  128958. */
  128959. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  128960. /**
  128961. * Pointer which can be used to select objects or attach a visible laser to
  128962. */
  128963. pointer: AbstractMesh;
  128964. /**
  128965. * Creates the input source object
  128966. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  128967. * @param _scene the scene which the controller should be associated to
  128968. * @param inputSource the underlying input source for the controller
  128969. * @param _options options for this controller creation
  128970. */
  128971. constructor(_scene: Scene,
  128972. /** The underlying input source for the controller */
  128973. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  128974. /**
  128975. * Get this controllers unique id
  128976. */
  128977. get uniqueId(): string;
  128978. /**
  128979. * Disposes of the object
  128980. */
  128981. dispose(): void;
  128982. /**
  128983. * Gets a world space ray coming from the pointer or grip
  128984. * @param result the resulting ray
  128985. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  128986. */
  128987. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  128988. /**
  128989. * Updates the controller pose based on the given XRFrame
  128990. * @param xrFrame xr frame to update the pose with
  128991. * @param referenceSpace reference space to use
  128992. */
  128993. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  128994. }
  128995. }
  128996. declare module BABYLON {
  128997. /**
  128998. * The schema for initialization options of the XR Input class
  128999. */
  129000. export interface IWebXRInputOptions {
  129001. /**
  129002. * If set to true no model will be automatically loaded
  129003. */
  129004. doNotLoadControllerMeshes?: boolean;
  129005. /**
  129006. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  129007. * If not found, the xr input profile data will be used.
  129008. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  129009. */
  129010. forceInputProfile?: string;
  129011. /**
  129012. * Do not send a request to the controller repository to load the profile.
  129013. *
  129014. * Instead, use the controllers available in babylon itself.
  129015. */
  129016. disableOnlineControllerRepository?: boolean;
  129017. /**
  129018. * A custom URL for the controllers repository
  129019. */
  129020. customControllersRepositoryURL?: string;
  129021. /**
  129022. * Should the controller model's components not move according to the user input
  129023. */
  129024. disableControllerAnimation?: boolean;
  129025. /**
  129026. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  129027. */
  129028. controllerOptions?: IWebXRControllerOptions;
  129029. }
  129030. /**
  129031. * XR input used to track XR inputs such as controllers/rays
  129032. */
  129033. export class WebXRInput implements IDisposable {
  129034. /**
  129035. * the xr session manager for this session
  129036. */
  129037. xrSessionManager: WebXRSessionManager;
  129038. /**
  129039. * the WebXR camera for this session. Mainly used for teleportation
  129040. */
  129041. xrCamera: WebXRCamera;
  129042. private readonly options;
  129043. /**
  129044. * XR controllers being tracked
  129045. */
  129046. controllers: Array<WebXRInputSource>;
  129047. private _frameObserver;
  129048. private _sessionEndedObserver;
  129049. private _sessionInitObserver;
  129050. /**
  129051. * Event when a controller has been connected/added
  129052. */
  129053. onControllerAddedObservable: Observable<WebXRInputSource>;
  129054. /**
  129055. * Event when a controller has been removed/disconnected
  129056. */
  129057. onControllerRemovedObservable: Observable<WebXRInputSource>;
  129058. /**
  129059. * Initializes the WebXRInput
  129060. * @param xrSessionManager the xr session manager for this session
  129061. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  129062. * @param options = initialization options for this xr input
  129063. */
  129064. constructor(
  129065. /**
  129066. * the xr session manager for this session
  129067. */
  129068. xrSessionManager: WebXRSessionManager,
  129069. /**
  129070. * the WebXR camera for this session. Mainly used for teleportation
  129071. */
  129072. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  129073. private _onInputSourcesChange;
  129074. private _addAndRemoveControllers;
  129075. /**
  129076. * Disposes of the object
  129077. */
  129078. dispose(): void;
  129079. }
  129080. }
  129081. declare module BABYLON {
  129082. /**
  129083. * This is the base class for all WebXR features.
  129084. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  129085. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  129086. */
  129087. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  129088. protected _xrSessionManager: WebXRSessionManager;
  129089. private _attached;
  129090. private _removeOnDetach;
  129091. /**
  129092. * Is this feature disposed?
  129093. */
  129094. isDisposed: boolean;
  129095. /**
  129096. * Should auto-attach be disabled?
  129097. */
  129098. disableAutoAttach: boolean;
  129099. /**
  129100. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  129101. */
  129102. xrNativeFeatureName: string;
  129103. /**
  129104. * Construct a new (abstract) WebXR feature
  129105. * @param _xrSessionManager the xr session manager for this feature
  129106. */
  129107. constructor(_xrSessionManager: WebXRSessionManager);
  129108. /**
  129109. * Is this feature attached
  129110. */
  129111. get attached(): boolean;
  129112. /**
  129113. * attach this feature
  129114. *
  129115. * @param force should attachment be forced (even when already attached)
  129116. * @returns true if successful, false is failed or already attached
  129117. */
  129118. attach(force?: boolean): boolean;
  129119. /**
  129120. * detach this feature.
  129121. *
  129122. * @returns true if successful, false if failed or already detached
  129123. */
  129124. detach(): boolean;
  129125. /**
  129126. * Dispose this feature and all of the resources attached
  129127. */
  129128. dispose(): void;
  129129. /**
  129130. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  129131. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  129132. *
  129133. * @returns whether or not the feature is compatible in this environment
  129134. */
  129135. isCompatible(): boolean;
  129136. /**
  129137. * This is used to register callbacks that will automatically be removed when detach is called.
  129138. * @param observable the observable to which the observer will be attached
  129139. * @param callback the callback to register
  129140. */
  129141. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  129142. /**
  129143. * Code in this function will be executed on each xrFrame received from the browser.
  129144. * This function will not execute after the feature is detached.
  129145. * @param _xrFrame the current frame
  129146. */
  129147. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  129148. }
  129149. }
  129150. declare module BABYLON {
  129151. /**
  129152. * Renders a layer on top of an existing scene
  129153. */
  129154. export class UtilityLayerRenderer implements IDisposable {
  129155. /** the original scene that will be rendered on top of */
  129156. originalScene: Scene;
  129157. private _pointerCaptures;
  129158. private _lastPointerEvents;
  129159. private static _DefaultUtilityLayer;
  129160. private static _DefaultKeepDepthUtilityLayer;
  129161. private _sharedGizmoLight;
  129162. private _renderCamera;
  129163. /**
  129164. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  129165. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  129166. * @returns the camera that is used when rendering the utility layer
  129167. */
  129168. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  129169. /**
  129170. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  129171. * @param cam the camera that should be used when rendering the utility layer
  129172. */
  129173. setRenderCamera(cam: Nullable<Camera>): void;
  129174. /**
  129175. * @hidden
  129176. * Light which used by gizmos to get light shading
  129177. */
  129178. _getSharedGizmoLight(): HemisphericLight;
  129179. /**
  129180. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  129181. */
  129182. pickUtilitySceneFirst: boolean;
  129183. /**
  129184. * 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)
  129185. */
  129186. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  129187. /**
  129188. * 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)
  129189. */
  129190. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  129191. /**
  129192. * The scene that is rendered on top of the original scene
  129193. */
  129194. utilityLayerScene: Scene;
  129195. /**
  129196. * If the utility layer should automatically be rendered on top of existing scene
  129197. */
  129198. shouldRender: boolean;
  129199. /**
  129200. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  129201. */
  129202. onlyCheckPointerDownEvents: boolean;
  129203. /**
  129204. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  129205. */
  129206. processAllEvents: boolean;
  129207. /**
  129208. * Observable raised when the pointer move from the utility layer scene to the main scene
  129209. */
  129210. onPointerOutObservable: Observable<number>;
  129211. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  129212. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  129213. private _afterRenderObserver;
  129214. private _sceneDisposeObserver;
  129215. private _originalPointerObserver;
  129216. /**
  129217. * Instantiates a UtilityLayerRenderer
  129218. * @param originalScene the original scene that will be rendered on top of
  129219. * @param handleEvents boolean indicating if the utility layer should handle events
  129220. */
  129221. constructor(
  129222. /** the original scene that will be rendered on top of */
  129223. originalScene: Scene, handleEvents?: boolean);
  129224. private _notifyObservers;
  129225. /**
  129226. * Renders the utility layers scene on top of the original scene
  129227. */
  129228. render(): void;
  129229. /**
  129230. * Disposes of the renderer
  129231. */
  129232. dispose(): void;
  129233. private _updateCamera;
  129234. }
  129235. }
  129236. declare module BABYLON {
  129237. /**
  129238. * Options interface for the pointer selection module
  129239. */
  129240. export interface IWebXRControllerPointerSelectionOptions {
  129241. /**
  129242. * if provided, this scene will be used to render meshes.
  129243. */
  129244. customUtilityLayerScene?: Scene;
  129245. /**
  129246. * 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)
  129247. * If not disabled, the last picked point will be used to execute a pointer up event
  129248. * If disabled, pointer up event will be triggered right after the pointer down event.
  129249. * Used in screen and gaze target ray mode only
  129250. */
  129251. disablePointerUpOnTouchOut: boolean;
  129252. /**
  129253. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  129254. */
  129255. forceGazeMode: boolean;
  129256. /**
  129257. * 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
  129258. * to start a new countdown to the pointer down event.
  129259. * Defaults to 1.
  129260. */
  129261. gazeModePointerMovedFactor?: number;
  129262. /**
  129263. * Different button type to use instead of the main component
  129264. */
  129265. overrideButtonId?: string;
  129266. /**
  129267. * use this rendering group id for the meshes (optional)
  129268. */
  129269. renderingGroupId?: number;
  129270. /**
  129271. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  129272. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  129273. * 3000 means 3 seconds between pointing at something and selecting it
  129274. */
  129275. timeToSelect?: number;
  129276. /**
  129277. * Should meshes created here be added to a utility layer or the main scene
  129278. */
  129279. useUtilityLayer?: boolean;
  129280. /**
  129281. * Optional WebXR camera to be used for gaze selection
  129282. */
  129283. gazeCamera?: WebXRCamera;
  129284. /**
  129285. * the xr input to use with this pointer selection
  129286. */
  129287. xrInput: WebXRInput;
  129288. }
  129289. /**
  129290. * A module that will enable pointer selection for motion controllers of XR Input Sources
  129291. */
  129292. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  129293. private readonly _options;
  129294. private static _idCounter;
  129295. private _attachController;
  129296. private _controllers;
  129297. private _scene;
  129298. private _tmpVectorForPickCompare;
  129299. /**
  129300. * The module's name
  129301. */
  129302. static readonly Name: string;
  129303. /**
  129304. * The (Babylon) version of this module.
  129305. * This is an integer representing the implementation version.
  129306. * This number does not correspond to the WebXR specs version
  129307. */
  129308. static readonly Version: number;
  129309. /**
  129310. * Disable lighting on the laser pointer (so it will always be visible)
  129311. */
  129312. disablePointerLighting: boolean;
  129313. /**
  129314. * Disable lighting on the selection mesh (so it will always be visible)
  129315. */
  129316. disableSelectionMeshLighting: boolean;
  129317. /**
  129318. * Should the laser pointer be displayed
  129319. */
  129320. displayLaserPointer: boolean;
  129321. /**
  129322. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  129323. */
  129324. displaySelectionMesh: boolean;
  129325. /**
  129326. * This color will be set to the laser pointer when selection is triggered
  129327. */
  129328. laserPointerPickedColor: Color3;
  129329. /**
  129330. * Default color of the laser pointer
  129331. */
  129332. laserPointerDefaultColor: Color3;
  129333. /**
  129334. * default color of the selection ring
  129335. */
  129336. selectionMeshDefaultColor: Color3;
  129337. /**
  129338. * This color will be applied to the selection ring when selection is triggered
  129339. */
  129340. selectionMeshPickedColor: Color3;
  129341. /**
  129342. * Optional filter to be used for ray selection. This predicate shares behavior with
  129343. * scene.pointerMovePredicate which takes priority if it is also assigned.
  129344. */
  129345. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  129346. /**
  129347. * constructs a new background remover module
  129348. * @param _xrSessionManager the session manager for this module
  129349. * @param _options read-only options to be used in this module
  129350. */
  129351. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  129352. /**
  129353. * attach this feature
  129354. * Will usually be called by the features manager
  129355. *
  129356. * @returns true if successful.
  129357. */
  129358. attach(): boolean;
  129359. /**
  129360. * detach this feature.
  129361. * Will usually be called by the features manager
  129362. *
  129363. * @returns true if successful.
  129364. */
  129365. detach(): boolean;
  129366. /**
  129367. * Will get the mesh under a specific pointer.
  129368. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  129369. * @param controllerId the controllerId to check
  129370. * @returns The mesh under pointer or null if no mesh is under the pointer
  129371. */
  129372. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  129373. /**
  129374. * Get the xr controller that correlates to the pointer id in the pointer event
  129375. *
  129376. * @param id the pointer id to search for
  129377. * @returns the controller that correlates to this id or null if not found
  129378. */
  129379. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  129380. protected _onXRFrame(_xrFrame: XRFrame): void;
  129381. private _attachGazeMode;
  129382. private _attachScreenRayMode;
  129383. private _attachTrackedPointerRayMode;
  129384. private _convertNormalToDirectionOfRay;
  129385. private _detachController;
  129386. private _generateNewMeshPair;
  129387. private _pickingMoved;
  129388. private _updatePointerDistance;
  129389. /** @hidden */
  129390. get lasterPointerDefaultColor(): Color3;
  129391. }
  129392. }
  129393. declare module BABYLON {
  129394. /**
  129395. * Button which can be used to enter a different mode of XR
  129396. */
  129397. export class WebXREnterExitUIButton {
  129398. /** button element */
  129399. element: HTMLElement;
  129400. /** XR initialization options for the button */
  129401. sessionMode: XRSessionMode;
  129402. /** Reference space type */
  129403. referenceSpaceType: XRReferenceSpaceType;
  129404. /**
  129405. * Creates a WebXREnterExitUIButton
  129406. * @param element button element
  129407. * @param sessionMode XR initialization session mode
  129408. * @param referenceSpaceType the type of reference space to be used
  129409. */
  129410. constructor(
  129411. /** button element */
  129412. element: HTMLElement,
  129413. /** XR initialization options for the button */
  129414. sessionMode: XRSessionMode,
  129415. /** Reference space type */
  129416. referenceSpaceType: XRReferenceSpaceType);
  129417. /**
  129418. * Extendable function which can be used to update the button's visuals when the state changes
  129419. * @param activeButton the current active button in the UI
  129420. */
  129421. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  129422. }
  129423. /**
  129424. * Options to create the webXR UI
  129425. */
  129426. export class WebXREnterExitUIOptions {
  129427. /**
  129428. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  129429. */
  129430. customButtons?: Array<WebXREnterExitUIButton>;
  129431. /**
  129432. * A reference space type to use when creating the default button.
  129433. * Default is local-floor
  129434. */
  129435. referenceSpaceType?: XRReferenceSpaceType;
  129436. /**
  129437. * Context to enter xr with
  129438. */
  129439. renderTarget?: Nullable<WebXRRenderTarget>;
  129440. /**
  129441. * A session mode to use when creating the default button.
  129442. * Default is immersive-vr
  129443. */
  129444. sessionMode?: XRSessionMode;
  129445. /**
  129446. * A list of optional features to init the session with
  129447. */
  129448. optionalFeatures?: string[];
  129449. /**
  129450. * A list of optional features to init the session with
  129451. */
  129452. requiredFeatures?: string[];
  129453. }
  129454. /**
  129455. * UI to allow the user to enter/exit XR mode
  129456. */
  129457. export class WebXREnterExitUI implements IDisposable {
  129458. private scene;
  129459. /** version of the options passed to this UI */
  129460. options: WebXREnterExitUIOptions;
  129461. private _activeButton;
  129462. private _buttons;
  129463. /**
  129464. * The HTML Div Element to which buttons are added.
  129465. */
  129466. readonly overlay: HTMLDivElement;
  129467. /**
  129468. * Fired every time the active button is changed.
  129469. *
  129470. * When xr is entered via a button that launches xr that button will be the callback parameter
  129471. *
  129472. * When exiting xr the callback parameter will be null)
  129473. */
  129474. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  129475. /**
  129476. *
  129477. * @param scene babylon scene object to use
  129478. * @param options (read-only) version of the options passed to this UI
  129479. */
  129480. private constructor();
  129481. /**
  129482. * Creates UI to allow the user to enter/exit XR mode
  129483. * @param scene the scene to add the ui to
  129484. * @param helper the xr experience helper to enter/exit xr with
  129485. * @param options options to configure the UI
  129486. * @returns the created ui
  129487. */
  129488. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  129489. /**
  129490. * Disposes of the XR UI component
  129491. */
  129492. dispose(): void;
  129493. private _updateButtons;
  129494. }
  129495. }
  129496. declare module BABYLON {
  129497. /**
  129498. * Class containing static functions to help procedurally build meshes
  129499. */
  129500. export class LinesBuilder {
  129501. /**
  129502. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  129503. * * 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
  129504. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  129505. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  129506. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  129507. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  129508. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  129509. * * 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
  129510. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  129511. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  129512. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  129513. * @param name defines the name of the new line system
  129514. * @param options defines the options used to create the line system
  129515. * @param scene defines the hosting scene
  129516. * @returns a new line system mesh
  129517. */
  129518. static CreateLineSystem(name: string, options: {
  129519. lines: Vector3[][];
  129520. updatable?: boolean;
  129521. instance?: Nullable<LinesMesh>;
  129522. colors?: Nullable<Color4[][]>;
  129523. useVertexAlpha?: boolean;
  129524. }, scene: Nullable<Scene>): LinesMesh;
  129525. /**
  129526. * Creates a line mesh
  129527. * 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
  129528. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  129529. * * The parameter `points` is an array successive Vector3
  129530. * * 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
  129531. * * The optional parameter `colors` is an array of successive Color4, one per line point
  129532. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  129533. * * When updating an instance, remember that only point positions can change, not the number of points
  129534. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  129535. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  129536. * @param name defines the name of the new line system
  129537. * @param options defines the options used to create the line system
  129538. * @param scene defines the hosting scene
  129539. * @returns a new line mesh
  129540. */
  129541. static CreateLines(name: string, options: {
  129542. points: Vector3[];
  129543. updatable?: boolean;
  129544. instance?: Nullable<LinesMesh>;
  129545. colors?: Color4[];
  129546. useVertexAlpha?: boolean;
  129547. }, scene?: Nullable<Scene>): LinesMesh;
  129548. /**
  129549. * Creates a dashed line mesh
  129550. * * 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
  129551. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  129552. * * The parameter `points` is an array successive Vector3
  129553. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  129554. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  129555. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  129556. * * 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
  129557. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  129558. * * When updating an instance, remember that only point positions can change, not the number of points
  129559. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  129560. * @param name defines the name of the mesh
  129561. * @param options defines the options used to create the mesh
  129562. * @param scene defines the hosting scene
  129563. * @returns the dashed line mesh
  129564. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  129565. */
  129566. static CreateDashedLines(name: string, options: {
  129567. points: Vector3[];
  129568. dashSize?: number;
  129569. gapSize?: number;
  129570. dashNb?: number;
  129571. updatable?: boolean;
  129572. instance?: LinesMesh;
  129573. useVertexAlpha?: boolean;
  129574. }, scene?: Nullable<Scene>): LinesMesh;
  129575. }
  129576. }
  129577. declare module BABYLON {
  129578. /**
  129579. * Construction options for a timer
  129580. */
  129581. export interface ITimerOptions<T> {
  129582. /**
  129583. * Time-to-end
  129584. */
  129585. timeout: number;
  129586. /**
  129587. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  129588. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  129589. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  129590. */
  129591. contextObservable: Observable<T>;
  129592. /**
  129593. * Optional parameters when adding an observer to the observable
  129594. */
  129595. observableParameters?: {
  129596. mask?: number;
  129597. insertFirst?: boolean;
  129598. scope?: any;
  129599. };
  129600. /**
  129601. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  129602. */
  129603. breakCondition?: (data?: ITimerData<T>) => boolean;
  129604. /**
  129605. * Will be triggered when the time condition has met
  129606. */
  129607. onEnded?: (data: ITimerData<any>) => void;
  129608. /**
  129609. * Will be triggered when the break condition has met (prematurely ended)
  129610. */
  129611. onAborted?: (data: ITimerData<any>) => void;
  129612. /**
  129613. * Optional function to execute on each tick (or count)
  129614. */
  129615. onTick?: (data: ITimerData<any>) => void;
  129616. }
  129617. /**
  129618. * An interface defining the data sent by the timer
  129619. */
  129620. export interface ITimerData<T> {
  129621. /**
  129622. * When did it start
  129623. */
  129624. startTime: number;
  129625. /**
  129626. * Time now
  129627. */
  129628. currentTime: number;
  129629. /**
  129630. * Time passed since started
  129631. */
  129632. deltaTime: number;
  129633. /**
  129634. * How much is completed, in [0.0...1.0].
  129635. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  129636. */
  129637. completeRate: number;
  129638. /**
  129639. * What the registered observable sent in the last count
  129640. */
  129641. payload: T;
  129642. }
  129643. /**
  129644. * The current state of the timer
  129645. */
  129646. export enum TimerState {
  129647. /**
  129648. * Timer initialized, not yet started
  129649. */
  129650. INIT = 0,
  129651. /**
  129652. * Timer started and counting
  129653. */
  129654. STARTED = 1,
  129655. /**
  129656. * Timer ended (whether aborted or time reached)
  129657. */
  129658. ENDED = 2
  129659. }
  129660. /**
  129661. * A simple version of the timer. Will take options and start the timer immediately after calling it
  129662. *
  129663. * @param options options with which to initialize this timer
  129664. */
  129665. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  129666. /**
  129667. * An advanced implementation of a timer class
  129668. */
  129669. export class AdvancedTimer<T = any> implements IDisposable {
  129670. /**
  129671. * Will notify each time the timer calculates the remaining time
  129672. */
  129673. onEachCountObservable: Observable<ITimerData<T>>;
  129674. /**
  129675. * Will trigger when the timer was aborted due to the break condition
  129676. */
  129677. onTimerAbortedObservable: Observable<ITimerData<T>>;
  129678. /**
  129679. * Will trigger when the timer ended successfully
  129680. */
  129681. onTimerEndedObservable: Observable<ITimerData<T>>;
  129682. /**
  129683. * Will trigger when the timer state has changed
  129684. */
  129685. onStateChangedObservable: Observable<TimerState>;
  129686. private _observer;
  129687. private _contextObservable;
  129688. private _observableParameters;
  129689. private _startTime;
  129690. private _timer;
  129691. private _state;
  129692. private _breakCondition;
  129693. private _timeToEnd;
  129694. private _breakOnNextTick;
  129695. /**
  129696. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  129697. * @param options construction options for this advanced timer
  129698. */
  129699. constructor(options: ITimerOptions<T>);
  129700. /**
  129701. * set a breaking condition for this timer. Default is to never break during count
  129702. * @param predicate the new break condition. Returns true to break, false otherwise
  129703. */
  129704. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  129705. /**
  129706. * Reset ALL associated observables in this advanced timer
  129707. */
  129708. clearObservables(): void;
  129709. /**
  129710. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  129711. *
  129712. * @param timeToEnd how much time to measure until timer ended
  129713. */
  129714. start(timeToEnd?: number): void;
  129715. /**
  129716. * Will force a stop on the next tick.
  129717. */
  129718. stop(): void;
  129719. /**
  129720. * Dispose this timer, clearing all resources
  129721. */
  129722. dispose(): void;
  129723. private _setState;
  129724. private _tick;
  129725. private _stop;
  129726. }
  129727. }
  129728. declare module BABYLON {
  129729. /**
  129730. * The options container for the teleportation module
  129731. */
  129732. export interface IWebXRTeleportationOptions {
  129733. /**
  129734. * if provided, this scene will be used to render meshes.
  129735. */
  129736. customUtilityLayerScene?: Scene;
  129737. /**
  129738. * Values to configure the default target mesh
  129739. */
  129740. defaultTargetMeshOptions?: {
  129741. /**
  129742. * Fill color of the teleportation area
  129743. */
  129744. teleportationFillColor?: string;
  129745. /**
  129746. * Border color for the teleportation area
  129747. */
  129748. teleportationBorderColor?: string;
  129749. /**
  129750. * Disable the mesh's animation sequence
  129751. */
  129752. disableAnimation?: boolean;
  129753. /**
  129754. * Disable lighting on the material or the ring and arrow
  129755. */
  129756. disableLighting?: boolean;
  129757. /**
  129758. * Override the default material of the torus and arrow
  129759. */
  129760. torusArrowMaterial?: Material;
  129761. };
  129762. /**
  129763. * A list of meshes to use as floor meshes.
  129764. * Meshes can be added and removed after initializing the feature using the
  129765. * addFloorMesh and removeFloorMesh functions
  129766. * If empty, rotation will still work
  129767. */
  129768. floorMeshes?: AbstractMesh[];
  129769. /**
  129770. * use this rendering group id for the meshes (optional)
  129771. */
  129772. renderingGroupId?: number;
  129773. /**
  129774. * Should teleportation move only to snap points
  129775. */
  129776. snapPointsOnly?: boolean;
  129777. /**
  129778. * An array of points to which the teleportation will snap to.
  129779. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  129780. */
  129781. snapPositions?: Vector3[];
  129782. /**
  129783. * How close should the teleportation ray be in order to snap to position.
  129784. * Default to 0.8 units (meters)
  129785. */
  129786. snapToPositionRadius?: number;
  129787. /**
  129788. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  129789. * If you want to support rotation, make sure your mesh has a direction indicator.
  129790. *
  129791. * When left untouched, the default mesh will be initialized.
  129792. */
  129793. teleportationTargetMesh?: AbstractMesh;
  129794. /**
  129795. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  129796. */
  129797. timeToTeleport?: number;
  129798. /**
  129799. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  129800. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  129801. */
  129802. useMainComponentOnly?: boolean;
  129803. /**
  129804. * Should meshes created here be added to a utility layer or the main scene
  129805. */
  129806. useUtilityLayer?: boolean;
  129807. /**
  129808. * Babylon XR Input class for controller
  129809. */
  129810. xrInput: WebXRInput;
  129811. /**
  129812. * Meshes that the teleportation ray cannot go through
  129813. */
  129814. pickBlockerMeshes?: AbstractMesh[];
  129815. }
  129816. /**
  129817. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  129818. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  129819. * the input of the attached controllers.
  129820. */
  129821. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  129822. private _options;
  129823. private _controllers;
  129824. private _currentTeleportationControllerId;
  129825. private _floorMeshes;
  129826. private _quadraticBezierCurve;
  129827. private _selectionFeature;
  129828. private _snapToPositions;
  129829. private _snappedToPoint;
  129830. private _teleportationRingMaterial?;
  129831. private _tmpRay;
  129832. private _tmpVector;
  129833. private _tmpQuaternion;
  129834. /**
  129835. * The module's name
  129836. */
  129837. static readonly Name: string;
  129838. /**
  129839. * The (Babylon) version of this module.
  129840. * This is an integer representing the implementation version.
  129841. * This number does not correspond to the webxr specs version
  129842. */
  129843. static readonly Version: number;
  129844. /**
  129845. * Is movement backwards enabled
  129846. */
  129847. backwardsMovementEnabled: boolean;
  129848. /**
  129849. * Distance to travel when moving backwards
  129850. */
  129851. backwardsTeleportationDistance: number;
  129852. /**
  129853. * The distance from the user to the inspection point in the direction of the controller
  129854. * A higher number will allow the user to move further
  129855. * defaults to 5 (meters, in xr units)
  129856. */
  129857. parabolicCheckRadius: number;
  129858. /**
  129859. * Should the module support parabolic ray on top of direct ray
  129860. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  129861. * Very helpful when moving between floors / different heights
  129862. */
  129863. parabolicRayEnabled: boolean;
  129864. /**
  129865. * How much rotation should be applied when rotating right and left
  129866. */
  129867. rotationAngle: number;
  129868. /**
  129869. * Is rotation enabled when moving forward?
  129870. * Disabling this feature will prevent the user from deciding the direction when teleporting
  129871. */
  129872. rotationEnabled: boolean;
  129873. /**
  129874. * constructs a new anchor system
  129875. * @param _xrSessionManager an instance of WebXRSessionManager
  129876. * @param _options configuration object for this feature
  129877. */
  129878. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  129879. /**
  129880. * Get the snapPointsOnly flag
  129881. */
  129882. get snapPointsOnly(): boolean;
  129883. /**
  129884. * Sets the snapPointsOnly flag
  129885. * @param snapToPoints should teleportation be exclusively to snap points
  129886. */
  129887. set snapPointsOnly(snapToPoints: boolean);
  129888. /**
  129889. * Add a new mesh to the floor meshes array
  129890. * @param mesh the mesh to use as floor mesh
  129891. */
  129892. addFloorMesh(mesh: AbstractMesh): void;
  129893. /**
  129894. * Add a new snap-to point to fix teleportation to this position
  129895. * @param newSnapPoint The new Snap-To point
  129896. */
  129897. addSnapPoint(newSnapPoint: Vector3): void;
  129898. attach(): boolean;
  129899. detach(): boolean;
  129900. dispose(): void;
  129901. /**
  129902. * Remove a mesh from the floor meshes array
  129903. * @param mesh the mesh to remove
  129904. */
  129905. removeFloorMesh(mesh: AbstractMesh): void;
  129906. /**
  129907. * Remove a mesh from the floor meshes array using its name
  129908. * @param name the mesh name to remove
  129909. */
  129910. removeFloorMeshByName(name: string): void;
  129911. /**
  129912. * 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
  129913. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  129914. * @returns was the point found and removed or not
  129915. */
  129916. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  129917. /**
  129918. * This function sets a selection feature that will be disabled when
  129919. * the forward ray is shown and will be reattached when hidden.
  129920. * This is used to remove the selection rays when moving.
  129921. * @param selectionFeature the feature to disable when forward movement is enabled
  129922. */
  129923. setSelectionFeature(selectionFeature: Nullable<IWebXRFeature>): void;
  129924. protected _onXRFrame(_xrFrame: XRFrame): void;
  129925. private _attachController;
  129926. private _createDefaultTargetMesh;
  129927. private _detachController;
  129928. private _findClosestSnapPointWithRadius;
  129929. private _setTargetMeshPosition;
  129930. private _setTargetMeshVisibility;
  129931. private _showParabolicPath;
  129932. private _teleportForward;
  129933. }
  129934. }
  129935. declare module BABYLON {
  129936. /**
  129937. * Options for the default xr helper
  129938. */
  129939. export class WebXRDefaultExperienceOptions {
  129940. /**
  129941. * Enable or disable default UI to enter XR
  129942. */
  129943. disableDefaultUI?: boolean;
  129944. /**
  129945. * Should teleportation not initialize. defaults to false.
  129946. */
  129947. disableTeleportation?: boolean;
  129948. /**
  129949. * Floor meshes that will be used for teleport
  129950. */
  129951. floorMeshes?: Array<AbstractMesh>;
  129952. /**
  129953. * If set to true, the first frame will not be used to reset position
  129954. * The first frame is mainly used when copying transformation from the old camera
  129955. * Mainly used in AR
  129956. */
  129957. ignoreNativeCameraTransformation?: boolean;
  129958. /**
  129959. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  129960. */
  129961. inputOptions?: IWebXRInputOptions;
  129962. /**
  129963. * optional configuration for the output canvas
  129964. */
  129965. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  129966. /**
  129967. * optional UI options. This can be used among other to change session mode and reference space type
  129968. */
  129969. uiOptions?: WebXREnterExitUIOptions;
  129970. /**
  129971. * When loading teleportation and pointer select, use stable versions instead of latest.
  129972. */
  129973. useStablePlugins?: boolean;
  129974. /**
  129975. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  129976. */
  129977. renderingGroupId?: number;
  129978. /**
  129979. * A list of optional features to init the session with
  129980. * If set to true, all features we support will be added
  129981. */
  129982. optionalFeatures?: boolean | string[];
  129983. }
  129984. /**
  129985. * Default experience which provides a similar setup to the previous webVRExperience
  129986. */
  129987. export class WebXRDefaultExperience {
  129988. /**
  129989. * Base experience
  129990. */
  129991. baseExperience: WebXRExperienceHelper;
  129992. /**
  129993. * Enables ui for entering/exiting xr
  129994. */
  129995. enterExitUI: WebXREnterExitUI;
  129996. /**
  129997. * Input experience extension
  129998. */
  129999. input: WebXRInput;
  130000. /**
  130001. * Enables laser pointer and selection
  130002. */
  130003. pointerSelection: WebXRControllerPointerSelection;
  130004. /**
  130005. * Default target xr should render to
  130006. */
  130007. renderTarget: WebXRRenderTarget;
  130008. /**
  130009. * Enables teleportation
  130010. */
  130011. teleportation: WebXRMotionControllerTeleportation;
  130012. private constructor();
  130013. /**
  130014. * Creates the default xr experience
  130015. * @param scene scene
  130016. * @param options options for basic configuration
  130017. * @returns resulting WebXRDefaultExperience
  130018. */
  130019. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  130020. /**
  130021. * DIsposes of the experience helper
  130022. */
  130023. dispose(): void;
  130024. }
  130025. }
  130026. declare module BABYLON {
  130027. /**
  130028. * Options to modify the vr teleportation behavior.
  130029. */
  130030. export interface VRTeleportationOptions {
  130031. /**
  130032. * The name of the mesh which should be used as the teleportation floor. (default: null)
  130033. */
  130034. floorMeshName?: string;
  130035. /**
  130036. * A list of meshes to be used as the teleportation floor. (default: empty)
  130037. */
  130038. floorMeshes?: Mesh[];
  130039. /**
  130040. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  130041. */
  130042. teleportationMode?: number;
  130043. /**
  130044. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  130045. */
  130046. teleportationTime?: number;
  130047. /**
  130048. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  130049. */
  130050. teleportationSpeed?: number;
  130051. /**
  130052. * The easing function used in the animation or null for Linear. (default CircleEase)
  130053. */
  130054. easingFunction?: EasingFunction;
  130055. }
  130056. /**
  130057. * Options to modify the vr experience helper's behavior.
  130058. */
  130059. export interface VRExperienceHelperOptions extends WebVROptions {
  130060. /**
  130061. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  130062. */
  130063. createDeviceOrientationCamera?: boolean;
  130064. /**
  130065. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  130066. */
  130067. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  130068. /**
  130069. * Uses the main button on the controller to toggle the laser casted. (default: true)
  130070. */
  130071. laserToggle?: boolean;
  130072. /**
  130073. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  130074. */
  130075. floorMeshes?: Mesh[];
  130076. /**
  130077. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  130078. */
  130079. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  130080. /**
  130081. * Defines if WebXR should be used instead of WebVR (if available)
  130082. */
  130083. useXR?: boolean;
  130084. }
  130085. /**
  130086. * Event containing information after VR has been entered
  130087. */
  130088. export class OnAfterEnteringVRObservableEvent {
  130089. /**
  130090. * If entering vr was successful
  130091. */
  130092. success: boolean;
  130093. }
  130094. /**
  130095. * Helps to quickly add VR support to an existing scene.
  130096. * See https://doc.babylonjs.com/how_to/webvr_helper
  130097. */
  130098. export class VRExperienceHelper {
  130099. /** Options to modify the vr experience helper's behavior. */
  130100. webVROptions: VRExperienceHelperOptions;
  130101. private _scene;
  130102. private _position;
  130103. private _btnVR;
  130104. private _btnVRDisplayed;
  130105. private _webVRsupported;
  130106. private _webVRready;
  130107. private _webVRrequesting;
  130108. private _webVRpresenting;
  130109. private _hasEnteredVR;
  130110. private _fullscreenVRpresenting;
  130111. private _inputElement;
  130112. private _webVRCamera;
  130113. private _vrDeviceOrientationCamera;
  130114. private _deviceOrientationCamera;
  130115. private _existingCamera;
  130116. private _onKeyDown;
  130117. private _onVrDisplayPresentChange;
  130118. private _onVRDisplayChanged;
  130119. private _onVRRequestPresentStart;
  130120. private _onVRRequestPresentComplete;
  130121. /**
  130122. * 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)
  130123. */
  130124. enableGazeEvenWhenNoPointerLock: boolean;
  130125. /**
  130126. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  130127. */
  130128. exitVROnDoubleTap: boolean;
  130129. /**
  130130. * Observable raised right before entering VR.
  130131. */
  130132. onEnteringVRObservable: Observable<VRExperienceHelper>;
  130133. /**
  130134. * Observable raised when entering VR has completed.
  130135. */
  130136. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  130137. /**
  130138. * Observable raised when exiting VR.
  130139. */
  130140. onExitingVRObservable: Observable<VRExperienceHelper>;
  130141. /**
  130142. * Observable raised when controller mesh is loaded.
  130143. */
  130144. onControllerMeshLoadedObservable: Observable<WebVRController>;
  130145. /** Return this.onEnteringVRObservable
  130146. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  130147. */
  130148. get onEnteringVR(): Observable<VRExperienceHelper>;
  130149. /** Return this.onExitingVRObservable
  130150. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  130151. */
  130152. get onExitingVR(): Observable<VRExperienceHelper>;
  130153. /** Return this.onControllerMeshLoadedObservable
  130154. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  130155. */
  130156. get onControllerMeshLoaded(): Observable<WebVRController>;
  130157. private _rayLength;
  130158. private _useCustomVRButton;
  130159. private _teleportationRequested;
  130160. private _teleportActive;
  130161. private _floorMeshName;
  130162. private _floorMeshesCollection;
  130163. private _teleportationMode;
  130164. private _teleportationTime;
  130165. private _teleportationSpeed;
  130166. private _teleportationEasing;
  130167. private _rotationAllowed;
  130168. private _teleportBackwardsVector;
  130169. private _teleportationTarget;
  130170. private _isDefaultTeleportationTarget;
  130171. private _postProcessMove;
  130172. private _teleportationFillColor;
  130173. private _teleportationBorderColor;
  130174. private _rotationAngle;
  130175. private _haloCenter;
  130176. private _cameraGazer;
  130177. private _padSensibilityUp;
  130178. private _padSensibilityDown;
  130179. private _leftController;
  130180. private _rightController;
  130181. private _gazeColor;
  130182. private _laserColor;
  130183. private _pickedLaserColor;
  130184. private _pickedGazeColor;
  130185. /**
  130186. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  130187. */
  130188. onNewMeshSelected: Observable<AbstractMesh>;
  130189. /**
  130190. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  130191. * This observable will provide the mesh and the controller used to select the mesh
  130192. */
  130193. onMeshSelectedWithController: Observable<{
  130194. mesh: AbstractMesh;
  130195. controller: WebVRController;
  130196. }>;
  130197. /**
  130198. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  130199. */
  130200. onNewMeshPicked: Observable<PickingInfo>;
  130201. private _circleEase;
  130202. /**
  130203. * Observable raised before camera teleportation
  130204. */
  130205. onBeforeCameraTeleport: Observable<Vector3>;
  130206. /**
  130207. * Observable raised after camera teleportation
  130208. */
  130209. onAfterCameraTeleport: Observable<Vector3>;
  130210. /**
  130211. * Observable raised when current selected mesh gets unselected
  130212. */
  130213. onSelectedMeshUnselected: Observable<AbstractMesh>;
  130214. private _raySelectionPredicate;
  130215. /**
  130216. * To be optionaly changed by user to define custom ray selection
  130217. */
  130218. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  130219. /**
  130220. * To be optionaly changed by user to define custom selection logic (after ray selection)
  130221. */
  130222. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  130223. /**
  130224. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  130225. */
  130226. teleportationEnabled: boolean;
  130227. private _defaultHeight;
  130228. private _teleportationInitialized;
  130229. private _interactionsEnabled;
  130230. private _interactionsRequested;
  130231. private _displayGaze;
  130232. private _displayLaserPointer;
  130233. /**
  130234. * The mesh used to display where the user is going to teleport.
  130235. */
  130236. get teleportationTarget(): Mesh;
  130237. /**
  130238. * Sets the mesh to be used to display where the user is going to teleport.
  130239. */
  130240. set teleportationTarget(value: Mesh);
  130241. /**
  130242. * 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
  130243. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  130244. * See https://doc.babylonjs.com/resources/baking_transformations
  130245. */
  130246. get gazeTrackerMesh(): Mesh;
  130247. set gazeTrackerMesh(value: Mesh);
  130248. /**
  130249. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  130250. */
  130251. updateGazeTrackerScale: boolean;
  130252. /**
  130253. * If the gaze trackers color should be updated when selecting meshes
  130254. */
  130255. updateGazeTrackerColor: boolean;
  130256. /**
  130257. * If the controller laser color should be updated when selecting meshes
  130258. */
  130259. updateControllerLaserColor: boolean;
  130260. /**
  130261. * The gaze tracking mesh corresponding to the left controller
  130262. */
  130263. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  130264. /**
  130265. * The gaze tracking mesh corresponding to the right controller
  130266. */
  130267. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  130268. /**
  130269. * If the ray of the gaze should be displayed.
  130270. */
  130271. get displayGaze(): boolean;
  130272. /**
  130273. * Sets if the ray of the gaze should be displayed.
  130274. */
  130275. set displayGaze(value: boolean);
  130276. /**
  130277. * If the ray of the LaserPointer should be displayed.
  130278. */
  130279. get displayLaserPointer(): boolean;
  130280. /**
  130281. * Sets if the ray of the LaserPointer should be displayed.
  130282. */
  130283. set displayLaserPointer(value: boolean);
  130284. /**
  130285. * The deviceOrientationCamera used as the camera when not in VR.
  130286. */
  130287. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  130288. /**
  130289. * Based on the current WebVR support, returns the current VR camera used.
  130290. */
  130291. get currentVRCamera(): Nullable<Camera>;
  130292. /**
  130293. * The webVRCamera which is used when in VR.
  130294. */
  130295. get webVRCamera(): WebVRFreeCamera;
  130296. /**
  130297. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  130298. */
  130299. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  130300. /**
  130301. * The html button that is used to trigger entering into VR.
  130302. */
  130303. get vrButton(): Nullable<HTMLButtonElement>;
  130304. private get _teleportationRequestInitiated();
  130305. /**
  130306. * Defines whether or not Pointer lock should be requested when switching to
  130307. * full screen.
  130308. */
  130309. requestPointerLockOnFullScreen: boolean;
  130310. /**
  130311. * If asking to force XR, this will be populated with the default xr experience
  130312. */
  130313. xr: WebXRDefaultExperience;
  130314. /**
  130315. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  130316. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  130317. */
  130318. xrTestDone: boolean;
  130319. /**
  130320. * Instantiates a VRExperienceHelper.
  130321. * Helps to quickly add VR support to an existing scene.
  130322. * @param scene The scene the VRExperienceHelper belongs to.
  130323. * @param webVROptions Options to modify the vr experience helper's behavior.
  130324. */
  130325. constructor(scene: Scene,
  130326. /** Options to modify the vr experience helper's behavior. */
  130327. webVROptions?: VRExperienceHelperOptions);
  130328. private completeVRInit;
  130329. private _onDefaultMeshLoaded;
  130330. private _onResize;
  130331. private _onFullscreenChange;
  130332. /**
  130333. * Gets a value indicating if we are currently in VR mode.
  130334. */
  130335. get isInVRMode(): boolean;
  130336. private onVrDisplayPresentChange;
  130337. private onVRDisplayChanged;
  130338. private moveButtonToBottomRight;
  130339. private displayVRButton;
  130340. private updateButtonVisibility;
  130341. private _cachedAngularSensibility;
  130342. /**
  130343. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  130344. * Otherwise, will use the fullscreen API.
  130345. */
  130346. enterVR(): void;
  130347. /**
  130348. * Attempt to exit VR, or fullscreen.
  130349. */
  130350. exitVR(): void;
  130351. /**
  130352. * The position of the vr experience helper.
  130353. */
  130354. get position(): Vector3;
  130355. /**
  130356. * Sets the position of the vr experience helper.
  130357. */
  130358. set position(value: Vector3);
  130359. /**
  130360. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  130361. */
  130362. enableInteractions(): void;
  130363. private get _noControllerIsActive();
  130364. private beforeRender;
  130365. private _isTeleportationFloor;
  130366. /**
  130367. * Adds a floor mesh to be used for teleportation.
  130368. * @param floorMesh the mesh to be used for teleportation.
  130369. */
  130370. addFloorMesh(floorMesh: Mesh): void;
  130371. /**
  130372. * Removes a floor mesh from being used for teleportation.
  130373. * @param floorMesh the mesh to be removed.
  130374. */
  130375. removeFloorMesh(floorMesh: Mesh): void;
  130376. /**
  130377. * Enables interactions and teleportation using the VR controllers and gaze.
  130378. * @param vrTeleportationOptions options to modify teleportation behavior.
  130379. */
  130380. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  130381. private _onNewGamepadConnected;
  130382. private _tryEnableInteractionOnController;
  130383. private _onNewGamepadDisconnected;
  130384. private _enableInteractionOnController;
  130385. private _checkTeleportWithRay;
  130386. private _checkRotate;
  130387. private _checkTeleportBackwards;
  130388. private _enableTeleportationOnController;
  130389. private _createTeleportationCircles;
  130390. private _displayTeleportationTarget;
  130391. private _hideTeleportationTarget;
  130392. private _rotateCamera;
  130393. private _moveTeleportationSelectorTo;
  130394. private _workingVector;
  130395. private _workingQuaternion;
  130396. private _workingMatrix;
  130397. /**
  130398. * Time Constant Teleportation Mode
  130399. */
  130400. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  130401. /**
  130402. * Speed Constant Teleportation Mode
  130403. */
  130404. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  130405. /**
  130406. * Teleports the users feet to the desired location
  130407. * @param location The location where the user's feet should be placed
  130408. */
  130409. teleportCamera(location: Vector3): void;
  130410. private _convertNormalToDirectionOfRay;
  130411. private _castRayAndSelectObject;
  130412. private _notifySelectedMeshUnselected;
  130413. /**
  130414. * Permanently set new colors for the laser pointer
  130415. * @param color the new laser color
  130416. * @param pickedColor the new laser color when picked mesh detected
  130417. */
  130418. setLaserColor(color: Color3, pickedColor?: Color3): void;
  130419. /**
  130420. * Set lighting enabled / disabled on the laser pointer of both controllers
  130421. * @param enabled should the lighting be enabled on the laser pointer
  130422. */
  130423. setLaserLightingState(enabled?: boolean): void;
  130424. /**
  130425. * Permanently set new colors for the gaze pointer
  130426. * @param color the new gaze color
  130427. * @param pickedColor the new gaze color when picked mesh detected
  130428. */
  130429. setGazeColor(color: Color3, pickedColor?: Color3): void;
  130430. /**
  130431. * Sets the color of the laser ray from the vr controllers.
  130432. * @param color new color for the ray.
  130433. */
  130434. changeLaserColor(color: Color3): void;
  130435. /**
  130436. * Sets the color of the ray from the vr headsets gaze.
  130437. * @param color new color for the ray.
  130438. */
  130439. changeGazeColor(color: Color3): void;
  130440. /**
  130441. * Exits VR and disposes of the vr experience helper
  130442. */
  130443. dispose(): void;
  130444. /**
  130445. * Gets the name of the VRExperienceHelper class
  130446. * @returns "VRExperienceHelper"
  130447. */
  130448. getClassName(): string;
  130449. }
  130450. }
  130451. declare module BABYLON {
  130452. /**
  130453. * Contains an array of blocks representing the octree
  130454. */
  130455. export interface IOctreeContainer<T> {
  130456. /**
  130457. * Blocks within the octree
  130458. */
  130459. blocks: Array<OctreeBlock<T>>;
  130460. }
  130461. /**
  130462. * Class used to store a cell in an octree
  130463. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  130464. */
  130465. export class OctreeBlock<T> {
  130466. /**
  130467. * Gets the content of the current block
  130468. */
  130469. entries: T[];
  130470. /**
  130471. * Gets the list of block children
  130472. */
  130473. blocks: Array<OctreeBlock<T>>;
  130474. private _depth;
  130475. private _maxDepth;
  130476. private _capacity;
  130477. private _minPoint;
  130478. private _maxPoint;
  130479. private _boundingVectors;
  130480. private _creationFunc;
  130481. /**
  130482. * Creates a new block
  130483. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  130484. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  130485. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  130486. * @param depth defines the current depth of this block in the octree
  130487. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  130488. * @param creationFunc defines a callback to call when an element is added to the block
  130489. */
  130490. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  130491. /**
  130492. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  130493. */
  130494. get capacity(): number;
  130495. /**
  130496. * Gets the minimum vector (in world space) of the block's bounding box
  130497. */
  130498. get minPoint(): Vector3;
  130499. /**
  130500. * Gets the maximum vector (in world space) of the block's bounding box
  130501. */
  130502. get maxPoint(): Vector3;
  130503. /**
  130504. * Add a new element to this block
  130505. * @param entry defines the element to add
  130506. */
  130507. addEntry(entry: T): void;
  130508. /**
  130509. * Remove an element from this block
  130510. * @param entry defines the element to remove
  130511. */
  130512. removeEntry(entry: T): void;
  130513. /**
  130514. * Add an array of elements to this block
  130515. * @param entries defines the array of elements to add
  130516. */
  130517. addEntries(entries: T[]): void;
  130518. /**
  130519. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  130520. * @param frustumPlanes defines the frustum planes to test
  130521. * @param selection defines the array to store current content if selection is positive
  130522. * @param allowDuplicate defines if the selection array can contains duplicated entries
  130523. */
  130524. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  130525. /**
  130526. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  130527. * @param sphereCenter defines the bounding sphere center
  130528. * @param sphereRadius defines the bounding sphere radius
  130529. * @param selection defines the array to store current content if selection is positive
  130530. * @param allowDuplicate defines if the selection array can contains duplicated entries
  130531. */
  130532. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  130533. /**
  130534. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  130535. * @param ray defines the ray to test with
  130536. * @param selection defines the array to store current content if selection is positive
  130537. */
  130538. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  130539. /**
  130540. * Subdivide the content into child blocks (this block will then be empty)
  130541. */
  130542. createInnerBlocks(): void;
  130543. /**
  130544. * @hidden
  130545. */
  130546. 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;
  130547. }
  130548. }
  130549. declare module BABYLON {
  130550. /**
  130551. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  130552. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  130553. */
  130554. export class Octree<T> {
  130555. /** 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.) */
  130556. maxDepth: number;
  130557. /**
  130558. * Blocks within the octree containing objects
  130559. */
  130560. blocks: Array<OctreeBlock<T>>;
  130561. /**
  130562. * Content stored in the octree
  130563. */
  130564. dynamicContent: T[];
  130565. private _maxBlockCapacity;
  130566. private _selectionContent;
  130567. private _creationFunc;
  130568. /**
  130569. * Creates a octree
  130570. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  130571. * @param creationFunc function to be used to instatiate the octree
  130572. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  130573. * @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.)
  130574. */
  130575. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  130576. /** 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.) */
  130577. maxDepth?: number);
  130578. /**
  130579. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  130580. * @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);
  130581. * @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);
  130582. * @param entries meshes to be added to the octree blocks
  130583. */
  130584. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  130585. /**
  130586. * Adds a mesh to the octree
  130587. * @param entry Mesh to add to the octree
  130588. */
  130589. addMesh(entry: T): void;
  130590. /**
  130591. * Remove an element from the octree
  130592. * @param entry defines the element to remove
  130593. */
  130594. removeMesh(entry: T): void;
  130595. /**
  130596. * Selects an array of meshes within the frustum
  130597. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  130598. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  130599. * @returns array of meshes within the frustum
  130600. */
  130601. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  130602. /**
  130603. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  130604. * @param sphereCenter defines the bounding sphere center
  130605. * @param sphereRadius defines the bounding sphere radius
  130606. * @param allowDuplicate defines if the selection array can contains duplicated entries
  130607. * @returns an array of objects that intersect the sphere
  130608. */
  130609. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  130610. /**
  130611. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  130612. * @param ray defines the ray to test with
  130613. * @returns array of intersected objects
  130614. */
  130615. intersectsRay(ray: Ray): SmartArray<T>;
  130616. /**
  130617. * Adds a mesh into the octree block if it intersects the block
  130618. */
  130619. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  130620. /**
  130621. * Adds a submesh into the octree block if it intersects the block
  130622. */
  130623. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  130624. }
  130625. }
  130626. declare module BABYLON {
  130627. interface Scene {
  130628. /**
  130629. * @hidden
  130630. * Backing Filed
  130631. */
  130632. _selectionOctree: Octree<AbstractMesh>;
  130633. /**
  130634. * Gets the octree used to boost mesh selection (picking)
  130635. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  130636. */
  130637. selectionOctree: Octree<AbstractMesh>;
  130638. /**
  130639. * Creates or updates the octree used to boost selection (picking)
  130640. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  130641. * @param maxCapacity defines the maximum capacity per leaf
  130642. * @param maxDepth defines the maximum depth of the octree
  130643. * @returns an octree of AbstractMesh
  130644. */
  130645. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  130646. }
  130647. interface AbstractMesh {
  130648. /**
  130649. * @hidden
  130650. * Backing Field
  130651. */
  130652. _submeshesOctree: Octree<SubMesh>;
  130653. /**
  130654. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  130655. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  130656. * @param maxCapacity defines the maximum size of each block (64 by default)
  130657. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  130658. * @returns the new octree
  130659. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  130660. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  130661. */
  130662. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  130663. }
  130664. /**
  130665. * Defines the octree scene component responsible to manage any octrees
  130666. * in a given scene.
  130667. */
  130668. export class OctreeSceneComponent {
  130669. /**
  130670. * The component name help to identify the component in the list of scene components.
  130671. */
  130672. readonly name: string;
  130673. /**
  130674. * The scene the component belongs to.
  130675. */
  130676. scene: Scene;
  130677. /**
  130678. * Indicates if the meshes have been checked to make sure they are isEnabled()
  130679. */
  130680. readonly checksIsEnabled: boolean;
  130681. /**
  130682. * Creates a new instance of the component for the given scene
  130683. * @param scene Defines the scene to register the component in
  130684. */
  130685. constructor(scene: Scene);
  130686. /**
  130687. * Registers the component in a given scene
  130688. */
  130689. register(): void;
  130690. /**
  130691. * Return the list of active meshes
  130692. * @returns the list of active meshes
  130693. */
  130694. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  130695. /**
  130696. * Return the list of active sub meshes
  130697. * @param mesh The mesh to get the candidates sub meshes from
  130698. * @returns the list of active sub meshes
  130699. */
  130700. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  130701. private _tempRay;
  130702. /**
  130703. * Return the list of sub meshes intersecting with a given local ray
  130704. * @param mesh defines the mesh to find the submesh for
  130705. * @param localRay defines the ray in local space
  130706. * @returns the list of intersecting sub meshes
  130707. */
  130708. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  130709. /**
  130710. * Return the list of sub meshes colliding with a collider
  130711. * @param mesh defines the mesh to find the submesh for
  130712. * @param collider defines the collider to evaluate the collision against
  130713. * @returns the list of colliding sub meshes
  130714. */
  130715. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  130716. /**
  130717. * Rebuilds the elements related to this component in case of
  130718. * context lost for instance.
  130719. */
  130720. rebuild(): void;
  130721. /**
  130722. * Disposes the component and the associated ressources.
  130723. */
  130724. dispose(): void;
  130725. }
  130726. }
  130727. declare module BABYLON {
  130728. /**
  130729. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  130730. */
  130731. export class Gizmo implements IDisposable {
  130732. /** The utility layer the gizmo will be added to */
  130733. gizmoLayer: UtilityLayerRenderer;
  130734. /**
  130735. * The root mesh of the gizmo
  130736. */
  130737. _rootMesh: Mesh;
  130738. private _attachedMesh;
  130739. private _attachedNode;
  130740. /**
  130741. * Ratio for the scale of the gizmo (Default: 1)
  130742. */
  130743. protected _scaleRatio: number;
  130744. /**
  130745. * boolean updated by pointermove when a gizmo mesh is hovered
  130746. */
  130747. protected _isHovered: boolean;
  130748. /**
  130749. * Ratio for the scale of the gizmo (Default: 1)
  130750. */
  130751. set scaleRatio(value: number);
  130752. get scaleRatio(): number;
  130753. /**
  130754. * True when the mouse pointer is hovered a gizmo mesh
  130755. */
  130756. get isHovered(): boolean;
  130757. /**
  130758. * If a custom mesh has been set (Default: false)
  130759. */
  130760. protected _customMeshSet: boolean;
  130761. /**
  130762. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  130763. * * When set, interactions will be enabled
  130764. */
  130765. get attachedMesh(): Nullable<AbstractMesh>;
  130766. set attachedMesh(value: Nullable<AbstractMesh>);
  130767. /**
  130768. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  130769. * * When set, interactions will be enabled
  130770. */
  130771. get attachedNode(): Nullable<Node>;
  130772. set attachedNode(value: Nullable<Node>);
  130773. /**
  130774. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  130775. * @param mesh The mesh to replace the default mesh of the gizmo
  130776. */
  130777. setCustomMesh(mesh: Mesh): void;
  130778. protected _updateGizmoRotationToMatchAttachedMesh: boolean;
  130779. /**
  130780. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  130781. */
  130782. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  130783. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  130784. /**
  130785. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  130786. */
  130787. updateGizmoPositionToMatchAttachedMesh: boolean;
  130788. /**
  130789. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  130790. */
  130791. updateScale: boolean;
  130792. protected _interactionsEnabled: boolean;
  130793. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130794. private _beforeRenderObserver;
  130795. private _tempQuaternion;
  130796. private _tempVector;
  130797. private _tempVector2;
  130798. private _tempMatrix1;
  130799. private _tempMatrix2;
  130800. private _rightHandtoLeftHandMatrix;
  130801. /**
  130802. * Creates a gizmo
  130803. * @param gizmoLayer The utility layer the gizmo will be added to
  130804. */
  130805. constructor(
  130806. /** The utility layer the gizmo will be added to */
  130807. gizmoLayer?: UtilityLayerRenderer);
  130808. /**
  130809. * Updates the gizmo to match the attached mesh's position/rotation
  130810. */
  130811. protected _update(): void;
  130812. /**
  130813. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  130814. * @param value Node, TransformNode or mesh
  130815. */
  130816. protected _matrixChanged(): void;
  130817. /**
  130818. * Disposes of the gizmo
  130819. */
  130820. dispose(): void;
  130821. }
  130822. }
  130823. declare module BABYLON {
  130824. /**
  130825. * Single plane drag gizmo
  130826. */
  130827. export class PlaneDragGizmo extends Gizmo {
  130828. /**
  130829. * Drag behavior responsible for the gizmos dragging interactions
  130830. */
  130831. dragBehavior: PointerDragBehavior;
  130832. private _pointerObserver;
  130833. /**
  130834. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130835. */
  130836. snapDistance: number;
  130837. /**
  130838. * Event that fires each time the gizmo snaps to a new location.
  130839. * * snapDistance is the the change in distance
  130840. */
  130841. onSnapObservable: Observable<{
  130842. snapDistance: number;
  130843. }>;
  130844. private _plane;
  130845. private _coloredMaterial;
  130846. private _hoverMaterial;
  130847. private _isEnabled;
  130848. private _parent;
  130849. /** @hidden */
  130850. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  130851. /** @hidden */
  130852. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  130853. /**
  130854. * Creates a PlaneDragGizmo
  130855. * @param gizmoLayer The utility layer the gizmo will be added to
  130856. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  130857. * @param color The color of the gizmo
  130858. */
  130859. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  130860. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130861. /**
  130862. * If the gizmo is enabled
  130863. */
  130864. set isEnabled(value: boolean);
  130865. get isEnabled(): boolean;
  130866. /**
  130867. * Disposes of the gizmo
  130868. */
  130869. dispose(): void;
  130870. }
  130871. }
  130872. declare module BABYLON {
  130873. /**
  130874. * Gizmo that enables dragging a mesh along 3 axis
  130875. */
  130876. export class PositionGizmo extends Gizmo {
  130877. /**
  130878. * Internal gizmo used for interactions on the x axis
  130879. */
  130880. xGizmo: AxisDragGizmo;
  130881. /**
  130882. * Internal gizmo used for interactions on the y axis
  130883. */
  130884. yGizmo: AxisDragGizmo;
  130885. /**
  130886. * Internal gizmo used for interactions on the z axis
  130887. */
  130888. zGizmo: AxisDragGizmo;
  130889. /**
  130890. * Internal gizmo used for interactions on the yz plane
  130891. */
  130892. xPlaneGizmo: PlaneDragGizmo;
  130893. /**
  130894. * Internal gizmo used for interactions on the xz plane
  130895. */
  130896. yPlaneGizmo: PlaneDragGizmo;
  130897. /**
  130898. * Internal gizmo used for interactions on the xy plane
  130899. */
  130900. zPlaneGizmo: PlaneDragGizmo;
  130901. /**
  130902. * private variables
  130903. */
  130904. private _meshAttached;
  130905. private _nodeAttached;
  130906. private _snapDistance;
  130907. /** Fires an event when any of it's sub gizmos are dragged */
  130908. onDragStartObservable: Observable<unknown>;
  130909. /** Fires an event when any of it's sub gizmos are released from dragging */
  130910. onDragEndObservable: Observable<unknown>;
  130911. /**
  130912. * If set to true, planar drag is enabled
  130913. */
  130914. private _planarGizmoEnabled;
  130915. get attachedMesh(): Nullable<AbstractMesh>;
  130916. set attachedMesh(mesh: Nullable<AbstractMesh>);
  130917. get attachedNode(): Nullable<Node>;
  130918. set attachedNode(node: Nullable<Node>);
  130919. /**
  130920. * True when the mouse pointer is hovering a gizmo mesh
  130921. */
  130922. get isHovered(): boolean;
  130923. /**
  130924. * Creates a PositionGizmo
  130925. * @param gizmoLayer The utility layer the gizmo will be added to
  130926. @param thickness display gizmo axis thickness
  130927. */
  130928. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  130929. /**
  130930. * If the planar drag gizmo is enabled
  130931. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  130932. */
  130933. set planarGizmoEnabled(value: boolean);
  130934. get planarGizmoEnabled(): boolean;
  130935. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  130936. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  130937. /**
  130938. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130939. */
  130940. set snapDistance(value: number);
  130941. get snapDistance(): number;
  130942. /**
  130943. * Ratio for the scale of the gizmo (Default: 1)
  130944. */
  130945. set scaleRatio(value: number);
  130946. get scaleRatio(): number;
  130947. /**
  130948. * Disposes of the gizmo
  130949. */
  130950. dispose(): void;
  130951. /**
  130952. * CustomMeshes are not supported by this gizmo
  130953. * @param mesh The mesh to replace the default mesh of the gizmo
  130954. */
  130955. setCustomMesh(mesh: Mesh): void;
  130956. }
  130957. }
  130958. declare module BABYLON {
  130959. /**
  130960. * Single axis drag gizmo
  130961. */
  130962. export class AxisDragGizmo extends Gizmo {
  130963. /**
  130964. * Drag behavior responsible for the gizmos dragging interactions
  130965. */
  130966. dragBehavior: PointerDragBehavior;
  130967. private _pointerObserver;
  130968. /**
  130969. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130970. */
  130971. snapDistance: number;
  130972. /**
  130973. * Event that fires each time the gizmo snaps to a new location.
  130974. * * snapDistance is the the change in distance
  130975. */
  130976. onSnapObservable: Observable<{
  130977. snapDistance: number;
  130978. }>;
  130979. private _isEnabled;
  130980. private _parent;
  130981. private _arrow;
  130982. private _coloredMaterial;
  130983. private _hoverMaterial;
  130984. /** @hidden */
  130985. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  130986. /** @hidden */
  130987. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  130988. /**
  130989. * Creates an AxisDragGizmo
  130990. * @param gizmoLayer The utility layer the gizmo will be added to
  130991. * @param dragAxis The axis which the gizmo will be able to drag on
  130992. * @param color The color of the gizmo
  130993. * @param thickness display gizmo axis thickness
  130994. */
  130995. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  130996. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130997. /**
  130998. * If the gizmo is enabled
  130999. */
  131000. set isEnabled(value: boolean);
  131001. get isEnabled(): boolean;
  131002. /**
  131003. * Disposes of the gizmo
  131004. */
  131005. dispose(): void;
  131006. }
  131007. }
  131008. declare module BABYLON.Debug {
  131009. /**
  131010. * The Axes viewer will show 3 axes in a specific point in space
  131011. */
  131012. export class AxesViewer {
  131013. private _xAxis;
  131014. private _yAxis;
  131015. private _zAxis;
  131016. private _scaleLinesFactor;
  131017. private _instanced;
  131018. /**
  131019. * Gets the hosting scene
  131020. */
  131021. scene: Nullable<Scene>;
  131022. /**
  131023. * Gets or sets a number used to scale line length
  131024. */
  131025. scaleLines: number;
  131026. /** Gets the node hierarchy used to render x-axis */
  131027. get xAxis(): TransformNode;
  131028. /** Gets the node hierarchy used to render y-axis */
  131029. get yAxis(): TransformNode;
  131030. /** Gets the node hierarchy used to render z-axis */
  131031. get zAxis(): TransformNode;
  131032. /**
  131033. * Creates a new AxesViewer
  131034. * @param scene defines the hosting scene
  131035. * @param scaleLines defines a number used to scale line length (1 by default)
  131036. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  131037. * @param xAxis defines the node hierarchy used to render the x-axis
  131038. * @param yAxis defines the node hierarchy used to render the y-axis
  131039. * @param zAxis defines the node hierarchy used to render the z-axis
  131040. */
  131041. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  131042. /**
  131043. * Force the viewer to update
  131044. * @param position defines the position of the viewer
  131045. * @param xaxis defines the x axis of the viewer
  131046. * @param yaxis defines the y axis of the viewer
  131047. * @param zaxis defines the z axis of the viewer
  131048. */
  131049. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  131050. /**
  131051. * Creates an instance of this axes viewer.
  131052. * @returns a new axes viewer with instanced meshes
  131053. */
  131054. createInstance(): AxesViewer;
  131055. /** Releases resources */
  131056. dispose(): void;
  131057. private static _SetRenderingGroupId;
  131058. }
  131059. }
  131060. declare module BABYLON.Debug {
  131061. /**
  131062. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  131063. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  131064. */
  131065. export class BoneAxesViewer extends AxesViewer {
  131066. /**
  131067. * Gets or sets the target mesh where to display the axes viewer
  131068. */
  131069. mesh: Nullable<Mesh>;
  131070. /**
  131071. * Gets or sets the target bone where to display the axes viewer
  131072. */
  131073. bone: Nullable<Bone>;
  131074. /** Gets current position */
  131075. pos: Vector3;
  131076. /** Gets direction of X axis */
  131077. xaxis: Vector3;
  131078. /** Gets direction of Y axis */
  131079. yaxis: Vector3;
  131080. /** Gets direction of Z axis */
  131081. zaxis: Vector3;
  131082. /**
  131083. * Creates a new BoneAxesViewer
  131084. * @param scene defines the hosting scene
  131085. * @param bone defines the target bone
  131086. * @param mesh defines the target mesh
  131087. * @param scaleLines defines a scaling factor for line length (1 by default)
  131088. */
  131089. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  131090. /**
  131091. * Force the viewer to update
  131092. */
  131093. update(): void;
  131094. /** Releases resources */
  131095. dispose(): void;
  131096. }
  131097. }
  131098. declare module BABYLON {
  131099. /**
  131100. * Interface used to define scene explorer extensibility option
  131101. */
  131102. export interface IExplorerExtensibilityOption {
  131103. /**
  131104. * Define the option label
  131105. */
  131106. label: string;
  131107. /**
  131108. * Defines the action to execute on click
  131109. */
  131110. action: (entity: any) => void;
  131111. }
  131112. /**
  131113. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  131114. */
  131115. export interface IExplorerExtensibilityGroup {
  131116. /**
  131117. * Defines a predicate to test if a given type mut be extended
  131118. */
  131119. predicate: (entity: any) => boolean;
  131120. /**
  131121. * Gets the list of options added to a type
  131122. */
  131123. entries: IExplorerExtensibilityOption[];
  131124. }
  131125. /**
  131126. * Interface used to define the options to use to create the Inspector
  131127. */
  131128. export interface IInspectorOptions {
  131129. /**
  131130. * Display in overlay mode (default: false)
  131131. */
  131132. overlay?: boolean;
  131133. /**
  131134. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  131135. */
  131136. globalRoot?: HTMLElement;
  131137. /**
  131138. * Display the Scene explorer
  131139. */
  131140. showExplorer?: boolean;
  131141. /**
  131142. * Display the property inspector
  131143. */
  131144. showInspector?: boolean;
  131145. /**
  131146. * Display in embed mode (both panes on the right)
  131147. */
  131148. embedMode?: boolean;
  131149. /**
  131150. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  131151. */
  131152. handleResize?: boolean;
  131153. /**
  131154. * Allow the panes to popup (default: true)
  131155. */
  131156. enablePopup?: boolean;
  131157. /**
  131158. * Allow the panes to be closed by users (default: true)
  131159. */
  131160. enableClose?: boolean;
  131161. /**
  131162. * Optional list of extensibility entries
  131163. */
  131164. explorerExtensibility?: IExplorerExtensibilityGroup[];
  131165. /**
  131166. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  131167. */
  131168. inspectorURL?: string;
  131169. /**
  131170. * Optional initial tab (default to DebugLayerTab.Properties)
  131171. */
  131172. initialTab?: DebugLayerTab;
  131173. }
  131174. interface Scene {
  131175. /**
  131176. * @hidden
  131177. * Backing field
  131178. */
  131179. _debugLayer: DebugLayer;
  131180. /**
  131181. * Gets the debug layer (aka Inspector) associated with the scene
  131182. * @see https://doc.babylonjs.com/features/playground_debuglayer
  131183. */
  131184. debugLayer: DebugLayer;
  131185. }
  131186. /**
  131187. * Enum of inspector action tab
  131188. */
  131189. export enum DebugLayerTab {
  131190. /**
  131191. * Properties tag (default)
  131192. */
  131193. Properties = 0,
  131194. /**
  131195. * Debug tab
  131196. */
  131197. Debug = 1,
  131198. /**
  131199. * Statistics tab
  131200. */
  131201. Statistics = 2,
  131202. /**
  131203. * Tools tab
  131204. */
  131205. Tools = 3,
  131206. /**
  131207. * Settings tab
  131208. */
  131209. Settings = 4
  131210. }
  131211. /**
  131212. * The debug layer (aka Inspector) is the go to tool in order to better understand
  131213. * what is happening in your scene
  131214. * @see https://doc.babylonjs.com/features/playground_debuglayer
  131215. */
  131216. export class DebugLayer {
  131217. /**
  131218. * Define the url to get the inspector script from.
  131219. * By default it uses the babylonjs CDN.
  131220. * @ignoreNaming
  131221. */
  131222. static InspectorURL: string;
  131223. private _scene;
  131224. private BJSINSPECTOR;
  131225. private _onPropertyChangedObservable?;
  131226. /**
  131227. * Observable triggered when a property is changed through the inspector.
  131228. */
  131229. get onPropertyChangedObservable(): any;
  131230. /**
  131231. * Instantiates a new debug layer.
  131232. * The debug layer (aka Inspector) is the go to tool in order to better understand
  131233. * what is happening in your scene
  131234. * @see https://doc.babylonjs.com/features/playground_debuglayer
  131235. * @param scene Defines the scene to inspect
  131236. */
  131237. constructor(scene: Scene);
  131238. /** Creates the inspector window. */
  131239. private _createInspector;
  131240. /**
  131241. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  131242. * @param entity defines the entity to select
  131243. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  131244. */
  131245. select(entity: any, lineContainerTitles?: string | string[]): void;
  131246. /** Get the inspector from bundle or global */
  131247. private _getGlobalInspector;
  131248. /**
  131249. * Get if the inspector is visible or not.
  131250. * @returns true if visible otherwise, false
  131251. */
  131252. isVisible(): boolean;
  131253. /**
  131254. * Hide the inspector and close its window.
  131255. */
  131256. hide(): void;
  131257. /**
  131258. * Update the scene in the inspector
  131259. */
  131260. setAsActiveScene(): void;
  131261. /**
  131262. * Launch the debugLayer.
  131263. * @param config Define the configuration of the inspector
  131264. * @return a promise fulfilled when the debug layer is visible
  131265. */
  131266. show(config?: IInspectorOptions): Promise<DebugLayer>;
  131267. }
  131268. }
  131269. declare module BABYLON {
  131270. /**
  131271. * Class containing static functions to help procedurally build meshes
  131272. */
  131273. export class BoxBuilder {
  131274. /**
  131275. * Creates a box mesh
  131276. * * The parameter `size` sets the size (float) of each box side (default 1)
  131277. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  131278. * * 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)
  131279. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  131280. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  131281. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  131282. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  131283. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  131284. * @param name defines the name of the mesh
  131285. * @param options defines the options used to create the mesh
  131286. * @param scene defines the hosting scene
  131287. * @returns the box mesh
  131288. */
  131289. static CreateBox(name: string, options: {
  131290. size?: number;
  131291. width?: number;
  131292. height?: number;
  131293. depth?: number;
  131294. faceUV?: Vector4[];
  131295. faceColors?: Color4[];
  131296. sideOrientation?: number;
  131297. frontUVs?: Vector4;
  131298. backUVs?: Vector4;
  131299. wrap?: boolean;
  131300. topBaseAt?: number;
  131301. bottomBaseAt?: number;
  131302. updatable?: boolean;
  131303. }, scene?: Nullable<Scene>): Mesh;
  131304. }
  131305. }
  131306. declare module BABYLON.Debug {
  131307. /**
  131308. * Used to show the physics impostor around the specific mesh
  131309. */
  131310. export class PhysicsViewer {
  131311. /** @hidden */
  131312. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  131313. /** @hidden */
  131314. protected _meshes: Array<Nullable<AbstractMesh>>;
  131315. /** @hidden */
  131316. protected _scene: Nullable<Scene>;
  131317. /** @hidden */
  131318. protected _numMeshes: number;
  131319. /** @hidden */
  131320. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  131321. private _renderFunction;
  131322. private _utilityLayer;
  131323. private _debugBoxMesh;
  131324. private _debugSphereMesh;
  131325. private _debugCylinderMesh;
  131326. private _debugMaterial;
  131327. private _debugMeshMeshes;
  131328. /**
  131329. * Creates a new PhysicsViewer
  131330. * @param scene defines the hosting scene
  131331. */
  131332. constructor(scene: Scene);
  131333. /** @hidden */
  131334. protected _updateDebugMeshes(): void;
  131335. /**
  131336. * Renders a specified physic impostor
  131337. * @param impostor defines the impostor to render
  131338. * @param targetMesh defines the mesh represented by the impostor
  131339. * @returns the new debug mesh used to render the impostor
  131340. */
  131341. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  131342. /**
  131343. * Hides a specified physic impostor
  131344. * @param impostor defines the impostor to hide
  131345. */
  131346. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  131347. private _getDebugMaterial;
  131348. private _getDebugBoxMesh;
  131349. private _getDebugSphereMesh;
  131350. private _getDebugCylinderMesh;
  131351. private _getDebugMeshMesh;
  131352. private _getDebugMesh;
  131353. /** Releases all resources */
  131354. dispose(): void;
  131355. }
  131356. }
  131357. declare module BABYLON {
  131358. /**
  131359. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  131360. * in order to better appreciate the issue one might have.
  131361. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  131362. */
  131363. export class RayHelper {
  131364. /**
  131365. * Defines the ray we are currently tryin to visualize.
  131366. */
  131367. ray: Nullable<Ray>;
  131368. private _renderPoints;
  131369. private _renderLine;
  131370. private _renderFunction;
  131371. private _scene;
  131372. private _onAfterRenderObserver;
  131373. private _onAfterStepObserver;
  131374. private _attachedToMesh;
  131375. private _meshSpaceDirection;
  131376. private _meshSpaceOrigin;
  131377. /**
  131378. * Helper function to create a colored helper in a scene in one line.
  131379. * @param ray Defines the ray we are currently tryin to visualize
  131380. * @param scene Defines the scene the ray is used in
  131381. * @param color Defines the color we want to see the ray in
  131382. * @returns The newly created ray helper.
  131383. */
  131384. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  131385. /**
  131386. * Instantiate a new ray helper.
  131387. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  131388. * in order to better appreciate the issue one might have.
  131389. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  131390. * @param ray Defines the ray we are currently tryin to visualize
  131391. */
  131392. constructor(ray: Ray);
  131393. /**
  131394. * Shows the ray we are willing to debug.
  131395. * @param scene Defines the scene the ray needs to be rendered in
  131396. * @param color Defines the color the ray needs to be rendered in
  131397. */
  131398. show(scene: Scene, color?: Color3): void;
  131399. /**
  131400. * Hides the ray we are debugging.
  131401. */
  131402. hide(): void;
  131403. private _render;
  131404. /**
  131405. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  131406. * @param mesh Defines the mesh we want the helper attached to
  131407. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  131408. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  131409. * @param length Defines the length of the ray
  131410. */
  131411. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  131412. /**
  131413. * Detach the ray helper from the mesh it has previously been attached to.
  131414. */
  131415. detachFromMesh(): void;
  131416. private _updateToMesh;
  131417. /**
  131418. * Dispose the helper and release its associated resources.
  131419. */
  131420. dispose(): void;
  131421. }
  131422. }
  131423. declare module BABYLON {
  131424. /**
  131425. * Defines the options associated with the creation of a SkeletonViewer.
  131426. */
  131427. export interface ISkeletonViewerOptions {
  131428. /** Should the system pause animations before building the Viewer? */
  131429. pauseAnimations: boolean;
  131430. /** Should the system return the skeleton to rest before building? */
  131431. returnToRest: boolean;
  131432. /** public Display Mode of the Viewer */
  131433. displayMode: number;
  131434. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  131435. displayOptions: ISkeletonViewerDisplayOptions;
  131436. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  131437. computeBonesUsingShaders: boolean;
  131438. /** Flag ignore non weighted bones */
  131439. useAllBones: boolean;
  131440. }
  131441. /**
  131442. * Defines how to display the various bone meshes for the viewer.
  131443. */
  131444. export interface ISkeletonViewerDisplayOptions {
  131445. /** How far down to start tapering the bone spurs */
  131446. midStep?: number;
  131447. /** How big is the midStep? */
  131448. midStepFactor?: number;
  131449. /** Base for the Sphere Size */
  131450. sphereBaseSize?: number;
  131451. /** The ratio of the sphere to the longest bone in units */
  131452. sphereScaleUnit?: number;
  131453. /** Ratio for the Sphere Size */
  131454. sphereFactor?: number;
  131455. /** Whether to show local axes or not */
  131456. showLocalAxes?: boolean;
  131457. /** Length of each local axis */
  131458. localAxesSize?: number;
  131459. }
  131460. /**
  131461. * Defines the constructor options for the BoneWeight Shader.
  131462. */
  131463. export interface IBoneWeightShaderOptions {
  131464. /** Skeleton to Map */
  131465. skeleton: Skeleton;
  131466. /** Colors for Uninfluenced bones */
  131467. colorBase?: Color3;
  131468. /** Colors for 0.0-0.25 Weight bones */
  131469. colorZero?: Color3;
  131470. /** Color for 0.25-0.5 Weight Influence */
  131471. colorQuarter?: Color3;
  131472. /** Color for 0.5-0.75 Weight Influence */
  131473. colorHalf?: Color3;
  131474. /** Color for 0.75-1 Weight Influence */
  131475. colorFull?: Color3;
  131476. /** Color for Zero Weight Influence */
  131477. targetBoneIndex?: number;
  131478. }
  131479. /**
  131480. * Simple structure of the gradient steps for the Color Map.
  131481. */
  131482. export interface ISkeletonMapShaderColorMapKnot {
  131483. /** Color of the Knot */
  131484. color: Color3;
  131485. /** Location of the Knot */
  131486. location: number;
  131487. }
  131488. /**
  131489. * Defines the constructor options for the SkeletonMap Shader.
  131490. */
  131491. export interface ISkeletonMapShaderOptions {
  131492. /** Skeleton to Map */
  131493. skeleton: Skeleton;
  131494. /** Array of ColorMapKnots that make the gradient must be ordered with knot[i].location < knot[i+1].location*/
  131495. colorMap?: ISkeletonMapShaderColorMapKnot[];
  131496. }
  131497. }
  131498. declare module BABYLON {
  131499. /**
  131500. * Class containing static functions to help procedurally build meshes
  131501. */
  131502. export class RibbonBuilder {
  131503. /**
  131504. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  131505. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  131506. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  131507. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  131508. * * 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
  131509. * * 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
  131510. * * 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
  131511. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  131512. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  131513. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  131514. * * 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
  131515. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  131516. * * 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
  131517. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  131518. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  131519. * @param name defines the name of the mesh
  131520. * @param options defines the options used to create the mesh
  131521. * @param scene defines the hosting scene
  131522. * @returns the ribbon mesh
  131523. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  131524. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  131525. */
  131526. static CreateRibbon(name: string, options: {
  131527. pathArray: Vector3[][];
  131528. closeArray?: boolean;
  131529. closePath?: boolean;
  131530. offset?: number;
  131531. updatable?: boolean;
  131532. sideOrientation?: number;
  131533. frontUVs?: Vector4;
  131534. backUVs?: Vector4;
  131535. instance?: Mesh;
  131536. invertUV?: boolean;
  131537. uvs?: Vector2[];
  131538. colors?: Color4[];
  131539. }, scene?: Nullable<Scene>): Mesh;
  131540. }
  131541. }
  131542. declare module BABYLON {
  131543. /**
  131544. * Class containing static functions to help procedurally build meshes
  131545. */
  131546. export class ShapeBuilder {
  131547. /**
  131548. * 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.
  131549. * * 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.
  131550. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  131551. * * 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.
  131552. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  131553. * * 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
  131554. * * 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
  131555. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  131556. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  131557. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  131558. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  131559. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  131560. * @param name defines the name of the mesh
  131561. * @param options defines the options used to create the mesh
  131562. * @param scene defines the hosting scene
  131563. * @returns the extruded shape mesh
  131564. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  131565. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  131566. */
  131567. static ExtrudeShape(name: string, options: {
  131568. shape: Vector3[];
  131569. path: Vector3[];
  131570. scale?: number;
  131571. rotation?: number;
  131572. cap?: number;
  131573. updatable?: boolean;
  131574. sideOrientation?: number;
  131575. frontUVs?: Vector4;
  131576. backUVs?: Vector4;
  131577. instance?: Mesh;
  131578. invertUV?: boolean;
  131579. }, scene?: Nullable<Scene>): Mesh;
  131580. /**
  131581. * Creates an custom extruded shape mesh.
  131582. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  131583. * * 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.
  131584. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  131585. * * 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
  131586. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  131587. * * 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
  131588. * * It must returns a float value that will be the scale value applied to the shape on each path point
  131589. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  131590. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  131591. * * 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
  131592. * * 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
  131593. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  131594. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  131595. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  131596. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  131597. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  131598. * @param name defines the name of the mesh
  131599. * @param options defines the options used to create the mesh
  131600. * @param scene defines the hosting scene
  131601. * @returns the custom extruded shape mesh
  131602. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  131603. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  131604. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  131605. */
  131606. static ExtrudeShapeCustom(name: string, options: {
  131607. shape: Vector3[];
  131608. path: Vector3[];
  131609. scaleFunction?: any;
  131610. rotationFunction?: any;
  131611. ribbonCloseArray?: boolean;
  131612. ribbonClosePath?: boolean;
  131613. cap?: number;
  131614. updatable?: boolean;
  131615. sideOrientation?: number;
  131616. frontUVs?: Vector4;
  131617. backUVs?: Vector4;
  131618. instance?: Mesh;
  131619. invertUV?: boolean;
  131620. }, scene?: Nullable<Scene>): Mesh;
  131621. private static _ExtrudeShapeGeneric;
  131622. }
  131623. }
  131624. declare module BABYLON.Debug {
  131625. /**
  131626. * Class used to render a debug view of a given skeleton
  131627. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  131628. */
  131629. export class SkeletonViewer {
  131630. /** defines the skeleton to render */
  131631. skeleton: Skeleton;
  131632. /** defines the mesh attached to the skeleton */
  131633. mesh: AbstractMesh;
  131634. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  131635. autoUpdateBonesMatrices: boolean;
  131636. /** defines the rendering group id to use with the viewer */
  131637. renderingGroupId: number;
  131638. /** is the options for the viewer */
  131639. options: Partial<ISkeletonViewerOptions>;
  131640. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  131641. static readonly DISPLAY_LINES: number;
  131642. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  131643. static readonly DISPLAY_SPHERES: number;
  131644. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  131645. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  131646. /** public static method to create a BoneWeight Shader
  131647. * @param options The constructor options
  131648. * @param scene The scene that the shader is scoped to
  131649. * @returns The created ShaderMaterial
  131650. * @see http://www.babylonjs-playground.com/#1BZJVJ#395
  131651. */
  131652. static CreateBoneWeightShader(options: IBoneWeightShaderOptions, scene: Scene): ShaderMaterial;
  131653. /** public static method to create a BoneWeight Shader
  131654. * @param options The constructor options
  131655. * @param scene The scene that the shader is scoped to
  131656. * @returns The created ShaderMaterial
  131657. */
  131658. static CreateSkeletonMapShader(options: ISkeletonMapShaderOptions, scene: Scene): ShaderMaterial;
  131659. /** private static method to create a BoneWeight Shader
  131660. * @param size The size of the buffer to create (usually the bone count)
  131661. * @param colorMap The gradient data to generate
  131662. * @param scene The scene that the shader is scoped to
  131663. * @returns an Array of floats from the color gradient values
  131664. */
  131665. private static _CreateBoneMapColorBuffer;
  131666. /** If SkeletonViewer scene scope. */
  131667. private _scene;
  131668. /** Gets or sets the color used to render the skeleton */
  131669. color: Color3;
  131670. /** Array of the points of the skeleton fo the line view. */
  131671. private _debugLines;
  131672. /** The SkeletonViewers Mesh. */
  131673. private _debugMesh;
  131674. /** The local axes Meshes. */
  131675. private _localAxes;
  131676. /** If SkeletonViewer is enabled. */
  131677. private _isEnabled;
  131678. /** If SkeletonViewer is ready. */
  131679. private _ready;
  131680. /** SkeletonViewer render observable. */
  131681. private _obs;
  131682. /** The Utility Layer to render the gizmos in. */
  131683. private _utilityLayer;
  131684. private _boneIndices;
  131685. /** Gets the Scene. */
  131686. get scene(): Scene;
  131687. /** Gets the utilityLayer. */
  131688. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  131689. /** Checks Ready Status. */
  131690. get isReady(): Boolean;
  131691. /** Sets Ready Status. */
  131692. set ready(value: boolean);
  131693. /** Gets the debugMesh */
  131694. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  131695. /** Sets the debugMesh */
  131696. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  131697. /** Gets the displayMode */
  131698. get displayMode(): number;
  131699. /** Sets the displayMode */
  131700. set displayMode(value: number);
  131701. /**
  131702. * Creates a new SkeletonViewer
  131703. * @param skeleton defines the skeleton to render
  131704. * @param mesh defines the mesh attached to the skeleton
  131705. * @param scene defines the hosting scene
  131706. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  131707. * @param renderingGroupId defines the rendering group id to use with the viewer
  131708. * @param options All of the extra constructor options for the SkeletonViewer
  131709. */
  131710. constructor(
  131711. /** defines the skeleton to render */
  131712. skeleton: Skeleton,
  131713. /** defines the mesh attached to the skeleton */
  131714. mesh: AbstractMesh,
  131715. /** The Scene scope*/
  131716. scene: Scene,
  131717. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  131718. autoUpdateBonesMatrices?: boolean,
  131719. /** defines the rendering group id to use with the viewer */
  131720. renderingGroupId?: number,
  131721. /** is the options for the viewer */
  131722. options?: Partial<ISkeletonViewerOptions>);
  131723. /** The Dynamic bindings for the update functions */
  131724. private _bindObs;
  131725. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  131726. update(): void;
  131727. /** Gets or sets a boolean indicating if the viewer is enabled */
  131728. set isEnabled(value: boolean);
  131729. get isEnabled(): boolean;
  131730. private _getBonePosition;
  131731. private _getLinesForBonesWithLength;
  131732. private _getLinesForBonesNoLength;
  131733. /** function to revert the mesh and scene back to the initial state. */
  131734. private _revert;
  131735. /** function to get the absolute bind pose of a bone by accumulating transformations up the bone hierarchy. */
  131736. private _getAbsoluteBindPoseToRef;
  131737. /** function to build and bind sphere joint points and spur bone representations. */
  131738. private _buildSpheresAndSpurs;
  131739. private _buildLocalAxes;
  131740. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  131741. private _displayLinesUpdate;
  131742. /** Changes the displayMode of the skeleton viewer
  131743. * @param mode The displayMode numerical value
  131744. */
  131745. changeDisplayMode(mode: number): void;
  131746. /** Sets a display option of the skeleton viewer
  131747. *
  131748. * | Option | Type | Default | Description |
  131749. * | --------------- | ------- | ------- | ----------- |
  131750. * | 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`. |
  131751. * | 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`. |
  131752. * | sphereBaseSize | float | 2 | Sphere base size. Only used when `displayMode` is set to `DISPLAY_SPHERE_AND_SPURS`. |
  131753. * | 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`. |
  131754. * | showLocalAxes | boolean | false | Displays local axes on all bones. |
  131755. * | localAxesSize | float | 0.075 | Determines the length of each local axis. |
  131756. *
  131757. * @param option String of the option name
  131758. * @param value The numerical option value
  131759. */
  131760. changeDisplayOptions(option: string, value: number): void;
  131761. /** Release associated resources */
  131762. dispose(): void;
  131763. }
  131764. }
  131765. declare module BABYLON {
  131766. /**
  131767. * Enum for Device Types
  131768. */
  131769. export enum DeviceType {
  131770. /** Generic */
  131771. Generic = 0,
  131772. /** Keyboard */
  131773. Keyboard = 1,
  131774. /** Mouse */
  131775. Mouse = 2,
  131776. /** Touch Pointers */
  131777. Touch = 3,
  131778. /** PS4 Dual Shock */
  131779. DualShock = 4,
  131780. /** Xbox */
  131781. Xbox = 5,
  131782. /** Switch Controller */
  131783. Switch = 6
  131784. }
  131785. /**
  131786. * Enum for All Pointers (Touch/Mouse)
  131787. */
  131788. export enum PointerInput {
  131789. /** Horizontal Axis */
  131790. Horizontal = 0,
  131791. /** Vertical Axis */
  131792. Vertical = 1,
  131793. /** Left Click or Touch */
  131794. LeftClick = 2,
  131795. /** Middle Click */
  131796. MiddleClick = 3,
  131797. /** Right Click */
  131798. RightClick = 4,
  131799. /** Browser Back */
  131800. BrowserBack = 5,
  131801. /** Browser Forward */
  131802. BrowserForward = 6
  131803. }
  131804. /**
  131805. * Enum for Dual Shock Gamepad
  131806. */
  131807. export enum DualShockInput {
  131808. /** Cross */
  131809. Cross = 0,
  131810. /** Circle */
  131811. Circle = 1,
  131812. /** Square */
  131813. Square = 2,
  131814. /** Triangle */
  131815. Triangle = 3,
  131816. /** L1 */
  131817. L1 = 4,
  131818. /** R1 */
  131819. R1 = 5,
  131820. /** L2 */
  131821. L2 = 6,
  131822. /** R2 */
  131823. R2 = 7,
  131824. /** Share */
  131825. Share = 8,
  131826. /** Options */
  131827. Options = 9,
  131828. /** L3 */
  131829. L3 = 10,
  131830. /** R3 */
  131831. R3 = 11,
  131832. /** DPadUp */
  131833. DPadUp = 12,
  131834. /** DPadDown */
  131835. DPadDown = 13,
  131836. /** DPadLeft */
  131837. DPadLeft = 14,
  131838. /** DRight */
  131839. DPadRight = 15,
  131840. /** Home */
  131841. Home = 16,
  131842. /** TouchPad */
  131843. TouchPad = 17,
  131844. /** LStickXAxis */
  131845. LStickXAxis = 18,
  131846. /** LStickYAxis */
  131847. LStickYAxis = 19,
  131848. /** RStickXAxis */
  131849. RStickXAxis = 20,
  131850. /** RStickYAxis */
  131851. RStickYAxis = 21
  131852. }
  131853. /**
  131854. * Enum for Xbox Gamepad
  131855. */
  131856. export enum XboxInput {
  131857. /** A */
  131858. A = 0,
  131859. /** B */
  131860. B = 1,
  131861. /** X */
  131862. X = 2,
  131863. /** Y */
  131864. Y = 3,
  131865. /** LB */
  131866. LB = 4,
  131867. /** RB */
  131868. RB = 5,
  131869. /** LT */
  131870. LT = 6,
  131871. /** RT */
  131872. RT = 7,
  131873. /** Back */
  131874. Back = 8,
  131875. /** Start */
  131876. Start = 9,
  131877. /** LS */
  131878. LS = 10,
  131879. /** RS */
  131880. RS = 11,
  131881. /** DPadUp */
  131882. DPadUp = 12,
  131883. /** DPadDown */
  131884. DPadDown = 13,
  131885. /** DPadLeft */
  131886. DPadLeft = 14,
  131887. /** DRight */
  131888. DPadRight = 15,
  131889. /** Home */
  131890. Home = 16,
  131891. /** LStickXAxis */
  131892. LStickXAxis = 17,
  131893. /** LStickYAxis */
  131894. LStickYAxis = 18,
  131895. /** RStickXAxis */
  131896. RStickXAxis = 19,
  131897. /** RStickYAxis */
  131898. RStickYAxis = 20
  131899. }
  131900. /**
  131901. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  131902. */
  131903. export enum SwitchInput {
  131904. /** B */
  131905. B = 0,
  131906. /** A */
  131907. A = 1,
  131908. /** Y */
  131909. Y = 2,
  131910. /** X */
  131911. X = 3,
  131912. /** L */
  131913. L = 4,
  131914. /** R */
  131915. R = 5,
  131916. /** ZL */
  131917. ZL = 6,
  131918. /** ZR */
  131919. ZR = 7,
  131920. /** Minus */
  131921. Minus = 8,
  131922. /** Plus */
  131923. Plus = 9,
  131924. /** LS */
  131925. LS = 10,
  131926. /** RS */
  131927. RS = 11,
  131928. /** DPadUp */
  131929. DPadUp = 12,
  131930. /** DPadDown */
  131931. DPadDown = 13,
  131932. /** DPadLeft */
  131933. DPadLeft = 14,
  131934. /** DRight */
  131935. DPadRight = 15,
  131936. /** Home */
  131937. Home = 16,
  131938. /** Capture */
  131939. Capture = 17,
  131940. /** LStickXAxis */
  131941. LStickXAxis = 18,
  131942. /** LStickYAxis */
  131943. LStickYAxis = 19,
  131944. /** RStickXAxis */
  131945. RStickXAxis = 20,
  131946. /** RStickYAxis */
  131947. RStickYAxis = 21
  131948. }
  131949. }
  131950. declare module BABYLON {
  131951. /**
  131952. * This class will take all inputs from Keyboard, Pointer, and
  131953. * any Gamepads and provide a polling system that all devices
  131954. * will use. This class assumes that there will only be one
  131955. * pointer device and one keyboard.
  131956. */
  131957. export class DeviceInputSystem implements IDisposable {
  131958. /**
  131959. * Callback to be triggered when a device is connected
  131960. */
  131961. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  131962. /**
  131963. * Callback to be triggered when a device is disconnected
  131964. */
  131965. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  131966. /**
  131967. * Callback to be triggered when event driven input is updated
  131968. */
  131969. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  131970. private _inputs;
  131971. private _gamepads;
  131972. private _keyboardActive;
  131973. private _pointerActive;
  131974. private _elementToAttachTo;
  131975. private _keyboardDownEvent;
  131976. private _keyboardUpEvent;
  131977. private _pointerMoveEvent;
  131978. private _pointerDownEvent;
  131979. private _pointerUpEvent;
  131980. private _gamepadConnectedEvent;
  131981. private _gamepadDisconnectedEvent;
  131982. private static _MAX_KEYCODES;
  131983. private static _MAX_POINTER_INPUTS;
  131984. private constructor();
  131985. /**
  131986. * Creates a new DeviceInputSystem instance
  131987. * @param engine Engine to pull input element from
  131988. * @returns The new instance
  131989. */
  131990. static Create(engine: Engine): DeviceInputSystem;
  131991. /**
  131992. * Checks for current device input value, given an id and input index
  131993. * @param deviceName Id of connected device
  131994. * @param inputIndex Index of device input
  131995. * @returns Current value of input
  131996. */
  131997. /**
  131998. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  131999. * @param deviceType Enum specifiying device type
  132000. * @param deviceSlot "Slot" or index that device is referenced in
  132001. * @param inputIndex Id of input to be checked
  132002. * @returns Current value of input
  132003. */
  132004. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  132005. /**
  132006. * Dispose of all the eventlisteners
  132007. */
  132008. dispose(): void;
  132009. /**
  132010. * Add device and inputs to device array
  132011. * @param deviceType Enum specifiying device type
  132012. * @param deviceSlot "Slot" or index that device is referenced in
  132013. * @param numberOfInputs Number of input entries to create for given device
  132014. */
  132015. private _registerDevice;
  132016. /**
  132017. * Given a specific device name, remove that device from the device map
  132018. * @param deviceType Enum specifiying device type
  132019. * @param deviceSlot "Slot" or index that device is referenced in
  132020. */
  132021. private _unregisterDevice;
  132022. /**
  132023. * Handle all actions that come from keyboard interaction
  132024. */
  132025. private _handleKeyActions;
  132026. /**
  132027. * Handle all actions that come from pointer interaction
  132028. */
  132029. private _handlePointerActions;
  132030. /**
  132031. * Handle all actions that come from gamepad interaction
  132032. */
  132033. private _handleGamepadActions;
  132034. /**
  132035. * Update all non-event based devices with each frame
  132036. * @param deviceType Enum specifiying device type
  132037. * @param deviceSlot "Slot" or index that device is referenced in
  132038. * @param inputIndex Id of input to be checked
  132039. */
  132040. private _updateDevice;
  132041. /**
  132042. * Gets DeviceType from the device name
  132043. * @param deviceName Name of Device from DeviceInputSystem
  132044. * @returns DeviceType enum value
  132045. */
  132046. private _getGamepadDeviceType;
  132047. }
  132048. }
  132049. declare module BABYLON {
  132050. /**
  132051. * Type to handle enforcement of inputs
  132052. */
  132053. 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;
  132054. }
  132055. declare module BABYLON {
  132056. /**
  132057. * Class that handles all input for a specific device
  132058. */
  132059. export class DeviceSource<T extends DeviceType> {
  132060. /** Type of device */
  132061. readonly deviceType: DeviceType;
  132062. /** "Slot" or index that device is referenced in */
  132063. readonly deviceSlot: number;
  132064. /**
  132065. * Observable to handle device input changes per device
  132066. */
  132067. readonly onInputChangedObservable: Observable<{
  132068. inputIndex: DeviceInput<T>;
  132069. previousState: Nullable<number>;
  132070. currentState: Nullable<number>;
  132071. }>;
  132072. private readonly _deviceInputSystem;
  132073. /**
  132074. * Default Constructor
  132075. * @param deviceInputSystem Reference to DeviceInputSystem
  132076. * @param deviceType Type of device
  132077. * @param deviceSlot "Slot" or index that device is referenced in
  132078. */
  132079. constructor(deviceInputSystem: DeviceInputSystem,
  132080. /** Type of device */
  132081. deviceType: DeviceType,
  132082. /** "Slot" or index that device is referenced in */
  132083. deviceSlot?: number);
  132084. /**
  132085. * Get input for specific input
  132086. * @param inputIndex index of specific input on device
  132087. * @returns Input value from DeviceInputSystem
  132088. */
  132089. getInput(inputIndex: DeviceInput<T>): number;
  132090. }
  132091. /**
  132092. * Class to keep track of devices
  132093. */
  132094. export class DeviceSourceManager implements IDisposable {
  132095. /**
  132096. * Observable to be triggered when before a device is connected
  132097. */
  132098. readonly onBeforeDeviceConnectedObservable: Observable<{
  132099. deviceType: DeviceType;
  132100. deviceSlot: number;
  132101. }>;
  132102. /**
  132103. * Observable to be triggered when before a device is disconnected
  132104. */
  132105. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  132106. deviceType: DeviceType;
  132107. deviceSlot: number;
  132108. }>;
  132109. /**
  132110. * Observable to be triggered when after a device is connected
  132111. */
  132112. readonly onAfterDeviceConnectedObservable: Observable<{
  132113. deviceType: DeviceType;
  132114. deviceSlot: number;
  132115. }>;
  132116. /**
  132117. * Observable to be triggered when after a device is disconnected
  132118. */
  132119. readonly onAfterDeviceDisconnectedObservable: Observable<{
  132120. deviceType: DeviceType;
  132121. deviceSlot: number;
  132122. }>;
  132123. private readonly _devices;
  132124. private readonly _firstDevice;
  132125. private readonly _deviceInputSystem;
  132126. /**
  132127. * Default Constructor
  132128. * @param engine engine to pull input element from
  132129. */
  132130. constructor(engine: Engine);
  132131. /**
  132132. * Gets a DeviceSource, given a type and slot
  132133. * @param deviceType Enum specifying device type
  132134. * @param deviceSlot "Slot" or index that device is referenced in
  132135. * @returns DeviceSource object
  132136. */
  132137. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  132138. /**
  132139. * Gets an array of DeviceSource objects for a given device type
  132140. * @param deviceType Enum specifying device type
  132141. * @returns Array of DeviceSource objects
  132142. */
  132143. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  132144. /**
  132145. * Dispose of DeviceInputSystem and other parts
  132146. */
  132147. dispose(): void;
  132148. /**
  132149. * Function to add device name to device list
  132150. * @param deviceType Enum specifying device type
  132151. * @param deviceSlot "Slot" or index that device is referenced in
  132152. */
  132153. private _addDevice;
  132154. /**
  132155. * Function to remove device name to device list
  132156. * @param deviceType Enum specifying device type
  132157. * @param deviceSlot "Slot" or index that device is referenced in
  132158. */
  132159. private _removeDevice;
  132160. /**
  132161. * Updates array storing first connected device of each type
  132162. * @param type Type of Device
  132163. */
  132164. private _updateFirstDevices;
  132165. }
  132166. }
  132167. declare module BABYLON {
  132168. /**
  132169. * Options to create the null engine
  132170. */
  132171. export class NullEngineOptions {
  132172. /**
  132173. * Render width (Default: 512)
  132174. */
  132175. renderWidth: number;
  132176. /**
  132177. * Render height (Default: 256)
  132178. */
  132179. renderHeight: number;
  132180. /**
  132181. * Texture size (Default: 512)
  132182. */
  132183. textureSize: number;
  132184. /**
  132185. * If delta time between frames should be constant
  132186. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  132187. */
  132188. deterministicLockstep: boolean;
  132189. /**
  132190. * Maximum about of steps between frames (Default: 4)
  132191. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  132192. */
  132193. lockstepMaxSteps: number;
  132194. /**
  132195. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  132196. */
  132197. useHighPrecisionMatrix?: boolean;
  132198. }
  132199. /**
  132200. * The null engine class provides support for headless version of babylon.js.
  132201. * This can be used in server side scenario or for testing purposes
  132202. */
  132203. export class NullEngine extends Engine {
  132204. private _options;
  132205. /**
  132206. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  132207. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  132208. * @returns true if engine is in deterministic lock step mode
  132209. */
  132210. isDeterministicLockStep(): boolean;
  132211. /**
  132212. * Gets the max steps when engine is running in deterministic lock step
  132213. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  132214. * @returns the max steps
  132215. */
  132216. getLockstepMaxSteps(): number;
  132217. /**
  132218. * Gets the current hardware scaling level.
  132219. * By default the hardware scaling level is computed from the window device ratio.
  132220. * 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.
  132221. * @returns a number indicating the current hardware scaling level
  132222. */
  132223. getHardwareScalingLevel(): number;
  132224. constructor(options?: NullEngineOptions);
  132225. /**
  132226. * Creates a vertex buffer
  132227. * @param vertices the data for the vertex buffer
  132228. * @returns the new WebGL static buffer
  132229. */
  132230. createVertexBuffer(vertices: FloatArray): DataBuffer;
  132231. /**
  132232. * Creates a new index buffer
  132233. * @param indices defines the content of the index buffer
  132234. * @param updatable defines if the index buffer must be updatable
  132235. * @returns a new webGL buffer
  132236. */
  132237. createIndexBuffer(indices: IndicesArray): DataBuffer;
  132238. /**
  132239. * Clear the current render buffer or the current render target (if any is set up)
  132240. * @param color defines the color to use
  132241. * @param backBuffer defines if the back buffer must be cleared
  132242. * @param depth defines if the depth buffer must be cleared
  132243. * @param stencil defines if the stencil buffer must be cleared
  132244. */
  132245. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  132246. /**
  132247. * Gets the current render width
  132248. * @param useScreen defines if screen size must be used (or the current render target if any)
  132249. * @returns a number defining the current render width
  132250. */
  132251. getRenderWidth(useScreen?: boolean): number;
  132252. /**
  132253. * Gets the current render height
  132254. * @param useScreen defines if screen size must be used (or the current render target if any)
  132255. * @returns a number defining the current render height
  132256. */
  132257. getRenderHeight(useScreen?: boolean): number;
  132258. /**
  132259. * Set the WebGL's viewport
  132260. * @param viewport defines the viewport element to be used
  132261. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  132262. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  132263. */
  132264. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  132265. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  132266. /**
  132267. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  132268. * @param pipelineContext defines the pipeline context to use
  132269. * @param uniformsNames defines the list of uniform names
  132270. * @returns an array of webGL uniform locations
  132271. */
  132272. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  132273. /**
  132274. * Gets the lsit of active attributes for a given webGL program
  132275. * @param pipelineContext defines the pipeline context to use
  132276. * @param attributesNames defines the list of attribute names to get
  132277. * @returns an array of indices indicating the offset of each attribute
  132278. */
  132279. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  132280. /**
  132281. * Binds an effect to the webGL context
  132282. * @param effect defines the effect to bind
  132283. */
  132284. bindSamplers(effect: Effect): void;
  132285. /**
  132286. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  132287. * @param effect defines the effect to activate
  132288. */
  132289. enableEffect(effect: Effect): void;
  132290. /**
  132291. * Set various states to the webGL context
  132292. * @param culling defines backface culling state
  132293. * @param zOffset defines the value to apply to zOffset (0 by default)
  132294. * @param force defines if states must be applied even if cache is up to date
  132295. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  132296. */
  132297. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  132298. /**
  132299. * Set the value of an uniform to an array of int32
  132300. * @param uniform defines the webGL uniform location where to store the value
  132301. * @param array defines the array of int32 to store
  132302. * @returns true if value was set
  132303. */
  132304. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  132305. /**
  132306. * Set the value of an uniform to an array of int32 (stored as vec2)
  132307. * @param uniform defines the webGL uniform location where to store the value
  132308. * @param array defines the array of int32 to store
  132309. * @returns true if value was set
  132310. */
  132311. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  132312. /**
  132313. * Set the value of an uniform to an array of int32 (stored as vec3)
  132314. * @param uniform defines the webGL uniform location where to store the value
  132315. * @param array defines the array of int32 to store
  132316. * @returns true if value was set
  132317. */
  132318. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  132319. /**
  132320. * Set the value of an uniform to an array of int32 (stored as vec4)
  132321. * @param uniform defines the webGL uniform location where to store the value
  132322. * @param array defines the array of int32 to store
  132323. * @returns true if value was set
  132324. */
  132325. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  132326. /**
  132327. * Set the value of an uniform to an array of float32
  132328. * @param uniform defines the webGL uniform location where to store the value
  132329. * @param array defines the array of float32 to store
  132330. * @returns true if value was set
  132331. */
  132332. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  132333. /**
  132334. * Set the value of an uniform to an array of float32 (stored as vec2)
  132335. * @param uniform defines the webGL uniform location where to store the value
  132336. * @param array defines the array of float32 to store
  132337. * @returns true if value was set
  132338. */
  132339. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  132340. /**
  132341. * Set the value of an uniform to an array of float32 (stored as vec3)
  132342. * @param uniform defines the webGL uniform location where to store the value
  132343. * @param array defines the array of float32 to store
  132344. * @returns true if value was set
  132345. */
  132346. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  132347. /**
  132348. * Set the value of an uniform to an array of float32 (stored as vec4)
  132349. * @param uniform defines the webGL uniform location where to store the value
  132350. * @param array defines the array of float32 to store
  132351. * @returns true if value was set
  132352. */
  132353. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  132354. /**
  132355. * Set the value of an uniform to an array of number
  132356. * @param uniform defines the webGL uniform location where to store the value
  132357. * @param array defines the array of number to store
  132358. * @returns true if value was set
  132359. */
  132360. setArray(uniform: WebGLUniformLocation, array: number[]): boolean;
  132361. /**
  132362. * Set the value of an uniform to an array of number (stored as vec2)
  132363. * @param uniform defines the webGL uniform location where to store the value
  132364. * @param array defines the array of number to store
  132365. * @returns true if value was set
  132366. */
  132367. setArray2(uniform: WebGLUniformLocation, array: number[]): boolean;
  132368. /**
  132369. * Set the value of an uniform to an array of number (stored as vec3)
  132370. * @param uniform defines the webGL uniform location where to store the value
  132371. * @param array defines the array of number to store
  132372. * @returns true if value was set
  132373. */
  132374. setArray3(uniform: WebGLUniformLocation, array: number[]): boolean;
  132375. /**
  132376. * Set the value of an uniform to an array of number (stored as vec4)
  132377. * @param uniform defines the webGL uniform location where to store the value
  132378. * @param array defines the array of number to store
  132379. * @returns true if value was set
  132380. */
  132381. setArray4(uniform: WebGLUniformLocation, array: number[]): boolean;
  132382. /**
  132383. * Set the value of an uniform to an array of float32 (stored as matrices)
  132384. * @param uniform defines the webGL uniform location where to store the value
  132385. * @param matrices defines the array of float32 to store
  132386. * @returns true if value was set
  132387. */
  132388. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): boolean;
  132389. /**
  132390. * Set the value of an uniform to a matrix (3x3)
  132391. * @param uniform defines the webGL uniform location where to store the value
  132392. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  132393. * @returns true if value was set
  132394. */
  132395. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  132396. /**
  132397. * Set the value of an uniform to a matrix (2x2)
  132398. * @param uniform defines the webGL uniform location where to store the value
  132399. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  132400. * @returns true if value was set
  132401. */
  132402. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  132403. /**
  132404. * Set the value of an uniform to a number (float)
  132405. * @param uniform defines the webGL uniform location where to store the value
  132406. * @param value defines the float number to store
  132407. * @returns true if value was set
  132408. */
  132409. setFloat(uniform: WebGLUniformLocation, value: number): boolean;
  132410. /**
  132411. * Set the value of an uniform to a vec2
  132412. * @param uniform defines the webGL uniform location where to store the value
  132413. * @param x defines the 1st component of the value
  132414. * @param y defines the 2nd component of the value
  132415. * @returns true if value was set
  132416. */
  132417. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): boolean;
  132418. /**
  132419. * Set the value of an uniform to a vec3
  132420. * @param uniform defines the webGL uniform location where to store the value
  132421. * @param x defines the 1st component of the value
  132422. * @param y defines the 2nd component of the value
  132423. * @param z defines the 3rd component of the value
  132424. * @returns true if value was set
  132425. */
  132426. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): boolean;
  132427. /**
  132428. * Set the value of an uniform to a boolean
  132429. * @param uniform defines the webGL uniform location where to store the value
  132430. * @param bool defines the boolean to store
  132431. * @returns true if value was set
  132432. */
  132433. setBool(uniform: WebGLUniformLocation, bool: number): boolean;
  132434. /**
  132435. * Set the value of an uniform to a vec4
  132436. * @param uniform defines the webGL uniform location where to store the value
  132437. * @param x defines the 1st component of the value
  132438. * @param y defines the 2nd component of the value
  132439. * @param z defines the 3rd component of the value
  132440. * @param w defines the 4th component of the value
  132441. * @returns true if value was set
  132442. */
  132443. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): boolean;
  132444. /**
  132445. * Sets the current alpha mode
  132446. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  132447. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  132448. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  132449. */
  132450. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  132451. /**
  132452. * Bind webGl buffers directly to the webGL context
  132453. * @param vertexBuffers defines the vertex buffer to bind
  132454. * @param indexBuffer defines the index buffer to bind
  132455. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  132456. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  132457. * @param effect defines the effect associated with the vertex buffer
  132458. */
  132459. bindBuffers(vertexBuffers: {
  132460. [key: string]: VertexBuffer;
  132461. }, indexBuffer: DataBuffer, effect: Effect): void;
  132462. /**
  132463. * Force the entire cache to be cleared
  132464. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  132465. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  132466. */
  132467. wipeCaches(bruteForce?: boolean): void;
  132468. /**
  132469. * Send a draw order
  132470. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  132471. * @param indexStart defines the starting index
  132472. * @param indexCount defines the number of index to draw
  132473. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  132474. */
  132475. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  132476. /**
  132477. * Draw a list of indexed primitives
  132478. * @param fillMode defines the primitive to use
  132479. * @param indexStart defines the starting index
  132480. * @param indexCount defines the number of index to draw
  132481. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  132482. */
  132483. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  132484. /**
  132485. * Draw a list of unindexed primitives
  132486. * @param fillMode defines the primitive to use
  132487. * @param verticesStart defines the index of first vertex to draw
  132488. * @param verticesCount defines the count of vertices to draw
  132489. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  132490. */
  132491. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  132492. /** @hidden */
  132493. _createTexture(): WebGLTexture;
  132494. /** @hidden */
  132495. _releaseTexture(texture: InternalTexture): void;
  132496. /**
  132497. * Usually called from Texture.ts.
  132498. * Passed information to create a WebGLTexture
  132499. * @param urlArg defines a value which contains one of the following:
  132500. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  132501. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  132502. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  132503. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  132504. * @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)
  132505. * @param scene needed for loading to the correct scene
  132506. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  132507. * @param onLoad optional callback to be called upon successful completion
  132508. * @param onError optional callback to be called upon failure
  132509. * @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
  132510. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  132511. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  132512. * @param forcedExtension defines the extension to use to pick the right loader
  132513. * @param mimeType defines an optional mime type
  132514. * @returns a InternalTexture for assignment back into BABYLON.Texture
  132515. */
  132516. 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;
  132517. /**
  132518. * Creates a new render target texture
  132519. * @param size defines the size of the texture
  132520. * @param options defines the options used to create the texture
  132521. * @returns a new render target texture stored in an InternalTexture
  132522. */
  132523. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  132524. /**
  132525. * Update the sampling mode of a given texture
  132526. * @param samplingMode defines the required sampling mode
  132527. * @param texture defines the texture to update
  132528. */
  132529. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  132530. /**
  132531. * Binds the frame buffer to the specified texture.
  132532. * @param texture The texture to render to or null for the default canvas
  132533. * @param faceIndex The face of the texture to render to in case of cube texture
  132534. * @param requiredWidth The width of the target to render to
  132535. * @param requiredHeight The height of the target to render to
  132536. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  132537. * @param lodLevel defines le lod level to bind to the frame buffer
  132538. */
  132539. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  132540. /**
  132541. * Unbind the current render target texture from the webGL context
  132542. * @param texture defines the render target texture to unbind
  132543. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  132544. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  132545. */
  132546. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  132547. /**
  132548. * Creates a dynamic vertex buffer
  132549. * @param vertices the data for the dynamic vertex buffer
  132550. * @returns the new WebGL dynamic buffer
  132551. */
  132552. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  132553. /**
  132554. * Update the content of a dynamic texture
  132555. * @param texture defines the texture to update
  132556. * @param canvas defines the canvas containing the source
  132557. * @param invertY defines if data must be stored with Y axis inverted
  132558. * @param premulAlpha defines if alpha is stored as premultiplied
  132559. * @param format defines the format of the data
  132560. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  132561. */
  132562. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  132563. /**
  132564. * Gets a boolean indicating if all created effects are ready
  132565. * @returns true if all effects are ready
  132566. */
  132567. areAllEffectsReady(): boolean;
  132568. /**
  132569. * @hidden
  132570. * Get the current error code of the webGL context
  132571. * @returns the error code
  132572. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  132573. */
  132574. getError(): number;
  132575. /** @hidden */
  132576. _getUnpackAlignement(): number;
  132577. /** @hidden */
  132578. _unpackFlipY(value: boolean): void;
  132579. /**
  132580. * Update a dynamic index buffer
  132581. * @param indexBuffer defines the target index buffer
  132582. * @param indices defines the data to update
  132583. * @param offset defines the offset in the target index buffer where update should start
  132584. */
  132585. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  132586. /**
  132587. * Updates a dynamic vertex buffer.
  132588. * @param vertexBuffer the vertex buffer to update
  132589. * @param vertices the data used to update the vertex buffer
  132590. * @param byteOffset the byte offset of the data (optional)
  132591. * @param byteLength the byte length of the data (optional)
  132592. */
  132593. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  132594. /** @hidden */
  132595. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  132596. /** @hidden */
  132597. _bindTexture(channel: number, texture: InternalTexture): void;
  132598. protected _deleteBuffer(buffer: WebGLBuffer): void;
  132599. /**
  132600. * 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
  132601. */
  132602. releaseEffects(): void;
  132603. displayLoadingUI(): void;
  132604. hideLoadingUI(): void;
  132605. /** @hidden */
  132606. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132607. /** @hidden */
  132608. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132609. /** @hidden */
  132610. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132611. /** @hidden */
  132612. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  132613. }
  132614. }
  132615. declare module BABYLON {
  132616. /**
  132617. * @hidden
  132618. **/
  132619. export class _TimeToken {
  132620. _startTimeQuery: Nullable<WebGLQuery>;
  132621. _endTimeQuery: Nullable<WebGLQuery>;
  132622. _timeElapsedQuery: Nullable<WebGLQuery>;
  132623. _timeElapsedQueryEnded: boolean;
  132624. }
  132625. }
  132626. declare module BABYLON {
  132627. /** @hidden */
  132628. export class _OcclusionDataStorage {
  132629. /** @hidden */
  132630. occlusionInternalRetryCounter: number;
  132631. /** @hidden */
  132632. isOcclusionQueryInProgress: boolean;
  132633. /** @hidden */
  132634. isOccluded: boolean;
  132635. /** @hidden */
  132636. occlusionRetryCount: number;
  132637. /** @hidden */
  132638. occlusionType: number;
  132639. /** @hidden */
  132640. occlusionQueryAlgorithmType: number;
  132641. }
  132642. interface Engine {
  132643. /**
  132644. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  132645. * @return the new query
  132646. */
  132647. createQuery(): WebGLQuery;
  132648. /**
  132649. * Delete and release a webGL query
  132650. * @param query defines the query to delete
  132651. * @return the current engine
  132652. */
  132653. deleteQuery(query: WebGLQuery): Engine;
  132654. /**
  132655. * Check if a given query has resolved and got its value
  132656. * @param query defines the query to check
  132657. * @returns true if the query got its value
  132658. */
  132659. isQueryResultAvailable(query: WebGLQuery): boolean;
  132660. /**
  132661. * Gets the value of a given query
  132662. * @param query defines the query to check
  132663. * @returns the value of the query
  132664. */
  132665. getQueryResult(query: WebGLQuery): number;
  132666. /**
  132667. * Initiates an occlusion query
  132668. * @param algorithmType defines the algorithm to use
  132669. * @param query defines the query to use
  132670. * @returns the current engine
  132671. * @see https://doc.babylonjs.com/features/occlusionquery
  132672. */
  132673. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  132674. /**
  132675. * Ends an occlusion query
  132676. * @see https://doc.babylonjs.com/features/occlusionquery
  132677. * @param algorithmType defines the algorithm to use
  132678. * @returns the current engine
  132679. */
  132680. endOcclusionQuery(algorithmType: number): Engine;
  132681. /**
  132682. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  132683. * Please note that only one query can be issued at a time
  132684. * @returns a time token used to track the time span
  132685. */
  132686. startTimeQuery(): Nullable<_TimeToken>;
  132687. /**
  132688. * Ends a time query
  132689. * @param token defines the token used to measure the time span
  132690. * @returns the time spent (in ns)
  132691. */
  132692. endTimeQuery(token: _TimeToken): int;
  132693. /** @hidden */
  132694. _currentNonTimestampToken: Nullable<_TimeToken>;
  132695. /** @hidden */
  132696. _createTimeQuery(): WebGLQuery;
  132697. /** @hidden */
  132698. _deleteTimeQuery(query: WebGLQuery): void;
  132699. /** @hidden */
  132700. _getGlAlgorithmType(algorithmType: number): number;
  132701. /** @hidden */
  132702. _getTimeQueryResult(query: WebGLQuery): any;
  132703. /** @hidden */
  132704. _getTimeQueryAvailability(query: WebGLQuery): any;
  132705. }
  132706. interface AbstractMesh {
  132707. /**
  132708. * Backing filed
  132709. * @hidden
  132710. */
  132711. __occlusionDataStorage: _OcclusionDataStorage;
  132712. /**
  132713. * Access property
  132714. * @hidden
  132715. */
  132716. _occlusionDataStorage: _OcclusionDataStorage;
  132717. /**
  132718. * 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.
  132719. * The default value is -1 which means don't break the query and wait till the result
  132720. * @see https://doc.babylonjs.com/features/occlusionquery
  132721. */
  132722. occlusionRetryCount: number;
  132723. /**
  132724. * 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:
  132725. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  132726. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  132727. * * 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.
  132728. * @see https://doc.babylonjs.com/features/occlusionquery
  132729. */
  132730. occlusionType: number;
  132731. /**
  132732. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  132733. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  132734. * * 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.
  132735. * @see https://doc.babylonjs.com/features/occlusionquery
  132736. */
  132737. occlusionQueryAlgorithmType: number;
  132738. /**
  132739. * 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
  132740. * @see https://doc.babylonjs.com/features/occlusionquery
  132741. */
  132742. isOccluded: boolean;
  132743. /**
  132744. * Flag to check the progress status of the query
  132745. * @see https://doc.babylonjs.com/features/occlusionquery
  132746. */
  132747. isOcclusionQueryInProgress: boolean;
  132748. }
  132749. }
  132750. declare module BABYLON {
  132751. /** @hidden */
  132752. export var _forceTransformFeedbackToBundle: boolean;
  132753. interface Engine {
  132754. /**
  132755. * Creates a webGL transform feedback object
  132756. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  132757. * @returns the webGL transform feedback object
  132758. */
  132759. createTransformFeedback(): WebGLTransformFeedback;
  132760. /**
  132761. * Delete a webGL transform feedback object
  132762. * @param value defines the webGL transform feedback object to delete
  132763. */
  132764. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  132765. /**
  132766. * Bind a webGL transform feedback object to the webgl context
  132767. * @param value defines the webGL transform feedback object to bind
  132768. */
  132769. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  132770. /**
  132771. * Begins a transform feedback operation
  132772. * @param usePoints defines if points or triangles must be used
  132773. */
  132774. beginTransformFeedback(usePoints: boolean): void;
  132775. /**
  132776. * Ends a transform feedback operation
  132777. */
  132778. endTransformFeedback(): void;
  132779. /**
  132780. * Specify the varyings to use with transform feedback
  132781. * @param program defines the associated webGL program
  132782. * @param value defines the list of strings representing the varying names
  132783. */
  132784. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  132785. /**
  132786. * Bind a webGL buffer for a transform feedback operation
  132787. * @param value defines the webGL buffer to bind
  132788. */
  132789. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  132790. }
  132791. }
  132792. declare module BABYLON {
  132793. /**
  132794. * Class used to define an additional view for the engine
  132795. * @see https://doc.babylonjs.com/how_to/multi_canvases
  132796. */
  132797. export class EngineView {
  132798. /** Defines the canvas where to render the view */
  132799. target: HTMLCanvasElement;
  132800. /** Defines an optional camera used to render the view (will use active camera else) */
  132801. camera?: Camera;
  132802. }
  132803. interface Engine {
  132804. /**
  132805. * Gets or sets the HTML element to use for attaching events
  132806. */
  132807. inputElement: Nullable<HTMLElement>;
  132808. /**
  132809. * Gets the current engine view
  132810. * @see https://doc.babylonjs.com/how_to/multi_canvases
  132811. */
  132812. activeView: Nullable<EngineView>;
  132813. /** Gets or sets the list of views */
  132814. views: EngineView[];
  132815. /**
  132816. * Register a new child canvas
  132817. * @param canvas defines the canvas to register
  132818. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  132819. * @returns the associated view
  132820. */
  132821. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  132822. /**
  132823. * Remove a registered child canvas
  132824. * @param canvas defines the canvas to remove
  132825. * @returns the current engine
  132826. */
  132827. unRegisterView(canvas: HTMLCanvasElement): Engine;
  132828. }
  132829. }
  132830. declare module BABYLON {
  132831. interface Engine {
  132832. /** @hidden */
  132833. _excludedCompressedTextures: string[];
  132834. /** @hidden */
  132835. _textureFormatInUse: string;
  132836. /**
  132837. * Gets the list of texture formats supported
  132838. */
  132839. readonly texturesSupported: Array<string>;
  132840. /**
  132841. * Gets the texture format in use
  132842. */
  132843. readonly textureFormatInUse: Nullable<string>;
  132844. /**
  132845. * Set the compressed texture extensions or file names to skip.
  132846. *
  132847. * @param skippedFiles defines the list of those texture files you want to skip
  132848. * Example: [".dds", ".env", "myfile.png"]
  132849. */
  132850. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  132851. /**
  132852. * Set the compressed texture format to use, based on the formats you have, and the formats
  132853. * supported by the hardware / browser.
  132854. *
  132855. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  132856. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  132857. * to API arguments needed to compressed textures. This puts the burden on the container
  132858. * generator to house the arcane code for determining these for current & future formats.
  132859. *
  132860. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  132861. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  132862. *
  132863. * Note: The result of this call is not taken into account when a texture is base64.
  132864. *
  132865. * @param formatsAvailable defines the list of those format families you have created
  132866. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  132867. *
  132868. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  132869. * @returns The extension selected.
  132870. */
  132871. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  132872. }
  132873. }
  132874. declare module BABYLON {
  132875. /**
  132876. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  132877. */
  132878. export interface CubeMapInfo {
  132879. /**
  132880. * The pixel array for the front face.
  132881. * This is stored in format, left to right, up to down format.
  132882. */
  132883. front: Nullable<ArrayBufferView>;
  132884. /**
  132885. * The pixel array for the back face.
  132886. * This is stored in format, left to right, up to down format.
  132887. */
  132888. back: Nullable<ArrayBufferView>;
  132889. /**
  132890. * The pixel array for the left face.
  132891. * This is stored in format, left to right, up to down format.
  132892. */
  132893. left: Nullable<ArrayBufferView>;
  132894. /**
  132895. * The pixel array for the right face.
  132896. * This is stored in format, left to right, up to down format.
  132897. */
  132898. right: Nullable<ArrayBufferView>;
  132899. /**
  132900. * The pixel array for the up face.
  132901. * This is stored in format, left to right, up to down format.
  132902. */
  132903. up: Nullable<ArrayBufferView>;
  132904. /**
  132905. * The pixel array for the down face.
  132906. * This is stored in format, left to right, up to down format.
  132907. */
  132908. down: Nullable<ArrayBufferView>;
  132909. /**
  132910. * The size of the cubemap stored.
  132911. *
  132912. * Each faces will be size * size pixels.
  132913. */
  132914. size: number;
  132915. /**
  132916. * The format of the texture.
  132917. *
  132918. * RGBA, RGB.
  132919. */
  132920. format: number;
  132921. /**
  132922. * The type of the texture data.
  132923. *
  132924. * UNSIGNED_INT, FLOAT.
  132925. */
  132926. type: number;
  132927. /**
  132928. * Specifies whether the texture is in gamma space.
  132929. */
  132930. gammaSpace: boolean;
  132931. }
  132932. /**
  132933. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  132934. */
  132935. export class PanoramaToCubeMapTools {
  132936. private static FACE_LEFT;
  132937. private static FACE_RIGHT;
  132938. private static FACE_FRONT;
  132939. private static FACE_BACK;
  132940. private static FACE_DOWN;
  132941. private static FACE_UP;
  132942. /**
  132943. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  132944. *
  132945. * @param float32Array The source data.
  132946. * @param inputWidth The width of the input panorama.
  132947. * @param inputHeight The height of the input panorama.
  132948. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  132949. * @return The cubemap data
  132950. */
  132951. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  132952. private static CreateCubemapTexture;
  132953. private static CalcProjectionSpherical;
  132954. }
  132955. }
  132956. declare module BABYLON {
  132957. /**
  132958. * Helper class dealing with the extraction of spherical polynomial dataArray
  132959. * from a cube map.
  132960. */
  132961. export class CubeMapToSphericalPolynomialTools {
  132962. private static FileFaces;
  132963. /**
  132964. * Converts a texture to the according Spherical Polynomial data.
  132965. * This extracts the first 3 orders only as they are the only one used in the lighting.
  132966. *
  132967. * @param texture The texture to extract the information from.
  132968. * @return The Spherical Polynomial data.
  132969. */
  132970. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  132971. /**
  132972. * Converts a cubemap to the according Spherical Polynomial data.
  132973. * This extracts the first 3 orders only as they are the only one used in the lighting.
  132974. *
  132975. * @param cubeInfo The Cube map to extract the information from.
  132976. * @return The Spherical Polynomial data.
  132977. */
  132978. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  132979. }
  132980. }
  132981. declare module BABYLON {
  132982. interface BaseTexture {
  132983. /**
  132984. * Get the polynomial representation of the texture data.
  132985. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  132986. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  132987. */
  132988. sphericalPolynomial: Nullable<SphericalPolynomial>;
  132989. }
  132990. }
  132991. declare module BABYLON {
  132992. /** @hidden */
  132993. export var rgbdEncodePixelShader: {
  132994. name: string;
  132995. shader: string;
  132996. };
  132997. }
  132998. declare module BABYLON {
  132999. /** @hidden */
  133000. export var rgbdDecodePixelShader: {
  133001. name: string;
  133002. shader: string;
  133003. };
  133004. }
  133005. declare module BABYLON {
  133006. /**
  133007. * Raw texture data and descriptor sufficient for WebGL texture upload
  133008. */
  133009. export interface EnvironmentTextureInfo {
  133010. /**
  133011. * Version of the environment map
  133012. */
  133013. version: number;
  133014. /**
  133015. * Width of image
  133016. */
  133017. width: number;
  133018. /**
  133019. * Irradiance information stored in the file.
  133020. */
  133021. irradiance: any;
  133022. /**
  133023. * Specular information stored in the file.
  133024. */
  133025. specular: any;
  133026. }
  133027. /**
  133028. * Defines One Image in the file. It requires only the position in the file
  133029. * as well as the length.
  133030. */
  133031. interface BufferImageData {
  133032. /**
  133033. * Length of the image data.
  133034. */
  133035. length: number;
  133036. /**
  133037. * Position of the data from the null terminator delimiting the end of the JSON.
  133038. */
  133039. position: number;
  133040. }
  133041. /**
  133042. * Defines the specular data enclosed in the file.
  133043. * This corresponds to the version 1 of the data.
  133044. */
  133045. export interface EnvironmentTextureSpecularInfoV1 {
  133046. /**
  133047. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  133048. */
  133049. specularDataPosition?: number;
  133050. /**
  133051. * This contains all the images data needed to reconstruct the cubemap.
  133052. */
  133053. mipmaps: Array<BufferImageData>;
  133054. /**
  133055. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  133056. */
  133057. lodGenerationScale: number;
  133058. }
  133059. /**
  133060. * Sets of helpers addressing the serialization and deserialization of environment texture
  133061. * stored in a BabylonJS env file.
  133062. * Those files are usually stored as .env files.
  133063. */
  133064. export class EnvironmentTextureTools {
  133065. /**
  133066. * Magic number identifying the env file.
  133067. */
  133068. private static _MagicBytes;
  133069. /**
  133070. * Gets the environment info from an env file.
  133071. * @param data The array buffer containing the .env bytes.
  133072. * @returns the environment file info (the json header) if successfully parsed.
  133073. */
  133074. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  133075. /**
  133076. * Creates an environment texture from a loaded cube texture.
  133077. * @param texture defines the cube texture to convert in env file
  133078. * @return a promise containing the environment data if succesfull.
  133079. */
  133080. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  133081. /**
  133082. * Creates a JSON representation of the spherical data.
  133083. * @param texture defines the texture containing the polynomials
  133084. * @return the JSON representation of the spherical info
  133085. */
  133086. private static _CreateEnvTextureIrradiance;
  133087. /**
  133088. * Creates the ArrayBufferViews used for initializing environment texture image data.
  133089. * @param data the image data
  133090. * @param info parameters that determine what views will be created for accessing the underlying buffer
  133091. * @return the views described by info providing access to the underlying buffer
  133092. */
  133093. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  133094. /**
  133095. * Uploads the texture info contained in the env file to the GPU.
  133096. * @param texture defines the internal texture to upload to
  133097. * @param data defines the data to load
  133098. * @param info defines the texture info retrieved through the GetEnvInfo method
  133099. * @returns a promise
  133100. */
  133101. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  133102. private static _OnImageReadyAsync;
  133103. /**
  133104. * Uploads the levels of image data to the GPU.
  133105. * @param texture defines the internal texture to upload to
  133106. * @param imageData defines the array buffer views of image data [mipmap][face]
  133107. * @returns a promise
  133108. */
  133109. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  133110. /**
  133111. * Uploads spherical polynomials information to the texture.
  133112. * @param texture defines the texture we are trying to upload the information to
  133113. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  133114. */
  133115. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  133116. /** @hidden */
  133117. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  133118. }
  133119. }
  133120. declare module BABYLON {
  133121. /**
  133122. * Class used to inline functions in shader code
  133123. */
  133124. export class ShaderCodeInliner {
  133125. private static readonly _RegexpFindFunctionNameAndType;
  133126. private _sourceCode;
  133127. private _functionDescr;
  133128. private _numMaxIterations;
  133129. /** Gets or sets the token used to mark the functions to inline */
  133130. inlineToken: string;
  133131. /** Gets or sets the debug mode */
  133132. debug: boolean;
  133133. /** Gets the code after the inlining process */
  133134. get code(): string;
  133135. /**
  133136. * Initializes the inliner
  133137. * @param sourceCode shader code source to inline
  133138. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  133139. */
  133140. constructor(sourceCode: string, numMaxIterations?: number);
  133141. /**
  133142. * Start the processing of the shader code
  133143. */
  133144. processCode(): void;
  133145. private _collectFunctions;
  133146. private _processInlining;
  133147. private _extractBetweenMarkers;
  133148. private _skipWhitespaces;
  133149. private _removeComments;
  133150. private _replaceFunctionCallsByCode;
  133151. private _findBackward;
  133152. private _escapeRegExp;
  133153. private _replaceNames;
  133154. }
  133155. }
  133156. declare module BABYLON {
  133157. /**
  133158. * Container for accessors for natively-stored mesh data buffers.
  133159. */
  133160. class NativeDataBuffer extends DataBuffer {
  133161. /**
  133162. * Accessor value used to identify/retrieve a natively-stored index buffer.
  133163. */
  133164. nativeIndexBuffer?: any;
  133165. /**
  133166. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  133167. */
  133168. nativeVertexBuffer?: any;
  133169. }
  133170. /** @hidden */
  133171. class NativeTexture extends InternalTexture {
  133172. getInternalTexture(): InternalTexture;
  133173. getViewCount(): number;
  133174. }
  133175. /** @hidden */
  133176. export class NativeEngine extends Engine {
  133177. private readonly _native;
  133178. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  133179. private readonly INVALID_HANDLE;
  133180. private _boundBuffersVertexArray;
  133181. private _currentDepthTest;
  133182. getHardwareScalingLevel(): number;
  133183. constructor();
  133184. dispose(): void;
  133185. /**
  133186. * Can be used to override the current requestAnimationFrame requester.
  133187. * @hidden
  133188. */
  133189. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  133190. /**
  133191. * Override default engine behavior.
  133192. * @param color
  133193. * @param backBuffer
  133194. * @param depth
  133195. * @param stencil
  133196. */
  133197. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  133198. /**
  133199. * Gets host document
  133200. * @returns the host document object
  133201. */
  133202. getHostDocument(): Nullable<Document>;
  133203. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  133204. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  133205. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  133206. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  133207. [key: string]: VertexBuffer;
  133208. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  133209. bindBuffers(vertexBuffers: {
  133210. [key: string]: VertexBuffer;
  133211. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  133212. recordVertexArrayObject(vertexBuffers: {
  133213. [key: string]: VertexBuffer;
  133214. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  133215. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  133216. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  133217. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  133218. /**
  133219. * Draw a list of indexed primitives
  133220. * @param fillMode defines the primitive to use
  133221. * @param indexStart defines the starting index
  133222. * @param indexCount defines the number of index to draw
  133223. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  133224. */
  133225. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  133226. /**
  133227. * Draw a list of unindexed primitives
  133228. * @param fillMode defines the primitive to use
  133229. * @param verticesStart defines the index of first vertex to draw
  133230. * @param verticesCount defines the count of vertices to draw
  133231. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  133232. */
  133233. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  133234. createPipelineContext(): IPipelineContext;
  133235. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  133236. /** @hidden */
  133237. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  133238. /** @hidden */
  133239. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  133240. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  133241. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  133242. protected _setProgram(program: WebGLProgram): void;
  133243. _releaseEffect(effect: Effect): void;
  133244. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  133245. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  133246. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  133247. bindSamplers(effect: Effect): void;
  133248. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  133249. getRenderWidth(useScreen?: boolean): number;
  133250. getRenderHeight(useScreen?: boolean): number;
  133251. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  133252. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  133253. /**
  133254. * Set the z offset to apply to current rendering
  133255. * @param value defines the offset to apply
  133256. */
  133257. setZOffset(value: number): void;
  133258. /**
  133259. * Gets the current value of the zOffset
  133260. * @returns the current zOffset state
  133261. */
  133262. getZOffset(): number;
  133263. /**
  133264. * Enable or disable depth buffering
  133265. * @param enable defines the state to set
  133266. */
  133267. setDepthBuffer(enable: boolean): void;
  133268. /**
  133269. * Gets a boolean indicating if depth writing is enabled
  133270. * @returns the current depth writing state
  133271. */
  133272. getDepthWrite(): boolean;
  133273. setDepthFunctionToGreater(): void;
  133274. setDepthFunctionToGreaterOrEqual(): void;
  133275. setDepthFunctionToLess(): void;
  133276. setDepthFunctionToLessOrEqual(): void;
  133277. /**
  133278. * Enable or disable depth writing
  133279. * @param enable defines the state to set
  133280. */
  133281. setDepthWrite(enable: boolean): void;
  133282. /**
  133283. * Enable or disable color writing
  133284. * @param enable defines the state to set
  133285. */
  133286. setColorWrite(enable: boolean): void;
  133287. /**
  133288. * Gets a boolean indicating if color writing is enabled
  133289. * @returns the current color writing state
  133290. */
  133291. getColorWrite(): boolean;
  133292. /**
  133293. * Sets alpha constants used by some alpha blending modes
  133294. * @param r defines the red component
  133295. * @param g defines the green component
  133296. * @param b defines the blue component
  133297. * @param a defines the alpha component
  133298. */
  133299. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  133300. /**
  133301. * Sets the current alpha mode
  133302. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  133303. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  133304. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  133305. */
  133306. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  133307. /**
  133308. * Gets the current alpha mode
  133309. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  133310. * @returns the current alpha mode
  133311. */
  133312. getAlphaMode(): number;
  133313. setInt(uniform: WebGLUniformLocation, int: number): boolean;
  133314. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  133315. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  133316. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  133317. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  133318. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  133319. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  133320. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  133321. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  133322. setArray(uniform: WebGLUniformLocation, array: number[]): boolean;
  133323. setArray2(uniform: WebGLUniformLocation, array: number[]): boolean;
  133324. setArray3(uniform: WebGLUniformLocation, array: number[]): boolean;
  133325. setArray4(uniform: WebGLUniformLocation, array: number[]): boolean;
  133326. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): boolean;
  133327. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  133328. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  133329. setFloat(uniform: WebGLUniformLocation, value: number): boolean;
  133330. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): boolean;
  133331. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): boolean;
  133332. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): boolean;
  133333. setColor3(uniform: WebGLUniformLocation, color3: Color3): boolean;
  133334. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): boolean;
  133335. wipeCaches(bruteForce?: boolean): void;
  133336. _createTexture(): WebGLTexture;
  133337. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  133338. /**
  133339. * Usually called from Texture.ts.
  133340. * Passed information to create a WebGLTexture
  133341. * @param url defines a value which contains one of the following:
  133342. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  133343. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  133344. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  133345. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  133346. * @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)
  133347. * @param scene needed for loading to the correct scene
  133348. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  133349. * @param onLoad optional callback to be called upon successful completion
  133350. * @param onError optional callback to be called upon failure
  133351. * @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
  133352. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  133353. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  133354. * @param forcedExtension defines the extension to use to pick the right loader
  133355. * @param mimeType defines an optional mime type
  133356. * @returns a InternalTexture for assignment back into BABYLON.Texture
  133357. */
  133358. 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;
  133359. /**
  133360. * Creates a cube texture
  133361. * @param rootUrl defines the url where the files to load is located
  133362. * @param scene defines the current scene
  133363. * @param files defines the list of files to load (1 per face)
  133364. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  133365. * @param onLoad defines an optional callback raised when the texture is loaded
  133366. * @param onError defines an optional callback raised if there is an issue to load the texture
  133367. * @param format defines the format of the data
  133368. * @param forcedExtension defines the extension to use to pick the right loader
  133369. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  133370. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  133371. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  133372. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  133373. * @returns the cube texture as an InternalTexture
  133374. */
  133375. 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;
  133376. private _getSamplingFilter;
  133377. private static _GetNativeTextureFormat;
  133378. createRenderTargetTexture(size: number | {
  133379. width: number;
  133380. height: number;
  133381. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  133382. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  133383. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  133384. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  133385. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  133386. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  133387. /**
  133388. * Updates a dynamic vertex buffer.
  133389. * @param vertexBuffer the vertex buffer to update
  133390. * @param data the data used to update the vertex buffer
  133391. * @param byteOffset the byte offset of the data (optional)
  133392. * @param byteLength the byte length of the data (optional)
  133393. */
  133394. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  133395. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  133396. private _updateAnisotropicLevel;
  133397. private _getAddressMode;
  133398. /** @hidden */
  133399. _bindTexture(channel: number, texture: InternalTexture): void;
  133400. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  133401. releaseEffects(): void;
  133402. /** @hidden */
  133403. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  133404. /** @hidden */
  133405. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  133406. /** @hidden */
  133407. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  133408. /** @hidden */
  133409. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  133410. }
  133411. }
  133412. declare module BABYLON {
  133413. /**
  133414. * Gather the list of clipboard event types as constants.
  133415. */
  133416. export class ClipboardEventTypes {
  133417. /**
  133418. * The clipboard event is fired when a copy command is active (pressed).
  133419. */
  133420. static readonly COPY: number;
  133421. /**
  133422. * The clipboard event is fired when a cut command is active (pressed).
  133423. */
  133424. static readonly CUT: number;
  133425. /**
  133426. * The clipboard event is fired when a paste command is active (pressed).
  133427. */
  133428. static readonly PASTE: number;
  133429. }
  133430. /**
  133431. * This class is used to store clipboard related info for the onClipboardObservable event.
  133432. */
  133433. export class ClipboardInfo {
  133434. /**
  133435. * Defines the type of event (BABYLON.ClipboardEventTypes)
  133436. */
  133437. type: number;
  133438. /**
  133439. * Defines the related dom event
  133440. */
  133441. event: ClipboardEvent;
  133442. /**
  133443. *Creates an instance of ClipboardInfo.
  133444. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  133445. * @param event Defines the related dom event
  133446. */
  133447. constructor(
  133448. /**
  133449. * Defines the type of event (BABYLON.ClipboardEventTypes)
  133450. */
  133451. type: number,
  133452. /**
  133453. * Defines the related dom event
  133454. */
  133455. event: ClipboardEvent);
  133456. /**
  133457. * Get the clipboard event's type from the keycode.
  133458. * @param keyCode Defines the keyCode for the current keyboard event.
  133459. * @return {number}
  133460. */
  133461. static GetTypeFromCharacter(keyCode: number): number;
  133462. }
  133463. }
  133464. declare module BABYLON {
  133465. /**
  133466. * Google Daydream controller
  133467. */
  133468. export class DaydreamController extends WebVRController {
  133469. /**
  133470. * Base Url for the controller model.
  133471. */
  133472. static MODEL_BASE_URL: string;
  133473. /**
  133474. * File name for the controller model.
  133475. */
  133476. static MODEL_FILENAME: string;
  133477. /**
  133478. * Gamepad Id prefix used to identify Daydream Controller.
  133479. */
  133480. static readonly GAMEPAD_ID_PREFIX: string;
  133481. /**
  133482. * Creates a new DaydreamController from a gamepad
  133483. * @param vrGamepad the gamepad that the controller should be created from
  133484. */
  133485. constructor(vrGamepad: any);
  133486. /**
  133487. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  133488. * @param scene scene in which to add meshes
  133489. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  133490. */
  133491. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  133492. /**
  133493. * Called once for each button that changed state since the last frame
  133494. * @param buttonIdx Which button index changed
  133495. * @param state New state of the button
  133496. * @param changes Which properties on the state changed since last frame
  133497. */
  133498. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  133499. }
  133500. }
  133501. declare module BABYLON {
  133502. /**
  133503. * Gear VR Controller
  133504. */
  133505. export class GearVRController extends WebVRController {
  133506. /**
  133507. * Base Url for the controller model.
  133508. */
  133509. static MODEL_BASE_URL: string;
  133510. /**
  133511. * File name for the controller model.
  133512. */
  133513. static MODEL_FILENAME: string;
  133514. /**
  133515. * Gamepad Id prefix used to identify this controller.
  133516. */
  133517. static readonly GAMEPAD_ID_PREFIX: string;
  133518. private readonly _buttonIndexToObservableNameMap;
  133519. /**
  133520. * Creates a new GearVRController from a gamepad
  133521. * @param vrGamepad the gamepad that the controller should be created from
  133522. */
  133523. constructor(vrGamepad: any);
  133524. /**
  133525. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  133526. * @param scene scene in which to add meshes
  133527. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  133528. */
  133529. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  133530. /**
  133531. * Called once for each button that changed state since the last frame
  133532. * @param buttonIdx Which button index changed
  133533. * @param state New state of the button
  133534. * @param changes Which properties on the state changed since last frame
  133535. */
  133536. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  133537. }
  133538. }
  133539. declare module BABYLON {
  133540. /**
  133541. * Generic Controller
  133542. */
  133543. export class GenericController extends WebVRController {
  133544. /**
  133545. * Base Url for the controller model.
  133546. */
  133547. static readonly MODEL_BASE_URL: string;
  133548. /**
  133549. * File name for the controller model.
  133550. */
  133551. static readonly MODEL_FILENAME: string;
  133552. /**
  133553. * Creates a new GenericController from a gamepad
  133554. * @param vrGamepad the gamepad that the controller should be created from
  133555. */
  133556. constructor(vrGamepad: any);
  133557. /**
  133558. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  133559. * @param scene scene in which to add meshes
  133560. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  133561. */
  133562. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  133563. /**
  133564. * Called once for each button that changed state since the last frame
  133565. * @param buttonIdx Which button index changed
  133566. * @param state New state of the button
  133567. * @param changes Which properties on the state changed since last frame
  133568. */
  133569. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  133570. }
  133571. }
  133572. declare module BABYLON {
  133573. /**
  133574. * Oculus Touch Controller
  133575. */
  133576. export class OculusTouchController extends WebVRController {
  133577. /**
  133578. * Base Url for the controller model.
  133579. */
  133580. static MODEL_BASE_URL: string;
  133581. /**
  133582. * File name for the left controller model.
  133583. */
  133584. static MODEL_LEFT_FILENAME: string;
  133585. /**
  133586. * File name for the right controller model.
  133587. */
  133588. static MODEL_RIGHT_FILENAME: string;
  133589. /**
  133590. * Base Url for the Quest controller model.
  133591. */
  133592. static QUEST_MODEL_BASE_URL: string;
  133593. /**
  133594. * @hidden
  133595. * If the controllers are running on a device that needs the updated Quest controller models
  133596. */
  133597. static _IsQuest: boolean;
  133598. /**
  133599. * Fired when the secondary trigger on this controller is modified
  133600. */
  133601. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  133602. /**
  133603. * Fired when the thumb rest on this controller is modified
  133604. */
  133605. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  133606. /**
  133607. * Creates a new OculusTouchController from a gamepad
  133608. * @param vrGamepad the gamepad that the controller should be created from
  133609. */
  133610. constructor(vrGamepad: any);
  133611. /**
  133612. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  133613. * @param scene scene in which to add meshes
  133614. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  133615. */
  133616. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  133617. /**
  133618. * Fired when the A button on this controller is modified
  133619. */
  133620. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133621. /**
  133622. * Fired when the B button on this controller is modified
  133623. */
  133624. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133625. /**
  133626. * Fired when the X button on this controller is modified
  133627. */
  133628. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133629. /**
  133630. * Fired when the Y button on this controller is modified
  133631. */
  133632. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133633. /**
  133634. * Called once for each button that changed state since the last frame
  133635. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  133636. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  133637. * 2) secondary trigger (same)
  133638. * 3) A (right) X (left), touch, pressed = value
  133639. * 4) B / Y
  133640. * 5) thumb rest
  133641. * @param buttonIdx Which button index changed
  133642. * @param state New state of the button
  133643. * @param changes Which properties on the state changed since last frame
  133644. */
  133645. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  133646. }
  133647. }
  133648. declare module BABYLON {
  133649. /**
  133650. * Vive Controller
  133651. */
  133652. export class ViveController extends WebVRController {
  133653. /**
  133654. * Base Url for the controller model.
  133655. */
  133656. static MODEL_BASE_URL: string;
  133657. /**
  133658. * File name for the controller model.
  133659. */
  133660. static MODEL_FILENAME: string;
  133661. /**
  133662. * Creates a new ViveController from a gamepad
  133663. * @param vrGamepad the gamepad that the controller should be created from
  133664. */
  133665. constructor(vrGamepad: any);
  133666. /**
  133667. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  133668. * @param scene scene in which to add meshes
  133669. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  133670. */
  133671. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  133672. /**
  133673. * Fired when the left button on this controller is modified
  133674. */
  133675. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133676. /**
  133677. * Fired when the right button on this controller is modified
  133678. */
  133679. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133680. /**
  133681. * Fired when the menu button on this controller is modified
  133682. */
  133683. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133684. /**
  133685. * Called once for each button that changed state since the last frame
  133686. * Vive mapping:
  133687. * 0: touchpad
  133688. * 1: trigger
  133689. * 2: left AND right buttons
  133690. * 3: menu button
  133691. * @param buttonIdx Which button index changed
  133692. * @param state New state of the button
  133693. * @param changes Which properties on the state changed since last frame
  133694. */
  133695. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  133696. }
  133697. }
  133698. declare module BABYLON {
  133699. /**
  133700. * Defines the WindowsMotionController object that the state of the windows motion controller
  133701. */
  133702. export class WindowsMotionController extends WebVRController {
  133703. /**
  133704. * The base url used to load the left and right controller models
  133705. */
  133706. static MODEL_BASE_URL: string;
  133707. /**
  133708. * The name of the left controller model file
  133709. */
  133710. static MODEL_LEFT_FILENAME: string;
  133711. /**
  133712. * The name of the right controller model file
  133713. */
  133714. static MODEL_RIGHT_FILENAME: string;
  133715. /**
  133716. * The controller name prefix for this controller type
  133717. */
  133718. static readonly GAMEPAD_ID_PREFIX: string;
  133719. /**
  133720. * The controller id pattern for this controller type
  133721. */
  133722. private static readonly GAMEPAD_ID_PATTERN;
  133723. private _loadedMeshInfo;
  133724. protected readonly _mapping: {
  133725. buttons: string[];
  133726. buttonMeshNames: {
  133727. trigger: string;
  133728. menu: string;
  133729. grip: string;
  133730. thumbstick: string;
  133731. trackpad: string;
  133732. };
  133733. buttonObservableNames: {
  133734. trigger: string;
  133735. menu: string;
  133736. grip: string;
  133737. thumbstick: string;
  133738. trackpad: string;
  133739. };
  133740. axisMeshNames: string[];
  133741. pointingPoseMeshName: string;
  133742. };
  133743. /**
  133744. * Fired when the trackpad on this controller is clicked
  133745. */
  133746. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  133747. /**
  133748. * Fired when the trackpad on this controller is modified
  133749. */
  133750. onTrackpadValuesChangedObservable: Observable<StickValues>;
  133751. /**
  133752. * The current x and y values of this controller's trackpad
  133753. */
  133754. trackpad: StickValues;
  133755. /**
  133756. * Creates a new WindowsMotionController from a gamepad
  133757. * @param vrGamepad the gamepad that the controller should be created from
  133758. */
  133759. constructor(vrGamepad: any);
  133760. /**
  133761. * Fired when the trigger on this controller is modified
  133762. */
  133763. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133764. /**
  133765. * Fired when the menu button on this controller is modified
  133766. */
  133767. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133768. /**
  133769. * Fired when the grip button on this controller is modified
  133770. */
  133771. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133772. /**
  133773. * Fired when the thumbstick button on this controller is modified
  133774. */
  133775. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133776. /**
  133777. * Fired when the touchpad button on this controller is modified
  133778. */
  133779. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133780. /**
  133781. * Fired when the touchpad values on this controller are modified
  133782. */
  133783. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  133784. protected _updateTrackpad(): void;
  133785. /**
  133786. * Called once per frame by the engine.
  133787. */
  133788. update(): void;
  133789. /**
  133790. * Called once for each button that changed state since the last frame
  133791. * @param buttonIdx Which button index changed
  133792. * @param state New state of the button
  133793. * @param changes Which properties on the state changed since last frame
  133794. */
  133795. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  133796. /**
  133797. * Moves the buttons on the controller mesh based on their current state
  133798. * @param buttonName the name of the button to move
  133799. * @param buttonValue the value of the button which determines the buttons new position
  133800. */
  133801. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  133802. /**
  133803. * Moves the axis on the controller mesh based on its current state
  133804. * @param axis the index of the axis
  133805. * @param axisValue the value of the axis which determines the meshes new position
  133806. * @hidden
  133807. */
  133808. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  133809. /**
  133810. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  133811. * @param scene scene in which to add meshes
  133812. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  133813. */
  133814. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  133815. /**
  133816. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  133817. * can be transformed by button presses and axes values, based on this._mapping.
  133818. *
  133819. * @param scene scene in which the meshes exist
  133820. * @param meshes list of meshes that make up the controller model to process
  133821. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  133822. */
  133823. private processModel;
  133824. private createMeshInfo;
  133825. /**
  133826. * Gets the ray of the controller in the direction the controller is pointing
  133827. * @param length the length the resulting ray should be
  133828. * @returns a ray in the direction the controller is pointing
  133829. */
  133830. getForwardRay(length?: number): Ray;
  133831. /**
  133832. * Disposes of the controller
  133833. */
  133834. dispose(): void;
  133835. }
  133836. /**
  133837. * This class represents a new windows motion controller in XR.
  133838. */
  133839. export class XRWindowsMotionController extends WindowsMotionController {
  133840. /**
  133841. * Changing the original WIndowsMotionController mapping to fir the new mapping
  133842. */
  133843. protected readonly _mapping: {
  133844. buttons: string[];
  133845. buttonMeshNames: {
  133846. trigger: string;
  133847. menu: string;
  133848. grip: string;
  133849. thumbstick: string;
  133850. trackpad: string;
  133851. };
  133852. buttonObservableNames: {
  133853. trigger: string;
  133854. menu: string;
  133855. grip: string;
  133856. thumbstick: string;
  133857. trackpad: string;
  133858. };
  133859. axisMeshNames: string[];
  133860. pointingPoseMeshName: string;
  133861. };
  133862. /**
  133863. * Construct a new XR-Based windows motion controller
  133864. *
  133865. * @param gamepadInfo the gamepad object from the browser
  133866. */
  133867. constructor(gamepadInfo: any);
  133868. /**
  133869. * holds the thumbstick values (X,Y)
  133870. */
  133871. thumbstickValues: StickValues;
  133872. /**
  133873. * Fired when the thumbstick on this controller is clicked
  133874. */
  133875. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  133876. /**
  133877. * Fired when the thumbstick on this controller is modified
  133878. */
  133879. onThumbstickValuesChangedObservable: Observable<StickValues>;
  133880. /**
  133881. * Fired when the touchpad button on this controller is modified
  133882. */
  133883. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  133884. /**
  133885. * Fired when the touchpad values on this controller are modified
  133886. */
  133887. onTrackpadValuesChangedObservable: Observable<StickValues>;
  133888. /**
  133889. * Fired when the thumbstick button on this controller is modified
  133890. * here to prevent breaking changes
  133891. */
  133892. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  133893. /**
  133894. * updating the thumbstick(!) and not the trackpad.
  133895. * This is named this way due to the difference between WebVR and XR and to avoid
  133896. * changing the parent class.
  133897. */
  133898. protected _updateTrackpad(): void;
  133899. /**
  133900. * Disposes the class with joy
  133901. */
  133902. dispose(): void;
  133903. }
  133904. }
  133905. declare module BABYLON {
  133906. /**
  133907. * Class containing static functions to help procedurally build meshes
  133908. */
  133909. export class PolyhedronBuilder {
  133910. /**
  133911. * Creates a polyhedron mesh
  133912. * * 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
  133913. * * The parameter `size` (positive float, default 1) sets the polygon size
  133914. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  133915. * * 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`
  133916. * * 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
  133917. * * 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)`)
  133918. * * 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
  133919. * * 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
  133920. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  133921. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  133922. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  133923. * @param name defines the name of the mesh
  133924. * @param options defines the options used to create the mesh
  133925. * @param scene defines the hosting scene
  133926. * @returns the polyhedron mesh
  133927. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  133928. */
  133929. static CreatePolyhedron(name: string, options: {
  133930. type?: number;
  133931. size?: number;
  133932. sizeX?: number;
  133933. sizeY?: number;
  133934. sizeZ?: number;
  133935. custom?: any;
  133936. faceUV?: Vector4[];
  133937. faceColors?: Color4[];
  133938. flat?: boolean;
  133939. updatable?: boolean;
  133940. sideOrientation?: number;
  133941. frontUVs?: Vector4;
  133942. backUVs?: Vector4;
  133943. }, scene?: Nullable<Scene>): Mesh;
  133944. }
  133945. }
  133946. declare module BABYLON {
  133947. /**
  133948. * Gizmo that enables scaling a mesh along 3 axis
  133949. */
  133950. export class ScaleGizmo extends Gizmo {
  133951. /**
  133952. * Internal gizmo used for interactions on the x axis
  133953. */
  133954. xGizmo: AxisScaleGizmo;
  133955. /**
  133956. * Internal gizmo used for interactions on the y axis
  133957. */
  133958. yGizmo: AxisScaleGizmo;
  133959. /**
  133960. * Internal gizmo used for interactions on the z axis
  133961. */
  133962. zGizmo: AxisScaleGizmo;
  133963. /**
  133964. * Internal gizmo used to scale all axis equally
  133965. */
  133966. uniformScaleGizmo: AxisScaleGizmo;
  133967. private _meshAttached;
  133968. private _nodeAttached;
  133969. private _snapDistance;
  133970. private _uniformScalingMesh;
  133971. private _octahedron;
  133972. private _sensitivity;
  133973. /** Fires an event when any of it's sub gizmos are dragged */
  133974. onDragStartObservable: Observable<unknown>;
  133975. /** Fires an event when any of it's sub gizmos are released from dragging */
  133976. onDragEndObservable: Observable<unknown>;
  133977. get attachedMesh(): Nullable<AbstractMesh>;
  133978. set attachedMesh(mesh: Nullable<AbstractMesh>);
  133979. get attachedNode(): Nullable<Node>;
  133980. set attachedNode(node: Nullable<Node>);
  133981. /**
  133982. * True when the mouse pointer is hovering a gizmo mesh
  133983. */
  133984. get isHovered(): boolean;
  133985. /**
  133986. * Creates a ScaleGizmo
  133987. * @param gizmoLayer The utility layer the gizmo will be added to
  133988. * @param thickness display gizmo axis thickness
  133989. */
  133990. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  133991. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  133992. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  133993. /**
  133994. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133995. */
  133996. set snapDistance(value: number);
  133997. get snapDistance(): number;
  133998. /**
  133999. * Ratio for the scale of the gizmo (Default: 1)
  134000. */
  134001. set scaleRatio(value: number);
  134002. get scaleRatio(): number;
  134003. /**
  134004. * Sensitivity factor for dragging (Default: 1)
  134005. */
  134006. set sensitivity(value: number);
  134007. get sensitivity(): number;
  134008. /**
  134009. * Disposes of the gizmo
  134010. */
  134011. dispose(): void;
  134012. }
  134013. }
  134014. declare module BABYLON {
  134015. /**
  134016. * Single axis scale gizmo
  134017. */
  134018. export class AxisScaleGizmo extends Gizmo {
  134019. /**
  134020. * Drag behavior responsible for the gizmos dragging interactions
  134021. */
  134022. dragBehavior: PointerDragBehavior;
  134023. private _pointerObserver;
  134024. /**
  134025. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  134026. */
  134027. snapDistance: number;
  134028. /**
  134029. * Event that fires each time the gizmo snaps to a new location.
  134030. * * snapDistance is the the change in distance
  134031. */
  134032. onSnapObservable: Observable<{
  134033. snapDistance: number;
  134034. }>;
  134035. /**
  134036. * If the scaling operation should be done on all axis (default: false)
  134037. */
  134038. uniformScaling: boolean;
  134039. /**
  134040. * Custom sensitivity value for the drag strength
  134041. */
  134042. sensitivity: number;
  134043. private _isEnabled;
  134044. private _parent;
  134045. private _arrow;
  134046. private _coloredMaterial;
  134047. private _hoverMaterial;
  134048. /**
  134049. * Creates an AxisScaleGizmo
  134050. * @param gizmoLayer The utility layer the gizmo will be added to
  134051. * @param dragAxis The axis which the gizmo will be able to scale on
  134052. * @param color The color of the gizmo
  134053. * @param thickness display gizmo axis thickness
  134054. */
  134055. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  134056. protected _attachedNodeChanged(value: Nullable<Node>): void;
  134057. /**
  134058. * If the gizmo is enabled
  134059. */
  134060. set isEnabled(value: boolean);
  134061. get isEnabled(): boolean;
  134062. /**
  134063. * Disposes of the gizmo
  134064. */
  134065. dispose(): void;
  134066. /**
  134067. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  134068. * @param mesh The mesh to replace the default mesh of the gizmo
  134069. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  134070. */
  134071. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  134072. }
  134073. }
  134074. declare module BABYLON {
  134075. /**
  134076. * Bounding box gizmo
  134077. */
  134078. export class BoundingBoxGizmo extends Gizmo {
  134079. private _lineBoundingBox;
  134080. private _rotateSpheresParent;
  134081. private _scaleBoxesParent;
  134082. private _boundingDimensions;
  134083. private _renderObserver;
  134084. private _pointerObserver;
  134085. private _scaleDragSpeed;
  134086. private _tmpQuaternion;
  134087. private _tmpVector;
  134088. private _tmpRotationMatrix;
  134089. /**
  134090. * 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)
  134091. */
  134092. ignoreChildren: boolean;
  134093. /**
  134094. * 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)
  134095. */
  134096. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  134097. /**
  134098. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  134099. */
  134100. rotationSphereSize: number;
  134101. /**
  134102. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  134103. */
  134104. scaleBoxSize: number;
  134105. /**
  134106. * 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)
  134107. */
  134108. fixedDragMeshScreenSize: boolean;
  134109. /**
  134110. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  134111. */
  134112. fixedDragMeshScreenSizeDistanceFactor: number;
  134113. /**
  134114. * Fired when a rotation sphere or scale box is dragged
  134115. */
  134116. onDragStartObservable: Observable<{}>;
  134117. /**
  134118. * Fired when a scale box is dragged
  134119. */
  134120. onScaleBoxDragObservable: Observable<{}>;
  134121. /**
  134122. * Fired when a scale box drag is ended
  134123. */
  134124. onScaleBoxDragEndObservable: Observable<{}>;
  134125. /**
  134126. * Fired when a rotation sphere is dragged
  134127. */
  134128. onRotationSphereDragObservable: Observable<{}>;
  134129. /**
  134130. * Fired when a rotation sphere drag is ended
  134131. */
  134132. onRotationSphereDragEndObservable: Observable<{}>;
  134133. /**
  134134. * 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)
  134135. */
  134136. scalePivot: Nullable<Vector3>;
  134137. /**
  134138. * Mesh used as a pivot to rotate the attached node
  134139. */
  134140. private _anchorMesh;
  134141. private _existingMeshScale;
  134142. private _dragMesh;
  134143. private pointerDragBehavior;
  134144. private coloredMaterial;
  134145. private hoverColoredMaterial;
  134146. /**
  134147. * Sets the color of the bounding box gizmo
  134148. * @param color the color to set
  134149. */
  134150. setColor(color: Color3): void;
  134151. /**
  134152. * Creates an BoundingBoxGizmo
  134153. * @param gizmoLayer The utility layer the gizmo will be added to
  134154. * @param color The color of the gizmo
  134155. */
  134156. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  134157. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  134158. private _selectNode;
  134159. /**
  134160. * Updates the bounding box information for the Gizmo
  134161. */
  134162. updateBoundingBox(): void;
  134163. private _updateRotationSpheres;
  134164. private _updateScaleBoxes;
  134165. /**
  134166. * Enables rotation on the specified axis and disables rotation on the others
  134167. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  134168. */
  134169. setEnabledRotationAxis(axis: string): void;
  134170. /**
  134171. * Enables/disables scaling
  134172. * @param enable if scaling should be enabled
  134173. * @param homogeneousScaling defines if scaling should only be homogeneous
  134174. */
  134175. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  134176. private _updateDummy;
  134177. /**
  134178. * Enables a pointer drag behavior on the bounding box of the gizmo
  134179. */
  134180. enableDragBehavior(): void;
  134181. /**
  134182. * Disposes of the gizmo
  134183. */
  134184. dispose(): void;
  134185. /**
  134186. * 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)
  134187. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  134188. * @returns the bounding box mesh with the passed in mesh as a child
  134189. */
  134190. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  134191. /**
  134192. * CustomMeshes are not supported by this gizmo
  134193. * @param mesh The mesh to replace the default mesh of the gizmo
  134194. */
  134195. setCustomMesh(mesh: Mesh): void;
  134196. }
  134197. }
  134198. declare module BABYLON {
  134199. /**
  134200. * Single plane rotation gizmo
  134201. */
  134202. export class PlaneRotationGizmo extends Gizmo {
  134203. /**
  134204. * Drag behavior responsible for the gizmos dragging interactions
  134205. */
  134206. dragBehavior: PointerDragBehavior;
  134207. private _pointerObserver;
  134208. /**
  134209. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  134210. */
  134211. snapDistance: number;
  134212. /**
  134213. * Event that fires each time the gizmo snaps to a new location.
  134214. * * snapDistance is the the change in distance
  134215. */
  134216. onSnapObservable: Observable<{
  134217. snapDistance: number;
  134218. }>;
  134219. private _isEnabled;
  134220. private _parent;
  134221. /**
  134222. * Creates a PlaneRotationGizmo
  134223. * @param gizmoLayer The utility layer the gizmo will be added to
  134224. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  134225. * @param color The color of the gizmo
  134226. * @param tessellation Amount of tessellation to be used when creating rotation circles
  134227. * @param useEulerRotation Use and update Euler angle instead of quaternion
  134228. * @param thickness display gizmo axis thickness
  134229. */
  134230. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  134231. protected _attachedNodeChanged(value: Nullable<Node>): void;
  134232. /**
  134233. * If the gizmo is enabled
  134234. */
  134235. set isEnabled(value: boolean);
  134236. get isEnabled(): boolean;
  134237. /**
  134238. * Disposes of the gizmo
  134239. */
  134240. dispose(): void;
  134241. }
  134242. }
  134243. declare module BABYLON {
  134244. /**
  134245. * Gizmo that enables rotating a mesh along 3 axis
  134246. */
  134247. export class RotationGizmo extends Gizmo {
  134248. /**
  134249. * Internal gizmo used for interactions on the x axis
  134250. */
  134251. xGizmo: PlaneRotationGizmo;
  134252. /**
  134253. * Internal gizmo used for interactions on the y axis
  134254. */
  134255. yGizmo: PlaneRotationGizmo;
  134256. /**
  134257. * Internal gizmo used for interactions on the z axis
  134258. */
  134259. zGizmo: PlaneRotationGizmo;
  134260. /** Fires an event when any of it's sub gizmos are dragged */
  134261. onDragStartObservable: Observable<unknown>;
  134262. /** Fires an event when any of it's sub gizmos are released from dragging */
  134263. onDragEndObservable: Observable<unknown>;
  134264. private _meshAttached;
  134265. private _nodeAttached;
  134266. get attachedMesh(): Nullable<AbstractMesh>;
  134267. set attachedMesh(mesh: Nullable<AbstractMesh>);
  134268. get attachedNode(): Nullable<Node>;
  134269. set attachedNode(node: Nullable<Node>);
  134270. /**
  134271. * True when the mouse pointer is hovering a gizmo mesh
  134272. */
  134273. get isHovered(): boolean;
  134274. /**
  134275. * Creates a RotationGizmo
  134276. * @param gizmoLayer The utility layer the gizmo will be added to
  134277. * @param tessellation Amount of tessellation to be used when creating rotation circles
  134278. * @param useEulerRotation Use and update Euler angle instead of quaternion
  134279. * @param thickness display gizmo axis thickness
  134280. */
  134281. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  134282. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  134283. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  134284. /**
  134285. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  134286. */
  134287. set snapDistance(value: number);
  134288. get snapDistance(): number;
  134289. /**
  134290. * Ratio for the scale of the gizmo (Default: 1)
  134291. */
  134292. set scaleRatio(value: number);
  134293. get scaleRatio(): number;
  134294. /**
  134295. * Disposes of the gizmo
  134296. */
  134297. dispose(): void;
  134298. /**
  134299. * CustomMeshes are not supported by this gizmo
  134300. * @param mesh The mesh to replace the default mesh of the gizmo
  134301. */
  134302. setCustomMesh(mesh: Mesh): void;
  134303. }
  134304. }
  134305. declare module BABYLON {
  134306. /**
  134307. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  134308. */
  134309. export class GizmoManager implements IDisposable {
  134310. private scene;
  134311. /**
  134312. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  134313. */
  134314. gizmos: {
  134315. positionGizmo: Nullable<PositionGizmo>;
  134316. rotationGizmo: Nullable<RotationGizmo>;
  134317. scaleGizmo: Nullable<ScaleGizmo>;
  134318. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  134319. };
  134320. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  134321. clearGizmoOnEmptyPointerEvent: boolean;
  134322. /** Fires an event when the manager is attached to a mesh */
  134323. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  134324. /** Fires an event when the manager is attached to a node */
  134325. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  134326. private _gizmosEnabled;
  134327. private _pointerObserver;
  134328. private _attachedMesh;
  134329. private _attachedNode;
  134330. private _boundingBoxColor;
  134331. private _defaultUtilityLayer;
  134332. private _defaultKeepDepthUtilityLayer;
  134333. private _thickness;
  134334. /**
  134335. * When bounding box gizmo is enabled, this can be used to track drag/end events
  134336. */
  134337. boundingBoxDragBehavior: SixDofDragBehavior;
  134338. /**
  134339. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  134340. */
  134341. attachableMeshes: Nullable<Array<AbstractMesh>>;
  134342. /**
  134343. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  134344. */
  134345. attachableNodes: Nullable<Array<Node>>;
  134346. /**
  134347. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  134348. */
  134349. usePointerToAttachGizmos: boolean;
  134350. /**
  134351. * Utility layer that the bounding box gizmo belongs to
  134352. */
  134353. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  134354. /**
  134355. * Utility layer that all gizmos besides bounding box belong to
  134356. */
  134357. get utilityLayer(): UtilityLayerRenderer;
  134358. /**
  134359. * True when the mouse pointer is hovering a gizmo mesh
  134360. */
  134361. get isHovered(): boolean;
  134362. /**
  134363. * Instatiates a gizmo manager
  134364. * @param scene the scene to overlay the gizmos on top of
  134365. * @param thickness display gizmo axis thickness
  134366. */
  134367. constructor(scene: Scene, thickness?: number);
  134368. /**
  134369. * Attaches a set of gizmos to the specified mesh
  134370. * @param mesh The mesh the gizmo's should be attached to
  134371. */
  134372. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  134373. /**
  134374. * Attaches a set of gizmos to the specified node
  134375. * @param node The node the gizmo's should be attached to
  134376. */
  134377. attachToNode(node: Nullable<Node>): void;
  134378. /**
  134379. * If the position gizmo is enabled
  134380. */
  134381. set positionGizmoEnabled(value: boolean);
  134382. get positionGizmoEnabled(): boolean;
  134383. /**
  134384. * If the rotation gizmo is enabled
  134385. */
  134386. set rotationGizmoEnabled(value: boolean);
  134387. get rotationGizmoEnabled(): boolean;
  134388. /**
  134389. * If the scale gizmo is enabled
  134390. */
  134391. set scaleGizmoEnabled(value: boolean);
  134392. get scaleGizmoEnabled(): boolean;
  134393. /**
  134394. * If the boundingBox gizmo is enabled
  134395. */
  134396. set boundingBoxGizmoEnabled(value: boolean);
  134397. get boundingBoxGizmoEnabled(): boolean;
  134398. /**
  134399. * Disposes of the gizmo manager
  134400. */
  134401. dispose(): void;
  134402. }
  134403. }
  134404. declare module BABYLON {
  134405. /**
  134406. * A directional light is defined by a direction (what a surprise!).
  134407. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  134408. * 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.
  134409. * Documentation: https://doc.babylonjs.com/babylon101/lights
  134410. */
  134411. export class DirectionalLight extends ShadowLight {
  134412. private _shadowFrustumSize;
  134413. /**
  134414. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  134415. */
  134416. get shadowFrustumSize(): number;
  134417. /**
  134418. * Specifies a fix frustum size for the shadow generation.
  134419. */
  134420. set shadowFrustumSize(value: number);
  134421. private _shadowOrthoScale;
  134422. /**
  134423. * Gets the shadow projection scale against the optimal computed one.
  134424. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  134425. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  134426. */
  134427. get shadowOrthoScale(): number;
  134428. /**
  134429. * Sets the shadow projection scale against the optimal computed one.
  134430. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  134431. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  134432. */
  134433. set shadowOrthoScale(value: number);
  134434. /**
  134435. * Automatically compute the projection matrix to best fit (including all the casters)
  134436. * on each frame.
  134437. */
  134438. autoUpdateExtends: boolean;
  134439. /**
  134440. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  134441. * on each frame. autoUpdateExtends must be set to true for this to work
  134442. */
  134443. autoCalcShadowZBounds: boolean;
  134444. private _orthoLeft;
  134445. private _orthoRight;
  134446. private _orthoTop;
  134447. private _orthoBottom;
  134448. /**
  134449. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  134450. * The directional light is emitted from everywhere in the given direction.
  134451. * It can cast shadows.
  134452. * Documentation : https://doc.babylonjs.com/babylon101/lights
  134453. * @param name The friendly name of the light
  134454. * @param direction The direction of the light
  134455. * @param scene The scene the light belongs to
  134456. */
  134457. constructor(name: string, direction: Vector3, scene: Scene);
  134458. /**
  134459. * Returns the string "DirectionalLight".
  134460. * @return The class name
  134461. */
  134462. getClassName(): string;
  134463. /**
  134464. * Returns the integer 1.
  134465. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  134466. */
  134467. getTypeID(): number;
  134468. /**
  134469. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  134470. * Returns the DirectionalLight Shadow projection matrix.
  134471. */
  134472. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  134473. /**
  134474. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  134475. * Returns the DirectionalLight Shadow projection matrix.
  134476. */
  134477. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  134478. /**
  134479. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  134480. * Returns the DirectionalLight Shadow projection matrix.
  134481. */
  134482. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  134483. protected _buildUniformLayout(): void;
  134484. /**
  134485. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  134486. * @param effect The effect to update
  134487. * @param lightIndex The index of the light in the effect to update
  134488. * @returns The directional light
  134489. */
  134490. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  134491. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  134492. /**
  134493. * Gets the minZ used for shadow according to both the scene and the light.
  134494. *
  134495. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  134496. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  134497. * @param activeCamera The camera we are returning the min for
  134498. * @returns the depth min z
  134499. */
  134500. getDepthMinZ(activeCamera: Camera): number;
  134501. /**
  134502. * Gets the maxZ used for shadow according to both the scene and the light.
  134503. *
  134504. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  134505. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  134506. * @param activeCamera The camera we are returning the max for
  134507. * @returns the depth max z
  134508. */
  134509. getDepthMaxZ(activeCamera: Camera): number;
  134510. /**
  134511. * Prepares the list of defines specific to the light type.
  134512. * @param defines the list of defines
  134513. * @param lightIndex defines the index of the light for the effect
  134514. */
  134515. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  134516. }
  134517. }
  134518. declare module BABYLON {
  134519. /**
  134520. * Class containing static functions to help procedurally build meshes
  134521. */
  134522. export class HemisphereBuilder {
  134523. /**
  134524. * Creates a hemisphere mesh
  134525. * @param name defines the name of the mesh
  134526. * @param options defines the options used to create the mesh
  134527. * @param scene defines the hosting scene
  134528. * @returns the hemisphere mesh
  134529. */
  134530. static CreateHemisphere(name: string, options: {
  134531. segments?: number;
  134532. diameter?: number;
  134533. sideOrientation?: number;
  134534. }, scene: any): Mesh;
  134535. }
  134536. }
  134537. declare module BABYLON {
  134538. /**
  134539. * A spot light is defined by a position, a direction, an angle, and an exponent.
  134540. * These values define a cone of light starting from the position, emitting toward the direction.
  134541. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  134542. * and the exponent defines the speed of the decay of the light with distance (reach).
  134543. * Documentation: https://doc.babylonjs.com/babylon101/lights
  134544. */
  134545. export class SpotLight extends ShadowLight {
  134546. private _angle;
  134547. private _innerAngle;
  134548. private _cosHalfAngle;
  134549. private _lightAngleScale;
  134550. private _lightAngleOffset;
  134551. /**
  134552. * Gets the cone angle of the spot light in Radians.
  134553. */
  134554. get angle(): number;
  134555. /**
  134556. * Sets the cone angle of the spot light in Radians.
  134557. */
  134558. set angle(value: number);
  134559. /**
  134560. * Only used in gltf falloff mode, this defines the angle where
  134561. * the directional falloff will start before cutting at angle which could be seen
  134562. * as outer angle.
  134563. */
  134564. get innerAngle(): number;
  134565. /**
  134566. * Only used in gltf falloff mode, this defines the angle where
  134567. * the directional falloff will start before cutting at angle which could be seen
  134568. * as outer angle.
  134569. */
  134570. set innerAngle(value: number);
  134571. private _shadowAngleScale;
  134572. /**
  134573. * Allows scaling the angle of the light for shadow generation only.
  134574. */
  134575. get shadowAngleScale(): number;
  134576. /**
  134577. * Allows scaling the angle of the light for shadow generation only.
  134578. */
  134579. set shadowAngleScale(value: number);
  134580. /**
  134581. * The light decay speed with the distance from the emission spot.
  134582. */
  134583. exponent: number;
  134584. private _projectionTextureMatrix;
  134585. /**
  134586. * Allows reading the projecton texture
  134587. */
  134588. get projectionTextureMatrix(): Matrix;
  134589. protected _projectionTextureLightNear: number;
  134590. /**
  134591. * Gets the near clip of the Spotlight for texture projection.
  134592. */
  134593. get projectionTextureLightNear(): number;
  134594. /**
  134595. * Sets the near clip of the Spotlight for texture projection.
  134596. */
  134597. set projectionTextureLightNear(value: number);
  134598. protected _projectionTextureLightFar: number;
  134599. /**
  134600. * Gets the far clip of the Spotlight for texture projection.
  134601. */
  134602. get projectionTextureLightFar(): number;
  134603. /**
  134604. * Sets the far clip of the Spotlight for texture projection.
  134605. */
  134606. set projectionTextureLightFar(value: number);
  134607. protected _projectionTextureUpDirection: Vector3;
  134608. /**
  134609. * Gets the Up vector of the Spotlight for texture projection.
  134610. */
  134611. get projectionTextureUpDirection(): Vector3;
  134612. /**
  134613. * Sets the Up vector of the Spotlight for texture projection.
  134614. */
  134615. set projectionTextureUpDirection(value: Vector3);
  134616. private _projectionTexture;
  134617. /**
  134618. * Gets the projection texture of the light.
  134619. */
  134620. get projectionTexture(): Nullable<BaseTexture>;
  134621. /**
  134622. * Sets the projection texture of the light.
  134623. */
  134624. set projectionTexture(value: Nullable<BaseTexture>);
  134625. private _projectionTextureViewLightDirty;
  134626. private _projectionTextureProjectionLightDirty;
  134627. private _projectionTextureDirty;
  134628. private _projectionTextureViewTargetVector;
  134629. private _projectionTextureViewLightMatrix;
  134630. private _projectionTextureProjectionLightMatrix;
  134631. private _projectionTextureScalingMatrix;
  134632. /**
  134633. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  134634. * It can cast shadows.
  134635. * Documentation : https://doc.babylonjs.com/babylon101/lights
  134636. * @param name The light friendly name
  134637. * @param position The position of the spot light in the scene
  134638. * @param direction The direction of the light in the scene
  134639. * @param angle The cone angle of the light in Radians
  134640. * @param exponent The light decay speed with the distance from the emission spot
  134641. * @param scene The scene the lights belongs to
  134642. */
  134643. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  134644. /**
  134645. * Returns the string "SpotLight".
  134646. * @returns the class name
  134647. */
  134648. getClassName(): string;
  134649. /**
  134650. * Returns the integer 2.
  134651. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  134652. */
  134653. getTypeID(): number;
  134654. /**
  134655. * Overrides the direction setter to recompute the projection texture view light Matrix.
  134656. */
  134657. protected _setDirection(value: Vector3): void;
  134658. /**
  134659. * Overrides the position setter to recompute the projection texture view light Matrix.
  134660. */
  134661. protected _setPosition(value: Vector3): void;
  134662. /**
  134663. * 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.
  134664. * Returns the SpotLight.
  134665. */
  134666. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  134667. protected _computeProjectionTextureViewLightMatrix(): void;
  134668. protected _computeProjectionTextureProjectionLightMatrix(): void;
  134669. /**
  134670. * Main function for light texture projection matrix computing.
  134671. */
  134672. protected _computeProjectionTextureMatrix(): void;
  134673. protected _buildUniformLayout(): void;
  134674. private _computeAngleValues;
  134675. /**
  134676. * Sets the passed Effect "effect" with the Light textures.
  134677. * @param effect The effect to update
  134678. * @param lightIndex The index of the light in the effect to update
  134679. * @returns The light
  134680. */
  134681. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  134682. /**
  134683. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  134684. * @param effect The effect to update
  134685. * @param lightIndex The index of the light in the effect to update
  134686. * @returns The spot light
  134687. */
  134688. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  134689. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  134690. /**
  134691. * Disposes the light and the associated resources.
  134692. */
  134693. dispose(): void;
  134694. /**
  134695. * Prepares the list of defines specific to the light type.
  134696. * @param defines the list of defines
  134697. * @param lightIndex defines the index of the light for the effect
  134698. */
  134699. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  134700. }
  134701. }
  134702. declare module BABYLON {
  134703. /**
  134704. * Gizmo that enables viewing a light
  134705. */
  134706. export class LightGizmo extends Gizmo {
  134707. private _lightMesh;
  134708. private _material;
  134709. private _cachedPosition;
  134710. private _cachedForward;
  134711. private _attachedMeshParent;
  134712. private _pointerObserver;
  134713. /**
  134714. * Event that fires each time the gizmo is clicked
  134715. */
  134716. onClickedObservable: Observable<Light>;
  134717. /**
  134718. * Creates a LightGizmo
  134719. * @param gizmoLayer The utility layer the gizmo will be added to
  134720. */
  134721. constructor(gizmoLayer?: UtilityLayerRenderer);
  134722. private _light;
  134723. /**
  134724. * The light that the gizmo is attached to
  134725. */
  134726. set light(light: Nullable<Light>);
  134727. get light(): Nullable<Light>;
  134728. /**
  134729. * Gets the material used to render the light gizmo
  134730. */
  134731. get material(): StandardMaterial;
  134732. /**
  134733. * @hidden
  134734. * Updates the gizmo to match the attached mesh's position/rotation
  134735. */
  134736. protected _update(): void;
  134737. private static _Scale;
  134738. /**
  134739. * Creates the lines for a light mesh
  134740. */
  134741. private static _CreateLightLines;
  134742. /**
  134743. * Disposes of the light gizmo
  134744. */
  134745. dispose(): void;
  134746. private static _CreateHemisphericLightMesh;
  134747. private static _CreatePointLightMesh;
  134748. private static _CreateSpotLightMesh;
  134749. private static _CreateDirectionalLightMesh;
  134750. }
  134751. }
  134752. declare module BABYLON {
  134753. /**
  134754. * Gizmo that enables viewing a camera
  134755. */
  134756. export class CameraGizmo extends Gizmo {
  134757. private _cameraMesh;
  134758. private _cameraLinesMesh;
  134759. private _material;
  134760. private _pointerObserver;
  134761. /**
  134762. * Event that fires each time the gizmo is clicked
  134763. */
  134764. onClickedObservable: Observable<Camera>;
  134765. /**
  134766. * Creates a CameraGizmo
  134767. * @param gizmoLayer The utility layer the gizmo will be added to
  134768. */
  134769. constructor(gizmoLayer?: UtilityLayerRenderer);
  134770. private _camera;
  134771. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  134772. get displayFrustum(): boolean;
  134773. set displayFrustum(value: boolean);
  134774. /**
  134775. * The camera that the gizmo is attached to
  134776. */
  134777. set camera(camera: Nullable<Camera>);
  134778. get camera(): Nullable<Camera>;
  134779. /**
  134780. * Gets the material used to render the camera gizmo
  134781. */
  134782. get material(): StandardMaterial;
  134783. /**
  134784. * @hidden
  134785. * Updates the gizmo to match the attached mesh's position/rotation
  134786. */
  134787. protected _update(): void;
  134788. private static _Scale;
  134789. private _invProjection;
  134790. /**
  134791. * Disposes of the camera gizmo
  134792. */
  134793. dispose(): void;
  134794. private static _CreateCameraMesh;
  134795. private static _CreateCameraFrustum;
  134796. }
  134797. }
  134798. declare module BABYLON {
  134799. /** @hidden */
  134800. export var backgroundFragmentDeclaration: {
  134801. name: string;
  134802. shader: string;
  134803. };
  134804. }
  134805. declare module BABYLON {
  134806. /** @hidden */
  134807. export var backgroundUboDeclaration: {
  134808. name: string;
  134809. shader: string;
  134810. };
  134811. }
  134812. declare module BABYLON {
  134813. /** @hidden */
  134814. export var backgroundPixelShader: {
  134815. name: string;
  134816. shader: string;
  134817. };
  134818. }
  134819. declare module BABYLON {
  134820. /** @hidden */
  134821. export var backgroundVertexDeclaration: {
  134822. name: string;
  134823. shader: string;
  134824. };
  134825. }
  134826. declare module BABYLON {
  134827. /** @hidden */
  134828. export var backgroundVertexShader: {
  134829. name: string;
  134830. shader: string;
  134831. };
  134832. }
  134833. declare module BABYLON {
  134834. /**
  134835. * Background material used to create an efficient environement around your scene.
  134836. */
  134837. export class BackgroundMaterial extends PushMaterial {
  134838. /**
  134839. * Standard reflectance value at parallel view angle.
  134840. */
  134841. static StandardReflectance0: number;
  134842. /**
  134843. * Standard reflectance value at grazing angle.
  134844. */
  134845. static StandardReflectance90: number;
  134846. protected _primaryColor: Color3;
  134847. /**
  134848. * Key light Color (multiply against the environement texture)
  134849. */
  134850. primaryColor: Color3;
  134851. protected __perceptualColor: Nullable<Color3>;
  134852. /**
  134853. * Experimental Internal Use Only.
  134854. *
  134855. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  134856. * This acts as a helper to set the primary color to a more "human friendly" value.
  134857. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  134858. * output color as close as possible from the chosen value.
  134859. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  134860. * part of lighting setup.)
  134861. */
  134862. get _perceptualColor(): Nullable<Color3>;
  134863. set _perceptualColor(value: Nullable<Color3>);
  134864. protected _primaryColorShadowLevel: float;
  134865. /**
  134866. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  134867. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  134868. */
  134869. get primaryColorShadowLevel(): float;
  134870. set primaryColorShadowLevel(value: float);
  134871. protected _primaryColorHighlightLevel: float;
  134872. /**
  134873. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  134874. * The primary color is used at the level chosen to define what the white area would look.
  134875. */
  134876. get primaryColorHighlightLevel(): float;
  134877. set primaryColorHighlightLevel(value: float);
  134878. protected _reflectionTexture: Nullable<BaseTexture>;
  134879. /**
  134880. * Reflection Texture used in the material.
  134881. * Should be author in a specific way for the best result (refer to the documentation).
  134882. */
  134883. reflectionTexture: Nullable<BaseTexture>;
  134884. protected _reflectionBlur: float;
  134885. /**
  134886. * Reflection Texture level of blur.
  134887. *
  134888. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  134889. * texture twice.
  134890. */
  134891. reflectionBlur: float;
  134892. protected _diffuseTexture: Nullable<BaseTexture>;
  134893. /**
  134894. * Diffuse Texture used in the material.
  134895. * Should be author in a specific way for the best result (refer to the documentation).
  134896. */
  134897. diffuseTexture: Nullable<BaseTexture>;
  134898. protected _shadowLights: Nullable<IShadowLight[]>;
  134899. /**
  134900. * Specify the list of lights casting shadow on the material.
  134901. * All scene shadow lights will be included if null.
  134902. */
  134903. shadowLights: Nullable<IShadowLight[]>;
  134904. protected _shadowLevel: float;
  134905. /**
  134906. * Helps adjusting the shadow to a softer level if required.
  134907. * 0 means black shadows and 1 means no shadows.
  134908. */
  134909. shadowLevel: float;
  134910. protected _sceneCenter: Vector3;
  134911. /**
  134912. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  134913. * It is usually zero but might be interesting to modify according to your setup.
  134914. */
  134915. sceneCenter: Vector3;
  134916. protected _opacityFresnel: boolean;
  134917. /**
  134918. * This helps specifying that the material is falling off to the sky box at grazing angle.
  134919. * This helps ensuring a nice transition when the camera goes under the ground.
  134920. */
  134921. opacityFresnel: boolean;
  134922. protected _reflectionFresnel: boolean;
  134923. /**
  134924. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  134925. * This helps adding a mirror texture on the ground.
  134926. */
  134927. reflectionFresnel: boolean;
  134928. protected _reflectionFalloffDistance: number;
  134929. /**
  134930. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  134931. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  134932. */
  134933. reflectionFalloffDistance: number;
  134934. protected _reflectionAmount: number;
  134935. /**
  134936. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  134937. */
  134938. reflectionAmount: number;
  134939. protected _reflectionReflectance0: number;
  134940. /**
  134941. * This specifies the weight of the reflection at grazing angle.
  134942. */
  134943. reflectionReflectance0: number;
  134944. protected _reflectionReflectance90: number;
  134945. /**
  134946. * This specifies the weight of the reflection at a perpendicular point of view.
  134947. */
  134948. reflectionReflectance90: number;
  134949. /**
  134950. * Sets the reflection reflectance fresnel values according to the default standard
  134951. * empirically know to work well :-)
  134952. */
  134953. set reflectionStandardFresnelWeight(value: number);
  134954. protected _useRGBColor: boolean;
  134955. /**
  134956. * Helps to directly use the maps channels instead of their level.
  134957. */
  134958. useRGBColor: boolean;
  134959. protected _enableNoise: boolean;
  134960. /**
  134961. * This helps reducing the banding effect that could occur on the background.
  134962. */
  134963. enableNoise: boolean;
  134964. /**
  134965. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  134966. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  134967. * Recommended to be keep at 1.0 except for special cases.
  134968. */
  134969. get fovMultiplier(): number;
  134970. set fovMultiplier(value: number);
  134971. private _fovMultiplier;
  134972. /**
  134973. * Enable the FOV adjustment feature controlled by fovMultiplier.
  134974. */
  134975. useEquirectangularFOV: boolean;
  134976. private _maxSimultaneousLights;
  134977. /**
  134978. * Number of Simultaneous lights allowed on the material.
  134979. */
  134980. maxSimultaneousLights: int;
  134981. private _shadowOnly;
  134982. /**
  134983. * Make the material only render shadows
  134984. */
  134985. shadowOnly: boolean;
  134986. /**
  134987. * Default configuration related to image processing available in the Background Material.
  134988. */
  134989. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  134990. /**
  134991. * Keep track of the image processing observer to allow dispose and replace.
  134992. */
  134993. private _imageProcessingObserver;
  134994. /**
  134995. * Attaches a new image processing configuration to the PBR Material.
  134996. * @param configuration (if null the scene configuration will be use)
  134997. */
  134998. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  134999. /**
  135000. * Gets the image processing configuration used either in this material.
  135001. */
  135002. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  135003. /**
  135004. * Sets the Default image processing configuration used either in the this material.
  135005. *
  135006. * If sets to null, the scene one is in use.
  135007. */
  135008. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  135009. /**
  135010. * Gets wether the color curves effect is enabled.
  135011. */
  135012. get cameraColorCurvesEnabled(): boolean;
  135013. /**
  135014. * Sets wether the color curves effect is enabled.
  135015. */
  135016. set cameraColorCurvesEnabled(value: boolean);
  135017. /**
  135018. * Gets wether the color grading effect is enabled.
  135019. */
  135020. get cameraColorGradingEnabled(): boolean;
  135021. /**
  135022. * Gets wether the color grading effect is enabled.
  135023. */
  135024. set cameraColorGradingEnabled(value: boolean);
  135025. /**
  135026. * Gets wether tonemapping is enabled or not.
  135027. */
  135028. get cameraToneMappingEnabled(): boolean;
  135029. /**
  135030. * Sets wether tonemapping is enabled or not
  135031. */
  135032. set cameraToneMappingEnabled(value: boolean);
  135033. /**
  135034. * The camera exposure used on this material.
  135035. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  135036. * This corresponds to a photographic exposure.
  135037. */
  135038. get cameraExposure(): float;
  135039. /**
  135040. * The camera exposure used on this material.
  135041. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  135042. * This corresponds to a photographic exposure.
  135043. */
  135044. set cameraExposure(value: float);
  135045. /**
  135046. * Gets The camera contrast used on this material.
  135047. */
  135048. get cameraContrast(): float;
  135049. /**
  135050. * Sets The camera contrast used on this material.
  135051. */
  135052. set cameraContrast(value: float);
  135053. /**
  135054. * Gets the Color Grading 2D Lookup Texture.
  135055. */
  135056. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  135057. /**
  135058. * Sets the Color Grading 2D Lookup Texture.
  135059. */
  135060. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  135061. /**
  135062. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  135063. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  135064. * 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;
  135065. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  135066. */
  135067. get cameraColorCurves(): Nullable<ColorCurves>;
  135068. /**
  135069. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  135070. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  135071. * 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;
  135072. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  135073. */
  135074. set cameraColorCurves(value: Nullable<ColorCurves>);
  135075. /**
  135076. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  135077. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  135078. */
  135079. switchToBGR: boolean;
  135080. private _renderTargets;
  135081. private _reflectionControls;
  135082. private _white;
  135083. private _primaryShadowColor;
  135084. private _primaryHighlightColor;
  135085. /**
  135086. * Instantiates a Background Material in the given scene
  135087. * @param name The friendly name of the material
  135088. * @param scene The scene to add the material to
  135089. */
  135090. constructor(name: string, scene: Scene);
  135091. /**
  135092. * Gets a boolean indicating that current material needs to register RTT
  135093. */
  135094. get hasRenderTargetTextures(): boolean;
  135095. /**
  135096. * The entire material has been created in order to prevent overdraw.
  135097. * @returns false
  135098. */
  135099. needAlphaTesting(): boolean;
  135100. /**
  135101. * The entire material has been created in order to prevent overdraw.
  135102. * @returns true if blending is enable
  135103. */
  135104. needAlphaBlending(): boolean;
  135105. /**
  135106. * Checks wether the material is ready to be rendered for a given mesh.
  135107. * @param mesh The mesh to render
  135108. * @param subMesh The submesh to check against
  135109. * @param useInstances Specify wether or not the material is used with instances
  135110. * @returns true if all the dependencies are ready (Textures, Effects...)
  135111. */
  135112. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  135113. /**
  135114. * Compute the primary color according to the chosen perceptual color.
  135115. */
  135116. private _computePrimaryColorFromPerceptualColor;
  135117. /**
  135118. * Compute the highlights and shadow colors according to their chosen levels.
  135119. */
  135120. private _computePrimaryColors;
  135121. /**
  135122. * Build the uniform buffer used in the material.
  135123. */
  135124. buildUniformLayout(): void;
  135125. /**
  135126. * Unbind the material.
  135127. */
  135128. unbind(): void;
  135129. /**
  135130. * Bind only the world matrix to the material.
  135131. * @param world The world matrix to bind.
  135132. */
  135133. bindOnlyWorldMatrix(world: Matrix): void;
  135134. /**
  135135. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  135136. * @param world The world matrix to bind.
  135137. * @param subMesh The submesh to bind for.
  135138. */
  135139. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  135140. /**
  135141. * Checks to see if a texture is used in the material.
  135142. * @param texture - Base texture to use.
  135143. * @returns - Boolean specifying if a texture is used in the material.
  135144. */
  135145. hasTexture(texture: BaseTexture): boolean;
  135146. /**
  135147. * Dispose the material.
  135148. * @param forceDisposeEffect Force disposal of the associated effect.
  135149. * @param forceDisposeTextures Force disposal of the associated textures.
  135150. */
  135151. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  135152. /**
  135153. * Clones the material.
  135154. * @param name The cloned name.
  135155. * @returns The cloned material.
  135156. */
  135157. clone(name: string): BackgroundMaterial;
  135158. /**
  135159. * Serializes the current material to its JSON representation.
  135160. * @returns The JSON representation.
  135161. */
  135162. serialize(): any;
  135163. /**
  135164. * Gets the class name of the material
  135165. * @returns "BackgroundMaterial"
  135166. */
  135167. getClassName(): string;
  135168. /**
  135169. * Parse a JSON input to create back a background material.
  135170. * @param source The JSON data to parse
  135171. * @param scene The scene to create the parsed material in
  135172. * @param rootUrl The root url of the assets the material depends upon
  135173. * @returns the instantiated BackgroundMaterial.
  135174. */
  135175. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  135176. }
  135177. }
  135178. declare module BABYLON {
  135179. /**
  135180. * Represents the different options available during the creation of
  135181. * a Environment helper.
  135182. *
  135183. * This can control the default ground, skybox and image processing setup of your scene.
  135184. */
  135185. export interface IEnvironmentHelperOptions {
  135186. /**
  135187. * Specifies whether or not to create a ground.
  135188. * True by default.
  135189. */
  135190. createGround: boolean;
  135191. /**
  135192. * Specifies the ground size.
  135193. * 15 by default.
  135194. */
  135195. groundSize: number;
  135196. /**
  135197. * The texture used on the ground for the main color.
  135198. * Comes from the BabylonJS CDN by default.
  135199. *
  135200. * Remarks: Can be either a texture or a url.
  135201. */
  135202. groundTexture: string | BaseTexture;
  135203. /**
  135204. * The color mixed in the ground texture by default.
  135205. * BabylonJS clearColor by default.
  135206. */
  135207. groundColor: Color3;
  135208. /**
  135209. * Specifies the ground opacity.
  135210. * 1 by default.
  135211. */
  135212. groundOpacity: number;
  135213. /**
  135214. * Enables the ground to receive shadows.
  135215. * True by default.
  135216. */
  135217. enableGroundShadow: boolean;
  135218. /**
  135219. * Helps preventing the shadow to be fully black on the ground.
  135220. * 0.5 by default.
  135221. */
  135222. groundShadowLevel: number;
  135223. /**
  135224. * Creates a mirror texture attach to the ground.
  135225. * false by default.
  135226. */
  135227. enableGroundMirror: boolean;
  135228. /**
  135229. * Specifies the ground mirror size ratio.
  135230. * 0.3 by default as the default kernel is 64.
  135231. */
  135232. groundMirrorSizeRatio: number;
  135233. /**
  135234. * Specifies the ground mirror blur kernel size.
  135235. * 64 by default.
  135236. */
  135237. groundMirrorBlurKernel: number;
  135238. /**
  135239. * Specifies the ground mirror visibility amount.
  135240. * 1 by default
  135241. */
  135242. groundMirrorAmount: number;
  135243. /**
  135244. * Specifies the ground mirror reflectance weight.
  135245. * This uses the standard weight of the background material to setup the fresnel effect
  135246. * of the mirror.
  135247. * 1 by default.
  135248. */
  135249. groundMirrorFresnelWeight: number;
  135250. /**
  135251. * Specifies the ground mirror Falloff distance.
  135252. * This can helps reducing the size of the reflection.
  135253. * 0 by Default.
  135254. */
  135255. groundMirrorFallOffDistance: number;
  135256. /**
  135257. * Specifies the ground mirror texture type.
  135258. * Unsigned Int by Default.
  135259. */
  135260. groundMirrorTextureType: number;
  135261. /**
  135262. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  135263. * the shown objects.
  135264. */
  135265. groundYBias: number;
  135266. /**
  135267. * Specifies whether or not to create a skybox.
  135268. * True by default.
  135269. */
  135270. createSkybox: boolean;
  135271. /**
  135272. * Specifies the skybox size.
  135273. * 20 by default.
  135274. */
  135275. skyboxSize: number;
  135276. /**
  135277. * The texture used on the skybox for the main color.
  135278. * Comes from the BabylonJS CDN by default.
  135279. *
  135280. * Remarks: Can be either a texture or a url.
  135281. */
  135282. skyboxTexture: string | BaseTexture;
  135283. /**
  135284. * The color mixed in the skybox texture by default.
  135285. * BabylonJS clearColor by default.
  135286. */
  135287. skyboxColor: Color3;
  135288. /**
  135289. * The background rotation around the Y axis of the scene.
  135290. * This helps aligning the key lights of your scene with the background.
  135291. * 0 by default.
  135292. */
  135293. backgroundYRotation: number;
  135294. /**
  135295. * Compute automatically the size of the elements to best fit with the scene.
  135296. */
  135297. sizeAuto: boolean;
  135298. /**
  135299. * Default position of the rootMesh if autoSize is not true.
  135300. */
  135301. rootPosition: Vector3;
  135302. /**
  135303. * Sets up the image processing in the scene.
  135304. * true by default.
  135305. */
  135306. setupImageProcessing: boolean;
  135307. /**
  135308. * The texture used as your environment texture in the scene.
  135309. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  135310. *
  135311. * Remarks: Can be either a texture or a url.
  135312. */
  135313. environmentTexture: string | BaseTexture;
  135314. /**
  135315. * The value of the exposure to apply to the scene.
  135316. * 0.6 by default if setupImageProcessing is true.
  135317. */
  135318. cameraExposure: number;
  135319. /**
  135320. * The value of the contrast to apply to the scene.
  135321. * 1.6 by default if setupImageProcessing is true.
  135322. */
  135323. cameraContrast: number;
  135324. /**
  135325. * Specifies whether or not tonemapping should be enabled in the scene.
  135326. * true by default if setupImageProcessing is true.
  135327. */
  135328. toneMappingEnabled: boolean;
  135329. }
  135330. /**
  135331. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  135332. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  135333. * It also helps with the default setup of your imageProcessing configuration.
  135334. */
  135335. export class EnvironmentHelper {
  135336. /**
  135337. * Default ground texture URL.
  135338. */
  135339. private static _groundTextureCDNUrl;
  135340. /**
  135341. * Default skybox texture URL.
  135342. */
  135343. private static _skyboxTextureCDNUrl;
  135344. /**
  135345. * Default environment texture URL.
  135346. */
  135347. private static _environmentTextureCDNUrl;
  135348. /**
  135349. * Creates the default options for the helper.
  135350. */
  135351. private static _getDefaultOptions;
  135352. private _rootMesh;
  135353. /**
  135354. * Gets the root mesh created by the helper.
  135355. */
  135356. get rootMesh(): Mesh;
  135357. private _skybox;
  135358. /**
  135359. * Gets the skybox created by the helper.
  135360. */
  135361. get skybox(): Nullable<Mesh>;
  135362. private _skyboxTexture;
  135363. /**
  135364. * Gets the skybox texture created by the helper.
  135365. */
  135366. get skyboxTexture(): Nullable<BaseTexture>;
  135367. private _skyboxMaterial;
  135368. /**
  135369. * Gets the skybox material created by the helper.
  135370. */
  135371. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  135372. private _ground;
  135373. /**
  135374. * Gets the ground mesh created by the helper.
  135375. */
  135376. get ground(): Nullable<Mesh>;
  135377. private _groundTexture;
  135378. /**
  135379. * Gets the ground texture created by the helper.
  135380. */
  135381. get groundTexture(): Nullable<BaseTexture>;
  135382. private _groundMirror;
  135383. /**
  135384. * Gets the ground mirror created by the helper.
  135385. */
  135386. get groundMirror(): Nullable<MirrorTexture>;
  135387. /**
  135388. * Gets the ground mirror render list to helps pushing the meshes
  135389. * you wish in the ground reflection.
  135390. */
  135391. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  135392. private _groundMaterial;
  135393. /**
  135394. * Gets the ground material created by the helper.
  135395. */
  135396. get groundMaterial(): Nullable<BackgroundMaterial>;
  135397. /**
  135398. * Stores the creation options.
  135399. */
  135400. private readonly _scene;
  135401. private _options;
  135402. /**
  135403. * This observable will be notified with any error during the creation of the environment,
  135404. * mainly texture creation errors.
  135405. */
  135406. onErrorObservable: Observable<{
  135407. message?: string;
  135408. exception?: any;
  135409. }>;
  135410. /**
  135411. * constructor
  135412. * @param options Defines the options we want to customize the helper
  135413. * @param scene The scene to add the material to
  135414. */
  135415. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  135416. /**
  135417. * Updates the background according to the new options
  135418. * @param options
  135419. */
  135420. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  135421. /**
  135422. * Sets the primary color of all the available elements.
  135423. * @param color the main color to affect to the ground and the background
  135424. */
  135425. setMainColor(color: Color3): void;
  135426. /**
  135427. * Setup the image processing according to the specified options.
  135428. */
  135429. private _setupImageProcessing;
  135430. /**
  135431. * Setup the environment texture according to the specified options.
  135432. */
  135433. private _setupEnvironmentTexture;
  135434. /**
  135435. * Setup the background according to the specified options.
  135436. */
  135437. private _setupBackground;
  135438. /**
  135439. * Get the scene sizes according to the setup.
  135440. */
  135441. private _getSceneSize;
  135442. /**
  135443. * Setup the ground according to the specified options.
  135444. */
  135445. private _setupGround;
  135446. /**
  135447. * Setup the ground material according to the specified options.
  135448. */
  135449. private _setupGroundMaterial;
  135450. /**
  135451. * Setup the ground diffuse texture according to the specified options.
  135452. */
  135453. private _setupGroundDiffuseTexture;
  135454. /**
  135455. * Setup the ground mirror texture according to the specified options.
  135456. */
  135457. private _setupGroundMirrorTexture;
  135458. /**
  135459. * Setup the ground to receive the mirror texture.
  135460. */
  135461. private _setupMirrorInGroundMaterial;
  135462. /**
  135463. * Setup the skybox according to the specified options.
  135464. */
  135465. private _setupSkybox;
  135466. /**
  135467. * Setup the skybox material according to the specified options.
  135468. */
  135469. private _setupSkyboxMaterial;
  135470. /**
  135471. * Setup the skybox reflection texture according to the specified options.
  135472. */
  135473. private _setupSkyboxReflectionTexture;
  135474. private _errorHandler;
  135475. /**
  135476. * Dispose all the elements created by the Helper.
  135477. */
  135478. dispose(): void;
  135479. }
  135480. }
  135481. declare module BABYLON {
  135482. /**
  135483. * Display a 360/180 degree texture on an approximately spherical surface, useful for VR applications or skyboxes.
  135484. * As a subclass of TransformNode, this allow parenting to the camera or multiple textures with different locations in the scene.
  135485. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  135486. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  135487. */
  135488. export abstract class TextureDome<T extends Texture> extends TransformNode {
  135489. protected onError: Nullable<(message?: string, exception?: any) => void>;
  135490. /**
  135491. * Define the source as a Monoscopic panoramic 360/180.
  135492. */
  135493. static readonly MODE_MONOSCOPIC: number;
  135494. /**
  135495. * Define the source as a Stereoscopic TopBottom/OverUnder panoramic 360/180.
  135496. */
  135497. static readonly MODE_TOPBOTTOM: number;
  135498. /**
  135499. * Define the source as a Stereoscopic Side by Side panoramic 360/180.
  135500. */
  135501. static readonly MODE_SIDEBYSIDE: number;
  135502. private _halfDome;
  135503. protected _useDirectMapping: boolean;
  135504. /**
  135505. * The texture being displayed on the sphere
  135506. */
  135507. protected _texture: T;
  135508. /**
  135509. * Gets the texture being displayed on the sphere
  135510. */
  135511. get texture(): T;
  135512. /**
  135513. * Sets the texture being displayed on the sphere
  135514. */
  135515. set texture(newTexture: T);
  135516. /**
  135517. * The skybox material
  135518. */
  135519. protected _material: BackgroundMaterial;
  135520. /**
  135521. * The surface used for the dome
  135522. */
  135523. protected _mesh: Mesh;
  135524. /**
  135525. * Gets the mesh used for the dome.
  135526. */
  135527. get mesh(): Mesh;
  135528. /**
  135529. * A mesh that will be used to mask the back of the dome in case it is a 180 degree movie.
  135530. */
  135531. private _halfDomeMask;
  135532. /**
  135533. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  135534. * Also see the options.resolution property.
  135535. */
  135536. get fovMultiplier(): number;
  135537. set fovMultiplier(value: number);
  135538. protected _textureMode: number;
  135539. /**
  135540. * Gets or set the current texture mode for the texture. It can be:
  135541. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  135542. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  135543. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  135544. */
  135545. get textureMode(): number;
  135546. /**
  135547. * Sets the current texture mode for the texture. It can be:
  135548. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  135549. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  135550. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  135551. */
  135552. set textureMode(value: number);
  135553. /**
  135554. * Is it a 180 degrees dome (half dome) or 360 texture (full dome)
  135555. */
  135556. get halfDome(): boolean;
  135557. /**
  135558. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  135559. */
  135560. set halfDome(enabled: boolean);
  135561. /**
  135562. * Oberserver used in Stereoscopic VR Mode.
  135563. */
  135564. private _onBeforeCameraRenderObserver;
  135565. /**
  135566. * Observable raised when an error occured while loading the 360 image
  135567. */
  135568. onLoadErrorObservable: Observable<string>;
  135569. /**
  135570. * Create an instance of this class and pass through the parameters to the relevant classes- Texture, StandardMaterial, and Mesh.
  135571. * @param name Element's name, child elements will append suffixes for their own names.
  135572. * @param textureUrlOrElement defines the url(s) or the (video) HTML element to use
  135573. * @param options An object containing optional or exposed sub element properties
  135574. */
  135575. constructor(name: string, textureUrlOrElement: string | string[] | HTMLVideoElement, options: {
  135576. resolution?: number;
  135577. clickToPlay?: boolean;
  135578. autoPlay?: boolean;
  135579. loop?: boolean;
  135580. size?: number;
  135581. poster?: string;
  135582. faceForward?: boolean;
  135583. useDirectMapping?: boolean;
  135584. halfDomeMode?: boolean;
  135585. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  135586. protected abstract _initTexture(urlsOrElement: string | string[] | HTMLElement, scene: Scene, options: any): T;
  135587. protected _changeTextureMode(value: number): void;
  135588. /**
  135589. * Releases resources associated with this node.
  135590. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  135591. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  135592. */
  135593. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  135594. }
  135595. }
  135596. declare module BABYLON {
  135597. /**
  135598. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  135599. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  135600. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  135601. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  135602. */
  135603. export class PhotoDome extends TextureDome<Texture> {
  135604. /**
  135605. * Define the image as a Monoscopic panoramic 360 image.
  135606. */
  135607. static readonly MODE_MONOSCOPIC: number;
  135608. /**
  135609. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  135610. */
  135611. static readonly MODE_TOPBOTTOM: number;
  135612. /**
  135613. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  135614. */
  135615. static readonly MODE_SIDEBYSIDE: number;
  135616. /**
  135617. * Gets or sets the texture being displayed on the sphere
  135618. */
  135619. get photoTexture(): Texture;
  135620. /**
  135621. * sets the texture being displayed on the sphere
  135622. */
  135623. set photoTexture(value: Texture);
  135624. /**
  135625. * Gets the current video mode for the video. It can be:
  135626. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  135627. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  135628. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  135629. */
  135630. get imageMode(): number;
  135631. /**
  135632. * Sets the current video mode for the video. It can be:
  135633. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  135634. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  135635. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  135636. */
  135637. set imageMode(value: number);
  135638. protected _initTexture(urlsOrElement: string, scene: Scene, options: any): Texture;
  135639. }
  135640. }
  135641. declare module BABYLON {
  135642. /**
  135643. * Class used to host RGBD texture specific utilities
  135644. */
  135645. export class RGBDTextureTools {
  135646. /**
  135647. * Expand the RGBD Texture from RGBD to Half Float if possible.
  135648. * @param texture the texture to expand.
  135649. */
  135650. static ExpandRGBDTexture(texture: Texture): void;
  135651. }
  135652. }
  135653. declare module BABYLON {
  135654. /**
  135655. * Class used to host texture specific utilities
  135656. */
  135657. export class BRDFTextureTools {
  135658. /**
  135659. * Prevents texture cache collision
  135660. */
  135661. private static _instanceNumber;
  135662. /**
  135663. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  135664. * @param scene defines the hosting scene
  135665. * @returns the environment BRDF texture
  135666. */
  135667. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  135668. private static _environmentBRDFBase64Texture;
  135669. }
  135670. }
  135671. declare module BABYLON {
  135672. /**
  135673. * @hidden
  135674. */
  135675. export interface IMaterialClearCoatDefines {
  135676. CLEARCOAT: boolean;
  135677. CLEARCOAT_DEFAULTIOR: boolean;
  135678. CLEARCOAT_TEXTURE: boolean;
  135679. CLEARCOAT_TEXTUREDIRECTUV: number;
  135680. CLEARCOAT_BUMP: boolean;
  135681. CLEARCOAT_BUMPDIRECTUV: number;
  135682. CLEARCOAT_TINT: boolean;
  135683. CLEARCOAT_TINT_TEXTURE: boolean;
  135684. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  135685. /** @hidden */
  135686. _areTexturesDirty: boolean;
  135687. }
  135688. /**
  135689. * Define the code related to the clear coat parameters of the pbr material.
  135690. */
  135691. export class PBRClearCoatConfiguration {
  135692. /**
  135693. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  135694. * The default fits with a polyurethane material.
  135695. */
  135696. private static readonly _DefaultIndexOfRefraction;
  135697. private _isEnabled;
  135698. /**
  135699. * Defines if the clear coat is enabled in the material.
  135700. */
  135701. isEnabled: boolean;
  135702. /**
  135703. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  135704. */
  135705. intensity: number;
  135706. /**
  135707. * Defines the clear coat layer roughness.
  135708. */
  135709. roughness: number;
  135710. private _indexOfRefraction;
  135711. /**
  135712. * Defines the index of refraction of the clear coat.
  135713. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  135714. * The default fits with a polyurethane material.
  135715. * Changing the default value is more performance intensive.
  135716. */
  135717. indexOfRefraction: number;
  135718. private _texture;
  135719. /**
  135720. * Stores the clear coat values in a texture.
  135721. */
  135722. texture: Nullable<BaseTexture>;
  135723. private _bumpTexture;
  135724. /**
  135725. * Define the clear coat specific bump texture.
  135726. */
  135727. bumpTexture: Nullable<BaseTexture>;
  135728. private _isTintEnabled;
  135729. /**
  135730. * Defines if the clear coat tint is enabled in the material.
  135731. */
  135732. isTintEnabled: boolean;
  135733. /**
  135734. * Defines the clear coat tint of the material.
  135735. * This is only use if tint is enabled
  135736. */
  135737. tintColor: Color3;
  135738. /**
  135739. * Defines the distance at which the tint color should be found in the
  135740. * clear coat media.
  135741. * This is only use if tint is enabled
  135742. */
  135743. tintColorAtDistance: number;
  135744. /**
  135745. * Defines the clear coat layer thickness.
  135746. * This is only use if tint is enabled
  135747. */
  135748. tintThickness: number;
  135749. private _tintTexture;
  135750. /**
  135751. * Stores the clear tint values in a texture.
  135752. * rgb is tint
  135753. * a is a thickness factor
  135754. */
  135755. tintTexture: Nullable<BaseTexture>;
  135756. /** @hidden */
  135757. private _internalMarkAllSubMeshesAsTexturesDirty;
  135758. /** @hidden */
  135759. _markAllSubMeshesAsTexturesDirty(): void;
  135760. /**
  135761. * Instantiate a new istance of clear coat configuration.
  135762. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135763. */
  135764. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  135765. /**
  135766. * Gets wehter the submesh is ready to be used or not.
  135767. * @param defines the list of "defines" to update.
  135768. * @param scene defines the scene the material belongs to.
  135769. * @param engine defines the engine the material belongs to.
  135770. * @param disableBumpMap defines wether the material disables bump or not.
  135771. * @returns - boolean indicating that the submesh is ready or not.
  135772. */
  135773. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  135774. /**
  135775. * Checks to see if a texture is used in the material.
  135776. * @param defines the list of "defines" to update.
  135777. * @param scene defines the scene to the material belongs to.
  135778. */
  135779. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  135780. /**
  135781. * Binds the material data.
  135782. * @param uniformBuffer defines the Uniform buffer to fill in.
  135783. * @param scene defines the scene the material belongs to.
  135784. * @param engine defines the engine the material belongs to.
  135785. * @param disableBumpMap defines wether the material disables bump or not.
  135786. * @param isFrozen defines wether the material is frozen or not.
  135787. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  135788. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  135789. */
  135790. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  135791. /**
  135792. * Checks to see if a texture is used in the material.
  135793. * @param texture - Base texture to use.
  135794. * @returns - Boolean specifying if a texture is used in the material.
  135795. */
  135796. hasTexture(texture: BaseTexture): boolean;
  135797. /**
  135798. * Returns an array of the actively used textures.
  135799. * @param activeTextures Array of BaseTextures
  135800. */
  135801. getActiveTextures(activeTextures: BaseTexture[]): void;
  135802. /**
  135803. * Returns the animatable textures.
  135804. * @param animatables Array of animatable textures.
  135805. */
  135806. getAnimatables(animatables: IAnimatable[]): void;
  135807. /**
  135808. * Disposes the resources of the material.
  135809. * @param forceDisposeTextures - Forces the disposal of all textures.
  135810. */
  135811. dispose(forceDisposeTextures?: boolean): void;
  135812. /**
  135813. * Get the current class name of the texture useful for serialization or dynamic coding.
  135814. * @returns "PBRClearCoatConfiguration"
  135815. */
  135816. getClassName(): string;
  135817. /**
  135818. * Add fallbacks to the effect fallbacks list.
  135819. * @param defines defines the Base texture to use.
  135820. * @param fallbacks defines the current fallback list.
  135821. * @param currentRank defines the current fallback rank.
  135822. * @returns the new fallback rank.
  135823. */
  135824. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135825. /**
  135826. * Add the required uniforms to the current list.
  135827. * @param uniforms defines the current uniform list.
  135828. */
  135829. static AddUniforms(uniforms: string[]): void;
  135830. /**
  135831. * Add the required samplers to the current list.
  135832. * @param samplers defines the current sampler list.
  135833. */
  135834. static AddSamplers(samplers: string[]): void;
  135835. /**
  135836. * Add the required uniforms to the current buffer.
  135837. * @param uniformBuffer defines the current uniform buffer.
  135838. */
  135839. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135840. /**
  135841. * Makes a duplicate of the current configuration into another one.
  135842. * @param clearCoatConfiguration define the config where to copy the info
  135843. */
  135844. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  135845. /**
  135846. * Serializes this clear coat configuration.
  135847. * @returns - An object with the serialized config.
  135848. */
  135849. serialize(): any;
  135850. /**
  135851. * Parses a anisotropy Configuration from a serialized object.
  135852. * @param source - Serialized object.
  135853. * @param scene Defines the scene we are parsing for
  135854. * @param rootUrl Defines the rootUrl to load from
  135855. */
  135856. parse(source: any, scene: Scene, rootUrl: string): void;
  135857. }
  135858. }
  135859. declare module BABYLON {
  135860. /**
  135861. * @hidden
  135862. */
  135863. export interface IMaterialAnisotropicDefines {
  135864. ANISOTROPIC: boolean;
  135865. ANISOTROPIC_TEXTURE: boolean;
  135866. ANISOTROPIC_TEXTUREDIRECTUV: number;
  135867. MAINUV1: boolean;
  135868. _areTexturesDirty: boolean;
  135869. _needUVs: boolean;
  135870. }
  135871. /**
  135872. * Define the code related to the anisotropic parameters of the pbr material.
  135873. */
  135874. export class PBRAnisotropicConfiguration {
  135875. private _isEnabled;
  135876. /**
  135877. * Defines if the anisotropy is enabled in the material.
  135878. */
  135879. isEnabled: boolean;
  135880. /**
  135881. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  135882. */
  135883. intensity: number;
  135884. /**
  135885. * Defines if the effect is along the tangents, bitangents or in between.
  135886. * By default, the effect is "strectching" the highlights along the tangents.
  135887. */
  135888. direction: Vector2;
  135889. private _texture;
  135890. /**
  135891. * Stores the anisotropy values in a texture.
  135892. * rg is direction (like normal from -1 to 1)
  135893. * b is a intensity
  135894. */
  135895. texture: Nullable<BaseTexture>;
  135896. /** @hidden */
  135897. private _internalMarkAllSubMeshesAsTexturesDirty;
  135898. /** @hidden */
  135899. _markAllSubMeshesAsTexturesDirty(): void;
  135900. /**
  135901. * Instantiate a new istance of anisotropy configuration.
  135902. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135903. */
  135904. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  135905. /**
  135906. * Specifies that the submesh is ready to be used.
  135907. * @param defines the list of "defines" to update.
  135908. * @param scene defines the scene the material belongs to.
  135909. * @returns - boolean indicating that the submesh is ready or not.
  135910. */
  135911. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  135912. /**
  135913. * Checks to see if a texture is used in the material.
  135914. * @param defines the list of "defines" to update.
  135915. * @param mesh the mesh we are preparing the defines for.
  135916. * @param scene defines the scene the material belongs to.
  135917. */
  135918. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  135919. /**
  135920. * Binds the material data.
  135921. * @param uniformBuffer defines the Uniform buffer to fill in.
  135922. * @param scene defines the scene the material belongs to.
  135923. * @param isFrozen defines wether the material is frozen or not.
  135924. */
  135925. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  135926. /**
  135927. * Checks to see if a texture is used in the material.
  135928. * @param texture - Base texture to use.
  135929. * @returns - Boolean specifying if a texture is used in the material.
  135930. */
  135931. hasTexture(texture: BaseTexture): boolean;
  135932. /**
  135933. * Returns an array of the actively used textures.
  135934. * @param activeTextures Array of BaseTextures
  135935. */
  135936. getActiveTextures(activeTextures: BaseTexture[]): void;
  135937. /**
  135938. * Returns the animatable textures.
  135939. * @param animatables Array of animatable textures.
  135940. */
  135941. getAnimatables(animatables: IAnimatable[]): void;
  135942. /**
  135943. * Disposes the resources of the material.
  135944. * @param forceDisposeTextures - Forces the disposal of all textures.
  135945. */
  135946. dispose(forceDisposeTextures?: boolean): void;
  135947. /**
  135948. * Get the current class name of the texture useful for serialization or dynamic coding.
  135949. * @returns "PBRAnisotropicConfiguration"
  135950. */
  135951. getClassName(): string;
  135952. /**
  135953. * Add fallbacks to the effect fallbacks list.
  135954. * @param defines defines the Base texture to use.
  135955. * @param fallbacks defines the current fallback list.
  135956. * @param currentRank defines the current fallback rank.
  135957. * @returns the new fallback rank.
  135958. */
  135959. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135960. /**
  135961. * Add the required uniforms to the current list.
  135962. * @param uniforms defines the current uniform list.
  135963. */
  135964. static AddUniforms(uniforms: string[]): void;
  135965. /**
  135966. * Add the required uniforms to the current buffer.
  135967. * @param uniformBuffer defines the current uniform buffer.
  135968. */
  135969. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135970. /**
  135971. * Add the required samplers to the current list.
  135972. * @param samplers defines the current sampler list.
  135973. */
  135974. static AddSamplers(samplers: string[]): void;
  135975. /**
  135976. * Makes a duplicate of the current configuration into another one.
  135977. * @param anisotropicConfiguration define the config where to copy the info
  135978. */
  135979. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  135980. /**
  135981. * Serializes this anisotropy configuration.
  135982. * @returns - An object with the serialized config.
  135983. */
  135984. serialize(): any;
  135985. /**
  135986. * Parses a anisotropy Configuration from a serialized object.
  135987. * @param source - Serialized object.
  135988. * @param scene Defines the scene we are parsing for
  135989. * @param rootUrl Defines the rootUrl to load from
  135990. */
  135991. parse(source: any, scene: Scene, rootUrl: string): void;
  135992. }
  135993. }
  135994. declare module BABYLON {
  135995. /**
  135996. * @hidden
  135997. */
  135998. export interface IMaterialBRDFDefines {
  135999. BRDF_V_HEIGHT_CORRELATED: boolean;
  136000. MS_BRDF_ENERGY_CONSERVATION: boolean;
  136001. SPHERICAL_HARMONICS: boolean;
  136002. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  136003. /** @hidden */
  136004. _areMiscDirty: boolean;
  136005. }
  136006. /**
  136007. * Define the code related to the BRDF parameters of the pbr material.
  136008. */
  136009. export class PBRBRDFConfiguration {
  136010. /**
  136011. * Default value used for the energy conservation.
  136012. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  136013. */
  136014. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  136015. /**
  136016. * Default value used for the Smith Visibility Height Correlated mode.
  136017. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  136018. */
  136019. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  136020. /**
  136021. * Default value used for the IBL diffuse part.
  136022. * This can help switching back to the polynomials mode globally which is a tiny bit
  136023. * less GPU intensive at the drawback of a lower quality.
  136024. */
  136025. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  136026. /**
  136027. * Default value used for activating energy conservation for the specular workflow.
  136028. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  136029. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  136030. */
  136031. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  136032. private _useEnergyConservation;
  136033. /**
  136034. * Defines if the material uses energy conservation.
  136035. */
  136036. useEnergyConservation: boolean;
  136037. private _useSmithVisibilityHeightCorrelated;
  136038. /**
  136039. * LEGACY Mode set to false
  136040. * Defines if the material uses height smith correlated visibility term.
  136041. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  136042. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  136043. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  136044. * Not relying on height correlated will also disable energy conservation.
  136045. */
  136046. useSmithVisibilityHeightCorrelated: boolean;
  136047. private _useSphericalHarmonics;
  136048. /**
  136049. * LEGACY Mode set to false
  136050. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  136051. * diffuse part of the IBL.
  136052. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  136053. * to the ground truth.
  136054. */
  136055. useSphericalHarmonics: boolean;
  136056. private _useSpecularGlossinessInputEnergyConservation;
  136057. /**
  136058. * Defines if the material uses energy conservation, when the specular workflow is active.
  136059. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  136060. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  136061. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  136062. */
  136063. useSpecularGlossinessInputEnergyConservation: boolean;
  136064. /** @hidden */
  136065. private _internalMarkAllSubMeshesAsMiscDirty;
  136066. /** @hidden */
  136067. _markAllSubMeshesAsMiscDirty(): void;
  136068. /**
  136069. * Instantiate a new istance of clear coat configuration.
  136070. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  136071. */
  136072. constructor(markAllSubMeshesAsMiscDirty: () => void);
  136073. /**
  136074. * Checks to see if a texture is used in the material.
  136075. * @param defines the list of "defines" to update.
  136076. */
  136077. prepareDefines(defines: IMaterialBRDFDefines): void;
  136078. /**
  136079. * Get the current class name of the texture useful for serialization or dynamic coding.
  136080. * @returns "PBRClearCoatConfiguration"
  136081. */
  136082. getClassName(): string;
  136083. /**
  136084. * Makes a duplicate of the current configuration into another one.
  136085. * @param brdfConfiguration define the config where to copy the info
  136086. */
  136087. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  136088. /**
  136089. * Serializes this BRDF configuration.
  136090. * @returns - An object with the serialized config.
  136091. */
  136092. serialize(): any;
  136093. /**
  136094. * Parses a anisotropy Configuration from a serialized object.
  136095. * @param source - Serialized object.
  136096. * @param scene Defines the scene we are parsing for
  136097. * @param rootUrl Defines the rootUrl to load from
  136098. */
  136099. parse(source: any, scene: Scene, rootUrl: string): void;
  136100. }
  136101. }
  136102. declare module BABYLON {
  136103. /**
  136104. * @hidden
  136105. */
  136106. export interface IMaterialSheenDefines {
  136107. SHEEN: boolean;
  136108. SHEEN_TEXTURE: boolean;
  136109. SHEEN_TEXTUREDIRECTUV: number;
  136110. SHEEN_LINKWITHALBEDO: boolean;
  136111. SHEEN_ROUGHNESS: boolean;
  136112. SHEEN_ALBEDOSCALING: boolean;
  136113. /** @hidden */
  136114. _areTexturesDirty: boolean;
  136115. }
  136116. /**
  136117. * Define the code related to the Sheen parameters of the pbr material.
  136118. */
  136119. export class PBRSheenConfiguration {
  136120. private _isEnabled;
  136121. /**
  136122. * Defines if the material uses sheen.
  136123. */
  136124. isEnabled: boolean;
  136125. private _linkSheenWithAlbedo;
  136126. /**
  136127. * Defines if the sheen is linked to the sheen color.
  136128. */
  136129. linkSheenWithAlbedo: boolean;
  136130. /**
  136131. * Defines the sheen intensity.
  136132. */
  136133. intensity: number;
  136134. /**
  136135. * Defines the sheen color.
  136136. */
  136137. color: Color3;
  136138. private _texture;
  136139. /**
  136140. * Stores the sheen tint values in a texture.
  136141. * rgb is tint
  136142. * a is a intensity or roughness if roughness has been defined
  136143. */
  136144. texture: Nullable<BaseTexture>;
  136145. private _roughness;
  136146. /**
  136147. * Defines the sheen roughness.
  136148. * It is not taken into account if linkSheenWithAlbedo is true.
  136149. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  136150. */
  136151. roughness: Nullable<number>;
  136152. private _albedoScaling;
  136153. /**
  136154. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  136155. * It allows the strength of the sheen effect to not depend on the base color of the material,
  136156. * making it easier to setup and tweak the effect
  136157. */
  136158. albedoScaling: boolean;
  136159. /** @hidden */
  136160. private _internalMarkAllSubMeshesAsTexturesDirty;
  136161. /** @hidden */
  136162. _markAllSubMeshesAsTexturesDirty(): void;
  136163. /**
  136164. * Instantiate a new istance of clear coat configuration.
  136165. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  136166. */
  136167. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  136168. /**
  136169. * Specifies that the submesh is ready to be used.
  136170. * @param defines the list of "defines" to update.
  136171. * @param scene defines the scene the material belongs to.
  136172. * @returns - boolean indicating that the submesh is ready or not.
  136173. */
  136174. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  136175. /**
  136176. * Checks to see if a texture is used in the material.
  136177. * @param defines the list of "defines" to update.
  136178. * @param scene defines the scene the material belongs to.
  136179. */
  136180. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  136181. /**
  136182. * Binds the material data.
  136183. * @param uniformBuffer defines the Uniform buffer to fill in.
  136184. * @param scene defines the scene the material belongs to.
  136185. * @param isFrozen defines wether the material is frozen or not.
  136186. */
  136187. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  136188. /**
  136189. * Checks to see if a texture is used in the material.
  136190. * @param texture - Base texture to use.
  136191. * @returns - Boolean specifying if a texture is used in the material.
  136192. */
  136193. hasTexture(texture: BaseTexture): boolean;
  136194. /**
  136195. * Returns an array of the actively used textures.
  136196. * @param activeTextures Array of BaseTextures
  136197. */
  136198. getActiveTextures(activeTextures: BaseTexture[]): void;
  136199. /**
  136200. * Returns the animatable textures.
  136201. * @param animatables Array of animatable textures.
  136202. */
  136203. getAnimatables(animatables: IAnimatable[]): void;
  136204. /**
  136205. * Disposes the resources of the material.
  136206. * @param forceDisposeTextures - Forces the disposal of all textures.
  136207. */
  136208. dispose(forceDisposeTextures?: boolean): void;
  136209. /**
  136210. * Get the current class name of the texture useful for serialization or dynamic coding.
  136211. * @returns "PBRSheenConfiguration"
  136212. */
  136213. getClassName(): string;
  136214. /**
  136215. * Add fallbacks to the effect fallbacks list.
  136216. * @param defines defines the Base texture to use.
  136217. * @param fallbacks defines the current fallback list.
  136218. * @param currentRank defines the current fallback rank.
  136219. * @returns the new fallback rank.
  136220. */
  136221. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  136222. /**
  136223. * Add the required uniforms to the current list.
  136224. * @param uniforms defines the current uniform list.
  136225. */
  136226. static AddUniforms(uniforms: string[]): void;
  136227. /**
  136228. * Add the required uniforms to the current buffer.
  136229. * @param uniformBuffer defines the current uniform buffer.
  136230. */
  136231. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  136232. /**
  136233. * Add the required samplers to the current list.
  136234. * @param samplers defines the current sampler list.
  136235. */
  136236. static AddSamplers(samplers: string[]): void;
  136237. /**
  136238. * Makes a duplicate of the current configuration into another one.
  136239. * @param sheenConfiguration define the config where to copy the info
  136240. */
  136241. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  136242. /**
  136243. * Serializes this BRDF configuration.
  136244. * @returns - An object with the serialized config.
  136245. */
  136246. serialize(): any;
  136247. /**
  136248. * Parses a anisotropy Configuration from a serialized object.
  136249. * @param source - Serialized object.
  136250. * @param scene Defines the scene we are parsing for
  136251. * @param rootUrl Defines the rootUrl to load from
  136252. */
  136253. parse(source: any, scene: Scene, rootUrl: string): void;
  136254. }
  136255. }
  136256. declare module BABYLON {
  136257. /**
  136258. * @hidden
  136259. */
  136260. export interface IMaterialSubSurfaceDefines {
  136261. SUBSURFACE: boolean;
  136262. SS_REFRACTION: boolean;
  136263. SS_TRANSLUCENCY: boolean;
  136264. SS_SCATTERING: boolean;
  136265. SS_THICKNESSANDMASK_TEXTURE: boolean;
  136266. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  136267. SS_REFRACTIONMAP_3D: boolean;
  136268. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  136269. SS_LODINREFRACTIONALPHA: boolean;
  136270. SS_GAMMAREFRACTION: boolean;
  136271. SS_RGBDREFRACTION: boolean;
  136272. SS_LINEARSPECULARREFRACTION: boolean;
  136273. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  136274. SS_ALBEDOFORREFRACTIONTINT: boolean;
  136275. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  136276. /** @hidden */
  136277. _areTexturesDirty: boolean;
  136278. }
  136279. /**
  136280. * Define the code related to the sub surface parameters of the pbr material.
  136281. */
  136282. export class PBRSubSurfaceConfiguration {
  136283. private _isRefractionEnabled;
  136284. /**
  136285. * Defines if the refraction is enabled in the material.
  136286. */
  136287. isRefractionEnabled: boolean;
  136288. private _isTranslucencyEnabled;
  136289. /**
  136290. * Defines if the translucency is enabled in the material.
  136291. */
  136292. isTranslucencyEnabled: boolean;
  136293. private _isScatteringEnabled;
  136294. /**
  136295. * Defines if the sub surface scattering is enabled in the material.
  136296. */
  136297. isScatteringEnabled: boolean;
  136298. private _scatteringDiffusionProfileIndex;
  136299. /**
  136300. * Diffusion profile for subsurface scattering.
  136301. * Useful for better scattering in the skins or foliages.
  136302. */
  136303. get scatteringDiffusionProfile(): Nullable<Color3>;
  136304. set scatteringDiffusionProfile(c: Nullable<Color3>);
  136305. /**
  136306. * Defines the refraction intensity of the material.
  136307. * The refraction when enabled replaces the Diffuse part of the material.
  136308. * The intensity helps transitionning between diffuse and refraction.
  136309. */
  136310. refractionIntensity: number;
  136311. /**
  136312. * Defines the translucency intensity of the material.
  136313. * When translucency has been enabled, this defines how much of the "translucency"
  136314. * is addded to the diffuse part of the material.
  136315. */
  136316. translucencyIntensity: number;
  136317. /**
  136318. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  136319. */
  136320. useAlbedoToTintRefraction: boolean;
  136321. private _thicknessTexture;
  136322. /**
  136323. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  136324. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  136325. * 0 would mean minimumThickness
  136326. * 1 would mean maximumThickness
  136327. * The other channels might be use as a mask to vary the different effects intensity.
  136328. */
  136329. thicknessTexture: Nullable<BaseTexture>;
  136330. private _refractionTexture;
  136331. /**
  136332. * Defines the texture to use for refraction.
  136333. */
  136334. refractionTexture: Nullable<BaseTexture>;
  136335. private _indexOfRefraction;
  136336. /**
  136337. * Index of refraction of the material base layer.
  136338. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  136339. *
  136340. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  136341. *
  136342. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  136343. */
  136344. indexOfRefraction: number;
  136345. private _volumeIndexOfRefraction;
  136346. /**
  136347. * Index of refraction of the material's volume.
  136348. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  136349. *
  136350. * This ONLY impacts refraction. If not provided or given a non-valid value,
  136351. * the volume will use the same IOR as the surface.
  136352. */
  136353. get volumeIndexOfRefraction(): number;
  136354. set volumeIndexOfRefraction(value: number);
  136355. private _invertRefractionY;
  136356. /**
  136357. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  136358. */
  136359. invertRefractionY: boolean;
  136360. private _linkRefractionWithTransparency;
  136361. /**
  136362. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  136363. * Materials half opaque for instance using refraction could benefit from this control.
  136364. */
  136365. linkRefractionWithTransparency: boolean;
  136366. /**
  136367. * Defines the minimum thickness stored in the thickness map.
  136368. * If no thickness map is defined, this value will be used to simulate thickness.
  136369. */
  136370. minimumThickness: number;
  136371. /**
  136372. * Defines the maximum thickness stored in the thickness map.
  136373. */
  136374. maximumThickness: number;
  136375. /**
  136376. * Defines the volume tint of the material.
  136377. * This is used for both translucency and scattering.
  136378. */
  136379. tintColor: Color3;
  136380. /**
  136381. * Defines the distance at which the tint color should be found in the media.
  136382. * This is used for refraction only.
  136383. */
  136384. tintColorAtDistance: number;
  136385. /**
  136386. * Defines how far each channel transmit through the media.
  136387. * It is defined as a color to simplify it selection.
  136388. */
  136389. diffusionDistance: Color3;
  136390. private _useMaskFromThicknessTexture;
  136391. /**
  136392. * Stores the intensity of the different subsurface effects in the thickness texture.
  136393. * * the green channel is the translucency intensity.
  136394. * * the blue channel is the scattering intensity.
  136395. * * the alpha channel is the refraction intensity.
  136396. */
  136397. useMaskFromThicknessTexture: boolean;
  136398. private _scene;
  136399. /** @hidden */
  136400. private _internalMarkAllSubMeshesAsTexturesDirty;
  136401. private _internalMarkScenePrePassDirty;
  136402. /** @hidden */
  136403. _markAllSubMeshesAsTexturesDirty(): void;
  136404. /** @hidden */
  136405. _markScenePrePassDirty(): void;
  136406. /**
  136407. * Instantiate a new istance of sub surface configuration.
  136408. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  136409. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  136410. * @param scene The scene
  136411. */
  136412. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  136413. /**
  136414. * Gets wehter the submesh is ready to be used or not.
  136415. * @param defines the list of "defines" to update.
  136416. * @param scene defines the scene the material belongs to.
  136417. * @returns - boolean indicating that the submesh is ready or not.
  136418. */
  136419. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  136420. /**
  136421. * Checks to see if a texture is used in the material.
  136422. * @param defines the list of "defines" to update.
  136423. * @param scene defines the scene to the material belongs to.
  136424. */
  136425. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  136426. /**
  136427. * Binds the material data.
  136428. * @param uniformBuffer defines the Uniform buffer to fill in.
  136429. * @param scene defines the scene the material belongs to.
  136430. * @param engine defines the engine the material belongs to.
  136431. * @param isFrozen defines whether the material is frozen or not.
  136432. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  136433. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  136434. */
  136435. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  136436. /**
  136437. * Unbinds the material from the mesh.
  136438. * @param activeEffect defines the effect that should be unbound from.
  136439. * @returns true if unbound, otherwise false
  136440. */
  136441. unbind(activeEffect: Effect): boolean;
  136442. /**
  136443. * Returns the texture used for refraction or null if none is used.
  136444. * @param scene defines the scene the material belongs to.
  136445. * @returns - Refraction texture if present. If no refraction texture and refraction
  136446. * is linked with transparency, returns environment texture. Otherwise, returns null.
  136447. */
  136448. private _getRefractionTexture;
  136449. /**
  136450. * Returns true if alpha blending should be disabled.
  136451. */
  136452. get disableAlphaBlending(): boolean;
  136453. /**
  136454. * Fills the list of render target textures.
  136455. * @param renderTargets the list of render targets to update
  136456. */
  136457. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  136458. /**
  136459. * Checks to see if a texture is used in the material.
  136460. * @param texture - Base texture to use.
  136461. * @returns - Boolean specifying if a texture is used in the material.
  136462. */
  136463. hasTexture(texture: BaseTexture): boolean;
  136464. /**
  136465. * Gets a boolean indicating that current material needs to register RTT
  136466. * @returns true if this uses a render target otherwise false.
  136467. */
  136468. hasRenderTargetTextures(): boolean;
  136469. /**
  136470. * Returns an array of the actively used textures.
  136471. * @param activeTextures Array of BaseTextures
  136472. */
  136473. getActiveTextures(activeTextures: BaseTexture[]): void;
  136474. /**
  136475. * Returns the animatable textures.
  136476. * @param animatables Array of animatable textures.
  136477. */
  136478. getAnimatables(animatables: IAnimatable[]): void;
  136479. /**
  136480. * Disposes the resources of the material.
  136481. * @param forceDisposeTextures - Forces the disposal of all textures.
  136482. */
  136483. dispose(forceDisposeTextures?: boolean): void;
  136484. /**
  136485. * Get the current class name of the texture useful for serialization or dynamic coding.
  136486. * @returns "PBRSubSurfaceConfiguration"
  136487. */
  136488. getClassName(): string;
  136489. /**
  136490. * Add fallbacks to the effect fallbacks list.
  136491. * @param defines defines the Base texture to use.
  136492. * @param fallbacks defines the current fallback list.
  136493. * @param currentRank defines the current fallback rank.
  136494. * @returns the new fallback rank.
  136495. */
  136496. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  136497. /**
  136498. * Add the required uniforms to the current list.
  136499. * @param uniforms defines the current uniform list.
  136500. */
  136501. static AddUniforms(uniforms: string[]): void;
  136502. /**
  136503. * Add the required samplers to the current list.
  136504. * @param samplers defines the current sampler list.
  136505. */
  136506. static AddSamplers(samplers: string[]): void;
  136507. /**
  136508. * Add the required uniforms to the current buffer.
  136509. * @param uniformBuffer defines the current uniform buffer.
  136510. */
  136511. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  136512. /**
  136513. * Makes a duplicate of the current configuration into another one.
  136514. * @param configuration define the config where to copy the info
  136515. */
  136516. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  136517. /**
  136518. * Serializes this Sub Surface configuration.
  136519. * @returns - An object with the serialized config.
  136520. */
  136521. serialize(): any;
  136522. /**
  136523. * Parses a anisotropy Configuration from a serialized object.
  136524. * @param source - Serialized object.
  136525. * @param scene Defines the scene we are parsing for
  136526. * @param rootUrl Defines the rootUrl to load from
  136527. */
  136528. parse(source: any, scene: Scene, rootUrl: string): void;
  136529. }
  136530. }
  136531. declare module BABYLON {
  136532. /** @hidden */
  136533. export var pbrFragmentDeclaration: {
  136534. name: string;
  136535. shader: string;
  136536. };
  136537. }
  136538. declare module BABYLON {
  136539. /** @hidden */
  136540. export var pbrUboDeclaration: {
  136541. name: string;
  136542. shader: string;
  136543. };
  136544. }
  136545. declare module BABYLON {
  136546. /** @hidden */
  136547. export var pbrFragmentExtraDeclaration: {
  136548. name: string;
  136549. shader: string;
  136550. };
  136551. }
  136552. declare module BABYLON {
  136553. /** @hidden */
  136554. export var pbrFragmentSamplersDeclaration: {
  136555. name: string;
  136556. shader: string;
  136557. };
  136558. }
  136559. declare module BABYLON {
  136560. /** @hidden */
  136561. export var subSurfaceScatteringFunctions: {
  136562. name: string;
  136563. shader: string;
  136564. };
  136565. }
  136566. declare module BABYLON {
  136567. /** @hidden */
  136568. export var importanceSampling: {
  136569. name: string;
  136570. shader: string;
  136571. };
  136572. }
  136573. declare module BABYLON {
  136574. /** @hidden */
  136575. export var pbrHelperFunctions: {
  136576. name: string;
  136577. shader: string;
  136578. };
  136579. }
  136580. declare module BABYLON {
  136581. /** @hidden */
  136582. export var harmonicsFunctions: {
  136583. name: string;
  136584. shader: string;
  136585. };
  136586. }
  136587. declare module BABYLON {
  136588. /** @hidden */
  136589. export var pbrDirectLightingSetupFunctions: {
  136590. name: string;
  136591. shader: string;
  136592. };
  136593. }
  136594. declare module BABYLON {
  136595. /** @hidden */
  136596. export var pbrDirectLightingFalloffFunctions: {
  136597. name: string;
  136598. shader: string;
  136599. };
  136600. }
  136601. declare module BABYLON {
  136602. /** @hidden */
  136603. export var pbrBRDFFunctions: {
  136604. name: string;
  136605. shader: string;
  136606. };
  136607. }
  136608. declare module BABYLON {
  136609. /** @hidden */
  136610. export var hdrFilteringFunctions: {
  136611. name: string;
  136612. shader: string;
  136613. };
  136614. }
  136615. declare module BABYLON {
  136616. /** @hidden */
  136617. export var pbrDirectLightingFunctions: {
  136618. name: string;
  136619. shader: string;
  136620. };
  136621. }
  136622. declare module BABYLON {
  136623. /** @hidden */
  136624. export var pbrIBLFunctions: {
  136625. name: string;
  136626. shader: string;
  136627. };
  136628. }
  136629. declare module BABYLON {
  136630. /** @hidden */
  136631. export var pbrBlockAlbedoOpacity: {
  136632. name: string;
  136633. shader: string;
  136634. };
  136635. }
  136636. declare module BABYLON {
  136637. /** @hidden */
  136638. export var pbrBlockReflectivity: {
  136639. name: string;
  136640. shader: string;
  136641. };
  136642. }
  136643. declare module BABYLON {
  136644. /** @hidden */
  136645. export var pbrBlockAmbientOcclusion: {
  136646. name: string;
  136647. shader: string;
  136648. };
  136649. }
  136650. declare module BABYLON {
  136651. /** @hidden */
  136652. export var pbrBlockAlphaFresnel: {
  136653. name: string;
  136654. shader: string;
  136655. };
  136656. }
  136657. declare module BABYLON {
  136658. /** @hidden */
  136659. export var pbrBlockAnisotropic: {
  136660. name: string;
  136661. shader: string;
  136662. };
  136663. }
  136664. declare module BABYLON {
  136665. /** @hidden */
  136666. export var pbrBlockReflection: {
  136667. name: string;
  136668. shader: string;
  136669. };
  136670. }
  136671. declare module BABYLON {
  136672. /** @hidden */
  136673. export var pbrBlockSheen: {
  136674. name: string;
  136675. shader: string;
  136676. };
  136677. }
  136678. declare module BABYLON {
  136679. /** @hidden */
  136680. export var pbrBlockClearcoat: {
  136681. name: string;
  136682. shader: string;
  136683. };
  136684. }
  136685. declare module BABYLON {
  136686. /** @hidden */
  136687. export var pbrBlockSubSurface: {
  136688. name: string;
  136689. shader: string;
  136690. };
  136691. }
  136692. declare module BABYLON {
  136693. /** @hidden */
  136694. export var pbrBlockNormalGeometric: {
  136695. name: string;
  136696. shader: string;
  136697. };
  136698. }
  136699. declare module BABYLON {
  136700. /** @hidden */
  136701. export var pbrBlockNormalFinal: {
  136702. name: string;
  136703. shader: string;
  136704. };
  136705. }
  136706. declare module BABYLON {
  136707. /** @hidden */
  136708. export var pbrBlockLightmapInit: {
  136709. name: string;
  136710. shader: string;
  136711. };
  136712. }
  136713. declare module BABYLON {
  136714. /** @hidden */
  136715. export var pbrBlockGeometryInfo: {
  136716. name: string;
  136717. shader: string;
  136718. };
  136719. }
  136720. declare module BABYLON {
  136721. /** @hidden */
  136722. export var pbrBlockReflectance0: {
  136723. name: string;
  136724. shader: string;
  136725. };
  136726. }
  136727. declare module BABYLON {
  136728. /** @hidden */
  136729. export var pbrBlockReflectance: {
  136730. name: string;
  136731. shader: string;
  136732. };
  136733. }
  136734. declare module BABYLON {
  136735. /** @hidden */
  136736. export var pbrBlockDirectLighting: {
  136737. name: string;
  136738. shader: string;
  136739. };
  136740. }
  136741. declare module BABYLON {
  136742. /** @hidden */
  136743. export var pbrBlockFinalLitComponents: {
  136744. name: string;
  136745. shader: string;
  136746. };
  136747. }
  136748. declare module BABYLON {
  136749. /** @hidden */
  136750. export var pbrBlockFinalUnlitComponents: {
  136751. name: string;
  136752. shader: string;
  136753. };
  136754. }
  136755. declare module BABYLON {
  136756. /** @hidden */
  136757. export var pbrBlockFinalColorComposition: {
  136758. name: string;
  136759. shader: string;
  136760. };
  136761. }
  136762. declare module BABYLON {
  136763. /** @hidden */
  136764. export var pbrBlockImageProcessing: {
  136765. name: string;
  136766. shader: string;
  136767. };
  136768. }
  136769. declare module BABYLON {
  136770. /** @hidden */
  136771. export var pbrDebug: {
  136772. name: string;
  136773. shader: string;
  136774. };
  136775. }
  136776. declare module BABYLON {
  136777. /** @hidden */
  136778. export var pbrPixelShader: {
  136779. name: string;
  136780. shader: string;
  136781. };
  136782. }
  136783. declare module BABYLON {
  136784. /** @hidden */
  136785. export var pbrVertexDeclaration: {
  136786. name: string;
  136787. shader: string;
  136788. };
  136789. }
  136790. declare module BABYLON {
  136791. /** @hidden */
  136792. export var pbrVertexShader: {
  136793. name: string;
  136794. shader: string;
  136795. };
  136796. }
  136797. declare module BABYLON {
  136798. /**
  136799. * Manages the defines for the PBR Material.
  136800. * @hidden
  136801. */
  136802. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  136803. PBR: boolean;
  136804. NUM_SAMPLES: string;
  136805. REALTIME_FILTERING: boolean;
  136806. MAINUV1: boolean;
  136807. MAINUV2: boolean;
  136808. UV1: boolean;
  136809. UV2: boolean;
  136810. ALBEDO: boolean;
  136811. GAMMAALBEDO: boolean;
  136812. ALBEDODIRECTUV: number;
  136813. VERTEXCOLOR: boolean;
  136814. DETAIL: boolean;
  136815. DETAILDIRECTUV: number;
  136816. DETAIL_NORMALBLENDMETHOD: number;
  136817. AMBIENT: boolean;
  136818. AMBIENTDIRECTUV: number;
  136819. AMBIENTINGRAYSCALE: boolean;
  136820. OPACITY: boolean;
  136821. VERTEXALPHA: boolean;
  136822. OPACITYDIRECTUV: number;
  136823. OPACITYRGB: boolean;
  136824. ALPHATEST: boolean;
  136825. DEPTHPREPASS: boolean;
  136826. ALPHABLEND: boolean;
  136827. ALPHAFROMALBEDO: boolean;
  136828. ALPHATESTVALUE: string;
  136829. SPECULAROVERALPHA: boolean;
  136830. RADIANCEOVERALPHA: boolean;
  136831. ALPHAFRESNEL: boolean;
  136832. LINEARALPHAFRESNEL: boolean;
  136833. PREMULTIPLYALPHA: boolean;
  136834. EMISSIVE: boolean;
  136835. EMISSIVEDIRECTUV: number;
  136836. REFLECTIVITY: boolean;
  136837. REFLECTIVITYDIRECTUV: number;
  136838. SPECULARTERM: boolean;
  136839. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  136840. MICROSURFACEAUTOMATIC: boolean;
  136841. LODBASEDMICROSFURACE: boolean;
  136842. MICROSURFACEMAP: boolean;
  136843. MICROSURFACEMAPDIRECTUV: number;
  136844. METALLICWORKFLOW: boolean;
  136845. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  136846. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  136847. METALLNESSSTOREINMETALMAPBLUE: boolean;
  136848. AOSTOREINMETALMAPRED: boolean;
  136849. METALLIC_REFLECTANCE: boolean;
  136850. METALLIC_REFLECTANCEDIRECTUV: number;
  136851. ENVIRONMENTBRDF: boolean;
  136852. ENVIRONMENTBRDF_RGBD: boolean;
  136853. NORMAL: boolean;
  136854. TANGENT: boolean;
  136855. BUMP: boolean;
  136856. BUMPDIRECTUV: number;
  136857. OBJECTSPACE_NORMALMAP: boolean;
  136858. PARALLAX: boolean;
  136859. PARALLAXOCCLUSION: boolean;
  136860. NORMALXYSCALE: boolean;
  136861. LIGHTMAP: boolean;
  136862. LIGHTMAPDIRECTUV: number;
  136863. USELIGHTMAPASSHADOWMAP: boolean;
  136864. GAMMALIGHTMAP: boolean;
  136865. RGBDLIGHTMAP: boolean;
  136866. REFLECTION: boolean;
  136867. REFLECTIONMAP_3D: boolean;
  136868. REFLECTIONMAP_SPHERICAL: boolean;
  136869. REFLECTIONMAP_PLANAR: boolean;
  136870. REFLECTIONMAP_CUBIC: boolean;
  136871. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  136872. REFLECTIONMAP_PROJECTION: boolean;
  136873. REFLECTIONMAP_SKYBOX: boolean;
  136874. REFLECTIONMAP_EXPLICIT: boolean;
  136875. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  136876. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  136877. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  136878. INVERTCUBICMAP: boolean;
  136879. USESPHERICALFROMREFLECTIONMAP: boolean;
  136880. USEIRRADIANCEMAP: boolean;
  136881. SPHERICAL_HARMONICS: boolean;
  136882. USESPHERICALINVERTEX: boolean;
  136883. REFLECTIONMAP_OPPOSITEZ: boolean;
  136884. LODINREFLECTIONALPHA: boolean;
  136885. GAMMAREFLECTION: boolean;
  136886. RGBDREFLECTION: boolean;
  136887. LINEARSPECULARREFLECTION: boolean;
  136888. RADIANCEOCCLUSION: boolean;
  136889. HORIZONOCCLUSION: boolean;
  136890. INSTANCES: boolean;
  136891. THIN_INSTANCES: boolean;
  136892. PREPASS: boolean;
  136893. PREPASS_IRRADIANCE: boolean;
  136894. PREPASS_IRRADIANCE_INDEX: number;
  136895. PREPASS_ALBEDO: boolean;
  136896. PREPASS_ALBEDO_INDEX: number;
  136897. PREPASS_DEPTHNORMAL: boolean;
  136898. PREPASS_DEPTHNORMAL_INDEX: number;
  136899. SCENE_MRT_COUNT: number;
  136900. NUM_BONE_INFLUENCERS: number;
  136901. BonesPerMesh: number;
  136902. BONETEXTURE: boolean;
  136903. NONUNIFORMSCALING: boolean;
  136904. MORPHTARGETS: boolean;
  136905. MORPHTARGETS_NORMAL: boolean;
  136906. MORPHTARGETS_TANGENT: boolean;
  136907. MORPHTARGETS_UV: boolean;
  136908. NUM_MORPH_INFLUENCERS: number;
  136909. IMAGEPROCESSING: boolean;
  136910. VIGNETTE: boolean;
  136911. VIGNETTEBLENDMODEMULTIPLY: boolean;
  136912. VIGNETTEBLENDMODEOPAQUE: boolean;
  136913. TONEMAPPING: boolean;
  136914. TONEMAPPING_ACES: boolean;
  136915. CONTRAST: boolean;
  136916. COLORCURVES: boolean;
  136917. COLORGRADING: boolean;
  136918. COLORGRADING3D: boolean;
  136919. SAMPLER3DGREENDEPTH: boolean;
  136920. SAMPLER3DBGRMAP: boolean;
  136921. IMAGEPROCESSINGPOSTPROCESS: boolean;
  136922. EXPOSURE: boolean;
  136923. MULTIVIEW: boolean;
  136924. USEPHYSICALLIGHTFALLOFF: boolean;
  136925. USEGLTFLIGHTFALLOFF: boolean;
  136926. TWOSIDEDLIGHTING: boolean;
  136927. SHADOWFLOAT: boolean;
  136928. CLIPPLANE: boolean;
  136929. CLIPPLANE2: boolean;
  136930. CLIPPLANE3: boolean;
  136931. CLIPPLANE4: boolean;
  136932. CLIPPLANE5: boolean;
  136933. CLIPPLANE6: boolean;
  136934. POINTSIZE: boolean;
  136935. FOG: boolean;
  136936. LOGARITHMICDEPTH: boolean;
  136937. FORCENORMALFORWARD: boolean;
  136938. SPECULARAA: boolean;
  136939. CLEARCOAT: boolean;
  136940. CLEARCOAT_DEFAULTIOR: boolean;
  136941. CLEARCOAT_TEXTURE: boolean;
  136942. CLEARCOAT_TEXTUREDIRECTUV: number;
  136943. CLEARCOAT_BUMP: boolean;
  136944. CLEARCOAT_BUMPDIRECTUV: number;
  136945. CLEARCOAT_TINT: boolean;
  136946. CLEARCOAT_TINT_TEXTURE: boolean;
  136947. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  136948. ANISOTROPIC: boolean;
  136949. ANISOTROPIC_TEXTURE: boolean;
  136950. ANISOTROPIC_TEXTUREDIRECTUV: number;
  136951. BRDF_V_HEIGHT_CORRELATED: boolean;
  136952. MS_BRDF_ENERGY_CONSERVATION: boolean;
  136953. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  136954. SHEEN: boolean;
  136955. SHEEN_TEXTURE: boolean;
  136956. SHEEN_TEXTUREDIRECTUV: number;
  136957. SHEEN_LINKWITHALBEDO: boolean;
  136958. SHEEN_ROUGHNESS: boolean;
  136959. SHEEN_ALBEDOSCALING: boolean;
  136960. SUBSURFACE: boolean;
  136961. SS_REFRACTION: boolean;
  136962. SS_TRANSLUCENCY: boolean;
  136963. SS_SCATTERING: boolean;
  136964. SS_THICKNESSANDMASK_TEXTURE: boolean;
  136965. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  136966. SS_REFRACTIONMAP_3D: boolean;
  136967. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  136968. SS_LODINREFRACTIONALPHA: boolean;
  136969. SS_GAMMAREFRACTION: boolean;
  136970. SS_RGBDREFRACTION: boolean;
  136971. SS_LINEARSPECULARREFRACTION: boolean;
  136972. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  136973. SS_ALBEDOFORREFRACTIONTINT: boolean;
  136974. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  136975. UNLIT: boolean;
  136976. DEBUGMODE: number;
  136977. /**
  136978. * Initializes the PBR Material defines.
  136979. */
  136980. constructor();
  136981. /**
  136982. * Resets the PBR Material defines.
  136983. */
  136984. reset(): void;
  136985. }
  136986. /**
  136987. * The Physically based material base class of BJS.
  136988. *
  136989. * This offers the main features of a standard PBR material.
  136990. * For more information, please refer to the documentation :
  136991. * https://doc.babylonjs.com/how_to/physically_based_rendering
  136992. */
  136993. export abstract class PBRBaseMaterial extends PushMaterial {
  136994. /**
  136995. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  136996. */
  136997. static readonly PBRMATERIAL_OPAQUE: number;
  136998. /**
  136999. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  137000. */
  137001. static readonly PBRMATERIAL_ALPHATEST: number;
  137002. /**
  137003. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  137004. */
  137005. static readonly PBRMATERIAL_ALPHABLEND: number;
  137006. /**
  137007. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  137008. * They are also discarded below the alpha cutoff threshold to improve performances.
  137009. */
  137010. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  137011. /**
  137012. * Defines the default value of how much AO map is occluding the analytical lights
  137013. * (point spot...).
  137014. */
  137015. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  137016. /**
  137017. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  137018. */
  137019. static readonly LIGHTFALLOFF_PHYSICAL: number;
  137020. /**
  137021. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  137022. * to enhance interoperability with other engines.
  137023. */
  137024. static readonly LIGHTFALLOFF_GLTF: number;
  137025. /**
  137026. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  137027. * to enhance interoperability with other materials.
  137028. */
  137029. static readonly LIGHTFALLOFF_STANDARD: number;
  137030. /**
  137031. * Intensity of the direct lights e.g. the four lights available in your scene.
  137032. * This impacts both the direct diffuse and specular highlights.
  137033. */
  137034. protected _directIntensity: number;
  137035. /**
  137036. * Intensity of the emissive part of the material.
  137037. * This helps controlling the emissive effect without modifying the emissive color.
  137038. */
  137039. protected _emissiveIntensity: number;
  137040. /**
  137041. * Intensity of the environment e.g. how much the environment will light the object
  137042. * either through harmonics for rough material or through the refelction for shiny ones.
  137043. */
  137044. protected _environmentIntensity: number;
  137045. /**
  137046. * This is a special control allowing the reduction of the specular highlights coming from the
  137047. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  137048. */
  137049. protected _specularIntensity: number;
  137050. /**
  137051. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  137052. */
  137053. private _lightingInfos;
  137054. /**
  137055. * Debug Control allowing disabling the bump map on this material.
  137056. */
  137057. protected _disableBumpMap: boolean;
  137058. /**
  137059. * AKA Diffuse Texture in standard nomenclature.
  137060. */
  137061. protected _albedoTexture: Nullable<BaseTexture>;
  137062. /**
  137063. * AKA Occlusion Texture in other nomenclature.
  137064. */
  137065. protected _ambientTexture: Nullable<BaseTexture>;
  137066. /**
  137067. * AKA Occlusion Texture Intensity in other nomenclature.
  137068. */
  137069. protected _ambientTextureStrength: number;
  137070. /**
  137071. * Defines how much the AO map is occluding the analytical lights (point spot...).
  137072. * 1 means it completely occludes it
  137073. * 0 mean it has no impact
  137074. */
  137075. protected _ambientTextureImpactOnAnalyticalLights: number;
  137076. /**
  137077. * Stores the alpha values in a texture.
  137078. */
  137079. protected _opacityTexture: Nullable<BaseTexture>;
  137080. /**
  137081. * Stores the reflection values in a texture.
  137082. */
  137083. protected _reflectionTexture: Nullable<BaseTexture>;
  137084. /**
  137085. * Stores the emissive values in a texture.
  137086. */
  137087. protected _emissiveTexture: Nullable<BaseTexture>;
  137088. /**
  137089. * AKA Specular texture in other nomenclature.
  137090. */
  137091. protected _reflectivityTexture: Nullable<BaseTexture>;
  137092. /**
  137093. * Used to switch from specular/glossiness to metallic/roughness workflow.
  137094. */
  137095. protected _metallicTexture: Nullable<BaseTexture>;
  137096. /**
  137097. * Specifies the metallic scalar of the metallic/roughness workflow.
  137098. * Can also be used to scale the metalness values of the metallic texture.
  137099. */
  137100. protected _metallic: Nullable<number>;
  137101. /**
  137102. * Specifies the roughness scalar of the metallic/roughness workflow.
  137103. * Can also be used to scale the roughness values of the metallic texture.
  137104. */
  137105. protected _roughness: Nullable<number>;
  137106. /**
  137107. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  137108. * By default the indexOfrefraction is used to compute F0;
  137109. *
  137110. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  137111. *
  137112. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  137113. * F90 = metallicReflectanceColor;
  137114. */
  137115. protected _metallicF0Factor: number;
  137116. /**
  137117. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  137118. * By default the F90 is always 1;
  137119. *
  137120. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  137121. *
  137122. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  137123. * F90 = metallicReflectanceColor;
  137124. */
  137125. protected _metallicReflectanceColor: Color3;
  137126. /**
  137127. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  137128. * This is multiply against the scalar values defined in the material.
  137129. */
  137130. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  137131. /**
  137132. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  137133. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  137134. */
  137135. protected _microSurfaceTexture: Nullable<BaseTexture>;
  137136. /**
  137137. * Stores surface normal data used to displace a mesh in a texture.
  137138. */
  137139. protected _bumpTexture: Nullable<BaseTexture>;
  137140. /**
  137141. * Stores the pre-calculated light information of a mesh in a texture.
  137142. */
  137143. protected _lightmapTexture: Nullable<BaseTexture>;
  137144. /**
  137145. * The color of a material in ambient lighting.
  137146. */
  137147. protected _ambientColor: Color3;
  137148. /**
  137149. * AKA Diffuse Color in other nomenclature.
  137150. */
  137151. protected _albedoColor: Color3;
  137152. /**
  137153. * AKA Specular Color in other nomenclature.
  137154. */
  137155. protected _reflectivityColor: Color3;
  137156. /**
  137157. * The color applied when light is reflected from a material.
  137158. */
  137159. protected _reflectionColor: Color3;
  137160. /**
  137161. * The color applied when light is emitted from a material.
  137162. */
  137163. protected _emissiveColor: Color3;
  137164. /**
  137165. * AKA Glossiness in other nomenclature.
  137166. */
  137167. protected _microSurface: number;
  137168. /**
  137169. * Specifies that the material will use the light map as a show map.
  137170. */
  137171. protected _useLightmapAsShadowmap: boolean;
  137172. /**
  137173. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  137174. * makes the reflect vector face the model (under horizon).
  137175. */
  137176. protected _useHorizonOcclusion: boolean;
  137177. /**
  137178. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  137179. * too much the area relying on ambient texture to define their ambient occlusion.
  137180. */
  137181. protected _useRadianceOcclusion: boolean;
  137182. /**
  137183. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  137184. */
  137185. protected _useAlphaFromAlbedoTexture: boolean;
  137186. /**
  137187. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  137188. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  137189. */
  137190. protected _useSpecularOverAlpha: boolean;
  137191. /**
  137192. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  137193. */
  137194. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  137195. /**
  137196. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  137197. */
  137198. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  137199. /**
  137200. * Specifies if the metallic texture contains the roughness information in its green channel.
  137201. */
  137202. protected _useRoughnessFromMetallicTextureGreen: boolean;
  137203. /**
  137204. * Specifies if the metallic texture contains the metallness information in its blue channel.
  137205. */
  137206. protected _useMetallnessFromMetallicTextureBlue: boolean;
  137207. /**
  137208. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  137209. */
  137210. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  137211. /**
  137212. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  137213. */
  137214. protected _useAmbientInGrayScale: boolean;
  137215. /**
  137216. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  137217. * The material will try to infer what glossiness each pixel should be.
  137218. */
  137219. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  137220. /**
  137221. * Defines the falloff type used in this material.
  137222. * It by default is Physical.
  137223. */
  137224. protected _lightFalloff: number;
  137225. /**
  137226. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  137227. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  137228. */
  137229. protected _useRadianceOverAlpha: boolean;
  137230. /**
  137231. * Allows using an object space normal map (instead of tangent space).
  137232. */
  137233. protected _useObjectSpaceNormalMap: boolean;
  137234. /**
  137235. * Allows using the bump map in parallax mode.
  137236. */
  137237. protected _useParallax: boolean;
  137238. /**
  137239. * Allows using the bump map in parallax occlusion mode.
  137240. */
  137241. protected _useParallaxOcclusion: boolean;
  137242. /**
  137243. * Controls the scale bias of the parallax mode.
  137244. */
  137245. protected _parallaxScaleBias: number;
  137246. /**
  137247. * If sets to true, disables all the lights affecting the material.
  137248. */
  137249. protected _disableLighting: boolean;
  137250. /**
  137251. * Number of Simultaneous lights allowed on the material.
  137252. */
  137253. protected _maxSimultaneousLights: number;
  137254. /**
  137255. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  137256. */
  137257. protected _invertNormalMapX: boolean;
  137258. /**
  137259. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  137260. */
  137261. protected _invertNormalMapY: boolean;
  137262. /**
  137263. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  137264. */
  137265. protected _twoSidedLighting: boolean;
  137266. /**
  137267. * Defines the alpha limits in alpha test mode.
  137268. */
  137269. protected _alphaCutOff: number;
  137270. /**
  137271. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  137272. */
  137273. protected _forceAlphaTest: boolean;
  137274. /**
  137275. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  137276. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  137277. */
  137278. protected _useAlphaFresnel: boolean;
  137279. /**
  137280. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  137281. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  137282. */
  137283. protected _useLinearAlphaFresnel: boolean;
  137284. /**
  137285. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  137286. * from cos thetav and roughness:
  137287. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  137288. */
  137289. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  137290. /**
  137291. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  137292. */
  137293. protected _forceIrradianceInFragment: boolean;
  137294. private _realTimeFiltering;
  137295. /**
  137296. * Enables realtime filtering on the texture.
  137297. */
  137298. get realTimeFiltering(): boolean;
  137299. set realTimeFiltering(b: boolean);
  137300. private _realTimeFilteringQuality;
  137301. /**
  137302. * Quality switch for realtime filtering
  137303. */
  137304. get realTimeFilteringQuality(): number;
  137305. set realTimeFilteringQuality(n: number);
  137306. /**
  137307. * Can this material render to several textures at once
  137308. */
  137309. get canRenderToMRT(): boolean;
  137310. /**
  137311. * Force normal to face away from face.
  137312. */
  137313. protected _forceNormalForward: boolean;
  137314. /**
  137315. * Enables specular anti aliasing in the PBR shader.
  137316. * It will both interacts on the Geometry for analytical and IBL lighting.
  137317. * It also prefilter the roughness map based on the bump values.
  137318. */
  137319. protected _enableSpecularAntiAliasing: boolean;
  137320. /**
  137321. * Default configuration related to image processing available in the PBR Material.
  137322. */
  137323. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  137324. /**
  137325. * Keep track of the image processing observer to allow dispose and replace.
  137326. */
  137327. private _imageProcessingObserver;
  137328. /**
  137329. * Attaches a new image processing configuration to the PBR Material.
  137330. * @param configuration
  137331. */
  137332. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  137333. /**
  137334. * Stores the available render targets.
  137335. */
  137336. private _renderTargets;
  137337. /**
  137338. * Sets the global ambient color for the material used in lighting calculations.
  137339. */
  137340. private _globalAmbientColor;
  137341. /**
  137342. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  137343. */
  137344. private _useLogarithmicDepth;
  137345. /**
  137346. * If set to true, no lighting calculations will be applied.
  137347. */
  137348. private _unlit;
  137349. private _debugMode;
  137350. /**
  137351. * @hidden
  137352. * This is reserved for the inspector.
  137353. * Defines the material debug mode.
  137354. * It helps seeing only some components of the material while troubleshooting.
  137355. */
  137356. debugMode: number;
  137357. /**
  137358. * @hidden
  137359. * This is reserved for the inspector.
  137360. * Specify from where on screen the debug mode should start.
  137361. * The value goes from -1 (full screen) to 1 (not visible)
  137362. * It helps with side by side comparison against the final render
  137363. * This defaults to -1
  137364. */
  137365. private debugLimit;
  137366. /**
  137367. * @hidden
  137368. * This is reserved for the inspector.
  137369. * As the default viewing range might not be enough (if the ambient is really small for instance)
  137370. * You can use the factor to better multiply the final value.
  137371. */
  137372. private debugFactor;
  137373. /**
  137374. * Defines the clear coat layer parameters for the material.
  137375. */
  137376. readonly clearCoat: PBRClearCoatConfiguration;
  137377. /**
  137378. * Defines the anisotropic parameters for the material.
  137379. */
  137380. readonly anisotropy: PBRAnisotropicConfiguration;
  137381. /**
  137382. * Defines the BRDF parameters for the material.
  137383. */
  137384. readonly brdf: PBRBRDFConfiguration;
  137385. /**
  137386. * Defines the Sheen parameters for the material.
  137387. */
  137388. readonly sheen: PBRSheenConfiguration;
  137389. /**
  137390. * Defines the SubSurface parameters for the material.
  137391. */
  137392. readonly subSurface: PBRSubSurfaceConfiguration;
  137393. /**
  137394. * Defines the detail map parameters for the material.
  137395. */
  137396. readonly detailMap: DetailMapConfiguration;
  137397. protected _rebuildInParallel: boolean;
  137398. /**
  137399. * Instantiates a new PBRMaterial instance.
  137400. *
  137401. * @param name The material name
  137402. * @param scene The scene the material will be use in.
  137403. */
  137404. constructor(name: string, scene: Scene);
  137405. /**
  137406. * Gets a boolean indicating that current material needs to register RTT
  137407. */
  137408. get hasRenderTargetTextures(): boolean;
  137409. /**
  137410. * Gets the name of the material class.
  137411. */
  137412. getClassName(): string;
  137413. /**
  137414. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  137415. */
  137416. get useLogarithmicDepth(): boolean;
  137417. /**
  137418. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  137419. */
  137420. set useLogarithmicDepth(value: boolean);
  137421. /**
  137422. * Returns true if alpha blending should be disabled.
  137423. */
  137424. protected get _disableAlphaBlending(): boolean;
  137425. /**
  137426. * Specifies whether or not this material should be rendered in alpha blend mode.
  137427. */
  137428. needAlphaBlending(): boolean;
  137429. /**
  137430. * Specifies whether or not this material should be rendered in alpha test mode.
  137431. */
  137432. needAlphaTesting(): boolean;
  137433. /**
  137434. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  137435. */
  137436. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  137437. /**
  137438. * Gets the texture used for the alpha test.
  137439. */
  137440. getAlphaTestTexture(): Nullable<BaseTexture>;
  137441. /**
  137442. * Specifies that the submesh is ready to be used.
  137443. * @param mesh - BJS mesh.
  137444. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  137445. * @param useInstances - Specifies that instances should be used.
  137446. * @returns - boolean indicating that the submesh is ready or not.
  137447. */
  137448. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  137449. /**
  137450. * Specifies if the material uses metallic roughness workflow.
  137451. * @returns boolean specifiying if the material uses metallic roughness workflow.
  137452. */
  137453. isMetallicWorkflow(): boolean;
  137454. private _prepareEffect;
  137455. private _prepareDefines;
  137456. /**
  137457. * Force shader compilation
  137458. */
  137459. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  137460. /**
  137461. * Initializes the uniform buffer layout for the shader.
  137462. */
  137463. buildUniformLayout(): void;
  137464. /**
  137465. * Unbinds the material from the mesh
  137466. */
  137467. unbind(): void;
  137468. /**
  137469. * Binds the submesh data.
  137470. * @param world - The world matrix.
  137471. * @param mesh - The BJS mesh.
  137472. * @param subMesh - A submesh of the BJS mesh.
  137473. */
  137474. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  137475. /**
  137476. * Returns the animatable textures.
  137477. * @returns - Array of animatable textures.
  137478. */
  137479. getAnimatables(): IAnimatable[];
  137480. /**
  137481. * Returns the texture used for reflections.
  137482. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  137483. */
  137484. private _getReflectionTexture;
  137485. /**
  137486. * Returns an array of the actively used textures.
  137487. * @returns - Array of BaseTextures
  137488. */
  137489. getActiveTextures(): BaseTexture[];
  137490. /**
  137491. * Checks to see if a texture is used in the material.
  137492. * @param texture - Base texture to use.
  137493. * @returns - Boolean specifying if a texture is used in the material.
  137494. */
  137495. hasTexture(texture: BaseTexture): boolean;
  137496. /**
  137497. * Sets the required values to the prepass renderer.
  137498. * @param prePassRenderer defines the prepass renderer to setup
  137499. */
  137500. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  137501. /**
  137502. * Disposes the resources of the material.
  137503. * @param forceDisposeEffect - Forces the disposal of effects.
  137504. * @param forceDisposeTextures - Forces the disposal of all textures.
  137505. */
  137506. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  137507. }
  137508. }
  137509. declare module BABYLON {
  137510. /**
  137511. * The Physically based material of BJS.
  137512. *
  137513. * This offers the main features of a standard PBR material.
  137514. * For more information, please refer to the documentation :
  137515. * https://doc.babylonjs.com/how_to/physically_based_rendering
  137516. */
  137517. export class PBRMaterial extends PBRBaseMaterial {
  137518. /**
  137519. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  137520. */
  137521. static readonly PBRMATERIAL_OPAQUE: number;
  137522. /**
  137523. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  137524. */
  137525. static readonly PBRMATERIAL_ALPHATEST: number;
  137526. /**
  137527. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  137528. */
  137529. static readonly PBRMATERIAL_ALPHABLEND: number;
  137530. /**
  137531. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  137532. * They are also discarded below the alpha cutoff threshold to improve performances.
  137533. */
  137534. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  137535. /**
  137536. * Defines the default value of how much AO map is occluding the analytical lights
  137537. * (point spot...).
  137538. */
  137539. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  137540. /**
  137541. * Intensity of the direct lights e.g. the four lights available in your scene.
  137542. * This impacts both the direct diffuse and specular highlights.
  137543. */
  137544. directIntensity: number;
  137545. /**
  137546. * Intensity of the emissive part of the material.
  137547. * This helps controlling the emissive effect without modifying the emissive color.
  137548. */
  137549. emissiveIntensity: number;
  137550. /**
  137551. * Intensity of the environment e.g. how much the environment will light the object
  137552. * either through harmonics for rough material or through the refelction for shiny ones.
  137553. */
  137554. environmentIntensity: number;
  137555. /**
  137556. * This is a special control allowing the reduction of the specular highlights coming from the
  137557. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  137558. */
  137559. specularIntensity: number;
  137560. /**
  137561. * Debug Control allowing disabling the bump map on this material.
  137562. */
  137563. disableBumpMap: boolean;
  137564. /**
  137565. * AKA Diffuse Texture in standard nomenclature.
  137566. */
  137567. albedoTexture: BaseTexture;
  137568. /**
  137569. * AKA Occlusion Texture in other nomenclature.
  137570. */
  137571. ambientTexture: BaseTexture;
  137572. /**
  137573. * AKA Occlusion Texture Intensity in other nomenclature.
  137574. */
  137575. ambientTextureStrength: number;
  137576. /**
  137577. * Defines how much the AO map is occluding the analytical lights (point spot...).
  137578. * 1 means it completely occludes it
  137579. * 0 mean it has no impact
  137580. */
  137581. ambientTextureImpactOnAnalyticalLights: number;
  137582. /**
  137583. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  137584. */
  137585. opacityTexture: BaseTexture;
  137586. /**
  137587. * Stores the reflection values in a texture.
  137588. */
  137589. reflectionTexture: Nullable<BaseTexture>;
  137590. /**
  137591. * Stores the emissive values in a texture.
  137592. */
  137593. emissiveTexture: BaseTexture;
  137594. /**
  137595. * AKA Specular texture in other nomenclature.
  137596. */
  137597. reflectivityTexture: BaseTexture;
  137598. /**
  137599. * Used to switch from specular/glossiness to metallic/roughness workflow.
  137600. */
  137601. metallicTexture: BaseTexture;
  137602. /**
  137603. * Specifies the metallic scalar of the metallic/roughness workflow.
  137604. * Can also be used to scale the metalness values of the metallic texture.
  137605. */
  137606. metallic: Nullable<number>;
  137607. /**
  137608. * Specifies the roughness scalar of the metallic/roughness workflow.
  137609. * Can also be used to scale the roughness values of the metallic texture.
  137610. */
  137611. roughness: Nullable<number>;
  137612. /**
  137613. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  137614. * By default the indexOfrefraction is used to compute F0;
  137615. *
  137616. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  137617. *
  137618. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  137619. * F90 = metallicReflectanceColor;
  137620. */
  137621. metallicF0Factor: number;
  137622. /**
  137623. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  137624. * By default the F90 is always 1;
  137625. *
  137626. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  137627. *
  137628. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  137629. * F90 = metallicReflectanceColor;
  137630. */
  137631. metallicReflectanceColor: Color3;
  137632. /**
  137633. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  137634. * This is multiply against the scalar values defined in the material.
  137635. */
  137636. metallicReflectanceTexture: Nullable<BaseTexture>;
  137637. /**
  137638. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  137639. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  137640. */
  137641. microSurfaceTexture: BaseTexture;
  137642. /**
  137643. * Stores surface normal data used to displace a mesh in a texture.
  137644. */
  137645. bumpTexture: BaseTexture;
  137646. /**
  137647. * Stores the pre-calculated light information of a mesh in a texture.
  137648. */
  137649. lightmapTexture: BaseTexture;
  137650. /**
  137651. * Stores the refracted light information in a texture.
  137652. */
  137653. get refractionTexture(): Nullable<BaseTexture>;
  137654. set refractionTexture(value: Nullable<BaseTexture>);
  137655. /**
  137656. * The color of a material in ambient lighting.
  137657. */
  137658. ambientColor: Color3;
  137659. /**
  137660. * AKA Diffuse Color in other nomenclature.
  137661. */
  137662. albedoColor: Color3;
  137663. /**
  137664. * AKA Specular Color in other nomenclature.
  137665. */
  137666. reflectivityColor: Color3;
  137667. /**
  137668. * The color reflected from the material.
  137669. */
  137670. reflectionColor: Color3;
  137671. /**
  137672. * The color emitted from the material.
  137673. */
  137674. emissiveColor: Color3;
  137675. /**
  137676. * AKA Glossiness in other nomenclature.
  137677. */
  137678. microSurface: number;
  137679. /**
  137680. * Index of refraction of the material base layer.
  137681. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  137682. *
  137683. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  137684. *
  137685. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  137686. */
  137687. get indexOfRefraction(): number;
  137688. set indexOfRefraction(value: number);
  137689. /**
  137690. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  137691. */
  137692. get invertRefractionY(): boolean;
  137693. set invertRefractionY(value: boolean);
  137694. /**
  137695. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  137696. * Materials half opaque for instance using refraction could benefit from this control.
  137697. */
  137698. get linkRefractionWithTransparency(): boolean;
  137699. set linkRefractionWithTransparency(value: boolean);
  137700. /**
  137701. * If true, the light map contains occlusion information instead of lighting info.
  137702. */
  137703. useLightmapAsShadowmap: boolean;
  137704. /**
  137705. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  137706. */
  137707. useAlphaFromAlbedoTexture: boolean;
  137708. /**
  137709. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  137710. */
  137711. forceAlphaTest: boolean;
  137712. /**
  137713. * Defines the alpha limits in alpha test mode.
  137714. */
  137715. alphaCutOff: number;
  137716. /**
  137717. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  137718. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  137719. */
  137720. useSpecularOverAlpha: boolean;
  137721. /**
  137722. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  137723. */
  137724. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  137725. /**
  137726. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  137727. */
  137728. useRoughnessFromMetallicTextureAlpha: boolean;
  137729. /**
  137730. * Specifies if the metallic texture contains the roughness information in its green channel.
  137731. */
  137732. useRoughnessFromMetallicTextureGreen: boolean;
  137733. /**
  137734. * Specifies if the metallic texture contains the metallness information in its blue channel.
  137735. */
  137736. useMetallnessFromMetallicTextureBlue: boolean;
  137737. /**
  137738. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  137739. */
  137740. useAmbientOcclusionFromMetallicTextureRed: boolean;
  137741. /**
  137742. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  137743. */
  137744. useAmbientInGrayScale: boolean;
  137745. /**
  137746. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  137747. * The material will try to infer what glossiness each pixel should be.
  137748. */
  137749. useAutoMicroSurfaceFromReflectivityMap: boolean;
  137750. /**
  137751. * BJS is using an harcoded light falloff based on a manually sets up range.
  137752. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  137753. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  137754. */
  137755. get usePhysicalLightFalloff(): boolean;
  137756. /**
  137757. * BJS is using an harcoded light falloff based on a manually sets up range.
  137758. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  137759. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  137760. */
  137761. set usePhysicalLightFalloff(value: boolean);
  137762. /**
  137763. * In order to support the falloff compatibility with gltf, a special mode has been added
  137764. * to reproduce the gltf light falloff.
  137765. */
  137766. get useGLTFLightFalloff(): boolean;
  137767. /**
  137768. * In order to support the falloff compatibility with gltf, a special mode has been added
  137769. * to reproduce the gltf light falloff.
  137770. */
  137771. set useGLTFLightFalloff(value: boolean);
  137772. /**
  137773. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  137774. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  137775. */
  137776. useRadianceOverAlpha: boolean;
  137777. /**
  137778. * Allows using an object space normal map (instead of tangent space).
  137779. */
  137780. useObjectSpaceNormalMap: boolean;
  137781. /**
  137782. * Allows using the bump map in parallax mode.
  137783. */
  137784. useParallax: boolean;
  137785. /**
  137786. * Allows using the bump map in parallax occlusion mode.
  137787. */
  137788. useParallaxOcclusion: boolean;
  137789. /**
  137790. * Controls the scale bias of the parallax mode.
  137791. */
  137792. parallaxScaleBias: number;
  137793. /**
  137794. * If sets to true, disables all the lights affecting the material.
  137795. */
  137796. disableLighting: boolean;
  137797. /**
  137798. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  137799. */
  137800. forceIrradianceInFragment: boolean;
  137801. /**
  137802. * Number of Simultaneous lights allowed on the material.
  137803. */
  137804. maxSimultaneousLights: number;
  137805. /**
  137806. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  137807. */
  137808. invertNormalMapX: boolean;
  137809. /**
  137810. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  137811. */
  137812. invertNormalMapY: boolean;
  137813. /**
  137814. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  137815. */
  137816. twoSidedLighting: boolean;
  137817. /**
  137818. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  137819. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  137820. */
  137821. useAlphaFresnel: boolean;
  137822. /**
  137823. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  137824. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  137825. */
  137826. useLinearAlphaFresnel: boolean;
  137827. /**
  137828. * Let user defines the brdf lookup texture used for IBL.
  137829. * A default 8bit version is embedded but you could point at :
  137830. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  137831. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  137832. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  137833. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  137834. */
  137835. environmentBRDFTexture: Nullable<BaseTexture>;
  137836. /**
  137837. * Force normal to face away from face.
  137838. */
  137839. forceNormalForward: boolean;
  137840. /**
  137841. * Enables specular anti aliasing in the PBR shader.
  137842. * It will both interacts on the Geometry for analytical and IBL lighting.
  137843. * It also prefilter the roughness map based on the bump values.
  137844. */
  137845. enableSpecularAntiAliasing: boolean;
  137846. /**
  137847. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  137848. * makes the reflect vector face the model (under horizon).
  137849. */
  137850. useHorizonOcclusion: boolean;
  137851. /**
  137852. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  137853. * too much the area relying on ambient texture to define their ambient occlusion.
  137854. */
  137855. useRadianceOcclusion: boolean;
  137856. /**
  137857. * If set to true, no lighting calculations will be applied.
  137858. */
  137859. unlit: boolean;
  137860. /**
  137861. * Gets the image processing configuration used either in this material.
  137862. */
  137863. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  137864. /**
  137865. * Sets the Default image processing configuration used either in the this material.
  137866. *
  137867. * If sets to null, the scene one is in use.
  137868. */
  137869. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  137870. /**
  137871. * Gets wether the color curves effect is enabled.
  137872. */
  137873. get cameraColorCurvesEnabled(): boolean;
  137874. /**
  137875. * Sets wether the color curves effect is enabled.
  137876. */
  137877. set cameraColorCurvesEnabled(value: boolean);
  137878. /**
  137879. * Gets wether the color grading effect is enabled.
  137880. */
  137881. get cameraColorGradingEnabled(): boolean;
  137882. /**
  137883. * Gets wether the color grading effect is enabled.
  137884. */
  137885. set cameraColorGradingEnabled(value: boolean);
  137886. /**
  137887. * Gets wether tonemapping is enabled or not.
  137888. */
  137889. get cameraToneMappingEnabled(): boolean;
  137890. /**
  137891. * Sets wether tonemapping is enabled or not
  137892. */
  137893. set cameraToneMappingEnabled(value: boolean);
  137894. /**
  137895. * The camera exposure used on this material.
  137896. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  137897. * This corresponds to a photographic exposure.
  137898. */
  137899. get cameraExposure(): number;
  137900. /**
  137901. * The camera exposure used on this material.
  137902. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  137903. * This corresponds to a photographic exposure.
  137904. */
  137905. set cameraExposure(value: number);
  137906. /**
  137907. * Gets The camera contrast used on this material.
  137908. */
  137909. get cameraContrast(): number;
  137910. /**
  137911. * Sets The camera contrast used on this material.
  137912. */
  137913. set cameraContrast(value: number);
  137914. /**
  137915. * Gets the Color Grading 2D Lookup Texture.
  137916. */
  137917. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  137918. /**
  137919. * Sets the Color Grading 2D Lookup Texture.
  137920. */
  137921. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  137922. /**
  137923. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  137924. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  137925. * 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;
  137926. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  137927. */
  137928. get cameraColorCurves(): Nullable<ColorCurves>;
  137929. /**
  137930. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  137931. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  137932. * 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;
  137933. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  137934. */
  137935. set cameraColorCurves(value: Nullable<ColorCurves>);
  137936. /**
  137937. * Instantiates a new PBRMaterial instance.
  137938. *
  137939. * @param name The material name
  137940. * @param scene The scene the material will be use in.
  137941. */
  137942. constructor(name: string, scene: Scene);
  137943. /**
  137944. * Returns the name of this material class.
  137945. */
  137946. getClassName(): string;
  137947. /**
  137948. * Makes a duplicate of the current material.
  137949. * @param name - name to use for the new material.
  137950. */
  137951. clone(name: string): PBRMaterial;
  137952. /**
  137953. * Serializes this PBR Material.
  137954. * @returns - An object with the serialized material.
  137955. */
  137956. serialize(): any;
  137957. /**
  137958. * Parses a PBR Material from a serialized object.
  137959. * @param source - Serialized object.
  137960. * @param scene - BJS scene instance.
  137961. * @param rootUrl - url for the scene object
  137962. * @returns - PBRMaterial
  137963. */
  137964. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  137965. }
  137966. }
  137967. declare module BABYLON {
  137968. /**
  137969. * Direct draw surface info
  137970. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  137971. */
  137972. export interface DDSInfo {
  137973. /**
  137974. * Width of the texture
  137975. */
  137976. width: number;
  137977. /**
  137978. * Width of the texture
  137979. */
  137980. height: number;
  137981. /**
  137982. * Number of Mipmaps for the texture
  137983. * @see https://en.wikipedia.org/wiki/Mipmap
  137984. */
  137985. mipmapCount: number;
  137986. /**
  137987. * If the textures format is a known fourCC format
  137988. * @see https://www.fourcc.org/
  137989. */
  137990. isFourCC: boolean;
  137991. /**
  137992. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  137993. */
  137994. isRGB: boolean;
  137995. /**
  137996. * If the texture is a lumincance format
  137997. */
  137998. isLuminance: boolean;
  137999. /**
  138000. * If this is a cube texture
  138001. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  138002. */
  138003. isCube: boolean;
  138004. /**
  138005. * If the texture is a compressed format eg. FOURCC_DXT1
  138006. */
  138007. isCompressed: boolean;
  138008. /**
  138009. * The dxgiFormat of the texture
  138010. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  138011. */
  138012. dxgiFormat: number;
  138013. /**
  138014. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  138015. */
  138016. textureType: number;
  138017. /**
  138018. * Sphericle polynomial created for the dds texture
  138019. */
  138020. sphericalPolynomial?: SphericalPolynomial;
  138021. }
  138022. /**
  138023. * Class used to provide DDS decompression tools
  138024. */
  138025. export class DDSTools {
  138026. /**
  138027. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  138028. */
  138029. static StoreLODInAlphaChannel: boolean;
  138030. /**
  138031. * Gets DDS information from an array buffer
  138032. * @param data defines the array buffer view to read data from
  138033. * @returns the DDS information
  138034. */
  138035. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  138036. private static _FloatView;
  138037. private static _Int32View;
  138038. private static _ToHalfFloat;
  138039. private static _FromHalfFloat;
  138040. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  138041. private static _GetHalfFloatRGBAArrayBuffer;
  138042. private static _GetFloatRGBAArrayBuffer;
  138043. private static _GetFloatAsUIntRGBAArrayBuffer;
  138044. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  138045. private static _GetRGBAArrayBuffer;
  138046. private static _ExtractLongWordOrder;
  138047. private static _GetRGBArrayBuffer;
  138048. private static _GetLuminanceArrayBuffer;
  138049. /**
  138050. * Uploads DDS Levels to a Babylon Texture
  138051. * @hidden
  138052. */
  138053. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  138054. }
  138055. interface ThinEngine {
  138056. /**
  138057. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  138058. * @param rootUrl defines the url where the file to load is located
  138059. * @param scene defines the current scene
  138060. * @param lodScale defines scale to apply to the mip map selection
  138061. * @param lodOffset defines offset to apply to the mip map selection
  138062. * @param onLoad defines an optional callback raised when the texture is loaded
  138063. * @param onError defines an optional callback raised if there is an issue to load the texture
  138064. * @param format defines the format of the data
  138065. * @param forcedExtension defines the extension to use to pick the right loader
  138066. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  138067. * @returns the cube texture as an InternalTexture
  138068. */
  138069. 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;
  138070. }
  138071. }
  138072. declare module BABYLON {
  138073. /**
  138074. * Implementation of the DDS Texture Loader.
  138075. * @hidden
  138076. */
  138077. export class _DDSTextureLoader implements IInternalTextureLoader {
  138078. /**
  138079. * Defines wether the loader supports cascade loading the different faces.
  138080. */
  138081. readonly supportCascades: boolean;
  138082. /**
  138083. * This returns if the loader support the current file information.
  138084. * @param extension defines the file extension of the file being loaded
  138085. * @returns true if the loader can load the specified file
  138086. */
  138087. canLoad(extension: string): boolean;
  138088. /**
  138089. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  138090. * @param data contains the texture data
  138091. * @param texture defines the BabylonJS internal texture
  138092. * @param createPolynomials will be true if polynomials have been requested
  138093. * @param onLoad defines the callback to trigger once the texture is ready
  138094. * @param onError defines the callback to trigger in case of error
  138095. */
  138096. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  138097. /**
  138098. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  138099. * @param data contains the texture data
  138100. * @param texture defines the BabylonJS internal texture
  138101. * @param callback defines the method to call once ready to upload
  138102. */
  138103. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  138104. }
  138105. }
  138106. declare module BABYLON {
  138107. /**
  138108. * Implementation of the ENV Texture Loader.
  138109. * @hidden
  138110. */
  138111. export class _ENVTextureLoader implements IInternalTextureLoader {
  138112. /**
  138113. * Defines wether the loader supports cascade loading the different faces.
  138114. */
  138115. readonly supportCascades: boolean;
  138116. /**
  138117. * This returns if the loader support the current file information.
  138118. * @param extension defines the file extension of the file being loaded
  138119. * @returns true if the loader can load the specified file
  138120. */
  138121. canLoad(extension: string): boolean;
  138122. /**
  138123. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  138124. * @param data contains the texture data
  138125. * @param texture defines the BabylonJS internal texture
  138126. * @param createPolynomials will be true if polynomials have been requested
  138127. * @param onLoad defines the callback to trigger once the texture is ready
  138128. * @param onError defines the callback to trigger in case of error
  138129. */
  138130. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  138131. /**
  138132. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  138133. * @param data contains the texture data
  138134. * @param texture defines the BabylonJS internal texture
  138135. * @param callback defines the method to call once ready to upload
  138136. */
  138137. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  138138. }
  138139. }
  138140. declare module BABYLON {
  138141. /**
  138142. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  138143. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  138144. */
  138145. export class KhronosTextureContainer {
  138146. /** contents of the KTX container file */
  138147. data: ArrayBufferView;
  138148. private static HEADER_LEN;
  138149. private static COMPRESSED_2D;
  138150. private static COMPRESSED_3D;
  138151. private static TEX_2D;
  138152. private static TEX_3D;
  138153. /**
  138154. * Gets the openGL type
  138155. */
  138156. glType: number;
  138157. /**
  138158. * Gets the openGL type size
  138159. */
  138160. glTypeSize: number;
  138161. /**
  138162. * Gets the openGL format
  138163. */
  138164. glFormat: number;
  138165. /**
  138166. * Gets the openGL internal format
  138167. */
  138168. glInternalFormat: number;
  138169. /**
  138170. * Gets the base internal format
  138171. */
  138172. glBaseInternalFormat: number;
  138173. /**
  138174. * Gets image width in pixel
  138175. */
  138176. pixelWidth: number;
  138177. /**
  138178. * Gets image height in pixel
  138179. */
  138180. pixelHeight: number;
  138181. /**
  138182. * Gets image depth in pixels
  138183. */
  138184. pixelDepth: number;
  138185. /**
  138186. * Gets the number of array elements
  138187. */
  138188. numberOfArrayElements: number;
  138189. /**
  138190. * Gets the number of faces
  138191. */
  138192. numberOfFaces: number;
  138193. /**
  138194. * Gets the number of mipmap levels
  138195. */
  138196. numberOfMipmapLevels: number;
  138197. /**
  138198. * Gets the bytes of key value data
  138199. */
  138200. bytesOfKeyValueData: number;
  138201. /**
  138202. * Gets the load type
  138203. */
  138204. loadType: number;
  138205. /**
  138206. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  138207. */
  138208. isInvalid: boolean;
  138209. /**
  138210. * Creates a new KhronosTextureContainer
  138211. * @param data contents of the KTX container file
  138212. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  138213. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  138214. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  138215. */
  138216. constructor(
  138217. /** contents of the KTX container file */
  138218. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  138219. /**
  138220. * Uploads KTX content to a Babylon Texture.
  138221. * It is assumed that the texture has already been created & is currently bound
  138222. * @hidden
  138223. */
  138224. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  138225. private _upload2DCompressedLevels;
  138226. /**
  138227. * Checks if the given data starts with a KTX file identifier.
  138228. * @param data the data to check
  138229. * @returns true if the data is a KTX file or false otherwise
  138230. */
  138231. static IsValid(data: ArrayBufferView): boolean;
  138232. }
  138233. }
  138234. declare module BABYLON {
  138235. /**
  138236. * Helper class to push actions to a pool of workers.
  138237. */
  138238. export class WorkerPool implements IDisposable {
  138239. private _workerInfos;
  138240. private _pendingActions;
  138241. /**
  138242. * Constructor
  138243. * @param workers Array of workers to use for actions
  138244. */
  138245. constructor(workers: Array<Worker>);
  138246. /**
  138247. * Terminates all workers and clears any pending actions.
  138248. */
  138249. dispose(): void;
  138250. /**
  138251. * Pushes an action to the worker pool. If all the workers are active, the action will be
  138252. * pended until a worker has completed its action.
  138253. * @param action The action to perform. Call onComplete when the action is complete.
  138254. */
  138255. push(action: (worker: Worker, onComplete: () => void) => void): void;
  138256. private _execute;
  138257. }
  138258. }
  138259. declare module BABYLON {
  138260. /**
  138261. * Class for loading KTX2 files
  138262. * @hidden
  138263. */
  138264. export class KhronosTextureContainer2 {
  138265. private static _WorkerPoolPromise?;
  138266. private static _Initialized;
  138267. private static _Ktx2Decoder;
  138268. /**
  138269. * URL to use when loading the KTX2 decoder module
  138270. */
  138271. static JSModuleURL: string;
  138272. /**
  138273. * Default number of workers used to handle data decoding
  138274. */
  138275. static DefaultNumWorkers: number;
  138276. private static GetDefaultNumWorkers;
  138277. private _engine;
  138278. private static _CreateWorkerPool;
  138279. /**
  138280. * Constructor
  138281. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  138282. */
  138283. constructor(engine: ThinEngine, numWorkers?: number);
  138284. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  138285. /**
  138286. * Stop all async operations and release resources.
  138287. */
  138288. dispose(): void;
  138289. protected _createTexture(data: any, internalTexture: InternalTexture): void;
  138290. /**
  138291. * Checks if the given data starts with a KTX2 file identifier.
  138292. * @param data the data to check
  138293. * @returns true if the data is a KTX2 file or false otherwise
  138294. */
  138295. static IsValid(data: ArrayBufferView): boolean;
  138296. }
  138297. export function workerFunc(): void;
  138298. }
  138299. declare module BABYLON {
  138300. /**
  138301. * Implementation of the KTX Texture Loader.
  138302. * @hidden
  138303. */
  138304. export class _KTXTextureLoader implements IInternalTextureLoader {
  138305. /**
  138306. * Defines wether the loader supports cascade loading the different faces.
  138307. */
  138308. readonly supportCascades: boolean;
  138309. /**
  138310. * This returns if the loader support the current file information.
  138311. * @param extension defines the file extension of the file being loaded
  138312. * @param mimeType defines the optional mime type of the file being loaded
  138313. * @returns true if the loader can load the specified file
  138314. */
  138315. canLoad(extension: string, mimeType?: string): boolean;
  138316. /**
  138317. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  138318. * @param data contains the texture data
  138319. * @param texture defines the BabylonJS internal texture
  138320. * @param createPolynomials will be true if polynomials have been requested
  138321. * @param onLoad defines the callback to trigger once the texture is ready
  138322. * @param onError defines the callback to trigger in case of error
  138323. */
  138324. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  138325. /**
  138326. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  138327. * @param data contains the texture data
  138328. * @param texture defines the BabylonJS internal texture
  138329. * @param callback defines the method to call once ready to upload
  138330. */
  138331. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  138332. }
  138333. }
  138334. declare module BABYLON {
  138335. /** @hidden */
  138336. export var _forceSceneHelpersToBundle: boolean;
  138337. interface Scene {
  138338. /**
  138339. * Creates a default light for the scene.
  138340. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  138341. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  138342. */
  138343. createDefaultLight(replace?: boolean): void;
  138344. /**
  138345. * Creates a default camera for the scene.
  138346. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  138347. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  138348. * @param replace has default false, when true replaces the active camera in the scene
  138349. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  138350. */
  138351. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  138352. /**
  138353. * Creates a default camera and a default light.
  138354. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  138355. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  138356. * @param replace has the default false, when true replaces the active camera/light in the scene
  138357. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  138358. */
  138359. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  138360. /**
  138361. * Creates a new sky box
  138362. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  138363. * @param environmentTexture defines the texture to use as environment texture
  138364. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  138365. * @param scale defines the overall scale of the skybox
  138366. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  138367. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  138368. * @returns a new mesh holding the sky box
  138369. */
  138370. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  138371. /**
  138372. * Creates a new environment
  138373. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  138374. * @param options defines the options you can use to configure the environment
  138375. * @returns the new EnvironmentHelper
  138376. */
  138377. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  138378. /**
  138379. * Creates a new VREXperienceHelper
  138380. * @see https://doc.babylonjs.com/how_to/webvr_helper
  138381. * @param webVROptions defines the options used to create the new VREXperienceHelper
  138382. * @returns a new VREXperienceHelper
  138383. */
  138384. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  138385. /**
  138386. * Creates a new WebXRDefaultExperience
  138387. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  138388. * @param options experience options
  138389. * @returns a promise for a new WebXRDefaultExperience
  138390. */
  138391. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  138392. }
  138393. }
  138394. declare module BABYLON {
  138395. /**
  138396. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  138397. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  138398. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  138399. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  138400. */
  138401. export class VideoDome extends TextureDome<VideoTexture> {
  138402. /**
  138403. * Define the video source as a Monoscopic panoramic 360 video.
  138404. */
  138405. static readonly MODE_MONOSCOPIC: number;
  138406. /**
  138407. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  138408. */
  138409. static readonly MODE_TOPBOTTOM: number;
  138410. /**
  138411. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  138412. */
  138413. static readonly MODE_SIDEBYSIDE: number;
  138414. /**
  138415. * Get the video texture associated with this video dome
  138416. */
  138417. get videoTexture(): VideoTexture;
  138418. /**
  138419. * Get the video mode of this dome
  138420. */
  138421. get videoMode(): number;
  138422. /**
  138423. * Set the video mode of this dome.
  138424. * @see textureMode
  138425. */
  138426. set videoMode(value: number);
  138427. protected _initTexture(urlsOrElement: string | string[] | HTMLVideoElement, scene: Scene, options: any): VideoTexture;
  138428. }
  138429. }
  138430. declare module BABYLON {
  138431. /**
  138432. * This class can be used to get instrumentation data from a Babylon engine
  138433. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  138434. */
  138435. export class EngineInstrumentation implements IDisposable {
  138436. /**
  138437. * Define the instrumented engine.
  138438. */
  138439. engine: Engine;
  138440. private _captureGPUFrameTime;
  138441. private _gpuFrameTimeToken;
  138442. private _gpuFrameTime;
  138443. private _captureShaderCompilationTime;
  138444. private _shaderCompilationTime;
  138445. private _onBeginFrameObserver;
  138446. private _onEndFrameObserver;
  138447. private _onBeforeShaderCompilationObserver;
  138448. private _onAfterShaderCompilationObserver;
  138449. /**
  138450. * Gets the perf counter used for GPU frame time
  138451. */
  138452. get gpuFrameTimeCounter(): PerfCounter;
  138453. /**
  138454. * Gets the GPU frame time capture status
  138455. */
  138456. get captureGPUFrameTime(): boolean;
  138457. /**
  138458. * Enable or disable the GPU frame time capture
  138459. */
  138460. set captureGPUFrameTime(value: boolean);
  138461. /**
  138462. * Gets the perf counter used for shader compilation time
  138463. */
  138464. get shaderCompilationTimeCounter(): PerfCounter;
  138465. /**
  138466. * Gets the shader compilation time capture status
  138467. */
  138468. get captureShaderCompilationTime(): boolean;
  138469. /**
  138470. * Enable or disable the shader compilation time capture
  138471. */
  138472. set captureShaderCompilationTime(value: boolean);
  138473. /**
  138474. * Instantiates a new engine instrumentation.
  138475. * This class can be used to get instrumentation data from a Babylon engine
  138476. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  138477. * @param engine Defines the engine to instrument
  138478. */
  138479. constructor(
  138480. /**
  138481. * Define the instrumented engine.
  138482. */
  138483. engine: Engine);
  138484. /**
  138485. * Dispose and release associated resources.
  138486. */
  138487. dispose(): void;
  138488. }
  138489. }
  138490. declare module BABYLON {
  138491. /**
  138492. * This class can be used to get instrumentation data from a Babylon engine
  138493. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  138494. */
  138495. export class SceneInstrumentation implements IDisposable {
  138496. /**
  138497. * Defines the scene to instrument
  138498. */
  138499. scene: Scene;
  138500. private _captureActiveMeshesEvaluationTime;
  138501. private _activeMeshesEvaluationTime;
  138502. private _captureRenderTargetsRenderTime;
  138503. private _renderTargetsRenderTime;
  138504. private _captureFrameTime;
  138505. private _frameTime;
  138506. private _captureRenderTime;
  138507. private _renderTime;
  138508. private _captureInterFrameTime;
  138509. private _interFrameTime;
  138510. private _captureParticlesRenderTime;
  138511. private _particlesRenderTime;
  138512. private _captureSpritesRenderTime;
  138513. private _spritesRenderTime;
  138514. private _capturePhysicsTime;
  138515. private _physicsTime;
  138516. private _captureAnimationsTime;
  138517. private _animationsTime;
  138518. private _captureCameraRenderTime;
  138519. private _cameraRenderTime;
  138520. private _onBeforeActiveMeshesEvaluationObserver;
  138521. private _onAfterActiveMeshesEvaluationObserver;
  138522. private _onBeforeRenderTargetsRenderObserver;
  138523. private _onAfterRenderTargetsRenderObserver;
  138524. private _onAfterRenderObserver;
  138525. private _onBeforeDrawPhaseObserver;
  138526. private _onAfterDrawPhaseObserver;
  138527. private _onBeforeAnimationsObserver;
  138528. private _onBeforeParticlesRenderingObserver;
  138529. private _onAfterParticlesRenderingObserver;
  138530. private _onBeforeSpritesRenderingObserver;
  138531. private _onAfterSpritesRenderingObserver;
  138532. private _onBeforePhysicsObserver;
  138533. private _onAfterPhysicsObserver;
  138534. private _onAfterAnimationsObserver;
  138535. private _onBeforeCameraRenderObserver;
  138536. private _onAfterCameraRenderObserver;
  138537. /**
  138538. * Gets the perf counter used for active meshes evaluation time
  138539. */
  138540. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  138541. /**
  138542. * Gets the active meshes evaluation time capture status
  138543. */
  138544. get captureActiveMeshesEvaluationTime(): boolean;
  138545. /**
  138546. * Enable or disable the active meshes evaluation time capture
  138547. */
  138548. set captureActiveMeshesEvaluationTime(value: boolean);
  138549. /**
  138550. * Gets the perf counter used for render targets render time
  138551. */
  138552. get renderTargetsRenderTimeCounter(): PerfCounter;
  138553. /**
  138554. * Gets the render targets render time capture status
  138555. */
  138556. get captureRenderTargetsRenderTime(): boolean;
  138557. /**
  138558. * Enable or disable the render targets render time capture
  138559. */
  138560. set captureRenderTargetsRenderTime(value: boolean);
  138561. /**
  138562. * Gets the perf counter used for particles render time
  138563. */
  138564. get particlesRenderTimeCounter(): PerfCounter;
  138565. /**
  138566. * Gets the particles render time capture status
  138567. */
  138568. get captureParticlesRenderTime(): boolean;
  138569. /**
  138570. * Enable or disable the particles render time capture
  138571. */
  138572. set captureParticlesRenderTime(value: boolean);
  138573. /**
  138574. * Gets the perf counter used for sprites render time
  138575. */
  138576. get spritesRenderTimeCounter(): PerfCounter;
  138577. /**
  138578. * Gets the sprites render time capture status
  138579. */
  138580. get captureSpritesRenderTime(): boolean;
  138581. /**
  138582. * Enable or disable the sprites render time capture
  138583. */
  138584. set captureSpritesRenderTime(value: boolean);
  138585. /**
  138586. * Gets the perf counter used for physics time
  138587. */
  138588. get physicsTimeCounter(): PerfCounter;
  138589. /**
  138590. * Gets the physics time capture status
  138591. */
  138592. get capturePhysicsTime(): boolean;
  138593. /**
  138594. * Enable or disable the physics time capture
  138595. */
  138596. set capturePhysicsTime(value: boolean);
  138597. /**
  138598. * Gets the perf counter used for animations time
  138599. */
  138600. get animationsTimeCounter(): PerfCounter;
  138601. /**
  138602. * Gets the animations time capture status
  138603. */
  138604. get captureAnimationsTime(): boolean;
  138605. /**
  138606. * Enable or disable the animations time capture
  138607. */
  138608. set captureAnimationsTime(value: boolean);
  138609. /**
  138610. * Gets the perf counter used for frame time capture
  138611. */
  138612. get frameTimeCounter(): PerfCounter;
  138613. /**
  138614. * Gets the frame time capture status
  138615. */
  138616. get captureFrameTime(): boolean;
  138617. /**
  138618. * Enable or disable the frame time capture
  138619. */
  138620. set captureFrameTime(value: boolean);
  138621. /**
  138622. * Gets the perf counter used for inter-frames time capture
  138623. */
  138624. get interFrameTimeCounter(): PerfCounter;
  138625. /**
  138626. * Gets the inter-frames time capture status
  138627. */
  138628. get captureInterFrameTime(): boolean;
  138629. /**
  138630. * Enable or disable the inter-frames time capture
  138631. */
  138632. set captureInterFrameTime(value: boolean);
  138633. /**
  138634. * Gets the perf counter used for render time capture
  138635. */
  138636. get renderTimeCounter(): PerfCounter;
  138637. /**
  138638. * Gets the render time capture status
  138639. */
  138640. get captureRenderTime(): boolean;
  138641. /**
  138642. * Enable or disable the render time capture
  138643. */
  138644. set captureRenderTime(value: boolean);
  138645. /**
  138646. * Gets the perf counter used for camera render time capture
  138647. */
  138648. get cameraRenderTimeCounter(): PerfCounter;
  138649. /**
  138650. * Gets the camera render time capture status
  138651. */
  138652. get captureCameraRenderTime(): boolean;
  138653. /**
  138654. * Enable or disable the camera render time capture
  138655. */
  138656. set captureCameraRenderTime(value: boolean);
  138657. /**
  138658. * Gets the perf counter used for draw calls
  138659. */
  138660. get drawCallsCounter(): PerfCounter;
  138661. /**
  138662. * Instantiates a new scene instrumentation.
  138663. * This class can be used to get instrumentation data from a Babylon engine
  138664. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  138665. * @param scene Defines the scene to instrument
  138666. */
  138667. constructor(
  138668. /**
  138669. * Defines the scene to instrument
  138670. */
  138671. scene: Scene);
  138672. /**
  138673. * Dispose and release associated resources.
  138674. */
  138675. dispose(): void;
  138676. }
  138677. }
  138678. declare module BABYLON {
  138679. /** @hidden */
  138680. export var glowMapGenerationPixelShader: {
  138681. name: string;
  138682. shader: string;
  138683. };
  138684. }
  138685. declare module BABYLON {
  138686. /** @hidden */
  138687. export var glowMapGenerationVertexShader: {
  138688. name: string;
  138689. shader: string;
  138690. };
  138691. }
  138692. declare module BABYLON {
  138693. /**
  138694. * Effect layer options. This helps customizing the behaviour
  138695. * of the effect layer.
  138696. */
  138697. export interface IEffectLayerOptions {
  138698. /**
  138699. * Multiplication factor apply to the canvas size to compute the render target size
  138700. * used to generated the objects (the smaller the faster).
  138701. */
  138702. mainTextureRatio: number;
  138703. /**
  138704. * Enforces a fixed size texture to ensure effect stability across devices.
  138705. */
  138706. mainTextureFixedSize?: number;
  138707. /**
  138708. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  138709. */
  138710. alphaBlendingMode: number;
  138711. /**
  138712. * The camera attached to the layer.
  138713. */
  138714. camera: Nullable<Camera>;
  138715. /**
  138716. * The rendering group to draw the layer in.
  138717. */
  138718. renderingGroupId: number;
  138719. }
  138720. /**
  138721. * The effect layer Helps adding post process effect blended with the main pass.
  138722. *
  138723. * This can be for instance use to generate glow or higlight effects on the scene.
  138724. *
  138725. * The effect layer class can not be used directly and is intented to inherited from to be
  138726. * customized per effects.
  138727. */
  138728. export abstract class EffectLayer {
  138729. private _vertexBuffers;
  138730. private _indexBuffer;
  138731. private _cachedDefines;
  138732. private _effectLayerMapGenerationEffect;
  138733. private _effectLayerOptions;
  138734. private _mergeEffect;
  138735. protected _scene: Scene;
  138736. protected _engine: Engine;
  138737. protected _maxSize: number;
  138738. protected _mainTextureDesiredSize: ISize;
  138739. protected _mainTexture: RenderTargetTexture;
  138740. protected _shouldRender: boolean;
  138741. protected _postProcesses: PostProcess[];
  138742. protected _textures: BaseTexture[];
  138743. protected _emissiveTextureAndColor: {
  138744. texture: Nullable<BaseTexture>;
  138745. color: Color4;
  138746. };
  138747. /**
  138748. * The name of the layer
  138749. */
  138750. name: string;
  138751. /**
  138752. * The clear color of the texture used to generate the glow map.
  138753. */
  138754. neutralColor: Color4;
  138755. /**
  138756. * Specifies whether the highlight layer is enabled or not.
  138757. */
  138758. isEnabled: boolean;
  138759. /**
  138760. * Gets the camera attached to the layer.
  138761. */
  138762. get camera(): Nullable<Camera>;
  138763. /**
  138764. * Gets the rendering group id the layer should render in.
  138765. */
  138766. get renderingGroupId(): number;
  138767. set renderingGroupId(renderingGroupId: number);
  138768. /**
  138769. * An event triggered when the effect layer has been disposed.
  138770. */
  138771. onDisposeObservable: Observable<EffectLayer>;
  138772. /**
  138773. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  138774. */
  138775. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  138776. /**
  138777. * An event triggered when the generated texture is being merged in the scene.
  138778. */
  138779. onBeforeComposeObservable: Observable<EffectLayer>;
  138780. /**
  138781. * An event triggered when the mesh is rendered into the effect render target.
  138782. */
  138783. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  138784. /**
  138785. * An event triggered after the mesh has been rendered into the effect render target.
  138786. */
  138787. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  138788. /**
  138789. * An event triggered when the generated texture has been merged in the scene.
  138790. */
  138791. onAfterComposeObservable: Observable<EffectLayer>;
  138792. /**
  138793. * An event triggered when the efffect layer changes its size.
  138794. */
  138795. onSizeChangedObservable: Observable<EffectLayer>;
  138796. /** @hidden */
  138797. static _SceneComponentInitialization: (scene: Scene) => void;
  138798. /**
  138799. * Instantiates a new effect Layer and references it in the scene.
  138800. * @param name The name of the layer
  138801. * @param scene The scene to use the layer in
  138802. */
  138803. constructor(
  138804. /** The Friendly of the effect in the scene */
  138805. name: string, scene: Scene);
  138806. /**
  138807. * Get the effect name of the layer.
  138808. * @return The effect name
  138809. */
  138810. abstract getEffectName(): string;
  138811. /**
  138812. * Checks for the readiness of the element composing the layer.
  138813. * @param subMesh the mesh to check for
  138814. * @param useInstances specify whether or not to use instances to render the mesh
  138815. * @return true if ready otherwise, false
  138816. */
  138817. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  138818. /**
  138819. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  138820. * @returns true if the effect requires stencil during the main canvas render pass.
  138821. */
  138822. abstract needStencil(): boolean;
  138823. /**
  138824. * Create the merge effect. This is the shader use to blit the information back
  138825. * to the main canvas at the end of the scene rendering.
  138826. * @returns The effect containing the shader used to merge the effect on the main canvas
  138827. */
  138828. protected abstract _createMergeEffect(): Effect;
  138829. /**
  138830. * Creates the render target textures and post processes used in the effect layer.
  138831. */
  138832. protected abstract _createTextureAndPostProcesses(): void;
  138833. /**
  138834. * Implementation specific of rendering the generating effect on the main canvas.
  138835. * @param effect The effect used to render through
  138836. */
  138837. protected abstract _internalRender(effect: Effect): void;
  138838. /**
  138839. * Sets the required values for both the emissive texture and and the main color.
  138840. */
  138841. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  138842. /**
  138843. * Free any resources and references associated to a mesh.
  138844. * Internal use
  138845. * @param mesh The mesh to free.
  138846. */
  138847. abstract _disposeMesh(mesh: Mesh): void;
  138848. /**
  138849. * Serializes this layer (Glow or Highlight for example)
  138850. * @returns a serialized layer object
  138851. */
  138852. abstract serialize?(): any;
  138853. /**
  138854. * Initializes the effect layer with the required options.
  138855. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  138856. */
  138857. protected _init(options: Partial<IEffectLayerOptions>): void;
  138858. /**
  138859. * Generates the index buffer of the full screen quad blending to the main canvas.
  138860. */
  138861. private _generateIndexBuffer;
  138862. /**
  138863. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  138864. */
  138865. private _generateVertexBuffer;
  138866. /**
  138867. * Sets the main texture desired size which is the closest power of two
  138868. * of the engine canvas size.
  138869. */
  138870. private _setMainTextureSize;
  138871. /**
  138872. * Creates the main texture for the effect layer.
  138873. */
  138874. protected _createMainTexture(): void;
  138875. /**
  138876. * Adds specific effects defines.
  138877. * @param defines The defines to add specifics to.
  138878. */
  138879. protected _addCustomEffectDefines(defines: string[]): void;
  138880. /**
  138881. * Checks for the readiness of the element composing the layer.
  138882. * @param subMesh the mesh to check for
  138883. * @param useInstances specify whether or not to use instances to render the mesh
  138884. * @param emissiveTexture the associated emissive texture used to generate the glow
  138885. * @return true if ready otherwise, false
  138886. */
  138887. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  138888. /**
  138889. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  138890. */
  138891. render(): void;
  138892. /**
  138893. * Determine if a given mesh will be used in the current effect.
  138894. * @param mesh mesh to test
  138895. * @returns true if the mesh will be used
  138896. */
  138897. hasMesh(mesh: AbstractMesh): boolean;
  138898. /**
  138899. * Returns true if the layer contains information to display, otherwise false.
  138900. * @returns true if the glow layer should be rendered
  138901. */
  138902. shouldRender(): boolean;
  138903. /**
  138904. * Returns true if the mesh should render, otherwise false.
  138905. * @param mesh The mesh to render
  138906. * @returns true if it should render otherwise false
  138907. */
  138908. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  138909. /**
  138910. * Returns true if the mesh can be rendered, otherwise false.
  138911. * @param mesh The mesh to render
  138912. * @param material The material used on the mesh
  138913. * @returns true if it can be rendered otherwise false
  138914. */
  138915. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  138916. /**
  138917. * Returns true if the mesh should render, otherwise false.
  138918. * @param mesh The mesh to render
  138919. * @returns true if it should render otherwise false
  138920. */
  138921. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  138922. /**
  138923. * Renders the submesh passed in parameter to the generation map.
  138924. */
  138925. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  138926. /**
  138927. * Defines whether the current material of the mesh should be use to render the effect.
  138928. * @param mesh defines the current mesh to render
  138929. */
  138930. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  138931. /**
  138932. * Rebuild the required buffers.
  138933. * @hidden Internal use only.
  138934. */
  138935. _rebuild(): void;
  138936. /**
  138937. * Dispose only the render target textures and post process.
  138938. */
  138939. private _disposeTextureAndPostProcesses;
  138940. /**
  138941. * Dispose the highlight layer and free resources.
  138942. */
  138943. dispose(): void;
  138944. /**
  138945. * Gets the class name of the effect layer
  138946. * @returns the string with the class name of the effect layer
  138947. */
  138948. getClassName(): string;
  138949. /**
  138950. * Creates an effect layer from parsed effect layer data
  138951. * @param parsedEffectLayer defines effect layer data
  138952. * @param scene defines the current scene
  138953. * @param rootUrl defines the root URL containing the effect layer information
  138954. * @returns a parsed effect Layer
  138955. */
  138956. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  138957. }
  138958. }
  138959. declare module BABYLON {
  138960. interface AbstractScene {
  138961. /**
  138962. * The list of effect layers (highlights/glow) added to the scene
  138963. * @see https://doc.babylonjs.com/how_to/highlight_layer
  138964. * @see https://doc.babylonjs.com/how_to/glow_layer
  138965. */
  138966. effectLayers: Array<EffectLayer>;
  138967. /**
  138968. * Removes the given effect layer from this scene.
  138969. * @param toRemove defines the effect layer to remove
  138970. * @returns the index of the removed effect layer
  138971. */
  138972. removeEffectLayer(toRemove: EffectLayer): number;
  138973. /**
  138974. * Adds the given effect layer to this scene
  138975. * @param newEffectLayer defines the effect layer to add
  138976. */
  138977. addEffectLayer(newEffectLayer: EffectLayer): void;
  138978. }
  138979. /**
  138980. * Defines the layer scene component responsible to manage any effect layers
  138981. * in a given scene.
  138982. */
  138983. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  138984. /**
  138985. * The component name helpfull to identify the component in the list of scene components.
  138986. */
  138987. readonly name: string;
  138988. /**
  138989. * The scene the component belongs to.
  138990. */
  138991. scene: Scene;
  138992. private _engine;
  138993. private _renderEffects;
  138994. private _needStencil;
  138995. private _previousStencilState;
  138996. /**
  138997. * Creates a new instance of the component for the given scene
  138998. * @param scene Defines the scene to register the component in
  138999. */
  139000. constructor(scene: Scene);
  139001. /**
  139002. * Registers the component in a given scene
  139003. */
  139004. register(): void;
  139005. /**
  139006. * Rebuilds the elements related to this component in case of
  139007. * context lost for instance.
  139008. */
  139009. rebuild(): void;
  139010. /**
  139011. * Serializes the component data to the specified json object
  139012. * @param serializationObject The object to serialize to
  139013. */
  139014. serialize(serializationObject: any): void;
  139015. /**
  139016. * Adds all the elements from the container to the scene
  139017. * @param container the container holding the elements
  139018. */
  139019. addFromContainer(container: AbstractScene): void;
  139020. /**
  139021. * Removes all the elements in the container from the scene
  139022. * @param container contains the elements to remove
  139023. * @param dispose if the removed element should be disposed (default: false)
  139024. */
  139025. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  139026. /**
  139027. * Disposes the component and the associated ressources.
  139028. */
  139029. dispose(): void;
  139030. private _isReadyForMesh;
  139031. private _renderMainTexture;
  139032. private _setStencil;
  139033. private _setStencilBack;
  139034. private _draw;
  139035. private _drawCamera;
  139036. private _drawRenderingGroup;
  139037. }
  139038. }
  139039. declare module BABYLON {
  139040. /** @hidden */
  139041. export var glowMapMergePixelShader: {
  139042. name: string;
  139043. shader: string;
  139044. };
  139045. }
  139046. declare module BABYLON {
  139047. /** @hidden */
  139048. export var glowMapMergeVertexShader: {
  139049. name: string;
  139050. shader: string;
  139051. };
  139052. }
  139053. declare module BABYLON {
  139054. interface AbstractScene {
  139055. /**
  139056. * Return a the first highlight layer of the scene with a given name.
  139057. * @param name The name of the highlight layer to look for.
  139058. * @return The highlight layer if found otherwise null.
  139059. */
  139060. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  139061. }
  139062. /**
  139063. * Glow layer options. This helps customizing the behaviour
  139064. * of the glow layer.
  139065. */
  139066. export interface IGlowLayerOptions {
  139067. /**
  139068. * Multiplication factor apply to the canvas size to compute the render target size
  139069. * used to generated the glowing objects (the smaller the faster).
  139070. */
  139071. mainTextureRatio: number;
  139072. /**
  139073. * Enforces a fixed size texture to ensure resize independant blur.
  139074. */
  139075. mainTextureFixedSize?: number;
  139076. /**
  139077. * How big is the kernel of the blur texture.
  139078. */
  139079. blurKernelSize: number;
  139080. /**
  139081. * The camera attached to the layer.
  139082. */
  139083. camera: Nullable<Camera>;
  139084. /**
  139085. * Enable MSAA by chosing the number of samples.
  139086. */
  139087. mainTextureSamples?: number;
  139088. /**
  139089. * The rendering group to draw the layer in.
  139090. */
  139091. renderingGroupId: number;
  139092. }
  139093. /**
  139094. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  139095. *
  139096. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  139097. *
  139098. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  139099. */
  139100. export class GlowLayer extends EffectLayer {
  139101. /**
  139102. * Effect Name of the layer.
  139103. */
  139104. static readonly EffectName: string;
  139105. /**
  139106. * The default blur kernel size used for the glow.
  139107. */
  139108. static DefaultBlurKernelSize: number;
  139109. /**
  139110. * The default texture size ratio used for the glow.
  139111. */
  139112. static DefaultTextureRatio: number;
  139113. /**
  139114. * Sets the kernel size of the blur.
  139115. */
  139116. set blurKernelSize(value: number);
  139117. /**
  139118. * Gets the kernel size of the blur.
  139119. */
  139120. get blurKernelSize(): number;
  139121. /**
  139122. * Sets the glow intensity.
  139123. */
  139124. set intensity(value: number);
  139125. /**
  139126. * Gets the glow intensity.
  139127. */
  139128. get intensity(): number;
  139129. private _options;
  139130. private _intensity;
  139131. private _horizontalBlurPostprocess1;
  139132. private _verticalBlurPostprocess1;
  139133. private _horizontalBlurPostprocess2;
  139134. private _verticalBlurPostprocess2;
  139135. private _blurTexture1;
  139136. private _blurTexture2;
  139137. private _postProcesses1;
  139138. private _postProcesses2;
  139139. private _includedOnlyMeshes;
  139140. private _excludedMeshes;
  139141. private _meshesUsingTheirOwnMaterials;
  139142. /**
  139143. * Callback used to let the user override the color selection on a per mesh basis
  139144. */
  139145. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  139146. /**
  139147. * Callback used to let the user override the texture selection on a per mesh basis
  139148. */
  139149. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  139150. /**
  139151. * Instantiates a new glow Layer and references it to the scene.
  139152. * @param name The name of the layer
  139153. * @param scene The scene to use the layer in
  139154. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  139155. */
  139156. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  139157. /**
  139158. * Get the effect name of the layer.
  139159. * @return The effect name
  139160. */
  139161. getEffectName(): string;
  139162. /**
  139163. * Create the merge effect. This is the shader use to blit the information back
  139164. * to the main canvas at the end of the scene rendering.
  139165. */
  139166. protected _createMergeEffect(): Effect;
  139167. /**
  139168. * Creates the render target textures and post processes used in the glow layer.
  139169. */
  139170. protected _createTextureAndPostProcesses(): void;
  139171. /**
  139172. * Checks for the readiness of the element composing the layer.
  139173. * @param subMesh the mesh to check for
  139174. * @param useInstances specify wether or not to use instances to render the mesh
  139175. * @param emissiveTexture the associated emissive texture used to generate the glow
  139176. * @return true if ready otherwise, false
  139177. */
  139178. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  139179. /**
  139180. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  139181. */
  139182. needStencil(): boolean;
  139183. /**
  139184. * Returns true if the mesh can be rendered, otherwise false.
  139185. * @param mesh The mesh to render
  139186. * @param material The material used on the mesh
  139187. * @returns true if it can be rendered otherwise false
  139188. */
  139189. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  139190. /**
  139191. * Implementation specific of rendering the generating effect on the main canvas.
  139192. * @param effect The effect used to render through
  139193. */
  139194. protected _internalRender(effect: Effect): void;
  139195. /**
  139196. * Sets the required values for both the emissive texture and and the main color.
  139197. */
  139198. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  139199. /**
  139200. * Returns true if the mesh should render, otherwise false.
  139201. * @param mesh The mesh to render
  139202. * @returns true if it should render otherwise false
  139203. */
  139204. protected _shouldRenderMesh(mesh: Mesh): boolean;
  139205. /**
  139206. * Adds specific effects defines.
  139207. * @param defines The defines to add specifics to.
  139208. */
  139209. protected _addCustomEffectDefines(defines: string[]): void;
  139210. /**
  139211. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  139212. * @param mesh The mesh to exclude from the glow layer
  139213. */
  139214. addExcludedMesh(mesh: Mesh): void;
  139215. /**
  139216. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  139217. * @param mesh The mesh to remove
  139218. */
  139219. removeExcludedMesh(mesh: Mesh): void;
  139220. /**
  139221. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  139222. * @param mesh The mesh to include in the glow layer
  139223. */
  139224. addIncludedOnlyMesh(mesh: Mesh): void;
  139225. /**
  139226. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  139227. * @param mesh The mesh to remove
  139228. */
  139229. removeIncludedOnlyMesh(mesh: Mesh): void;
  139230. /**
  139231. * Determine if a given mesh will be used in the glow layer
  139232. * @param mesh The mesh to test
  139233. * @returns true if the mesh will be highlighted by the current glow layer
  139234. */
  139235. hasMesh(mesh: AbstractMesh): boolean;
  139236. /**
  139237. * Defines whether the current material of the mesh should be use to render the effect.
  139238. * @param mesh defines the current mesh to render
  139239. */
  139240. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  139241. /**
  139242. * Add a mesh to be rendered through its own material and not with emissive only.
  139243. * @param mesh The mesh for which we need to use its material
  139244. */
  139245. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  139246. /**
  139247. * Remove a mesh from being rendered through its own material and not with emissive only.
  139248. * @param mesh The mesh for which we need to not use its material
  139249. */
  139250. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  139251. /**
  139252. * Free any resources and references associated to a mesh.
  139253. * Internal use
  139254. * @param mesh The mesh to free.
  139255. * @hidden
  139256. */
  139257. _disposeMesh(mesh: Mesh): void;
  139258. /**
  139259. * Gets the class name of the effect layer
  139260. * @returns the string with the class name of the effect layer
  139261. */
  139262. getClassName(): string;
  139263. /**
  139264. * Serializes this glow layer
  139265. * @returns a serialized glow layer object
  139266. */
  139267. serialize(): any;
  139268. /**
  139269. * Creates a Glow Layer from parsed glow layer data
  139270. * @param parsedGlowLayer defines glow layer data
  139271. * @param scene defines the current scene
  139272. * @param rootUrl defines the root URL containing the glow layer information
  139273. * @returns a parsed Glow Layer
  139274. */
  139275. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  139276. }
  139277. }
  139278. declare module BABYLON {
  139279. /** @hidden */
  139280. export var glowBlurPostProcessPixelShader: {
  139281. name: string;
  139282. shader: string;
  139283. };
  139284. }
  139285. declare module BABYLON {
  139286. interface AbstractScene {
  139287. /**
  139288. * Return a the first highlight layer of the scene with a given name.
  139289. * @param name The name of the highlight layer to look for.
  139290. * @return The highlight layer if found otherwise null.
  139291. */
  139292. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  139293. }
  139294. /**
  139295. * Highlight layer options. This helps customizing the behaviour
  139296. * of the highlight layer.
  139297. */
  139298. export interface IHighlightLayerOptions {
  139299. /**
  139300. * Multiplication factor apply to the canvas size to compute the render target size
  139301. * used to generated the glowing objects (the smaller the faster).
  139302. */
  139303. mainTextureRatio: number;
  139304. /**
  139305. * Enforces a fixed size texture to ensure resize independant blur.
  139306. */
  139307. mainTextureFixedSize?: number;
  139308. /**
  139309. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  139310. * of the picture to blur (the smaller the faster).
  139311. */
  139312. blurTextureSizeRatio: number;
  139313. /**
  139314. * How big in texel of the blur texture is the vertical blur.
  139315. */
  139316. blurVerticalSize: number;
  139317. /**
  139318. * How big in texel of the blur texture is the horizontal blur.
  139319. */
  139320. blurHorizontalSize: number;
  139321. /**
  139322. * Alpha blending mode used to apply the blur. Default is combine.
  139323. */
  139324. alphaBlendingMode: number;
  139325. /**
  139326. * The camera attached to the layer.
  139327. */
  139328. camera: Nullable<Camera>;
  139329. /**
  139330. * Should we display highlight as a solid stroke?
  139331. */
  139332. isStroke?: boolean;
  139333. /**
  139334. * The rendering group to draw the layer in.
  139335. */
  139336. renderingGroupId: number;
  139337. }
  139338. /**
  139339. * The highlight layer Helps adding a glow effect around a mesh.
  139340. *
  139341. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  139342. * glowy meshes to your scene.
  139343. *
  139344. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  139345. */
  139346. export class HighlightLayer extends EffectLayer {
  139347. name: string;
  139348. /**
  139349. * Effect Name of the highlight layer.
  139350. */
  139351. static readonly EffectName: string;
  139352. /**
  139353. * The neutral color used during the preparation of the glow effect.
  139354. * This is black by default as the blend operation is a blend operation.
  139355. */
  139356. static NeutralColor: Color4;
  139357. /**
  139358. * Stencil value used for glowing meshes.
  139359. */
  139360. static GlowingMeshStencilReference: number;
  139361. /**
  139362. * Stencil value used for the other meshes in the scene.
  139363. */
  139364. static NormalMeshStencilReference: number;
  139365. /**
  139366. * Specifies whether or not the inner glow is ACTIVE in the layer.
  139367. */
  139368. innerGlow: boolean;
  139369. /**
  139370. * Specifies whether or not the outer glow is ACTIVE in the layer.
  139371. */
  139372. outerGlow: boolean;
  139373. /**
  139374. * Specifies the horizontal size of the blur.
  139375. */
  139376. set blurHorizontalSize(value: number);
  139377. /**
  139378. * Specifies the vertical size of the blur.
  139379. */
  139380. set blurVerticalSize(value: number);
  139381. /**
  139382. * Gets the horizontal size of the blur.
  139383. */
  139384. get blurHorizontalSize(): number;
  139385. /**
  139386. * Gets the vertical size of the blur.
  139387. */
  139388. get blurVerticalSize(): number;
  139389. /**
  139390. * An event triggered when the highlight layer is being blurred.
  139391. */
  139392. onBeforeBlurObservable: Observable<HighlightLayer>;
  139393. /**
  139394. * An event triggered when the highlight layer has been blurred.
  139395. */
  139396. onAfterBlurObservable: Observable<HighlightLayer>;
  139397. private _instanceGlowingMeshStencilReference;
  139398. private _options;
  139399. private _downSamplePostprocess;
  139400. private _horizontalBlurPostprocess;
  139401. private _verticalBlurPostprocess;
  139402. private _blurTexture;
  139403. private _meshes;
  139404. private _excludedMeshes;
  139405. /**
  139406. * Instantiates a new highlight Layer and references it to the scene..
  139407. * @param name The name of the layer
  139408. * @param scene The scene to use the layer in
  139409. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  139410. */
  139411. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  139412. /**
  139413. * Get the effect name of the layer.
  139414. * @return The effect name
  139415. */
  139416. getEffectName(): string;
  139417. /**
  139418. * Create the merge effect. This is the shader use to blit the information back
  139419. * to the main canvas at the end of the scene rendering.
  139420. */
  139421. protected _createMergeEffect(): Effect;
  139422. /**
  139423. * Creates the render target textures and post processes used in the highlight layer.
  139424. */
  139425. protected _createTextureAndPostProcesses(): void;
  139426. /**
  139427. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  139428. */
  139429. needStencil(): boolean;
  139430. /**
  139431. * Checks for the readiness of the element composing the layer.
  139432. * @param subMesh the mesh to check for
  139433. * @param useInstances specify wether or not to use instances to render the mesh
  139434. * @param emissiveTexture the associated emissive texture used to generate the glow
  139435. * @return true if ready otherwise, false
  139436. */
  139437. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  139438. /**
  139439. * Implementation specific of rendering the generating effect on the main canvas.
  139440. * @param effect The effect used to render through
  139441. */
  139442. protected _internalRender(effect: Effect): void;
  139443. /**
  139444. * Returns true if the layer contains information to display, otherwise false.
  139445. */
  139446. shouldRender(): boolean;
  139447. /**
  139448. * Returns true if the mesh should render, otherwise false.
  139449. * @param mesh The mesh to render
  139450. * @returns true if it should render otherwise false
  139451. */
  139452. protected _shouldRenderMesh(mesh: Mesh): boolean;
  139453. /**
  139454. * Returns true if the mesh can be rendered, otherwise false.
  139455. * @param mesh The mesh to render
  139456. * @param material The material used on the mesh
  139457. * @returns true if it can be rendered otherwise false
  139458. */
  139459. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  139460. /**
  139461. * Adds specific effects defines.
  139462. * @param defines The defines to add specifics to.
  139463. */
  139464. protected _addCustomEffectDefines(defines: string[]): void;
  139465. /**
  139466. * Sets the required values for both the emissive texture and and the main color.
  139467. */
  139468. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  139469. /**
  139470. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  139471. * @param mesh The mesh to exclude from the highlight layer
  139472. */
  139473. addExcludedMesh(mesh: Mesh): void;
  139474. /**
  139475. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  139476. * @param mesh The mesh to highlight
  139477. */
  139478. removeExcludedMesh(mesh: Mesh): void;
  139479. /**
  139480. * Determine if a given mesh will be highlighted by the current HighlightLayer
  139481. * @param mesh mesh to test
  139482. * @returns true if the mesh will be highlighted by the current HighlightLayer
  139483. */
  139484. hasMesh(mesh: AbstractMesh): boolean;
  139485. /**
  139486. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  139487. * @param mesh The mesh to highlight
  139488. * @param color The color of the highlight
  139489. * @param glowEmissiveOnly Extract the glow from the emissive texture
  139490. */
  139491. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  139492. /**
  139493. * Remove a mesh from the highlight layer in order to make it stop glowing.
  139494. * @param mesh The mesh to highlight
  139495. */
  139496. removeMesh(mesh: Mesh): void;
  139497. /**
  139498. * Remove all the meshes currently referenced in the highlight layer
  139499. */
  139500. removeAllMeshes(): void;
  139501. /**
  139502. * Force the stencil to the normal expected value for none glowing parts
  139503. */
  139504. private _defaultStencilReference;
  139505. /**
  139506. * Free any resources and references associated to a mesh.
  139507. * Internal use
  139508. * @param mesh The mesh to free.
  139509. * @hidden
  139510. */
  139511. _disposeMesh(mesh: Mesh): void;
  139512. /**
  139513. * Dispose the highlight layer and free resources.
  139514. */
  139515. dispose(): void;
  139516. /**
  139517. * Gets the class name of the effect layer
  139518. * @returns the string with the class name of the effect layer
  139519. */
  139520. getClassName(): string;
  139521. /**
  139522. * Serializes this Highlight layer
  139523. * @returns a serialized Highlight layer object
  139524. */
  139525. serialize(): any;
  139526. /**
  139527. * Creates a Highlight layer from parsed Highlight layer data
  139528. * @param parsedHightlightLayer defines the Highlight layer data
  139529. * @param scene defines the current scene
  139530. * @param rootUrl defines the root URL containing the Highlight layer information
  139531. * @returns a parsed Highlight layer
  139532. */
  139533. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  139534. }
  139535. }
  139536. declare module BABYLON {
  139537. interface AbstractScene {
  139538. /**
  139539. * The list of layers (background and foreground) of the scene
  139540. */
  139541. layers: Array<Layer>;
  139542. }
  139543. /**
  139544. * Defines the layer scene component responsible to manage any layers
  139545. * in a given scene.
  139546. */
  139547. export class LayerSceneComponent implements ISceneComponent {
  139548. /**
  139549. * The component name helpfull to identify the component in the list of scene components.
  139550. */
  139551. readonly name: string;
  139552. /**
  139553. * The scene the component belongs to.
  139554. */
  139555. scene: Scene;
  139556. private _engine;
  139557. /**
  139558. * Creates a new instance of the component for the given scene
  139559. * @param scene Defines the scene to register the component in
  139560. */
  139561. constructor(scene: Scene);
  139562. /**
  139563. * Registers the component in a given scene
  139564. */
  139565. register(): void;
  139566. /**
  139567. * Rebuilds the elements related to this component in case of
  139568. * context lost for instance.
  139569. */
  139570. rebuild(): void;
  139571. /**
  139572. * Disposes the component and the associated ressources.
  139573. */
  139574. dispose(): void;
  139575. private _draw;
  139576. private _drawCameraPredicate;
  139577. private _drawCameraBackground;
  139578. private _drawCameraForeground;
  139579. private _drawRenderTargetPredicate;
  139580. private _drawRenderTargetBackground;
  139581. private _drawRenderTargetForeground;
  139582. /**
  139583. * Adds all the elements from the container to the scene
  139584. * @param container the container holding the elements
  139585. */
  139586. addFromContainer(container: AbstractScene): void;
  139587. /**
  139588. * Removes all the elements in the container from the scene
  139589. * @param container contains the elements to remove
  139590. * @param dispose if the removed element should be disposed (default: false)
  139591. */
  139592. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  139593. }
  139594. }
  139595. declare module BABYLON {
  139596. /** @hidden */
  139597. export var layerPixelShader: {
  139598. name: string;
  139599. shader: string;
  139600. };
  139601. }
  139602. declare module BABYLON {
  139603. /** @hidden */
  139604. export var layerVertexShader: {
  139605. name: string;
  139606. shader: string;
  139607. };
  139608. }
  139609. declare module BABYLON {
  139610. /**
  139611. * This represents a full screen 2d layer.
  139612. * This can be useful to display a picture in the background of your scene for instance.
  139613. * @see https://www.babylonjs-playground.com/#08A2BS#1
  139614. */
  139615. export class Layer {
  139616. /**
  139617. * Define the name of the layer.
  139618. */
  139619. name: string;
  139620. /**
  139621. * Define the texture the layer should display.
  139622. */
  139623. texture: Nullable<Texture>;
  139624. /**
  139625. * Is the layer in background or foreground.
  139626. */
  139627. isBackground: boolean;
  139628. /**
  139629. * Define the color of the layer (instead of texture).
  139630. */
  139631. color: Color4;
  139632. /**
  139633. * Define the scale of the layer in order to zoom in out of the texture.
  139634. */
  139635. scale: Vector2;
  139636. /**
  139637. * Define an offset for the layer in order to shift the texture.
  139638. */
  139639. offset: Vector2;
  139640. /**
  139641. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  139642. */
  139643. alphaBlendingMode: number;
  139644. /**
  139645. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  139646. * Alpha test will not mix with the background color in case of transparency.
  139647. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  139648. */
  139649. alphaTest: boolean;
  139650. /**
  139651. * Define a mask to restrict the layer to only some of the scene cameras.
  139652. */
  139653. layerMask: number;
  139654. /**
  139655. * Define the list of render target the layer is visible into.
  139656. */
  139657. renderTargetTextures: RenderTargetTexture[];
  139658. /**
  139659. * Define if the layer is only used in renderTarget or if it also
  139660. * renders in the main frame buffer of the canvas.
  139661. */
  139662. renderOnlyInRenderTargetTextures: boolean;
  139663. private _scene;
  139664. private _vertexBuffers;
  139665. private _indexBuffer;
  139666. private _effect;
  139667. private _previousDefines;
  139668. /**
  139669. * An event triggered when the layer is disposed.
  139670. */
  139671. onDisposeObservable: Observable<Layer>;
  139672. private _onDisposeObserver;
  139673. /**
  139674. * Back compatibility with callback before the onDisposeObservable existed.
  139675. * The set callback will be triggered when the layer has been disposed.
  139676. */
  139677. set onDispose(callback: () => void);
  139678. /**
  139679. * An event triggered before rendering the scene
  139680. */
  139681. onBeforeRenderObservable: Observable<Layer>;
  139682. private _onBeforeRenderObserver;
  139683. /**
  139684. * Back compatibility with callback before the onBeforeRenderObservable existed.
  139685. * The set callback will be triggered just before rendering the layer.
  139686. */
  139687. set onBeforeRender(callback: () => void);
  139688. /**
  139689. * An event triggered after rendering the scene
  139690. */
  139691. onAfterRenderObservable: Observable<Layer>;
  139692. private _onAfterRenderObserver;
  139693. /**
  139694. * Back compatibility with callback before the onAfterRenderObservable existed.
  139695. * The set callback will be triggered just after rendering the layer.
  139696. */
  139697. set onAfterRender(callback: () => void);
  139698. /**
  139699. * Instantiates a new layer.
  139700. * This represents a full screen 2d layer.
  139701. * This can be useful to display a picture in the background of your scene for instance.
  139702. * @see https://www.babylonjs-playground.com/#08A2BS#1
  139703. * @param name Define the name of the layer in the scene
  139704. * @param imgUrl Define the url of the texture to display in the layer
  139705. * @param scene Define the scene the layer belongs to
  139706. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  139707. * @param color Defines a color for the layer
  139708. */
  139709. constructor(
  139710. /**
  139711. * Define the name of the layer.
  139712. */
  139713. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  139714. private _createIndexBuffer;
  139715. /** @hidden */
  139716. _rebuild(): void;
  139717. /**
  139718. * Renders the layer in the scene.
  139719. */
  139720. render(): void;
  139721. /**
  139722. * Disposes and releases the associated ressources.
  139723. */
  139724. dispose(): void;
  139725. }
  139726. }
  139727. declare module BABYLON {
  139728. /** @hidden */
  139729. export var lensFlarePixelShader: {
  139730. name: string;
  139731. shader: string;
  139732. };
  139733. }
  139734. declare module BABYLON {
  139735. /** @hidden */
  139736. export var lensFlareVertexShader: {
  139737. name: string;
  139738. shader: string;
  139739. };
  139740. }
  139741. declare module BABYLON {
  139742. /**
  139743. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  139744. * It is usually composed of several `lensFlare`.
  139745. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  139746. */
  139747. export class LensFlareSystem {
  139748. /**
  139749. * Define the name of the lens flare system
  139750. */
  139751. name: string;
  139752. /**
  139753. * List of lens flares used in this system.
  139754. */
  139755. lensFlares: LensFlare[];
  139756. /**
  139757. * Define a limit from the border the lens flare can be visible.
  139758. */
  139759. borderLimit: number;
  139760. /**
  139761. * Define a viewport border we do not want to see the lens flare in.
  139762. */
  139763. viewportBorder: number;
  139764. /**
  139765. * Define a predicate which could limit the list of meshes able to occlude the effect.
  139766. */
  139767. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  139768. /**
  139769. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  139770. */
  139771. layerMask: number;
  139772. /**
  139773. * Define the id of the lens flare system in the scene.
  139774. * (equal to name by default)
  139775. */
  139776. id: string;
  139777. private _scene;
  139778. private _emitter;
  139779. private _vertexBuffers;
  139780. private _indexBuffer;
  139781. private _effect;
  139782. private _positionX;
  139783. private _positionY;
  139784. private _isEnabled;
  139785. /** @hidden */
  139786. static _SceneComponentInitialization: (scene: Scene) => void;
  139787. /**
  139788. * Instantiates a lens flare system.
  139789. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  139790. * It is usually composed of several `lensFlare`.
  139791. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  139792. * @param name Define the name of the lens flare system in the scene
  139793. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  139794. * @param scene Define the scene the lens flare system belongs to
  139795. */
  139796. constructor(
  139797. /**
  139798. * Define the name of the lens flare system
  139799. */
  139800. name: string, emitter: any, scene: Scene);
  139801. /**
  139802. * Define if the lens flare system is enabled.
  139803. */
  139804. get isEnabled(): boolean;
  139805. set isEnabled(value: boolean);
  139806. /**
  139807. * Get the scene the effects belongs to.
  139808. * @returns the scene holding the lens flare system
  139809. */
  139810. getScene(): Scene;
  139811. /**
  139812. * Get the emitter of the lens flare system.
  139813. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  139814. * @returns the emitter of the lens flare system
  139815. */
  139816. getEmitter(): any;
  139817. /**
  139818. * Set the emitter of the lens flare system.
  139819. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  139820. * @param newEmitter Define the new emitter of the system
  139821. */
  139822. setEmitter(newEmitter: any): void;
  139823. /**
  139824. * Get the lens flare system emitter position.
  139825. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  139826. * @returns the position
  139827. */
  139828. getEmitterPosition(): Vector3;
  139829. /**
  139830. * @hidden
  139831. */
  139832. computeEffectivePosition(globalViewport: Viewport): boolean;
  139833. /** @hidden */
  139834. _isVisible(): boolean;
  139835. /**
  139836. * @hidden
  139837. */
  139838. render(): boolean;
  139839. /**
  139840. * Dispose and release the lens flare with its associated resources.
  139841. */
  139842. dispose(): void;
  139843. /**
  139844. * Parse a lens flare system from a JSON repressentation
  139845. * @param parsedLensFlareSystem Define the JSON to parse
  139846. * @param scene Define the scene the parsed system should be instantiated in
  139847. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  139848. * @returns the parsed system
  139849. */
  139850. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  139851. /**
  139852. * Serialize the current Lens Flare System into a JSON representation.
  139853. * @returns the serialized JSON
  139854. */
  139855. serialize(): any;
  139856. }
  139857. }
  139858. declare module BABYLON {
  139859. /**
  139860. * This represents one of the lens effect in a `lensFlareSystem`.
  139861. * It controls one of the indiviual texture used in the effect.
  139862. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  139863. */
  139864. export class LensFlare {
  139865. /**
  139866. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  139867. */
  139868. size: number;
  139869. /**
  139870. * 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.
  139871. */
  139872. position: number;
  139873. /**
  139874. * Define the lens color.
  139875. */
  139876. color: Color3;
  139877. /**
  139878. * Define the lens texture.
  139879. */
  139880. texture: Nullable<Texture>;
  139881. /**
  139882. * Define the alpha mode to render this particular lens.
  139883. */
  139884. alphaMode: number;
  139885. private _system;
  139886. /**
  139887. * Creates a new Lens Flare.
  139888. * This represents one of the lens effect in a `lensFlareSystem`.
  139889. * It controls one of the indiviual texture used in the effect.
  139890. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  139891. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  139892. * @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.
  139893. * @param color Define the lens color
  139894. * @param imgUrl Define the lens texture url
  139895. * @param system Define the `lensFlareSystem` this flare is part of
  139896. * @returns The newly created Lens Flare
  139897. */
  139898. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  139899. /**
  139900. * Instantiates a new Lens Flare.
  139901. * This represents one of the lens effect in a `lensFlareSystem`.
  139902. * It controls one of the indiviual texture used in the effect.
  139903. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  139904. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  139905. * @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.
  139906. * @param color Define the lens color
  139907. * @param imgUrl Define the lens texture url
  139908. * @param system Define the `lensFlareSystem` this flare is part of
  139909. */
  139910. constructor(
  139911. /**
  139912. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  139913. */
  139914. size: number,
  139915. /**
  139916. * 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.
  139917. */
  139918. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  139919. /**
  139920. * Dispose and release the lens flare with its associated resources.
  139921. */
  139922. dispose(): void;
  139923. }
  139924. }
  139925. declare module BABYLON {
  139926. interface AbstractScene {
  139927. /**
  139928. * The list of lens flare system added to the scene
  139929. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  139930. */
  139931. lensFlareSystems: Array<LensFlareSystem>;
  139932. /**
  139933. * Removes the given lens flare system from this scene.
  139934. * @param toRemove The lens flare system to remove
  139935. * @returns The index of the removed lens flare system
  139936. */
  139937. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  139938. /**
  139939. * Adds the given lens flare system to this scene
  139940. * @param newLensFlareSystem The lens flare system to add
  139941. */
  139942. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  139943. /**
  139944. * Gets a lens flare system using its name
  139945. * @param name defines the name to look for
  139946. * @returns the lens flare system or null if not found
  139947. */
  139948. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  139949. /**
  139950. * Gets a lens flare system using its id
  139951. * @param id defines the id to look for
  139952. * @returns the lens flare system or null if not found
  139953. */
  139954. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  139955. }
  139956. /**
  139957. * Defines the lens flare scene component responsible to manage any lens flares
  139958. * in a given scene.
  139959. */
  139960. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  139961. /**
  139962. * The component name helpfull to identify the component in the list of scene components.
  139963. */
  139964. readonly name: string;
  139965. /**
  139966. * The scene the component belongs to.
  139967. */
  139968. scene: Scene;
  139969. /**
  139970. * Creates a new instance of the component for the given scene
  139971. * @param scene Defines the scene to register the component in
  139972. */
  139973. constructor(scene: Scene);
  139974. /**
  139975. * Registers the component in a given scene
  139976. */
  139977. register(): void;
  139978. /**
  139979. * Rebuilds the elements related to this component in case of
  139980. * context lost for instance.
  139981. */
  139982. rebuild(): void;
  139983. /**
  139984. * Adds all the elements from the container to the scene
  139985. * @param container the container holding the elements
  139986. */
  139987. addFromContainer(container: AbstractScene): void;
  139988. /**
  139989. * Removes all the elements in the container from the scene
  139990. * @param container contains the elements to remove
  139991. * @param dispose if the removed element should be disposed (default: false)
  139992. */
  139993. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  139994. /**
  139995. * Serializes the component data to the specified json object
  139996. * @param serializationObject The object to serialize to
  139997. */
  139998. serialize(serializationObject: any): void;
  139999. /**
  140000. * Disposes the component and the associated ressources.
  140001. */
  140002. dispose(): void;
  140003. private _draw;
  140004. }
  140005. }
  140006. declare module BABYLON {
  140007. /** @hidden */
  140008. export var depthPixelShader: {
  140009. name: string;
  140010. shader: string;
  140011. };
  140012. }
  140013. declare module BABYLON {
  140014. /** @hidden */
  140015. export var depthVertexShader: {
  140016. name: string;
  140017. shader: string;
  140018. };
  140019. }
  140020. declare module BABYLON {
  140021. /**
  140022. * This represents a depth renderer in Babylon.
  140023. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  140024. */
  140025. export class DepthRenderer {
  140026. private _scene;
  140027. private _depthMap;
  140028. private _effect;
  140029. private readonly _storeNonLinearDepth;
  140030. private readonly _clearColor;
  140031. /** Get if the depth renderer is using packed depth or not */
  140032. readonly isPacked: boolean;
  140033. private _cachedDefines;
  140034. private _camera;
  140035. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  140036. enabled: boolean;
  140037. /**
  140038. * Specifiess that the depth renderer will only be used within
  140039. * the camera it is created for.
  140040. * This can help forcing its rendering during the camera processing.
  140041. */
  140042. useOnlyInActiveCamera: boolean;
  140043. /** @hidden */
  140044. static _SceneComponentInitialization: (scene: Scene) => void;
  140045. /**
  140046. * Instantiates a depth renderer
  140047. * @param scene The scene the renderer belongs to
  140048. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  140049. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  140050. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  140051. */
  140052. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  140053. /**
  140054. * Creates the depth rendering effect and checks if the effect is ready.
  140055. * @param subMesh The submesh to be used to render the depth map of
  140056. * @param useInstances If multiple world instances should be used
  140057. * @returns if the depth renderer is ready to render the depth map
  140058. */
  140059. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  140060. /**
  140061. * Gets the texture which the depth map will be written to.
  140062. * @returns The depth map texture
  140063. */
  140064. getDepthMap(): RenderTargetTexture;
  140065. /**
  140066. * Disposes of the depth renderer.
  140067. */
  140068. dispose(): void;
  140069. }
  140070. }
  140071. declare module BABYLON {
  140072. /** @hidden */
  140073. export var minmaxReduxPixelShader: {
  140074. name: string;
  140075. shader: string;
  140076. };
  140077. }
  140078. declare module BABYLON {
  140079. /**
  140080. * This class computes a min/max reduction from a texture: it means it computes the minimum
  140081. * and maximum values from all values of the texture.
  140082. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  140083. * The source values are read from the red channel of the texture.
  140084. */
  140085. export class MinMaxReducer {
  140086. /**
  140087. * Observable triggered when the computation has been performed
  140088. */
  140089. onAfterReductionPerformed: Observable<{
  140090. min: number;
  140091. max: number;
  140092. }>;
  140093. protected _camera: Camera;
  140094. protected _sourceTexture: Nullable<RenderTargetTexture>;
  140095. protected _reductionSteps: Nullable<Array<PostProcess>>;
  140096. protected _postProcessManager: PostProcessManager;
  140097. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  140098. protected _forceFullscreenViewport: boolean;
  140099. /**
  140100. * Creates a min/max reducer
  140101. * @param camera The camera to use for the post processes
  140102. */
  140103. constructor(camera: Camera);
  140104. /**
  140105. * Gets the texture used to read the values from.
  140106. */
  140107. get sourceTexture(): Nullable<RenderTargetTexture>;
  140108. /**
  140109. * Sets the source texture to read the values from.
  140110. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  140111. * because in such textures '1' value must not be taken into account to compute the maximum
  140112. * as this value is used to clear the texture.
  140113. * Note that the computation is not activated by calling this function, you must call activate() for that!
  140114. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  140115. * @param depthRedux Indicates if the texture is a depth texture or not
  140116. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  140117. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  140118. */
  140119. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  140120. /**
  140121. * Defines the refresh rate of the computation.
  140122. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  140123. */
  140124. get refreshRate(): number;
  140125. set refreshRate(value: number);
  140126. protected _activated: boolean;
  140127. /**
  140128. * Gets the activation status of the reducer
  140129. */
  140130. get activated(): boolean;
  140131. /**
  140132. * Activates the reduction computation.
  140133. * When activated, the observers registered in onAfterReductionPerformed are
  140134. * called after the compuation is performed
  140135. */
  140136. activate(): void;
  140137. /**
  140138. * Deactivates the reduction computation.
  140139. */
  140140. deactivate(): void;
  140141. /**
  140142. * Disposes the min/max reducer
  140143. * @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.
  140144. */
  140145. dispose(disposeAll?: boolean): void;
  140146. }
  140147. }
  140148. declare module BABYLON {
  140149. /**
  140150. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  140151. */
  140152. export class DepthReducer extends MinMaxReducer {
  140153. private _depthRenderer;
  140154. private _depthRendererId;
  140155. /**
  140156. * Gets the depth renderer used for the computation.
  140157. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  140158. */
  140159. get depthRenderer(): Nullable<DepthRenderer>;
  140160. /**
  140161. * Creates a depth reducer
  140162. * @param camera The camera used to render the depth texture
  140163. */
  140164. constructor(camera: Camera);
  140165. /**
  140166. * Sets the depth renderer to use to generate the depth map
  140167. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  140168. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  140169. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  140170. */
  140171. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  140172. /** @hidden */
  140173. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  140174. /**
  140175. * Activates the reduction computation.
  140176. * When activated, the observers registered in onAfterReductionPerformed are
  140177. * called after the compuation is performed
  140178. */
  140179. activate(): void;
  140180. /**
  140181. * Deactivates the reduction computation.
  140182. */
  140183. deactivate(): void;
  140184. /**
  140185. * Disposes the depth reducer
  140186. * @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.
  140187. */
  140188. dispose(disposeAll?: boolean): void;
  140189. }
  140190. }
  140191. declare module BABYLON {
  140192. /**
  140193. * A CSM implementation allowing casting shadows on large scenes.
  140194. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  140195. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  140196. */
  140197. export class CascadedShadowGenerator extends ShadowGenerator {
  140198. private static readonly frustumCornersNDCSpace;
  140199. /**
  140200. * Name of the CSM class
  140201. */
  140202. static CLASSNAME: string;
  140203. /**
  140204. * Defines the default number of cascades used by the CSM.
  140205. */
  140206. static readonly DEFAULT_CASCADES_COUNT: number;
  140207. /**
  140208. * Defines the minimum number of cascades used by the CSM.
  140209. */
  140210. static readonly MIN_CASCADES_COUNT: number;
  140211. /**
  140212. * Defines the maximum number of cascades used by the CSM.
  140213. */
  140214. static readonly MAX_CASCADES_COUNT: number;
  140215. protected _validateFilter(filter: number): number;
  140216. /**
  140217. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  140218. */
  140219. penumbraDarkness: number;
  140220. private _numCascades;
  140221. /**
  140222. * Gets or set the number of cascades used by the CSM.
  140223. */
  140224. get numCascades(): number;
  140225. set numCascades(value: number);
  140226. /**
  140227. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  140228. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  140229. */
  140230. stabilizeCascades: boolean;
  140231. private _freezeShadowCastersBoundingInfo;
  140232. private _freezeShadowCastersBoundingInfoObservable;
  140233. /**
  140234. * Enables or disables the shadow casters bounding info computation.
  140235. * If your shadow casters don't move, you can disable this feature.
  140236. * If it is enabled, the bounding box computation is done every frame.
  140237. */
  140238. get freezeShadowCastersBoundingInfo(): boolean;
  140239. set freezeShadowCastersBoundingInfo(freeze: boolean);
  140240. private _scbiMin;
  140241. private _scbiMax;
  140242. protected _computeShadowCastersBoundingInfo(): void;
  140243. protected _shadowCastersBoundingInfo: BoundingInfo;
  140244. /**
  140245. * Gets or sets the shadow casters bounding info.
  140246. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  140247. * so that the system won't overwrite the bounds you provide
  140248. */
  140249. get shadowCastersBoundingInfo(): BoundingInfo;
  140250. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  140251. protected _breaksAreDirty: boolean;
  140252. protected _minDistance: number;
  140253. protected _maxDistance: number;
  140254. /**
  140255. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  140256. *
  140257. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  140258. * If you don't know these values, simply leave them to their defaults and don't call this function.
  140259. * @param min minimal distance for the breaks (default to 0.)
  140260. * @param max maximal distance for the breaks (default to 1.)
  140261. */
  140262. setMinMaxDistance(min: number, max: number): void;
  140263. /** Gets the minimal distance used in the cascade break computation */
  140264. get minDistance(): number;
  140265. /** Gets the maximal distance used in the cascade break computation */
  140266. get maxDistance(): number;
  140267. /**
  140268. * Gets the class name of that object
  140269. * @returns "CascadedShadowGenerator"
  140270. */
  140271. getClassName(): string;
  140272. private _cascadeMinExtents;
  140273. private _cascadeMaxExtents;
  140274. /**
  140275. * Gets a cascade minimum extents
  140276. * @param cascadeIndex index of the cascade
  140277. * @returns the minimum cascade extents
  140278. */
  140279. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  140280. /**
  140281. * Gets a cascade maximum extents
  140282. * @param cascadeIndex index of the cascade
  140283. * @returns the maximum cascade extents
  140284. */
  140285. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  140286. private _cascades;
  140287. private _currentLayer;
  140288. private _viewSpaceFrustumsZ;
  140289. private _viewMatrices;
  140290. private _projectionMatrices;
  140291. private _transformMatrices;
  140292. private _transformMatricesAsArray;
  140293. private _frustumLengths;
  140294. private _lightSizeUVCorrection;
  140295. private _depthCorrection;
  140296. private _frustumCornersWorldSpace;
  140297. private _frustumCenter;
  140298. private _shadowCameraPos;
  140299. private _shadowMaxZ;
  140300. /**
  140301. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  140302. * It defaults to camera.maxZ
  140303. */
  140304. get shadowMaxZ(): number;
  140305. /**
  140306. * Sets the shadow max z distance.
  140307. */
  140308. set shadowMaxZ(value: number);
  140309. protected _debug: boolean;
  140310. /**
  140311. * Gets or sets the debug flag.
  140312. * When enabled, the cascades are materialized by different colors on the screen.
  140313. */
  140314. get debug(): boolean;
  140315. set debug(dbg: boolean);
  140316. private _depthClamp;
  140317. /**
  140318. * Gets or sets the depth clamping value.
  140319. *
  140320. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  140321. * to account for the shadow casters far away.
  140322. *
  140323. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  140324. */
  140325. get depthClamp(): boolean;
  140326. set depthClamp(value: boolean);
  140327. private _cascadeBlendPercentage;
  140328. /**
  140329. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  140330. * It defaults to 0.1 (10% blending).
  140331. */
  140332. get cascadeBlendPercentage(): number;
  140333. set cascadeBlendPercentage(value: number);
  140334. private _lambda;
  140335. /**
  140336. * Gets or set the lambda parameter.
  140337. * This parameter is used to split the camera frustum and create the cascades.
  140338. * 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.
  140339. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  140340. */
  140341. get lambda(): number;
  140342. set lambda(value: number);
  140343. /**
  140344. * Gets the view matrix corresponding to a given cascade
  140345. * @param cascadeNum cascade to retrieve the view matrix from
  140346. * @returns the cascade view matrix
  140347. */
  140348. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  140349. /**
  140350. * Gets the projection matrix corresponding to a given cascade
  140351. * @param cascadeNum cascade to retrieve the projection matrix from
  140352. * @returns the cascade projection matrix
  140353. */
  140354. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  140355. /**
  140356. * Gets the transformation matrix corresponding to a given cascade
  140357. * @param cascadeNum cascade to retrieve the transformation matrix from
  140358. * @returns the cascade transformation matrix
  140359. */
  140360. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  140361. private _depthRenderer;
  140362. /**
  140363. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  140364. *
  140365. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  140366. *
  140367. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  140368. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  140369. * @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
  140370. */
  140371. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  140372. private _depthReducer;
  140373. private _autoCalcDepthBounds;
  140374. /**
  140375. * Gets or sets the autoCalcDepthBounds property.
  140376. *
  140377. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  140378. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  140379. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  140380. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  140381. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  140382. */
  140383. get autoCalcDepthBounds(): boolean;
  140384. set autoCalcDepthBounds(value: boolean);
  140385. /**
  140386. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  140387. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  140388. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  140389. * for setting the refresh rate on the renderer yourself!
  140390. */
  140391. get autoCalcDepthBoundsRefreshRate(): number;
  140392. set autoCalcDepthBoundsRefreshRate(value: number);
  140393. /**
  140394. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  140395. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  140396. * you change the camera near/far planes!
  140397. */
  140398. splitFrustum(): void;
  140399. private _splitFrustum;
  140400. private _computeMatrices;
  140401. private _computeFrustumInWorldSpace;
  140402. private _computeCascadeFrustum;
  140403. /**
  140404. * Support test.
  140405. */
  140406. static get IsSupported(): boolean;
  140407. /** @hidden */
  140408. static _SceneComponentInitialization: (scene: Scene) => void;
  140409. /**
  140410. * Creates a Cascaded Shadow Generator object.
  140411. * A ShadowGenerator is the required tool to use the shadows.
  140412. * Each directional light casting shadows needs to use its own ShadowGenerator.
  140413. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  140414. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  140415. * @param light The directional light object generating the shadows.
  140416. * @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.
  140417. */
  140418. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  140419. protected _initializeGenerator(): void;
  140420. protected _createTargetRenderTexture(): void;
  140421. protected _initializeShadowMap(): void;
  140422. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  140423. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  140424. /**
  140425. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  140426. * @param defines Defines of the material we want to update
  140427. * @param lightIndex Index of the light in the enabled light list of the material
  140428. */
  140429. prepareDefines(defines: any, lightIndex: number): void;
  140430. /**
  140431. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  140432. * defined in the generator but impacting the effect).
  140433. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  140434. * @param effect The effect we are binfing the information for
  140435. */
  140436. bindShadowLight(lightIndex: string, effect: Effect): void;
  140437. /**
  140438. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  140439. * (eq to view projection * shadow projection matrices)
  140440. * @returns The transform matrix used to create the shadow map
  140441. */
  140442. getTransformMatrix(): Matrix;
  140443. /**
  140444. * Disposes the ShadowGenerator.
  140445. * Returns nothing.
  140446. */
  140447. dispose(): void;
  140448. /**
  140449. * Serializes the shadow generator setup to a json object.
  140450. * @returns The serialized JSON object
  140451. */
  140452. serialize(): any;
  140453. /**
  140454. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  140455. * @param parsedShadowGenerator The JSON object to parse
  140456. * @param scene The scene to create the shadow map for
  140457. * @returns The parsed shadow generator
  140458. */
  140459. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  140460. }
  140461. }
  140462. declare module BABYLON {
  140463. /**
  140464. * Defines the shadow generator component responsible to manage any shadow generators
  140465. * in a given scene.
  140466. */
  140467. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  140468. /**
  140469. * The component name helpfull to identify the component in the list of scene components.
  140470. */
  140471. readonly name: string;
  140472. /**
  140473. * The scene the component belongs to.
  140474. */
  140475. scene: Scene;
  140476. /**
  140477. * Creates a new instance of the component for the given scene
  140478. * @param scene Defines the scene to register the component in
  140479. */
  140480. constructor(scene: Scene);
  140481. /**
  140482. * Registers the component in a given scene
  140483. */
  140484. register(): void;
  140485. /**
  140486. * Rebuilds the elements related to this component in case of
  140487. * context lost for instance.
  140488. */
  140489. rebuild(): void;
  140490. /**
  140491. * Serializes the component data to the specified json object
  140492. * @param serializationObject The object to serialize to
  140493. */
  140494. serialize(serializationObject: any): void;
  140495. /**
  140496. * Adds all the elements from the container to the scene
  140497. * @param container the container holding the elements
  140498. */
  140499. addFromContainer(container: AbstractScene): void;
  140500. /**
  140501. * Removes all the elements in the container from the scene
  140502. * @param container contains the elements to remove
  140503. * @param dispose if the removed element should be disposed (default: false)
  140504. */
  140505. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  140506. /**
  140507. * Rebuilds the elements related to this component in case of
  140508. * context lost for instance.
  140509. */
  140510. dispose(): void;
  140511. private _gatherRenderTargets;
  140512. }
  140513. }
  140514. declare module BABYLON {
  140515. /**
  140516. * A point light is a light defined by an unique point in world space.
  140517. * The light is emitted in every direction from this point.
  140518. * A good example of a point light is a standard light bulb.
  140519. * Documentation: https://doc.babylonjs.com/babylon101/lights
  140520. */
  140521. export class PointLight extends ShadowLight {
  140522. private _shadowAngle;
  140523. /**
  140524. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  140525. * This specifies what angle the shadow will use to be created.
  140526. *
  140527. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  140528. */
  140529. get shadowAngle(): number;
  140530. /**
  140531. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  140532. * This specifies what angle the shadow will use to be created.
  140533. *
  140534. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  140535. */
  140536. set shadowAngle(value: number);
  140537. /**
  140538. * Gets the direction if it has been set.
  140539. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  140540. */
  140541. get direction(): Vector3;
  140542. /**
  140543. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  140544. */
  140545. set direction(value: Vector3);
  140546. /**
  140547. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  140548. * A PointLight emits the light in every direction.
  140549. * It can cast shadows.
  140550. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  140551. * ```javascript
  140552. * var pointLight = new PointLight("pl", camera.position, scene);
  140553. * ```
  140554. * Documentation : https://doc.babylonjs.com/babylon101/lights
  140555. * @param name The light friendly name
  140556. * @param position The position of the point light in the scene
  140557. * @param scene The scene the lights belongs to
  140558. */
  140559. constructor(name: string, position: Vector3, scene: Scene);
  140560. /**
  140561. * Returns the string "PointLight"
  140562. * @returns the class name
  140563. */
  140564. getClassName(): string;
  140565. /**
  140566. * Returns the integer 0.
  140567. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  140568. */
  140569. getTypeID(): number;
  140570. /**
  140571. * Specifies wether or not the shadowmap should be a cube texture.
  140572. * @returns true if the shadowmap needs to be a cube texture.
  140573. */
  140574. needCube(): boolean;
  140575. /**
  140576. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  140577. * @param faceIndex The index of the face we are computed the direction to generate shadow
  140578. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  140579. */
  140580. getShadowDirection(faceIndex?: number): Vector3;
  140581. /**
  140582. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  140583. * - fov = PI / 2
  140584. * - aspect ratio : 1.0
  140585. * - z-near and far equal to the active camera minZ and maxZ.
  140586. * Returns the PointLight.
  140587. */
  140588. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  140589. protected _buildUniformLayout(): void;
  140590. /**
  140591. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  140592. * @param effect The effect to update
  140593. * @param lightIndex The index of the light in the effect to update
  140594. * @returns The point light
  140595. */
  140596. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  140597. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  140598. /**
  140599. * Prepares the list of defines specific to the light type.
  140600. * @param defines the list of defines
  140601. * @param lightIndex defines the index of the light for the effect
  140602. */
  140603. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  140604. }
  140605. }
  140606. declare module BABYLON {
  140607. /**
  140608. * Header information of HDR texture files.
  140609. */
  140610. export interface HDRInfo {
  140611. /**
  140612. * The height of the texture in pixels.
  140613. */
  140614. height: number;
  140615. /**
  140616. * The width of the texture in pixels.
  140617. */
  140618. width: number;
  140619. /**
  140620. * The index of the beginning of the data in the binary file.
  140621. */
  140622. dataPosition: number;
  140623. }
  140624. /**
  140625. * This groups tools to convert HDR texture to native colors array.
  140626. */
  140627. export class HDRTools {
  140628. private static Ldexp;
  140629. private static Rgbe2float;
  140630. private static readStringLine;
  140631. /**
  140632. * Reads header information from an RGBE texture stored in a native array.
  140633. * More information on this format are available here:
  140634. * https://en.wikipedia.org/wiki/RGBE_image_format
  140635. *
  140636. * @param uint8array The binary file stored in native array.
  140637. * @return The header information.
  140638. */
  140639. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  140640. /**
  140641. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  140642. * This RGBE texture needs to store the information as a panorama.
  140643. *
  140644. * More information on this format are available here:
  140645. * https://en.wikipedia.org/wiki/RGBE_image_format
  140646. *
  140647. * @param buffer The binary file stored in an array buffer.
  140648. * @param size The expected size of the extracted cubemap.
  140649. * @return The Cube Map information.
  140650. */
  140651. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  140652. /**
  140653. * Returns the pixels data extracted from an RGBE texture.
  140654. * This pixels will be stored left to right up to down in the R G B order in one array.
  140655. *
  140656. * More information on this format are available here:
  140657. * https://en.wikipedia.org/wiki/RGBE_image_format
  140658. *
  140659. * @param uint8array The binary file stored in an array buffer.
  140660. * @param hdrInfo The header information of the file.
  140661. * @return The pixels data in RGB right to left up to down order.
  140662. */
  140663. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  140664. private static RGBE_ReadPixels_RLE;
  140665. private static RGBE_ReadPixels_NOT_RLE;
  140666. }
  140667. }
  140668. declare module BABYLON {
  140669. /**
  140670. * Effect Render Options
  140671. */
  140672. export interface IEffectRendererOptions {
  140673. /**
  140674. * Defines the vertices positions.
  140675. */
  140676. positions?: number[];
  140677. /**
  140678. * Defines the indices.
  140679. */
  140680. indices?: number[];
  140681. }
  140682. /**
  140683. * Helper class to render one or more effects.
  140684. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  140685. */
  140686. export class EffectRenderer {
  140687. private engine;
  140688. private static _DefaultOptions;
  140689. private _vertexBuffers;
  140690. private _indexBuffer;
  140691. private _fullscreenViewport;
  140692. /**
  140693. * Creates an effect renderer
  140694. * @param engine the engine to use for rendering
  140695. * @param options defines the options of the effect renderer
  140696. */
  140697. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  140698. /**
  140699. * Sets the current viewport in normalized coordinates 0-1
  140700. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  140701. */
  140702. setViewport(viewport?: Viewport): void;
  140703. /**
  140704. * Binds the embedded attributes buffer to the effect.
  140705. * @param effect Defines the effect to bind the attributes for
  140706. */
  140707. bindBuffers(effect: Effect): void;
  140708. /**
  140709. * Sets the current effect wrapper to use during draw.
  140710. * The effect needs to be ready before calling this api.
  140711. * This also sets the default full screen position attribute.
  140712. * @param effectWrapper Defines the effect to draw with
  140713. */
  140714. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  140715. /**
  140716. * Restores engine states
  140717. */
  140718. restoreStates(): void;
  140719. /**
  140720. * Draws a full screen quad.
  140721. */
  140722. draw(): void;
  140723. private isRenderTargetTexture;
  140724. /**
  140725. * renders one or more effects to a specified texture
  140726. * @param effectWrapper the effect to renderer
  140727. * @param outputTexture texture to draw to, if null it will render to the screen.
  140728. */
  140729. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  140730. /**
  140731. * Disposes of the effect renderer
  140732. */
  140733. dispose(): void;
  140734. }
  140735. /**
  140736. * Options to create an EffectWrapper
  140737. */
  140738. interface EffectWrapperCreationOptions {
  140739. /**
  140740. * Engine to use to create the effect
  140741. */
  140742. engine: ThinEngine;
  140743. /**
  140744. * Fragment shader for the effect
  140745. */
  140746. fragmentShader: string;
  140747. /**
  140748. * Use the shader store instead of direct source code
  140749. */
  140750. useShaderStore?: boolean;
  140751. /**
  140752. * Vertex shader for the effect
  140753. */
  140754. vertexShader?: string;
  140755. /**
  140756. * Attributes to use in the shader
  140757. */
  140758. attributeNames?: Array<string>;
  140759. /**
  140760. * Uniforms to use in the shader
  140761. */
  140762. uniformNames?: Array<string>;
  140763. /**
  140764. * Texture sampler names to use in the shader
  140765. */
  140766. samplerNames?: Array<string>;
  140767. /**
  140768. * Defines to use in the shader
  140769. */
  140770. defines?: Array<string>;
  140771. /**
  140772. * Callback when effect is compiled
  140773. */
  140774. onCompiled?: Nullable<(effect: Effect) => void>;
  140775. /**
  140776. * The friendly name of the effect displayed in Spector.
  140777. */
  140778. name?: string;
  140779. }
  140780. /**
  140781. * Wraps an effect to be used for rendering
  140782. */
  140783. export class EffectWrapper {
  140784. /**
  140785. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  140786. */
  140787. onApplyObservable: Observable<{}>;
  140788. /**
  140789. * The underlying effect
  140790. */
  140791. effect: Effect;
  140792. /**
  140793. * Creates an effect to be renderer
  140794. * @param creationOptions options to create the effect
  140795. */
  140796. constructor(creationOptions: EffectWrapperCreationOptions);
  140797. /**
  140798. * Disposes of the effect wrapper
  140799. */
  140800. dispose(): void;
  140801. }
  140802. }
  140803. declare module BABYLON {
  140804. /** @hidden */
  140805. export var hdrFilteringVertexShader: {
  140806. name: string;
  140807. shader: string;
  140808. };
  140809. }
  140810. declare module BABYLON {
  140811. /** @hidden */
  140812. export var hdrFilteringPixelShader: {
  140813. name: string;
  140814. shader: string;
  140815. };
  140816. }
  140817. declare module BABYLON {
  140818. /**
  140819. * Options for texture filtering
  140820. */
  140821. interface IHDRFilteringOptions {
  140822. /**
  140823. * Scales pixel intensity for the input HDR map.
  140824. */
  140825. hdrScale?: number;
  140826. /**
  140827. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  140828. */
  140829. quality?: number;
  140830. }
  140831. /**
  140832. * Filters HDR maps to get correct renderings of PBR reflections
  140833. */
  140834. export class HDRFiltering {
  140835. private _engine;
  140836. private _effectRenderer;
  140837. private _effectWrapper;
  140838. private _lodGenerationOffset;
  140839. private _lodGenerationScale;
  140840. /**
  140841. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  140842. * you care about baking speed.
  140843. */
  140844. quality: number;
  140845. /**
  140846. * Scales pixel intensity for the input HDR map.
  140847. */
  140848. hdrScale: number;
  140849. /**
  140850. * Instantiates HDR filter for reflection maps
  140851. *
  140852. * @param engine Thin engine
  140853. * @param options Options
  140854. */
  140855. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  140856. private _createRenderTarget;
  140857. private _prefilterInternal;
  140858. private _createEffect;
  140859. /**
  140860. * Get a value indicating if the filter is ready to be used
  140861. * @param texture Texture to filter
  140862. * @returns true if the filter is ready
  140863. */
  140864. isReady(texture: BaseTexture): boolean;
  140865. /**
  140866. * Prefilters a cube texture to have mipmap levels representing roughness values.
  140867. * Prefiltering will be invoked at the end of next rendering pass.
  140868. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  140869. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  140870. * @param texture Texture to filter
  140871. * @param onFinished Callback when filtering is done
  140872. * @return Promise called when prefiltering is done
  140873. */
  140874. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  140875. }
  140876. }
  140877. declare module BABYLON {
  140878. /**
  140879. * This represents a texture coming from an HDR input.
  140880. *
  140881. * The only supported format is currently panorama picture stored in RGBE format.
  140882. * Example of such files can be found on HDRLib: http://hdrlib.com/
  140883. */
  140884. export class HDRCubeTexture extends BaseTexture {
  140885. private static _facesMapping;
  140886. private _generateHarmonics;
  140887. private _noMipmap;
  140888. private _prefilterOnLoad;
  140889. private _textureMatrix;
  140890. private _size;
  140891. private _onLoad;
  140892. private _onError;
  140893. /**
  140894. * The texture URL.
  140895. */
  140896. url: string;
  140897. protected _isBlocking: boolean;
  140898. /**
  140899. * Sets wether or not the texture is blocking during loading.
  140900. */
  140901. set isBlocking(value: boolean);
  140902. /**
  140903. * Gets wether or not the texture is blocking during loading.
  140904. */
  140905. get isBlocking(): boolean;
  140906. protected _rotationY: number;
  140907. /**
  140908. * Sets texture matrix rotation angle around Y axis in radians.
  140909. */
  140910. set rotationY(value: number);
  140911. /**
  140912. * Gets texture matrix rotation angle around Y axis radians.
  140913. */
  140914. get rotationY(): number;
  140915. /**
  140916. * Gets or sets the center of the bounding box associated with the cube texture
  140917. * It must define where the camera used to render the texture was set
  140918. */
  140919. boundingBoxPosition: Vector3;
  140920. private _boundingBoxSize;
  140921. /**
  140922. * Gets or sets the size of the bounding box associated with the cube texture
  140923. * When defined, the cubemap will switch to local mode
  140924. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  140925. * @example https://www.babylonjs-playground.com/#RNASML
  140926. */
  140927. set boundingBoxSize(value: Vector3);
  140928. get boundingBoxSize(): Vector3;
  140929. /**
  140930. * Instantiates an HDRTexture from the following parameters.
  140931. *
  140932. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  140933. * @param sceneOrEngine The scene or engine the texture will be used in
  140934. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  140935. * @param noMipmap Forces to not generate the mipmap if true
  140936. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  140937. * @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)
  140938. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  140939. */
  140940. 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>);
  140941. /**
  140942. * Get the current class name of the texture useful for serialization or dynamic coding.
  140943. * @returns "HDRCubeTexture"
  140944. */
  140945. getClassName(): string;
  140946. /**
  140947. * Occurs when the file is raw .hdr file.
  140948. */
  140949. private loadTexture;
  140950. clone(): HDRCubeTexture;
  140951. delayLoad(): void;
  140952. /**
  140953. * Get the texture reflection matrix used to rotate/transform the reflection.
  140954. * @returns the reflection matrix
  140955. */
  140956. getReflectionTextureMatrix(): Matrix;
  140957. /**
  140958. * Set the texture reflection matrix used to rotate/transform the reflection.
  140959. * @param value Define the reflection matrix to set
  140960. */
  140961. setReflectionTextureMatrix(value: Matrix): void;
  140962. /**
  140963. * Parses a JSON representation of an HDR Texture in order to create the texture
  140964. * @param parsedTexture Define the JSON representation
  140965. * @param scene Define the scene the texture should be created in
  140966. * @param rootUrl Define the root url in case we need to load relative dependencies
  140967. * @returns the newly created texture after parsing
  140968. */
  140969. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  140970. serialize(): any;
  140971. }
  140972. }
  140973. declare module BABYLON {
  140974. /**
  140975. * Class used to control physics engine
  140976. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  140977. */
  140978. export class PhysicsEngine implements IPhysicsEngine {
  140979. private _physicsPlugin;
  140980. /**
  140981. * Global value used to control the smallest number supported by the simulation
  140982. */
  140983. static Epsilon: number;
  140984. private _impostors;
  140985. private _joints;
  140986. private _subTimeStep;
  140987. /**
  140988. * Gets the gravity vector used by the simulation
  140989. */
  140990. gravity: Vector3;
  140991. /**
  140992. * Factory used to create the default physics plugin.
  140993. * @returns The default physics plugin
  140994. */
  140995. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  140996. /**
  140997. * Creates a new Physics Engine
  140998. * @param gravity defines the gravity vector used by the simulation
  140999. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  141000. */
  141001. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  141002. /**
  141003. * Sets the gravity vector used by the simulation
  141004. * @param gravity defines the gravity vector to use
  141005. */
  141006. setGravity(gravity: Vector3): void;
  141007. /**
  141008. * Set the time step of the physics engine.
  141009. * Default is 1/60.
  141010. * To slow it down, enter 1/600 for example.
  141011. * To speed it up, 1/30
  141012. * @param newTimeStep defines the new timestep to apply to this world.
  141013. */
  141014. setTimeStep(newTimeStep?: number): void;
  141015. /**
  141016. * Get the time step of the physics engine.
  141017. * @returns the current time step
  141018. */
  141019. getTimeStep(): number;
  141020. /**
  141021. * Set the sub time step of the physics engine.
  141022. * Default is 0 meaning there is no sub steps
  141023. * To increase physics resolution precision, set a small value (like 1 ms)
  141024. * @param subTimeStep defines the new sub timestep used for physics resolution.
  141025. */
  141026. setSubTimeStep(subTimeStep?: number): void;
  141027. /**
  141028. * Get the sub time step of the physics engine.
  141029. * @returns the current sub time step
  141030. */
  141031. getSubTimeStep(): number;
  141032. /**
  141033. * Release all resources
  141034. */
  141035. dispose(): void;
  141036. /**
  141037. * Gets the name of the current physics plugin
  141038. * @returns the name of the plugin
  141039. */
  141040. getPhysicsPluginName(): string;
  141041. /**
  141042. * Adding a new impostor for the impostor tracking.
  141043. * This will be done by the impostor itself.
  141044. * @param impostor the impostor to add
  141045. */
  141046. addImpostor(impostor: PhysicsImpostor): void;
  141047. /**
  141048. * Remove an impostor from the engine.
  141049. * This impostor and its mesh will not longer be updated by the physics engine.
  141050. * @param impostor the impostor to remove
  141051. */
  141052. removeImpostor(impostor: PhysicsImpostor): void;
  141053. /**
  141054. * Add a joint to the physics engine
  141055. * @param mainImpostor defines the main impostor to which the joint is added.
  141056. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  141057. * @param joint defines the joint that will connect both impostors.
  141058. */
  141059. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  141060. /**
  141061. * Removes a joint from the simulation
  141062. * @param mainImpostor defines the impostor used with the joint
  141063. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  141064. * @param joint defines the joint to remove
  141065. */
  141066. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  141067. /**
  141068. * Called by the scene. No need to call it.
  141069. * @param delta defines the timespam between frames
  141070. */
  141071. _step(delta: number): void;
  141072. /**
  141073. * Gets the current plugin used to run the simulation
  141074. * @returns current plugin
  141075. */
  141076. getPhysicsPlugin(): IPhysicsEnginePlugin;
  141077. /**
  141078. * Gets the list of physic impostors
  141079. * @returns an array of PhysicsImpostor
  141080. */
  141081. getImpostors(): Array<PhysicsImpostor>;
  141082. /**
  141083. * Gets the impostor for a physics enabled object
  141084. * @param object defines the object impersonated by the impostor
  141085. * @returns the PhysicsImpostor or null if not found
  141086. */
  141087. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  141088. /**
  141089. * Gets the impostor for a physics body object
  141090. * @param body defines physics body used by the impostor
  141091. * @returns the PhysicsImpostor or null if not found
  141092. */
  141093. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  141094. /**
  141095. * Does a raycast in the physics world
  141096. * @param from when should the ray start?
  141097. * @param to when should the ray end?
  141098. * @returns PhysicsRaycastResult
  141099. */
  141100. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  141101. }
  141102. }
  141103. declare module BABYLON {
  141104. /** @hidden */
  141105. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  141106. private _useDeltaForWorldStep;
  141107. world: any;
  141108. name: string;
  141109. private _physicsMaterials;
  141110. private _fixedTimeStep;
  141111. private _cannonRaycastResult;
  141112. private _raycastResult;
  141113. private _physicsBodysToRemoveAfterStep;
  141114. private _firstFrame;
  141115. BJSCANNON: any;
  141116. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  141117. setGravity(gravity: Vector3): void;
  141118. setTimeStep(timeStep: number): void;
  141119. getTimeStep(): number;
  141120. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  141121. private _removeMarkedPhysicsBodiesFromWorld;
  141122. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  141123. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  141124. generatePhysicsBody(impostor: PhysicsImpostor): void;
  141125. private _processChildMeshes;
  141126. removePhysicsBody(impostor: PhysicsImpostor): void;
  141127. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  141128. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  141129. private _addMaterial;
  141130. private _checkWithEpsilon;
  141131. private _createShape;
  141132. private _createHeightmap;
  141133. private _minus90X;
  141134. private _plus90X;
  141135. private _tmpPosition;
  141136. private _tmpDeltaPosition;
  141137. private _tmpUnityRotation;
  141138. private _updatePhysicsBodyTransformation;
  141139. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  141140. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  141141. isSupported(): boolean;
  141142. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  141143. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  141144. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  141145. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  141146. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  141147. getBodyMass(impostor: PhysicsImpostor): number;
  141148. getBodyFriction(impostor: PhysicsImpostor): number;
  141149. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  141150. getBodyRestitution(impostor: PhysicsImpostor): number;
  141151. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  141152. sleepBody(impostor: PhysicsImpostor): void;
  141153. wakeUpBody(impostor: PhysicsImpostor): void;
  141154. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  141155. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  141156. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  141157. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  141158. getRadius(impostor: PhysicsImpostor): number;
  141159. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  141160. dispose(): void;
  141161. private _extendNamespace;
  141162. /**
  141163. * Does a raycast in the physics world
  141164. * @param from when should the ray start?
  141165. * @param to when should the ray end?
  141166. * @returns PhysicsRaycastResult
  141167. */
  141168. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  141169. }
  141170. }
  141171. declare module BABYLON {
  141172. /** @hidden */
  141173. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  141174. private _useDeltaForWorldStep;
  141175. world: any;
  141176. name: string;
  141177. BJSOIMO: any;
  141178. private _raycastResult;
  141179. private _fixedTimeStep;
  141180. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  141181. setGravity(gravity: Vector3): void;
  141182. setTimeStep(timeStep: number): void;
  141183. getTimeStep(): number;
  141184. private _tmpImpostorsArray;
  141185. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  141186. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  141187. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  141188. generatePhysicsBody(impostor: PhysicsImpostor): void;
  141189. private _tmpPositionVector;
  141190. removePhysicsBody(impostor: PhysicsImpostor): void;
  141191. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  141192. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  141193. isSupported(): boolean;
  141194. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  141195. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  141196. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  141197. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  141198. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  141199. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  141200. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  141201. getBodyMass(impostor: PhysicsImpostor): number;
  141202. getBodyFriction(impostor: PhysicsImpostor): number;
  141203. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  141204. getBodyRestitution(impostor: PhysicsImpostor): number;
  141205. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  141206. sleepBody(impostor: PhysicsImpostor): void;
  141207. wakeUpBody(impostor: PhysicsImpostor): void;
  141208. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  141209. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  141210. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  141211. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  141212. getRadius(impostor: PhysicsImpostor): number;
  141213. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  141214. dispose(): void;
  141215. /**
  141216. * Does a raycast in the physics world
  141217. * @param from when should the ray start?
  141218. * @param to when should the ray end?
  141219. * @returns PhysicsRaycastResult
  141220. */
  141221. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  141222. }
  141223. }
  141224. declare module BABYLON {
  141225. /**
  141226. * AmmoJS Physics plugin
  141227. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  141228. * @see https://github.com/kripken/ammo.js/
  141229. */
  141230. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  141231. private _useDeltaForWorldStep;
  141232. /**
  141233. * Reference to the Ammo library
  141234. */
  141235. bjsAMMO: any;
  141236. /**
  141237. * Created ammoJS world which physics bodies are added to
  141238. */
  141239. world: any;
  141240. /**
  141241. * Name of the plugin
  141242. */
  141243. name: string;
  141244. private _timeStep;
  141245. private _fixedTimeStep;
  141246. private _maxSteps;
  141247. private _tmpQuaternion;
  141248. private _tmpAmmoTransform;
  141249. private _tmpAmmoQuaternion;
  141250. private _tmpAmmoConcreteContactResultCallback;
  141251. private _collisionConfiguration;
  141252. private _dispatcher;
  141253. private _overlappingPairCache;
  141254. private _solver;
  141255. private _softBodySolver;
  141256. private _tmpAmmoVectorA;
  141257. private _tmpAmmoVectorB;
  141258. private _tmpAmmoVectorC;
  141259. private _tmpAmmoVectorD;
  141260. private _tmpContactCallbackResult;
  141261. private _tmpAmmoVectorRCA;
  141262. private _tmpAmmoVectorRCB;
  141263. private _raycastResult;
  141264. private static readonly DISABLE_COLLISION_FLAG;
  141265. private static readonly KINEMATIC_FLAG;
  141266. private static readonly DISABLE_DEACTIVATION_FLAG;
  141267. /**
  141268. * Initializes the ammoJS plugin
  141269. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  141270. * @param ammoInjection can be used to inject your own ammo reference
  141271. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  141272. */
  141273. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  141274. /**
  141275. * Sets the gravity of the physics world (m/(s^2))
  141276. * @param gravity Gravity to set
  141277. */
  141278. setGravity(gravity: Vector3): void;
  141279. /**
  141280. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  141281. * @param timeStep timestep to use in seconds
  141282. */
  141283. setTimeStep(timeStep: number): void;
  141284. /**
  141285. * 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)
  141286. * @param fixedTimeStep fixedTimeStep to use in seconds
  141287. */
  141288. setFixedTimeStep(fixedTimeStep: number): void;
  141289. /**
  141290. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  141291. * @param maxSteps the maximum number of steps by the physics engine per frame
  141292. */
  141293. setMaxSteps(maxSteps: number): void;
  141294. /**
  141295. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  141296. * @returns the current timestep in seconds
  141297. */
  141298. getTimeStep(): number;
  141299. /**
  141300. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  141301. */
  141302. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  141303. private _isImpostorInContact;
  141304. private _isImpostorPairInContact;
  141305. private _stepSimulation;
  141306. /**
  141307. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  141308. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  141309. * After the step the babylon meshes are set to the position of the physics imposters
  141310. * @param delta amount of time to step forward
  141311. * @param impostors array of imposters to update before/after the step
  141312. */
  141313. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  141314. /**
  141315. * Update babylon mesh to match physics world object
  141316. * @param impostor imposter to match
  141317. */
  141318. private _afterSoftStep;
  141319. /**
  141320. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  141321. * @param impostor imposter to match
  141322. */
  141323. private _ropeStep;
  141324. /**
  141325. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  141326. * @param impostor imposter to match
  141327. */
  141328. private _softbodyOrClothStep;
  141329. private _tmpMatrix;
  141330. /**
  141331. * Applies an impulse on the imposter
  141332. * @param impostor imposter to apply impulse to
  141333. * @param force amount of force to be applied to the imposter
  141334. * @param contactPoint the location to apply the impulse on the imposter
  141335. */
  141336. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  141337. /**
  141338. * Applies a force on the imposter
  141339. * @param impostor imposter to apply force
  141340. * @param force amount of force to be applied to the imposter
  141341. * @param contactPoint the location to apply the force on the imposter
  141342. */
  141343. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  141344. /**
  141345. * Creates a physics body using the plugin
  141346. * @param impostor the imposter to create the physics body on
  141347. */
  141348. generatePhysicsBody(impostor: PhysicsImpostor): void;
  141349. /**
  141350. * Removes the physics body from the imposter and disposes of the body's memory
  141351. * @param impostor imposter to remove the physics body from
  141352. */
  141353. removePhysicsBody(impostor: PhysicsImpostor): void;
  141354. /**
  141355. * Generates a joint
  141356. * @param impostorJoint the imposter joint to create the joint with
  141357. */
  141358. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  141359. /**
  141360. * Removes a joint
  141361. * @param impostorJoint the imposter joint to remove the joint from
  141362. */
  141363. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  141364. private _addMeshVerts;
  141365. /**
  141366. * Initialise the soft body vertices to match its object's (mesh) vertices
  141367. * Softbody vertices (nodes) are in world space and to match this
  141368. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  141369. * @param impostor to create the softbody for
  141370. */
  141371. private _softVertexData;
  141372. /**
  141373. * Create an impostor's soft body
  141374. * @param impostor to create the softbody for
  141375. */
  141376. private _createSoftbody;
  141377. /**
  141378. * Create cloth for an impostor
  141379. * @param impostor to create the softbody for
  141380. */
  141381. private _createCloth;
  141382. /**
  141383. * Create rope for an impostor
  141384. * @param impostor to create the softbody for
  141385. */
  141386. private _createRope;
  141387. /**
  141388. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  141389. * @param impostor to create the custom physics shape for
  141390. */
  141391. private _createCustom;
  141392. private _addHullVerts;
  141393. private _createShape;
  141394. /**
  141395. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  141396. * @param impostor imposter containing the physics body and babylon object
  141397. */
  141398. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  141399. /**
  141400. * Sets the babylon object's position/rotation from the physics body's position/rotation
  141401. * @param impostor imposter containing the physics body and babylon object
  141402. * @param newPosition new position
  141403. * @param newRotation new rotation
  141404. */
  141405. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  141406. /**
  141407. * If this plugin is supported
  141408. * @returns true if its supported
  141409. */
  141410. isSupported(): boolean;
  141411. /**
  141412. * Sets the linear velocity of the physics body
  141413. * @param impostor imposter to set the velocity on
  141414. * @param velocity velocity to set
  141415. */
  141416. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  141417. /**
  141418. * Sets the angular velocity of the physics body
  141419. * @param impostor imposter to set the velocity on
  141420. * @param velocity velocity to set
  141421. */
  141422. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  141423. /**
  141424. * gets the linear velocity
  141425. * @param impostor imposter to get linear velocity from
  141426. * @returns linear velocity
  141427. */
  141428. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  141429. /**
  141430. * gets the angular velocity
  141431. * @param impostor imposter to get angular velocity from
  141432. * @returns angular velocity
  141433. */
  141434. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  141435. /**
  141436. * Sets the mass of physics body
  141437. * @param impostor imposter to set the mass on
  141438. * @param mass mass to set
  141439. */
  141440. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  141441. /**
  141442. * Gets the mass of the physics body
  141443. * @param impostor imposter to get the mass from
  141444. * @returns mass
  141445. */
  141446. getBodyMass(impostor: PhysicsImpostor): number;
  141447. /**
  141448. * Gets friction of the impostor
  141449. * @param impostor impostor to get friction from
  141450. * @returns friction value
  141451. */
  141452. getBodyFriction(impostor: PhysicsImpostor): number;
  141453. /**
  141454. * Sets friction of the impostor
  141455. * @param impostor impostor to set friction on
  141456. * @param friction friction value
  141457. */
  141458. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  141459. /**
  141460. * Gets restitution of the impostor
  141461. * @param impostor impostor to get restitution from
  141462. * @returns restitution value
  141463. */
  141464. getBodyRestitution(impostor: PhysicsImpostor): number;
  141465. /**
  141466. * Sets resitution of the impostor
  141467. * @param impostor impostor to set resitution on
  141468. * @param restitution resitution value
  141469. */
  141470. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  141471. /**
  141472. * Gets pressure inside the impostor
  141473. * @param impostor impostor to get pressure from
  141474. * @returns pressure value
  141475. */
  141476. getBodyPressure(impostor: PhysicsImpostor): number;
  141477. /**
  141478. * Sets pressure inside a soft body impostor
  141479. * Cloth and rope must remain 0 pressure
  141480. * @param impostor impostor to set pressure on
  141481. * @param pressure pressure value
  141482. */
  141483. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  141484. /**
  141485. * Gets stiffness of the impostor
  141486. * @param impostor impostor to get stiffness from
  141487. * @returns pressure value
  141488. */
  141489. getBodyStiffness(impostor: PhysicsImpostor): number;
  141490. /**
  141491. * Sets stiffness of the impostor
  141492. * @param impostor impostor to set stiffness on
  141493. * @param stiffness stiffness value from 0 to 1
  141494. */
  141495. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  141496. /**
  141497. * Gets velocityIterations of the impostor
  141498. * @param impostor impostor to get velocity iterations from
  141499. * @returns velocityIterations value
  141500. */
  141501. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  141502. /**
  141503. * Sets velocityIterations of the impostor
  141504. * @param impostor impostor to set velocity iterations on
  141505. * @param velocityIterations velocityIterations value
  141506. */
  141507. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  141508. /**
  141509. * Gets positionIterations of the impostor
  141510. * @param impostor impostor to get position iterations from
  141511. * @returns positionIterations value
  141512. */
  141513. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  141514. /**
  141515. * Sets positionIterations of the impostor
  141516. * @param impostor impostor to set position on
  141517. * @param positionIterations positionIterations value
  141518. */
  141519. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  141520. /**
  141521. * Append an anchor to a cloth object
  141522. * @param impostor is the cloth impostor to add anchor to
  141523. * @param otherImpostor is the rigid impostor to anchor to
  141524. * @param width ratio across width from 0 to 1
  141525. * @param height ratio up height from 0 to 1
  141526. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  141527. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  141528. */
  141529. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  141530. /**
  141531. * Append an hook to a rope object
  141532. * @param impostor is the rope impostor to add hook to
  141533. * @param otherImpostor is the rigid impostor to hook to
  141534. * @param length ratio along the rope from 0 to 1
  141535. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  141536. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  141537. */
  141538. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  141539. /**
  141540. * Sleeps the physics body and stops it from being active
  141541. * @param impostor impostor to sleep
  141542. */
  141543. sleepBody(impostor: PhysicsImpostor): void;
  141544. /**
  141545. * Activates the physics body
  141546. * @param impostor impostor to activate
  141547. */
  141548. wakeUpBody(impostor: PhysicsImpostor): void;
  141549. /**
  141550. * Updates the distance parameters of the joint
  141551. * @param joint joint to update
  141552. * @param maxDistance maximum distance of the joint
  141553. * @param minDistance minimum distance of the joint
  141554. */
  141555. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  141556. /**
  141557. * Sets a motor on the joint
  141558. * @param joint joint to set motor on
  141559. * @param speed speed of the motor
  141560. * @param maxForce maximum force of the motor
  141561. * @param motorIndex index of the motor
  141562. */
  141563. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  141564. /**
  141565. * Sets the motors limit
  141566. * @param joint joint to set limit on
  141567. * @param upperLimit upper limit
  141568. * @param lowerLimit lower limit
  141569. */
  141570. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  141571. /**
  141572. * Syncs the position and rotation of a mesh with the impostor
  141573. * @param mesh mesh to sync
  141574. * @param impostor impostor to update the mesh with
  141575. */
  141576. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  141577. /**
  141578. * Gets the radius of the impostor
  141579. * @param impostor impostor to get radius from
  141580. * @returns the radius
  141581. */
  141582. getRadius(impostor: PhysicsImpostor): number;
  141583. /**
  141584. * Gets the box size of the impostor
  141585. * @param impostor impostor to get box size from
  141586. * @param result the resulting box size
  141587. */
  141588. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  141589. /**
  141590. * Disposes of the impostor
  141591. */
  141592. dispose(): void;
  141593. /**
  141594. * Does a raycast in the physics world
  141595. * @param from when should the ray start?
  141596. * @param to when should the ray end?
  141597. * @returns PhysicsRaycastResult
  141598. */
  141599. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  141600. }
  141601. }
  141602. declare module BABYLON {
  141603. interface AbstractScene {
  141604. /**
  141605. * The list of reflection probes added to the scene
  141606. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  141607. */
  141608. reflectionProbes: Array<ReflectionProbe>;
  141609. /**
  141610. * Removes the given reflection probe from this scene.
  141611. * @param toRemove The reflection probe to remove
  141612. * @returns The index of the removed reflection probe
  141613. */
  141614. removeReflectionProbe(toRemove: ReflectionProbe): number;
  141615. /**
  141616. * Adds the given reflection probe to this scene.
  141617. * @param newReflectionProbe The reflection probe to add
  141618. */
  141619. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  141620. }
  141621. /**
  141622. * Class used to generate realtime reflection / refraction cube textures
  141623. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  141624. */
  141625. export class ReflectionProbe {
  141626. /** defines the name of the probe */
  141627. name: string;
  141628. private _scene;
  141629. private _renderTargetTexture;
  141630. private _projectionMatrix;
  141631. private _viewMatrix;
  141632. private _target;
  141633. private _add;
  141634. private _attachedMesh;
  141635. private _invertYAxis;
  141636. /** Gets or sets probe position (center of the cube map) */
  141637. position: Vector3;
  141638. /**
  141639. * Creates a new reflection probe
  141640. * @param name defines the name of the probe
  141641. * @param size defines the texture resolution (for each face)
  141642. * @param scene defines the hosting scene
  141643. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  141644. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  141645. */
  141646. constructor(
  141647. /** defines the name of the probe */
  141648. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  141649. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  141650. get samples(): number;
  141651. set samples(value: number);
  141652. /** Gets or sets the refresh rate to use (on every frame by default) */
  141653. get refreshRate(): number;
  141654. set refreshRate(value: number);
  141655. /**
  141656. * Gets the hosting scene
  141657. * @returns a Scene
  141658. */
  141659. getScene(): Scene;
  141660. /** Gets the internal CubeTexture used to render to */
  141661. get cubeTexture(): RenderTargetTexture;
  141662. /** Gets the list of meshes to render */
  141663. get renderList(): Nullable<AbstractMesh[]>;
  141664. /**
  141665. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  141666. * @param mesh defines the mesh to attach to
  141667. */
  141668. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  141669. /**
  141670. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  141671. * @param renderingGroupId The rendering group id corresponding to its index
  141672. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  141673. */
  141674. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  141675. /**
  141676. * Clean all associated resources
  141677. */
  141678. dispose(): void;
  141679. /**
  141680. * Converts the reflection probe information to a readable string for debug purpose.
  141681. * @param fullDetails Supports for multiple levels of logging within scene loading
  141682. * @returns the human readable reflection probe info
  141683. */
  141684. toString(fullDetails?: boolean): string;
  141685. /**
  141686. * Get the class name of the relfection probe.
  141687. * @returns "ReflectionProbe"
  141688. */
  141689. getClassName(): string;
  141690. /**
  141691. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  141692. * @returns The JSON representation of the texture
  141693. */
  141694. serialize(): any;
  141695. /**
  141696. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  141697. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  141698. * @param scene Define the scene the parsed reflection probe should be instantiated in
  141699. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  141700. * @returns The parsed reflection probe if successful
  141701. */
  141702. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  141703. }
  141704. }
  141705. declare module BABYLON {
  141706. /** @hidden */
  141707. export var _BabylonLoaderRegistered: boolean;
  141708. /**
  141709. * Helps setting up some configuration for the babylon file loader.
  141710. */
  141711. export class BabylonFileLoaderConfiguration {
  141712. /**
  141713. * The loader does not allow injecting custom physix engine into the plugins.
  141714. * Unfortunately in ES6, we need to manually inject them into the plugin.
  141715. * So you could set this variable to your engine import to make it work.
  141716. */
  141717. static LoaderInjectedPhysicsEngine: any;
  141718. }
  141719. }
  141720. declare module BABYLON {
  141721. /**
  141722. * The Physically based simple base material of BJS.
  141723. *
  141724. * This enables better naming and convention enforcements on top of the pbrMaterial.
  141725. * It is used as the base class for both the specGloss and metalRough conventions.
  141726. */
  141727. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  141728. /**
  141729. * Number of Simultaneous lights allowed on the material.
  141730. */
  141731. maxSimultaneousLights: number;
  141732. /**
  141733. * If sets to true, disables all the lights affecting the material.
  141734. */
  141735. disableLighting: boolean;
  141736. /**
  141737. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  141738. */
  141739. environmentTexture: BaseTexture;
  141740. /**
  141741. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  141742. */
  141743. invertNormalMapX: boolean;
  141744. /**
  141745. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  141746. */
  141747. invertNormalMapY: boolean;
  141748. /**
  141749. * Normal map used in the model.
  141750. */
  141751. normalTexture: BaseTexture;
  141752. /**
  141753. * Emissivie color used to self-illuminate the model.
  141754. */
  141755. emissiveColor: Color3;
  141756. /**
  141757. * Emissivie texture used to self-illuminate the model.
  141758. */
  141759. emissiveTexture: BaseTexture;
  141760. /**
  141761. * Occlusion Channel Strenght.
  141762. */
  141763. occlusionStrength: number;
  141764. /**
  141765. * Occlusion Texture of the material (adding extra occlusion effects).
  141766. */
  141767. occlusionTexture: BaseTexture;
  141768. /**
  141769. * Defines the alpha limits in alpha test mode.
  141770. */
  141771. alphaCutOff: number;
  141772. /**
  141773. * Gets the current double sided mode.
  141774. */
  141775. get doubleSided(): boolean;
  141776. /**
  141777. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  141778. */
  141779. set doubleSided(value: boolean);
  141780. /**
  141781. * Stores the pre-calculated light information of a mesh in a texture.
  141782. */
  141783. lightmapTexture: BaseTexture;
  141784. /**
  141785. * If true, the light map contains occlusion information instead of lighting info.
  141786. */
  141787. useLightmapAsShadowmap: boolean;
  141788. /**
  141789. * Instantiates a new PBRMaterial instance.
  141790. *
  141791. * @param name The material name
  141792. * @param scene The scene the material will be use in.
  141793. */
  141794. constructor(name: string, scene: Scene);
  141795. getClassName(): string;
  141796. }
  141797. }
  141798. declare module BABYLON {
  141799. /**
  141800. * The PBR material of BJS following the metal roughness convention.
  141801. *
  141802. * This fits to the PBR convention in the GLTF definition:
  141803. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  141804. */
  141805. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  141806. /**
  141807. * The base color has two different interpretations depending on the value of metalness.
  141808. * When the material is a metal, the base color is the specific measured reflectance value
  141809. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  141810. * of the material.
  141811. */
  141812. baseColor: Color3;
  141813. /**
  141814. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  141815. * well as opacity information in the alpha channel.
  141816. */
  141817. baseTexture: BaseTexture;
  141818. /**
  141819. * Specifies the metallic scalar value of the material.
  141820. * Can also be used to scale the metalness values of the metallic texture.
  141821. */
  141822. metallic: number;
  141823. /**
  141824. * Specifies the roughness scalar value of the material.
  141825. * Can also be used to scale the roughness values of the metallic texture.
  141826. */
  141827. roughness: number;
  141828. /**
  141829. * Texture containing both the metallic value in the B channel and the
  141830. * roughness value in the G channel to keep better precision.
  141831. */
  141832. metallicRoughnessTexture: BaseTexture;
  141833. /**
  141834. * Instantiates a new PBRMetalRoughnessMaterial instance.
  141835. *
  141836. * @param name The material name
  141837. * @param scene The scene the material will be use in.
  141838. */
  141839. constructor(name: string, scene: Scene);
  141840. /**
  141841. * Return the currrent class name of the material.
  141842. */
  141843. getClassName(): string;
  141844. /**
  141845. * Makes a duplicate of the current material.
  141846. * @param name - name to use for the new material.
  141847. */
  141848. clone(name: string): PBRMetallicRoughnessMaterial;
  141849. /**
  141850. * Serialize the material to a parsable JSON object.
  141851. */
  141852. serialize(): any;
  141853. /**
  141854. * Parses a JSON object correponding to the serialize function.
  141855. */
  141856. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  141857. }
  141858. }
  141859. declare module BABYLON {
  141860. /**
  141861. * The PBR material of BJS following the specular glossiness convention.
  141862. *
  141863. * This fits to the PBR convention in the GLTF definition:
  141864. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  141865. */
  141866. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  141867. /**
  141868. * Specifies the diffuse color of the material.
  141869. */
  141870. diffuseColor: Color3;
  141871. /**
  141872. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  141873. * channel.
  141874. */
  141875. diffuseTexture: BaseTexture;
  141876. /**
  141877. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  141878. */
  141879. specularColor: Color3;
  141880. /**
  141881. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  141882. */
  141883. glossiness: number;
  141884. /**
  141885. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  141886. */
  141887. specularGlossinessTexture: BaseTexture;
  141888. /**
  141889. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  141890. *
  141891. * @param name The material name
  141892. * @param scene The scene the material will be use in.
  141893. */
  141894. constructor(name: string, scene: Scene);
  141895. /**
  141896. * Return the currrent class name of the material.
  141897. */
  141898. getClassName(): string;
  141899. /**
  141900. * Makes a duplicate of the current material.
  141901. * @param name - name to use for the new material.
  141902. */
  141903. clone(name: string): PBRSpecularGlossinessMaterial;
  141904. /**
  141905. * Serialize the material to a parsable JSON object.
  141906. */
  141907. serialize(): any;
  141908. /**
  141909. * Parses a JSON object correponding to the serialize function.
  141910. */
  141911. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  141912. }
  141913. }
  141914. declare module BABYLON {
  141915. /**
  141916. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  141917. * It can help converting any input color in a desired output one. This can then be used to create effects
  141918. * from sepia, black and white to sixties or futuristic rendering...
  141919. *
  141920. * The only supported format is currently 3dl.
  141921. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  141922. */
  141923. export class ColorGradingTexture extends BaseTexture {
  141924. /**
  141925. * The texture URL.
  141926. */
  141927. url: string;
  141928. /**
  141929. * Empty line regex stored for GC.
  141930. */
  141931. private static _noneEmptyLineRegex;
  141932. private _textureMatrix;
  141933. private _onLoad;
  141934. /**
  141935. * Instantiates a ColorGradingTexture from the following parameters.
  141936. *
  141937. * @param url The location of the color gradind data (currently only supporting 3dl)
  141938. * @param sceneOrEngine The scene or engine the texture will be used in
  141939. * @param onLoad defines a callback triggered when the texture has been loaded
  141940. */
  141941. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  141942. /**
  141943. * Fires the onload event from the constructor if requested.
  141944. */
  141945. private _triggerOnLoad;
  141946. /**
  141947. * Returns the texture matrix used in most of the material.
  141948. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  141949. */
  141950. getTextureMatrix(): Matrix;
  141951. /**
  141952. * Occurs when the file being loaded is a .3dl LUT file.
  141953. */
  141954. private load3dlTexture;
  141955. /**
  141956. * Starts the loading process of the texture.
  141957. */
  141958. private loadTexture;
  141959. /**
  141960. * Clones the color gradind texture.
  141961. */
  141962. clone(): ColorGradingTexture;
  141963. /**
  141964. * Called during delayed load for textures.
  141965. */
  141966. delayLoad(): void;
  141967. /**
  141968. * Parses a color grading texture serialized by Babylon.
  141969. * @param parsedTexture The texture information being parsedTexture
  141970. * @param scene The scene to load the texture in
  141971. * @param rootUrl The root url of the data assets to load
  141972. * @return A color gradind texture
  141973. */
  141974. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  141975. /**
  141976. * Serializes the LUT texture to json format.
  141977. */
  141978. serialize(): any;
  141979. }
  141980. }
  141981. declare module BABYLON {
  141982. /**
  141983. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  141984. */
  141985. export class EquiRectangularCubeTexture extends BaseTexture {
  141986. /** The six faces of the cube. */
  141987. private static _FacesMapping;
  141988. private _noMipmap;
  141989. private _onLoad;
  141990. private _onError;
  141991. /** The size of the cubemap. */
  141992. private _size;
  141993. /** The buffer of the image. */
  141994. private _buffer;
  141995. /** The width of the input image. */
  141996. private _width;
  141997. /** The height of the input image. */
  141998. private _height;
  141999. /** The URL to the image. */
  142000. url: string;
  142001. /**
  142002. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  142003. * @param url The location of the image
  142004. * @param scene The scene 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 gammaSpace Specifies if the texture will be used in gamma or linear space
  142008. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  142009. * @param onLoad — defines a callback called when texture is loaded
  142010. * @param onError — defines a callback called if there is an error
  142011. */
  142012. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  142013. /**
  142014. * Load the image data, by putting the image on a canvas and extracting its buffer.
  142015. */
  142016. private loadImage;
  142017. /**
  142018. * Convert the image buffer into a cubemap and create a CubeTexture.
  142019. */
  142020. private loadTexture;
  142021. /**
  142022. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  142023. * @param buffer The ArrayBuffer that should be converted.
  142024. * @returns The buffer as Float32Array.
  142025. */
  142026. private getFloat32ArrayFromArrayBuffer;
  142027. /**
  142028. * Get the current class name of the texture useful for serialization or dynamic coding.
  142029. * @returns "EquiRectangularCubeTexture"
  142030. */
  142031. getClassName(): string;
  142032. /**
  142033. * Create a clone of the current EquiRectangularCubeTexture and return it.
  142034. * @returns A clone of the current EquiRectangularCubeTexture.
  142035. */
  142036. clone(): EquiRectangularCubeTexture;
  142037. }
  142038. }
  142039. declare module BABYLON {
  142040. /**
  142041. * Defines the options related to the creation of an HtmlElementTexture
  142042. */
  142043. export interface IHtmlElementTextureOptions {
  142044. /**
  142045. * Defines wether mip maps should be created or not.
  142046. */
  142047. generateMipMaps?: boolean;
  142048. /**
  142049. * Defines the sampling mode of the texture.
  142050. */
  142051. samplingMode?: number;
  142052. /**
  142053. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  142054. */
  142055. engine: Nullable<ThinEngine>;
  142056. /**
  142057. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  142058. */
  142059. scene: Nullable<Scene>;
  142060. }
  142061. /**
  142062. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  142063. * To be as efficient as possible depending on your constraints nothing aside the first upload
  142064. * is automatically managed.
  142065. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  142066. * in your application.
  142067. *
  142068. * As the update is not automatic, you need to call them manually.
  142069. */
  142070. export class HtmlElementTexture extends BaseTexture {
  142071. /**
  142072. * The texture URL.
  142073. */
  142074. element: HTMLVideoElement | HTMLCanvasElement;
  142075. private static readonly DefaultOptions;
  142076. private _textureMatrix;
  142077. private _isVideo;
  142078. private _generateMipMaps;
  142079. private _samplingMode;
  142080. /**
  142081. * Instantiates a HtmlElementTexture from the following parameters.
  142082. *
  142083. * @param name Defines the name of the texture
  142084. * @param element Defines the video or canvas the texture is filled with
  142085. * @param options Defines the other none mandatory texture creation options
  142086. */
  142087. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  142088. private _createInternalTexture;
  142089. /**
  142090. * Returns the texture matrix used in most of the material.
  142091. */
  142092. getTextureMatrix(): Matrix;
  142093. /**
  142094. * Updates the content of the texture.
  142095. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  142096. */
  142097. update(invertY?: Nullable<boolean>): void;
  142098. }
  142099. }
  142100. declare module BABYLON {
  142101. /**
  142102. * Based on jsTGALoader - Javascript loader for TGA file
  142103. * By Vincent Thibault
  142104. * @see http://blog.robrowser.com/javascript-tga-loader.html
  142105. */
  142106. export class TGATools {
  142107. private static _TYPE_INDEXED;
  142108. private static _TYPE_RGB;
  142109. private static _TYPE_GREY;
  142110. private static _TYPE_RLE_INDEXED;
  142111. private static _TYPE_RLE_RGB;
  142112. private static _TYPE_RLE_GREY;
  142113. private static _ORIGIN_MASK;
  142114. private static _ORIGIN_SHIFT;
  142115. private static _ORIGIN_BL;
  142116. private static _ORIGIN_BR;
  142117. private static _ORIGIN_UL;
  142118. private static _ORIGIN_UR;
  142119. /**
  142120. * Gets the header of a TGA file
  142121. * @param data defines the TGA data
  142122. * @returns the header
  142123. */
  142124. static GetTGAHeader(data: Uint8Array): any;
  142125. /**
  142126. * Uploads TGA content to a Babylon Texture
  142127. * @hidden
  142128. */
  142129. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  142130. /** @hidden */
  142131. 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;
  142132. /** @hidden */
  142133. 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;
  142134. /** @hidden */
  142135. 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;
  142136. /** @hidden */
  142137. 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;
  142138. /** @hidden */
  142139. 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;
  142140. /** @hidden */
  142141. 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;
  142142. }
  142143. }
  142144. declare module BABYLON {
  142145. /**
  142146. * Implementation of the TGA Texture Loader.
  142147. * @hidden
  142148. */
  142149. export class _TGATextureLoader implements IInternalTextureLoader {
  142150. /**
  142151. * Defines wether the loader supports cascade loading the different faces.
  142152. */
  142153. readonly supportCascades: boolean;
  142154. /**
  142155. * This returns if the loader support the current file information.
  142156. * @param extension defines the file extension of the file being loaded
  142157. * @returns true if the loader can load the specified file
  142158. */
  142159. canLoad(extension: string): boolean;
  142160. /**
  142161. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  142162. * @param data contains the texture data
  142163. * @param texture defines the BabylonJS internal texture
  142164. * @param createPolynomials will be true if polynomials have been requested
  142165. * @param onLoad defines the callback to trigger once the texture is ready
  142166. * @param onError defines the callback to trigger in case of error
  142167. */
  142168. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  142169. /**
  142170. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  142171. * @param data contains the texture data
  142172. * @param texture defines the BabylonJS internal texture
  142173. * @param callback defines the method to call once ready to upload
  142174. */
  142175. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  142176. }
  142177. }
  142178. declare module BABYLON {
  142179. /**
  142180. * Info about the .basis files
  142181. */
  142182. class BasisFileInfo {
  142183. /**
  142184. * If the file has alpha
  142185. */
  142186. hasAlpha: boolean;
  142187. /**
  142188. * Info about each image of the basis file
  142189. */
  142190. images: Array<{
  142191. levels: Array<{
  142192. width: number;
  142193. height: number;
  142194. transcodedPixels: ArrayBufferView;
  142195. }>;
  142196. }>;
  142197. }
  142198. /**
  142199. * Result of transcoding a basis file
  142200. */
  142201. class TranscodeResult {
  142202. /**
  142203. * Info about the .basis file
  142204. */
  142205. fileInfo: BasisFileInfo;
  142206. /**
  142207. * Format to use when loading the file
  142208. */
  142209. format: number;
  142210. }
  142211. /**
  142212. * Configuration options for the Basis transcoder
  142213. */
  142214. export class BasisTranscodeConfiguration {
  142215. /**
  142216. * Supported compression formats used to determine the supported output format of the transcoder
  142217. */
  142218. supportedCompressionFormats?: {
  142219. /**
  142220. * etc1 compression format
  142221. */
  142222. etc1?: boolean;
  142223. /**
  142224. * s3tc compression format
  142225. */
  142226. s3tc?: boolean;
  142227. /**
  142228. * pvrtc compression format
  142229. */
  142230. pvrtc?: boolean;
  142231. /**
  142232. * etc2 compression format
  142233. */
  142234. etc2?: boolean;
  142235. };
  142236. /**
  142237. * If mipmap levels should be loaded for transcoded images (Default: true)
  142238. */
  142239. loadMipmapLevels?: boolean;
  142240. /**
  142241. * Index of a single image to load (Default: all images)
  142242. */
  142243. loadSingleImage?: number;
  142244. }
  142245. /**
  142246. * Used to load .Basis files
  142247. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  142248. */
  142249. export class BasisTools {
  142250. private static _IgnoreSupportedFormats;
  142251. /**
  142252. * URL to use when loading the basis transcoder
  142253. */
  142254. static JSModuleURL: string;
  142255. /**
  142256. * URL to use when loading the wasm module for the transcoder
  142257. */
  142258. static WasmModuleURL: string;
  142259. /**
  142260. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  142261. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  142262. * @returns internal format corresponding to the Basis format
  142263. */
  142264. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  142265. private static _WorkerPromise;
  142266. private static _Worker;
  142267. private static _actionId;
  142268. private static _CreateWorkerAsync;
  142269. /**
  142270. * Transcodes a loaded image file to compressed pixel data
  142271. * @param data image data to transcode
  142272. * @param config configuration options for the transcoding
  142273. * @returns a promise resulting in the transcoded image
  142274. */
  142275. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  142276. /**
  142277. * Loads a texture from the transcode result
  142278. * @param texture texture load to
  142279. * @param transcodeResult the result of transcoding the basis file to load from
  142280. */
  142281. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  142282. }
  142283. }
  142284. declare module BABYLON {
  142285. /**
  142286. * Loader for .basis file format
  142287. */
  142288. export class _BasisTextureLoader implements IInternalTextureLoader {
  142289. /**
  142290. * Defines whether the loader supports cascade loading the different faces.
  142291. */
  142292. readonly supportCascades: boolean;
  142293. /**
  142294. * This returns if the loader support the current file information.
  142295. * @param extension defines the file extension of the file being loaded
  142296. * @returns true if the loader can load the specified file
  142297. */
  142298. canLoad(extension: string): boolean;
  142299. /**
  142300. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  142301. * @param data contains the texture data
  142302. * @param texture defines the BabylonJS internal texture
  142303. * @param createPolynomials will be true if polynomials have been requested
  142304. * @param onLoad defines the callback to trigger once the texture is ready
  142305. * @param onError defines the callback to trigger in case of error
  142306. */
  142307. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  142308. /**
  142309. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  142310. * @param data contains the texture data
  142311. * @param texture defines the BabylonJS internal texture
  142312. * @param callback defines the method to call once ready to upload
  142313. */
  142314. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  142315. }
  142316. }
  142317. declare module BABYLON {
  142318. /**
  142319. * Defines the basic options interface of a TexturePacker Frame
  142320. */
  142321. export interface ITexturePackerFrame {
  142322. /**
  142323. * The frame ID
  142324. */
  142325. id: number;
  142326. /**
  142327. * The frames Scale
  142328. */
  142329. scale: Vector2;
  142330. /**
  142331. * The Frames offset
  142332. */
  142333. offset: Vector2;
  142334. }
  142335. /**
  142336. * This is a support class for frame Data on texture packer sets.
  142337. */
  142338. export class TexturePackerFrame implements ITexturePackerFrame {
  142339. /**
  142340. * The frame ID
  142341. */
  142342. id: number;
  142343. /**
  142344. * The frames Scale
  142345. */
  142346. scale: Vector2;
  142347. /**
  142348. * The Frames offset
  142349. */
  142350. offset: Vector2;
  142351. /**
  142352. * Initializes a texture package frame.
  142353. * @param id The numerical frame identifier
  142354. * @param scale Scalar Vector2 for UV frame
  142355. * @param offset Vector2 for the frame position in UV units.
  142356. * @returns TexturePackerFrame
  142357. */
  142358. constructor(id: number, scale: Vector2, offset: Vector2);
  142359. }
  142360. }
  142361. declare module BABYLON {
  142362. /**
  142363. * Defines the basic options interface of a TexturePacker
  142364. */
  142365. export interface ITexturePackerOptions {
  142366. /**
  142367. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  142368. */
  142369. map?: string[];
  142370. /**
  142371. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  142372. */
  142373. uvsIn?: string;
  142374. /**
  142375. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  142376. */
  142377. uvsOut?: string;
  142378. /**
  142379. * number representing the layout style. Defaults to LAYOUT_STRIP
  142380. */
  142381. layout?: number;
  142382. /**
  142383. * number of columns if using custom column count layout(2). This defaults to 4.
  142384. */
  142385. colnum?: number;
  142386. /**
  142387. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  142388. */
  142389. updateInputMeshes?: boolean;
  142390. /**
  142391. * boolean flag to dispose all the source textures. Defaults to true.
  142392. */
  142393. disposeSources?: boolean;
  142394. /**
  142395. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  142396. */
  142397. fillBlanks?: boolean;
  142398. /**
  142399. * string value representing the context fill style color. Defaults to 'black'.
  142400. */
  142401. customFillColor?: string;
  142402. /**
  142403. * Width and Height Value of each Frame in the TexturePacker Sets
  142404. */
  142405. frameSize?: number;
  142406. /**
  142407. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  142408. */
  142409. paddingRatio?: number;
  142410. /**
  142411. * Number that declares the fill method for the padding gutter.
  142412. */
  142413. paddingMode?: number;
  142414. /**
  142415. * If in SUBUV_COLOR padding mode what color to use.
  142416. */
  142417. paddingColor?: Color3 | Color4;
  142418. }
  142419. /**
  142420. * Defines the basic interface of a TexturePacker JSON File
  142421. */
  142422. export interface ITexturePackerJSON {
  142423. /**
  142424. * The frame ID
  142425. */
  142426. name: string;
  142427. /**
  142428. * The base64 channel data
  142429. */
  142430. sets: any;
  142431. /**
  142432. * The options of the Packer
  142433. */
  142434. options: ITexturePackerOptions;
  142435. /**
  142436. * The frame data of the Packer
  142437. */
  142438. frames: Array<number>;
  142439. }
  142440. /**
  142441. * This is a support class that generates a series of packed texture sets.
  142442. * @see https://doc.babylonjs.com/babylon101/materials
  142443. */
  142444. export class TexturePacker {
  142445. /** Packer Layout Constant 0 */
  142446. static readonly LAYOUT_STRIP: number;
  142447. /** Packer Layout Constant 1 */
  142448. static readonly LAYOUT_POWER2: number;
  142449. /** Packer Layout Constant 2 */
  142450. static readonly LAYOUT_COLNUM: number;
  142451. /** Packer Layout Constant 0 */
  142452. static readonly SUBUV_WRAP: number;
  142453. /** Packer Layout Constant 1 */
  142454. static readonly SUBUV_EXTEND: number;
  142455. /** Packer Layout Constant 2 */
  142456. static readonly SUBUV_COLOR: number;
  142457. /** The Name of the Texture Package */
  142458. name: string;
  142459. /** The scene scope of the TexturePacker */
  142460. scene: Scene;
  142461. /** The Meshes to target */
  142462. meshes: AbstractMesh[];
  142463. /** Arguments passed with the Constructor */
  142464. options: ITexturePackerOptions;
  142465. /** The promise that is started upon initialization */
  142466. promise: Nullable<Promise<TexturePacker | string>>;
  142467. /** The Container object for the channel sets that are generated */
  142468. sets: object;
  142469. /** The Container array for the frames that are generated */
  142470. frames: TexturePackerFrame[];
  142471. /** The expected number of textures the system is parsing. */
  142472. private _expecting;
  142473. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  142474. private _paddingValue;
  142475. /**
  142476. * Initializes a texture package series from an array of meshes or a single mesh.
  142477. * @param name The name of the package
  142478. * @param meshes The target meshes to compose the package from
  142479. * @param options The arguments that texture packer should follow while building.
  142480. * @param scene The scene which the textures are scoped to.
  142481. * @returns TexturePacker
  142482. */
  142483. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  142484. /**
  142485. * Starts the package process
  142486. * @param resolve The promises resolution function
  142487. * @returns TexturePacker
  142488. */
  142489. private _createFrames;
  142490. /**
  142491. * Calculates the Size of the Channel Sets
  142492. * @returns Vector2
  142493. */
  142494. private _calculateSize;
  142495. /**
  142496. * Calculates the UV data for the frames.
  142497. * @param baseSize the base frameSize
  142498. * @param padding the base frame padding
  142499. * @param dtSize size of the Dynamic Texture for that channel
  142500. * @param dtUnits is 1/dtSize
  142501. * @param update flag to update the input meshes
  142502. */
  142503. private _calculateMeshUVFrames;
  142504. /**
  142505. * Calculates the frames Offset.
  142506. * @param index of the frame
  142507. * @returns Vector2
  142508. */
  142509. private _getFrameOffset;
  142510. /**
  142511. * Updates a Mesh to the frame data
  142512. * @param mesh that is the target
  142513. * @param frameID or the frame index
  142514. */
  142515. private _updateMeshUV;
  142516. /**
  142517. * Updates a Meshes materials to use the texture packer channels
  142518. * @param m is the mesh to target
  142519. * @param force all channels on the packer to be set.
  142520. */
  142521. private _updateTextureReferences;
  142522. /**
  142523. * Public method to set a Mesh to a frame
  142524. * @param m that is the target
  142525. * @param frameID or the frame index
  142526. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  142527. */
  142528. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  142529. /**
  142530. * Starts the async promise to compile the texture packer.
  142531. * @returns Promise<void>
  142532. */
  142533. processAsync(): Promise<void>;
  142534. /**
  142535. * Disposes all textures associated with this packer
  142536. */
  142537. dispose(): void;
  142538. /**
  142539. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  142540. * @param imageType is the image type to use.
  142541. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  142542. */
  142543. download(imageType?: string, quality?: number): void;
  142544. /**
  142545. * Public method to load a texturePacker JSON file.
  142546. * @param data of the JSON file in string format.
  142547. */
  142548. updateFromJSON(data: string): void;
  142549. }
  142550. }
  142551. declare module BABYLON {
  142552. /**
  142553. * 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.
  142554. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  142555. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  142556. */
  142557. export class CustomProceduralTexture extends ProceduralTexture {
  142558. private _animate;
  142559. private _time;
  142560. private _config;
  142561. private _texturePath;
  142562. /**
  142563. * Instantiates a new Custom Procedural Texture.
  142564. * 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.
  142565. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  142566. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  142567. * @param name Define the name of the texture
  142568. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  142569. * @param size Define the size of the texture to create
  142570. * @param scene Define the scene the texture belongs to
  142571. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  142572. * @param generateMipMaps Define if the texture should creates mip maps or not
  142573. */
  142574. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  142575. private _loadJson;
  142576. /**
  142577. * Is the texture ready to be used ? (rendered at least once)
  142578. * @returns true if ready, otherwise, false.
  142579. */
  142580. isReady(): boolean;
  142581. /**
  142582. * Render the texture to its associated render target.
  142583. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  142584. */
  142585. render(useCameraPostProcess?: boolean): void;
  142586. /**
  142587. * Update the list of dependant textures samplers in the shader.
  142588. */
  142589. updateTextures(): void;
  142590. /**
  142591. * Update the uniform values of the procedural texture in the shader.
  142592. */
  142593. updateShaderUniforms(): void;
  142594. /**
  142595. * Define if the texture animates or not.
  142596. */
  142597. get animate(): boolean;
  142598. set animate(value: boolean);
  142599. }
  142600. }
  142601. declare module BABYLON {
  142602. /** @hidden */
  142603. export var noisePixelShader: {
  142604. name: string;
  142605. shader: string;
  142606. };
  142607. }
  142608. declare module BABYLON {
  142609. /**
  142610. * Class used to generate noise procedural textures
  142611. */
  142612. export class NoiseProceduralTexture extends ProceduralTexture {
  142613. /** Gets or sets the start time (default is 0) */
  142614. time: number;
  142615. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  142616. brightness: number;
  142617. /** Defines the number of octaves to process */
  142618. octaves: number;
  142619. /** Defines the level of persistence (0.8 by default) */
  142620. persistence: number;
  142621. /** Gets or sets animation speed factor (default is 1) */
  142622. animationSpeedFactor: number;
  142623. /**
  142624. * Creates a new NoiseProceduralTexture
  142625. * @param name defines the name fo the texture
  142626. * @param size defines the size of the texture (default is 256)
  142627. * @param scene defines the hosting scene
  142628. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  142629. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  142630. */
  142631. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  142632. private _updateShaderUniforms;
  142633. protected _getDefines(): string;
  142634. /** Generate the current state of the procedural texture */
  142635. render(useCameraPostProcess?: boolean): void;
  142636. /**
  142637. * Serializes this noise procedural texture
  142638. * @returns a serialized noise procedural texture object
  142639. */
  142640. serialize(): any;
  142641. /**
  142642. * Clone the texture.
  142643. * @returns the cloned texture
  142644. */
  142645. clone(): NoiseProceduralTexture;
  142646. /**
  142647. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  142648. * @param parsedTexture defines parsed texture data
  142649. * @param scene defines the current scene
  142650. * @param rootUrl defines the root URL containing noise procedural texture information
  142651. * @returns a parsed NoiseProceduralTexture
  142652. */
  142653. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  142654. }
  142655. }
  142656. declare module BABYLON {
  142657. /**
  142658. * Raw cube texture where the raw buffers are passed in
  142659. */
  142660. export class RawCubeTexture extends CubeTexture {
  142661. /**
  142662. * Creates a cube texture where the raw buffers are passed in.
  142663. * @param scene defines the scene the texture is attached to
  142664. * @param data defines the array of data to use to create each face
  142665. * @param size defines the size of the textures
  142666. * @param format defines the format of the data
  142667. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  142668. * @param generateMipMaps defines if the engine should generate the mip levels
  142669. * @param invertY defines if data must be stored with Y axis inverted
  142670. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  142671. * @param compression defines the compression used (null by default)
  142672. */
  142673. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  142674. /**
  142675. * Updates the raw cube texture.
  142676. * @param data defines the data to store
  142677. * @param format defines the data format
  142678. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  142679. * @param invertY defines if data must be stored with Y axis inverted
  142680. * @param compression defines the compression used (null by default)
  142681. * @param level defines which level of the texture to update
  142682. */
  142683. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  142684. /**
  142685. * Updates a raw cube texture with RGBD encoded data.
  142686. * @param data defines the array of data [mipmap][face] to use to create each face
  142687. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  142688. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  142689. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  142690. * @returns a promsie that resolves when the operation is complete
  142691. */
  142692. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  142693. /**
  142694. * Clones the raw cube texture.
  142695. * @return a new cube texture
  142696. */
  142697. clone(): CubeTexture;
  142698. /** @hidden */
  142699. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  142700. }
  142701. }
  142702. declare module BABYLON {
  142703. /**
  142704. * Class used to store 2D array textures containing user data
  142705. */
  142706. export class RawTexture2DArray extends Texture {
  142707. /** Gets or sets the texture format to use */
  142708. format: number;
  142709. /**
  142710. * Create a new RawTexture2DArray
  142711. * @param data defines the data of the texture
  142712. * @param width defines the width of the texture
  142713. * @param height defines the height of the texture
  142714. * @param depth defines the number of layers of the texture
  142715. * @param format defines the texture format to use
  142716. * @param scene defines the hosting scene
  142717. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  142718. * @param invertY defines if texture must be stored with Y axis inverted
  142719. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  142720. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  142721. */
  142722. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  142723. /** Gets or sets the texture format to use */
  142724. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  142725. /**
  142726. * Update the texture with new data
  142727. * @param data defines the data to store in the texture
  142728. */
  142729. update(data: ArrayBufferView): void;
  142730. }
  142731. }
  142732. declare module BABYLON {
  142733. /**
  142734. * Class used to store 3D textures containing user data
  142735. */
  142736. export class RawTexture3D extends Texture {
  142737. /** Gets or sets the texture format to use */
  142738. format: number;
  142739. /**
  142740. * Create a new RawTexture3D
  142741. * @param data defines the data of the texture
  142742. * @param width defines the width of the texture
  142743. * @param height defines the height of the texture
  142744. * @param depth defines the depth of the texture
  142745. * @param format defines the texture format to use
  142746. * @param scene defines the hosting scene
  142747. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  142748. * @param invertY defines if texture must be stored with Y axis inverted
  142749. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  142750. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  142751. */
  142752. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  142753. /** Gets or sets the texture format to use */
  142754. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  142755. /**
  142756. * Update the texture with new data
  142757. * @param data defines the data to store in the texture
  142758. */
  142759. update(data: ArrayBufferView): void;
  142760. }
  142761. }
  142762. declare module BABYLON {
  142763. /**
  142764. * Creates a refraction texture used by refraction channel of the standard material.
  142765. * It is like a mirror but to see through a material.
  142766. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  142767. */
  142768. export class RefractionTexture extends RenderTargetTexture {
  142769. /**
  142770. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  142771. * 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.
  142772. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  142773. */
  142774. refractionPlane: Plane;
  142775. /**
  142776. * Define how deep under the surface we should see.
  142777. */
  142778. depth: number;
  142779. /**
  142780. * Creates a refraction texture used by refraction channel of the standard material.
  142781. * It is like a mirror but to see through a material.
  142782. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  142783. * @param name Define the texture name
  142784. * @param size Define the size of the underlying texture
  142785. * @param scene Define the scene the refraction belongs to
  142786. * @param generateMipMaps Define if we need to generate mips level for the refraction
  142787. */
  142788. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  142789. /**
  142790. * Clone the refraction texture.
  142791. * @returns the cloned texture
  142792. */
  142793. clone(): RefractionTexture;
  142794. /**
  142795. * Serialize the texture to a JSON representation you could use in Parse later on
  142796. * @returns the serialized JSON representation
  142797. */
  142798. serialize(): any;
  142799. }
  142800. }
  142801. declare module BABYLON {
  142802. /**
  142803. * Block used to add support for vertex skinning (bones)
  142804. */
  142805. export class BonesBlock extends NodeMaterialBlock {
  142806. /**
  142807. * Creates a new BonesBlock
  142808. * @param name defines the block name
  142809. */
  142810. constructor(name: string);
  142811. /**
  142812. * Initialize the block and prepare the context for build
  142813. * @param state defines the state that will be used for the build
  142814. */
  142815. initialize(state: NodeMaterialBuildState): void;
  142816. /**
  142817. * Gets the current class name
  142818. * @returns the class name
  142819. */
  142820. getClassName(): string;
  142821. /**
  142822. * Gets the matrix indices input component
  142823. */
  142824. get matricesIndices(): NodeMaterialConnectionPoint;
  142825. /**
  142826. * Gets the matrix weights input component
  142827. */
  142828. get matricesWeights(): NodeMaterialConnectionPoint;
  142829. /**
  142830. * Gets the extra matrix indices input component
  142831. */
  142832. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  142833. /**
  142834. * Gets the extra matrix weights input component
  142835. */
  142836. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  142837. /**
  142838. * Gets the world input component
  142839. */
  142840. get world(): NodeMaterialConnectionPoint;
  142841. /**
  142842. * Gets the output component
  142843. */
  142844. get output(): NodeMaterialConnectionPoint;
  142845. autoConfigure(material: NodeMaterial): void;
  142846. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  142847. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142848. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142849. protected _buildBlock(state: NodeMaterialBuildState): this;
  142850. }
  142851. }
  142852. declare module BABYLON {
  142853. /**
  142854. * Block used to add support for instances
  142855. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  142856. */
  142857. export class InstancesBlock extends NodeMaterialBlock {
  142858. /**
  142859. * Creates a new InstancesBlock
  142860. * @param name defines the block name
  142861. */
  142862. constructor(name: string);
  142863. /**
  142864. * Gets the current class name
  142865. * @returns the class name
  142866. */
  142867. getClassName(): string;
  142868. /**
  142869. * Gets the first world row input component
  142870. */
  142871. get world0(): NodeMaterialConnectionPoint;
  142872. /**
  142873. * Gets the second world row input component
  142874. */
  142875. get world1(): NodeMaterialConnectionPoint;
  142876. /**
  142877. * Gets the third world row input component
  142878. */
  142879. get world2(): NodeMaterialConnectionPoint;
  142880. /**
  142881. * Gets the forth world row input component
  142882. */
  142883. get world3(): NodeMaterialConnectionPoint;
  142884. /**
  142885. * Gets the world input component
  142886. */
  142887. get world(): NodeMaterialConnectionPoint;
  142888. /**
  142889. * Gets the output component
  142890. */
  142891. get output(): NodeMaterialConnectionPoint;
  142892. /**
  142893. * Gets the isntanceID component
  142894. */
  142895. get instanceID(): NodeMaterialConnectionPoint;
  142896. autoConfigure(material: NodeMaterial): void;
  142897. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  142898. protected _buildBlock(state: NodeMaterialBuildState): this;
  142899. }
  142900. }
  142901. declare module BABYLON {
  142902. /**
  142903. * Block used to add morph targets support to vertex shader
  142904. */
  142905. export class MorphTargetsBlock extends NodeMaterialBlock {
  142906. private _repeatableContentAnchor;
  142907. /**
  142908. * Create a new MorphTargetsBlock
  142909. * @param name defines the block name
  142910. */
  142911. constructor(name: string);
  142912. /**
  142913. * Gets the current class name
  142914. * @returns the class name
  142915. */
  142916. getClassName(): string;
  142917. /**
  142918. * Gets the position input component
  142919. */
  142920. get position(): NodeMaterialConnectionPoint;
  142921. /**
  142922. * Gets the normal input component
  142923. */
  142924. get normal(): NodeMaterialConnectionPoint;
  142925. /**
  142926. * Gets the tangent input component
  142927. */
  142928. get tangent(): NodeMaterialConnectionPoint;
  142929. /**
  142930. * Gets the tangent input component
  142931. */
  142932. get uv(): NodeMaterialConnectionPoint;
  142933. /**
  142934. * Gets the position output component
  142935. */
  142936. get positionOutput(): NodeMaterialConnectionPoint;
  142937. /**
  142938. * Gets the normal output component
  142939. */
  142940. get normalOutput(): NodeMaterialConnectionPoint;
  142941. /**
  142942. * Gets the tangent output component
  142943. */
  142944. get tangentOutput(): NodeMaterialConnectionPoint;
  142945. /**
  142946. * Gets the tangent output component
  142947. */
  142948. get uvOutput(): NodeMaterialConnectionPoint;
  142949. initialize(state: NodeMaterialBuildState): void;
  142950. autoConfigure(material: NodeMaterial): void;
  142951. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142952. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142953. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  142954. protected _buildBlock(state: NodeMaterialBuildState): this;
  142955. }
  142956. }
  142957. declare module BABYLON {
  142958. /**
  142959. * Block used to get data information from a light
  142960. */
  142961. export class LightInformationBlock extends NodeMaterialBlock {
  142962. private _lightDataUniformName;
  142963. private _lightColorUniformName;
  142964. private _lightTypeDefineName;
  142965. /**
  142966. * Gets or sets the light associated with this block
  142967. */
  142968. light: Nullable<Light>;
  142969. /**
  142970. * Creates a new LightInformationBlock
  142971. * @param name defines the block name
  142972. */
  142973. constructor(name: string);
  142974. /**
  142975. * Gets the current class name
  142976. * @returns the class name
  142977. */
  142978. getClassName(): string;
  142979. /**
  142980. * Gets the world position input component
  142981. */
  142982. get worldPosition(): NodeMaterialConnectionPoint;
  142983. /**
  142984. * Gets the direction output component
  142985. */
  142986. get direction(): NodeMaterialConnectionPoint;
  142987. /**
  142988. * Gets the direction output component
  142989. */
  142990. get color(): NodeMaterialConnectionPoint;
  142991. /**
  142992. * Gets the direction output component
  142993. */
  142994. get intensity(): NodeMaterialConnectionPoint;
  142995. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142996. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142997. protected _buildBlock(state: NodeMaterialBuildState): this;
  142998. serialize(): any;
  142999. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143000. }
  143001. }
  143002. declare module BABYLON {
  143003. /**
  143004. * Block used to add image processing support to fragment shader
  143005. */
  143006. export class ImageProcessingBlock extends NodeMaterialBlock {
  143007. /**
  143008. * Create a new ImageProcessingBlock
  143009. * @param name defines the block name
  143010. */
  143011. constructor(name: string);
  143012. /**
  143013. * Gets the current class name
  143014. * @returns the class name
  143015. */
  143016. getClassName(): string;
  143017. /**
  143018. * Gets the color input component
  143019. */
  143020. get color(): NodeMaterialConnectionPoint;
  143021. /**
  143022. * Gets the output component
  143023. */
  143024. get output(): NodeMaterialConnectionPoint;
  143025. /**
  143026. * Initialize the block and prepare the context for build
  143027. * @param state defines the state that will be used for the build
  143028. */
  143029. initialize(state: NodeMaterialBuildState): void;
  143030. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  143031. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143032. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  143033. protected _buildBlock(state: NodeMaterialBuildState): this;
  143034. }
  143035. }
  143036. declare module BABYLON {
  143037. /**
  143038. * Block used to pertub normals based on a normal map
  143039. */
  143040. export class PerturbNormalBlock extends NodeMaterialBlock {
  143041. private _tangentSpaceParameterName;
  143042. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  143043. invertX: boolean;
  143044. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  143045. invertY: boolean;
  143046. /**
  143047. * Create a new PerturbNormalBlock
  143048. * @param name defines the block name
  143049. */
  143050. constructor(name: string);
  143051. /**
  143052. * Gets the current class name
  143053. * @returns the class name
  143054. */
  143055. getClassName(): string;
  143056. /**
  143057. * Gets the world position input component
  143058. */
  143059. get worldPosition(): NodeMaterialConnectionPoint;
  143060. /**
  143061. * Gets the world normal input component
  143062. */
  143063. get worldNormal(): NodeMaterialConnectionPoint;
  143064. /**
  143065. * Gets the world tangent input component
  143066. */
  143067. get worldTangent(): NodeMaterialConnectionPoint;
  143068. /**
  143069. * Gets the uv input component
  143070. */
  143071. get uv(): NodeMaterialConnectionPoint;
  143072. /**
  143073. * Gets the normal map color input component
  143074. */
  143075. get normalMapColor(): NodeMaterialConnectionPoint;
  143076. /**
  143077. * Gets the strength input component
  143078. */
  143079. get strength(): NodeMaterialConnectionPoint;
  143080. /**
  143081. * Gets the output component
  143082. */
  143083. get output(): NodeMaterialConnectionPoint;
  143084. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143085. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  143086. autoConfigure(material: NodeMaterial): void;
  143087. protected _buildBlock(state: NodeMaterialBuildState): this;
  143088. protected _dumpPropertiesCode(): string;
  143089. serialize(): any;
  143090. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143091. }
  143092. }
  143093. declare module BABYLON {
  143094. /**
  143095. * Block used to discard a pixel if a value is smaller than a cutoff
  143096. */
  143097. export class DiscardBlock extends NodeMaterialBlock {
  143098. /**
  143099. * Create a new DiscardBlock
  143100. * @param name defines the block name
  143101. */
  143102. constructor(name: string);
  143103. /**
  143104. * Gets the current class name
  143105. * @returns the class name
  143106. */
  143107. getClassName(): string;
  143108. /**
  143109. * Gets the color input component
  143110. */
  143111. get value(): NodeMaterialConnectionPoint;
  143112. /**
  143113. * Gets the cutoff input component
  143114. */
  143115. get cutoff(): NodeMaterialConnectionPoint;
  143116. protected _buildBlock(state: NodeMaterialBuildState): this;
  143117. }
  143118. }
  143119. declare module BABYLON {
  143120. /**
  143121. * Block used to test if the fragment shader is front facing
  143122. */
  143123. export class FrontFacingBlock extends NodeMaterialBlock {
  143124. /**
  143125. * Creates a new FrontFacingBlock
  143126. * @param name defines the block name
  143127. */
  143128. constructor(name: string);
  143129. /**
  143130. * Gets the current class name
  143131. * @returns the class name
  143132. */
  143133. getClassName(): string;
  143134. /**
  143135. * Gets the output component
  143136. */
  143137. get output(): NodeMaterialConnectionPoint;
  143138. protected _buildBlock(state: NodeMaterialBuildState): this;
  143139. }
  143140. }
  143141. declare module BABYLON {
  143142. /**
  143143. * Block used to get the derivative value on x and y of a given input
  143144. */
  143145. export class DerivativeBlock extends NodeMaterialBlock {
  143146. /**
  143147. * Create a new DerivativeBlock
  143148. * @param name defines the block name
  143149. */
  143150. constructor(name: string);
  143151. /**
  143152. * Gets the current class name
  143153. * @returns the class name
  143154. */
  143155. getClassName(): string;
  143156. /**
  143157. * Gets the input component
  143158. */
  143159. get input(): NodeMaterialConnectionPoint;
  143160. /**
  143161. * Gets the derivative output on x
  143162. */
  143163. get dx(): NodeMaterialConnectionPoint;
  143164. /**
  143165. * Gets the derivative output on y
  143166. */
  143167. get dy(): NodeMaterialConnectionPoint;
  143168. protected _buildBlock(state: NodeMaterialBuildState): this;
  143169. }
  143170. }
  143171. declare module BABYLON {
  143172. /**
  143173. * Block used to make gl_FragCoord available
  143174. */
  143175. export class FragCoordBlock extends NodeMaterialBlock {
  143176. /**
  143177. * Creates a new FragCoordBlock
  143178. * @param name defines the block name
  143179. */
  143180. constructor(name: string);
  143181. /**
  143182. * Gets the current class name
  143183. * @returns the class name
  143184. */
  143185. getClassName(): string;
  143186. /**
  143187. * Gets the xy component
  143188. */
  143189. get xy(): NodeMaterialConnectionPoint;
  143190. /**
  143191. * Gets the xyz component
  143192. */
  143193. get xyz(): NodeMaterialConnectionPoint;
  143194. /**
  143195. * Gets the xyzw component
  143196. */
  143197. get xyzw(): NodeMaterialConnectionPoint;
  143198. /**
  143199. * Gets the x component
  143200. */
  143201. get x(): NodeMaterialConnectionPoint;
  143202. /**
  143203. * Gets the y component
  143204. */
  143205. get y(): NodeMaterialConnectionPoint;
  143206. /**
  143207. * Gets the z component
  143208. */
  143209. get z(): NodeMaterialConnectionPoint;
  143210. /**
  143211. * Gets the w component
  143212. */
  143213. get output(): NodeMaterialConnectionPoint;
  143214. protected writeOutputs(state: NodeMaterialBuildState): string;
  143215. protected _buildBlock(state: NodeMaterialBuildState): this;
  143216. }
  143217. }
  143218. declare module BABYLON {
  143219. /**
  143220. * Block used to get the screen sizes
  143221. */
  143222. export class ScreenSizeBlock extends NodeMaterialBlock {
  143223. private _varName;
  143224. private _scene;
  143225. /**
  143226. * Creates a new ScreenSizeBlock
  143227. * @param name defines the block name
  143228. */
  143229. constructor(name: string);
  143230. /**
  143231. * Gets the current class name
  143232. * @returns the class name
  143233. */
  143234. getClassName(): string;
  143235. /**
  143236. * Gets the xy component
  143237. */
  143238. get xy(): NodeMaterialConnectionPoint;
  143239. /**
  143240. * Gets the x component
  143241. */
  143242. get x(): NodeMaterialConnectionPoint;
  143243. /**
  143244. * Gets the y component
  143245. */
  143246. get y(): NodeMaterialConnectionPoint;
  143247. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  143248. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  143249. protected _buildBlock(state: NodeMaterialBuildState): this;
  143250. }
  143251. }
  143252. declare module BABYLON {
  143253. /**
  143254. * Block used to add support for scene fog
  143255. */
  143256. export class FogBlock extends NodeMaterialBlock {
  143257. private _fogDistanceName;
  143258. private _fogParameters;
  143259. /**
  143260. * Create a new FogBlock
  143261. * @param name defines the block name
  143262. */
  143263. constructor(name: string);
  143264. /**
  143265. * Gets the current class name
  143266. * @returns the class name
  143267. */
  143268. getClassName(): string;
  143269. /**
  143270. * Gets the world position input component
  143271. */
  143272. get worldPosition(): NodeMaterialConnectionPoint;
  143273. /**
  143274. * Gets the view input component
  143275. */
  143276. get view(): NodeMaterialConnectionPoint;
  143277. /**
  143278. * Gets the color input component
  143279. */
  143280. get input(): NodeMaterialConnectionPoint;
  143281. /**
  143282. * Gets the fog color input component
  143283. */
  143284. get fogColor(): NodeMaterialConnectionPoint;
  143285. /**
  143286. * Gets the output component
  143287. */
  143288. get output(): NodeMaterialConnectionPoint;
  143289. autoConfigure(material: NodeMaterial): void;
  143290. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143291. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  143292. protected _buildBlock(state: NodeMaterialBuildState): this;
  143293. }
  143294. }
  143295. declare module BABYLON {
  143296. /**
  143297. * Block used to add light in the fragment shader
  143298. */
  143299. export class LightBlock extends NodeMaterialBlock {
  143300. private _lightId;
  143301. /**
  143302. * Gets or sets the light associated with this block
  143303. */
  143304. light: Nullable<Light>;
  143305. /**
  143306. * Create a new LightBlock
  143307. * @param name defines the block name
  143308. */
  143309. constructor(name: string);
  143310. /**
  143311. * Gets the current class name
  143312. * @returns the class name
  143313. */
  143314. getClassName(): string;
  143315. /**
  143316. * Gets the world position input component
  143317. */
  143318. get worldPosition(): NodeMaterialConnectionPoint;
  143319. /**
  143320. * Gets the world normal input component
  143321. */
  143322. get worldNormal(): NodeMaterialConnectionPoint;
  143323. /**
  143324. * Gets the camera (or eye) position component
  143325. */
  143326. get cameraPosition(): NodeMaterialConnectionPoint;
  143327. /**
  143328. * Gets the glossiness component
  143329. */
  143330. get glossiness(): NodeMaterialConnectionPoint;
  143331. /**
  143332. * Gets the glossinness power component
  143333. */
  143334. get glossPower(): NodeMaterialConnectionPoint;
  143335. /**
  143336. * Gets the diffuse color component
  143337. */
  143338. get diffuseColor(): NodeMaterialConnectionPoint;
  143339. /**
  143340. * Gets the specular color component
  143341. */
  143342. get specularColor(): NodeMaterialConnectionPoint;
  143343. /**
  143344. * Gets the diffuse output component
  143345. */
  143346. get diffuseOutput(): NodeMaterialConnectionPoint;
  143347. /**
  143348. * Gets the specular output component
  143349. */
  143350. get specularOutput(): NodeMaterialConnectionPoint;
  143351. /**
  143352. * Gets the shadow output component
  143353. */
  143354. get shadow(): NodeMaterialConnectionPoint;
  143355. autoConfigure(material: NodeMaterial): void;
  143356. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143357. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  143358. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  143359. private _injectVertexCode;
  143360. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143361. serialize(): any;
  143362. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143363. }
  143364. }
  143365. declare module BABYLON {
  143366. /**
  143367. * Block used to read a reflection texture from a sampler
  143368. */
  143369. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  143370. /**
  143371. * Create a new ReflectionTextureBlock
  143372. * @param name defines the block name
  143373. */
  143374. constructor(name: string);
  143375. /**
  143376. * Gets the current class name
  143377. * @returns the class name
  143378. */
  143379. getClassName(): string;
  143380. /**
  143381. * Gets the world position input component
  143382. */
  143383. get position(): NodeMaterialConnectionPoint;
  143384. /**
  143385. * Gets the world position input component
  143386. */
  143387. get worldPosition(): NodeMaterialConnectionPoint;
  143388. /**
  143389. * Gets the world normal input component
  143390. */
  143391. get worldNormal(): NodeMaterialConnectionPoint;
  143392. /**
  143393. * Gets the world input component
  143394. */
  143395. get world(): NodeMaterialConnectionPoint;
  143396. /**
  143397. * Gets the camera (or eye) position component
  143398. */
  143399. get cameraPosition(): NodeMaterialConnectionPoint;
  143400. /**
  143401. * Gets the view input component
  143402. */
  143403. get view(): NodeMaterialConnectionPoint;
  143404. /**
  143405. * Gets the rgb output component
  143406. */
  143407. get rgb(): NodeMaterialConnectionPoint;
  143408. /**
  143409. * Gets the rgba output component
  143410. */
  143411. get rgba(): NodeMaterialConnectionPoint;
  143412. /**
  143413. * Gets the r output component
  143414. */
  143415. get r(): NodeMaterialConnectionPoint;
  143416. /**
  143417. * Gets the g output component
  143418. */
  143419. get g(): NodeMaterialConnectionPoint;
  143420. /**
  143421. * Gets the b output component
  143422. */
  143423. get b(): NodeMaterialConnectionPoint;
  143424. /**
  143425. * Gets the a output component
  143426. */
  143427. get a(): NodeMaterialConnectionPoint;
  143428. autoConfigure(material: NodeMaterial): void;
  143429. protected _buildBlock(state: NodeMaterialBuildState): this;
  143430. }
  143431. }
  143432. declare module BABYLON {
  143433. /**
  143434. * Block used to add 2 vectors
  143435. */
  143436. export class AddBlock extends NodeMaterialBlock {
  143437. /**
  143438. * Creates a new AddBlock
  143439. * @param name defines the block name
  143440. */
  143441. constructor(name: string);
  143442. /**
  143443. * Gets the current class name
  143444. * @returns the class name
  143445. */
  143446. getClassName(): string;
  143447. /**
  143448. * Gets the left operand input component
  143449. */
  143450. get left(): NodeMaterialConnectionPoint;
  143451. /**
  143452. * Gets the right operand input component
  143453. */
  143454. get right(): NodeMaterialConnectionPoint;
  143455. /**
  143456. * Gets the output component
  143457. */
  143458. get output(): NodeMaterialConnectionPoint;
  143459. protected _buildBlock(state: NodeMaterialBuildState): this;
  143460. }
  143461. }
  143462. declare module BABYLON {
  143463. /**
  143464. * Block used to scale a vector by a float
  143465. */
  143466. export class ScaleBlock extends NodeMaterialBlock {
  143467. /**
  143468. * Creates a new ScaleBlock
  143469. * @param name defines the block name
  143470. */
  143471. constructor(name: string);
  143472. /**
  143473. * Gets the current class name
  143474. * @returns the class name
  143475. */
  143476. getClassName(): string;
  143477. /**
  143478. * Gets the input component
  143479. */
  143480. get input(): NodeMaterialConnectionPoint;
  143481. /**
  143482. * Gets the factor input component
  143483. */
  143484. get factor(): NodeMaterialConnectionPoint;
  143485. /**
  143486. * Gets the output component
  143487. */
  143488. get output(): NodeMaterialConnectionPoint;
  143489. protected _buildBlock(state: NodeMaterialBuildState): this;
  143490. }
  143491. }
  143492. declare module BABYLON {
  143493. /**
  143494. * Block used to clamp a float
  143495. */
  143496. export class ClampBlock extends NodeMaterialBlock {
  143497. /** Gets or sets the minimum range */
  143498. minimum: number;
  143499. /** Gets or sets the maximum range */
  143500. maximum: number;
  143501. /**
  143502. * Creates a new ClampBlock
  143503. * @param name defines the block name
  143504. */
  143505. constructor(name: string);
  143506. /**
  143507. * Gets the current class name
  143508. * @returns the class name
  143509. */
  143510. getClassName(): string;
  143511. /**
  143512. * Gets the value input component
  143513. */
  143514. get value(): NodeMaterialConnectionPoint;
  143515. /**
  143516. * Gets the output component
  143517. */
  143518. get output(): NodeMaterialConnectionPoint;
  143519. protected _buildBlock(state: NodeMaterialBuildState): this;
  143520. protected _dumpPropertiesCode(): string;
  143521. serialize(): any;
  143522. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143523. }
  143524. }
  143525. declare module BABYLON {
  143526. /**
  143527. * Block used to apply a cross product between 2 vectors
  143528. */
  143529. export class CrossBlock extends NodeMaterialBlock {
  143530. /**
  143531. * Creates a new CrossBlock
  143532. * @param name defines the block name
  143533. */
  143534. constructor(name: string);
  143535. /**
  143536. * Gets the current class name
  143537. * @returns the class name
  143538. */
  143539. getClassName(): string;
  143540. /**
  143541. * Gets the left operand input component
  143542. */
  143543. get left(): NodeMaterialConnectionPoint;
  143544. /**
  143545. * Gets the right operand input component
  143546. */
  143547. get right(): NodeMaterialConnectionPoint;
  143548. /**
  143549. * Gets the output component
  143550. */
  143551. get output(): NodeMaterialConnectionPoint;
  143552. protected _buildBlock(state: NodeMaterialBuildState): this;
  143553. }
  143554. }
  143555. declare module BABYLON {
  143556. /**
  143557. * Block used to apply a dot product between 2 vectors
  143558. */
  143559. export class DotBlock extends NodeMaterialBlock {
  143560. /**
  143561. * Creates a new DotBlock
  143562. * @param name defines the block name
  143563. */
  143564. constructor(name: string);
  143565. /**
  143566. * Gets the current class name
  143567. * @returns the class name
  143568. */
  143569. getClassName(): string;
  143570. /**
  143571. * Gets the left operand input component
  143572. */
  143573. get left(): NodeMaterialConnectionPoint;
  143574. /**
  143575. * Gets the right operand input component
  143576. */
  143577. get right(): NodeMaterialConnectionPoint;
  143578. /**
  143579. * Gets the output component
  143580. */
  143581. get output(): NodeMaterialConnectionPoint;
  143582. protected _buildBlock(state: NodeMaterialBuildState): this;
  143583. }
  143584. }
  143585. declare module BABYLON {
  143586. /**
  143587. * Block used to normalize a vector
  143588. */
  143589. export class NormalizeBlock extends NodeMaterialBlock {
  143590. /**
  143591. * Creates a new NormalizeBlock
  143592. * @param name defines the block name
  143593. */
  143594. constructor(name: string);
  143595. /**
  143596. * Gets the current class name
  143597. * @returns the class name
  143598. */
  143599. getClassName(): string;
  143600. /**
  143601. * Gets the input component
  143602. */
  143603. get input(): NodeMaterialConnectionPoint;
  143604. /**
  143605. * Gets the output component
  143606. */
  143607. get output(): NodeMaterialConnectionPoint;
  143608. protected _buildBlock(state: NodeMaterialBuildState): this;
  143609. }
  143610. }
  143611. declare module BABYLON {
  143612. /**
  143613. * Block used to create a Color3/4 out of individual inputs (one for each component)
  143614. */
  143615. export class ColorMergerBlock extends NodeMaterialBlock {
  143616. /**
  143617. * Create a new ColorMergerBlock
  143618. * @param name defines the block name
  143619. */
  143620. constructor(name: string);
  143621. /**
  143622. * Gets the current class name
  143623. * @returns the class name
  143624. */
  143625. getClassName(): string;
  143626. /**
  143627. * Gets the rgb component (input)
  143628. */
  143629. get rgbIn(): NodeMaterialConnectionPoint;
  143630. /**
  143631. * Gets the r component (input)
  143632. */
  143633. get r(): NodeMaterialConnectionPoint;
  143634. /**
  143635. * Gets the g component (input)
  143636. */
  143637. get g(): NodeMaterialConnectionPoint;
  143638. /**
  143639. * Gets the b component (input)
  143640. */
  143641. get b(): NodeMaterialConnectionPoint;
  143642. /**
  143643. * Gets the a component (input)
  143644. */
  143645. get a(): NodeMaterialConnectionPoint;
  143646. /**
  143647. * Gets the rgba component (output)
  143648. */
  143649. get rgba(): NodeMaterialConnectionPoint;
  143650. /**
  143651. * Gets the rgb component (output)
  143652. */
  143653. get rgbOut(): NodeMaterialConnectionPoint;
  143654. /**
  143655. * Gets the rgb component (output)
  143656. * @deprecated Please use rgbOut instead.
  143657. */
  143658. get rgb(): NodeMaterialConnectionPoint;
  143659. protected _buildBlock(state: NodeMaterialBuildState): this;
  143660. }
  143661. }
  143662. declare module BABYLON {
  143663. /**
  143664. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  143665. */
  143666. export class VectorSplitterBlock extends NodeMaterialBlock {
  143667. /**
  143668. * Create a new VectorSplitterBlock
  143669. * @param name defines the block name
  143670. */
  143671. constructor(name: string);
  143672. /**
  143673. * Gets the current class name
  143674. * @returns the class name
  143675. */
  143676. getClassName(): string;
  143677. /**
  143678. * Gets the xyzw component (input)
  143679. */
  143680. get xyzw(): NodeMaterialConnectionPoint;
  143681. /**
  143682. * Gets the xyz component (input)
  143683. */
  143684. get xyzIn(): NodeMaterialConnectionPoint;
  143685. /**
  143686. * Gets the xy component (input)
  143687. */
  143688. get xyIn(): NodeMaterialConnectionPoint;
  143689. /**
  143690. * Gets the xyz component (output)
  143691. */
  143692. get xyzOut(): NodeMaterialConnectionPoint;
  143693. /**
  143694. * Gets the xy component (output)
  143695. */
  143696. get xyOut(): NodeMaterialConnectionPoint;
  143697. /**
  143698. * Gets the x component (output)
  143699. */
  143700. get x(): NodeMaterialConnectionPoint;
  143701. /**
  143702. * Gets the y component (output)
  143703. */
  143704. get y(): NodeMaterialConnectionPoint;
  143705. /**
  143706. * Gets the z component (output)
  143707. */
  143708. get z(): NodeMaterialConnectionPoint;
  143709. /**
  143710. * Gets the w component (output)
  143711. */
  143712. get w(): NodeMaterialConnectionPoint;
  143713. protected _inputRename(name: string): string;
  143714. protected _outputRename(name: string): string;
  143715. protected _buildBlock(state: NodeMaterialBuildState): this;
  143716. }
  143717. }
  143718. declare module BABYLON {
  143719. /**
  143720. * Block used to lerp between 2 values
  143721. */
  143722. export class LerpBlock extends NodeMaterialBlock {
  143723. /**
  143724. * Creates a new LerpBlock
  143725. * @param name defines the block name
  143726. */
  143727. constructor(name: string);
  143728. /**
  143729. * Gets the current class name
  143730. * @returns the class name
  143731. */
  143732. getClassName(): string;
  143733. /**
  143734. * Gets the left operand input component
  143735. */
  143736. get left(): NodeMaterialConnectionPoint;
  143737. /**
  143738. * Gets the right operand input component
  143739. */
  143740. get right(): NodeMaterialConnectionPoint;
  143741. /**
  143742. * Gets the gradient operand input component
  143743. */
  143744. get gradient(): NodeMaterialConnectionPoint;
  143745. /**
  143746. * Gets the output component
  143747. */
  143748. get output(): NodeMaterialConnectionPoint;
  143749. protected _buildBlock(state: NodeMaterialBuildState): this;
  143750. }
  143751. }
  143752. declare module BABYLON {
  143753. /**
  143754. * Block used to divide 2 vectors
  143755. */
  143756. export class DivideBlock extends NodeMaterialBlock {
  143757. /**
  143758. * Creates a new DivideBlock
  143759. * @param name defines the block name
  143760. */
  143761. constructor(name: string);
  143762. /**
  143763. * Gets the current class name
  143764. * @returns the class name
  143765. */
  143766. getClassName(): string;
  143767. /**
  143768. * Gets the left operand input component
  143769. */
  143770. get left(): NodeMaterialConnectionPoint;
  143771. /**
  143772. * Gets the right operand input component
  143773. */
  143774. get right(): NodeMaterialConnectionPoint;
  143775. /**
  143776. * Gets the output component
  143777. */
  143778. get output(): NodeMaterialConnectionPoint;
  143779. protected _buildBlock(state: NodeMaterialBuildState): this;
  143780. }
  143781. }
  143782. declare module BABYLON {
  143783. /**
  143784. * Block used to subtract 2 vectors
  143785. */
  143786. export class SubtractBlock extends NodeMaterialBlock {
  143787. /**
  143788. * Creates a new SubtractBlock
  143789. * @param name defines the block name
  143790. */
  143791. constructor(name: string);
  143792. /**
  143793. * Gets the current class name
  143794. * @returns the class name
  143795. */
  143796. getClassName(): string;
  143797. /**
  143798. * Gets the left operand input component
  143799. */
  143800. get left(): NodeMaterialConnectionPoint;
  143801. /**
  143802. * Gets the right operand input component
  143803. */
  143804. get right(): NodeMaterialConnectionPoint;
  143805. /**
  143806. * Gets the output component
  143807. */
  143808. get output(): NodeMaterialConnectionPoint;
  143809. protected _buildBlock(state: NodeMaterialBuildState): this;
  143810. }
  143811. }
  143812. declare module BABYLON {
  143813. /**
  143814. * Block used to step a value
  143815. */
  143816. export class StepBlock extends NodeMaterialBlock {
  143817. /**
  143818. * Creates a new StepBlock
  143819. * @param name defines the block name
  143820. */
  143821. constructor(name: string);
  143822. /**
  143823. * Gets the current class name
  143824. * @returns the class name
  143825. */
  143826. getClassName(): string;
  143827. /**
  143828. * Gets the value operand input component
  143829. */
  143830. get value(): NodeMaterialConnectionPoint;
  143831. /**
  143832. * Gets the edge operand input component
  143833. */
  143834. get edge(): NodeMaterialConnectionPoint;
  143835. /**
  143836. * Gets the output component
  143837. */
  143838. get output(): NodeMaterialConnectionPoint;
  143839. protected _buildBlock(state: NodeMaterialBuildState): this;
  143840. }
  143841. }
  143842. declare module BABYLON {
  143843. /**
  143844. * Block used to get the opposite (1 - x) of a value
  143845. */
  143846. export class OneMinusBlock extends NodeMaterialBlock {
  143847. /**
  143848. * Creates a new OneMinusBlock
  143849. * @param name defines the block name
  143850. */
  143851. constructor(name: string);
  143852. /**
  143853. * Gets the current class name
  143854. * @returns the class name
  143855. */
  143856. getClassName(): string;
  143857. /**
  143858. * Gets the input component
  143859. */
  143860. get input(): NodeMaterialConnectionPoint;
  143861. /**
  143862. * Gets the output component
  143863. */
  143864. get output(): NodeMaterialConnectionPoint;
  143865. protected _buildBlock(state: NodeMaterialBuildState): this;
  143866. }
  143867. }
  143868. declare module BABYLON {
  143869. /**
  143870. * Block used to get the view direction
  143871. */
  143872. export class ViewDirectionBlock extends NodeMaterialBlock {
  143873. /**
  143874. * Creates a new ViewDirectionBlock
  143875. * @param name defines the block name
  143876. */
  143877. constructor(name: string);
  143878. /**
  143879. * Gets the current class name
  143880. * @returns the class name
  143881. */
  143882. getClassName(): string;
  143883. /**
  143884. * Gets the world position component
  143885. */
  143886. get worldPosition(): NodeMaterialConnectionPoint;
  143887. /**
  143888. * Gets the camera position component
  143889. */
  143890. get cameraPosition(): NodeMaterialConnectionPoint;
  143891. /**
  143892. * Gets the output component
  143893. */
  143894. get output(): NodeMaterialConnectionPoint;
  143895. autoConfigure(material: NodeMaterial): void;
  143896. protected _buildBlock(state: NodeMaterialBuildState): this;
  143897. }
  143898. }
  143899. declare module BABYLON {
  143900. /**
  143901. * Block used to compute fresnel value
  143902. */
  143903. export class FresnelBlock extends NodeMaterialBlock {
  143904. /**
  143905. * Create a new FresnelBlock
  143906. * @param name defines the block name
  143907. */
  143908. constructor(name: string);
  143909. /**
  143910. * Gets the current class name
  143911. * @returns the class name
  143912. */
  143913. getClassName(): string;
  143914. /**
  143915. * Gets the world normal input component
  143916. */
  143917. get worldNormal(): NodeMaterialConnectionPoint;
  143918. /**
  143919. * Gets the view direction input component
  143920. */
  143921. get viewDirection(): NodeMaterialConnectionPoint;
  143922. /**
  143923. * Gets the bias input component
  143924. */
  143925. get bias(): NodeMaterialConnectionPoint;
  143926. /**
  143927. * Gets the camera (or eye) position component
  143928. */
  143929. get power(): NodeMaterialConnectionPoint;
  143930. /**
  143931. * Gets the fresnel output component
  143932. */
  143933. get fresnel(): NodeMaterialConnectionPoint;
  143934. autoConfigure(material: NodeMaterial): void;
  143935. protected _buildBlock(state: NodeMaterialBuildState): this;
  143936. }
  143937. }
  143938. declare module BABYLON {
  143939. /**
  143940. * Block used to get the max of 2 values
  143941. */
  143942. export class MaxBlock extends NodeMaterialBlock {
  143943. /**
  143944. * Creates a new MaxBlock
  143945. * @param name defines the block name
  143946. */
  143947. constructor(name: string);
  143948. /**
  143949. * Gets the current class name
  143950. * @returns the class name
  143951. */
  143952. getClassName(): string;
  143953. /**
  143954. * Gets the left operand input component
  143955. */
  143956. get left(): NodeMaterialConnectionPoint;
  143957. /**
  143958. * Gets the right operand input component
  143959. */
  143960. get right(): NodeMaterialConnectionPoint;
  143961. /**
  143962. * Gets the output component
  143963. */
  143964. get output(): NodeMaterialConnectionPoint;
  143965. protected _buildBlock(state: NodeMaterialBuildState): this;
  143966. }
  143967. }
  143968. declare module BABYLON {
  143969. /**
  143970. * Block used to get the min of 2 values
  143971. */
  143972. export class MinBlock extends NodeMaterialBlock {
  143973. /**
  143974. * Creates a new MinBlock
  143975. * @param name defines the block name
  143976. */
  143977. constructor(name: string);
  143978. /**
  143979. * Gets the current class name
  143980. * @returns the class name
  143981. */
  143982. getClassName(): string;
  143983. /**
  143984. * Gets the left operand input component
  143985. */
  143986. get left(): NodeMaterialConnectionPoint;
  143987. /**
  143988. * Gets the right operand input component
  143989. */
  143990. get right(): NodeMaterialConnectionPoint;
  143991. /**
  143992. * Gets the output component
  143993. */
  143994. get output(): NodeMaterialConnectionPoint;
  143995. protected _buildBlock(state: NodeMaterialBuildState): this;
  143996. }
  143997. }
  143998. declare module BABYLON {
  143999. /**
  144000. * Block used to get the distance between 2 values
  144001. */
  144002. export class DistanceBlock extends NodeMaterialBlock {
  144003. /**
  144004. * Creates a new DistanceBlock
  144005. * @param name defines the block name
  144006. */
  144007. constructor(name: string);
  144008. /**
  144009. * Gets the current class name
  144010. * @returns the class name
  144011. */
  144012. getClassName(): string;
  144013. /**
  144014. * Gets the left operand input component
  144015. */
  144016. get left(): NodeMaterialConnectionPoint;
  144017. /**
  144018. * Gets the right operand input component
  144019. */
  144020. get right(): NodeMaterialConnectionPoint;
  144021. /**
  144022. * Gets the output component
  144023. */
  144024. get output(): NodeMaterialConnectionPoint;
  144025. protected _buildBlock(state: NodeMaterialBuildState): this;
  144026. }
  144027. }
  144028. declare module BABYLON {
  144029. /**
  144030. * Block used to get the length of a vector
  144031. */
  144032. export class LengthBlock extends NodeMaterialBlock {
  144033. /**
  144034. * Creates a new LengthBlock
  144035. * @param name defines the block name
  144036. */
  144037. constructor(name: string);
  144038. /**
  144039. * Gets the current class name
  144040. * @returns the class name
  144041. */
  144042. getClassName(): string;
  144043. /**
  144044. * Gets the value input component
  144045. */
  144046. get value(): NodeMaterialConnectionPoint;
  144047. /**
  144048. * Gets the output component
  144049. */
  144050. get output(): NodeMaterialConnectionPoint;
  144051. protected _buildBlock(state: NodeMaterialBuildState): this;
  144052. }
  144053. }
  144054. declare module BABYLON {
  144055. /**
  144056. * Block used to get negative version of a value (i.e. x * -1)
  144057. */
  144058. export class NegateBlock extends NodeMaterialBlock {
  144059. /**
  144060. * Creates a new NegateBlock
  144061. * @param name defines the block name
  144062. */
  144063. constructor(name: string);
  144064. /**
  144065. * Gets the current class name
  144066. * @returns the class name
  144067. */
  144068. getClassName(): string;
  144069. /**
  144070. * Gets the value input component
  144071. */
  144072. get value(): NodeMaterialConnectionPoint;
  144073. /**
  144074. * Gets the output component
  144075. */
  144076. get output(): NodeMaterialConnectionPoint;
  144077. protected _buildBlock(state: NodeMaterialBuildState): this;
  144078. }
  144079. }
  144080. declare module BABYLON {
  144081. /**
  144082. * Block used to get the value of the first parameter raised to the power of the second
  144083. */
  144084. export class PowBlock extends NodeMaterialBlock {
  144085. /**
  144086. * Creates a new PowBlock
  144087. * @param name defines the block name
  144088. */
  144089. constructor(name: string);
  144090. /**
  144091. * Gets the current class name
  144092. * @returns the class name
  144093. */
  144094. getClassName(): string;
  144095. /**
  144096. * Gets the value operand input component
  144097. */
  144098. get value(): NodeMaterialConnectionPoint;
  144099. /**
  144100. * Gets the power operand input component
  144101. */
  144102. get power(): NodeMaterialConnectionPoint;
  144103. /**
  144104. * Gets the output component
  144105. */
  144106. get output(): NodeMaterialConnectionPoint;
  144107. protected _buildBlock(state: NodeMaterialBuildState): this;
  144108. }
  144109. }
  144110. declare module BABYLON {
  144111. /**
  144112. * Block used to get a random number
  144113. */
  144114. export class RandomNumberBlock extends NodeMaterialBlock {
  144115. /**
  144116. * Creates a new RandomNumberBlock
  144117. * @param name defines the block name
  144118. */
  144119. constructor(name: string);
  144120. /**
  144121. * Gets the current class name
  144122. * @returns the class name
  144123. */
  144124. getClassName(): string;
  144125. /**
  144126. * Gets the seed input component
  144127. */
  144128. get seed(): NodeMaterialConnectionPoint;
  144129. /**
  144130. * Gets the output component
  144131. */
  144132. get output(): NodeMaterialConnectionPoint;
  144133. protected _buildBlock(state: NodeMaterialBuildState): this;
  144134. }
  144135. }
  144136. declare module BABYLON {
  144137. /**
  144138. * Block used to compute arc tangent of 2 values
  144139. */
  144140. export class ArcTan2Block extends NodeMaterialBlock {
  144141. /**
  144142. * Creates a new ArcTan2Block
  144143. * @param name defines the block name
  144144. */
  144145. constructor(name: string);
  144146. /**
  144147. * Gets the current class name
  144148. * @returns the class name
  144149. */
  144150. getClassName(): string;
  144151. /**
  144152. * Gets the x operand input component
  144153. */
  144154. get x(): NodeMaterialConnectionPoint;
  144155. /**
  144156. * Gets the y operand input component
  144157. */
  144158. get y(): NodeMaterialConnectionPoint;
  144159. /**
  144160. * Gets the output component
  144161. */
  144162. get output(): NodeMaterialConnectionPoint;
  144163. protected _buildBlock(state: NodeMaterialBuildState): this;
  144164. }
  144165. }
  144166. declare module BABYLON {
  144167. /**
  144168. * Block used to smooth step a value
  144169. */
  144170. export class SmoothStepBlock extends NodeMaterialBlock {
  144171. /**
  144172. * Creates a new SmoothStepBlock
  144173. * @param name defines the block name
  144174. */
  144175. constructor(name: string);
  144176. /**
  144177. * Gets the current class name
  144178. * @returns the class name
  144179. */
  144180. getClassName(): string;
  144181. /**
  144182. * Gets the value operand input component
  144183. */
  144184. get value(): NodeMaterialConnectionPoint;
  144185. /**
  144186. * Gets the first edge operand input component
  144187. */
  144188. get edge0(): NodeMaterialConnectionPoint;
  144189. /**
  144190. * Gets the second edge operand input component
  144191. */
  144192. get edge1(): NodeMaterialConnectionPoint;
  144193. /**
  144194. * Gets the output component
  144195. */
  144196. get output(): NodeMaterialConnectionPoint;
  144197. protected _buildBlock(state: NodeMaterialBuildState): this;
  144198. }
  144199. }
  144200. declare module BABYLON {
  144201. /**
  144202. * Block used to get the reciprocal (1 / x) of a value
  144203. */
  144204. export class ReciprocalBlock extends NodeMaterialBlock {
  144205. /**
  144206. * Creates a new ReciprocalBlock
  144207. * @param name defines the block name
  144208. */
  144209. constructor(name: string);
  144210. /**
  144211. * Gets the current class name
  144212. * @returns the class name
  144213. */
  144214. getClassName(): string;
  144215. /**
  144216. * Gets the input component
  144217. */
  144218. get input(): NodeMaterialConnectionPoint;
  144219. /**
  144220. * Gets the output component
  144221. */
  144222. get output(): NodeMaterialConnectionPoint;
  144223. protected _buildBlock(state: NodeMaterialBuildState): this;
  144224. }
  144225. }
  144226. declare module BABYLON {
  144227. /**
  144228. * Block used to replace a color by another one
  144229. */
  144230. export class ReplaceColorBlock extends NodeMaterialBlock {
  144231. /**
  144232. * Creates a new ReplaceColorBlock
  144233. * @param name defines the block name
  144234. */
  144235. constructor(name: string);
  144236. /**
  144237. * Gets the current class name
  144238. * @returns the class name
  144239. */
  144240. getClassName(): string;
  144241. /**
  144242. * Gets the value input component
  144243. */
  144244. get value(): NodeMaterialConnectionPoint;
  144245. /**
  144246. * Gets the reference input component
  144247. */
  144248. get reference(): NodeMaterialConnectionPoint;
  144249. /**
  144250. * Gets the distance input component
  144251. */
  144252. get distance(): NodeMaterialConnectionPoint;
  144253. /**
  144254. * Gets the replacement input component
  144255. */
  144256. get replacement(): NodeMaterialConnectionPoint;
  144257. /**
  144258. * Gets the output component
  144259. */
  144260. get output(): NodeMaterialConnectionPoint;
  144261. protected _buildBlock(state: NodeMaterialBuildState): this;
  144262. }
  144263. }
  144264. declare module BABYLON {
  144265. /**
  144266. * Block used to posterize a value
  144267. * @see https://en.wikipedia.org/wiki/Posterization
  144268. */
  144269. export class PosterizeBlock extends NodeMaterialBlock {
  144270. /**
  144271. * Creates a new PosterizeBlock
  144272. * @param name defines the block name
  144273. */
  144274. constructor(name: string);
  144275. /**
  144276. * Gets the current class name
  144277. * @returns the class name
  144278. */
  144279. getClassName(): string;
  144280. /**
  144281. * Gets the value input component
  144282. */
  144283. get value(): NodeMaterialConnectionPoint;
  144284. /**
  144285. * Gets the steps input component
  144286. */
  144287. get steps(): NodeMaterialConnectionPoint;
  144288. /**
  144289. * Gets the output component
  144290. */
  144291. get output(): NodeMaterialConnectionPoint;
  144292. protected _buildBlock(state: NodeMaterialBuildState): this;
  144293. }
  144294. }
  144295. declare module BABYLON {
  144296. /**
  144297. * Operations supported by the Wave block
  144298. */
  144299. export enum WaveBlockKind {
  144300. /** SawTooth */
  144301. SawTooth = 0,
  144302. /** Square */
  144303. Square = 1,
  144304. /** Triangle */
  144305. Triangle = 2
  144306. }
  144307. /**
  144308. * Block used to apply wave operation to floats
  144309. */
  144310. export class WaveBlock extends NodeMaterialBlock {
  144311. /**
  144312. * Gets or sets the kibnd of wave to be applied by the block
  144313. */
  144314. kind: WaveBlockKind;
  144315. /**
  144316. * Creates a new WaveBlock
  144317. * @param name defines the block name
  144318. */
  144319. constructor(name: string);
  144320. /**
  144321. * Gets the current class name
  144322. * @returns the class name
  144323. */
  144324. getClassName(): string;
  144325. /**
  144326. * Gets the input component
  144327. */
  144328. get input(): NodeMaterialConnectionPoint;
  144329. /**
  144330. * Gets the output component
  144331. */
  144332. get output(): NodeMaterialConnectionPoint;
  144333. protected _buildBlock(state: NodeMaterialBuildState): this;
  144334. serialize(): any;
  144335. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144336. }
  144337. }
  144338. declare module BABYLON {
  144339. /**
  144340. * Class used to store a color step for the GradientBlock
  144341. */
  144342. export class GradientBlockColorStep {
  144343. private _step;
  144344. /**
  144345. * Gets value indicating which step this color is associated with (between 0 and 1)
  144346. */
  144347. get step(): number;
  144348. /**
  144349. * Sets a value indicating which step this color is associated with (between 0 and 1)
  144350. */
  144351. set step(val: number);
  144352. private _color;
  144353. /**
  144354. * Gets the color associated with this step
  144355. */
  144356. get color(): Color3;
  144357. /**
  144358. * Sets the color associated with this step
  144359. */
  144360. set color(val: Color3);
  144361. /**
  144362. * Creates a new GradientBlockColorStep
  144363. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  144364. * @param color defines the color associated with this step
  144365. */
  144366. constructor(step: number, color: Color3);
  144367. }
  144368. /**
  144369. * Block used to return a color from a gradient based on an input value between 0 and 1
  144370. */
  144371. export class GradientBlock extends NodeMaterialBlock {
  144372. /**
  144373. * Gets or sets the list of color steps
  144374. */
  144375. colorSteps: GradientBlockColorStep[];
  144376. /** Gets an observable raised when the value is changed */
  144377. onValueChangedObservable: Observable<GradientBlock>;
  144378. /** calls observable when the value is changed*/
  144379. colorStepsUpdated(): void;
  144380. /**
  144381. * Creates a new GradientBlock
  144382. * @param name defines the block name
  144383. */
  144384. constructor(name: string);
  144385. /**
  144386. * Gets the current class name
  144387. * @returns the class name
  144388. */
  144389. getClassName(): string;
  144390. /**
  144391. * Gets the gradient input component
  144392. */
  144393. get gradient(): NodeMaterialConnectionPoint;
  144394. /**
  144395. * Gets the output component
  144396. */
  144397. get output(): NodeMaterialConnectionPoint;
  144398. private _writeColorConstant;
  144399. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  144400. serialize(): any;
  144401. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144402. protected _dumpPropertiesCode(): string;
  144403. }
  144404. }
  144405. declare module BABYLON {
  144406. /**
  144407. * Block used to normalize lerp between 2 values
  144408. */
  144409. export class NLerpBlock extends NodeMaterialBlock {
  144410. /**
  144411. * Creates a new NLerpBlock
  144412. * @param name defines the block name
  144413. */
  144414. constructor(name: string);
  144415. /**
  144416. * Gets the current class name
  144417. * @returns the class name
  144418. */
  144419. getClassName(): string;
  144420. /**
  144421. * Gets the left operand input component
  144422. */
  144423. get left(): NodeMaterialConnectionPoint;
  144424. /**
  144425. * Gets the right operand input component
  144426. */
  144427. get right(): NodeMaterialConnectionPoint;
  144428. /**
  144429. * Gets the gradient operand input component
  144430. */
  144431. get gradient(): NodeMaterialConnectionPoint;
  144432. /**
  144433. * Gets the output component
  144434. */
  144435. get output(): NodeMaterialConnectionPoint;
  144436. protected _buildBlock(state: NodeMaterialBuildState): this;
  144437. }
  144438. }
  144439. declare module BABYLON {
  144440. /**
  144441. * block used to Generate a Worley Noise 3D Noise Pattern
  144442. */
  144443. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  144444. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  144445. manhattanDistance: boolean;
  144446. /**
  144447. * Creates a new WorleyNoise3DBlock
  144448. * @param name defines the block name
  144449. */
  144450. constructor(name: string);
  144451. /**
  144452. * Gets the current class name
  144453. * @returns the class name
  144454. */
  144455. getClassName(): string;
  144456. /**
  144457. * Gets the seed input component
  144458. */
  144459. get seed(): NodeMaterialConnectionPoint;
  144460. /**
  144461. * Gets the jitter input component
  144462. */
  144463. get jitter(): NodeMaterialConnectionPoint;
  144464. /**
  144465. * Gets the output component
  144466. */
  144467. get output(): NodeMaterialConnectionPoint;
  144468. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  144469. /**
  144470. * Exposes the properties to the UI?
  144471. */
  144472. protected _dumpPropertiesCode(): string;
  144473. /**
  144474. * Exposes the properties to the Seralize?
  144475. */
  144476. serialize(): any;
  144477. /**
  144478. * Exposes the properties to the deseralize?
  144479. */
  144480. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144481. }
  144482. }
  144483. declare module BABYLON {
  144484. /**
  144485. * block used to Generate a Simplex Perlin 3d Noise Pattern
  144486. */
  144487. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  144488. /**
  144489. * Creates a new SimplexPerlin3DBlock
  144490. * @param name defines the block name
  144491. */
  144492. constructor(name: string);
  144493. /**
  144494. * Gets the current class name
  144495. * @returns the class name
  144496. */
  144497. getClassName(): string;
  144498. /**
  144499. * Gets the seed operand input component
  144500. */
  144501. get seed(): NodeMaterialConnectionPoint;
  144502. /**
  144503. * Gets the output component
  144504. */
  144505. get output(): NodeMaterialConnectionPoint;
  144506. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  144507. }
  144508. }
  144509. declare module BABYLON {
  144510. /**
  144511. * Block used to blend normals
  144512. */
  144513. export class NormalBlendBlock extends NodeMaterialBlock {
  144514. /**
  144515. * Creates a new NormalBlendBlock
  144516. * @param name defines the block name
  144517. */
  144518. constructor(name: string);
  144519. /**
  144520. * Gets the current class name
  144521. * @returns the class name
  144522. */
  144523. getClassName(): string;
  144524. /**
  144525. * Gets the first input component
  144526. */
  144527. get normalMap0(): NodeMaterialConnectionPoint;
  144528. /**
  144529. * Gets the second input component
  144530. */
  144531. get normalMap1(): NodeMaterialConnectionPoint;
  144532. /**
  144533. * Gets the output component
  144534. */
  144535. get output(): NodeMaterialConnectionPoint;
  144536. protected _buildBlock(state: NodeMaterialBuildState): this;
  144537. }
  144538. }
  144539. declare module BABYLON {
  144540. /**
  144541. * Block used to rotate a 2d vector by a given angle
  144542. */
  144543. export class Rotate2dBlock extends NodeMaterialBlock {
  144544. /**
  144545. * Creates a new Rotate2dBlock
  144546. * @param name defines the block name
  144547. */
  144548. constructor(name: string);
  144549. /**
  144550. * Gets the current class name
  144551. * @returns the class name
  144552. */
  144553. getClassName(): string;
  144554. /**
  144555. * Gets the input vector
  144556. */
  144557. get input(): NodeMaterialConnectionPoint;
  144558. /**
  144559. * Gets the input angle
  144560. */
  144561. get angle(): NodeMaterialConnectionPoint;
  144562. /**
  144563. * Gets the output component
  144564. */
  144565. get output(): NodeMaterialConnectionPoint;
  144566. autoConfigure(material: NodeMaterial): void;
  144567. protected _buildBlock(state: NodeMaterialBuildState): this;
  144568. }
  144569. }
  144570. declare module BABYLON {
  144571. /**
  144572. * Block used to get the reflected vector from a direction and a normal
  144573. */
  144574. export class ReflectBlock extends NodeMaterialBlock {
  144575. /**
  144576. * Creates a new ReflectBlock
  144577. * @param name defines the block name
  144578. */
  144579. constructor(name: string);
  144580. /**
  144581. * Gets the current class name
  144582. * @returns the class name
  144583. */
  144584. getClassName(): string;
  144585. /**
  144586. * Gets the incident component
  144587. */
  144588. get incident(): NodeMaterialConnectionPoint;
  144589. /**
  144590. * Gets the normal component
  144591. */
  144592. get normal(): NodeMaterialConnectionPoint;
  144593. /**
  144594. * Gets the output component
  144595. */
  144596. get output(): NodeMaterialConnectionPoint;
  144597. protected _buildBlock(state: NodeMaterialBuildState): this;
  144598. }
  144599. }
  144600. declare module BABYLON {
  144601. /**
  144602. * Block used to get the refracted vector from a direction and a normal
  144603. */
  144604. export class RefractBlock extends NodeMaterialBlock {
  144605. /**
  144606. * Creates a new RefractBlock
  144607. * @param name defines the block name
  144608. */
  144609. constructor(name: string);
  144610. /**
  144611. * Gets the current class name
  144612. * @returns the class name
  144613. */
  144614. getClassName(): string;
  144615. /**
  144616. * Gets the incident component
  144617. */
  144618. get incident(): NodeMaterialConnectionPoint;
  144619. /**
  144620. * Gets the normal component
  144621. */
  144622. get normal(): NodeMaterialConnectionPoint;
  144623. /**
  144624. * Gets the index of refraction component
  144625. */
  144626. get ior(): NodeMaterialConnectionPoint;
  144627. /**
  144628. * Gets the output component
  144629. */
  144630. get output(): NodeMaterialConnectionPoint;
  144631. protected _buildBlock(state: NodeMaterialBuildState): this;
  144632. }
  144633. }
  144634. declare module BABYLON {
  144635. /**
  144636. * Block used to desaturate a color
  144637. */
  144638. export class DesaturateBlock extends NodeMaterialBlock {
  144639. /**
  144640. * Creates a new DesaturateBlock
  144641. * @param name defines the block name
  144642. */
  144643. constructor(name: string);
  144644. /**
  144645. * Gets the current class name
  144646. * @returns the class name
  144647. */
  144648. getClassName(): string;
  144649. /**
  144650. * Gets the color operand input component
  144651. */
  144652. get color(): NodeMaterialConnectionPoint;
  144653. /**
  144654. * Gets the level operand input component
  144655. */
  144656. get level(): NodeMaterialConnectionPoint;
  144657. /**
  144658. * Gets the output component
  144659. */
  144660. get output(): NodeMaterialConnectionPoint;
  144661. protected _buildBlock(state: NodeMaterialBuildState): this;
  144662. }
  144663. }
  144664. declare module BABYLON {
  144665. /**
  144666. * Block used to implement the ambient occlusion module of the PBR material
  144667. */
  144668. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  144669. /**
  144670. * Create a new AmbientOcclusionBlock
  144671. * @param name defines the block name
  144672. */
  144673. constructor(name: string);
  144674. /**
  144675. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  144676. */
  144677. useAmbientInGrayScale: boolean;
  144678. /**
  144679. * Initialize the block and prepare the context for build
  144680. * @param state defines the state that will be used for the build
  144681. */
  144682. initialize(state: NodeMaterialBuildState): void;
  144683. /**
  144684. * Gets the current class name
  144685. * @returns the class name
  144686. */
  144687. getClassName(): string;
  144688. /**
  144689. * Gets the texture input component
  144690. */
  144691. get texture(): NodeMaterialConnectionPoint;
  144692. /**
  144693. * Gets the texture intensity component
  144694. */
  144695. get intensity(): NodeMaterialConnectionPoint;
  144696. /**
  144697. * Gets the direct light intensity input component
  144698. */
  144699. get directLightIntensity(): NodeMaterialConnectionPoint;
  144700. /**
  144701. * Gets the ambient occlusion object output component
  144702. */
  144703. get ambientOcclusion(): NodeMaterialConnectionPoint;
  144704. /**
  144705. * Gets the main code of the block (fragment side)
  144706. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  144707. * @returns the shader code
  144708. */
  144709. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  144710. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144711. protected _buildBlock(state: NodeMaterialBuildState): this;
  144712. protected _dumpPropertiesCode(): string;
  144713. serialize(): any;
  144714. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144715. }
  144716. }
  144717. declare module BABYLON {
  144718. /**
  144719. * Block used to implement the reflection module of the PBR material
  144720. */
  144721. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  144722. /** @hidden */
  144723. _defineLODReflectionAlpha: string;
  144724. /** @hidden */
  144725. _defineLinearSpecularReflection: string;
  144726. private _vEnvironmentIrradianceName;
  144727. /** @hidden */
  144728. _vReflectionMicrosurfaceInfosName: string;
  144729. /** @hidden */
  144730. _vReflectionInfosName: string;
  144731. /** @hidden */
  144732. _vReflectionFilteringInfoName: string;
  144733. private _scene;
  144734. /**
  144735. * The three properties below are set by the main PBR block prior to calling methods of this class.
  144736. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  144737. * It's less burden on the user side in the editor part.
  144738. */
  144739. /** @hidden */
  144740. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  144741. /** @hidden */
  144742. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  144743. /** @hidden */
  144744. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  144745. /**
  144746. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  144747. * diffuse part of the IBL.
  144748. */
  144749. useSphericalHarmonics: boolean;
  144750. /**
  144751. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  144752. */
  144753. forceIrradianceInFragment: boolean;
  144754. /**
  144755. * Create a new ReflectionBlock
  144756. * @param name defines the block name
  144757. */
  144758. constructor(name: string);
  144759. /**
  144760. * Gets the current class name
  144761. * @returns the class name
  144762. */
  144763. getClassName(): string;
  144764. /**
  144765. * Gets the position input component
  144766. */
  144767. get position(): NodeMaterialConnectionPoint;
  144768. /**
  144769. * Gets the world position input component
  144770. */
  144771. get worldPosition(): NodeMaterialConnectionPoint;
  144772. /**
  144773. * Gets the world normal input component
  144774. */
  144775. get worldNormal(): NodeMaterialConnectionPoint;
  144776. /**
  144777. * Gets the world input component
  144778. */
  144779. get world(): NodeMaterialConnectionPoint;
  144780. /**
  144781. * Gets the camera (or eye) position component
  144782. */
  144783. get cameraPosition(): NodeMaterialConnectionPoint;
  144784. /**
  144785. * Gets the view input component
  144786. */
  144787. get view(): NodeMaterialConnectionPoint;
  144788. /**
  144789. * Gets the color input component
  144790. */
  144791. get color(): NodeMaterialConnectionPoint;
  144792. /**
  144793. * Gets the reflection object output component
  144794. */
  144795. get reflection(): NodeMaterialConnectionPoint;
  144796. /**
  144797. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  144798. */
  144799. get hasTexture(): boolean;
  144800. /**
  144801. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  144802. */
  144803. get reflectionColor(): string;
  144804. protected _getTexture(): Nullable<BaseTexture>;
  144805. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144806. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  144807. /**
  144808. * Gets the code to inject in the vertex shader
  144809. * @param state current state of the node material building
  144810. * @returns the shader code
  144811. */
  144812. handleVertexSide(state: NodeMaterialBuildState): string;
  144813. /**
  144814. * Gets the main code of the block (fragment side)
  144815. * @param state current state of the node material building
  144816. * @param normalVarName name of the existing variable corresponding to the normal
  144817. * @returns the shader code
  144818. */
  144819. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  144820. protected _buildBlock(state: NodeMaterialBuildState): this;
  144821. protected _dumpPropertiesCode(): string;
  144822. serialize(): any;
  144823. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144824. }
  144825. }
  144826. declare module BABYLON {
  144827. /**
  144828. * Block used to implement the sheen module of the PBR material
  144829. */
  144830. export class SheenBlock extends NodeMaterialBlock {
  144831. /**
  144832. * Create a new SheenBlock
  144833. * @param name defines the block name
  144834. */
  144835. constructor(name: string);
  144836. /**
  144837. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  144838. * It allows the strength of the sheen effect to not depend on the base color of the material,
  144839. * making it easier to setup and tweak the effect
  144840. */
  144841. albedoScaling: boolean;
  144842. /**
  144843. * Defines if the sheen is linked to the sheen color.
  144844. */
  144845. linkSheenWithAlbedo: boolean;
  144846. /**
  144847. * Initialize the block and prepare the context for build
  144848. * @param state defines the state that will be used for the build
  144849. */
  144850. initialize(state: NodeMaterialBuildState): void;
  144851. /**
  144852. * Gets the current class name
  144853. * @returns the class name
  144854. */
  144855. getClassName(): string;
  144856. /**
  144857. * Gets the intensity input component
  144858. */
  144859. get intensity(): NodeMaterialConnectionPoint;
  144860. /**
  144861. * Gets the color input component
  144862. */
  144863. get color(): NodeMaterialConnectionPoint;
  144864. /**
  144865. * Gets the roughness input component
  144866. */
  144867. get roughness(): NodeMaterialConnectionPoint;
  144868. /**
  144869. * Gets the sheen object output component
  144870. */
  144871. get sheen(): NodeMaterialConnectionPoint;
  144872. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144873. /**
  144874. * Gets the main code of the block (fragment side)
  144875. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  144876. * @returns the shader code
  144877. */
  144878. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  144879. protected _buildBlock(state: NodeMaterialBuildState): this;
  144880. protected _dumpPropertiesCode(): string;
  144881. serialize(): any;
  144882. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144883. }
  144884. }
  144885. declare module BABYLON {
  144886. /**
  144887. * Block used to implement the reflectivity module of the PBR material
  144888. */
  144889. export class ReflectivityBlock extends NodeMaterialBlock {
  144890. private _metallicReflectanceColor;
  144891. private _metallicF0Factor;
  144892. /** @hidden */
  144893. _vMetallicReflectanceFactorsName: string;
  144894. /**
  144895. * The property below is set by the main PBR block prior to calling methods of this class.
  144896. */
  144897. /** @hidden */
  144898. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  144899. /**
  144900. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  144901. */
  144902. useAmbientOcclusionFromMetallicTextureRed: boolean;
  144903. /**
  144904. * Specifies if the metallic texture contains the metallness information in its blue channel.
  144905. */
  144906. useMetallnessFromMetallicTextureBlue: boolean;
  144907. /**
  144908. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  144909. */
  144910. useRoughnessFromMetallicTextureAlpha: boolean;
  144911. /**
  144912. * Specifies if the metallic texture contains the roughness information in its green channel.
  144913. */
  144914. useRoughnessFromMetallicTextureGreen: boolean;
  144915. /**
  144916. * Create a new ReflectivityBlock
  144917. * @param name defines the block name
  144918. */
  144919. constructor(name: string);
  144920. /**
  144921. * Initialize the block and prepare the context for build
  144922. * @param state defines the state that will be used for the build
  144923. */
  144924. initialize(state: NodeMaterialBuildState): void;
  144925. /**
  144926. * Gets the current class name
  144927. * @returns the class name
  144928. */
  144929. getClassName(): string;
  144930. /**
  144931. * Gets the metallic input component
  144932. */
  144933. get metallic(): NodeMaterialConnectionPoint;
  144934. /**
  144935. * Gets the roughness input component
  144936. */
  144937. get roughness(): NodeMaterialConnectionPoint;
  144938. /**
  144939. * Gets the texture input component
  144940. */
  144941. get texture(): NodeMaterialConnectionPoint;
  144942. /**
  144943. * Gets the reflectivity object output component
  144944. */
  144945. get reflectivity(): NodeMaterialConnectionPoint;
  144946. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  144947. /**
  144948. * Gets the main code of the block (fragment side)
  144949. * @param state current state of the node material building
  144950. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  144951. * @returns the shader code
  144952. */
  144953. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  144954. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144955. protected _buildBlock(state: NodeMaterialBuildState): this;
  144956. protected _dumpPropertiesCode(): string;
  144957. serialize(): any;
  144958. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144959. }
  144960. }
  144961. declare module BABYLON {
  144962. /**
  144963. * Block used to implement the anisotropy module of the PBR material
  144964. */
  144965. export class AnisotropyBlock extends NodeMaterialBlock {
  144966. /**
  144967. * The two properties below are set by the main PBR block prior to calling methods of this class.
  144968. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  144969. * It's less burden on the user side in the editor part.
  144970. */
  144971. /** @hidden */
  144972. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  144973. /** @hidden */
  144974. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  144975. /**
  144976. * Create a new AnisotropyBlock
  144977. * @param name defines the block name
  144978. */
  144979. constructor(name: string);
  144980. /**
  144981. * Initialize the block and prepare the context for build
  144982. * @param state defines the state that will be used for the build
  144983. */
  144984. initialize(state: NodeMaterialBuildState): void;
  144985. /**
  144986. * Gets the current class name
  144987. * @returns the class name
  144988. */
  144989. getClassName(): string;
  144990. /**
  144991. * Gets the intensity input component
  144992. */
  144993. get intensity(): NodeMaterialConnectionPoint;
  144994. /**
  144995. * Gets the direction input component
  144996. */
  144997. get direction(): NodeMaterialConnectionPoint;
  144998. /**
  144999. * Gets the texture input component
  145000. */
  145001. get texture(): NodeMaterialConnectionPoint;
  145002. /**
  145003. * Gets the uv input component
  145004. */
  145005. get uv(): NodeMaterialConnectionPoint;
  145006. /**
  145007. * Gets the worldTangent input component
  145008. */
  145009. get worldTangent(): NodeMaterialConnectionPoint;
  145010. /**
  145011. * Gets the anisotropy object output component
  145012. */
  145013. get anisotropy(): NodeMaterialConnectionPoint;
  145014. private _generateTBNSpace;
  145015. /**
  145016. * Gets the main code of the block (fragment side)
  145017. * @param state current state of the node material building
  145018. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  145019. * @returns the shader code
  145020. */
  145021. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  145022. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  145023. protected _buildBlock(state: NodeMaterialBuildState): this;
  145024. }
  145025. }
  145026. declare module BABYLON {
  145027. /**
  145028. * Block used to implement the clear coat module of the PBR material
  145029. */
  145030. export class ClearCoatBlock extends NodeMaterialBlock {
  145031. private _scene;
  145032. /**
  145033. * Create a new ClearCoatBlock
  145034. * @param name defines the block name
  145035. */
  145036. constructor(name: string);
  145037. /**
  145038. * Initialize the block and prepare the context for build
  145039. * @param state defines the state that will be used for the build
  145040. */
  145041. initialize(state: NodeMaterialBuildState): void;
  145042. /**
  145043. * Gets the current class name
  145044. * @returns the class name
  145045. */
  145046. getClassName(): string;
  145047. /**
  145048. * Gets the intensity input component
  145049. */
  145050. get intensity(): NodeMaterialConnectionPoint;
  145051. /**
  145052. * Gets the roughness input component
  145053. */
  145054. get roughness(): NodeMaterialConnectionPoint;
  145055. /**
  145056. * Gets the ior input component
  145057. */
  145058. get ior(): NodeMaterialConnectionPoint;
  145059. /**
  145060. * Gets the texture input component
  145061. */
  145062. get texture(): NodeMaterialConnectionPoint;
  145063. /**
  145064. * Gets the bump texture input component
  145065. */
  145066. get bumpTexture(): NodeMaterialConnectionPoint;
  145067. /**
  145068. * Gets the uv input component
  145069. */
  145070. get uv(): NodeMaterialConnectionPoint;
  145071. /**
  145072. * Gets the tint color input component
  145073. */
  145074. get tintColor(): NodeMaterialConnectionPoint;
  145075. /**
  145076. * Gets the tint "at distance" input component
  145077. */
  145078. get tintAtDistance(): NodeMaterialConnectionPoint;
  145079. /**
  145080. * Gets the tint thickness input component
  145081. */
  145082. get tintThickness(): NodeMaterialConnectionPoint;
  145083. /**
  145084. * Gets the world tangent input component
  145085. */
  145086. get worldTangent(): NodeMaterialConnectionPoint;
  145087. /**
  145088. * Gets the clear coat object output component
  145089. */
  145090. get clearcoat(): NodeMaterialConnectionPoint;
  145091. autoConfigure(material: NodeMaterial): void;
  145092. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  145093. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  145094. private _generateTBNSpace;
  145095. /**
  145096. * Gets the main code of the block (fragment side)
  145097. * @param state current state of the node material building
  145098. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  145099. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  145100. * @param worldPosVarName name of the variable holding the world position
  145101. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  145102. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  145103. * @param worldNormalVarName name of the variable holding the world normal
  145104. * @returns the shader code
  145105. */
  145106. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  145107. protected _buildBlock(state: NodeMaterialBuildState): this;
  145108. }
  145109. }
  145110. declare module BABYLON {
  145111. /**
  145112. * Block used to implement the sub surface module of the PBR material
  145113. */
  145114. export class SubSurfaceBlock extends NodeMaterialBlock {
  145115. /**
  145116. * Create a new SubSurfaceBlock
  145117. * @param name defines the block name
  145118. */
  145119. constructor(name: string);
  145120. /**
  145121. * Stores the intensity of the different subsurface effects in the thickness texture.
  145122. * * the green channel is the translucency intensity.
  145123. * * the blue channel is the scattering intensity.
  145124. * * the alpha channel is the refraction intensity.
  145125. */
  145126. useMaskFromThicknessTexture: boolean;
  145127. /**
  145128. * Initialize the block and prepare the context for build
  145129. * @param state defines the state that will be used for the build
  145130. */
  145131. initialize(state: NodeMaterialBuildState): void;
  145132. /**
  145133. * Gets the current class name
  145134. * @returns the class name
  145135. */
  145136. getClassName(): string;
  145137. /**
  145138. * Gets the min thickness input component
  145139. */
  145140. get minThickness(): NodeMaterialConnectionPoint;
  145141. /**
  145142. * Gets the max thickness input component
  145143. */
  145144. get maxThickness(): NodeMaterialConnectionPoint;
  145145. /**
  145146. * Gets the thickness texture component
  145147. */
  145148. get thicknessTexture(): NodeMaterialConnectionPoint;
  145149. /**
  145150. * Gets the tint color input component
  145151. */
  145152. get tintColor(): NodeMaterialConnectionPoint;
  145153. /**
  145154. * Gets the translucency intensity input component
  145155. */
  145156. get translucencyIntensity(): NodeMaterialConnectionPoint;
  145157. /**
  145158. * Gets the translucency diffusion distance input component
  145159. */
  145160. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  145161. /**
  145162. * Gets the refraction object parameters
  145163. */
  145164. get refraction(): NodeMaterialConnectionPoint;
  145165. /**
  145166. * Gets the sub surface object output component
  145167. */
  145168. get subsurface(): NodeMaterialConnectionPoint;
  145169. autoConfigure(material: NodeMaterial): void;
  145170. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  145171. /**
  145172. * Gets the main code of the block (fragment side)
  145173. * @param state current state of the node material building
  145174. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  145175. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  145176. * @param worldPosVarName name of the variable holding the world position
  145177. * @returns the shader code
  145178. */
  145179. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  145180. protected _buildBlock(state: NodeMaterialBuildState): this;
  145181. }
  145182. }
  145183. declare module BABYLON {
  145184. /**
  145185. * Block used to implement the PBR metallic/roughness model
  145186. */
  145187. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  145188. /**
  145189. * Gets or sets the light associated with this block
  145190. */
  145191. light: Nullable<Light>;
  145192. private _lightId;
  145193. private _scene;
  145194. private _environmentBRDFTexture;
  145195. private _environmentBrdfSamplerName;
  145196. private _vNormalWName;
  145197. private _invertNormalName;
  145198. /**
  145199. * Create a new ReflectionBlock
  145200. * @param name defines the block name
  145201. */
  145202. constructor(name: string);
  145203. /**
  145204. * Intensity of the direct lights e.g. the four lights available in your scene.
  145205. * This impacts both the direct diffuse and specular highlights.
  145206. */
  145207. directIntensity: number;
  145208. /**
  145209. * Intensity of the environment e.g. how much the environment will light the object
  145210. * either through harmonics for rough material or through the refelction for shiny ones.
  145211. */
  145212. environmentIntensity: number;
  145213. /**
  145214. * This is a special control allowing the reduction of the specular highlights coming from the
  145215. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  145216. */
  145217. specularIntensity: number;
  145218. /**
  145219. * Defines the falloff type used in this material.
  145220. * It by default is Physical.
  145221. */
  145222. lightFalloff: number;
  145223. /**
  145224. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  145225. */
  145226. useAlphaFromAlbedoTexture: boolean;
  145227. /**
  145228. * Specifies that alpha test should be used
  145229. */
  145230. useAlphaTest: boolean;
  145231. /**
  145232. * Defines the alpha limits in alpha test mode.
  145233. */
  145234. alphaTestCutoff: number;
  145235. /**
  145236. * Specifies that alpha blending should be used
  145237. */
  145238. useAlphaBlending: boolean;
  145239. /**
  145240. * Defines if the alpha value should be determined via the rgb values.
  145241. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  145242. */
  145243. opacityRGB: boolean;
  145244. /**
  145245. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  145246. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  145247. */
  145248. useRadianceOverAlpha: boolean;
  145249. /**
  145250. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  145251. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  145252. */
  145253. useSpecularOverAlpha: boolean;
  145254. /**
  145255. * Enables specular anti aliasing in the PBR shader.
  145256. * It will both interacts on the Geometry for analytical and IBL lighting.
  145257. * It also prefilter the roughness map based on the bump values.
  145258. */
  145259. enableSpecularAntiAliasing: boolean;
  145260. /**
  145261. * Enables realtime filtering on the texture.
  145262. */
  145263. realTimeFiltering: boolean;
  145264. /**
  145265. * Quality switch for realtime filtering
  145266. */
  145267. realTimeFilteringQuality: number;
  145268. /**
  145269. * Defines if the material uses energy conservation.
  145270. */
  145271. useEnergyConservation: boolean;
  145272. /**
  145273. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  145274. * too much the area relying on ambient texture to define their ambient occlusion.
  145275. */
  145276. useRadianceOcclusion: boolean;
  145277. /**
  145278. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  145279. * makes the reflect vector face the model (under horizon).
  145280. */
  145281. useHorizonOcclusion: boolean;
  145282. /**
  145283. * If set to true, no lighting calculations will be applied.
  145284. */
  145285. unlit: boolean;
  145286. /**
  145287. * Force normal to face away from face.
  145288. */
  145289. forceNormalForward: boolean;
  145290. /**
  145291. * Defines the material debug mode.
  145292. * It helps seeing only some components of the material while troubleshooting.
  145293. */
  145294. debugMode: number;
  145295. /**
  145296. * Specify from where on screen the debug mode should start.
  145297. * The value goes from -1 (full screen) to 1 (not visible)
  145298. * It helps with side by side comparison against the final render
  145299. * This defaults to 0
  145300. */
  145301. debugLimit: number;
  145302. /**
  145303. * As the default viewing range might not be enough (if the ambient is really small for instance)
  145304. * You can use the factor to better multiply the final value.
  145305. */
  145306. debugFactor: number;
  145307. /**
  145308. * Initialize the block and prepare the context for build
  145309. * @param state defines the state that will be used for the build
  145310. */
  145311. initialize(state: NodeMaterialBuildState): void;
  145312. /**
  145313. * Gets the current class name
  145314. * @returns the class name
  145315. */
  145316. getClassName(): string;
  145317. /**
  145318. * Gets the world position input component
  145319. */
  145320. get worldPosition(): NodeMaterialConnectionPoint;
  145321. /**
  145322. * Gets the world normal input component
  145323. */
  145324. get worldNormal(): NodeMaterialConnectionPoint;
  145325. /**
  145326. * Gets the perturbed normal input component
  145327. */
  145328. get perturbedNormal(): NodeMaterialConnectionPoint;
  145329. /**
  145330. * Gets the camera position input component
  145331. */
  145332. get cameraPosition(): NodeMaterialConnectionPoint;
  145333. /**
  145334. * Gets the base color input component
  145335. */
  145336. get baseColor(): NodeMaterialConnectionPoint;
  145337. /**
  145338. * Gets the opacity texture input component
  145339. */
  145340. get opacityTexture(): NodeMaterialConnectionPoint;
  145341. /**
  145342. * Gets the ambient color input component
  145343. */
  145344. get ambientColor(): NodeMaterialConnectionPoint;
  145345. /**
  145346. * Gets the reflectivity object parameters
  145347. */
  145348. get reflectivity(): NodeMaterialConnectionPoint;
  145349. /**
  145350. * Gets the ambient occlusion object parameters
  145351. */
  145352. get ambientOcclusion(): NodeMaterialConnectionPoint;
  145353. /**
  145354. * Gets the reflection object parameters
  145355. */
  145356. get reflection(): NodeMaterialConnectionPoint;
  145357. /**
  145358. * Gets the sheen object parameters
  145359. */
  145360. get sheen(): NodeMaterialConnectionPoint;
  145361. /**
  145362. * Gets the clear coat object parameters
  145363. */
  145364. get clearcoat(): NodeMaterialConnectionPoint;
  145365. /**
  145366. * Gets the sub surface object parameters
  145367. */
  145368. get subsurface(): NodeMaterialConnectionPoint;
  145369. /**
  145370. * Gets the anisotropy object parameters
  145371. */
  145372. get anisotropy(): NodeMaterialConnectionPoint;
  145373. /**
  145374. * Gets the ambient output component
  145375. */
  145376. get ambient(): NodeMaterialConnectionPoint;
  145377. /**
  145378. * Gets the diffuse output component
  145379. */
  145380. get diffuse(): NodeMaterialConnectionPoint;
  145381. /**
  145382. * Gets the specular output component
  145383. */
  145384. get specular(): NodeMaterialConnectionPoint;
  145385. /**
  145386. * Gets the sheen output component
  145387. */
  145388. get sheenDir(): NodeMaterialConnectionPoint;
  145389. /**
  145390. * Gets the clear coat output component
  145391. */
  145392. get clearcoatDir(): NodeMaterialConnectionPoint;
  145393. /**
  145394. * Gets the indirect diffuse output component
  145395. */
  145396. get diffuseIndirect(): NodeMaterialConnectionPoint;
  145397. /**
  145398. * Gets the indirect specular output component
  145399. */
  145400. get specularIndirect(): NodeMaterialConnectionPoint;
  145401. /**
  145402. * Gets the indirect sheen output component
  145403. */
  145404. get sheenIndirect(): NodeMaterialConnectionPoint;
  145405. /**
  145406. * Gets the indirect clear coat output component
  145407. */
  145408. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  145409. /**
  145410. * Gets the refraction output component
  145411. */
  145412. get refraction(): NodeMaterialConnectionPoint;
  145413. /**
  145414. * Gets the global lighting output component
  145415. */
  145416. get lighting(): NodeMaterialConnectionPoint;
  145417. /**
  145418. * Gets the shadow output component
  145419. */
  145420. get shadow(): NodeMaterialConnectionPoint;
  145421. /**
  145422. * Gets the alpha output component
  145423. */
  145424. get alpha(): NodeMaterialConnectionPoint;
  145425. autoConfigure(material: NodeMaterial): void;
  145426. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  145427. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  145428. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  145429. private _injectVertexCode;
  145430. /**
  145431. * Gets the code corresponding to the albedo/opacity module
  145432. * @returns the shader code
  145433. */
  145434. getAlbedoOpacityCode(): string;
  145435. protected _buildBlock(state: NodeMaterialBuildState): this;
  145436. protected _dumpPropertiesCode(): string;
  145437. serialize(): any;
  145438. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  145439. }
  145440. }
  145441. declare module BABYLON {
  145442. /**
  145443. * Block used to compute value of one parameter modulo another
  145444. */
  145445. export class ModBlock extends NodeMaterialBlock {
  145446. /**
  145447. * Creates a new ModBlock
  145448. * @param name defines the block name
  145449. */
  145450. constructor(name: string);
  145451. /**
  145452. * Gets the current class name
  145453. * @returns the class name
  145454. */
  145455. getClassName(): string;
  145456. /**
  145457. * Gets the left operand input component
  145458. */
  145459. get left(): NodeMaterialConnectionPoint;
  145460. /**
  145461. * Gets the right operand input component
  145462. */
  145463. get right(): NodeMaterialConnectionPoint;
  145464. /**
  145465. * Gets the output component
  145466. */
  145467. get output(): NodeMaterialConnectionPoint;
  145468. protected _buildBlock(state: NodeMaterialBuildState): this;
  145469. }
  145470. }
  145471. declare module BABYLON {
  145472. /**
  145473. * Configuration for Draco compression
  145474. */
  145475. export interface IDracoCompressionConfiguration {
  145476. /**
  145477. * Configuration for the decoder.
  145478. */
  145479. decoder: {
  145480. /**
  145481. * The url to the WebAssembly module.
  145482. */
  145483. wasmUrl?: string;
  145484. /**
  145485. * The url to the WebAssembly binary.
  145486. */
  145487. wasmBinaryUrl?: string;
  145488. /**
  145489. * The url to the fallback JavaScript module.
  145490. */
  145491. fallbackUrl?: string;
  145492. };
  145493. }
  145494. /**
  145495. * Draco compression (https://google.github.io/draco/)
  145496. *
  145497. * This class wraps the Draco module.
  145498. *
  145499. * **Encoder**
  145500. *
  145501. * The encoder is not currently implemented.
  145502. *
  145503. * **Decoder**
  145504. *
  145505. * 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.
  145506. *
  145507. * To update the configuration, use the following code:
  145508. * ```javascript
  145509. * DracoCompression.Configuration = {
  145510. * decoder: {
  145511. * wasmUrl: "<url to the WebAssembly library>",
  145512. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  145513. * fallbackUrl: "<url to the fallback JavaScript library>",
  145514. * }
  145515. * };
  145516. * ```
  145517. *
  145518. * 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.
  145519. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  145520. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  145521. *
  145522. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  145523. * ```javascript
  145524. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  145525. * ```
  145526. *
  145527. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  145528. */
  145529. export class DracoCompression implements IDisposable {
  145530. private _workerPoolPromise?;
  145531. private _decoderModulePromise?;
  145532. /**
  145533. * The configuration. Defaults to the following urls:
  145534. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  145535. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  145536. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  145537. */
  145538. static Configuration: IDracoCompressionConfiguration;
  145539. /**
  145540. * Returns true if the decoder configuration is available.
  145541. */
  145542. static get DecoderAvailable(): boolean;
  145543. /**
  145544. * Default number of workers to create when creating the draco compression object.
  145545. */
  145546. static DefaultNumWorkers: number;
  145547. private static GetDefaultNumWorkers;
  145548. private static _Default;
  145549. /**
  145550. * Default instance for the draco compression object.
  145551. */
  145552. static get Default(): DracoCompression;
  145553. /**
  145554. * Constructor
  145555. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  145556. */
  145557. constructor(numWorkers?: number);
  145558. /**
  145559. * Stop all async operations and release resources.
  145560. */
  145561. dispose(): void;
  145562. /**
  145563. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  145564. * @returns a promise that resolves when ready
  145565. */
  145566. whenReadyAsync(): Promise<void>;
  145567. /**
  145568. * Decode Draco compressed mesh data to vertex data.
  145569. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  145570. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  145571. * @returns A promise that resolves with the decoded vertex data
  145572. */
  145573. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  145574. [kind: string]: number;
  145575. }): Promise<VertexData>;
  145576. }
  145577. }
  145578. declare module BABYLON {
  145579. /**
  145580. * Class for building Constructive Solid Geometry
  145581. */
  145582. export class CSG {
  145583. private polygons;
  145584. /**
  145585. * The world matrix
  145586. */
  145587. matrix: Matrix;
  145588. /**
  145589. * Stores the position
  145590. */
  145591. position: Vector3;
  145592. /**
  145593. * Stores the rotation
  145594. */
  145595. rotation: Vector3;
  145596. /**
  145597. * Stores the rotation quaternion
  145598. */
  145599. rotationQuaternion: Nullable<Quaternion>;
  145600. /**
  145601. * Stores the scaling vector
  145602. */
  145603. scaling: Vector3;
  145604. /**
  145605. * Convert the Mesh to CSG
  145606. * @param mesh The Mesh to convert to CSG
  145607. * @returns A new CSG from the Mesh
  145608. */
  145609. static FromMesh(mesh: Mesh): CSG;
  145610. /**
  145611. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  145612. * @param polygons Polygons used to construct a CSG solid
  145613. */
  145614. private static FromPolygons;
  145615. /**
  145616. * Clones, or makes a deep copy, of the CSG
  145617. * @returns A new CSG
  145618. */
  145619. clone(): CSG;
  145620. /**
  145621. * Unions this CSG with another CSG
  145622. * @param csg The CSG to union against this CSG
  145623. * @returns The unioned CSG
  145624. */
  145625. union(csg: CSG): CSG;
  145626. /**
  145627. * Unions this CSG with another CSG in place
  145628. * @param csg The CSG to union against this CSG
  145629. */
  145630. unionInPlace(csg: CSG): void;
  145631. /**
  145632. * Subtracts this CSG with another CSG
  145633. * @param csg The CSG to subtract against this CSG
  145634. * @returns A new CSG
  145635. */
  145636. subtract(csg: CSG): CSG;
  145637. /**
  145638. * Subtracts this CSG with another CSG in place
  145639. * @param csg The CSG to subtact against this CSG
  145640. */
  145641. subtractInPlace(csg: CSG): void;
  145642. /**
  145643. * Intersect this CSG with another CSG
  145644. * @param csg The CSG to intersect against this CSG
  145645. * @returns A new CSG
  145646. */
  145647. intersect(csg: CSG): CSG;
  145648. /**
  145649. * Intersects this CSG with another CSG in place
  145650. * @param csg The CSG to intersect against this CSG
  145651. */
  145652. intersectInPlace(csg: CSG): void;
  145653. /**
  145654. * Return a new CSG solid with solid and empty space switched. This solid is
  145655. * not modified.
  145656. * @returns A new CSG solid with solid and empty space switched
  145657. */
  145658. inverse(): CSG;
  145659. /**
  145660. * Inverses the CSG in place
  145661. */
  145662. inverseInPlace(): void;
  145663. /**
  145664. * This is used to keep meshes transformations so they can be restored
  145665. * when we build back a Babylon Mesh
  145666. * NB : All CSG operations are performed in world coordinates
  145667. * @param csg The CSG to copy the transform attributes from
  145668. * @returns This CSG
  145669. */
  145670. copyTransformAttributes(csg: CSG): CSG;
  145671. /**
  145672. * Build Raw mesh from CSG
  145673. * Coordinates here are in world space
  145674. * @param name The name of the mesh geometry
  145675. * @param scene The Scene
  145676. * @param keepSubMeshes Specifies if the submeshes should be kept
  145677. * @returns A new Mesh
  145678. */
  145679. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  145680. /**
  145681. * Build Mesh from CSG taking material and transforms into account
  145682. * @param name The name of the Mesh
  145683. * @param material The material of the Mesh
  145684. * @param scene The Scene
  145685. * @param keepSubMeshes Specifies if submeshes should be kept
  145686. * @returns The new Mesh
  145687. */
  145688. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  145689. }
  145690. }
  145691. declare module BABYLON {
  145692. /**
  145693. * Class used to create a trail following a mesh
  145694. */
  145695. export class TrailMesh extends Mesh {
  145696. private _generator;
  145697. private _autoStart;
  145698. private _running;
  145699. private _diameter;
  145700. private _length;
  145701. private _sectionPolygonPointsCount;
  145702. private _sectionVectors;
  145703. private _sectionNormalVectors;
  145704. private _beforeRenderObserver;
  145705. /**
  145706. * @constructor
  145707. * @param name The value used by scene.getMeshByName() to do a lookup.
  145708. * @param generator The mesh or transform node to generate a trail.
  145709. * @param scene The scene to add this mesh to.
  145710. * @param diameter Diameter of trailing mesh. Default is 1.
  145711. * @param length Length of trailing mesh. Default is 60.
  145712. * @param autoStart Automatically start trailing mesh. Default true.
  145713. */
  145714. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  145715. /**
  145716. * "TrailMesh"
  145717. * @returns "TrailMesh"
  145718. */
  145719. getClassName(): string;
  145720. private _createMesh;
  145721. /**
  145722. * Start trailing mesh.
  145723. */
  145724. start(): void;
  145725. /**
  145726. * Stop trailing mesh.
  145727. */
  145728. stop(): void;
  145729. /**
  145730. * Update trailing mesh geometry.
  145731. */
  145732. update(): void;
  145733. /**
  145734. * Returns a new TrailMesh object.
  145735. * @param name is a string, the name given to the new mesh
  145736. * @param newGenerator use new generator object for cloned trail mesh
  145737. * @returns a new mesh
  145738. */
  145739. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  145740. /**
  145741. * Serializes this trail mesh
  145742. * @param serializationObject object to write serialization to
  145743. */
  145744. serialize(serializationObject: any): void;
  145745. /**
  145746. * Parses a serialized trail mesh
  145747. * @param parsedMesh the serialized mesh
  145748. * @param scene the scene to create the trail mesh in
  145749. * @returns the created trail mesh
  145750. */
  145751. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  145752. }
  145753. }
  145754. declare module BABYLON {
  145755. /**
  145756. * Class containing static functions to help procedurally build meshes
  145757. */
  145758. export class TiledBoxBuilder {
  145759. /**
  145760. * Creates a box mesh
  145761. * 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)
  145762. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145763. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145764. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145765. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145766. * @param name defines the name of the mesh
  145767. * @param options defines the options used to create the mesh
  145768. * @param scene defines the hosting scene
  145769. * @returns the box mesh
  145770. */
  145771. static CreateTiledBox(name: string, options: {
  145772. pattern?: number;
  145773. width?: number;
  145774. height?: number;
  145775. depth?: number;
  145776. tileSize?: number;
  145777. tileWidth?: number;
  145778. tileHeight?: number;
  145779. alignHorizontal?: number;
  145780. alignVertical?: number;
  145781. faceUV?: Vector4[];
  145782. faceColors?: Color4[];
  145783. sideOrientation?: number;
  145784. updatable?: boolean;
  145785. }, scene?: Nullable<Scene>): Mesh;
  145786. }
  145787. }
  145788. declare module BABYLON {
  145789. /**
  145790. * Class containing static functions to help procedurally build meshes
  145791. */
  145792. export class TorusKnotBuilder {
  145793. /**
  145794. * Creates a torus knot mesh
  145795. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  145796. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  145797. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  145798. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  145799. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145800. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145801. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145802. * @param name defines the name of the mesh
  145803. * @param options defines the options used to create the mesh
  145804. * @param scene defines the hosting scene
  145805. * @returns the torus knot mesh
  145806. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  145807. */
  145808. static CreateTorusKnot(name: string, options: {
  145809. radius?: number;
  145810. tube?: number;
  145811. radialSegments?: number;
  145812. tubularSegments?: number;
  145813. p?: number;
  145814. q?: number;
  145815. updatable?: boolean;
  145816. sideOrientation?: number;
  145817. frontUVs?: Vector4;
  145818. backUVs?: Vector4;
  145819. }, scene: any): Mesh;
  145820. }
  145821. }
  145822. declare module BABYLON {
  145823. /**
  145824. * Polygon
  145825. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  145826. */
  145827. export class Polygon {
  145828. /**
  145829. * Creates a rectangle
  145830. * @param xmin bottom X coord
  145831. * @param ymin bottom Y coord
  145832. * @param xmax top X coord
  145833. * @param ymax top Y coord
  145834. * @returns points that make the resulting rectation
  145835. */
  145836. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  145837. /**
  145838. * Creates a circle
  145839. * @param radius radius of circle
  145840. * @param cx scale in x
  145841. * @param cy scale in y
  145842. * @param numberOfSides number of sides that make up the circle
  145843. * @returns points that make the resulting circle
  145844. */
  145845. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  145846. /**
  145847. * Creates a polygon from input string
  145848. * @param input Input polygon data
  145849. * @returns the parsed points
  145850. */
  145851. static Parse(input: string): Vector2[];
  145852. /**
  145853. * Starts building a polygon from x and y coordinates
  145854. * @param x x coordinate
  145855. * @param y y coordinate
  145856. * @returns the started path2
  145857. */
  145858. static StartingAt(x: number, y: number): Path2;
  145859. }
  145860. /**
  145861. * Builds a polygon
  145862. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  145863. */
  145864. export class PolygonMeshBuilder {
  145865. private _points;
  145866. private _outlinepoints;
  145867. private _holes;
  145868. private _name;
  145869. private _scene;
  145870. private _epoints;
  145871. private _eholes;
  145872. private _addToepoint;
  145873. /**
  145874. * Babylon reference to the earcut plugin.
  145875. */
  145876. bjsEarcut: any;
  145877. /**
  145878. * Creates a PolygonMeshBuilder
  145879. * @param name name of the builder
  145880. * @param contours Path of the polygon
  145881. * @param scene scene to add to when creating the mesh
  145882. * @param earcutInjection can be used to inject your own earcut reference
  145883. */
  145884. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  145885. /**
  145886. * Adds a whole within the polygon
  145887. * @param hole Array of points defining the hole
  145888. * @returns this
  145889. */
  145890. addHole(hole: Vector2[]): PolygonMeshBuilder;
  145891. /**
  145892. * Creates the polygon
  145893. * @param updatable If the mesh should be updatable
  145894. * @param depth The depth of the mesh created
  145895. * @returns the created mesh
  145896. */
  145897. build(updatable?: boolean, depth?: number): Mesh;
  145898. /**
  145899. * Creates the polygon
  145900. * @param depth The depth of the mesh created
  145901. * @returns the created VertexData
  145902. */
  145903. buildVertexData(depth?: number): VertexData;
  145904. /**
  145905. * Adds a side to the polygon
  145906. * @param positions points that make the polygon
  145907. * @param normals normals of the polygon
  145908. * @param uvs uvs of the polygon
  145909. * @param indices indices of the polygon
  145910. * @param bounds bounds of the polygon
  145911. * @param points points of the polygon
  145912. * @param depth depth of the polygon
  145913. * @param flip flip of the polygon
  145914. */
  145915. private addSide;
  145916. }
  145917. }
  145918. declare module BABYLON {
  145919. /**
  145920. * Class containing static functions to help procedurally build meshes
  145921. */
  145922. export class PolygonBuilder {
  145923. /**
  145924. * Creates a polygon mesh
  145925. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  145926. * * 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
  145927. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  145928. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145929. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  145930. * * Remember you can only change the shape positions, not their number when updating a polygon
  145931. * @param name defines the name of the mesh
  145932. * @param options defines the options used to create the mesh
  145933. * @param scene defines the hosting scene
  145934. * @param earcutInjection can be used to inject your own earcut reference
  145935. * @returns the polygon mesh
  145936. */
  145937. static CreatePolygon(name: string, options: {
  145938. shape: Vector3[];
  145939. holes?: Vector3[][];
  145940. depth?: number;
  145941. faceUV?: Vector4[];
  145942. faceColors?: Color4[];
  145943. updatable?: boolean;
  145944. sideOrientation?: number;
  145945. frontUVs?: Vector4;
  145946. backUVs?: Vector4;
  145947. wrap?: boolean;
  145948. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145949. /**
  145950. * Creates an extruded polygon mesh, with depth in the Y direction.
  145951. * * 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)
  145952. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145953. * @param name defines the name of the mesh
  145954. * @param options defines the options used to create the mesh
  145955. * @param scene defines the hosting scene
  145956. * @param earcutInjection can be used to inject your own earcut reference
  145957. * @returns the polygon mesh
  145958. */
  145959. static ExtrudePolygon(name: string, options: {
  145960. shape: Vector3[];
  145961. holes?: Vector3[][];
  145962. depth?: number;
  145963. faceUV?: Vector4[];
  145964. faceColors?: Color4[];
  145965. updatable?: boolean;
  145966. sideOrientation?: number;
  145967. frontUVs?: Vector4;
  145968. backUVs?: Vector4;
  145969. wrap?: boolean;
  145970. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145971. }
  145972. }
  145973. declare module BABYLON {
  145974. /**
  145975. * Class containing static functions to help procedurally build meshes
  145976. */
  145977. export class LatheBuilder {
  145978. /**
  145979. * Creates lathe mesh.
  145980. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  145981. * * 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
  145982. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  145983. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  145984. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  145985. * * 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
  145986. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  145987. * * 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
  145988. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145989. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145990. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145991. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145992. * @param name defines the name of the mesh
  145993. * @param options defines the options used to create the mesh
  145994. * @param scene defines the hosting scene
  145995. * @returns the lathe mesh
  145996. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  145997. */
  145998. static CreateLathe(name: string, options: {
  145999. shape: Vector3[];
  146000. radius?: number;
  146001. tessellation?: number;
  146002. clip?: number;
  146003. arc?: number;
  146004. closed?: boolean;
  146005. updatable?: boolean;
  146006. sideOrientation?: number;
  146007. frontUVs?: Vector4;
  146008. backUVs?: Vector4;
  146009. cap?: number;
  146010. invertUV?: boolean;
  146011. }, scene?: Nullable<Scene>): Mesh;
  146012. }
  146013. }
  146014. declare module BABYLON {
  146015. /**
  146016. * Class containing static functions to help procedurally build meshes
  146017. */
  146018. export class TiledPlaneBuilder {
  146019. /**
  146020. * Creates a tiled plane mesh
  146021. * * The parameter `pattern` will, depending on value, do nothing or
  146022. * * * flip (reflect about central vertical) alternate tiles across and up
  146023. * * * flip every tile on alternate rows
  146024. * * * rotate (180 degs) alternate tiles across and up
  146025. * * * rotate every tile on alternate rows
  146026. * * * flip and rotate alternate tiles across and up
  146027. * * * flip and rotate every tile on alternate rows
  146028. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  146029. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  146030. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146031. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  146032. * * 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)
  146033. * * 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)
  146034. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  146035. * @param name defines the name of the mesh
  146036. * @param options defines the options used to create the mesh
  146037. * @param scene defines the hosting scene
  146038. * @returns the box mesh
  146039. */
  146040. static CreateTiledPlane(name: string, options: {
  146041. pattern?: number;
  146042. tileSize?: number;
  146043. tileWidth?: number;
  146044. tileHeight?: number;
  146045. size?: number;
  146046. width?: number;
  146047. height?: number;
  146048. alignHorizontal?: number;
  146049. alignVertical?: number;
  146050. sideOrientation?: number;
  146051. frontUVs?: Vector4;
  146052. backUVs?: Vector4;
  146053. updatable?: boolean;
  146054. }, scene?: Nullable<Scene>): Mesh;
  146055. }
  146056. }
  146057. declare module BABYLON {
  146058. /**
  146059. * Class containing static functions to help procedurally build meshes
  146060. */
  146061. export class TubeBuilder {
  146062. /**
  146063. * Creates a tube mesh.
  146064. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  146065. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  146066. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  146067. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  146068. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  146069. * * 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)
  146070. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  146071. * * 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
  146072. * * 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
  146073. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146074. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146075. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  146076. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146077. * @param name defines the name of the mesh
  146078. * @param options defines the options used to create the mesh
  146079. * @param scene defines the hosting scene
  146080. * @returns the tube mesh
  146081. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  146082. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  146083. */
  146084. static CreateTube(name: string, options: {
  146085. path: Vector3[];
  146086. radius?: number;
  146087. tessellation?: number;
  146088. radiusFunction?: {
  146089. (i: number, distance: number): number;
  146090. };
  146091. cap?: number;
  146092. arc?: number;
  146093. updatable?: boolean;
  146094. sideOrientation?: number;
  146095. frontUVs?: Vector4;
  146096. backUVs?: Vector4;
  146097. instance?: Mesh;
  146098. invertUV?: boolean;
  146099. }, scene?: Nullable<Scene>): Mesh;
  146100. }
  146101. }
  146102. declare module BABYLON {
  146103. /**
  146104. * Class containing static functions to help procedurally build meshes
  146105. */
  146106. export class IcoSphereBuilder {
  146107. /**
  146108. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  146109. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  146110. * * 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`)
  146111. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  146112. * * 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
  146113. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146114. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146115. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146116. * @param name defines the name of the mesh
  146117. * @param options defines the options used to create the mesh
  146118. * @param scene defines the hosting scene
  146119. * @returns the icosahedron mesh
  146120. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  146121. */
  146122. static CreateIcoSphere(name: string, options: {
  146123. radius?: number;
  146124. radiusX?: number;
  146125. radiusY?: number;
  146126. radiusZ?: number;
  146127. flat?: boolean;
  146128. subdivisions?: number;
  146129. sideOrientation?: number;
  146130. frontUVs?: Vector4;
  146131. backUVs?: Vector4;
  146132. updatable?: boolean;
  146133. }, scene?: Nullable<Scene>): Mesh;
  146134. }
  146135. }
  146136. declare module BABYLON {
  146137. /**
  146138. * Class containing static functions to help procedurally build meshes
  146139. */
  146140. export class DecalBuilder {
  146141. /**
  146142. * Creates a decal mesh.
  146143. * 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
  146144. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  146145. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  146146. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  146147. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  146148. * @param name defines the name of the mesh
  146149. * @param sourceMesh defines the mesh where the decal must be applied
  146150. * @param options defines the options used to create the mesh
  146151. * @param scene defines the hosting scene
  146152. * @returns the decal mesh
  146153. * @see https://doc.babylonjs.com/how_to/decals
  146154. */
  146155. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  146156. position?: Vector3;
  146157. normal?: Vector3;
  146158. size?: Vector3;
  146159. angle?: number;
  146160. }): Mesh;
  146161. }
  146162. }
  146163. declare module BABYLON {
  146164. /**
  146165. * Class containing static functions to help procedurally build meshes
  146166. */
  146167. export class MeshBuilder {
  146168. /**
  146169. * Creates a box mesh
  146170. * * The parameter `size` sets the size (float) of each box side (default 1)
  146171. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  146172. * * 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)
  146173. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  146174. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146175. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146176. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146177. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  146178. * @param name defines the name of the mesh
  146179. * @param options defines the options used to create the mesh
  146180. * @param scene defines the hosting scene
  146181. * @returns the box mesh
  146182. */
  146183. static CreateBox(name: string, options: {
  146184. size?: number;
  146185. width?: number;
  146186. height?: number;
  146187. depth?: number;
  146188. faceUV?: Vector4[];
  146189. faceColors?: Color4[];
  146190. sideOrientation?: number;
  146191. frontUVs?: Vector4;
  146192. backUVs?: Vector4;
  146193. wrap?: boolean;
  146194. topBaseAt?: number;
  146195. bottomBaseAt?: number;
  146196. updatable?: boolean;
  146197. }, scene?: Nullable<Scene>): Mesh;
  146198. /**
  146199. * Creates a tiled box mesh
  146200. * * faceTiles sets the pattern, tile size and number of tiles for a face
  146201. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146202. * @param name defines the name of the mesh
  146203. * @param options defines the options used to create the mesh
  146204. * @param scene defines the hosting scene
  146205. * @returns the tiled box mesh
  146206. */
  146207. static CreateTiledBox(name: string, options: {
  146208. pattern?: number;
  146209. size?: number;
  146210. width?: number;
  146211. height?: number;
  146212. depth: number;
  146213. tileSize?: number;
  146214. tileWidth?: number;
  146215. tileHeight?: number;
  146216. faceUV?: Vector4[];
  146217. faceColors?: Color4[];
  146218. alignHorizontal?: number;
  146219. alignVertical?: number;
  146220. sideOrientation?: number;
  146221. updatable?: boolean;
  146222. }, scene?: Nullable<Scene>): Mesh;
  146223. /**
  146224. * Creates a sphere mesh
  146225. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  146226. * * 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`)
  146227. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  146228. * * 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
  146229. * * 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)
  146230. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146231. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146232. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146233. * @param name defines the name of the mesh
  146234. * @param options defines the options used to create the mesh
  146235. * @param scene defines the hosting scene
  146236. * @returns the sphere mesh
  146237. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  146238. */
  146239. static CreateSphere(name: string, options: {
  146240. segments?: number;
  146241. diameter?: number;
  146242. diameterX?: number;
  146243. diameterY?: number;
  146244. diameterZ?: number;
  146245. arc?: number;
  146246. slice?: number;
  146247. sideOrientation?: number;
  146248. frontUVs?: Vector4;
  146249. backUVs?: Vector4;
  146250. updatable?: boolean;
  146251. }, scene?: Nullable<Scene>): Mesh;
  146252. /**
  146253. * Creates a plane polygonal mesh. By default, this is a disc
  146254. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  146255. * * 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
  146256. * * 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
  146257. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146258. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146259. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146260. * @param name defines the name of the mesh
  146261. * @param options defines the options used to create the mesh
  146262. * @param scene defines the hosting scene
  146263. * @returns the plane polygonal mesh
  146264. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  146265. */
  146266. static CreateDisc(name: string, options: {
  146267. radius?: number;
  146268. tessellation?: number;
  146269. arc?: number;
  146270. updatable?: boolean;
  146271. sideOrientation?: number;
  146272. frontUVs?: Vector4;
  146273. backUVs?: Vector4;
  146274. }, scene?: Nullable<Scene>): Mesh;
  146275. /**
  146276. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  146277. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  146278. * * 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`)
  146279. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  146280. * * 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
  146281. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146282. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146283. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146284. * @param name defines the name of the mesh
  146285. * @param options defines the options used to create the mesh
  146286. * @param scene defines the hosting scene
  146287. * @returns the icosahedron mesh
  146288. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  146289. */
  146290. static CreateIcoSphere(name: string, options: {
  146291. radius?: number;
  146292. radiusX?: number;
  146293. radiusY?: number;
  146294. radiusZ?: number;
  146295. flat?: boolean;
  146296. subdivisions?: number;
  146297. sideOrientation?: number;
  146298. frontUVs?: Vector4;
  146299. backUVs?: Vector4;
  146300. updatable?: boolean;
  146301. }, scene?: Nullable<Scene>): Mesh;
  146302. /**
  146303. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  146304. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  146305. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  146306. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  146307. * * 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
  146308. * * 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
  146309. * * 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
  146310. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146311. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146312. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  146313. * * 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
  146314. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  146315. * * 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
  146316. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  146317. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146318. * @param name defines the name of the mesh
  146319. * @param options defines the options used to create the mesh
  146320. * @param scene defines the hosting scene
  146321. * @returns the ribbon mesh
  146322. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  146323. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  146324. */
  146325. static CreateRibbon(name: string, options: {
  146326. pathArray: Vector3[][];
  146327. closeArray?: boolean;
  146328. closePath?: boolean;
  146329. offset?: number;
  146330. updatable?: boolean;
  146331. sideOrientation?: number;
  146332. frontUVs?: Vector4;
  146333. backUVs?: Vector4;
  146334. instance?: Mesh;
  146335. invertUV?: boolean;
  146336. uvs?: Vector2[];
  146337. colors?: Color4[];
  146338. }, scene?: Nullable<Scene>): Mesh;
  146339. /**
  146340. * Creates a cylinder or a cone mesh
  146341. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  146342. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  146343. * * 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.
  146344. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  146345. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  146346. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  146347. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  146348. * * 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).
  146349. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  146350. * * 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).
  146351. * * 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
  146352. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  146353. * * 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
  146354. * * 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.
  146355. * * If `enclose` is false, a ring surface is one element.
  146356. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  146357. * * 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
  146358. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146359. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146360. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  146361. * @param name defines the name of the mesh
  146362. * @param options defines the options used to create the mesh
  146363. * @param scene defines the hosting scene
  146364. * @returns the cylinder mesh
  146365. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  146366. */
  146367. static CreateCylinder(name: string, options: {
  146368. height?: number;
  146369. diameterTop?: number;
  146370. diameterBottom?: number;
  146371. diameter?: number;
  146372. tessellation?: number;
  146373. subdivisions?: number;
  146374. arc?: number;
  146375. faceColors?: Color4[];
  146376. faceUV?: Vector4[];
  146377. updatable?: boolean;
  146378. hasRings?: boolean;
  146379. enclose?: boolean;
  146380. cap?: number;
  146381. sideOrientation?: number;
  146382. frontUVs?: Vector4;
  146383. backUVs?: Vector4;
  146384. }, scene?: Nullable<Scene>): Mesh;
  146385. /**
  146386. * Creates a torus mesh
  146387. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  146388. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  146389. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  146390. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146391. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146392. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  146393. * @param name defines the name of the mesh
  146394. * @param options defines the options used to create the mesh
  146395. * @param scene defines the hosting scene
  146396. * @returns the torus mesh
  146397. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  146398. */
  146399. static CreateTorus(name: string, options: {
  146400. diameter?: number;
  146401. thickness?: number;
  146402. tessellation?: number;
  146403. updatable?: boolean;
  146404. sideOrientation?: number;
  146405. frontUVs?: Vector4;
  146406. backUVs?: Vector4;
  146407. }, scene?: Nullable<Scene>): Mesh;
  146408. /**
  146409. * Creates a torus knot mesh
  146410. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  146411. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  146412. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  146413. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  146414. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146415. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146416. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  146417. * @param name defines the name of the mesh
  146418. * @param options defines the options used to create the mesh
  146419. * @param scene defines the hosting scene
  146420. * @returns the torus knot mesh
  146421. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  146422. */
  146423. static CreateTorusKnot(name: string, options: {
  146424. radius?: number;
  146425. tube?: number;
  146426. radialSegments?: number;
  146427. tubularSegments?: number;
  146428. p?: number;
  146429. q?: number;
  146430. updatable?: boolean;
  146431. sideOrientation?: number;
  146432. frontUVs?: Vector4;
  146433. backUVs?: Vector4;
  146434. }, scene?: Nullable<Scene>): Mesh;
  146435. /**
  146436. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  146437. * * 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
  146438. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  146439. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  146440. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  146441. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  146442. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  146443. * * 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
  146444. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  146445. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146446. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  146447. * @param name defines the name of the new line system
  146448. * @param options defines the options used to create the line system
  146449. * @param scene defines the hosting scene
  146450. * @returns a new line system mesh
  146451. */
  146452. static CreateLineSystem(name: string, options: {
  146453. lines: Vector3[][];
  146454. updatable?: boolean;
  146455. instance?: Nullable<LinesMesh>;
  146456. colors?: Nullable<Color4[][]>;
  146457. useVertexAlpha?: boolean;
  146458. }, scene: Nullable<Scene>): LinesMesh;
  146459. /**
  146460. * Creates a line mesh
  146461. * 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
  146462. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  146463. * * The parameter `points` is an array successive Vector3
  146464. * * 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
  146465. * * The optional parameter `colors` is an array of successive Color4, one per line point
  146466. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  146467. * * When updating an instance, remember that only point positions can change, not the number of points
  146468. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146469. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  146470. * @param name defines the name of the new line system
  146471. * @param options defines the options used to create the line system
  146472. * @param scene defines the hosting scene
  146473. * @returns a new line mesh
  146474. */
  146475. static CreateLines(name: string, options: {
  146476. points: Vector3[];
  146477. updatable?: boolean;
  146478. instance?: Nullable<LinesMesh>;
  146479. colors?: Color4[];
  146480. useVertexAlpha?: boolean;
  146481. }, scene?: Nullable<Scene>): LinesMesh;
  146482. /**
  146483. * Creates a dashed line mesh
  146484. * * 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
  146485. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  146486. * * The parameter `points` is an array successive Vector3
  146487. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  146488. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  146489. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  146490. * * 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
  146491. * * When updating an instance, remember that only point positions can change, not the number of points
  146492. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146493. * @param name defines the name of the mesh
  146494. * @param options defines the options used to create the mesh
  146495. * @param scene defines the hosting scene
  146496. * @returns the dashed line mesh
  146497. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  146498. */
  146499. static CreateDashedLines(name: string, options: {
  146500. points: Vector3[];
  146501. dashSize?: number;
  146502. gapSize?: number;
  146503. dashNb?: number;
  146504. updatable?: boolean;
  146505. instance?: LinesMesh;
  146506. }, scene?: Nullable<Scene>): LinesMesh;
  146507. /**
  146508. * 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.
  146509. * * 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.
  146510. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  146511. * * 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.
  146512. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  146513. * * 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
  146514. * * 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
  146515. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  146516. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146517. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146518. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  146519. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  146520. * @param name defines the name of the mesh
  146521. * @param options defines the options used to create the mesh
  146522. * @param scene defines the hosting scene
  146523. * @returns the extruded shape mesh
  146524. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  146525. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  146526. */
  146527. static ExtrudeShape(name: string, options: {
  146528. shape: Vector3[];
  146529. path: Vector3[];
  146530. scale?: number;
  146531. rotation?: number;
  146532. cap?: number;
  146533. updatable?: boolean;
  146534. sideOrientation?: number;
  146535. frontUVs?: Vector4;
  146536. backUVs?: Vector4;
  146537. instance?: Mesh;
  146538. invertUV?: boolean;
  146539. }, scene?: Nullable<Scene>): Mesh;
  146540. /**
  146541. * Creates an custom extruded shape mesh.
  146542. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  146543. * * 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.
  146544. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  146545. * * 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
  146546. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  146547. * * 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
  146548. * * It must returns a float value that will be the scale value applied to the shape on each path point
  146549. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  146550. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  146551. * * 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
  146552. * * 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
  146553. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  146554. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146555. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146556. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  146557. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146558. * @param name defines the name of the mesh
  146559. * @param options defines the options used to create the mesh
  146560. * @param scene defines the hosting scene
  146561. * @returns the custom extruded shape mesh
  146562. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  146563. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  146564. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  146565. */
  146566. static ExtrudeShapeCustom(name: string, options: {
  146567. shape: Vector3[];
  146568. path: Vector3[];
  146569. scaleFunction?: any;
  146570. rotationFunction?: any;
  146571. ribbonCloseArray?: boolean;
  146572. ribbonClosePath?: boolean;
  146573. cap?: number;
  146574. updatable?: boolean;
  146575. sideOrientation?: number;
  146576. frontUVs?: Vector4;
  146577. backUVs?: Vector4;
  146578. instance?: Mesh;
  146579. invertUV?: boolean;
  146580. }, scene?: Nullable<Scene>): Mesh;
  146581. /**
  146582. * Creates lathe mesh.
  146583. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  146584. * * 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
  146585. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  146586. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  146587. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  146588. * * 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
  146589. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  146590. * * 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
  146591. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146592. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146593. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  146594. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146595. * @param name defines the name of the mesh
  146596. * @param options defines the options used to create the mesh
  146597. * @param scene defines the hosting scene
  146598. * @returns the lathe mesh
  146599. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  146600. */
  146601. static CreateLathe(name: string, options: {
  146602. shape: Vector3[];
  146603. radius?: number;
  146604. tessellation?: number;
  146605. clip?: number;
  146606. arc?: number;
  146607. closed?: boolean;
  146608. updatable?: boolean;
  146609. sideOrientation?: number;
  146610. frontUVs?: Vector4;
  146611. backUVs?: Vector4;
  146612. cap?: number;
  146613. invertUV?: boolean;
  146614. }, scene?: Nullable<Scene>): Mesh;
  146615. /**
  146616. * Creates a tiled plane mesh
  146617. * * You can set a limited pattern arrangement with the tiles
  146618. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146619. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146620. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146621. * @param name defines the name of the mesh
  146622. * @param options defines the options used to create the mesh
  146623. * @param scene defines the hosting scene
  146624. * @returns the plane mesh
  146625. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  146626. */
  146627. static CreateTiledPlane(name: string, options: {
  146628. pattern?: number;
  146629. tileSize?: number;
  146630. tileWidth?: number;
  146631. tileHeight?: number;
  146632. size?: number;
  146633. width?: number;
  146634. height?: number;
  146635. alignHorizontal?: number;
  146636. alignVertical?: number;
  146637. sideOrientation?: number;
  146638. frontUVs?: Vector4;
  146639. backUVs?: Vector4;
  146640. updatable?: boolean;
  146641. }, scene?: Nullable<Scene>): Mesh;
  146642. /**
  146643. * Creates a plane mesh
  146644. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  146645. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  146646. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  146647. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146648. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146649. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146650. * @param name defines the name of the mesh
  146651. * @param options defines the options used to create the mesh
  146652. * @param scene defines the hosting scene
  146653. * @returns the plane mesh
  146654. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  146655. */
  146656. static CreatePlane(name: string, options: {
  146657. size?: number;
  146658. width?: number;
  146659. height?: number;
  146660. sideOrientation?: number;
  146661. frontUVs?: Vector4;
  146662. backUVs?: Vector4;
  146663. updatable?: boolean;
  146664. sourcePlane?: Plane;
  146665. }, scene?: Nullable<Scene>): Mesh;
  146666. /**
  146667. * Creates a ground mesh
  146668. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  146669. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  146670. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146671. * @param name defines the name of the mesh
  146672. * @param options defines the options used to create the mesh
  146673. * @param scene defines the hosting scene
  146674. * @returns the ground mesh
  146675. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  146676. */
  146677. static CreateGround(name: string, options: {
  146678. width?: number;
  146679. height?: number;
  146680. subdivisions?: number;
  146681. subdivisionsX?: number;
  146682. subdivisionsY?: number;
  146683. updatable?: boolean;
  146684. }, scene?: Nullable<Scene>): Mesh;
  146685. /**
  146686. * Creates a tiled ground mesh
  146687. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  146688. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  146689. * * 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
  146690. * * 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
  146691. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  146692. * @param name defines the name of the mesh
  146693. * @param options defines the options used to create the mesh
  146694. * @param scene defines the hosting scene
  146695. * @returns the tiled ground mesh
  146696. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  146697. */
  146698. static CreateTiledGround(name: string, options: {
  146699. xmin: number;
  146700. zmin: number;
  146701. xmax: number;
  146702. zmax: number;
  146703. subdivisions?: {
  146704. w: number;
  146705. h: number;
  146706. };
  146707. precision?: {
  146708. w: number;
  146709. h: number;
  146710. };
  146711. updatable?: boolean;
  146712. }, scene?: Nullable<Scene>): Mesh;
  146713. /**
  146714. * Creates a ground mesh from a height map
  146715. * * The parameter `url` sets the URL of the height map image resource.
  146716. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  146717. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  146718. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  146719. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  146720. * * 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.
  146721. * * 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).
  146722. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  146723. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  146724. * @param name defines the name of the mesh
  146725. * @param url defines the url to the height map
  146726. * @param options defines the options used to create the mesh
  146727. * @param scene defines the hosting scene
  146728. * @returns the ground mesh
  146729. * @see https://doc.babylonjs.com/babylon101/height_map
  146730. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  146731. */
  146732. static CreateGroundFromHeightMap(name: string, url: string, options: {
  146733. width?: number;
  146734. height?: number;
  146735. subdivisions?: number;
  146736. minHeight?: number;
  146737. maxHeight?: number;
  146738. colorFilter?: Color3;
  146739. alphaFilter?: number;
  146740. updatable?: boolean;
  146741. onReady?: (mesh: GroundMesh) => void;
  146742. }, scene?: Nullable<Scene>): GroundMesh;
  146743. /**
  146744. * Creates a polygon mesh
  146745. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  146746. * * 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
  146747. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  146748. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146749. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  146750. * * Remember you can only change the shape positions, not their number when updating a polygon
  146751. * @param name defines the name of the mesh
  146752. * @param options defines the options used to create the mesh
  146753. * @param scene defines the hosting scene
  146754. * @param earcutInjection can be used to inject your own earcut reference
  146755. * @returns the polygon mesh
  146756. */
  146757. static CreatePolygon(name: string, options: {
  146758. shape: Vector3[];
  146759. holes?: Vector3[][];
  146760. depth?: number;
  146761. faceUV?: Vector4[];
  146762. faceColors?: Color4[];
  146763. updatable?: boolean;
  146764. sideOrientation?: number;
  146765. frontUVs?: Vector4;
  146766. backUVs?: Vector4;
  146767. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  146768. /**
  146769. * Creates an extruded polygon mesh, with depth in the Y direction.
  146770. * * 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)
  146771. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  146772. * @param name defines the name of the mesh
  146773. * @param options defines the options used to create the mesh
  146774. * @param scene defines the hosting scene
  146775. * @param earcutInjection can be used to inject your own earcut reference
  146776. * @returns the polygon mesh
  146777. */
  146778. static ExtrudePolygon(name: string, options: {
  146779. shape: Vector3[];
  146780. holes?: Vector3[][];
  146781. depth?: number;
  146782. faceUV?: Vector4[];
  146783. faceColors?: Color4[];
  146784. updatable?: boolean;
  146785. sideOrientation?: number;
  146786. frontUVs?: Vector4;
  146787. backUVs?: Vector4;
  146788. wrap?: boolean;
  146789. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  146790. /**
  146791. * Creates a tube mesh.
  146792. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  146793. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  146794. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  146795. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  146796. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  146797. * * 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)
  146798. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  146799. * * 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
  146800. * * 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
  146801. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146802. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146803. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  146804. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146805. * @param name defines the name of the mesh
  146806. * @param options defines the options used to create the mesh
  146807. * @param scene defines the hosting scene
  146808. * @returns the tube mesh
  146809. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  146810. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  146811. */
  146812. static CreateTube(name: string, options: {
  146813. path: Vector3[];
  146814. radius?: number;
  146815. tessellation?: number;
  146816. radiusFunction?: {
  146817. (i: number, distance: number): number;
  146818. };
  146819. cap?: number;
  146820. arc?: number;
  146821. updatable?: boolean;
  146822. sideOrientation?: number;
  146823. frontUVs?: Vector4;
  146824. backUVs?: Vector4;
  146825. instance?: Mesh;
  146826. invertUV?: boolean;
  146827. }, scene?: Nullable<Scene>): Mesh;
  146828. /**
  146829. * Creates a polyhedron mesh
  146830. * * 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
  146831. * * The parameter `size` (positive float, default 1) sets the polygon size
  146832. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  146833. * * 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`
  146834. * * 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
  146835. * * 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)`)
  146836. * * 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
  146837. * * 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
  146838. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  146839. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  146840. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  146841. * @param name defines the name of the mesh
  146842. * @param options defines the options used to create the mesh
  146843. * @param scene defines the hosting scene
  146844. * @returns the polyhedron mesh
  146845. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  146846. */
  146847. static CreatePolyhedron(name: string, options: {
  146848. type?: number;
  146849. size?: number;
  146850. sizeX?: number;
  146851. sizeY?: number;
  146852. sizeZ?: number;
  146853. custom?: any;
  146854. faceUV?: Vector4[];
  146855. faceColors?: Color4[];
  146856. flat?: boolean;
  146857. updatable?: boolean;
  146858. sideOrientation?: number;
  146859. frontUVs?: Vector4;
  146860. backUVs?: Vector4;
  146861. }, scene?: Nullable<Scene>): Mesh;
  146862. /**
  146863. * Creates a decal mesh.
  146864. * 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
  146865. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  146866. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  146867. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  146868. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  146869. * @param name defines the name of the mesh
  146870. * @param sourceMesh defines the mesh where the decal must be applied
  146871. * @param options defines the options used to create the mesh
  146872. * @param scene defines the hosting scene
  146873. * @returns the decal mesh
  146874. * @see https://doc.babylonjs.com/how_to/decals
  146875. */
  146876. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  146877. position?: Vector3;
  146878. normal?: Vector3;
  146879. size?: Vector3;
  146880. angle?: number;
  146881. }): Mesh;
  146882. /**
  146883. * Creates a Capsule Mesh
  146884. * @param name defines the name of the mesh.
  146885. * @param options the constructors options used to shape the mesh.
  146886. * @param scene defines the scene the mesh is scoped to.
  146887. * @returns the capsule mesh
  146888. * @see https://doc.babylonjs.com/how_to/capsule_shape
  146889. */
  146890. static CreateCapsule(name: string, options?: ICreateCapsuleOptions, scene?: Nullable<Scene>): Mesh;
  146891. }
  146892. }
  146893. declare module BABYLON {
  146894. /**
  146895. * A simplifier interface for future simplification implementations
  146896. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146897. */
  146898. export interface ISimplifier {
  146899. /**
  146900. * Simplification of a given mesh according to the given settings.
  146901. * Since this requires computation, it is assumed that the function runs async.
  146902. * @param settings The settings of the simplification, including quality and distance
  146903. * @param successCallback A callback that will be called after the mesh was simplified.
  146904. * @param errorCallback in case of an error, this callback will be called. optional.
  146905. */
  146906. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  146907. }
  146908. /**
  146909. * Expected simplification settings.
  146910. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  146911. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146912. */
  146913. export interface ISimplificationSettings {
  146914. /**
  146915. * Gets or sets the expected quality
  146916. */
  146917. quality: number;
  146918. /**
  146919. * Gets or sets the distance when this optimized version should be used
  146920. */
  146921. distance: number;
  146922. /**
  146923. * Gets an already optimized mesh
  146924. */
  146925. optimizeMesh?: boolean;
  146926. }
  146927. /**
  146928. * Class used to specify simplification options
  146929. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146930. */
  146931. export class SimplificationSettings implements ISimplificationSettings {
  146932. /** expected quality */
  146933. quality: number;
  146934. /** distance when this optimized version should be used */
  146935. distance: number;
  146936. /** already optimized mesh */
  146937. optimizeMesh?: boolean | undefined;
  146938. /**
  146939. * Creates a SimplificationSettings
  146940. * @param quality expected quality
  146941. * @param distance distance when this optimized version should be used
  146942. * @param optimizeMesh already optimized mesh
  146943. */
  146944. constructor(
  146945. /** expected quality */
  146946. quality: number,
  146947. /** distance when this optimized version should be used */
  146948. distance: number,
  146949. /** already optimized mesh */
  146950. optimizeMesh?: boolean | undefined);
  146951. }
  146952. /**
  146953. * Interface used to define a simplification task
  146954. */
  146955. export interface ISimplificationTask {
  146956. /**
  146957. * Array of settings
  146958. */
  146959. settings: Array<ISimplificationSettings>;
  146960. /**
  146961. * Simplification type
  146962. */
  146963. simplificationType: SimplificationType;
  146964. /**
  146965. * Mesh to simplify
  146966. */
  146967. mesh: Mesh;
  146968. /**
  146969. * Callback called on success
  146970. */
  146971. successCallback?: () => void;
  146972. /**
  146973. * Defines if parallel processing can be used
  146974. */
  146975. parallelProcessing: boolean;
  146976. }
  146977. /**
  146978. * Queue used to order the simplification tasks
  146979. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146980. */
  146981. export class SimplificationQueue {
  146982. private _simplificationArray;
  146983. /**
  146984. * Gets a boolean indicating that the process is still running
  146985. */
  146986. running: boolean;
  146987. /**
  146988. * Creates a new queue
  146989. */
  146990. constructor();
  146991. /**
  146992. * Adds a new simplification task
  146993. * @param task defines a task to add
  146994. */
  146995. addTask(task: ISimplificationTask): void;
  146996. /**
  146997. * Execute next task
  146998. */
  146999. executeNext(): void;
  147000. /**
  147001. * Execute a simplification task
  147002. * @param task defines the task to run
  147003. */
  147004. runSimplification(task: ISimplificationTask): void;
  147005. private getSimplifier;
  147006. }
  147007. /**
  147008. * The implemented types of simplification
  147009. * At the moment only Quadratic Error Decimation is implemented
  147010. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  147011. */
  147012. export enum SimplificationType {
  147013. /** Quadratic error decimation */
  147014. QUADRATIC = 0
  147015. }
  147016. /**
  147017. * An implementation of the Quadratic Error simplification algorithm.
  147018. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  147019. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  147020. * @author RaananW
  147021. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  147022. */
  147023. export class QuadraticErrorSimplification implements ISimplifier {
  147024. private _mesh;
  147025. private triangles;
  147026. private vertices;
  147027. private references;
  147028. private _reconstructedMesh;
  147029. /** Gets or sets the number pf sync interations */
  147030. syncIterations: number;
  147031. /** Gets or sets the aggressiveness of the simplifier */
  147032. aggressiveness: number;
  147033. /** Gets or sets the number of allowed iterations for decimation */
  147034. decimationIterations: number;
  147035. /** Gets or sets the espilon to use for bounding box computation */
  147036. boundingBoxEpsilon: number;
  147037. /**
  147038. * Creates a new QuadraticErrorSimplification
  147039. * @param _mesh defines the target mesh
  147040. */
  147041. constructor(_mesh: Mesh);
  147042. /**
  147043. * Simplification of a given mesh according to the given settings.
  147044. * Since this requires computation, it is assumed that the function runs async.
  147045. * @param settings The settings of the simplification, including quality and distance
  147046. * @param successCallback A callback that will be called after the mesh was simplified.
  147047. */
  147048. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  147049. private runDecimation;
  147050. private initWithMesh;
  147051. private init;
  147052. private reconstructMesh;
  147053. private initDecimatedMesh;
  147054. private isFlipped;
  147055. private updateTriangles;
  147056. private identifyBorder;
  147057. private updateMesh;
  147058. private vertexError;
  147059. private calculateError;
  147060. }
  147061. }
  147062. declare module BABYLON {
  147063. interface Scene {
  147064. /** @hidden (Backing field) */
  147065. _simplificationQueue: SimplificationQueue;
  147066. /**
  147067. * Gets or sets the simplification queue attached to the scene
  147068. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  147069. */
  147070. simplificationQueue: SimplificationQueue;
  147071. }
  147072. interface Mesh {
  147073. /**
  147074. * Simplify the mesh according to the given array of settings.
  147075. * Function will return immediately and will simplify async
  147076. * @param settings a collection of simplification settings
  147077. * @param parallelProcessing should all levels calculate parallel or one after the other
  147078. * @param simplificationType the type of simplification to run
  147079. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  147080. * @returns the current mesh
  147081. */
  147082. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  147083. }
  147084. /**
  147085. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  147086. * created in a scene
  147087. */
  147088. export class SimplicationQueueSceneComponent implements ISceneComponent {
  147089. /**
  147090. * The component name helpfull to identify the component in the list of scene components.
  147091. */
  147092. readonly name: string;
  147093. /**
  147094. * The scene the component belongs to.
  147095. */
  147096. scene: Scene;
  147097. /**
  147098. * Creates a new instance of the component for the given scene
  147099. * @param scene Defines the scene to register the component in
  147100. */
  147101. constructor(scene: Scene);
  147102. /**
  147103. * Registers the component in a given scene
  147104. */
  147105. register(): void;
  147106. /**
  147107. * Rebuilds the elements related to this component in case of
  147108. * context lost for instance.
  147109. */
  147110. rebuild(): void;
  147111. /**
  147112. * Disposes the component and the associated ressources
  147113. */
  147114. dispose(): void;
  147115. private _beforeCameraUpdate;
  147116. }
  147117. }
  147118. declare module BABYLON {
  147119. interface Mesh {
  147120. /**
  147121. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  147122. */
  147123. thinInstanceEnablePicking: boolean;
  147124. /**
  147125. * Creates a new thin instance
  147126. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  147127. * @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
  147128. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  147129. */
  147130. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  147131. /**
  147132. * Adds the transformation (matrix) of the current mesh as a thin instance
  147133. * @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
  147134. * @returns the thin instance index number
  147135. */
  147136. thinInstanceAddSelf(refresh: boolean): number;
  147137. /**
  147138. * Registers a custom attribute to be used with thin instances
  147139. * @param kind name of the attribute
  147140. * @param stride size in floats of the attribute
  147141. */
  147142. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  147143. /**
  147144. * Sets the matrix of a thin instance
  147145. * @param index index of the thin instance
  147146. * @param matrix matrix to set
  147147. * @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
  147148. */
  147149. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  147150. /**
  147151. * Sets the value of a custom attribute for a thin instance
  147152. * @param kind name of the attribute
  147153. * @param index index of the thin instance
  147154. * @param value value to set
  147155. * @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
  147156. */
  147157. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  147158. /**
  147159. * 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.
  147160. */
  147161. thinInstanceCount: number;
  147162. /**
  147163. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  147164. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  147165. * @param buffer buffer to set
  147166. * @param stride size in floats of each value of the buffer
  147167. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  147168. */
  147169. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  147170. /**
  147171. * Gets the list of world matrices
  147172. * @return an array containing all the world matrices from the thin instances
  147173. */
  147174. thinInstanceGetWorldMatrices(): Matrix[];
  147175. /**
  147176. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  147177. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  147178. */
  147179. thinInstanceBufferUpdated(kind: string): void;
  147180. /**
  147181. * Applies a partial update to a buffer directly on the GPU
  147182. * 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
  147183. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  147184. * @param data the data to set in the GPU buffer
  147185. * @param offset the offset in the GPU buffer where to update the data
  147186. */
  147187. thinInstancePartialBufferUpdate(kind: string, data: Float32Array, offset: number): void;
  147188. /**
  147189. * Refreshes the bounding info, taking into account all the thin instances defined
  147190. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  147191. */
  147192. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  147193. /** @hidden */
  147194. _thinInstanceInitializeUserStorage(): void;
  147195. /** @hidden */
  147196. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  147197. /** @hidden */
  147198. _userThinInstanceBuffersStorage: {
  147199. data: {
  147200. [key: string]: Float32Array;
  147201. };
  147202. sizes: {
  147203. [key: string]: number;
  147204. };
  147205. vertexBuffers: {
  147206. [key: string]: Nullable<VertexBuffer>;
  147207. };
  147208. strides: {
  147209. [key: string]: number;
  147210. };
  147211. };
  147212. }
  147213. }
  147214. declare module BABYLON {
  147215. /**
  147216. * Navigation plugin interface to add navigation constrained by a navigation mesh
  147217. */
  147218. export interface INavigationEnginePlugin {
  147219. /**
  147220. * plugin name
  147221. */
  147222. name: string;
  147223. /**
  147224. * Creates a navigation mesh
  147225. * @param meshes array of all the geometry used to compute the navigatio mesh
  147226. * @param parameters bunch of parameters used to filter geometry
  147227. */
  147228. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  147229. /**
  147230. * Create a navigation mesh debug mesh
  147231. * @param scene is where the mesh will be added
  147232. * @returns debug display mesh
  147233. */
  147234. createDebugNavMesh(scene: Scene): Mesh;
  147235. /**
  147236. * Get a navigation mesh constrained position, closest to the parameter position
  147237. * @param position world position
  147238. * @returns the closest point to position constrained by the navigation mesh
  147239. */
  147240. getClosestPoint(position: Vector3): Vector3;
  147241. /**
  147242. * Get a navigation mesh constrained position, closest to the parameter position
  147243. * @param position world position
  147244. * @param result output the closest point to position constrained by the navigation mesh
  147245. */
  147246. getClosestPointToRef(position: Vector3, result: Vector3): void;
  147247. /**
  147248. * Get a navigation mesh constrained position, within a particular radius
  147249. * @param position world position
  147250. * @param maxRadius the maximum distance to the constrained world position
  147251. * @returns the closest point to position constrained by the navigation mesh
  147252. */
  147253. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  147254. /**
  147255. * Get a navigation mesh constrained position, within a particular radius
  147256. * @param position world position
  147257. * @param maxRadius the maximum distance to the constrained world position
  147258. * @param result output the closest point to position constrained by the navigation mesh
  147259. */
  147260. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  147261. /**
  147262. * Compute the final position from a segment made of destination-position
  147263. * @param position world position
  147264. * @param destination world position
  147265. * @returns the resulting point along the navmesh
  147266. */
  147267. moveAlong(position: Vector3, destination: Vector3): Vector3;
  147268. /**
  147269. * Compute the final position from a segment made of destination-position
  147270. * @param position world position
  147271. * @param destination world position
  147272. * @param result output the resulting point along the navmesh
  147273. */
  147274. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  147275. /**
  147276. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  147277. * @param start world position
  147278. * @param end world position
  147279. * @returns array containing world position composing the path
  147280. */
  147281. computePath(start: Vector3, end: Vector3): Vector3[];
  147282. /**
  147283. * If this plugin is supported
  147284. * @returns true if plugin is supported
  147285. */
  147286. isSupported(): boolean;
  147287. /**
  147288. * Create a new Crowd so you can add agents
  147289. * @param maxAgents the maximum agent count in the crowd
  147290. * @param maxAgentRadius the maximum radius an agent can have
  147291. * @param scene to attach the crowd to
  147292. * @returns the crowd you can add agents to
  147293. */
  147294. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  147295. /**
  147296. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  147297. * The queries will try to find a solution within those bounds
  147298. * default is (1,1,1)
  147299. * @param extent x,y,z value that define the extent around the queries point of reference
  147300. */
  147301. setDefaultQueryExtent(extent: Vector3): void;
  147302. /**
  147303. * Get the Bounding box extent specified by setDefaultQueryExtent
  147304. * @returns the box extent values
  147305. */
  147306. getDefaultQueryExtent(): Vector3;
  147307. /**
  147308. * build the navmesh from a previously saved state using getNavmeshData
  147309. * @param data the Uint8Array returned by getNavmeshData
  147310. */
  147311. buildFromNavmeshData(data: Uint8Array): void;
  147312. /**
  147313. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  147314. * @returns data the Uint8Array that can be saved and reused
  147315. */
  147316. getNavmeshData(): Uint8Array;
  147317. /**
  147318. * Get the Bounding box extent result specified by setDefaultQueryExtent
  147319. * @param result output the box extent values
  147320. */
  147321. getDefaultQueryExtentToRef(result: Vector3): void;
  147322. /**
  147323. * Release all resources
  147324. */
  147325. dispose(): void;
  147326. }
  147327. /**
  147328. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  147329. */
  147330. export interface ICrowd {
  147331. /**
  147332. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  147333. * You can attach anything to that node. The node position is updated in the scene update tick.
  147334. * @param pos world position that will be constrained by the navigation mesh
  147335. * @param parameters agent parameters
  147336. * @param transform hooked to the agent that will be update by the scene
  147337. * @returns agent index
  147338. */
  147339. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  147340. /**
  147341. * Returns the agent position in world space
  147342. * @param index agent index returned by addAgent
  147343. * @returns world space position
  147344. */
  147345. getAgentPosition(index: number): Vector3;
  147346. /**
  147347. * Gets the agent position result in world space
  147348. * @param index agent index returned by addAgent
  147349. * @param result output world space position
  147350. */
  147351. getAgentPositionToRef(index: number, result: Vector3): void;
  147352. /**
  147353. * Gets the agent velocity in world space
  147354. * @param index agent index returned by addAgent
  147355. * @returns world space velocity
  147356. */
  147357. getAgentVelocity(index: number): Vector3;
  147358. /**
  147359. * Gets the agent velocity result in world space
  147360. * @param index agent index returned by addAgent
  147361. * @param result output world space velocity
  147362. */
  147363. getAgentVelocityToRef(index: number, result: Vector3): void;
  147364. /**
  147365. * remove a particular agent previously created
  147366. * @param index agent index returned by addAgent
  147367. */
  147368. removeAgent(index: number): void;
  147369. /**
  147370. * get the list of all agents attached to this crowd
  147371. * @returns list of agent indices
  147372. */
  147373. getAgents(): number[];
  147374. /**
  147375. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  147376. * @param deltaTime in seconds
  147377. */
  147378. update(deltaTime: number): void;
  147379. /**
  147380. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  147381. * @param index agent index returned by addAgent
  147382. * @param destination targeted world position
  147383. */
  147384. agentGoto(index: number, destination: Vector3): void;
  147385. /**
  147386. * Teleport the agent to a new position
  147387. * @param index agent index returned by addAgent
  147388. * @param destination targeted world position
  147389. */
  147390. agentTeleport(index: number, destination: Vector3): void;
  147391. /**
  147392. * Update agent parameters
  147393. * @param index agent index returned by addAgent
  147394. * @param parameters agent parameters
  147395. */
  147396. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  147397. /**
  147398. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  147399. * The queries will try to find a solution within those bounds
  147400. * default is (1,1,1)
  147401. * @param extent x,y,z value that define the extent around the queries point of reference
  147402. */
  147403. setDefaultQueryExtent(extent: Vector3): void;
  147404. /**
  147405. * Get the Bounding box extent specified by setDefaultQueryExtent
  147406. * @returns the box extent values
  147407. */
  147408. getDefaultQueryExtent(): Vector3;
  147409. /**
  147410. * Get the Bounding box extent result specified by setDefaultQueryExtent
  147411. * @param result output the box extent values
  147412. */
  147413. getDefaultQueryExtentToRef(result: Vector3): void;
  147414. /**
  147415. * Release all resources
  147416. */
  147417. dispose(): void;
  147418. }
  147419. /**
  147420. * Configures an agent
  147421. */
  147422. export interface IAgentParameters {
  147423. /**
  147424. * Agent radius. [Limit: >= 0]
  147425. */
  147426. radius: number;
  147427. /**
  147428. * Agent height. [Limit: > 0]
  147429. */
  147430. height: number;
  147431. /**
  147432. * Maximum allowed acceleration. [Limit: >= 0]
  147433. */
  147434. maxAcceleration: number;
  147435. /**
  147436. * Maximum allowed speed. [Limit: >= 0]
  147437. */
  147438. maxSpeed: number;
  147439. /**
  147440. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  147441. */
  147442. collisionQueryRange: number;
  147443. /**
  147444. * The path visibility optimization range. [Limit: > 0]
  147445. */
  147446. pathOptimizationRange: number;
  147447. /**
  147448. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  147449. */
  147450. separationWeight: number;
  147451. }
  147452. /**
  147453. * Configures the navigation mesh creation
  147454. */
  147455. export interface INavMeshParameters {
  147456. /**
  147457. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  147458. */
  147459. cs: number;
  147460. /**
  147461. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  147462. */
  147463. ch: number;
  147464. /**
  147465. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  147466. */
  147467. walkableSlopeAngle: number;
  147468. /**
  147469. * Minimum floor to 'ceiling' height that will still allow the floor area to
  147470. * be considered walkable. [Limit: >= 3] [Units: vx]
  147471. */
  147472. walkableHeight: number;
  147473. /**
  147474. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  147475. */
  147476. walkableClimb: number;
  147477. /**
  147478. * The distance to erode/shrink the walkable area of the heightfield away from
  147479. * obstructions. [Limit: >=0] [Units: vx]
  147480. */
  147481. walkableRadius: number;
  147482. /**
  147483. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  147484. */
  147485. maxEdgeLen: number;
  147486. /**
  147487. * The maximum distance a simplfied contour's border edges should deviate
  147488. * the original raw contour. [Limit: >=0] [Units: vx]
  147489. */
  147490. maxSimplificationError: number;
  147491. /**
  147492. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  147493. */
  147494. minRegionArea: number;
  147495. /**
  147496. * Any regions with a span count smaller than this value will, if possible,
  147497. * be merged with larger regions. [Limit: >=0] [Units: vx]
  147498. */
  147499. mergeRegionArea: number;
  147500. /**
  147501. * The maximum number of vertices allowed for polygons generated during the
  147502. * contour to polygon conversion process. [Limit: >= 3]
  147503. */
  147504. maxVertsPerPoly: number;
  147505. /**
  147506. * Sets the sampling distance to use when generating the detail mesh.
  147507. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  147508. */
  147509. detailSampleDist: number;
  147510. /**
  147511. * The maximum distance the detail mesh surface should deviate from heightfield
  147512. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  147513. */
  147514. detailSampleMaxError: number;
  147515. }
  147516. }
  147517. declare module BABYLON {
  147518. /**
  147519. * RecastJS navigation plugin
  147520. */
  147521. export class RecastJSPlugin implements INavigationEnginePlugin {
  147522. /**
  147523. * Reference to the Recast library
  147524. */
  147525. bjsRECAST: any;
  147526. /**
  147527. * plugin name
  147528. */
  147529. name: string;
  147530. /**
  147531. * the first navmesh created. We might extend this to support multiple navmeshes
  147532. */
  147533. navMesh: any;
  147534. /**
  147535. * Initializes the recastJS plugin
  147536. * @param recastInjection can be used to inject your own recast reference
  147537. */
  147538. constructor(recastInjection?: any);
  147539. /**
  147540. * Creates a navigation mesh
  147541. * @param meshes array of all the geometry used to compute the navigatio mesh
  147542. * @param parameters bunch of parameters used to filter geometry
  147543. */
  147544. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  147545. /**
  147546. * Create a navigation mesh debug mesh
  147547. * @param scene is where the mesh will be added
  147548. * @returns debug display mesh
  147549. */
  147550. createDebugNavMesh(scene: Scene): Mesh;
  147551. /**
  147552. * Get a navigation mesh constrained position, closest to the parameter position
  147553. * @param position world position
  147554. * @returns the closest point to position constrained by the navigation mesh
  147555. */
  147556. getClosestPoint(position: Vector3): Vector3;
  147557. /**
  147558. * Get a navigation mesh constrained position, closest to the parameter position
  147559. * @param position world position
  147560. * @param result output the closest point to position constrained by the navigation mesh
  147561. */
  147562. getClosestPointToRef(position: Vector3, result: Vector3): void;
  147563. /**
  147564. * Get a navigation mesh constrained position, within a particular radius
  147565. * @param position world position
  147566. * @param maxRadius the maximum distance to the constrained world position
  147567. * @returns the closest point to position constrained by the navigation mesh
  147568. */
  147569. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  147570. /**
  147571. * Get a navigation mesh constrained position, within a particular radius
  147572. * @param position world position
  147573. * @param maxRadius the maximum distance to the constrained world position
  147574. * @param result output the closest point to position constrained by the navigation mesh
  147575. */
  147576. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  147577. /**
  147578. * Compute the final position from a segment made of destination-position
  147579. * @param position world position
  147580. * @param destination world position
  147581. * @returns the resulting point along the navmesh
  147582. */
  147583. moveAlong(position: Vector3, destination: Vector3): Vector3;
  147584. /**
  147585. * Compute the final position from a segment made of destination-position
  147586. * @param position world position
  147587. * @param destination world position
  147588. * @param result output the resulting point along the navmesh
  147589. */
  147590. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  147591. /**
  147592. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  147593. * @param start world position
  147594. * @param end world position
  147595. * @returns array containing world position composing the path
  147596. */
  147597. computePath(start: Vector3, end: Vector3): Vector3[];
  147598. /**
  147599. * Create a new Crowd so you can add agents
  147600. * @param maxAgents the maximum agent count in the crowd
  147601. * @param maxAgentRadius the maximum radius an agent can have
  147602. * @param scene to attach the crowd to
  147603. * @returns the crowd you can add agents to
  147604. */
  147605. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  147606. /**
  147607. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  147608. * The queries will try to find a solution within those bounds
  147609. * default is (1,1,1)
  147610. * @param extent x,y,z value that define the extent around the queries point of reference
  147611. */
  147612. setDefaultQueryExtent(extent: Vector3): void;
  147613. /**
  147614. * Get the Bounding box extent specified by setDefaultQueryExtent
  147615. * @returns the box extent values
  147616. */
  147617. getDefaultQueryExtent(): Vector3;
  147618. /**
  147619. * build the navmesh from a previously saved state using getNavmeshData
  147620. * @param data the Uint8Array returned by getNavmeshData
  147621. */
  147622. buildFromNavmeshData(data: Uint8Array): void;
  147623. /**
  147624. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  147625. * @returns data the Uint8Array that can be saved and reused
  147626. */
  147627. getNavmeshData(): Uint8Array;
  147628. /**
  147629. * Get the Bounding box extent result specified by setDefaultQueryExtent
  147630. * @param result output the box extent values
  147631. */
  147632. getDefaultQueryExtentToRef(result: Vector3): void;
  147633. /**
  147634. * Disposes
  147635. */
  147636. dispose(): void;
  147637. /**
  147638. * If this plugin is supported
  147639. * @returns true if plugin is supported
  147640. */
  147641. isSupported(): boolean;
  147642. }
  147643. /**
  147644. * Recast detour crowd implementation
  147645. */
  147646. export class RecastJSCrowd implements ICrowd {
  147647. /**
  147648. * Recast/detour plugin
  147649. */
  147650. bjsRECASTPlugin: RecastJSPlugin;
  147651. /**
  147652. * Link to the detour crowd
  147653. */
  147654. recastCrowd: any;
  147655. /**
  147656. * One transform per agent
  147657. */
  147658. transforms: TransformNode[];
  147659. /**
  147660. * All agents created
  147661. */
  147662. agents: number[];
  147663. /**
  147664. * Link to the scene is kept to unregister the crowd from the scene
  147665. */
  147666. private _scene;
  147667. /**
  147668. * Observer for crowd updates
  147669. */
  147670. private _onBeforeAnimationsObserver;
  147671. /**
  147672. * Constructor
  147673. * @param plugin recastJS plugin
  147674. * @param maxAgents the maximum agent count in the crowd
  147675. * @param maxAgentRadius the maximum radius an agent can have
  147676. * @param scene to attach the crowd to
  147677. * @returns the crowd you can add agents to
  147678. */
  147679. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  147680. /**
  147681. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  147682. * You can attach anything to that node. The node position is updated in the scene update tick.
  147683. * @param pos world position that will be constrained by the navigation mesh
  147684. * @param parameters agent parameters
  147685. * @param transform hooked to the agent that will be update by the scene
  147686. * @returns agent index
  147687. */
  147688. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  147689. /**
  147690. * Returns the agent position in world space
  147691. * @param index agent index returned by addAgent
  147692. * @returns world space position
  147693. */
  147694. getAgentPosition(index: number): Vector3;
  147695. /**
  147696. * Returns the agent position result in world space
  147697. * @param index agent index returned by addAgent
  147698. * @param result output world space position
  147699. */
  147700. getAgentPositionToRef(index: number, result: Vector3): void;
  147701. /**
  147702. * Returns the agent velocity in world space
  147703. * @param index agent index returned by addAgent
  147704. * @returns world space velocity
  147705. */
  147706. getAgentVelocity(index: number): Vector3;
  147707. /**
  147708. * Returns the agent velocity result in world space
  147709. * @param index agent index returned by addAgent
  147710. * @param result output world space velocity
  147711. */
  147712. getAgentVelocityToRef(index: number, result: Vector3): void;
  147713. /**
  147714. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  147715. * @param index agent index returned by addAgent
  147716. * @param destination targeted world position
  147717. */
  147718. agentGoto(index: number, destination: Vector3): void;
  147719. /**
  147720. * Teleport the agent to a new position
  147721. * @param index agent index returned by addAgent
  147722. * @param destination targeted world position
  147723. */
  147724. agentTeleport(index: number, destination: Vector3): void;
  147725. /**
  147726. * Update agent parameters
  147727. * @param index agent index returned by addAgent
  147728. * @param parameters agent parameters
  147729. */
  147730. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  147731. /**
  147732. * remove a particular agent previously created
  147733. * @param index agent index returned by addAgent
  147734. */
  147735. removeAgent(index: number): void;
  147736. /**
  147737. * get the list of all agents attached to this crowd
  147738. * @returns list of agent indices
  147739. */
  147740. getAgents(): number[];
  147741. /**
  147742. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  147743. * @param deltaTime in seconds
  147744. */
  147745. update(deltaTime: number): void;
  147746. /**
  147747. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  147748. * The queries will try to find a solution within those bounds
  147749. * default is (1,1,1)
  147750. * @param extent x,y,z value that define the extent around the queries point of reference
  147751. */
  147752. setDefaultQueryExtent(extent: Vector3): void;
  147753. /**
  147754. * Get the Bounding box extent specified by setDefaultQueryExtent
  147755. * @returns the box extent values
  147756. */
  147757. getDefaultQueryExtent(): Vector3;
  147758. /**
  147759. * Get the Bounding box extent result specified by setDefaultQueryExtent
  147760. * @param result output the box extent values
  147761. */
  147762. getDefaultQueryExtentToRef(result: Vector3): void;
  147763. /**
  147764. * Release all resources
  147765. */
  147766. dispose(): void;
  147767. }
  147768. }
  147769. declare module BABYLON {
  147770. /**
  147771. * Class used to enable access to IndexedDB
  147772. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  147773. */
  147774. export class Database implements IOfflineProvider {
  147775. private _callbackManifestChecked;
  147776. private _currentSceneUrl;
  147777. private _db;
  147778. private _enableSceneOffline;
  147779. private _enableTexturesOffline;
  147780. private _manifestVersionFound;
  147781. private _mustUpdateRessources;
  147782. private _hasReachedQuota;
  147783. private _isSupported;
  147784. private _idbFactory;
  147785. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  147786. private static IsUASupportingBlobStorage;
  147787. /**
  147788. * Gets a boolean indicating if Database storate is enabled (off by default)
  147789. */
  147790. static IDBStorageEnabled: boolean;
  147791. /**
  147792. * Gets a boolean indicating if scene must be saved in the database
  147793. */
  147794. get enableSceneOffline(): boolean;
  147795. /**
  147796. * Gets a boolean indicating if textures must be saved in the database
  147797. */
  147798. get enableTexturesOffline(): boolean;
  147799. /**
  147800. * Creates a new Database
  147801. * @param urlToScene defines the url to load the scene
  147802. * @param callbackManifestChecked defines the callback to use when manifest is checked
  147803. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  147804. */
  147805. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  147806. private static _ParseURL;
  147807. private static _ReturnFullUrlLocation;
  147808. private _checkManifestFile;
  147809. /**
  147810. * Open the database and make it available
  147811. * @param successCallback defines the callback to call on success
  147812. * @param errorCallback defines the callback to call on error
  147813. */
  147814. open(successCallback: () => void, errorCallback: () => void): void;
  147815. /**
  147816. * Loads an image from the database
  147817. * @param url defines the url to load from
  147818. * @param image defines the target DOM image
  147819. */
  147820. loadImage(url: string, image: HTMLImageElement): void;
  147821. private _loadImageFromDBAsync;
  147822. private _saveImageIntoDBAsync;
  147823. private _checkVersionFromDB;
  147824. private _loadVersionFromDBAsync;
  147825. private _saveVersionIntoDBAsync;
  147826. /**
  147827. * Loads a file from database
  147828. * @param url defines the URL to load from
  147829. * @param sceneLoaded defines a callback to call on success
  147830. * @param progressCallBack defines a callback to call when progress changed
  147831. * @param errorCallback defines a callback to call on error
  147832. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  147833. */
  147834. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  147835. private _loadFileAsync;
  147836. private _saveFileAsync;
  147837. /**
  147838. * Validates if xhr data is correct
  147839. * @param xhr defines the request to validate
  147840. * @param dataType defines the expected data type
  147841. * @returns true if data is correct
  147842. */
  147843. private static _ValidateXHRData;
  147844. }
  147845. }
  147846. declare module BABYLON {
  147847. /** @hidden */
  147848. export var gpuUpdateParticlesPixelShader: {
  147849. name: string;
  147850. shader: string;
  147851. };
  147852. }
  147853. declare module BABYLON {
  147854. /** @hidden */
  147855. export var gpuUpdateParticlesVertexShader: {
  147856. name: string;
  147857. shader: string;
  147858. };
  147859. }
  147860. declare module BABYLON {
  147861. /** @hidden */
  147862. export var clipPlaneFragmentDeclaration2: {
  147863. name: string;
  147864. shader: string;
  147865. };
  147866. }
  147867. declare module BABYLON {
  147868. /** @hidden */
  147869. export var gpuRenderParticlesPixelShader: {
  147870. name: string;
  147871. shader: string;
  147872. };
  147873. }
  147874. declare module BABYLON {
  147875. /** @hidden */
  147876. export var clipPlaneVertexDeclaration2: {
  147877. name: string;
  147878. shader: string;
  147879. };
  147880. }
  147881. declare module BABYLON {
  147882. /** @hidden */
  147883. export var gpuRenderParticlesVertexShader: {
  147884. name: string;
  147885. shader: string;
  147886. };
  147887. }
  147888. declare module BABYLON {
  147889. /**
  147890. * This represents a GPU particle system in Babylon
  147891. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  147892. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  147893. */
  147894. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  147895. /**
  147896. * The layer mask we are rendering the particles through.
  147897. */
  147898. layerMask: number;
  147899. private _capacity;
  147900. private _activeCount;
  147901. private _currentActiveCount;
  147902. private _accumulatedCount;
  147903. private _renderEffect;
  147904. private _updateEffect;
  147905. private _buffer0;
  147906. private _buffer1;
  147907. private _spriteBuffer;
  147908. private _updateVAO;
  147909. private _renderVAO;
  147910. private _targetIndex;
  147911. private _sourceBuffer;
  147912. private _targetBuffer;
  147913. private _currentRenderId;
  147914. private _started;
  147915. private _stopped;
  147916. private _timeDelta;
  147917. private _randomTexture;
  147918. private _randomTexture2;
  147919. private _attributesStrideSize;
  147920. private _updateEffectOptions;
  147921. private _randomTextureSize;
  147922. private _actualFrame;
  147923. private _customEffect;
  147924. private readonly _rawTextureWidth;
  147925. /**
  147926. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  147927. */
  147928. static get IsSupported(): boolean;
  147929. /**
  147930. * An event triggered when the system is disposed.
  147931. */
  147932. onDisposeObservable: Observable<IParticleSystem>;
  147933. /**
  147934. * Gets the maximum number of particles active at the same time.
  147935. * @returns The max number of active particles.
  147936. */
  147937. getCapacity(): number;
  147938. /**
  147939. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  147940. * to override the particles.
  147941. */
  147942. forceDepthWrite: boolean;
  147943. /**
  147944. * Gets or set the number of active particles
  147945. */
  147946. get activeParticleCount(): number;
  147947. set activeParticleCount(value: number);
  147948. private _preWarmDone;
  147949. /**
  147950. * Specifies if the particles are updated in emitter local space or world space.
  147951. */
  147952. isLocal: boolean;
  147953. /** Gets or sets a matrix to use to compute projection */
  147954. defaultProjectionMatrix: Matrix;
  147955. /**
  147956. * Is this system ready to be used/rendered
  147957. * @return true if the system is ready
  147958. */
  147959. isReady(): boolean;
  147960. /**
  147961. * Gets if the system has been started. (Note: this will still be true after stop is called)
  147962. * @returns True if it has been started, otherwise false.
  147963. */
  147964. isStarted(): boolean;
  147965. /**
  147966. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  147967. * @returns True if it has been stopped, otherwise false.
  147968. */
  147969. isStopped(): boolean;
  147970. /**
  147971. * Gets a boolean indicating that the system is stopping
  147972. * @returns true if the system is currently stopping
  147973. */
  147974. isStopping(): boolean;
  147975. /**
  147976. * Gets the number of particles active at the same time.
  147977. * @returns The number of active particles.
  147978. */
  147979. getActiveCount(): number;
  147980. /**
  147981. * Starts the particle system and begins to emit
  147982. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  147983. */
  147984. start(delay?: number): void;
  147985. /**
  147986. * Stops the particle system.
  147987. */
  147988. stop(): void;
  147989. /**
  147990. * Remove all active particles
  147991. */
  147992. reset(): void;
  147993. /**
  147994. * Returns the string "GPUParticleSystem"
  147995. * @returns a string containing the class name
  147996. */
  147997. getClassName(): string;
  147998. /**
  147999. * Gets the custom effect used to render the particles
  148000. * @param blendMode Blend mode for which the effect should be retrieved
  148001. * @returns The effect
  148002. */
  148003. getCustomEffect(blendMode?: number): Nullable<Effect>;
  148004. /**
  148005. * Sets the custom effect used to render the particles
  148006. * @param effect The effect to set
  148007. * @param blendMode Blend mode for which the effect should be set
  148008. */
  148009. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  148010. /** @hidden */
  148011. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  148012. /**
  148013. * Observable that will be called just before the particles are drawn
  148014. */
  148015. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  148016. /**
  148017. * Gets the name of the particle vertex shader
  148018. */
  148019. get vertexShaderName(): string;
  148020. private _colorGradientsTexture;
  148021. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  148022. /**
  148023. * Adds a new color gradient
  148024. * @param gradient defines the gradient to use (between 0 and 1)
  148025. * @param color1 defines the color to affect to the specified gradient
  148026. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  148027. * @returns the current particle system
  148028. */
  148029. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  148030. private _refreshColorGradient;
  148031. /** Force the system to rebuild all gradients that need to be resync */
  148032. forceRefreshGradients(): void;
  148033. /**
  148034. * Remove a specific color gradient
  148035. * @param gradient defines the gradient to remove
  148036. * @returns the current particle system
  148037. */
  148038. removeColorGradient(gradient: number): GPUParticleSystem;
  148039. private _angularSpeedGradientsTexture;
  148040. private _sizeGradientsTexture;
  148041. private _velocityGradientsTexture;
  148042. private _limitVelocityGradientsTexture;
  148043. private _dragGradientsTexture;
  148044. private _addFactorGradient;
  148045. /**
  148046. * Adds a new size gradient
  148047. * @param gradient defines the gradient to use (between 0 and 1)
  148048. * @param factor defines the size factor to affect to the specified gradient
  148049. * @returns the current particle system
  148050. */
  148051. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  148052. /**
  148053. * Remove a specific size gradient
  148054. * @param gradient defines the gradient to remove
  148055. * @returns the current particle system
  148056. */
  148057. removeSizeGradient(gradient: number): GPUParticleSystem;
  148058. private _refreshFactorGradient;
  148059. /**
  148060. * Adds a new angular speed gradient
  148061. * @param gradient defines the gradient to use (between 0 and 1)
  148062. * @param factor defines the angular speed to affect to the specified gradient
  148063. * @returns the current particle system
  148064. */
  148065. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  148066. /**
  148067. * Remove a specific angular speed gradient
  148068. * @param gradient defines the gradient to remove
  148069. * @returns the current particle system
  148070. */
  148071. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  148072. /**
  148073. * Adds a new velocity gradient
  148074. * @param gradient defines the gradient to use (between 0 and 1)
  148075. * @param factor defines the velocity to affect to the specified gradient
  148076. * @returns the current particle system
  148077. */
  148078. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  148079. /**
  148080. * Remove a specific velocity gradient
  148081. * @param gradient defines the gradient to remove
  148082. * @returns the current particle system
  148083. */
  148084. removeVelocityGradient(gradient: number): GPUParticleSystem;
  148085. /**
  148086. * Adds a new limit velocity gradient
  148087. * @param gradient defines the gradient to use (between 0 and 1)
  148088. * @param factor defines the limit velocity value to affect to the specified gradient
  148089. * @returns the current particle system
  148090. */
  148091. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  148092. /**
  148093. * Remove a specific limit velocity gradient
  148094. * @param gradient defines the gradient to remove
  148095. * @returns the current particle system
  148096. */
  148097. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  148098. /**
  148099. * Adds a new drag gradient
  148100. * @param gradient defines the gradient to use (between 0 and 1)
  148101. * @param factor defines the drag value to affect to the specified gradient
  148102. * @returns the current particle system
  148103. */
  148104. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  148105. /**
  148106. * Remove a specific drag gradient
  148107. * @param gradient defines the gradient to remove
  148108. * @returns the current particle system
  148109. */
  148110. removeDragGradient(gradient: number): GPUParticleSystem;
  148111. /**
  148112. * Not supported by GPUParticleSystem
  148113. * @param gradient defines the gradient to use (between 0 and 1)
  148114. * @param factor defines the emit rate value to affect to the specified gradient
  148115. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  148116. * @returns the current particle system
  148117. */
  148118. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  148119. /**
  148120. * Not supported by GPUParticleSystem
  148121. * @param gradient defines the gradient to remove
  148122. * @returns the current particle system
  148123. */
  148124. removeEmitRateGradient(gradient: number): IParticleSystem;
  148125. /**
  148126. * Not supported by GPUParticleSystem
  148127. * @param gradient defines the gradient to use (between 0 and 1)
  148128. * @param factor defines the start size value to affect to the specified gradient
  148129. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  148130. * @returns the current particle system
  148131. */
  148132. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  148133. /**
  148134. * Not supported by GPUParticleSystem
  148135. * @param gradient defines the gradient to remove
  148136. * @returns the current particle system
  148137. */
  148138. removeStartSizeGradient(gradient: number): IParticleSystem;
  148139. /**
  148140. * Not supported by GPUParticleSystem
  148141. * @param gradient defines the gradient to use (between 0 and 1)
  148142. * @param min defines the color remap minimal range
  148143. * @param max defines the color remap maximal range
  148144. * @returns the current particle system
  148145. */
  148146. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  148147. /**
  148148. * Not supported by GPUParticleSystem
  148149. * @param gradient defines the gradient to remove
  148150. * @returns the current particle system
  148151. */
  148152. removeColorRemapGradient(): IParticleSystem;
  148153. /**
  148154. * Not supported by GPUParticleSystem
  148155. * @param gradient defines the gradient to use (between 0 and 1)
  148156. * @param min defines the alpha remap minimal range
  148157. * @param max defines the alpha remap maximal range
  148158. * @returns the current particle system
  148159. */
  148160. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  148161. /**
  148162. * Not supported by GPUParticleSystem
  148163. * @param gradient defines the gradient to remove
  148164. * @returns the current particle system
  148165. */
  148166. removeAlphaRemapGradient(): IParticleSystem;
  148167. /**
  148168. * Not supported by GPUParticleSystem
  148169. * @param gradient defines the gradient to use (between 0 and 1)
  148170. * @param color defines the color to affect to the specified gradient
  148171. * @returns the current particle system
  148172. */
  148173. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  148174. /**
  148175. * Not supported by GPUParticleSystem
  148176. * @param gradient defines the gradient to remove
  148177. * @returns the current particle system
  148178. */
  148179. removeRampGradient(): IParticleSystem;
  148180. /**
  148181. * Not supported by GPUParticleSystem
  148182. * @returns the list of ramp gradients
  148183. */
  148184. getRampGradients(): Nullable<Array<Color3Gradient>>;
  148185. /**
  148186. * Not supported by GPUParticleSystem
  148187. * Gets or sets a boolean indicating that ramp gradients must be used
  148188. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  148189. */
  148190. get useRampGradients(): boolean;
  148191. set useRampGradients(value: boolean);
  148192. /**
  148193. * Not supported by GPUParticleSystem
  148194. * @param gradient defines the gradient to use (between 0 and 1)
  148195. * @param factor defines the life time factor to affect to the specified gradient
  148196. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  148197. * @returns the current particle system
  148198. */
  148199. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  148200. /**
  148201. * Not supported by GPUParticleSystem
  148202. * @param gradient defines the gradient to remove
  148203. * @returns the current particle system
  148204. */
  148205. removeLifeTimeGradient(gradient: number): IParticleSystem;
  148206. /**
  148207. * Instantiates a GPU particle system.
  148208. * 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.
  148209. * @param name The name of the particle system
  148210. * @param options The options used to create the system
  148211. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  148212. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  148213. * @param customEffect a custom effect used to change the way particles are rendered by default
  148214. */
  148215. constructor(name: string, options: Partial<{
  148216. capacity: number;
  148217. randomTextureSize: number;
  148218. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  148219. protected _reset(): void;
  148220. private _createUpdateVAO;
  148221. private _createRenderVAO;
  148222. private _initialize;
  148223. /** @hidden */
  148224. _recreateUpdateEffect(): void;
  148225. private _getEffect;
  148226. /**
  148227. * Fill the defines array according to the current settings of the particle system
  148228. * @param defines Array to be updated
  148229. * @param blendMode blend mode to take into account when updating the array
  148230. */
  148231. fillDefines(defines: Array<string>, blendMode?: number): void;
  148232. /**
  148233. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  148234. * @param uniforms Uniforms array to fill
  148235. * @param attributes Attributes array to fill
  148236. * @param samplers Samplers array to fill
  148237. */
  148238. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  148239. /** @hidden */
  148240. _recreateRenderEffect(): Effect;
  148241. /**
  148242. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  148243. * @param preWarm defines if we are in the pre-warmimg phase
  148244. */
  148245. animate(preWarm?: boolean): void;
  148246. private _createFactorGradientTexture;
  148247. private _createSizeGradientTexture;
  148248. private _createAngularSpeedGradientTexture;
  148249. private _createVelocityGradientTexture;
  148250. private _createLimitVelocityGradientTexture;
  148251. private _createDragGradientTexture;
  148252. private _createColorGradientTexture;
  148253. /**
  148254. * Renders the particle system in its current state
  148255. * @param preWarm defines if the system should only update the particles but not render them
  148256. * @returns the current number of particles
  148257. */
  148258. render(preWarm?: boolean): number;
  148259. /**
  148260. * Rebuilds the particle system
  148261. */
  148262. rebuild(): void;
  148263. private _releaseBuffers;
  148264. private _releaseVAOs;
  148265. /**
  148266. * Disposes the particle system and free the associated resources
  148267. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  148268. */
  148269. dispose(disposeTexture?: boolean): void;
  148270. /**
  148271. * Clones the particle system.
  148272. * @param name The name of the cloned object
  148273. * @param newEmitter The new emitter to use
  148274. * @returns the cloned particle system
  148275. */
  148276. clone(name: string, newEmitter: any): GPUParticleSystem;
  148277. /**
  148278. * Serializes the particle system to a JSON object
  148279. * @param serializeTexture defines if the texture must be serialized as well
  148280. * @returns the JSON object
  148281. */
  148282. serialize(serializeTexture?: boolean): any;
  148283. /**
  148284. * Parses a JSON object to create a GPU particle system.
  148285. * @param parsedParticleSystem The JSON object to parse
  148286. * @param sceneOrEngine The scene or the engine to create the particle system in
  148287. * @param rootUrl The root url to use to load external dependencies like texture
  148288. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  148289. * @returns the parsed GPU particle system
  148290. */
  148291. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  148292. }
  148293. }
  148294. declare module BABYLON {
  148295. /**
  148296. * Represents a set of particle systems working together to create a specific effect
  148297. */
  148298. export class ParticleSystemSet implements IDisposable {
  148299. /**
  148300. * Gets or sets base Assets URL
  148301. */
  148302. static BaseAssetsUrl: string;
  148303. private _emitterCreationOptions;
  148304. private _emitterNode;
  148305. /**
  148306. * Gets the particle system list
  148307. */
  148308. systems: IParticleSystem[];
  148309. /**
  148310. * Gets the emitter node used with this set
  148311. */
  148312. get emitterNode(): Nullable<TransformNode>;
  148313. /**
  148314. * Creates a new emitter mesh as a sphere
  148315. * @param options defines the options used to create the sphere
  148316. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  148317. * @param scene defines the hosting scene
  148318. */
  148319. setEmitterAsSphere(options: {
  148320. diameter: number;
  148321. segments: number;
  148322. color: Color3;
  148323. }, renderingGroupId: number, scene: Scene): void;
  148324. /**
  148325. * Starts all particle systems of the set
  148326. * @param emitter defines an optional mesh to use as emitter for the particle systems
  148327. */
  148328. start(emitter?: AbstractMesh): void;
  148329. /**
  148330. * Release all associated resources
  148331. */
  148332. dispose(): void;
  148333. /**
  148334. * Serialize the set into a JSON compatible object
  148335. * @param serializeTexture defines if the texture must be serialized as well
  148336. * @returns a JSON compatible representation of the set
  148337. */
  148338. serialize(serializeTexture?: boolean): any;
  148339. /**
  148340. * Parse a new ParticleSystemSet from a serialized source
  148341. * @param data defines a JSON compatible representation of the set
  148342. * @param scene defines the hosting scene
  148343. * @param gpu defines if we want GPU particles or CPU particles
  148344. * @returns a new ParticleSystemSet
  148345. */
  148346. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  148347. }
  148348. }
  148349. declare module BABYLON {
  148350. /**
  148351. * This class is made for on one-liner static method to help creating particle system set.
  148352. */
  148353. export class ParticleHelper {
  148354. /**
  148355. * Gets or sets base Assets URL
  148356. */
  148357. static BaseAssetsUrl: string;
  148358. /** Define the Url to load snippets */
  148359. static SnippetUrl: string;
  148360. /**
  148361. * Create a default particle system that you can tweak
  148362. * @param emitter defines the emitter to use
  148363. * @param capacity defines the system capacity (default is 500 particles)
  148364. * @param scene defines the hosting scene
  148365. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  148366. * @returns the new Particle system
  148367. */
  148368. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  148369. /**
  148370. * This is the main static method (one-liner) of this helper to create different particle systems
  148371. * @param type This string represents the type to the particle system to create
  148372. * @param scene The scene where the particle system should live
  148373. * @param gpu If the system will use gpu
  148374. * @returns the ParticleSystemSet created
  148375. */
  148376. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  148377. /**
  148378. * Static function used to export a particle system to a ParticleSystemSet variable.
  148379. * Please note that the emitter shape is not exported
  148380. * @param systems defines the particle systems to export
  148381. * @returns the created particle system set
  148382. */
  148383. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  148384. /**
  148385. * Creates a particle system from a snippet saved in a remote file
  148386. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  148387. * @param url defines the url to load from
  148388. * @param scene defines the hosting scene
  148389. * @param gpu If the system will use gpu
  148390. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  148391. * @returns a promise that will resolve to the new particle system
  148392. */
  148393. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  148394. /**
  148395. * Creates a particle system from a snippet saved by the particle system editor
  148396. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  148397. * @param scene defines the hosting scene
  148398. * @param gpu If the system will use gpu
  148399. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  148400. * @returns a promise that will resolve to the new particle system
  148401. */
  148402. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  148403. }
  148404. }
  148405. declare module BABYLON {
  148406. interface Engine {
  148407. /**
  148408. * Create an effect to use with particle systems.
  148409. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  148410. * the particle system for which you want to create a custom effect in the last parameter
  148411. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  148412. * @param uniformsNames defines a list of attribute names
  148413. * @param samplers defines an array of string used to represent textures
  148414. * @param defines defines the string containing the defines to use to compile the shaders
  148415. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  148416. * @param onCompiled defines a function to call when the effect creation is successful
  148417. * @param onError defines a function to call when the effect creation has failed
  148418. * @param particleSystem the particle system you want to create the effect for
  148419. * @returns the new Effect
  148420. */
  148421. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  148422. }
  148423. interface Mesh {
  148424. /**
  148425. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  148426. * @returns an array of IParticleSystem
  148427. */
  148428. getEmittedParticleSystems(): IParticleSystem[];
  148429. /**
  148430. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  148431. * @returns an array of IParticleSystem
  148432. */
  148433. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  148434. }
  148435. }
  148436. declare module BABYLON {
  148437. /** Defines the 4 color options */
  148438. export enum PointColor {
  148439. /** color value */
  148440. Color = 2,
  148441. /** uv value */
  148442. UV = 1,
  148443. /** random value */
  148444. Random = 0,
  148445. /** stated value */
  148446. Stated = 3
  148447. }
  148448. /**
  148449. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  148450. * 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.
  148451. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  148452. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  148453. *
  148454. * Full documentation here : TO BE ENTERED
  148455. */
  148456. export class PointsCloudSystem implements IDisposable {
  148457. /**
  148458. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  148459. * Example : var p = SPS.particles[i];
  148460. */
  148461. particles: CloudPoint[];
  148462. /**
  148463. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  148464. */
  148465. nbParticles: number;
  148466. /**
  148467. * This a counter for your own usage. It's not set by any SPS functions.
  148468. */
  148469. counter: number;
  148470. /**
  148471. * The PCS name. This name is also given to the underlying mesh.
  148472. */
  148473. name: string;
  148474. /**
  148475. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  148476. */
  148477. mesh: Mesh;
  148478. /**
  148479. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  148480. * Please read :
  148481. */
  148482. vars: any;
  148483. /**
  148484. * @hidden
  148485. */
  148486. _size: number;
  148487. private _scene;
  148488. private _promises;
  148489. private _positions;
  148490. private _indices;
  148491. private _normals;
  148492. private _colors;
  148493. private _uvs;
  148494. private _indices32;
  148495. private _positions32;
  148496. private _colors32;
  148497. private _uvs32;
  148498. private _updatable;
  148499. private _isVisibilityBoxLocked;
  148500. private _alwaysVisible;
  148501. private _groups;
  148502. private _groupCounter;
  148503. private _computeParticleColor;
  148504. private _computeParticleTexture;
  148505. private _computeParticleRotation;
  148506. private _computeBoundingBox;
  148507. private _isReady;
  148508. /**
  148509. * Creates a PCS (Points Cloud System) object
  148510. * @param name (String) is the PCS name, this will be the underlying mesh name
  148511. * @param pointSize (number) is the size for each point
  148512. * @param scene (Scene) is the scene in which the PCS is added
  148513. * @param options defines the options of the PCS e.g.
  148514. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  148515. */
  148516. constructor(name: string, pointSize: number, scene: Scene, options?: {
  148517. updatable?: boolean;
  148518. });
  148519. /**
  148520. * Builds the PCS underlying mesh. Returns a standard Mesh.
  148521. * If no points were added to the PCS, the returned mesh is just a single point.
  148522. * @returns a promise for the created mesh
  148523. */
  148524. buildMeshAsync(): Promise<Mesh>;
  148525. /**
  148526. * @hidden
  148527. */
  148528. private _buildMesh;
  148529. private _addParticle;
  148530. private _randomUnitVector;
  148531. private _getColorIndicesForCoord;
  148532. private _setPointsColorOrUV;
  148533. private _colorFromTexture;
  148534. private _calculateDensity;
  148535. /**
  148536. * Adds points to the PCS in random positions within a unit sphere
  148537. * @param nb (positive integer) the number of particles to be created from this model
  148538. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  148539. * @returns the number of groups in the system
  148540. */
  148541. addPoints(nb: number, pointFunction?: any): number;
  148542. /**
  148543. * Adds points to the PCS from the surface of the model shape
  148544. * @param mesh is any Mesh object that will be used as a surface model for the points
  148545. * @param nb (positive integer) the number of particles to be created from this model
  148546. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  148547. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  148548. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  148549. * @returns the number of groups in the system
  148550. */
  148551. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  148552. /**
  148553. * Adds points to the PCS inside the model shape
  148554. * @param mesh is any Mesh object that will be used as a surface model for the points
  148555. * @param nb (positive integer) the number of particles to be created from this model
  148556. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  148557. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  148558. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  148559. * @returns the number of groups in the system
  148560. */
  148561. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  148562. /**
  148563. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  148564. * This method calls `updateParticle()` for each particle of the SPS.
  148565. * For an animated SPS, it is usually called within the render loop.
  148566. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  148567. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  148568. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  148569. * @returns the PCS.
  148570. */
  148571. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  148572. /**
  148573. * Disposes the PCS.
  148574. */
  148575. dispose(): void;
  148576. /**
  148577. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  148578. * doc :
  148579. * @returns the PCS.
  148580. */
  148581. refreshVisibleSize(): PointsCloudSystem;
  148582. /**
  148583. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  148584. * @param size the size (float) of the visibility box
  148585. * note : this doesn't lock the PCS mesh bounding box.
  148586. * doc :
  148587. */
  148588. setVisibilityBox(size: number): void;
  148589. /**
  148590. * Gets whether the PCS is always visible or not
  148591. * doc :
  148592. */
  148593. get isAlwaysVisible(): boolean;
  148594. /**
  148595. * Sets the PCS as always visible or not
  148596. * doc :
  148597. */
  148598. set isAlwaysVisible(val: boolean);
  148599. /**
  148600. * Tells to `setParticles()` to compute the particle rotations or not
  148601. * Default value : false. The PCS is faster when it's set to false
  148602. * Note : particle rotations are only applied to parent particles
  148603. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  148604. */
  148605. set computeParticleRotation(val: boolean);
  148606. /**
  148607. * Tells to `setParticles()` to compute the particle colors or not.
  148608. * Default value : true. The PCS is faster when it's set to false.
  148609. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  148610. */
  148611. set computeParticleColor(val: boolean);
  148612. set computeParticleTexture(val: boolean);
  148613. /**
  148614. * Gets if `setParticles()` computes the particle colors or not.
  148615. * Default value : false. The PCS is faster when it's set to false.
  148616. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  148617. */
  148618. get computeParticleColor(): boolean;
  148619. /**
  148620. * Gets if `setParticles()` computes the particle textures or not.
  148621. * Default value : false. The PCS is faster when it's set to false.
  148622. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  148623. */
  148624. get computeParticleTexture(): boolean;
  148625. /**
  148626. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  148627. */
  148628. set computeBoundingBox(val: boolean);
  148629. /**
  148630. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  148631. */
  148632. get computeBoundingBox(): boolean;
  148633. /**
  148634. * This function does nothing. It may be overwritten to set all the particle first values.
  148635. * The PCS doesn't call this function, you may have to call it by your own.
  148636. * doc :
  148637. */
  148638. initParticles(): void;
  148639. /**
  148640. * This function does nothing. It may be overwritten to recycle a particle
  148641. * The PCS doesn't call this function, you can to call it
  148642. * doc :
  148643. * @param particle The particle to recycle
  148644. * @returns the recycled particle
  148645. */
  148646. recycleParticle(particle: CloudPoint): CloudPoint;
  148647. /**
  148648. * Updates a particle : this function should be overwritten by the user.
  148649. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  148650. * doc :
  148651. * @example : just set a particle position or velocity and recycle conditions
  148652. * @param particle The particle to update
  148653. * @returns the updated particle
  148654. */
  148655. updateParticle(particle: CloudPoint): CloudPoint;
  148656. /**
  148657. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  148658. * This does nothing and may be overwritten by the user.
  148659. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  148660. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  148661. * @param update the boolean update value actually passed to setParticles()
  148662. */
  148663. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  148664. /**
  148665. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  148666. * This will be passed three parameters.
  148667. * This does nothing and may be overwritten by the user.
  148668. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  148669. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  148670. * @param update the boolean update value actually passed to setParticles()
  148671. */
  148672. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  148673. }
  148674. }
  148675. declare module BABYLON {
  148676. /**
  148677. * Represents one particle of a points cloud system.
  148678. */
  148679. export class CloudPoint {
  148680. /**
  148681. * particle global index
  148682. */
  148683. idx: number;
  148684. /**
  148685. * The color of the particle
  148686. */
  148687. color: Nullable<Color4>;
  148688. /**
  148689. * The world space position of the particle.
  148690. */
  148691. position: Vector3;
  148692. /**
  148693. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  148694. */
  148695. rotation: Vector3;
  148696. /**
  148697. * The world space rotation quaternion of the particle.
  148698. */
  148699. rotationQuaternion: Nullable<Quaternion>;
  148700. /**
  148701. * The uv of the particle.
  148702. */
  148703. uv: Nullable<Vector2>;
  148704. /**
  148705. * The current speed of the particle.
  148706. */
  148707. velocity: Vector3;
  148708. /**
  148709. * The pivot point in the particle local space.
  148710. */
  148711. pivot: Vector3;
  148712. /**
  148713. * Must the particle be translated from its pivot point in its local space ?
  148714. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  148715. * Default : false
  148716. */
  148717. translateFromPivot: boolean;
  148718. /**
  148719. * Index of this particle in the global "positions" array (Internal use)
  148720. * @hidden
  148721. */
  148722. _pos: number;
  148723. /**
  148724. * @hidden Index of this particle in the global "indices" array (Internal use)
  148725. */
  148726. _ind: number;
  148727. /**
  148728. * Group this particle belongs to
  148729. */
  148730. _group: PointsGroup;
  148731. /**
  148732. * Group id of this particle
  148733. */
  148734. groupId: number;
  148735. /**
  148736. * Index of the particle in its group id (Internal use)
  148737. */
  148738. idxInGroup: number;
  148739. /**
  148740. * @hidden Particle BoundingInfo object (Internal use)
  148741. */
  148742. _boundingInfo: BoundingInfo;
  148743. /**
  148744. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  148745. */
  148746. _pcs: PointsCloudSystem;
  148747. /**
  148748. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  148749. */
  148750. _stillInvisible: boolean;
  148751. /**
  148752. * @hidden Last computed particle rotation matrix
  148753. */
  148754. _rotationMatrix: number[];
  148755. /**
  148756. * Parent particle Id, if any.
  148757. * Default null.
  148758. */
  148759. parentId: Nullable<number>;
  148760. /**
  148761. * @hidden Internal global position in the PCS.
  148762. */
  148763. _globalPosition: Vector3;
  148764. /**
  148765. * Creates a Point Cloud object.
  148766. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  148767. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  148768. * @param group (PointsGroup) is the group the particle belongs to
  148769. * @param groupId (integer) is the group identifier in the PCS.
  148770. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  148771. * @param pcs defines the PCS it is associated to
  148772. */
  148773. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  148774. /**
  148775. * get point size
  148776. */
  148777. get size(): Vector3;
  148778. /**
  148779. * Set point size
  148780. */
  148781. set size(scale: Vector3);
  148782. /**
  148783. * Legacy support, changed quaternion to rotationQuaternion
  148784. */
  148785. get quaternion(): Nullable<Quaternion>;
  148786. /**
  148787. * Legacy support, changed quaternion to rotationQuaternion
  148788. */
  148789. set quaternion(q: Nullable<Quaternion>);
  148790. /**
  148791. * Returns a boolean. True if the particle intersects a mesh, else false
  148792. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  148793. * @param target is the object (point or mesh) what the intersection is computed against
  148794. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  148795. * @returns true if it intersects
  148796. */
  148797. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  148798. /**
  148799. * get the rotation matrix of the particle
  148800. * @hidden
  148801. */
  148802. getRotationMatrix(m: Matrix): void;
  148803. }
  148804. /**
  148805. * Represents a group of points in a points cloud system
  148806. * * PCS internal tool, don't use it manually.
  148807. */
  148808. export class PointsGroup {
  148809. /**
  148810. * The group id
  148811. * @hidden
  148812. */
  148813. groupID: number;
  148814. /**
  148815. * image data for group (internal use)
  148816. * @hidden
  148817. */
  148818. _groupImageData: Nullable<ArrayBufferView>;
  148819. /**
  148820. * Image Width (internal use)
  148821. * @hidden
  148822. */
  148823. _groupImgWidth: number;
  148824. /**
  148825. * Image Height (internal use)
  148826. * @hidden
  148827. */
  148828. _groupImgHeight: number;
  148829. /**
  148830. * Custom position function (internal use)
  148831. * @hidden
  148832. */
  148833. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  148834. /**
  148835. * density per facet for surface points
  148836. * @hidden
  148837. */
  148838. _groupDensity: number[];
  148839. /**
  148840. * Only when points are colored by texture carries pointer to texture list array
  148841. * @hidden
  148842. */
  148843. _textureNb: number;
  148844. /**
  148845. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  148846. * PCS internal tool, don't use it manually.
  148847. * @hidden
  148848. */
  148849. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  148850. }
  148851. }
  148852. declare module BABYLON {
  148853. interface Scene {
  148854. /** @hidden (Backing field) */
  148855. _physicsEngine: Nullable<IPhysicsEngine>;
  148856. /** @hidden */
  148857. _physicsTimeAccumulator: number;
  148858. /**
  148859. * Gets the current physics engine
  148860. * @returns a IPhysicsEngine or null if none attached
  148861. */
  148862. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  148863. /**
  148864. * Enables physics to the current scene
  148865. * @param gravity defines the scene's gravity for the physics engine
  148866. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  148867. * @return a boolean indicating if the physics engine was initialized
  148868. */
  148869. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  148870. /**
  148871. * Disables and disposes the physics engine associated with the scene
  148872. */
  148873. disablePhysicsEngine(): void;
  148874. /**
  148875. * Gets a boolean indicating if there is an active physics engine
  148876. * @returns a boolean indicating if there is an active physics engine
  148877. */
  148878. isPhysicsEnabled(): boolean;
  148879. /**
  148880. * Deletes a physics compound impostor
  148881. * @param compound defines the compound to delete
  148882. */
  148883. deleteCompoundImpostor(compound: any): void;
  148884. /**
  148885. * An event triggered when physic simulation is about to be run
  148886. */
  148887. onBeforePhysicsObservable: Observable<Scene>;
  148888. /**
  148889. * An event triggered when physic simulation has been done
  148890. */
  148891. onAfterPhysicsObservable: Observable<Scene>;
  148892. }
  148893. interface AbstractMesh {
  148894. /** @hidden */
  148895. _physicsImpostor: Nullable<PhysicsImpostor>;
  148896. /**
  148897. * Gets or sets impostor used for physic simulation
  148898. * @see https://doc.babylonjs.com/features/physics_engine
  148899. */
  148900. physicsImpostor: Nullable<PhysicsImpostor>;
  148901. /**
  148902. * Gets the current physics impostor
  148903. * @see https://doc.babylonjs.com/features/physics_engine
  148904. * @returns a physics impostor or null
  148905. */
  148906. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  148907. /** Apply a physic impulse to the mesh
  148908. * @param force defines the force to apply
  148909. * @param contactPoint defines where to apply the force
  148910. * @returns the current mesh
  148911. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  148912. */
  148913. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  148914. /**
  148915. * Creates a physic joint between two meshes
  148916. * @param otherMesh defines the other mesh to use
  148917. * @param pivot1 defines the pivot to use on this mesh
  148918. * @param pivot2 defines the pivot to use on the other mesh
  148919. * @param options defines additional options (can be plugin dependent)
  148920. * @returns the current mesh
  148921. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  148922. */
  148923. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  148924. /** @hidden */
  148925. _disposePhysicsObserver: Nullable<Observer<Node>>;
  148926. }
  148927. /**
  148928. * Defines the physics engine scene component responsible to manage a physics engine
  148929. */
  148930. export class PhysicsEngineSceneComponent implements ISceneComponent {
  148931. /**
  148932. * The component name helpful to identify the component in the list of scene components.
  148933. */
  148934. readonly name: string;
  148935. /**
  148936. * The scene the component belongs to.
  148937. */
  148938. scene: Scene;
  148939. /**
  148940. * Creates a new instance of the component for the given scene
  148941. * @param scene Defines the scene to register the component in
  148942. */
  148943. constructor(scene: Scene);
  148944. /**
  148945. * Registers the component in a given scene
  148946. */
  148947. register(): void;
  148948. /**
  148949. * Rebuilds the elements related to this component in case of
  148950. * context lost for instance.
  148951. */
  148952. rebuild(): void;
  148953. /**
  148954. * Disposes the component and the associated ressources
  148955. */
  148956. dispose(): void;
  148957. }
  148958. }
  148959. declare module BABYLON {
  148960. /**
  148961. * A helper for physics simulations
  148962. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148963. */
  148964. export class PhysicsHelper {
  148965. private _scene;
  148966. private _physicsEngine;
  148967. /**
  148968. * Initializes the Physics helper
  148969. * @param scene Babylon.js scene
  148970. */
  148971. constructor(scene: Scene);
  148972. /**
  148973. * Applies a radial explosion impulse
  148974. * @param origin the origin of the explosion
  148975. * @param radiusOrEventOptions the radius or the options of radial explosion
  148976. * @param strength the explosion strength
  148977. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148978. * @returns A physics radial explosion event, or null
  148979. */
  148980. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  148981. /**
  148982. * Applies a radial explosion force
  148983. * @param origin the origin of the explosion
  148984. * @param radiusOrEventOptions the radius or the options of radial explosion
  148985. * @param strength the explosion strength
  148986. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148987. * @returns A physics radial explosion event, or null
  148988. */
  148989. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  148990. /**
  148991. * Creates a gravitational field
  148992. * @param origin the origin of the explosion
  148993. * @param radiusOrEventOptions the radius or the options of radial explosion
  148994. * @param strength the explosion strength
  148995. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148996. * @returns A physics gravitational field event, or null
  148997. */
  148998. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  148999. /**
  149000. * Creates a physics updraft event
  149001. * @param origin the origin of the updraft
  149002. * @param radiusOrEventOptions the radius or the options of the updraft
  149003. * @param strength the strength of the updraft
  149004. * @param height the height of the updraft
  149005. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  149006. * @returns A physics updraft event, or null
  149007. */
  149008. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  149009. /**
  149010. * Creates a physics vortex event
  149011. * @param origin the of the vortex
  149012. * @param radiusOrEventOptions the radius or the options of the vortex
  149013. * @param strength the strength of the vortex
  149014. * @param height the height of the vortex
  149015. * @returns a Physics vortex event, or null
  149016. * A physics vortex event or null
  149017. */
  149018. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  149019. }
  149020. /**
  149021. * Represents a physics radial explosion event
  149022. */
  149023. class PhysicsRadialExplosionEvent {
  149024. private _scene;
  149025. private _options;
  149026. private _sphere;
  149027. private _dataFetched;
  149028. /**
  149029. * Initializes a radial explosioin event
  149030. * @param _scene BabylonJS scene
  149031. * @param _options The options for the vortex event
  149032. */
  149033. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  149034. /**
  149035. * Returns the data related to the radial explosion event (sphere).
  149036. * @returns The radial explosion event data
  149037. */
  149038. getData(): PhysicsRadialExplosionEventData;
  149039. /**
  149040. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  149041. * @param impostor A physics imposter
  149042. * @param origin the origin of the explosion
  149043. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  149044. */
  149045. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  149046. /**
  149047. * Triggers affecterd impostors callbacks
  149048. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  149049. */
  149050. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  149051. /**
  149052. * Disposes the sphere.
  149053. * @param force Specifies if the sphere should be disposed by force
  149054. */
  149055. dispose(force?: boolean): void;
  149056. /*** Helpers ***/
  149057. private _prepareSphere;
  149058. private _intersectsWithSphere;
  149059. }
  149060. /**
  149061. * Represents a gravitational field event
  149062. */
  149063. class PhysicsGravitationalFieldEvent {
  149064. private _physicsHelper;
  149065. private _scene;
  149066. private _origin;
  149067. private _options;
  149068. private _tickCallback;
  149069. private _sphere;
  149070. private _dataFetched;
  149071. /**
  149072. * Initializes the physics gravitational field event
  149073. * @param _physicsHelper A physics helper
  149074. * @param _scene BabylonJS scene
  149075. * @param _origin The origin position of the gravitational field event
  149076. * @param _options The options for the vortex event
  149077. */
  149078. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  149079. /**
  149080. * Returns the data related to the gravitational field event (sphere).
  149081. * @returns A gravitational field event
  149082. */
  149083. getData(): PhysicsGravitationalFieldEventData;
  149084. /**
  149085. * Enables the gravitational field.
  149086. */
  149087. enable(): void;
  149088. /**
  149089. * Disables the gravitational field.
  149090. */
  149091. disable(): void;
  149092. /**
  149093. * Disposes the sphere.
  149094. * @param force The force to dispose from the gravitational field event
  149095. */
  149096. dispose(force?: boolean): void;
  149097. private _tick;
  149098. }
  149099. /**
  149100. * Represents a physics updraft event
  149101. */
  149102. class PhysicsUpdraftEvent {
  149103. private _scene;
  149104. private _origin;
  149105. private _options;
  149106. private _physicsEngine;
  149107. private _originTop;
  149108. private _originDirection;
  149109. private _tickCallback;
  149110. private _cylinder;
  149111. private _cylinderPosition;
  149112. private _dataFetched;
  149113. /**
  149114. * Initializes the physics updraft event
  149115. * @param _scene BabylonJS scene
  149116. * @param _origin The origin position of the updraft
  149117. * @param _options The options for the updraft event
  149118. */
  149119. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  149120. /**
  149121. * Returns the data related to the updraft event (cylinder).
  149122. * @returns A physics updraft event
  149123. */
  149124. getData(): PhysicsUpdraftEventData;
  149125. /**
  149126. * Enables the updraft.
  149127. */
  149128. enable(): void;
  149129. /**
  149130. * Disables the updraft.
  149131. */
  149132. disable(): void;
  149133. /**
  149134. * Disposes the cylinder.
  149135. * @param force Specifies if the updraft should be disposed by force
  149136. */
  149137. dispose(force?: boolean): void;
  149138. private getImpostorHitData;
  149139. private _tick;
  149140. /*** Helpers ***/
  149141. private _prepareCylinder;
  149142. private _intersectsWithCylinder;
  149143. }
  149144. /**
  149145. * Represents a physics vortex event
  149146. */
  149147. class PhysicsVortexEvent {
  149148. private _scene;
  149149. private _origin;
  149150. private _options;
  149151. private _physicsEngine;
  149152. private _originTop;
  149153. private _tickCallback;
  149154. private _cylinder;
  149155. private _cylinderPosition;
  149156. private _dataFetched;
  149157. /**
  149158. * Initializes the physics vortex event
  149159. * @param _scene The BabylonJS scene
  149160. * @param _origin The origin position of the vortex
  149161. * @param _options The options for the vortex event
  149162. */
  149163. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  149164. /**
  149165. * Returns the data related to the vortex event (cylinder).
  149166. * @returns The physics vortex event data
  149167. */
  149168. getData(): PhysicsVortexEventData;
  149169. /**
  149170. * Enables the vortex.
  149171. */
  149172. enable(): void;
  149173. /**
  149174. * Disables the cortex.
  149175. */
  149176. disable(): void;
  149177. /**
  149178. * Disposes the sphere.
  149179. * @param force
  149180. */
  149181. dispose(force?: boolean): void;
  149182. private getImpostorHitData;
  149183. private _tick;
  149184. /*** Helpers ***/
  149185. private _prepareCylinder;
  149186. private _intersectsWithCylinder;
  149187. }
  149188. /**
  149189. * Options fot the radial explosion event
  149190. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  149191. */
  149192. export class PhysicsRadialExplosionEventOptions {
  149193. /**
  149194. * The radius of the sphere for the radial explosion.
  149195. */
  149196. radius: number;
  149197. /**
  149198. * The strenth of the explosion.
  149199. */
  149200. strength: number;
  149201. /**
  149202. * The strenght of the force in correspondence to the distance of the affected object
  149203. */
  149204. falloff: PhysicsRadialImpulseFalloff;
  149205. /**
  149206. * Sphere options for the radial explosion.
  149207. */
  149208. sphere: {
  149209. segments: number;
  149210. diameter: number;
  149211. };
  149212. /**
  149213. * Sphere options for the radial explosion.
  149214. */
  149215. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  149216. }
  149217. /**
  149218. * Options fot the updraft event
  149219. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  149220. */
  149221. export class PhysicsUpdraftEventOptions {
  149222. /**
  149223. * The radius of the cylinder for the vortex
  149224. */
  149225. radius: number;
  149226. /**
  149227. * The strenth of the updraft.
  149228. */
  149229. strength: number;
  149230. /**
  149231. * The height of the cylinder for the updraft.
  149232. */
  149233. height: number;
  149234. /**
  149235. * The mode for the the updraft.
  149236. */
  149237. updraftMode: PhysicsUpdraftMode;
  149238. }
  149239. /**
  149240. * Options fot the vortex event
  149241. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  149242. */
  149243. export class PhysicsVortexEventOptions {
  149244. /**
  149245. * The radius of the cylinder for the vortex
  149246. */
  149247. radius: number;
  149248. /**
  149249. * The strenth of the vortex.
  149250. */
  149251. strength: number;
  149252. /**
  149253. * The height of the cylinder for the vortex.
  149254. */
  149255. height: number;
  149256. /**
  149257. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  149258. */
  149259. centripetalForceThreshold: number;
  149260. /**
  149261. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  149262. */
  149263. centripetalForceMultiplier: number;
  149264. /**
  149265. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  149266. */
  149267. centrifugalForceMultiplier: number;
  149268. /**
  149269. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  149270. */
  149271. updraftForceMultiplier: number;
  149272. }
  149273. /**
  149274. * The strenght of the force in correspondence to the distance of the affected object
  149275. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  149276. */
  149277. export enum PhysicsRadialImpulseFalloff {
  149278. /** Defines that impulse is constant in strength across it's whole radius */
  149279. Constant = 0,
  149280. /** Defines that impulse gets weaker if it's further from the origin */
  149281. Linear = 1
  149282. }
  149283. /**
  149284. * The strength of the force in correspondence to the distance of the affected object
  149285. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  149286. */
  149287. export enum PhysicsUpdraftMode {
  149288. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  149289. Center = 0,
  149290. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  149291. Perpendicular = 1
  149292. }
  149293. /**
  149294. * Interface for a physics hit data
  149295. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  149296. */
  149297. export interface PhysicsHitData {
  149298. /**
  149299. * The force applied at the contact point
  149300. */
  149301. force: Vector3;
  149302. /**
  149303. * The contact point
  149304. */
  149305. contactPoint: Vector3;
  149306. /**
  149307. * The distance from the origin to the contact point
  149308. */
  149309. distanceFromOrigin: number;
  149310. }
  149311. /**
  149312. * Interface for radial explosion event data
  149313. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  149314. */
  149315. export interface PhysicsRadialExplosionEventData {
  149316. /**
  149317. * A sphere used for the radial explosion event
  149318. */
  149319. sphere: Mesh;
  149320. }
  149321. /**
  149322. * Interface for gravitational field event data
  149323. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  149324. */
  149325. export interface PhysicsGravitationalFieldEventData {
  149326. /**
  149327. * A sphere mesh used for the gravitational field event
  149328. */
  149329. sphere: Mesh;
  149330. }
  149331. /**
  149332. * Interface for updraft event data
  149333. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  149334. */
  149335. export interface PhysicsUpdraftEventData {
  149336. /**
  149337. * A cylinder used for the updraft event
  149338. */
  149339. cylinder: Mesh;
  149340. }
  149341. /**
  149342. * Interface for vortex event data
  149343. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  149344. */
  149345. export interface PhysicsVortexEventData {
  149346. /**
  149347. * A cylinder used for the vortex event
  149348. */
  149349. cylinder: Mesh;
  149350. }
  149351. /**
  149352. * Interface for an affected physics impostor
  149353. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  149354. */
  149355. export interface PhysicsAffectedImpostorWithData {
  149356. /**
  149357. * The impostor affected by the effect
  149358. */
  149359. impostor: PhysicsImpostor;
  149360. /**
  149361. * The data about the hit/horce from the explosion
  149362. */
  149363. hitData: PhysicsHitData;
  149364. }
  149365. }
  149366. declare module BABYLON {
  149367. /** @hidden */
  149368. export var blackAndWhitePixelShader: {
  149369. name: string;
  149370. shader: string;
  149371. };
  149372. }
  149373. declare module BABYLON {
  149374. /**
  149375. * Post process used to render in black and white
  149376. */
  149377. export class BlackAndWhitePostProcess extends PostProcess {
  149378. /**
  149379. * Linear about to convert he result to black and white (default: 1)
  149380. */
  149381. degree: number;
  149382. /**
  149383. * Gets a string identifying the name of the class
  149384. * @returns "BlackAndWhitePostProcess" string
  149385. */
  149386. getClassName(): string;
  149387. /**
  149388. * Creates a black and white post process
  149389. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  149390. * @param name The name of the effect.
  149391. * @param options The required width/height ratio to downsize to before computing the render pass.
  149392. * @param camera The camera to apply the render pass to.
  149393. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149394. * @param engine The engine which the post process will be applied. (default: current engine)
  149395. * @param reusable If the post process can be reused on the same frame. (default: false)
  149396. */
  149397. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149398. /** @hidden */
  149399. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  149400. }
  149401. }
  149402. declare module BABYLON {
  149403. /**
  149404. * This represents a set of one or more post processes in Babylon.
  149405. * A post process can be used to apply a shader to a texture after it is rendered.
  149406. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149407. */
  149408. export class PostProcessRenderEffect {
  149409. private _postProcesses;
  149410. private _getPostProcesses;
  149411. private _singleInstance;
  149412. private _cameras;
  149413. private _indicesForCamera;
  149414. /**
  149415. * Name of the effect
  149416. * @hidden
  149417. */
  149418. _name: string;
  149419. /**
  149420. * Instantiates a post process render effect.
  149421. * A post process can be used to apply a shader to a texture after it is rendered.
  149422. * @param engine The engine the effect is tied to
  149423. * @param name The name of the effect
  149424. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  149425. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  149426. */
  149427. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  149428. /**
  149429. * Checks if all the post processes in the effect are supported.
  149430. */
  149431. get isSupported(): boolean;
  149432. /**
  149433. * Updates the current state of the effect
  149434. * @hidden
  149435. */
  149436. _update(): void;
  149437. /**
  149438. * Attaches the effect on cameras
  149439. * @param cameras The camera to attach to.
  149440. * @hidden
  149441. */
  149442. _attachCameras(cameras: Camera): void;
  149443. /**
  149444. * Attaches the effect on cameras
  149445. * @param cameras The camera to attach to.
  149446. * @hidden
  149447. */
  149448. _attachCameras(cameras: Camera[]): void;
  149449. /**
  149450. * Detaches the effect on cameras
  149451. * @param cameras The camera to detatch from.
  149452. * @hidden
  149453. */
  149454. _detachCameras(cameras: Camera): void;
  149455. /**
  149456. * Detatches the effect on cameras
  149457. * @param cameras The camera to detatch from.
  149458. * @hidden
  149459. */
  149460. _detachCameras(cameras: Camera[]): void;
  149461. /**
  149462. * Enables the effect on given cameras
  149463. * @param cameras The camera to enable.
  149464. * @hidden
  149465. */
  149466. _enable(cameras: Camera): void;
  149467. /**
  149468. * Enables the effect on given cameras
  149469. * @param cameras The camera to enable.
  149470. * @hidden
  149471. */
  149472. _enable(cameras: Nullable<Camera[]>): void;
  149473. /**
  149474. * Disables the effect on the given cameras
  149475. * @param cameras The camera to disable.
  149476. * @hidden
  149477. */
  149478. _disable(cameras: Camera): void;
  149479. /**
  149480. * Disables the effect on the given cameras
  149481. * @param cameras The camera to disable.
  149482. * @hidden
  149483. */
  149484. _disable(cameras: Nullable<Camera[]>): void;
  149485. /**
  149486. * Gets a list of the post processes contained in the effect.
  149487. * @param camera The camera to get the post processes on.
  149488. * @returns The list of the post processes in the effect.
  149489. */
  149490. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  149491. }
  149492. }
  149493. declare module BABYLON {
  149494. /** @hidden */
  149495. export var extractHighlightsPixelShader: {
  149496. name: string;
  149497. shader: string;
  149498. };
  149499. }
  149500. declare module BABYLON {
  149501. /**
  149502. * 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.
  149503. */
  149504. export class ExtractHighlightsPostProcess extends PostProcess {
  149505. /**
  149506. * The luminance threshold, pixels below this value will be set to black.
  149507. */
  149508. threshold: number;
  149509. /** @hidden */
  149510. _exposure: number;
  149511. /**
  149512. * Post process which has the input texture to be used when performing highlight extraction
  149513. * @hidden
  149514. */
  149515. _inputPostProcess: Nullable<PostProcess>;
  149516. /**
  149517. * Gets a string identifying the name of the class
  149518. * @returns "ExtractHighlightsPostProcess" string
  149519. */
  149520. getClassName(): string;
  149521. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149522. }
  149523. }
  149524. declare module BABYLON {
  149525. /** @hidden */
  149526. export var bloomMergePixelShader: {
  149527. name: string;
  149528. shader: string;
  149529. };
  149530. }
  149531. declare module BABYLON {
  149532. /**
  149533. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  149534. */
  149535. export class BloomMergePostProcess extends PostProcess {
  149536. /** Weight of the bloom to be added to the original input. */
  149537. weight: number;
  149538. /**
  149539. * Gets a string identifying the name of the class
  149540. * @returns "BloomMergePostProcess" string
  149541. */
  149542. getClassName(): string;
  149543. /**
  149544. * Creates a new instance of @see BloomMergePostProcess
  149545. * @param name The name of the effect.
  149546. * @param originalFromInput Post process which's input will be used for the merge.
  149547. * @param blurred Blurred highlights post process which's output will be used.
  149548. * @param weight Weight of the bloom to be added to the original input.
  149549. * @param options The required width/height ratio to downsize to before computing the render pass.
  149550. * @param camera The camera to apply the render pass to.
  149551. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149552. * @param engine The engine which the post process will be applied. (default: current engine)
  149553. * @param reusable If the post process can be reused on the same frame. (default: false)
  149554. * @param textureType Type of textures used when performing the post process. (default: 0)
  149555. * @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)
  149556. */
  149557. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  149558. /** Weight of the bloom to be added to the original input. */
  149559. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149560. }
  149561. }
  149562. declare module BABYLON {
  149563. /**
  149564. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  149565. */
  149566. export class BloomEffect extends PostProcessRenderEffect {
  149567. private bloomScale;
  149568. /**
  149569. * @hidden Internal
  149570. */
  149571. _effects: Array<PostProcess>;
  149572. /**
  149573. * @hidden Internal
  149574. */
  149575. _downscale: ExtractHighlightsPostProcess;
  149576. private _blurX;
  149577. private _blurY;
  149578. private _merge;
  149579. /**
  149580. * The luminance threshold to find bright areas of the image to bloom.
  149581. */
  149582. get threshold(): number;
  149583. set threshold(value: number);
  149584. /**
  149585. * The strength of the bloom.
  149586. */
  149587. get weight(): number;
  149588. set weight(value: number);
  149589. /**
  149590. * Specifies the size of the bloom blur kernel, relative to the final output size
  149591. */
  149592. get kernel(): number;
  149593. set kernel(value: number);
  149594. /**
  149595. * Creates a new instance of @see BloomEffect
  149596. * @param scene The scene the effect belongs to.
  149597. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  149598. * @param bloomKernel The size of the kernel to be used when applying the blur.
  149599. * @param bloomWeight The the strength of bloom.
  149600. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  149601. * @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)
  149602. */
  149603. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  149604. /**
  149605. * Disposes each of the internal effects for a given camera.
  149606. * @param camera The camera to dispose the effect on.
  149607. */
  149608. disposeEffects(camera: Camera): void;
  149609. /**
  149610. * @hidden Internal
  149611. */
  149612. _updateEffects(): void;
  149613. /**
  149614. * Internal
  149615. * @returns if all the contained post processes are ready.
  149616. * @hidden
  149617. */
  149618. _isReady(): boolean;
  149619. }
  149620. }
  149621. declare module BABYLON {
  149622. /** @hidden */
  149623. export var chromaticAberrationPixelShader: {
  149624. name: string;
  149625. shader: string;
  149626. };
  149627. }
  149628. declare module BABYLON {
  149629. /**
  149630. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  149631. */
  149632. export class ChromaticAberrationPostProcess extends PostProcess {
  149633. /**
  149634. * The amount of seperation of rgb channels (default: 30)
  149635. */
  149636. aberrationAmount: number;
  149637. /**
  149638. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  149639. */
  149640. radialIntensity: number;
  149641. /**
  149642. * 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))
  149643. */
  149644. direction: Vector2;
  149645. /**
  149646. * 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))
  149647. */
  149648. centerPosition: Vector2;
  149649. /** The width of the screen to apply the effect on */
  149650. screenWidth: number;
  149651. /** The height of the screen to apply the effect on */
  149652. screenHeight: number;
  149653. /**
  149654. * Gets a string identifying the name of the class
  149655. * @returns "ChromaticAberrationPostProcess" string
  149656. */
  149657. getClassName(): string;
  149658. /**
  149659. * Creates a new instance ChromaticAberrationPostProcess
  149660. * @param name The name of the effect.
  149661. * @param screenWidth The width of the screen to apply the effect on.
  149662. * @param screenHeight The height of the screen to apply the effect on.
  149663. * @param options The required width/height ratio to downsize to before computing the render pass.
  149664. * @param camera The camera to apply the render pass to.
  149665. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149666. * @param engine The engine which the post process will be applied. (default: current engine)
  149667. * @param reusable If the post process can be reused on the same frame. (default: false)
  149668. * @param textureType Type of textures used when performing the post process. (default: 0)
  149669. * @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)
  149670. */
  149671. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149672. /** @hidden */
  149673. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  149674. }
  149675. }
  149676. declare module BABYLON {
  149677. /** @hidden */
  149678. export var circleOfConfusionPixelShader: {
  149679. name: string;
  149680. shader: string;
  149681. };
  149682. }
  149683. declare module BABYLON {
  149684. /**
  149685. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  149686. */
  149687. export class CircleOfConfusionPostProcess extends PostProcess {
  149688. /**
  149689. * 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.
  149690. */
  149691. lensSize: number;
  149692. /**
  149693. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  149694. */
  149695. fStop: number;
  149696. /**
  149697. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  149698. */
  149699. focusDistance: number;
  149700. /**
  149701. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  149702. */
  149703. focalLength: number;
  149704. /**
  149705. * Gets a string identifying the name of the class
  149706. * @returns "CircleOfConfusionPostProcess" string
  149707. */
  149708. getClassName(): string;
  149709. private _depthTexture;
  149710. /**
  149711. * Creates a new instance CircleOfConfusionPostProcess
  149712. * @param name The name of the effect.
  149713. * @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.
  149714. * @param options The required width/height ratio to downsize to before computing the render pass.
  149715. * @param camera The camera to apply the render pass to.
  149716. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149717. * @param engine The engine which the post process will be applied. (default: current engine)
  149718. * @param reusable If the post process can be reused on the same frame. (default: false)
  149719. * @param textureType Type of textures used when performing the post process. (default: 0)
  149720. * @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)
  149721. */
  149722. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149723. /**
  149724. * 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.
  149725. */
  149726. set depthTexture(value: RenderTargetTexture);
  149727. }
  149728. }
  149729. declare module BABYLON {
  149730. /** @hidden */
  149731. export var colorCorrectionPixelShader: {
  149732. name: string;
  149733. shader: string;
  149734. };
  149735. }
  149736. declare module BABYLON {
  149737. /**
  149738. *
  149739. * This post-process allows the modification of rendered colors by using
  149740. * a 'look-up table' (LUT). This effect is also called Color Grading.
  149741. *
  149742. * The object needs to be provided an url to a texture containing the color
  149743. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  149744. * Use an image editing software to tweak the LUT to match your needs.
  149745. *
  149746. * For an example of a color LUT, see here:
  149747. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  149748. * For explanations on color grading, see here:
  149749. * @see http://udn.epicgames.com/Three/ColorGrading.html
  149750. *
  149751. */
  149752. export class ColorCorrectionPostProcess extends PostProcess {
  149753. private _colorTableTexture;
  149754. /**
  149755. * Gets the color table url used to create the LUT texture
  149756. */
  149757. colorTableUrl: string;
  149758. /**
  149759. * Gets a string identifying the name of the class
  149760. * @returns "ColorCorrectionPostProcess" string
  149761. */
  149762. getClassName(): string;
  149763. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149764. /** @hidden */
  149765. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  149766. }
  149767. }
  149768. declare module BABYLON {
  149769. /** @hidden */
  149770. export var convolutionPixelShader: {
  149771. name: string;
  149772. shader: string;
  149773. };
  149774. }
  149775. declare module BABYLON {
  149776. /**
  149777. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  149778. * input texture to perform effects such as edge detection or sharpening
  149779. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  149780. */
  149781. export class ConvolutionPostProcess extends PostProcess {
  149782. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  149783. kernel: number[];
  149784. /**
  149785. * Gets a string identifying the name of the class
  149786. * @returns "ConvolutionPostProcess" string
  149787. */
  149788. getClassName(): string;
  149789. /**
  149790. * Creates a new instance ConvolutionPostProcess
  149791. * @param name The name of the effect.
  149792. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  149793. * @param options The required width/height ratio to downsize to before computing the render pass.
  149794. * @param camera The camera to apply the render pass to.
  149795. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149796. * @param engine The engine which the post process will be applied. (default: current engine)
  149797. * @param reusable If the post process can be reused on the same frame. (default: false)
  149798. * @param textureType Type of textures used when performing the post process. (default: 0)
  149799. */
  149800. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  149801. /** @hidden */
  149802. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  149803. /**
  149804. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  149805. */
  149806. static EdgeDetect0Kernel: number[];
  149807. /**
  149808. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  149809. */
  149810. static EdgeDetect1Kernel: number[];
  149811. /**
  149812. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  149813. */
  149814. static EdgeDetect2Kernel: number[];
  149815. /**
  149816. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  149817. */
  149818. static SharpenKernel: number[];
  149819. /**
  149820. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  149821. */
  149822. static EmbossKernel: number[];
  149823. /**
  149824. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  149825. */
  149826. static GaussianKernel: number[];
  149827. }
  149828. }
  149829. declare module BABYLON {
  149830. /**
  149831. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  149832. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  149833. * based on samples that have a large difference in distance than the center pixel.
  149834. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  149835. */
  149836. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  149837. /**
  149838. * The direction the blur should be applied
  149839. */
  149840. direction: Vector2;
  149841. /**
  149842. * Gets a string identifying the name of the class
  149843. * @returns "DepthOfFieldBlurPostProcess" string
  149844. */
  149845. getClassName(): string;
  149846. /**
  149847. * Creates a new instance CircleOfConfusionPostProcess
  149848. * @param name The name of the effect.
  149849. * @param scene The scene the effect belongs to.
  149850. * @param direction The direction the blur should be applied.
  149851. * @param kernel The size of the kernel used to blur.
  149852. * @param options The required width/height ratio to downsize to before computing the render pass.
  149853. * @param camera The camera to apply the render pass to.
  149854. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  149855. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  149856. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149857. * @param engine The engine which the post process will be applied. (default: current engine)
  149858. * @param reusable If the post process can be reused on the same frame. (default: false)
  149859. * @param textureType Type of textures used when performing the post process. (default: 0)
  149860. * @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)
  149861. */
  149862. 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);
  149863. }
  149864. }
  149865. declare module BABYLON {
  149866. /** @hidden */
  149867. export var depthOfFieldMergePixelShader: {
  149868. name: string;
  149869. shader: string;
  149870. };
  149871. }
  149872. declare module BABYLON {
  149873. /**
  149874. * Options to be set when merging outputs from the default pipeline.
  149875. */
  149876. export class DepthOfFieldMergePostProcessOptions {
  149877. /**
  149878. * The original image to merge on top of
  149879. */
  149880. originalFromInput: PostProcess;
  149881. /**
  149882. * Parameters to perform the merge of the depth of field effect
  149883. */
  149884. depthOfField?: {
  149885. circleOfConfusion: PostProcess;
  149886. blurSteps: Array<PostProcess>;
  149887. };
  149888. /**
  149889. * Parameters to perform the merge of bloom effect
  149890. */
  149891. bloom?: {
  149892. blurred: PostProcess;
  149893. weight: number;
  149894. };
  149895. }
  149896. /**
  149897. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  149898. */
  149899. export class DepthOfFieldMergePostProcess extends PostProcess {
  149900. private blurSteps;
  149901. /**
  149902. * Gets a string identifying the name of the class
  149903. * @returns "DepthOfFieldMergePostProcess" string
  149904. */
  149905. getClassName(): string;
  149906. /**
  149907. * Creates a new instance of DepthOfFieldMergePostProcess
  149908. * @param name The name of the effect.
  149909. * @param originalFromInput Post process which's input will be used for the merge.
  149910. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  149911. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  149912. * @param options The required width/height ratio to downsize to before computing the render pass.
  149913. * @param camera The camera to apply the render pass to.
  149914. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149915. * @param engine The engine which the post process will be applied. (default: current engine)
  149916. * @param reusable If the post process can be reused on the same frame. (default: false)
  149917. * @param textureType Type of textures used when performing the post process. (default: 0)
  149918. * @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)
  149919. */
  149920. 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);
  149921. /**
  149922. * Updates the effect with the current post process compile time values and recompiles the shader.
  149923. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  149924. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  149925. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  149926. * @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
  149927. * @param onCompiled Called when the shader has been compiled.
  149928. * @param onError Called if there is an error when compiling a shader.
  149929. */
  149930. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  149931. }
  149932. }
  149933. declare module BABYLON {
  149934. /**
  149935. * Specifies the level of max blur that should be applied when using the depth of field effect
  149936. */
  149937. export enum DepthOfFieldEffectBlurLevel {
  149938. /**
  149939. * Subtle blur
  149940. */
  149941. Low = 0,
  149942. /**
  149943. * Medium blur
  149944. */
  149945. Medium = 1,
  149946. /**
  149947. * Large blur
  149948. */
  149949. High = 2
  149950. }
  149951. /**
  149952. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  149953. */
  149954. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  149955. private _circleOfConfusion;
  149956. /**
  149957. * @hidden Internal, blurs from high to low
  149958. */
  149959. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  149960. private _depthOfFieldBlurY;
  149961. private _dofMerge;
  149962. /**
  149963. * @hidden Internal post processes in depth of field effect
  149964. */
  149965. _effects: Array<PostProcess>;
  149966. /**
  149967. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  149968. */
  149969. set focalLength(value: number);
  149970. get focalLength(): number;
  149971. /**
  149972. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  149973. */
  149974. set fStop(value: number);
  149975. get fStop(): number;
  149976. /**
  149977. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  149978. */
  149979. set focusDistance(value: number);
  149980. get focusDistance(): number;
  149981. /**
  149982. * 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.
  149983. */
  149984. set lensSize(value: number);
  149985. get lensSize(): number;
  149986. /**
  149987. * Creates a new instance DepthOfFieldEffect
  149988. * @param scene The scene the effect belongs to.
  149989. * @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.
  149990. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  149991. * @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)
  149992. */
  149993. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  149994. /**
  149995. * Get the current class name of the current effet
  149996. * @returns "DepthOfFieldEffect"
  149997. */
  149998. getClassName(): string;
  149999. /**
  150000. * 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.
  150001. */
  150002. set depthTexture(value: RenderTargetTexture);
  150003. /**
  150004. * Disposes each of the internal effects for a given camera.
  150005. * @param camera The camera to dispose the effect on.
  150006. */
  150007. disposeEffects(camera: Camera): void;
  150008. /**
  150009. * @hidden Internal
  150010. */
  150011. _updateEffects(): void;
  150012. /**
  150013. * Internal
  150014. * @returns if all the contained post processes are ready.
  150015. * @hidden
  150016. */
  150017. _isReady(): boolean;
  150018. }
  150019. }
  150020. declare module BABYLON {
  150021. /** @hidden */
  150022. export var displayPassPixelShader: {
  150023. name: string;
  150024. shader: string;
  150025. };
  150026. }
  150027. declare module BABYLON {
  150028. /**
  150029. * DisplayPassPostProcess which produces an output the same as it's input
  150030. */
  150031. export class DisplayPassPostProcess extends PostProcess {
  150032. /**
  150033. * Gets a string identifying the name of the class
  150034. * @returns "DisplayPassPostProcess" string
  150035. */
  150036. getClassName(): string;
  150037. /**
  150038. * Creates the DisplayPassPostProcess
  150039. * @param name The name of the effect.
  150040. * @param options The required width/height ratio to downsize to before computing the render pass.
  150041. * @param camera The camera to apply the render pass to.
  150042. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150043. * @param engine The engine which the post process will be applied. (default: current engine)
  150044. * @param reusable If the post process can be reused on the same frame. (default: false)
  150045. */
  150046. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  150047. /** @hidden */
  150048. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  150049. }
  150050. }
  150051. declare module BABYLON {
  150052. /** @hidden */
  150053. export var filterPixelShader: {
  150054. name: string;
  150055. shader: string;
  150056. };
  150057. }
  150058. declare module BABYLON {
  150059. /**
  150060. * Applies a kernel filter to the image
  150061. */
  150062. export class FilterPostProcess extends PostProcess {
  150063. /** The matrix to be applied to the image */
  150064. kernelMatrix: Matrix;
  150065. /**
  150066. * Gets a string identifying the name of the class
  150067. * @returns "FilterPostProcess" string
  150068. */
  150069. getClassName(): string;
  150070. /**
  150071. *
  150072. * @param name The name of the effect.
  150073. * @param kernelMatrix The matrix to be applied to the image
  150074. * @param options The required width/height ratio to downsize to before computing the render pass.
  150075. * @param camera The camera to apply the render pass to.
  150076. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150077. * @param engine The engine which the post process will be applied. (default: current engine)
  150078. * @param reusable If the post process can be reused on the same frame. (default: false)
  150079. */
  150080. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  150081. /** @hidden */
  150082. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  150083. }
  150084. }
  150085. declare module BABYLON {
  150086. /** @hidden */
  150087. export var fxaaPixelShader: {
  150088. name: string;
  150089. shader: string;
  150090. };
  150091. }
  150092. declare module BABYLON {
  150093. /** @hidden */
  150094. export var fxaaVertexShader: {
  150095. name: string;
  150096. shader: string;
  150097. };
  150098. }
  150099. declare module BABYLON {
  150100. /**
  150101. * Fxaa post process
  150102. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  150103. */
  150104. export class FxaaPostProcess extends PostProcess {
  150105. /**
  150106. * Gets a string identifying the name of the class
  150107. * @returns "FxaaPostProcess" string
  150108. */
  150109. getClassName(): string;
  150110. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  150111. private _getDefines;
  150112. /** @hidden */
  150113. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  150114. }
  150115. }
  150116. declare module BABYLON {
  150117. /** @hidden */
  150118. export var grainPixelShader: {
  150119. name: string;
  150120. shader: string;
  150121. };
  150122. }
  150123. declare module BABYLON {
  150124. /**
  150125. * The GrainPostProcess adds noise to the image at mid luminance levels
  150126. */
  150127. export class GrainPostProcess extends PostProcess {
  150128. /**
  150129. * The intensity of the grain added (default: 30)
  150130. */
  150131. intensity: number;
  150132. /**
  150133. * If the grain should be randomized on every frame
  150134. */
  150135. animated: boolean;
  150136. /**
  150137. * Gets a string identifying the name of the class
  150138. * @returns "GrainPostProcess" string
  150139. */
  150140. getClassName(): string;
  150141. /**
  150142. * Creates a new instance of @see GrainPostProcess
  150143. * @param name The name of the effect.
  150144. * @param options The required width/height ratio to downsize to before computing the render pass.
  150145. * @param camera The camera to apply the render pass to.
  150146. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150147. * @param engine The engine which the post process will be applied. (default: current engine)
  150148. * @param reusable If the post process can be reused on the same frame. (default: false)
  150149. * @param textureType Type of textures used when performing the post process. (default: 0)
  150150. * @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)
  150151. */
  150152. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  150153. /** @hidden */
  150154. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  150155. }
  150156. }
  150157. declare module BABYLON {
  150158. /** @hidden */
  150159. export var highlightsPixelShader: {
  150160. name: string;
  150161. shader: string;
  150162. };
  150163. }
  150164. declare module BABYLON {
  150165. /**
  150166. * Extracts highlights from the image
  150167. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  150168. */
  150169. export class HighlightsPostProcess extends PostProcess {
  150170. /**
  150171. * Gets a string identifying the name of the class
  150172. * @returns "HighlightsPostProcess" string
  150173. */
  150174. getClassName(): string;
  150175. /**
  150176. * Extracts highlights from the image
  150177. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  150178. * @param name The name of the effect.
  150179. * @param options The required width/height ratio to downsize to before computing the render pass.
  150180. * @param camera The camera to apply the render pass to.
  150181. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150182. * @param engine The engine which the post process will be applied. (default: current engine)
  150183. * @param reusable If the post process can be reused on the same frame. (default: false)
  150184. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  150185. */
  150186. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  150187. }
  150188. }
  150189. declare module BABYLON {
  150190. /** @hidden */
  150191. export var mrtFragmentDeclaration: {
  150192. name: string;
  150193. shader: string;
  150194. };
  150195. }
  150196. declare module BABYLON {
  150197. /** @hidden */
  150198. export var geometryPixelShader: {
  150199. name: string;
  150200. shader: string;
  150201. };
  150202. }
  150203. declare module BABYLON {
  150204. /** @hidden */
  150205. export var geometryVertexShader: {
  150206. name: string;
  150207. shader: string;
  150208. };
  150209. }
  150210. declare module BABYLON {
  150211. /** @hidden */
  150212. interface ISavedTransformationMatrix {
  150213. world: Matrix;
  150214. viewProjection: Matrix;
  150215. }
  150216. /**
  150217. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  150218. */
  150219. export class GeometryBufferRenderer {
  150220. /**
  150221. * Constant used to retrieve the position texture index in the G-Buffer textures array
  150222. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  150223. */
  150224. static readonly POSITION_TEXTURE_TYPE: number;
  150225. /**
  150226. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  150227. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  150228. */
  150229. static readonly VELOCITY_TEXTURE_TYPE: number;
  150230. /**
  150231. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  150232. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  150233. */
  150234. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  150235. /**
  150236. * Dictionary used to store the previous transformation matrices of each rendered mesh
  150237. * in order to compute objects velocities when enableVelocity is set to "true"
  150238. * @hidden
  150239. */
  150240. _previousTransformationMatrices: {
  150241. [index: number]: ISavedTransformationMatrix;
  150242. };
  150243. /**
  150244. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  150245. * in order to compute objects velocities when enableVelocity is set to "true"
  150246. * @hidden
  150247. */
  150248. _previousBonesTransformationMatrices: {
  150249. [index: number]: Float32Array;
  150250. };
  150251. /**
  150252. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  150253. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  150254. */
  150255. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  150256. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  150257. renderTransparentMeshes: boolean;
  150258. private _scene;
  150259. private _resizeObserver;
  150260. private _multiRenderTarget;
  150261. private _ratio;
  150262. private _enablePosition;
  150263. private _enableVelocity;
  150264. private _enableReflectivity;
  150265. private _positionIndex;
  150266. private _velocityIndex;
  150267. private _reflectivityIndex;
  150268. protected _effect: Effect;
  150269. protected _cachedDefines: string;
  150270. /**
  150271. * Set the render list (meshes to be rendered) used in the G buffer.
  150272. */
  150273. set renderList(meshes: Mesh[]);
  150274. /**
  150275. * Gets wether or not G buffer are supported by the running hardware.
  150276. * This requires draw buffer supports
  150277. */
  150278. get isSupported(): boolean;
  150279. /**
  150280. * Returns the index of the given texture type in the G-Buffer textures array
  150281. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  150282. * @returns the index of the given texture type in the G-Buffer textures array
  150283. */
  150284. getTextureIndex(textureType: number): number;
  150285. /**
  150286. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  150287. */
  150288. get enablePosition(): boolean;
  150289. /**
  150290. * Sets whether or not objects positions are enabled for the G buffer.
  150291. */
  150292. set enablePosition(enable: boolean);
  150293. /**
  150294. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  150295. */
  150296. get enableVelocity(): boolean;
  150297. /**
  150298. * Sets wether or not objects velocities are enabled for the G buffer.
  150299. */
  150300. set enableVelocity(enable: boolean);
  150301. /**
  150302. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  150303. */
  150304. get enableReflectivity(): boolean;
  150305. /**
  150306. * Sets wether or not objects roughness are enabled for the G buffer.
  150307. */
  150308. set enableReflectivity(enable: boolean);
  150309. /**
  150310. * Gets the scene associated with the buffer.
  150311. */
  150312. get scene(): Scene;
  150313. /**
  150314. * Gets the ratio used by the buffer during its creation.
  150315. * How big is the buffer related to the main canvas.
  150316. */
  150317. get ratio(): number;
  150318. /** @hidden */
  150319. static _SceneComponentInitialization: (scene: Scene) => void;
  150320. /**
  150321. * Creates a new G Buffer for the scene
  150322. * @param scene The scene the buffer belongs to
  150323. * @param ratio How big is the buffer related to the main canvas.
  150324. */
  150325. constructor(scene: Scene, ratio?: number);
  150326. /**
  150327. * Checks wether everything is ready to render a submesh to the G buffer.
  150328. * @param subMesh the submesh to check readiness for
  150329. * @param useInstances is the mesh drawn using instance or not
  150330. * @returns true if ready otherwise false
  150331. */
  150332. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  150333. /**
  150334. * Gets the current underlying G Buffer.
  150335. * @returns the buffer
  150336. */
  150337. getGBuffer(): MultiRenderTarget;
  150338. /**
  150339. * Gets the number of samples used to render the buffer (anti aliasing).
  150340. */
  150341. get samples(): number;
  150342. /**
  150343. * Sets the number of samples used to render the buffer (anti aliasing).
  150344. */
  150345. set samples(value: number);
  150346. /**
  150347. * Disposes the renderer and frees up associated resources.
  150348. */
  150349. dispose(): void;
  150350. protected _createRenderTargets(): void;
  150351. private _copyBonesTransformationMatrices;
  150352. }
  150353. }
  150354. declare module BABYLON {
  150355. interface Scene {
  150356. /** @hidden (Backing field) */
  150357. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  150358. /**
  150359. * Gets or Sets the current geometry buffer associated to the scene.
  150360. */
  150361. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  150362. /**
  150363. * Enables a GeometryBufferRender and associates it with the scene
  150364. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  150365. * @returns the GeometryBufferRenderer
  150366. */
  150367. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  150368. /**
  150369. * Disables the GeometryBufferRender associated with the scene
  150370. */
  150371. disableGeometryBufferRenderer(): void;
  150372. }
  150373. /**
  150374. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  150375. * in several rendering techniques.
  150376. */
  150377. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  150378. /**
  150379. * The component name helpful to identify the component in the list of scene components.
  150380. */
  150381. readonly name: string;
  150382. /**
  150383. * The scene the component belongs to.
  150384. */
  150385. scene: Scene;
  150386. /**
  150387. * Creates a new instance of the component for the given scene
  150388. * @param scene Defines the scene to register the component in
  150389. */
  150390. constructor(scene: Scene);
  150391. /**
  150392. * Registers the component in a given scene
  150393. */
  150394. register(): void;
  150395. /**
  150396. * Rebuilds the elements related to this component in case of
  150397. * context lost for instance.
  150398. */
  150399. rebuild(): void;
  150400. /**
  150401. * Disposes the component and the associated ressources
  150402. */
  150403. dispose(): void;
  150404. private _gatherRenderTargets;
  150405. }
  150406. }
  150407. declare module BABYLON {
  150408. /** @hidden */
  150409. export var motionBlurPixelShader: {
  150410. name: string;
  150411. shader: string;
  150412. };
  150413. }
  150414. declare module BABYLON {
  150415. /**
  150416. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  150417. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  150418. * As an example, all you have to do is to create the post-process:
  150419. * var mb = new BABYLON.MotionBlurPostProcess(
  150420. * 'mb', // The name of the effect.
  150421. * scene, // The scene containing the objects to blur according to their velocity.
  150422. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  150423. * camera // The camera to apply the render pass to.
  150424. * );
  150425. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  150426. */
  150427. export class MotionBlurPostProcess extends PostProcess {
  150428. /**
  150429. * Defines how much the image is blurred by the movement. Default value is equal to 1
  150430. */
  150431. motionStrength: number;
  150432. /**
  150433. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  150434. */
  150435. get motionBlurSamples(): number;
  150436. /**
  150437. * Sets the number of iterations to be used for motion blur quality
  150438. */
  150439. set motionBlurSamples(samples: number);
  150440. private _motionBlurSamples;
  150441. private _geometryBufferRenderer;
  150442. /**
  150443. * Gets a string identifying the name of the class
  150444. * @returns "MotionBlurPostProcess" string
  150445. */
  150446. getClassName(): string;
  150447. /**
  150448. * Creates a new instance MotionBlurPostProcess
  150449. * @param name The name of the effect.
  150450. * @param scene The scene containing the objects to blur according to their velocity.
  150451. * @param options The required width/height ratio to downsize to before computing the render pass.
  150452. * @param camera The camera to apply the render pass to.
  150453. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150454. * @param engine The engine which the post process will be applied. (default: current engine)
  150455. * @param reusable If the post process can be reused on the same frame. (default: false)
  150456. * @param textureType Type of textures used when performing the post process. (default: 0)
  150457. * @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)
  150458. */
  150459. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  150460. /**
  150461. * Excludes the given skinned mesh from computing bones velocities.
  150462. * 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.
  150463. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  150464. */
  150465. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  150466. /**
  150467. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  150468. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  150469. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  150470. */
  150471. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  150472. /**
  150473. * Disposes the post process.
  150474. * @param camera The camera to dispose the post process on.
  150475. */
  150476. dispose(camera?: Camera): void;
  150477. /** @hidden */
  150478. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  150479. }
  150480. }
  150481. declare module BABYLON {
  150482. /** @hidden */
  150483. export var refractionPixelShader: {
  150484. name: string;
  150485. shader: string;
  150486. };
  150487. }
  150488. declare module BABYLON {
  150489. /**
  150490. * Post process which applies a refractin texture
  150491. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  150492. */
  150493. export class RefractionPostProcess extends PostProcess {
  150494. private _refTexture;
  150495. private _ownRefractionTexture;
  150496. /** the base color of the refraction (used to taint the rendering) */
  150497. color: Color3;
  150498. /** simulated refraction depth */
  150499. depth: number;
  150500. /** the coefficient of the base color (0 to remove base color tainting) */
  150501. colorLevel: number;
  150502. /** Gets the url used to load the refraction texture */
  150503. refractionTextureUrl: string;
  150504. /**
  150505. * Gets or sets the refraction texture
  150506. * Please note that you are responsible for disposing the texture if you set it manually
  150507. */
  150508. get refractionTexture(): Texture;
  150509. set refractionTexture(value: Texture);
  150510. /**
  150511. * Gets a string identifying the name of the class
  150512. * @returns "RefractionPostProcess" string
  150513. */
  150514. getClassName(): string;
  150515. /**
  150516. * Initializes the RefractionPostProcess
  150517. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  150518. * @param name The name of the effect.
  150519. * @param refractionTextureUrl Url of the refraction texture to use
  150520. * @param color the base color of the refraction (used to taint the rendering)
  150521. * @param depth simulated refraction depth
  150522. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  150523. * @param camera The camera to apply the render pass to.
  150524. * @param options The required width/height ratio to downsize to before computing the render pass.
  150525. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150526. * @param engine The engine which the post process will be applied. (default: current engine)
  150527. * @param reusable If the post process can be reused on the same frame. (default: false)
  150528. */
  150529. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  150530. /**
  150531. * Disposes of the post process
  150532. * @param camera Camera to dispose post process on
  150533. */
  150534. dispose(camera: Camera): void;
  150535. /** @hidden */
  150536. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  150537. }
  150538. }
  150539. declare module BABYLON {
  150540. /** @hidden */
  150541. export var sharpenPixelShader: {
  150542. name: string;
  150543. shader: string;
  150544. };
  150545. }
  150546. declare module BABYLON {
  150547. /**
  150548. * The SharpenPostProcess applies a sharpen kernel to every pixel
  150549. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  150550. */
  150551. export class SharpenPostProcess extends PostProcess {
  150552. /**
  150553. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  150554. */
  150555. colorAmount: number;
  150556. /**
  150557. * How much sharpness should be applied (default: 0.3)
  150558. */
  150559. edgeAmount: number;
  150560. /**
  150561. * Gets a string identifying the name of the class
  150562. * @returns "SharpenPostProcess" string
  150563. */
  150564. getClassName(): string;
  150565. /**
  150566. * Creates a new instance ConvolutionPostProcess
  150567. * @param name The name of the effect.
  150568. * @param options The required width/height ratio to downsize to before computing the render pass.
  150569. * @param camera The camera to apply the render pass to.
  150570. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150571. * @param engine The engine which the post process will be applied. (default: current engine)
  150572. * @param reusable If the post process can be reused on the same frame. (default: false)
  150573. * @param textureType Type of textures used when performing the post process. (default: 0)
  150574. * @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)
  150575. */
  150576. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  150577. /** @hidden */
  150578. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  150579. }
  150580. }
  150581. declare module BABYLON {
  150582. /**
  150583. * PostProcessRenderPipeline
  150584. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  150585. */
  150586. export class PostProcessRenderPipeline {
  150587. private engine;
  150588. private _renderEffects;
  150589. private _renderEffectsForIsolatedPass;
  150590. /**
  150591. * List of inspectable custom properties (used by the Inspector)
  150592. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  150593. */
  150594. inspectableCustomProperties: IInspectable[];
  150595. /**
  150596. * @hidden
  150597. */
  150598. protected _cameras: Camera[];
  150599. /** @hidden */
  150600. _name: string;
  150601. /**
  150602. * Gets pipeline name
  150603. */
  150604. get name(): string;
  150605. /** Gets the list of attached cameras */
  150606. get cameras(): Camera[];
  150607. /**
  150608. * Initializes a PostProcessRenderPipeline
  150609. * @param engine engine to add the pipeline to
  150610. * @param name name of the pipeline
  150611. */
  150612. constructor(engine: Engine, name: string);
  150613. /**
  150614. * Gets the class name
  150615. * @returns "PostProcessRenderPipeline"
  150616. */
  150617. getClassName(): string;
  150618. /**
  150619. * If all the render effects in the pipeline are supported
  150620. */
  150621. get isSupported(): boolean;
  150622. /**
  150623. * Adds an effect to the pipeline
  150624. * @param renderEffect the effect to add
  150625. */
  150626. addEffect(renderEffect: PostProcessRenderEffect): void;
  150627. /** @hidden */
  150628. _rebuild(): void;
  150629. /** @hidden */
  150630. _enableEffect(renderEffectName: string, cameras: Camera): void;
  150631. /** @hidden */
  150632. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  150633. /** @hidden */
  150634. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  150635. /** @hidden */
  150636. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  150637. /** @hidden */
  150638. _attachCameras(cameras: Camera, unique: boolean): void;
  150639. /** @hidden */
  150640. _attachCameras(cameras: Camera[], unique: boolean): void;
  150641. /** @hidden */
  150642. _detachCameras(cameras: Camera): void;
  150643. /** @hidden */
  150644. _detachCameras(cameras: Nullable<Camera[]>): void;
  150645. /** @hidden */
  150646. _update(): void;
  150647. /** @hidden */
  150648. _reset(): void;
  150649. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  150650. /**
  150651. * Sets the required values to the prepass renderer.
  150652. * @param prePassRenderer defines the prepass renderer to setup.
  150653. * @returns true if the pre pass is needed.
  150654. */
  150655. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  150656. /**
  150657. * Disposes of the pipeline
  150658. */
  150659. dispose(): void;
  150660. }
  150661. }
  150662. declare module BABYLON {
  150663. /**
  150664. * PostProcessRenderPipelineManager class
  150665. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  150666. */
  150667. export class PostProcessRenderPipelineManager {
  150668. private _renderPipelines;
  150669. /**
  150670. * Initializes a PostProcessRenderPipelineManager
  150671. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  150672. */
  150673. constructor();
  150674. /**
  150675. * Gets the list of supported render pipelines
  150676. */
  150677. get supportedPipelines(): PostProcessRenderPipeline[];
  150678. /**
  150679. * Adds a pipeline to the manager
  150680. * @param renderPipeline The pipeline to add
  150681. */
  150682. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  150683. /**
  150684. * Attaches a camera to the pipeline
  150685. * @param renderPipelineName The name of the pipeline to attach to
  150686. * @param cameras the camera to attach
  150687. * @param unique if the camera can be attached multiple times to the pipeline
  150688. */
  150689. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  150690. /**
  150691. * Detaches a camera from the pipeline
  150692. * @param renderPipelineName The name of the pipeline to detach from
  150693. * @param cameras the camera to detach
  150694. */
  150695. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  150696. /**
  150697. * Enables an effect by name on a pipeline
  150698. * @param renderPipelineName the name of the pipeline to enable the effect in
  150699. * @param renderEffectName the name of the effect to enable
  150700. * @param cameras the cameras that the effect should be enabled on
  150701. */
  150702. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  150703. /**
  150704. * Disables an effect by name on a pipeline
  150705. * @param renderPipelineName the name of the pipeline to disable the effect in
  150706. * @param renderEffectName the name of the effect to disable
  150707. * @param cameras the cameras that the effect should be disabled on
  150708. */
  150709. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  150710. /**
  150711. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  150712. */
  150713. update(): void;
  150714. /** @hidden */
  150715. _rebuild(): void;
  150716. /**
  150717. * Disposes of the manager and pipelines
  150718. */
  150719. dispose(): void;
  150720. }
  150721. }
  150722. declare module BABYLON {
  150723. interface Scene {
  150724. /** @hidden (Backing field) */
  150725. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  150726. /**
  150727. * Gets the postprocess render pipeline manager
  150728. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  150729. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  150730. */
  150731. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  150732. }
  150733. /**
  150734. * Defines the Render Pipeline scene component responsible to rendering pipelines
  150735. */
  150736. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  150737. /**
  150738. * The component name helpfull to identify the component in the list of scene components.
  150739. */
  150740. readonly name: string;
  150741. /**
  150742. * The scene the component belongs to.
  150743. */
  150744. scene: Scene;
  150745. /**
  150746. * Creates a new instance of the component for the given scene
  150747. * @param scene Defines the scene to register the component in
  150748. */
  150749. constructor(scene: Scene);
  150750. /**
  150751. * Registers the component in a given scene
  150752. */
  150753. register(): void;
  150754. /**
  150755. * Rebuilds the elements related to this component in case of
  150756. * context lost for instance.
  150757. */
  150758. rebuild(): void;
  150759. /**
  150760. * Disposes the component and the associated ressources
  150761. */
  150762. dispose(): void;
  150763. private _gatherRenderTargets;
  150764. }
  150765. }
  150766. declare module BABYLON {
  150767. /**
  150768. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  150769. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  150770. */
  150771. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  150772. private _scene;
  150773. private _camerasToBeAttached;
  150774. /**
  150775. * ID of the sharpen post process,
  150776. */
  150777. private readonly SharpenPostProcessId;
  150778. /**
  150779. * @ignore
  150780. * ID of the image processing post process;
  150781. */
  150782. readonly ImageProcessingPostProcessId: string;
  150783. /**
  150784. * @ignore
  150785. * ID of the Fast Approximate Anti-Aliasing post process;
  150786. */
  150787. readonly FxaaPostProcessId: string;
  150788. /**
  150789. * ID of the chromatic aberration post process,
  150790. */
  150791. private readonly ChromaticAberrationPostProcessId;
  150792. /**
  150793. * ID of the grain post process
  150794. */
  150795. private readonly GrainPostProcessId;
  150796. /**
  150797. * Sharpen post process which will apply a sharpen convolution to enhance edges
  150798. */
  150799. sharpen: SharpenPostProcess;
  150800. private _sharpenEffect;
  150801. private bloom;
  150802. /**
  150803. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  150804. */
  150805. depthOfField: DepthOfFieldEffect;
  150806. /**
  150807. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  150808. */
  150809. fxaa: FxaaPostProcess;
  150810. /**
  150811. * Image post processing pass used to perform operations such as tone mapping or color grading.
  150812. */
  150813. imageProcessing: ImageProcessingPostProcess;
  150814. /**
  150815. * Chromatic aberration post process which will shift rgb colors in the image
  150816. */
  150817. chromaticAberration: ChromaticAberrationPostProcess;
  150818. private _chromaticAberrationEffect;
  150819. /**
  150820. * Grain post process which add noise to the image
  150821. */
  150822. grain: GrainPostProcess;
  150823. private _grainEffect;
  150824. /**
  150825. * Glow post process which adds a glow to emissive areas of the image
  150826. */
  150827. private _glowLayer;
  150828. /**
  150829. * Animations which can be used to tweak settings over a period of time
  150830. */
  150831. animations: Animation[];
  150832. private _imageProcessingConfigurationObserver;
  150833. private _sharpenEnabled;
  150834. private _bloomEnabled;
  150835. private _depthOfFieldEnabled;
  150836. private _depthOfFieldBlurLevel;
  150837. private _fxaaEnabled;
  150838. private _imageProcessingEnabled;
  150839. private _defaultPipelineTextureType;
  150840. private _bloomScale;
  150841. private _chromaticAberrationEnabled;
  150842. private _grainEnabled;
  150843. private _buildAllowed;
  150844. /**
  150845. * Gets active scene
  150846. */
  150847. get scene(): Scene;
  150848. /**
  150849. * Enable or disable the sharpen process from the pipeline
  150850. */
  150851. set sharpenEnabled(enabled: boolean);
  150852. get sharpenEnabled(): boolean;
  150853. private _resizeObserver;
  150854. private _hardwareScaleLevel;
  150855. private _bloomKernel;
  150856. /**
  150857. * Specifies the size of the bloom blur kernel, relative to the final output size
  150858. */
  150859. get bloomKernel(): number;
  150860. set bloomKernel(value: number);
  150861. /**
  150862. * Specifies the weight of the bloom in the final rendering
  150863. */
  150864. private _bloomWeight;
  150865. /**
  150866. * Specifies the luma threshold for the area that will be blurred by the bloom
  150867. */
  150868. private _bloomThreshold;
  150869. private _hdr;
  150870. /**
  150871. * The strength of the bloom.
  150872. */
  150873. set bloomWeight(value: number);
  150874. get bloomWeight(): number;
  150875. /**
  150876. * The strength of the bloom.
  150877. */
  150878. set bloomThreshold(value: number);
  150879. get bloomThreshold(): number;
  150880. /**
  150881. * The scale of the bloom, lower value will provide better performance.
  150882. */
  150883. set bloomScale(value: number);
  150884. get bloomScale(): number;
  150885. /**
  150886. * Enable or disable the bloom from the pipeline
  150887. */
  150888. set bloomEnabled(enabled: boolean);
  150889. get bloomEnabled(): boolean;
  150890. private _rebuildBloom;
  150891. /**
  150892. * If the depth of field is enabled.
  150893. */
  150894. get depthOfFieldEnabled(): boolean;
  150895. set depthOfFieldEnabled(enabled: boolean);
  150896. /**
  150897. * Blur level of the depth of field effect. (Higher blur will effect performance)
  150898. */
  150899. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  150900. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  150901. /**
  150902. * If the anti aliasing is enabled.
  150903. */
  150904. set fxaaEnabled(enabled: boolean);
  150905. get fxaaEnabled(): boolean;
  150906. private _samples;
  150907. /**
  150908. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  150909. */
  150910. set samples(sampleCount: number);
  150911. get samples(): number;
  150912. /**
  150913. * If image processing is enabled.
  150914. */
  150915. set imageProcessingEnabled(enabled: boolean);
  150916. get imageProcessingEnabled(): boolean;
  150917. /**
  150918. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  150919. */
  150920. set glowLayerEnabled(enabled: boolean);
  150921. get glowLayerEnabled(): boolean;
  150922. /**
  150923. * Gets the glow layer (or null if not defined)
  150924. */
  150925. get glowLayer(): Nullable<GlowLayer>;
  150926. /**
  150927. * Enable or disable the chromaticAberration process from the pipeline
  150928. */
  150929. set chromaticAberrationEnabled(enabled: boolean);
  150930. get chromaticAberrationEnabled(): boolean;
  150931. /**
  150932. * Enable or disable the grain process from the pipeline
  150933. */
  150934. set grainEnabled(enabled: boolean);
  150935. get grainEnabled(): boolean;
  150936. /**
  150937. * @constructor
  150938. * @param name - The rendering pipeline name (default: "")
  150939. * @param hdr - If high dynamic range textures should be used (default: true)
  150940. * @param scene - The scene linked to this pipeline (default: the last created scene)
  150941. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  150942. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  150943. */
  150944. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  150945. /**
  150946. * Get the class name
  150947. * @returns "DefaultRenderingPipeline"
  150948. */
  150949. getClassName(): string;
  150950. /**
  150951. * Force the compilation of the entire pipeline.
  150952. */
  150953. prepare(): void;
  150954. private _hasCleared;
  150955. private _prevPostProcess;
  150956. private _prevPrevPostProcess;
  150957. private _setAutoClearAndTextureSharing;
  150958. private _depthOfFieldSceneObserver;
  150959. private _buildPipeline;
  150960. private _disposePostProcesses;
  150961. /**
  150962. * Adds a camera to the pipeline
  150963. * @param camera the camera to be added
  150964. */
  150965. addCamera(camera: Camera): void;
  150966. /**
  150967. * Removes a camera from the pipeline
  150968. * @param camera the camera to remove
  150969. */
  150970. removeCamera(camera: Camera): void;
  150971. /**
  150972. * Dispose of the pipeline and stop all post processes
  150973. */
  150974. dispose(): void;
  150975. /**
  150976. * Serialize the rendering pipeline (Used when exporting)
  150977. * @returns the serialized object
  150978. */
  150979. serialize(): any;
  150980. /**
  150981. * Parse the serialized pipeline
  150982. * @param source Source pipeline.
  150983. * @param scene The scene to load the pipeline to.
  150984. * @param rootUrl The URL of the serialized pipeline.
  150985. * @returns An instantiated pipeline from the serialized object.
  150986. */
  150987. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  150988. }
  150989. }
  150990. declare module BABYLON {
  150991. /** @hidden */
  150992. export var lensHighlightsPixelShader: {
  150993. name: string;
  150994. shader: string;
  150995. };
  150996. }
  150997. declare module BABYLON {
  150998. /** @hidden */
  150999. export var depthOfFieldPixelShader: {
  151000. name: string;
  151001. shader: string;
  151002. };
  151003. }
  151004. declare module BABYLON {
  151005. /**
  151006. * BABYLON.JS Chromatic Aberration GLSL Shader
  151007. * Author: Olivier Guyot
  151008. * Separates very slightly R, G and B colors on the edges of the screen
  151009. * Inspired by Francois Tarlier & Martins Upitis
  151010. */
  151011. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  151012. /**
  151013. * @ignore
  151014. * The chromatic aberration PostProcess id in the pipeline
  151015. */
  151016. LensChromaticAberrationEffect: string;
  151017. /**
  151018. * @ignore
  151019. * The highlights enhancing PostProcess id in the pipeline
  151020. */
  151021. HighlightsEnhancingEffect: string;
  151022. /**
  151023. * @ignore
  151024. * The depth-of-field PostProcess id in the pipeline
  151025. */
  151026. LensDepthOfFieldEffect: string;
  151027. private _scene;
  151028. private _depthTexture;
  151029. private _grainTexture;
  151030. private _chromaticAberrationPostProcess;
  151031. private _highlightsPostProcess;
  151032. private _depthOfFieldPostProcess;
  151033. private _edgeBlur;
  151034. private _grainAmount;
  151035. private _chromaticAberration;
  151036. private _distortion;
  151037. private _highlightsGain;
  151038. private _highlightsThreshold;
  151039. private _dofDistance;
  151040. private _dofAperture;
  151041. private _dofDarken;
  151042. private _dofPentagon;
  151043. private _blurNoise;
  151044. /**
  151045. * @constructor
  151046. *
  151047. * Effect parameters are as follow:
  151048. * {
  151049. * chromatic_aberration: number; // from 0 to x (1 for realism)
  151050. * edge_blur: number; // from 0 to x (1 for realism)
  151051. * distortion: number; // from 0 to x (1 for realism)
  151052. * grain_amount: number; // from 0 to 1
  151053. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  151054. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  151055. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  151056. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  151057. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  151058. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  151059. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  151060. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  151061. * }
  151062. * Note: if an effect parameter is unset, effect is disabled
  151063. *
  151064. * @param name The rendering pipeline name
  151065. * @param parameters - An object containing all parameters (see above)
  151066. * @param scene The scene linked to this pipeline
  151067. * @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)
  151068. * @param cameras The array of cameras that the rendering pipeline will be attached to
  151069. */
  151070. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  151071. /**
  151072. * Get the class name
  151073. * @returns "LensRenderingPipeline"
  151074. */
  151075. getClassName(): string;
  151076. /**
  151077. * Gets associated scene
  151078. */
  151079. get scene(): Scene;
  151080. /**
  151081. * Gets or sets the edge blur
  151082. */
  151083. get edgeBlur(): number;
  151084. set edgeBlur(value: number);
  151085. /**
  151086. * Gets or sets the grain amount
  151087. */
  151088. get grainAmount(): number;
  151089. set grainAmount(value: number);
  151090. /**
  151091. * Gets or sets the chromatic aberration amount
  151092. */
  151093. get chromaticAberration(): number;
  151094. set chromaticAberration(value: number);
  151095. /**
  151096. * Gets or sets the depth of field aperture
  151097. */
  151098. get dofAperture(): number;
  151099. set dofAperture(value: number);
  151100. /**
  151101. * Gets or sets the edge distortion
  151102. */
  151103. get edgeDistortion(): number;
  151104. set edgeDistortion(value: number);
  151105. /**
  151106. * Gets or sets the depth of field distortion
  151107. */
  151108. get dofDistortion(): number;
  151109. set dofDistortion(value: number);
  151110. /**
  151111. * Gets or sets the darken out of focus amount
  151112. */
  151113. get darkenOutOfFocus(): number;
  151114. set darkenOutOfFocus(value: number);
  151115. /**
  151116. * Gets or sets a boolean indicating if blur noise is enabled
  151117. */
  151118. get blurNoise(): boolean;
  151119. set blurNoise(value: boolean);
  151120. /**
  151121. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  151122. */
  151123. get pentagonBokeh(): boolean;
  151124. set pentagonBokeh(value: boolean);
  151125. /**
  151126. * Gets or sets the highlight grain amount
  151127. */
  151128. get highlightsGain(): number;
  151129. set highlightsGain(value: number);
  151130. /**
  151131. * Gets or sets the highlight threshold
  151132. */
  151133. get highlightsThreshold(): number;
  151134. set highlightsThreshold(value: number);
  151135. /**
  151136. * Sets the amount of blur at the edges
  151137. * @param amount blur amount
  151138. */
  151139. setEdgeBlur(amount: number): void;
  151140. /**
  151141. * Sets edge blur to 0
  151142. */
  151143. disableEdgeBlur(): void;
  151144. /**
  151145. * Sets the amout of grain
  151146. * @param amount Amount of grain
  151147. */
  151148. setGrainAmount(amount: number): void;
  151149. /**
  151150. * Set grain amount to 0
  151151. */
  151152. disableGrain(): void;
  151153. /**
  151154. * Sets the chromatic aberration amount
  151155. * @param amount amount of chromatic aberration
  151156. */
  151157. setChromaticAberration(amount: number): void;
  151158. /**
  151159. * Sets chromatic aberration amount to 0
  151160. */
  151161. disableChromaticAberration(): void;
  151162. /**
  151163. * Sets the EdgeDistortion amount
  151164. * @param amount amount of EdgeDistortion
  151165. */
  151166. setEdgeDistortion(amount: number): void;
  151167. /**
  151168. * Sets edge distortion to 0
  151169. */
  151170. disableEdgeDistortion(): void;
  151171. /**
  151172. * Sets the FocusDistance amount
  151173. * @param amount amount of FocusDistance
  151174. */
  151175. setFocusDistance(amount: number): void;
  151176. /**
  151177. * Disables depth of field
  151178. */
  151179. disableDepthOfField(): void;
  151180. /**
  151181. * Sets the Aperture amount
  151182. * @param amount amount of Aperture
  151183. */
  151184. setAperture(amount: number): void;
  151185. /**
  151186. * Sets the DarkenOutOfFocus amount
  151187. * @param amount amount of DarkenOutOfFocus
  151188. */
  151189. setDarkenOutOfFocus(amount: number): void;
  151190. private _pentagonBokehIsEnabled;
  151191. /**
  151192. * Creates a pentagon bokeh effect
  151193. */
  151194. enablePentagonBokeh(): void;
  151195. /**
  151196. * Disables the pentagon bokeh effect
  151197. */
  151198. disablePentagonBokeh(): void;
  151199. /**
  151200. * Enables noise blur
  151201. */
  151202. enableNoiseBlur(): void;
  151203. /**
  151204. * Disables noise blur
  151205. */
  151206. disableNoiseBlur(): void;
  151207. /**
  151208. * Sets the HighlightsGain amount
  151209. * @param amount amount of HighlightsGain
  151210. */
  151211. setHighlightsGain(amount: number): void;
  151212. /**
  151213. * Sets the HighlightsThreshold amount
  151214. * @param amount amount of HighlightsThreshold
  151215. */
  151216. setHighlightsThreshold(amount: number): void;
  151217. /**
  151218. * Disables highlights
  151219. */
  151220. disableHighlights(): void;
  151221. /**
  151222. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  151223. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  151224. */
  151225. dispose(disableDepthRender?: boolean): void;
  151226. private _createChromaticAberrationPostProcess;
  151227. private _createHighlightsPostProcess;
  151228. private _createDepthOfFieldPostProcess;
  151229. private _createGrainTexture;
  151230. }
  151231. }
  151232. declare module BABYLON {
  151233. /**
  151234. * Contains all parameters needed for the prepass to perform
  151235. * screen space subsurface scattering
  151236. */
  151237. export class SSAO2Configuration implements PrePassEffectConfiguration {
  151238. /**
  151239. * Is subsurface enabled
  151240. */
  151241. enabled: boolean;
  151242. /**
  151243. * Name of the configuration
  151244. */
  151245. name: string;
  151246. /**
  151247. * Textures that should be present in the MRT for this effect to work
  151248. */
  151249. readonly texturesRequired: number[];
  151250. /**
  151251. * Builds a ssao2 configuration object
  151252. * @param scene The scene
  151253. */
  151254. constructor();
  151255. /**
  151256. * Disposes the configuration
  151257. */
  151258. dispose(): void;
  151259. }
  151260. }
  151261. declare module BABYLON {
  151262. /** @hidden */
  151263. export var ssao2PixelShader: {
  151264. name: string;
  151265. shader: string;
  151266. };
  151267. }
  151268. declare module BABYLON {
  151269. /** @hidden */
  151270. export var ssaoCombinePixelShader: {
  151271. name: string;
  151272. shader: string;
  151273. };
  151274. }
  151275. declare module BABYLON {
  151276. /**
  151277. * Render pipeline to produce ssao effect
  151278. */
  151279. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  151280. /**
  151281. * @ignore
  151282. * The PassPostProcess id in the pipeline that contains the original scene color
  151283. */
  151284. SSAOOriginalSceneColorEffect: string;
  151285. /**
  151286. * @ignore
  151287. * The SSAO PostProcess id in the pipeline
  151288. */
  151289. SSAORenderEffect: string;
  151290. /**
  151291. * @ignore
  151292. * The horizontal blur PostProcess id in the pipeline
  151293. */
  151294. SSAOBlurHRenderEffect: string;
  151295. /**
  151296. * @ignore
  151297. * The vertical blur PostProcess id in the pipeline
  151298. */
  151299. SSAOBlurVRenderEffect: string;
  151300. /**
  151301. * @ignore
  151302. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  151303. */
  151304. SSAOCombineRenderEffect: string;
  151305. /**
  151306. * The output strength of the SSAO post-process. Default value is 1.0.
  151307. */
  151308. totalStrength: number;
  151309. /**
  151310. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  151311. */
  151312. maxZ: number;
  151313. /**
  151314. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  151315. */
  151316. minZAspect: number;
  151317. private _samples;
  151318. /**
  151319. * Number of samples used for the SSAO calculations. Default value is 8
  151320. */
  151321. set samples(n: number);
  151322. get samples(): number;
  151323. private _textureSamples;
  151324. /**
  151325. * Number of samples to use for antialiasing
  151326. */
  151327. set textureSamples(n: number);
  151328. get textureSamples(): number;
  151329. /**
  151330. * Force rendering the geometry through geometry buffer
  151331. */
  151332. private _forceGeometryBuffer;
  151333. /**
  151334. * Ratio object used for SSAO ratio and blur ratio
  151335. */
  151336. private _ratio;
  151337. /**
  151338. * Dynamically generated sphere sampler.
  151339. */
  151340. private _sampleSphere;
  151341. private _ssao2PrePassConfiguration;
  151342. /**
  151343. * Blur filter offsets
  151344. */
  151345. private _samplerOffsets;
  151346. private _expensiveBlur;
  151347. /**
  151348. * If bilateral blur should be used
  151349. */
  151350. set expensiveBlur(b: boolean);
  151351. get expensiveBlur(): boolean;
  151352. /**
  151353. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  151354. */
  151355. radius: number;
  151356. /**
  151357. * The base color of the SSAO post-process
  151358. * The final result is "base + ssao" between [0, 1]
  151359. */
  151360. base: number;
  151361. /**
  151362. * Support test.
  151363. */
  151364. static get IsSupported(): boolean;
  151365. private _scene;
  151366. private _randomTexture;
  151367. private _originalColorPostProcess;
  151368. private _ssaoPostProcess;
  151369. private _blurHPostProcess;
  151370. private _blurVPostProcess;
  151371. private _ssaoCombinePostProcess;
  151372. private _prePassRenderer;
  151373. /**
  151374. * Gets active scene
  151375. */
  151376. get scene(): Scene;
  151377. /**
  151378. * @constructor
  151379. * @param name The rendering pipeline name
  151380. * @param scene The scene linked to this pipeline
  151381. * @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 }
  151382. * @param cameras The array of cameras that the rendering pipeline will be attached to
  151383. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  151384. */
  151385. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  151386. /**
  151387. * Get the class name
  151388. * @returns "SSAO2RenderingPipeline"
  151389. */
  151390. getClassName(): string;
  151391. /**
  151392. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  151393. */
  151394. dispose(disableGeometryBufferRenderer?: boolean): void;
  151395. private _createBlurPostProcess;
  151396. /** @hidden */
  151397. _rebuild(): void;
  151398. private _bits;
  151399. private _radicalInverse_VdC;
  151400. private _hammersley;
  151401. private _hemisphereSample_uniform;
  151402. private _generateHemisphere;
  151403. private _getDefinesForSSAO;
  151404. private _createSSAOPostProcess;
  151405. private _createSSAOCombinePostProcess;
  151406. private _createRandomTexture;
  151407. /**
  151408. * Serialize the rendering pipeline (Used when exporting)
  151409. * @returns the serialized object
  151410. */
  151411. serialize(): any;
  151412. /**
  151413. * Parse the serialized pipeline
  151414. * @param source Source pipeline.
  151415. * @param scene The scene to load the pipeline to.
  151416. * @param rootUrl The URL of the serialized pipeline.
  151417. * @returns An instantiated pipeline from the serialized object.
  151418. */
  151419. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  151420. /**
  151421. * Sets the required values to the prepass renderer.
  151422. * @param prePassRenderer defines the prepass renderer to setup
  151423. * @returns true if the pre pass is needed.
  151424. */
  151425. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  151426. }
  151427. }
  151428. declare module BABYLON {
  151429. /** @hidden */
  151430. export var ssaoPixelShader: {
  151431. name: string;
  151432. shader: string;
  151433. };
  151434. }
  151435. declare module BABYLON {
  151436. /**
  151437. * Render pipeline to produce ssao effect
  151438. */
  151439. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  151440. /**
  151441. * @ignore
  151442. * The PassPostProcess id in the pipeline that contains the original scene color
  151443. */
  151444. SSAOOriginalSceneColorEffect: string;
  151445. /**
  151446. * @ignore
  151447. * The SSAO PostProcess id in the pipeline
  151448. */
  151449. SSAORenderEffect: string;
  151450. /**
  151451. * @ignore
  151452. * The horizontal blur PostProcess id in the pipeline
  151453. */
  151454. SSAOBlurHRenderEffect: string;
  151455. /**
  151456. * @ignore
  151457. * The vertical blur PostProcess id in the pipeline
  151458. */
  151459. SSAOBlurVRenderEffect: string;
  151460. /**
  151461. * @ignore
  151462. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  151463. */
  151464. SSAOCombineRenderEffect: string;
  151465. /**
  151466. * The output strength of the SSAO post-process. Default value is 1.0.
  151467. */
  151468. totalStrength: number;
  151469. /**
  151470. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  151471. */
  151472. radius: number;
  151473. /**
  151474. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  151475. * Must not be equal to fallOff and superior to fallOff.
  151476. * Default value is 0.0075
  151477. */
  151478. area: number;
  151479. /**
  151480. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  151481. * Must not be equal to area and inferior to area.
  151482. * Default value is 0.000001
  151483. */
  151484. fallOff: number;
  151485. /**
  151486. * The base color of the SSAO post-process
  151487. * The final result is "base + ssao" between [0, 1]
  151488. */
  151489. base: number;
  151490. private _scene;
  151491. private _depthTexture;
  151492. private _randomTexture;
  151493. private _originalColorPostProcess;
  151494. private _ssaoPostProcess;
  151495. private _blurHPostProcess;
  151496. private _blurVPostProcess;
  151497. private _ssaoCombinePostProcess;
  151498. private _firstUpdate;
  151499. /**
  151500. * Gets active scene
  151501. */
  151502. get scene(): Scene;
  151503. /**
  151504. * @constructor
  151505. * @param name - The rendering pipeline name
  151506. * @param scene - The scene linked to this pipeline
  151507. * @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 }
  151508. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  151509. */
  151510. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  151511. /**
  151512. * Get the class name
  151513. * @returns "SSAORenderingPipeline"
  151514. */
  151515. getClassName(): string;
  151516. /**
  151517. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  151518. */
  151519. dispose(disableDepthRender?: boolean): void;
  151520. private _createBlurPostProcess;
  151521. /** @hidden */
  151522. _rebuild(): void;
  151523. private _createSSAOPostProcess;
  151524. private _createSSAOCombinePostProcess;
  151525. private _createRandomTexture;
  151526. }
  151527. }
  151528. declare module BABYLON {
  151529. /** @hidden */
  151530. export var screenSpaceReflectionPixelShader: {
  151531. name: string;
  151532. shader: string;
  151533. };
  151534. }
  151535. declare module BABYLON {
  151536. /**
  151537. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  151538. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  151539. */
  151540. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  151541. /**
  151542. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  151543. */
  151544. threshold: number;
  151545. /**
  151546. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  151547. */
  151548. strength: number;
  151549. /**
  151550. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  151551. */
  151552. reflectionSpecularFalloffExponent: number;
  151553. /**
  151554. * 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]
  151555. */
  151556. step: number;
  151557. /**
  151558. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  151559. */
  151560. roughnessFactor: number;
  151561. private _geometryBufferRenderer;
  151562. private _enableSmoothReflections;
  151563. private _reflectionSamples;
  151564. private _smoothSteps;
  151565. /**
  151566. * Gets a string identifying the name of the class
  151567. * @returns "ScreenSpaceReflectionPostProcess" string
  151568. */
  151569. getClassName(): string;
  151570. /**
  151571. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  151572. * @param name The name of the effect.
  151573. * @param scene The scene containing the objects to calculate reflections.
  151574. * @param options The required width/height ratio to downsize to before computing the render pass.
  151575. * @param camera The camera to apply the render pass to.
  151576. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151577. * @param engine The engine which the post process will be applied. (default: current engine)
  151578. * @param reusable If the post process can be reused on the same frame. (default: false)
  151579. * @param textureType Type of textures used when performing the post process. (default: 0)
  151580. * @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)
  151581. */
  151582. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  151583. /**
  151584. * Gets wether or not smoothing reflections is enabled.
  151585. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  151586. */
  151587. get enableSmoothReflections(): boolean;
  151588. /**
  151589. * Sets wether or not smoothing reflections is enabled.
  151590. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  151591. */
  151592. set enableSmoothReflections(enabled: boolean);
  151593. /**
  151594. * Gets the number of samples taken while computing reflections. More samples count is high,
  151595. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  151596. */
  151597. get reflectionSamples(): number;
  151598. /**
  151599. * Sets the number of samples taken while computing reflections. More samples count is high,
  151600. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  151601. */
  151602. set reflectionSamples(samples: number);
  151603. /**
  151604. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  151605. * more the post-process will require GPU power and can generate a drop in FPS.
  151606. * Default value (5.0) work pretty well in all cases but can be adjusted.
  151607. */
  151608. get smoothSteps(): number;
  151609. set smoothSteps(steps: number);
  151610. private _updateEffectDefines;
  151611. /** @hidden */
  151612. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  151613. }
  151614. }
  151615. declare module BABYLON {
  151616. /** @hidden */
  151617. export var standardPixelShader: {
  151618. name: string;
  151619. shader: string;
  151620. };
  151621. }
  151622. declare module BABYLON {
  151623. /**
  151624. * Standard rendering pipeline
  151625. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  151626. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  151627. */
  151628. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  151629. /**
  151630. * Public members
  151631. */
  151632. /**
  151633. * Post-process which contains the original scene color before the pipeline applies all the effects
  151634. */
  151635. originalPostProcess: Nullable<PostProcess>;
  151636. /**
  151637. * Post-process used to down scale an image x4
  151638. */
  151639. downSampleX4PostProcess: Nullable<PostProcess>;
  151640. /**
  151641. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  151642. */
  151643. brightPassPostProcess: Nullable<PostProcess>;
  151644. /**
  151645. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  151646. */
  151647. blurHPostProcesses: PostProcess[];
  151648. /**
  151649. * Post-process array storing all the vertical blur post-processes used by the pipeline
  151650. */
  151651. blurVPostProcesses: PostProcess[];
  151652. /**
  151653. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  151654. */
  151655. textureAdderPostProcess: Nullable<PostProcess>;
  151656. /**
  151657. * Post-process used to create volumetric lighting effect
  151658. */
  151659. volumetricLightPostProcess: Nullable<PostProcess>;
  151660. /**
  151661. * Post-process used to smooth the previous volumetric light post-process on the X axis
  151662. */
  151663. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  151664. /**
  151665. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  151666. */
  151667. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  151668. /**
  151669. * Post-process used to merge the volumetric light effect and the real scene color
  151670. */
  151671. volumetricLightMergePostProces: Nullable<PostProcess>;
  151672. /**
  151673. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  151674. */
  151675. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  151676. /**
  151677. * Base post-process used to calculate the average luminance of the final image for HDR
  151678. */
  151679. luminancePostProcess: Nullable<PostProcess>;
  151680. /**
  151681. * Post-processes used to create down sample post-processes in order to get
  151682. * the average luminance of the final image for HDR
  151683. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  151684. */
  151685. luminanceDownSamplePostProcesses: PostProcess[];
  151686. /**
  151687. * Post-process used to create a HDR effect (light adaptation)
  151688. */
  151689. hdrPostProcess: Nullable<PostProcess>;
  151690. /**
  151691. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  151692. */
  151693. textureAdderFinalPostProcess: Nullable<PostProcess>;
  151694. /**
  151695. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  151696. */
  151697. lensFlareFinalPostProcess: Nullable<PostProcess>;
  151698. /**
  151699. * Post-process used to merge the final HDR post-process and the real scene color
  151700. */
  151701. hdrFinalPostProcess: Nullable<PostProcess>;
  151702. /**
  151703. * Post-process used to create a lens flare effect
  151704. */
  151705. lensFlarePostProcess: Nullable<PostProcess>;
  151706. /**
  151707. * Post-process that merges the result of the lens flare post-process and the real scene color
  151708. */
  151709. lensFlareComposePostProcess: Nullable<PostProcess>;
  151710. /**
  151711. * Post-process used to create a motion blur effect
  151712. */
  151713. motionBlurPostProcess: Nullable<PostProcess>;
  151714. /**
  151715. * Post-process used to create a depth of field effect
  151716. */
  151717. depthOfFieldPostProcess: Nullable<PostProcess>;
  151718. /**
  151719. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  151720. */
  151721. fxaaPostProcess: Nullable<FxaaPostProcess>;
  151722. /**
  151723. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  151724. */
  151725. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  151726. /**
  151727. * Represents the brightness threshold in order to configure the illuminated surfaces
  151728. */
  151729. brightThreshold: number;
  151730. /**
  151731. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  151732. */
  151733. blurWidth: number;
  151734. /**
  151735. * Sets if the blur for highlighted surfaces must be only horizontal
  151736. */
  151737. horizontalBlur: boolean;
  151738. /**
  151739. * Gets the overall exposure used by the pipeline
  151740. */
  151741. get exposure(): number;
  151742. /**
  151743. * Sets the overall exposure used by the pipeline
  151744. */
  151745. set exposure(value: number);
  151746. /**
  151747. * Texture used typically to simulate "dirty" on camera lens
  151748. */
  151749. lensTexture: Nullable<Texture>;
  151750. /**
  151751. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  151752. */
  151753. volumetricLightCoefficient: number;
  151754. /**
  151755. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  151756. */
  151757. volumetricLightPower: number;
  151758. /**
  151759. * Used the set the blur intensity to smooth the volumetric lights
  151760. */
  151761. volumetricLightBlurScale: number;
  151762. /**
  151763. * Light (spot or directional) used to generate the volumetric lights rays
  151764. * The source light must have a shadow generate so the pipeline can get its
  151765. * depth map
  151766. */
  151767. sourceLight: Nullable<SpotLight | DirectionalLight>;
  151768. /**
  151769. * For eye adaptation, represents the minimum luminance the eye can see
  151770. */
  151771. hdrMinimumLuminance: number;
  151772. /**
  151773. * For eye adaptation, represents the decrease luminance speed
  151774. */
  151775. hdrDecreaseRate: number;
  151776. /**
  151777. * For eye adaptation, represents the increase luminance speed
  151778. */
  151779. hdrIncreaseRate: number;
  151780. /**
  151781. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  151782. */
  151783. get hdrAutoExposure(): boolean;
  151784. /**
  151785. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  151786. */
  151787. set hdrAutoExposure(value: boolean);
  151788. /**
  151789. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  151790. */
  151791. lensColorTexture: Nullable<Texture>;
  151792. /**
  151793. * The overall strengh for the lens flare effect
  151794. */
  151795. lensFlareStrength: number;
  151796. /**
  151797. * Dispersion coefficient for lens flare ghosts
  151798. */
  151799. lensFlareGhostDispersal: number;
  151800. /**
  151801. * Main lens flare halo width
  151802. */
  151803. lensFlareHaloWidth: number;
  151804. /**
  151805. * Based on the lens distortion effect, defines how much the lens flare result
  151806. * is distorted
  151807. */
  151808. lensFlareDistortionStrength: number;
  151809. /**
  151810. * Configures the blur intensity used for for lens flare (halo)
  151811. */
  151812. lensFlareBlurWidth: number;
  151813. /**
  151814. * Lens star texture must be used to simulate rays on the flares and is available
  151815. * in the documentation
  151816. */
  151817. lensStarTexture: Nullable<Texture>;
  151818. /**
  151819. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  151820. * flare effect by taking account of the dirt texture
  151821. */
  151822. lensFlareDirtTexture: Nullable<Texture>;
  151823. /**
  151824. * Represents the focal length for the depth of field effect
  151825. */
  151826. depthOfFieldDistance: number;
  151827. /**
  151828. * Represents the blur intensity for the blurred part of the depth of field effect
  151829. */
  151830. depthOfFieldBlurWidth: number;
  151831. /**
  151832. * Gets how much the image is blurred by the movement while using the motion blur post-process
  151833. */
  151834. get motionStrength(): number;
  151835. /**
  151836. * Sets how much the image is blurred by the movement while using the motion blur post-process
  151837. */
  151838. set motionStrength(strength: number);
  151839. /**
  151840. * Gets wether or not the motion blur post-process is object based or screen based.
  151841. */
  151842. get objectBasedMotionBlur(): boolean;
  151843. /**
  151844. * Sets wether or not the motion blur post-process should be object based or screen based
  151845. */
  151846. set objectBasedMotionBlur(value: boolean);
  151847. /**
  151848. * List of animations for the pipeline (IAnimatable implementation)
  151849. */
  151850. animations: Animation[];
  151851. /**
  151852. * Private members
  151853. */
  151854. private _scene;
  151855. private _currentDepthOfFieldSource;
  151856. private _basePostProcess;
  151857. private _fixedExposure;
  151858. private _currentExposure;
  151859. private _hdrAutoExposure;
  151860. private _hdrCurrentLuminance;
  151861. private _motionStrength;
  151862. private _isObjectBasedMotionBlur;
  151863. private _floatTextureType;
  151864. private _camerasToBeAttached;
  151865. private _ratio;
  151866. private _bloomEnabled;
  151867. private _depthOfFieldEnabled;
  151868. private _vlsEnabled;
  151869. private _lensFlareEnabled;
  151870. private _hdrEnabled;
  151871. private _motionBlurEnabled;
  151872. private _fxaaEnabled;
  151873. private _screenSpaceReflectionsEnabled;
  151874. private _motionBlurSamples;
  151875. private _volumetricLightStepsCount;
  151876. private _samples;
  151877. /**
  151878. * @ignore
  151879. * Specifies if the bloom pipeline is enabled
  151880. */
  151881. get BloomEnabled(): boolean;
  151882. set BloomEnabled(enabled: boolean);
  151883. /**
  151884. * @ignore
  151885. * Specifies if the depth of field pipeline is enabed
  151886. */
  151887. get DepthOfFieldEnabled(): boolean;
  151888. set DepthOfFieldEnabled(enabled: boolean);
  151889. /**
  151890. * @ignore
  151891. * Specifies if the lens flare pipeline is enabed
  151892. */
  151893. get LensFlareEnabled(): boolean;
  151894. set LensFlareEnabled(enabled: boolean);
  151895. /**
  151896. * @ignore
  151897. * Specifies if the HDR pipeline is enabled
  151898. */
  151899. get HDREnabled(): boolean;
  151900. set HDREnabled(enabled: boolean);
  151901. /**
  151902. * @ignore
  151903. * Specifies if the volumetric lights scattering effect is enabled
  151904. */
  151905. get VLSEnabled(): boolean;
  151906. set VLSEnabled(enabled: boolean);
  151907. /**
  151908. * @ignore
  151909. * Specifies if the motion blur effect is enabled
  151910. */
  151911. get MotionBlurEnabled(): boolean;
  151912. set MotionBlurEnabled(enabled: boolean);
  151913. /**
  151914. * Specifies if anti-aliasing is enabled
  151915. */
  151916. get fxaaEnabled(): boolean;
  151917. set fxaaEnabled(enabled: boolean);
  151918. /**
  151919. * Specifies if screen space reflections are enabled.
  151920. */
  151921. get screenSpaceReflectionsEnabled(): boolean;
  151922. set screenSpaceReflectionsEnabled(enabled: boolean);
  151923. /**
  151924. * Specifies the number of steps used to calculate the volumetric lights
  151925. * Typically in interval [50, 200]
  151926. */
  151927. get volumetricLightStepsCount(): number;
  151928. set volumetricLightStepsCount(count: number);
  151929. /**
  151930. * Specifies the number of samples used for the motion blur effect
  151931. * Typically in interval [16, 64]
  151932. */
  151933. get motionBlurSamples(): number;
  151934. set motionBlurSamples(samples: number);
  151935. /**
  151936. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  151937. */
  151938. get samples(): number;
  151939. set samples(sampleCount: number);
  151940. /**
  151941. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  151942. * @constructor
  151943. * @param name The rendering pipeline name
  151944. * @param scene The scene linked to this pipeline
  151945. * @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)
  151946. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  151947. * @param cameras The array of cameras that the rendering pipeline will be attached to
  151948. */
  151949. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  151950. private _buildPipeline;
  151951. private _createDownSampleX4PostProcess;
  151952. private _createBrightPassPostProcess;
  151953. private _createBlurPostProcesses;
  151954. private _createTextureAdderPostProcess;
  151955. private _createVolumetricLightPostProcess;
  151956. private _createLuminancePostProcesses;
  151957. private _createHdrPostProcess;
  151958. private _createLensFlarePostProcess;
  151959. private _createDepthOfFieldPostProcess;
  151960. private _createMotionBlurPostProcess;
  151961. private _getDepthTexture;
  151962. private _disposePostProcesses;
  151963. /**
  151964. * Dispose of the pipeline and stop all post processes
  151965. */
  151966. dispose(): void;
  151967. /**
  151968. * Serialize the rendering pipeline (Used when exporting)
  151969. * @returns the serialized object
  151970. */
  151971. serialize(): any;
  151972. /**
  151973. * Parse the serialized pipeline
  151974. * @param source Source pipeline.
  151975. * @param scene The scene to load the pipeline to.
  151976. * @param rootUrl The URL of the serialized pipeline.
  151977. * @returns An instantiated pipeline from the serialized object.
  151978. */
  151979. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  151980. /**
  151981. * Luminance steps
  151982. */
  151983. static LuminanceSteps: number;
  151984. }
  151985. }
  151986. declare module BABYLON {
  151987. /** @hidden */
  151988. export var stereoscopicInterlacePixelShader: {
  151989. name: string;
  151990. shader: string;
  151991. };
  151992. }
  151993. declare module BABYLON {
  151994. /**
  151995. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  151996. */
  151997. export class StereoscopicInterlacePostProcessI extends PostProcess {
  151998. private _stepSize;
  151999. private _passedProcess;
  152000. /**
  152001. * Gets a string identifying the name of the class
  152002. * @returns "StereoscopicInterlacePostProcessI" string
  152003. */
  152004. getClassName(): string;
  152005. /**
  152006. * Initializes a StereoscopicInterlacePostProcessI
  152007. * @param name The name of the effect.
  152008. * @param rigCameras The rig cameras to be appled to the post process
  152009. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  152010. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  152011. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  152012. * @param engine The engine which the post process will be applied. (default: current engine)
  152013. * @param reusable If the post process can be reused on the same frame. (default: false)
  152014. */
  152015. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  152016. }
  152017. /**
  152018. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  152019. */
  152020. export class StereoscopicInterlacePostProcess extends PostProcess {
  152021. private _stepSize;
  152022. private _passedProcess;
  152023. /**
  152024. * Gets a string identifying the name of the class
  152025. * @returns "StereoscopicInterlacePostProcess" string
  152026. */
  152027. getClassName(): string;
  152028. /**
  152029. * Initializes a StereoscopicInterlacePostProcess
  152030. * @param name The name of the effect.
  152031. * @param rigCameras The rig cameras to be appled to the post process
  152032. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  152033. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  152034. * @param engine The engine which the post process will be applied. (default: current engine)
  152035. * @param reusable If the post process can be reused on the same frame. (default: false)
  152036. */
  152037. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  152038. }
  152039. }
  152040. declare module BABYLON {
  152041. /** @hidden */
  152042. export var tonemapPixelShader: {
  152043. name: string;
  152044. shader: string;
  152045. };
  152046. }
  152047. declare module BABYLON {
  152048. /** Defines operator used for tonemapping */
  152049. export enum TonemappingOperator {
  152050. /** Hable */
  152051. Hable = 0,
  152052. /** Reinhard */
  152053. Reinhard = 1,
  152054. /** HejiDawson */
  152055. HejiDawson = 2,
  152056. /** Photographic */
  152057. Photographic = 3
  152058. }
  152059. /**
  152060. * Defines a post process to apply tone mapping
  152061. */
  152062. export class TonemapPostProcess extends PostProcess {
  152063. private _operator;
  152064. /** Defines the required exposure adjustement */
  152065. exposureAdjustment: number;
  152066. /**
  152067. * Gets a string identifying the name of the class
  152068. * @returns "TonemapPostProcess" string
  152069. */
  152070. getClassName(): string;
  152071. /**
  152072. * Creates a new TonemapPostProcess
  152073. * @param name defines the name of the postprocess
  152074. * @param _operator defines the operator to use
  152075. * @param exposureAdjustment defines the required exposure adjustement
  152076. * @param camera defines the camera to use (can be null)
  152077. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  152078. * @param engine defines the hosting engine (can be ignore if camera is set)
  152079. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  152080. */
  152081. constructor(name: string, _operator: TonemappingOperator,
  152082. /** Defines the required exposure adjustement */
  152083. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  152084. }
  152085. }
  152086. declare module BABYLON {
  152087. /** @hidden */
  152088. export var volumetricLightScatteringPixelShader: {
  152089. name: string;
  152090. shader: string;
  152091. };
  152092. }
  152093. declare module BABYLON {
  152094. /** @hidden */
  152095. export var volumetricLightScatteringPassVertexShader: {
  152096. name: string;
  152097. shader: string;
  152098. };
  152099. }
  152100. declare module BABYLON {
  152101. /** @hidden */
  152102. export var volumetricLightScatteringPassPixelShader: {
  152103. name: string;
  152104. shader: string;
  152105. };
  152106. }
  152107. declare module BABYLON {
  152108. /**
  152109. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  152110. */
  152111. export class VolumetricLightScatteringPostProcess extends PostProcess {
  152112. private _volumetricLightScatteringPass;
  152113. private _volumetricLightScatteringRTT;
  152114. private _viewPort;
  152115. private _screenCoordinates;
  152116. private _cachedDefines;
  152117. /**
  152118. * If not undefined, the mesh position is computed from the attached node position
  152119. */
  152120. attachedNode: {
  152121. position: Vector3;
  152122. };
  152123. /**
  152124. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  152125. */
  152126. customMeshPosition: Vector3;
  152127. /**
  152128. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  152129. */
  152130. useCustomMeshPosition: boolean;
  152131. /**
  152132. * If the post-process should inverse the light scattering direction
  152133. */
  152134. invert: boolean;
  152135. /**
  152136. * The internal mesh used by the post-process
  152137. */
  152138. mesh: Mesh;
  152139. /**
  152140. * @hidden
  152141. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  152142. */
  152143. get useDiffuseColor(): boolean;
  152144. set useDiffuseColor(useDiffuseColor: boolean);
  152145. /**
  152146. * Array containing the excluded meshes not rendered in the internal pass
  152147. */
  152148. excludedMeshes: AbstractMesh[];
  152149. /**
  152150. * Controls the overall intensity of the post-process
  152151. */
  152152. exposure: number;
  152153. /**
  152154. * Dissipates each sample's contribution in range [0, 1]
  152155. */
  152156. decay: number;
  152157. /**
  152158. * Controls the overall intensity of each sample
  152159. */
  152160. weight: number;
  152161. /**
  152162. * Controls the density of each sample
  152163. */
  152164. density: number;
  152165. /**
  152166. * @constructor
  152167. * @param name The post-process name
  152168. * @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)
  152169. * @param camera The camera that the post-process will be attached to
  152170. * @param mesh The mesh used to create the light scattering
  152171. * @param samples The post-process quality, default 100
  152172. * @param samplingModeThe post-process filtering mode
  152173. * @param engine The babylon engine
  152174. * @param reusable If the post-process is reusable
  152175. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  152176. */
  152177. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  152178. /**
  152179. * Returns the string "VolumetricLightScatteringPostProcess"
  152180. * @returns "VolumetricLightScatteringPostProcess"
  152181. */
  152182. getClassName(): string;
  152183. private _isReady;
  152184. /**
  152185. * Sets the new light position for light scattering effect
  152186. * @param position The new custom light position
  152187. */
  152188. setCustomMeshPosition(position: Vector3): void;
  152189. /**
  152190. * Returns the light position for light scattering effect
  152191. * @return Vector3 The custom light position
  152192. */
  152193. getCustomMeshPosition(): Vector3;
  152194. /**
  152195. * Disposes the internal assets and detaches the post-process from the camera
  152196. */
  152197. dispose(camera: Camera): void;
  152198. /**
  152199. * Returns the render target texture used by the post-process
  152200. * @return the render target texture used by the post-process
  152201. */
  152202. getPass(): RenderTargetTexture;
  152203. private _meshExcluded;
  152204. private _createPass;
  152205. private _updateMeshScreenCoordinates;
  152206. /**
  152207. * Creates a default mesh for the Volumeric Light Scattering post-process
  152208. * @param name The mesh name
  152209. * @param scene The scene where to create the mesh
  152210. * @return the default mesh
  152211. */
  152212. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  152213. }
  152214. }
  152215. declare module BABYLON {
  152216. /** @hidden */
  152217. export var screenSpaceCurvaturePixelShader: {
  152218. name: string;
  152219. shader: string;
  152220. };
  152221. }
  152222. declare module BABYLON {
  152223. /**
  152224. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  152225. */
  152226. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  152227. /**
  152228. * Defines how much ridge the curvature effect displays.
  152229. */
  152230. ridge: number;
  152231. /**
  152232. * Defines how much valley the curvature effect displays.
  152233. */
  152234. valley: number;
  152235. private _geometryBufferRenderer;
  152236. /**
  152237. * Gets a string identifying the name of the class
  152238. * @returns "ScreenSpaceCurvaturePostProcess" string
  152239. */
  152240. getClassName(): string;
  152241. /**
  152242. * Creates a new instance ScreenSpaceCurvaturePostProcess
  152243. * @param name The name of the effect.
  152244. * @param scene The scene containing the objects to blur according to their velocity.
  152245. * @param options The required width/height ratio to downsize to before computing the render pass.
  152246. * @param camera The camera to apply the render pass to.
  152247. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  152248. * @param engine The engine which the post process will be applied. (default: current engine)
  152249. * @param reusable If the post process can be reused on the same frame. (default: false)
  152250. * @param textureType Type of textures used when performing the post process. (default: 0)
  152251. * @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)
  152252. */
  152253. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  152254. /**
  152255. * Support test.
  152256. */
  152257. static get IsSupported(): boolean;
  152258. /** @hidden */
  152259. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  152260. }
  152261. }
  152262. declare module BABYLON {
  152263. interface Scene {
  152264. /** @hidden (Backing field) */
  152265. _boundingBoxRenderer: BoundingBoxRenderer;
  152266. /** @hidden (Backing field) */
  152267. _forceShowBoundingBoxes: boolean;
  152268. /**
  152269. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  152270. */
  152271. forceShowBoundingBoxes: boolean;
  152272. /**
  152273. * Gets the bounding box renderer associated with the scene
  152274. * @returns a BoundingBoxRenderer
  152275. */
  152276. getBoundingBoxRenderer(): BoundingBoxRenderer;
  152277. }
  152278. interface AbstractMesh {
  152279. /** @hidden (Backing field) */
  152280. _showBoundingBox: boolean;
  152281. /**
  152282. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  152283. */
  152284. showBoundingBox: boolean;
  152285. }
  152286. /**
  152287. * Component responsible of rendering the bounding box of the meshes in a scene.
  152288. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  152289. */
  152290. export class BoundingBoxRenderer implements ISceneComponent {
  152291. /**
  152292. * The component name helpfull to identify the component in the list of scene components.
  152293. */
  152294. readonly name: string;
  152295. /**
  152296. * The scene the component belongs to.
  152297. */
  152298. scene: Scene;
  152299. /**
  152300. * Color of the bounding box lines placed in front of an object
  152301. */
  152302. frontColor: Color3;
  152303. /**
  152304. * Color of the bounding box lines placed behind an object
  152305. */
  152306. backColor: Color3;
  152307. /**
  152308. * Defines if the renderer should show the back lines or not
  152309. */
  152310. showBackLines: boolean;
  152311. /**
  152312. * Observable raised before rendering a bounding box
  152313. */
  152314. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  152315. /**
  152316. * Observable raised after rendering a bounding box
  152317. */
  152318. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  152319. /**
  152320. * @hidden
  152321. */
  152322. renderList: SmartArray<BoundingBox>;
  152323. private _colorShader;
  152324. private _vertexBuffers;
  152325. private _indexBuffer;
  152326. private _fillIndexBuffer;
  152327. private _fillIndexData;
  152328. /**
  152329. * Instantiates a new bounding box renderer in a scene.
  152330. * @param scene the scene the renderer renders in
  152331. */
  152332. constructor(scene: Scene);
  152333. /**
  152334. * Registers the component in a given scene
  152335. */
  152336. register(): void;
  152337. private _evaluateSubMesh;
  152338. private _activeMesh;
  152339. private _prepareRessources;
  152340. private _createIndexBuffer;
  152341. /**
  152342. * Rebuilds the elements related to this component in case of
  152343. * context lost for instance.
  152344. */
  152345. rebuild(): void;
  152346. /**
  152347. * @hidden
  152348. */
  152349. reset(): void;
  152350. /**
  152351. * Render the bounding boxes of a specific rendering group
  152352. * @param renderingGroupId defines the rendering group to render
  152353. */
  152354. render(renderingGroupId: number): void;
  152355. /**
  152356. * In case of occlusion queries, we can render the occlusion bounding box through this method
  152357. * @param mesh Define the mesh to render the occlusion bounding box for
  152358. */
  152359. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  152360. /**
  152361. * Dispose and release the resources attached to this renderer.
  152362. */
  152363. dispose(): void;
  152364. }
  152365. }
  152366. declare module BABYLON {
  152367. interface Scene {
  152368. /** @hidden (Backing field) */
  152369. _depthRenderer: {
  152370. [id: string]: DepthRenderer;
  152371. };
  152372. /**
  152373. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  152374. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  152375. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  152376. * @param force32bitsFloat Forces 32 bits float when supported (else 16 bits float is prioritized over 32 bits float if supported)
  152377. * @returns the created depth renderer
  152378. */
  152379. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean, force32bitsFloat?: boolean): DepthRenderer;
  152380. /**
  152381. * Disables a depth renderer for a given camera
  152382. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  152383. */
  152384. disableDepthRenderer(camera?: Nullable<Camera>): void;
  152385. }
  152386. /**
  152387. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  152388. * in several rendering techniques.
  152389. */
  152390. export class DepthRendererSceneComponent implements ISceneComponent {
  152391. /**
  152392. * The component name helpfull to identify the component in the list of scene components.
  152393. */
  152394. readonly name: string;
  152395. /**
  152396. * The scene the component belongs to.
  152397. */
  152398. scene: Scene;
  152399. /**
  152400. * Creates a new instance of the component for the given scene
  152401. * @param scene Defines the scene to register the component in
  152402. */
  152403. constructor(scene: Scene);
  152404. /**
  152405. * Registers the component in a given scene
  152406. */
  152407. register(): void;
  152408. /**
  152409. * Rebuilds the elements related to this component in case of
  152410. * context lost for instance.
  152411. */
  152412. rebuild(): void;
  152413. /**
  152414. * Disposes the component and the associated ressources
  152415. */
  152416. dispose(): void;
  152417. private _gatherRenderTargets;
  152418. private _gatherActiveCameraRenderTargets;
  152419. }
  152420. }
  152421. declare module BABYLON {
  152422. interface AbstractScene {
  152423. /** @hidden (Backing field) */
  152424. _prePassRenderer: Nullable<PrePassRenderer>;
  152425. /**
  152426. * Gets or Sets the current prepass renderer associated to the scene.
  152427. */
  152428. prePassRenderer: Nullable<PrePassRenderer>;
  152429. /**
  152430. * Enables the prepass and associates it with the scene
  152431. * @returns the PrePassRenderer
  152432. */
  152433. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  152434. /**
  152435. * Disables the prepass associated with the scene
  152436. */
  152437. disablePrePassRenderer(): void;
  152438. }
  152439. /**
  152440. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  152441. * in several rendering techniques.
  152442. */
  152443. export class PrePassRendererSceneComponent implements ISceneComponent {
  152444. /**
  152445. * The component name helpful to identify the component in the list of scene components.
  152446. */
  152447. readonly name: string;
  152448. /**
  152449. * The scene the component belongs to.
  152450. */
  152451. scene: Scene;
  152452. /**
  152453. * Creates a new instance of the component for the given scene
  152454. * @param scene Defines the scene to register the component in
  152455. */
  152456. constructor(scene: Scene);
  152457. /**
  152458. * Registers the component in a given scene
  152459. */
  152460. register(): void;
  152461. private _beforeCameraDraw;
  152462. private _afterCameraDraw;
  152463. private _beforeClearStage;
  152464. /**
  152465. * Rebuilds the elements related to this component in case of
  152466. * context lost for instance.
  152467. */
  152468. rebuild(): void;
  152469. /**
  152470. * Disposes the component and the associated ressources
  152471. */
  152472. dispose(): void;
  152473. }
  152474. }
  152475. declare module BABYLON {
  152476. /** @hidden */
  152477. export var fibonacci: {
  152478. name: string;
  152479. shader: string;
  152480. };
  152481. }
  152482. declare module BABYLON {
  152483. /** @hidden */
  152484. export var diffusionProfile: {
  152485. name: string;
  152486. shader: string;
  152487. };
  152488. }
  152489. declare module BABYLON {
  152490. /** @hidden */
  152491. export var subSurfaceScatteringPixelShader: {
  152492. name: string;
  152493. shader: string;
  152494. };
  152495. }
  152496. declare module BABYLON {
  152497. /**
  152498. * Sub surface scattering post process
  152499. */
  152500. export class SubSurfaceScatteringPostProcess extends PostProcess {
  152501. /**
  152502. * Gets a string identifying the name of the class
  152503. * @returns "SubSurfaceScatteringPostProcess" string
  152504. */
  152505. getClassName(): string;
  152506. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  152507. }
  152508. }
  152509. declare module BABYLON {
  152510. /**
  152511. * Contains all parameters needed for the prepass to perform
  152512. * screen space subsurface scattering
  152513. */
  152514. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  152515. /** @hidden */
  152516. static _SceneComponentInitialization: (scene: Scene) => void;
  152517. private _ssDiffusionS;
  152518. private _ssFilterRadii;
  152519. private _ssDiffusionD;
  152520. /**
  152521. * Post process to attach for screen space subsurface scattering
  152522. */
  152523. postProcess: SubSurfaceScatteringPostProcess;
  152524. /**
  152525. * Diffusion profile color for subsurface scattering
  152526. */
  152527. get ssDiffusionS(): number[];
  152528. /**
  152529. * Diffusion profile max color channel value for subsurface scattering
  152530. */
  152531. get ssDiffusionD(): number[];
  152532. /**
  152533. * Diffusion profile filter radius for subsurface scattering
  152534. */
  152535. get ssFilterRadii(): number[];
  152536. /**
  152537. * Is subsurface enabled
  152538. */
  152539. enabled: boolean;
  152540. /**
  152541. * Name of the configuration
  152542. */
  152543. name: string;
  152544. /**
  152545. * Diffusion profile colors for subsurface scattering
  152546. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  152547. * See ...
  152548. * Note that you can only store up to 5 of them
  152549. */
  152550. ssDiffusionProfileColors: Color3[];
  152551. /**
  152552. * Defines the ratio real world => scene units.
  152553. * Used for subsurface scattering
  152554. */
  152555. metersPerUnit: number;
  152556. /**
  152557. * Textures that should be present in the MRT for this effect to work
  152558. */
  152559. readonly texturesRequired: number[];
  152560. private _scene;
  152561. /**
  152562. * Builds a subsurface configuration object
  152563. * @param scene The scene
  152564. */
  152565. constructor(scene: Scene);
  152566. /**
  152567. * Adds a new diffusion profile.
  152568. * Useful for more realistic subsurface scattering on diverse materials.
  152569. * @param color The color of the diffusion profile. Should be the average color of the material.
  152570. * @return The index of the diffusion profile for the material subsurface configuration
  152571. */
  152572. addDiffusionProfile(color: Color3): number;
  152573. /**
  152574. * Creates the sss post process
  152575. * @return The created post process
  152576. */
  152577. createPostProcess(): SubSurfaceScatteringPostProcess;
  152578. /**
  152579. * Deletes all diffusion profiles.
  152580. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  152581. */
  152582. clearAllDiffusionProfiles(): void;
  152583. /**
  152584. * Disposes this object
  152585. */
  152586. dispose(): void;
  152587. /**
  152588. * @hidden
  152589. * https://zero-radiance.github.io/post/sampling-diffusion/
  152590. *
  152591. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  152592. * ------------------------------------------------------------------------------------
  152593. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  152594. * PDF[r, phi, s] = r * R[r, phi, s]
  152595. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  152596. * ------------------------------------------------------------------------------------
  152597. * We importance sample the color channel with the widest scattering distance.
  152598. */
  152599. getDiffusionProfileParameters(color: Color3): number;
  152600. /**
  152601. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  152602. * 'u' is the random number (the value of the CDF): [0, 1).
  152603. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  152604. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  152605. */
  152606. private _sampleBurleyDiffusionProfile;
  152607. }
  152608. }
  152609. declare module BABYLON {
  152610. interface AbstractScene {
  152611. /** @hidden (Backing field) */
  152612. _subSurfaceConfiguration: Nullable<SubSurfaceConfiguration>;
  152613. /**
  152614. * Gets or Sets the current prepass renderer associated to the scene.
  152615. */
  152616. subSurfaceConfiguration: Nullable<SubSurfaceConfiguration>;
  152617. /**
  152618. * Enables the subsurface effect for prepass
  152619. * @returns the SubSurfaceConfiguration
  152620. */
  152621. enableSubSurfaceForPrePass(): Nullable<SubSurfaceConfiguration>;
  152622. /**
  152623. * Disables the subsurface effect for prepass
  152624. */
  152625. disableSubSurfaceForPrePass(): void;
  152626. }
  152627. /**
  152628. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  152629. * in several rendering techniques.
  152630. */
  152631. export class SubSurfaceSceneComponent implements ISceneSerializableComponent {
  152632. /**
  152633. * The component name helpful to identify the component in the list of scene components.
  152634. */
  152635. readonly name: string;
  152636. /**
  152637. * The scene the component belongs to.
  152638. */
  152639. scene: Scene;
  152640. /**
  152641. * Creates a new instance of the component for the given scene
  152642. * @param scene Defines the scene to register the component in
  152643. */
  152644. constructor(scene: Scene);
  152645. /**
  152646. * Registers the component in a given scene
  152647. */
  152648. register(): void;
  152649. /**
  152650. * Serializes the component data to the specified json object
  152651. * @param serializationObject The object to serialize to
  152652. */
  152653. serialize(serializationObject: any): void;
  152654. /**
  152655. * Adds all the elements from the container to the scene
  152656. * @param container the container holding the elements
  152657. */
  152658. addFromContainer(container: AbstractScene): void;
  152659. /**
  152660. * Removes all the elements in the container from the scene
  152661. * @param container contains the elements to remove
  152662. * @param dispose if the removed element should be disposed (default: false)
  152663. */
  152664. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  152665. /**
  152666. * Rebuilds the elements related to this component in case of
  152667. * context lost for instance.
  152668. */
  152669. rebuild(): void;
  152670. /**
  152671. * Disposes the component and the associated ressources
  152672. */
  152673. dispose(): void;
  152674. }
  152675. }
  152676. declare module BABYLON {
  152677. /** @hidden */
  152678. export var outlinePixelShader: {
  152679. name: string;
  152680. shader: string;
  152681. };
  152682. }
  152683. declare module BABYLON {
  152684. /** @hidden */
  152685. export var outlineVertexShader: {
  152686. name: string;
  152687. shader: string;
  152688. };
  152689. }
  152690. declare module BABYLON {
  152691. interface Scene {
  152692. /** @hidden */
  152693. _outlineRenderer: OutlineRenderer;
  152694. /**
  152695. * Gets the outline renderer associated with the scene
  152696. * @returns a OutlineRenderer
  152697. */
  152698. getOutlineRenderer(): OutlineRenderer;
  152699. }
  152700. interface AbstractMesh {
  152701. /** @hidden (Backing field) */
  152702. _renderOutline: boolean;
  152703. /**
  152704. * Gets or sets a boolean indicating if the outline must be rendered as well
  152705. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  152706. */
  152707. renderOutline: boolean;
  152708. /** @hidden (Backing field) */
  152709. _renderOverlay: boolean;
  152710. /**
  152711. * Gets or sets a boolean indicating if the overlay must be rendered as well
  152712. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  152713. */
  152714. renderOverlay: boolean;
  152715. }
  152716. /**
  152717. * This class is responsible to draw bothe outline/overlay of meshes.
  152718. * It should not be used directly but through the available method on mesh.
  152719. */
  152720. export class OutlineRenderer implements ISceneComponent {
  152721. /**
  152722. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  152723. */
  152724. private static _StencilReference;
  152725. /**
  152726. * The name of the component. Each component must have a unique name.
  152727. */
  152728. name: string;
  152729. /**
  152730. * The scene the component belongs to.
  152731. */
  152732. scene: Scene;
  152733. /**
  152734. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  152735. */
  152736. zOffset: number;
  152737. private _engine;
  152738. private _effect;
  152739. private _cachedDefines;
  152740. private _savedDepthWrite;
  152741. /**
  152742. * Instantiates a new outline renderer. (There could be only one per scene).
  152743. * @param scene Defines the scene it belongs to
  152744. */
  152745. constructor(scene: Scene);
  152746. /**
  152747. * Register the component to one instance of a scene.
  152748. */
  152749. register(): void;
  152750. /**
  152751. * Rebuilds the elements related to this component in case of
  152752. * context lost for instance.
  152753. */
  152754. rebuild(): void;
  152755. /**
  152756. * Disposes the component and the associated ressources.
  152757. */
  152758. dispose(): void;
  152759. /**
  152760. * Renders the outline in the canvas.
  152761. * @param subMesh Defines the sumesh to render
  152762. * @param batch Defines the batch of meshes in case of instances
  152763. * @param useOverlay Defines if the rendering is for the overlay or the outline
  152764. */
  152765. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  152766. /**
  152767. * Returns whether or not the outline renderer is ready for a given submesh.
  152768. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  152769. * @param subMesh Defines the submesh to check readyness for
  152770. * @param useInstances Defines wheter wee are trying to render instances or not
  152771. * @returns true if ready otherwise false
  152772. */
  152773. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  152774. private _beforeRenderingMesh;
  152775. private _afterRenderingMesh;
  152776. }
  152777. }
  152778. declare module BABYLON {
  152779. /**
  152780. * Defines the basic options interface of a Sprite Frame Source Size.
  152781. */
  152782. export interface ISpriteJSONSpriteSourceSize {
  152783. /**
  152784. * number of the original width of the Frame
  152785. */
  152786. w: number;
  152787. /**
  152788. * number of the original height of the Frame
  152789. */
  152790. h: number;
  152791. }
  152792. /**
  152793. * Defines the basic options interface of a Sprite Frame Data.
  152794. */
  152795. export interface ISpriteJSONSpriteFrameData {
  152796. /**
  152797. * number of the x offset of the Frame
  152798. */
  152799. x: number;
  152800. /**
  152801. * number of the y offset of the Frame
  152802. */
  152803. y: number;
  152804. /**
  152805. * number of the width of the Frame
  152806. */
  152807. w: number;
  152808. /**
  152809. * number of the height of the Frame
  152810. */
  152811. h: number;
  152812. }
  152813. /**
  152814. * Defines the basic options interface of a JSON Sprite.
  152815. */
  152816. export interface ISpriteJSONSprite {
  152817. /**
  152818. * string name of the Frame
  152819. */
  152820. filename: string;
  152821. /**
  152822. * ISpriteJSONSpriteFrame basic object of the frame data
  152823. */
  152824. frame: ISpriteJSONSpriteFrameData;
  152825. /**
  152826. * boolean to flag is the frame was rotated.
  152827. */
  152828. rotated: boolean;
  152829. /**
  152830. * boolean to flag is the frame was trimmed.
  152831. */
  152832. trimmed: boolean;
  152833. /**
  152834. * ISpriteJSONSpriteFrame basic object of the source data
  152835. */
  152836. spriteSourceSize: ISpriteJSONSpriteFrameData;
  152837. /**
  152838. * ISpriteJSONSpriteFrame basic object of the source data
  152839. */
  152840. sourceSize: ISpriteJSONSpriteSourceSize;
  152841. }
  152842. /**
  152843. * Defines the basic options interface of a JSON atlas.
  152844. */
  152845. export interface ISpriteJSONAtlas {
  152846. /**
  152847. * Array of objects that contain the frame data.
  152848. */
  152849. frames: Array<ISpriteJSONSprite>;
  152850. /**
  152851. * object basic object containing the sprite meta data.
  152852. */
  152853. meta?: object;
  152854. }
  152855. }
  152856. declare module BABYLON {
  152857. /** @hidden */
  152858. export var spriteMapPixelShader: {
  152859. name: string;
  152860. shader: string;
  152861. };
  152862. }
  152863. declare module BABYLON {
  152864. /** @hidden */
  152865. export var spriteMapVertexShader: {
  152866. name: string;
  152867. shader: string;
  152868. };
  152869. }
  152870. declare module BABYLON {
  152871. /**
  152872. * Defines the basic options interface of a SpriteMap
  152873. */
  152874. export interface ISpriteMapOptions {
  152875. /**
  152876. * Vector2 of the number of cells in the grid.
  152877. */
  152878. stageSize?: Vector2;
  152879. /**
  152880. * Vector2 of the size of the output plane in World Units.
  152881. */
  152882. outputSize?: Vector2;
  152883. /**
  152884. * Vector3 of the position of the output plane in World Units.
  152885. */
  152886. outputPosition?: Vector3;
  152887. /**
  152888. * Vector3 of the rotation of the output plane.
  152889. */
  152890. outputRotation?: Vector3;
  152891. /**
  152892. * number of layers that the system will reserve in resources.
  152893. */
  152894. layerCount?: number;
  152895. /**
  152896. * number of max animation frames a single cell will reserve in resources.
  152897. */
  152898. maxAnimationFrames?: number;
  152899. /**
  152900. * number cell index of the base tile when the system compiles.
  152901. */
  152902. baseTile?: number;
  152903. /**
  152904. * boolean flip the sprite after its been repositioned by the framing data.
  152905. */
  152906. flipU?: boolean;
  152907. /**
  152908. * Vector3 scalar of the global RGB values of the SpriteMap.
  152909. */
  152910. colorMultiply?: Vector3;
  152911. }
  152912. /**
  152913. * Defines the IDisposable interface in order to be cleanable from resources.
  152914. */
  152915. export interface ISpriteMap extends IDisposable {
  152916. /**
  152917. * String name of the SpriteMap.
  152918. */
  152919. name: string;
  152920. /**
  152921. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  152922. */
  152923. atlasJSON: ISpriteJSONAtlas;
  152924. /**
  152925. * Texture of the SpriteMap.
  152926. */
  152927. spriteSheet: Texture;
  152928. /**
  152929. * The parameters to initialize the SpriteMap with.
  152930. */
  152931. options: ISpriteMapOptions;
  152932. }
  152933. /**
  152934. * Class used to manage a grid restricted sprite deployment on an Output plane.
  152935. */
  152936. export class SpriteMap implements ISpriteMap {
  152937. /** The Name of the spriteMap */
  152938. name: string;
  152939. /** The JSON file with the frame and meta data */
  152940. atlasJSON: ISpriteJSONAtlas;
  152941. /** The systems Sprite Sheet Texture */
  152942. spriteSheet: Texture;
  152943. /** Arguments passed with the Constructor */
  152944. options: ISpriteMapOptions;
  152945. /** Public Sprite Storage array, parsed from atlasJSON */
  152946. sprites: Array<ISpriteJSONSprite>;
  152947. /** Returns the Number of Sprites in the System */
  152948. get spriteCount(): number;
  152949. /** Returns the Position of Output Plane*/
  152950. get position(): Vector3;
  152951. /** Returns the Position of Output Plane*/
  152952. set position(v: Vector3);
  152953. /** Returns the Rotation of Output Plane*/
  152954. get rotation(): Vector3;
  152955. /** Returns the Rotation of Output Plane*/
  152956. set rotation(v: Vector3);
  152957. /** Sets the AnimationMap*/
  152958. get animationMap(): RawTexture;
  152959. /** Sets the AnimationMap*/
  152960. set animationMap(v: RawTexture);
  152961. /** Scene that the SpriteMap was created in */
  152962. private _scene;
  152963. /** Texture Buffer of Float32 that holds tile frame data*/
  152964. private _frameMap;
  152965. /** Texture Buffers of Float32 that holds tileMap data*/
  152966. private _tileMaps;
  152967. /** Texture Buffer of Float32 that holds Animation Data*/
  152968. private _animationMap;
  152969. /** Custom ShaderMaterial Central to the System*/
  152970. private _material;
  152971. /** Custom ShaderMaterial Central to the System*/
  152972. private _output;
  152973. /** Systems Time Ticker*/
  152974. private _time;
  152975. /**
  152976. * Creates a new SpriteMap
  152977. * @param name defines the SpriteMaps Name
  152978. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  152979. * @param spriteSheet is the Texture that the Sprites are on.
  152980. * @param options a basic deployment configuration
  152981. * @param scene The Scene that the map is deployed on
  152982. */
  152983. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  152984. /**
  152985. * Returns tileID location
  152986. * @returns Vector2 the cell position ID
  152987. */
  152988. getTileID(): Vector2;
  152989. /**
  152990. * Gets the UV location of the mouse over the SpriteMap.
  152991. * @returns Vector2 the UV position of the mouse interaction
  152992. */
  152993. getMousePosition(): Vector2;
  152994. /**
  152995. * Creates the "frame" texture Buffer
  152996. * -------------------------------------
  152997. * Structure of frames
  152998. * "filename": "Falling-Water-2.png",
  152999. * "frame": {"x":69,"y":103,"w":24,"h":32},
  153000. * "rotated": true,
  153001. * "trimmed": true,
  153002. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  153003. * "sourceSize": {"w":32,"h":32}
  153004. * @returns RawTexture of the frameMap
  153005. */
  153006. private _createFrameBuffer;
  153007. /**
  153008. * Creates the tileMap texture Buffer
  153009. * @param buffer normally and array of numbers, or a false to generate from scratch
  153010. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  153011. * @returns RawTexture of the tileMap
  153012. */
  153013. private _createTileBuffer;
  153014. /**
  153015. * Modifies the data of the tileMaps
  153016. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  153017. * @param pos is the iVector2 Coordinates of the Tile
  153018. * @param tile The SpriteIndex of the new Tile
  153019. */
  153020. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  153021. /**
  153022. * Creates the animationMap texture Buffer
  153023. * @param buffer normally and array of numbers, or a false to generate from scratch
  153024. * @returns RawTexture of the animationMap
  153025. */
  153026. private _createTileAnimationBuffer;
  153027. /**
  153028. * Modifies the data of the animationMap
  153029. * @param cellID is the Index of the Sprite
  153030. * @param _frame is the target Animation frame
  153031. * @param toCell is the Target Index of the next frame of the animation
  153032. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  153033. * @param speed is a global scalar of the time variable on the map.
  153034. */
  153035. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  153036. /**
  153037. * Exports the .tilemaps file
  153038. */
  153039. saveTileMaps(): void;
  153040. /**
  153041. * Imports the .tilemaps file
  153042. * @param url of the .tilemaps file
  153043. */
  153044. loadTileMaps(url: string): void;
  153045. /**
  153046. * Release associated resources
  153047. */
  153048. dispose(): void;
  153049. }
  153050. }
  153051. declare module BABYLON {
  153052. /**
  153053. * Class used to manage multiple sprites of different sizes on the same spritesheet
  153054. * @see https://doc.babylonjs.com/babylon101/sprites
  153055. */
  153056. export class SpritePackedManager extends SpriteManager {
  153057. /** defines the packed manager's name */
  153058. name: string;
  153059. /**
  153060. * Creates a new sprite manager from a packed sprite sheet
  153061. * @param name defines the manager's name
  153062. * @param imgUrl defines the sprite sheet url
  153063. * @param capacity defines the maximum allowed number of sprites
  153064. * @param scene defines the hosting scene
  153065. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  153066. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  153067. * @param samplingMode defines the smapling mode to use with spritesheet
  153068. * @param fromPacked set to true; do not alter
  153069. */
  153070. constructor(
  153071. /** defines the packed manager's name */
  153072. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  153073. }
  153074. }
  153075. declare module BABYLON {
  153076. /**
  153077. * Defines the list of states available for a task inside a AssetsManager
  153078. */
  153079. export enum AssetTaskState {
  153080. /**
  153081. * Initialization
  153082. */
  153083. INIT = 0,
  153084. /**
  153085. * Running
  153086. */
  153087. RUNNING = 1,
  153088. /**
  153089. * Done
  153090. */
  153091. DONE = 2,
  153092. /**
  153093. * Error
  153094. */
  153095. ERROR = 3
  153096. }
  153097. /**
  153098. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  153099. */
  153100. export abstract class AbstractAssetTask {
  153101. /**
  153102. * Task name
  153103. */ name: string;
  153104. /**
  153105. * Callback called when the task is successful
  153106. */
  153107. onSuccess: (task: any) => void;
  153108. /**
  153109. * Callback called when the task is not successful
  153110. */
  153111. onError: (task: any, message?: string, exception?: any) => void;
  153112. /**
  153113. * Creates a new AssetsManager
  153114. * @param name defines the name of the task
  153115. */
  153116. constructor(
  153117. /**
  153118. * Task name
  153119. */ name: string);
  153120. private _isCompleted;
  153121. private _taskState;
  153122. private _errorObject;
  153123. /**
  153124. * Get if the task is completed
  153125. */
  153126. get isCompleted(): boolean;
  153127. /**
  153128. * Gets the current state of the task
  153129. */
  153130. get taskState(): AssetTaskState;
  153131. /**
  153132. * Gets the current error object (if task is in error)
  153133. */
  153134. get errorObject(): {
  153135. message?: string;
  153136. exception?: any;
  153137. };
  153138. /**
  153139. * Internal only
  153140. * @hidden
  153141. */
  153142. _setErrorObject(message?: string, exception?: any): void;
  153143. /**
  153144. * Execute the current task
  153145. * @param scene defines the scene where you want your assets to be loaded
  153146. * @param onSuccess is a callback called when the task is successfully executed
  153147. * @param onError is a callback called if an error occurs
  153148. */
  153149. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  153150. /**
  153151. * Execute the current task
  153152. * @param scene defines the scene where you want your assets to be loaded
  153153. * @param onSuccess is a callback called when the task is successfully executed
  153154. * @param onError is a callback called if an error occurs
  153155. */
  153156. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  153157. /**
  153158. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  153159. * This can be used with failed tasks that have the reason for failure fixed.
  153160. */
  153161. reset(): void;
  153162. private onErrorCallback;
  153163. private onDoneCallback;
  153164. }
  153165. /**
  153166. * Define the interface used by progress events raised during assets loading
  153167. */
  153168. export interface IAssetsProgressEvent {
  153169. /**
  153170. * Defines the number of remaining tasks to process
  153171. */
  153172. remainingCount: number;
  153173. /**
  153174. * Defines the total number of tasks
  153175. */
  153176. totalCount: number;
  153177. /**
  153178. * Defines the task that was just processed
  153179. */
  153180. task: AbstractAssetTask;
  153181. }
  153182. /**
  153183. * Class used to share progress information about assets loading
  153184. */
  153185. export class AssetsProgressEvent implements IAssetsProgressEvent {
  153186. /**
  153187. * Defines the number of remaining tasks to process
  153188. */
  153189. remainingCount: number;
  153190. /**
  153191. * Defines the total number of tasks
  153192. */
  153193. totalCount: number;
  153194. /**
  153195. * Defines the task that was just processed
  153196. */
  153197. task: AbstractAssetTask;
  153198. /**
  153199. * Creates a AssetsProgressEvent
  153200. * @param remainingCount defines the number of remaining tasks to process
  153201. * @param totalCount defines the total number of tasks
  153202. * @param task defines the task that was just processed
  153203. */
  153204. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  153205. }
  153206. /**
  153207. * Define a task used by AssetsManager to load assets into a container
  153208. */
  153209. export class ContainerAssetTask extends AbstractAssetTask {
  153210. /**
  153211. * Defines the name of the task
  153212. */
  153213. name: string;
  153214. /**
  153215. * Defines the list of mesh's names you want to load
  153216. */
  153217. meshesNames: any;
  153218. /**
  153219. * Defines the root url to use as a base to load your meshes and associated resources
  153220. */
  153221. rootUrl: string;
  153222. /**
  153223. * Defines the filename or File of the scene to load from
  153224. */
  153225. sceneFilename: string | File;
  153226. /**
  153227. * Get the loaded asset container
  153228. */
  153229. loadedContainer: AssetContainer;
  153230. /**
  153231. * Gets the list of loaded meshes
  153232. */
  153233. loadedMeshes: Array<AbstractMesh>;
  153234. /**
  153235. * Gets the list of loaded particle systems
  153236. */
  153237. loadedParticleSystems: Array<IParticleSystem>;
  153238. /**
  153239. * Gets the list of loaded skeletons
  153240. */
  153241. loadedSkeletons: Array<Skeleton>;
  153242. /**
  153243. * Gets the list of loaded animation groups
  153244. */
  153245. loadedAnimationGroups: Array<AnimationGroup>;
  153246. /**
  153247. * Callback called when the task is successful
  153248. */
  153249. onSuccess: (task: ContainerAssetTask) => void;
  153250. /**
  153251. * Callback called when the task is successful
  153252. */
  153253. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  153254. /**
  153255. * Creates a new ContainerAssetTask
  153256. * @param name defines the name of the task
  153257. * @param meshesNames defines the list of mesh's names you want to load
  153258. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  153259. * @param sceneFilename defines the filename or File of the scene to load from
  153260. */
  153261. constructor(
  153262. /**
  153263. * Defines the name of the task
  153264. */
  153265. name: string,
  153266. /**
  153267. * Defines the list of mesh's names you want to load
  153268. */
  153269. meshesNames: any,
  153270. /**
  153271. * Defines the root url to use as a base to load your meshes and associated resources
  153272. */
  153273. rootUrl: string,
  153274. /**
  153275. * Defines the filename or File of the scene to load from
  153276. */
  153277. sceneFilename: string | File);
  153278. /**
  153279. * Execute the current task
  153280. * @param scene defines the scene where you want your assets to be loaded
  153281. * @param onSuccess is a callback called when the task is successfully executed
  153282. * @param onError is a callback called if an error occurs
  153283. */
  153284. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  153285. }
  153286. /**
  153287. * Define a task used by AssetsManager to load meshes
  153288. */
  153289. export class MeshAssetTask extends AbstractAssetTask {
  153290. /**
  153291. * Defines the name of the task
  153292. */
  153293. name: string;
  153294. /**
  153295. * Defines the list of mesh's names you want to load
  153296. */
  153297. meshesNames: any;
  153298. /**
  153299. * Defines the root url to use as a base to load your meshes and associated resources
  153300. */
  153301. rootUrl: string;
  153302. /**
  153303. * Defines the filename or File of the scene to load from
  153304. */
  153305. sceneFilename: string | File;
  153306. /**
  153307. * Gets the list of loaded meshes
  153308. */
  153309. loadedMeshes: Array<AbstractMesh>;
  153310. /**
  153311. * Gets the list of loaded particle systems
  153312. */
  153313. loadedParticleSystems: Array<IParticleSystem>;
  153314. /**
  153315. * Gets the list of loaded skeletons
  153316. */
  153317. loadedSkeletons: Array<Skeleton>;
  153318. /**
  153319. * Gets the list of loaded animation groups
  153320. */
  153321. loadedAnimationGroups: Array<AnimationGroup>;
  153322. /**
  153323. * Callback called when the task is successful
  153324. */
  153325. onSuccess: (task: MeshAssetTask) => void;
  153326. /**
  153327. * Callback called when the task is successful
  153328. */
  153329. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  153330. /**
  153331. * Creates a new MeshAssetTask
  153332. * @param name defines the name of the task
  153333. * @param meshesNames defines the list of mesh's names you want to load
  153334. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  153335. * @param sceneFilename defines the filename or File of the scene to load from
  153336. */
  153337. constructor(
  153338. /**
  153339. * Defines the name of the task
  153340. */
  153341. name: string,
  153342. /**
  153343. * Defines the list of mesh's names you want to load
  153344. */
  153345. meshesNames: any,
  153346. /**
  153347. * Defines the root url to use as a base to load your meshes and associated resources
  153348. */
  153349. rootUrl: string,
  153350. /**
  153351. * Defines the filename or File of the scene to load from
  153352. */
  153353. sceneFilename: string | File);
  153354. /**
  153355. * Execute the current task
  153356. * @param scene defines the scene where you want your assets to be loaded
  153357. * @param onSuccess is a callback called when the task is successfully executed
  153358. * @param onError is a callback called if an error occurs
  153359. */
  153360. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  153361. }
  153362. /**
  153363. * Define a task used by AssetsManager to load text content
  153364. */
  153365. export class TextFileAssetTask extends AbstractAssetTask {
  153366. /**
  153367. * Defines the name of the task
  153368. */
  153369. name: string;
  153370. /**
  153371. * Defines the location of the file to load
  153372. */
  153373. url: string;
  153374. /**
  153375. * Gets the loaded text string
  153376. */
  153377. text: string;
  153378. /**
  153379. * Callback called when the task is successful
  153380. */
  153381. onSuccess: (task: TextFileAssetTask) => void;
  153382. /**
  153383. * Callback called when the task is successful
  153384. */
  153385. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  153386. /**
  153387. * Creates a new TextFileAssetTask object
  153388. * @param name defines the name of the task
  153389. * @param url defines the location of the file to load
  153390. */
  153391. constructor(
  153392. /**
  153393. * Defines the name of the task
  153394. */
  153395. name: string,
  153396. /**
  153397. * Defines the location of the file to load
  153398. */
  153399. url: string);
  153400. /**
  153401. * Execute the current task
  153402. * @param scene defines the scene where you want your assets to be loaded
  153403. * @param onSuccess is a callback called when the task is successfully executed
  153404. * @param onError is a callback called if an error occurs
  153405. */
  153406. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  153407. }
  153408. /**
  153409. * Define a task used by AssetsManager to load binary data
  153410. */
  153411. export class BinaryFileAssetTask extends AbstractAssetTask {
  153412. /**
  153413. * Defines the name of the task
  153414. */
  153415. name: string;
  153416. /**
  153417. * Defines the location of the file to load
  153418. */
  153419. url: string;
  153420. /**
  153421. * Gets the lodaded data (as an array buffer)
  153422. */
  153423. data: ArrayBuffer;
  153424. /**
  153425. * Callback called when the task is successful
  153426. */
  153427. onSuccess: (task: BinaryFileAssetTask) => void;
  153428. /**
  153429. * Callback called when the task is successful
  153430. */
  153431. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  153432. /**
  153433. * Creates a new BinaryFileAssetTask object
  153434. * @param name defines the name of the new task
  153435. * @param url defines the location of the file to load
  153436. */
  153437. constructor(
  153438. /**
  153439. * Defines the name of the task
  153440. */
  153441. name: string,
  153442. /**
  153443. * Defines the location of the file to load
  153444. */
  153445. url: string);
  153446. /**
  153447. * Execute the current task
  153448. * @param scene defines the scene where you want your assets to be loaded
  153449. * @param onSuccess is a callback called when the task is successfully executed
  153450. * @param onError is a callback called if an error occurs
  153451. */
  153452. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  153453. }
  153454. /**
  153455. * Define a task used by AssetsManager to load images
  153456. */
  153457. export class ImageAssetTask extends AbstractAssetTask {
  153458. /**
  153459. * Defines the name of the task
  153460. */
  153461. name: string;
  153462. /**
  153463. * Defines the location of the image to load
  153464. */
  153465. url: string;
  153466. /**
  153467. * Gets the loaded images
  153468. */
  153469. image: HTMLImageElement;
  153470. /**
  153471. * Callback called when the task is successful
  153472. */
  153473. onSuccess: (task: ImageAssetTask) => void;
  153474. /**
  153475. * Callback called when the task is successful
  153476. */
  153477. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  153478. /**
  153479. * Creates a new ImageAssetTask
  153480. * @param name defines the name of the task
  153481. * @param url defines the location of the image to load
  153482. */
  153483. constructor(
  153484. /**
  153485. * Defines the name of the task
  153486. */
  153487. name: string,
  153488. /**
  153489. * Defines the location of the image to load
  153490. */
  153491. url: string);
  153492. /**
  153493. * Execute the current task
  153494. * @param scene defines the scene where you want your assets to be loaded
  153495. * @param onSuccess is a callback called when the task is successfully executed
  153496. * @param onError is a callback called if an error occurs
  153497. */
  153498. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  153499. }
  153500. /**
  153501. * Defines the interface used by texture loading tasks
  153502. */
  153503. export interface ITextureAssetTask<TEX extends BaseTexture> {
  153504. /**
  153505. * Gets the loaded texture
  153506. */
  153507. texture: TEX;
  153508. }
  153509. /**
  153510. * Define a task used by AssetsManager to load 2D textures
  153511. */
  153512. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  153513. /**
  153514. * Defines the name of the task
  153515. */
  153516. name: string;
  153517. /**
  153518. * Defines the location of the file to load
  153519. */
  153520. url: string;
  153521. /**
  153522. * Defines if mipmap should not be generated (default is false)
  153523. */
  153524. noMipmap?: boolean | undefined;
  153525. /**
  153526. * Defines if texture must be inverted on Y axis (default is true)
  153527. */
  153528. invertY: boolean;
  153529. /**
  153530. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  153531. */
  153532. samplingMode: number;
  153533. /**
  153534. * Gets the loaded texture
  153535. */
  153536. texture: Texture;
  153537. /**
  153538. * Callback called when the task is successful
  153539. */
  153540. onSuccess: (task: TextureAssetTask) => void;
  153541. /**
  153542. * Callback called when the task is successful
  153543. */
  153544. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  153545. /**
  153546. * Creates a new TextureAssetTask object
  153547. * @param name defines the name of the task
  153548. * @param url defines the location of the file to load
  153549. * @param noMipmap defines if mipmap should not be generated (default is false)
  153550. * @param invertY defines if texture must be inverted on Y axis (default is true)
  153551. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  153552. */
  153553. constructor(
  153554. /**
  153555. * Defines the name of the task
  153556. */
  153557. name: string,
  153558. /**
  153559. * Defines the location of the file to load
  153560. */
  153561. url: string,
  153562. /**
  153563. * Defines if mipmap should not be generated (default is false)
  153564. */
  153565. noMipmap?: boolean | undefined,
  153566. /**
  153567. * Defines if texture must be inverted on Y axis (default is true)
  153568. */
  153569. invertY?: boolean,
  153570. /**
  153571. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  153572. */
  153573. samplingMode?: number);
  153574. /**
  153575. * Execute the current task
  153576. * @param scene defines the scene where you want your assets to be loaded
  153577. * @param onSuccess is a callback called when the task is successfully executed
  153578. * @param onError is a callback called if an error occurs
  153579. */
  153580. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  153581. }
  153582. /**
  153583. * Define a task used by AssetsManager to load cube textures
  153584. */
  153585. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  153586. /**
  153587. * Defines the name of the task
  153588. */
  153589. name: string;
  153590. /**
  153591. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  153592. */
  153593. url: string;
  153594. /**
  153595. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  153596. */
  153597. extensions?: string[] | undefined;
  153598. /**
  153599. * Defines if mipmaps should not be generated (default is false)
  153600. */
  153601. noMipmap?: boolean | undefined;
  153602. /**
  153603. * Defines the explicit list of files (undefined by default)
  153604. */
  153605. files?: string[] | undefined;
  153606. /**
  153607. * Gets the loaded texture
  153608. */
  153609. texture: CubeTexture;
  153610. /**
  153611. * Callback called when the task is successful
  153612. */
  153613. onSuccess: (task: CubeTextureAssetTask) => void;
  153614. /**
  153615. * Callback called when the task is successful
  153616. */
  153617. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  153618. /**
  153619. * Creates a new CubeTextureAssetTask
  153620. * @param name defines the name of the task
  153621. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  153622. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  153623. * @param noMipmap defines if mipmaps should not be generated (default is false)
  153624. * @param files defines the explicit list of files (undefined by default)
  153625. */
  153626. constructor(
  153627. /**
  153628. * Defines the name of the task
  153629. */
  153630. name: string,
  153631. /**
  153632. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  153633. */
  153634. url: string,
  153635. /**
  153636. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  153637. */
  153638. extensions?: string[] | undefined,
  153639. /**
  153640. * Defines if mipmaps should not be generated (default is false)
  153641. */
  153642. noMipmap?: boolean | undefined,
  153643. /**
  153644. * Defines the explicit list of files (undefined by default)
  153645. */
  153646. files?: string[] | undefined);
  153647. /**
  153648. * Execute the current task
  153649. * @param scene defines the scene where you want your assets to be loaded
  153650. * @param onSuccess is a callback called when the task is successfully executed
  153651. * @param onError is a callback called if an error occurs
  153652. */
  153653. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  153654. }
  153655. /**
  153656. * Define a task used by AssetsManager to load HDR cube textures
  153657. */
  153658. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  153659. /**
  153660. * Defines the name of the task
  153661. */
  153662. name: string;
  153663. /**
  153664. * Defines the location of the file to load
  153665. */
  153666. url: string;
  153667. /**
  153668. * Defines the desired size (the more it increases the longer the generation will be)
  153669. */
  153670. size: number;
  153671. /**
  153672. * Defines if mipmaps should not be generated (default is false)
  153673. */
  153674. noMipmap: boolean;
  153675. /**
  153676. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  153677. */
  153678. generateHarmonics: boolean;
  153679. /**
  153680. * 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)
  153681. */
  153682. gammaSpace: boolean;
  153683. /**
  153684. * Internal Use Only
  153685. */
  153686. reserved: boolean;
  153687. /**
  153688. * Gets the loaded texture
  153689. */
  153690. texture: HDRCubeTexture;
  153691. /**
  153692. * Callback called when the task is successful
  153693. */
  153694. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  153695. /**
  153696. * Callback called when the task is successful
  153697. */
  153698. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  153699. /**
  153700. * Creates a new HDRCubeTextureAssetTask object
  153701. * @param name defines the name of the task
  153702. * @param url defines the location of the file to load
  153703. * @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.
  153704. * @param noMipmap defines if mipmaps should not be generated (default is false)
  153705. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  153706. * @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)
  153707. * @param reserved Internal use only
  153708. */
  153709. constructor(
  153710. /**
  153711. * Defines the name of the task
  153712. */
  153713. name: string,
  153714. /**
  153715. * Defines the location of the file to load
  153716. */
  153717. url: string,
  153718. /**
  153719. * Defines the desired size (the more it increases the longer the generation will be)
  153720. */
  153721. size: number,
  153722. /**
  153723. * Defines if mipmaps should not be generated (default is false)
  153724. */
  153725. noMipmap?: boolean,
  153726. /**
  153727. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  153728. */
  153729. generateHarmonics?: boolean,
  153730. /**
  153731. * 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)
  153732. */
  153733. gammaSpace?: boolean,
  153734. /**
  153735. * Internal Use Only
  153736. */
  153737. reserved?: boolean);
  153738. /**
  153739. * Execute the current task
  153740. * @param scene defines the scene where you want your assets to be loaded
  153741. * @param onSuccess is a callback called when the task is successfully executed
  153742. * @param onError is a callback called if an error occurs
  153743. */
  153744. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  153745. }
  153746. /**
  153747. * Define a task used by AssetsManager to load Equirectangular cube textures
  153748. */
  153749. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  153750. /**
  153751. * Defines the name of the task
  153752. */
  153753. name: string;
  153754. /**
  153755. * Defines the location of the file to load
  153756. */
  153757. url: string;
  153758. /**
  153759. * Defines the desired size (the more it increases the longer the generation will be)
  153760. */
  153761. size: number;
  153762. /**
  153763. * Defines if mipmaps should not be generated (default is false)
  153764. */
  153765. noMipmap: boolean;
  153766. /**
  153767. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  153768. * but the standard material would require them in Gamma space) (default is true)
  153769. */
  153770. gammaSpace: boolean;
  153771. /**
  153772. * Gets the loaded texture
  153773. */
  153774. texture: EquiRectangularCubeTexture;
  153775. /**
  153776. * Callback called when the task is successful
  153777. */
  153778. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  153779. /**
  153780. * Callback called when the task is successful
  153781. */
  153782. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  153783. /**
  153784. * Creates a new EquiRectangularCubeTextureAssetTask object
  153785. * @param name defines the name of the task
  153786. * @param url defines the location of the file to load
  153787. * @param size defines the desired size (the more it increases the longer the generation will be)
  153788. * If the size is omitted this implies you are using a preprocessed cubemap.
  153789. * @param noMipmap defines if mipmaps should not be generated (default is false)
  153790. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  153791. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  153792. * (default is true)
  153793. */
  153794. constructor(
  153795. /**
  153796. * Defines the name of the task
  153797. */
  153798. name: string,
  153799. /**
  153800. * Defines the location of the file to load
  153801. */
  153802. url: string,
  153803. /**
  153804. * Defines the desired size (the more it increases the longer the generation will be)
  153805. */
  153806. size: number,
  153807. /**
  153808. * Defines if mipmaps should not be generated (default is false)
  153809. */
  153810. noMipmap?: boolean,
  153811. /**
  153812. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  153813. * but the standard material would require them in Gamma space) (default is true)
  153814. */
  153815. gammaSpace?: boolean);
  153816. /**
  153817. * Execute the current task
  153818. * @param scene defines the scene where you want your assets to be loaded
  153819. * @param onSuccess is a callback called when the task is successfully executed
  153820. * @param onError is a callback called if an error occurs
  153821. */
  153822. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  153823. }
  153824. /**
  153825. * This class can be used to easily import assets into a scene
  153826. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  153827. */
  153828. export class AssetsManager {
  153829. private _scene;
  153830. private _isLoading;
  153831. protected _tasks: AbstractAssetTask[];
  153832. protected _waitingTasksCount: number;
  153833. protected _totalTasksCount: number;
  153834. /**
  153835. * Callback called when all tasks are processed
  153836. */
  153837. onFinish: (tasks: AbstractAssetTask[]) => void;
  153838. /**
  153839. * Callback called when a task is successful
  153840. */
  153841. onTaskSuccess: (task: AbstractAssetTask) => void;
  153842. /**
  153843. * Callback called when a task had an error
  153844. */
  153845. onTaskError: (task: AbstractAssetTask) => void;
  153846. /**
  153847. * Callback called when a task is done (whatever the result is)
  153848. */
  153849. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  153850. /**
  153851. * Observable called when all tasks are processed
  153852. */
  153853. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  153854. /**
  153855. * Observable called when a task had an error
  153856. */
  153857. onTaskErrorObservable: Observable<AbstractAssetTask>;
  153858. /**
  153859. * Observable called when all tasks were executed
  153860. */
  153861. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  153862. /**
  153863. * Observable called when a task is done (whatever the result is)
  153864. */
  153865. onProgressObservable: Observable<IAssetsProgressEvent>;
  153866. /**
  153867. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  153868. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  153869. */
  153870. useDefaultLoadingScreen: boolean;
  153871. /**
  153872. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  153873. * when all assets have been downloaded.
  153874. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  153875. */
  153876. autoHideLoadingUI: boolean;
  153877. /**
  153878. * Creates a new AssetsManager
  153879. * @param scene defines the scene to work on
  153880. */
  153881. constructor(scene: Scene);
  153882. /**
  153883. * Add a ContainerAssetTask to the list of active tasks
  153884. * @param taskName defines the name of the new task
  153885. * @param meshesNames defines the name of meshes to load
  153886. * @param rootUrl defines the root url to use to locate files
  153887. * @param sceneFilename defines the filename of the scene file
  153888. * @returns a new ContainerAssetTask object
  153889. */
  153890. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  153891. /**
  153892. * Add a MeshAssetTask to the list of active tasks
  153893. * @param taskName defines the name of the new task
  153894. * @param meshesNames defines the name of meshes to load
  153895. * @param rootUrl defines the root url to use to locate files
  153896. * @param sceneFilename defines the filename of the scene file
  153897. * @returns a new MeshAssetTask object
  153898. */
  153899. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  153900. /**
  153901. * Add a TextFileAssetTask to the list of active tasks
  153902. * @param taskName defines the name of the new task
  153903. * @param url defines the url of the file to load
  153904. * @returns a new TextFileAssetTask object
  153905. */
  153906. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  153907. /**
  153908. * Add a BinaryFileAssetTask to the list of active tasks
  153909. * @param taskName defines the name of the new task
  153910. * @param url defines the url of the file to load
  153911. * @returns a new BinaryFileAssetTask object
  153912. */
  153913. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  153914. /**
  153915. * Add a ImageAssetTask to the list of active tasks
  153916. * @param taskName defines the name of the new task
  153917. * @param url defines the url of the file to load
  153918. * @returns a new ImageAssetTask object
  153919. */
  153920. addImageTask(taskName: string, url: string): ImageAssetTask;
  153921. /**
  153922. * Add a TextureAssetTask to the list of active tasks
  153923. * @param taskName defines the name of the new task
  153924. * @param url defines the url of the file to load
  153925. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  153926. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  153927. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  153928. * @returns a new TextureAssetTask object
  153929. */
  153930. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  153931. /**
  153932. * Add a CubeTextureAssetTask to the list of active tasks
  153933. * @param taskName defines the name of the new task
  153934. * @param url defines the url of the file to load
  153935. * @param extensions defines the extension to use to load the cube map (can be null)
  153936. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  153937. * @param files defines the list of files to load (can be null)
  153938. * @returns a new CubeTextureAssetTask object
  153939. */
  153940. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  153941. /**
  153942. *
  153943. * Add a HDRCubeTextureAssetTask to the list of active tasks
  153944. * @param taskName defines the name of the new task
  153945. * @param url defines the url of the file to load
  153946. * @param size defines the size you want for the cubemap (can be null)
  153947. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  153948. * @param generateHarmonics defines if you want to automatically generate (true by default)
  153949. * @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)
  153950. * @param reserved Internal use only
  153951. * @returns a new HDRCubeTextureAssetTask object
  153952. */
  153953. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  153954. /**
  153955. *
  153956. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  153957. * @param taskName defines the name of the new task
  153958. * @param url defines the url of the file to load
  153959. * @param size defines the size you want for the cubemap (can be null)
  153960. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  153961. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  153962. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  153963. * @returns a new EquiRectangularCubeTextureAssetTask object
  153964. */
  153965. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  153966. /**
  153967. * Remove a task from the assets manager.
  153968. * @param task the task to remove
  153969. */
  153970. removeTask(task: AbstractAssetTask): void;
  153971. private _decreaseWaitingTasksCount;
  153972. private _runTask;
  153973. /**
  153974. * Reset the AssetsManager and remove all tasks
  153975. * @return the current instance of the AssetsManager
  153976. */
  153977. reset(): AssetsManager;
  153978. /**
  153979. * Start the loading process
  153980. * @return the current instance of the AssetsManager
  153981. */
  153982. load(): AssetsManager;
  153983. /**
  153984. * Start the loading process as an async operation
  153985. * @return a promise returning the list of failed tasks
  153986. */
  153987. loadAsync(): Promise<void>;
  153988. }
  153989. }
  153990. declare module BABYLON {
  153991. /**
  153992. * Wrapper class for promise with external resolve and reject.
  153993. */
  153994. export class Deferred<T> {
  153995. /**
  153996. * The promise associated with this deferred object.
  153997. */
  153998. readonly promise: Promise<T>;
  153999. private _resolve;
  154000. private _reject;
  154001. /**
  154002. * The resolve method of the promise associated with this deferred object.
  154003. */
  154004. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  154005. /**
  154006. * The reject method of the promise associated with this deferred object.
  154007. */
  154008. get reject(): (reason?: any) => void;
  154009. /**
  154010. * Constructor for this deferred object.
  154011. */
  154012. constructor();
  154013. }
  154014. }
  154015. declare module BABYLON {
  154016. /**
  154017. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  154018. */
  154019. export class MeshExploder {
  154020. private _centerMesh;
  154021. private _meshes;
  154022. private _meshesOrigins;
  154023. private _toCenterVectors;
  154024. private _scaledDirection;
  154025. private _newPosition;
  154026. private _centerPosition;
  154027. /**
  154028. * Explodes meshes from a center mesh.
  154029. * @param meshes The meshes to explode.
  154030. * @param centerMesh The mesh to be center of explosion.
  154031. */
  154032. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  154033. private _setCenterMesh;
  154034. /**
  154035. * Get class name
  154036. * @returns "MeshExploder"
  154037. */
  154038. getClassName(): string;
  154039. /**
  154040. * "Exploded meshes"
  154041. * @returns Array of meshes with the centerMesh at index 0.
  154042. */
  154043. getMeshes(): Array<Mesh>;
  154044. /**
  154045. * Explodes meshes giving a specific direction
  154046. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  154047. */
  154048. explode(direction?: number): void;
  154049. }
  154050. }
  154051. declare module BABYLON {
  154052. /**
  154053. * Class used to help managing file picking and drag'n'drop
  154054. */
  154055. export class FilesInput {
  154056. /**
  154057. * List of files ready to be loaded
  154058. */
  154059. static get FilesToLoad(): {
  154060. [key: string]: File;
  154061. };
  154062. /**
  154063. * Callback called when a file is processed
  154064. */
  154065. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  154066. private _engine;
  154067. private _currentScene;
  154068. private _sceneLoadedCallback;
  154069. private _progressCallback;
  154070. private _additionalRenderLoopLogicCallback;
  154071. private _textureLoadingCallback;
  154072. private _startingProcessingFilesCallback;
  154073. private _onReloadCallback;
  154074. private _errorCallback;
  154075. private _elementToMonitor;
  154076. private _sceneFileToLoad;
  154077. private _filesToLoad;
  154078. /**
  154079. * Creates a new FilesInput
  154080. * @param engine defines the rendering engine
  154081. * @param scene defines the hosting scene
  154082. * @param sceneLoadedCallback callback called when scene is loaded
  154083. * @param progressCallback callback called to track progress
  154084. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  154085. * @param textureLoadingCallback callback called when a texture is loading
  154086. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  154087. * @param onReloadCallback callback called when a reload is requested
  154088. * @param errorCallback callback call if an error occurs
  154089. */
  154090. 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>);
  154091. private _dragEnterHandler;
  154092. private _dragOverHandler;
  154093. private _dropHandler;
  154094. /**
  154095. * Calls this function to listen to drag'n'drop events on a specific DOM element
  154096. * @param elementToMonitor defines the DOM element to track
  154097. */
  154098. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  154099. /** Gets the current list of files to load */
  154100. get filesToLoad(): File[];
  154101. /**
  154102. * Release all associated resources
  154103. */
  154104. dispose(): void;
  154105. private renderFunction;
  154106. private drag;
  154107. private drop;
  154108. private _traverseFolder;
  154109. private _processFiles;
  154110. /**
  154111. * Load files from a drop event
  154112. * @param event defines the drop event to use as source
  154113. */
  154114. loadFiles(event: any): void;
  154115. private _processReload;
  154116. /**
  154117. * Reload the current scene from the loaded files
  154118. */
  154119. reload(): void;
  154120. }
  154121. }
  154122. declare module BABYLON {
  154123. /**
  154124. * Defines the root class used to create scene optimization to use with SceneOptimizer
  154125. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  154126. */
  154127. export class SceneOptimization {
  154128. /**
  154129. * Defines the priority of this optimization (0 by default which means first in the list)
  154130. */
  154131. priority: number;
  154132. /**
  154133. * Gets a string describing the action executed by the current optimization
  154134. * @returns description string
  154135. */
  154136. getDescription(): string;
  154137. /**
  154138. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  154139. * @param scene defines the current scene where to apply this optimization
  154140. * @param optimizer defines the current optimizer
  154141. * @returns true if everything that can be done was applied
  154142. */
  154143. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  154144. /**
  154145. * Creates the SceneOptimization object
  154146. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  154147. * @param desc defines the description associated with the optimization
  154148. */
  154149. constructor(
  154150. /**
  154151. * Defines the priority of this optimization (0 by default which means first in the list)
  154152. */
  154153. priority?: number);
  154154. }
  154155. /**
  154156. * Defines an optimization used to reduce the size of render target textures
  154157. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  154158. */
  154159. export class TextureOptimization extends SceneOptimization {
  154160. /**
  154161. * Defines the priority of this optimization (0 by default which means first in the list)
  154162. */
  154163. priority: number;
  154164. /**
  154165. * 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
  154166. */
  154167. maximumSize: number;
  154168. /**
  154169. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  154170. */
  154171. step: number;
  154172. /**
  154173. * Gets a string describing the action executed by the current optimization
  154174. * @returns description string
  154175. */
  154176. getDescription(): string;
  154177. /**
  154178. * Creates the TextureOptimization object
  154179. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  154180. * @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
  154181. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  154182. */
  154183. constructor(
  154184. /**
  154185. * Defines the priority of this optimization (0 by default which means first in the list)
  154186. */
  154187. priority?: number,
  154188. /**
  154189. * 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
  154190. */
  154191. maximumSize?: number,
  154192. /**
  154193. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  154194. */
  154195. step?: number);
  154196. /**
  154197. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  154198. * @param scene defines the current scene where to apply this optimization
  154199. * @param optimizer defines the current optimizer
  154200. * @returns true if everything that can be done was applied
  154201. */
  154202. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  154203. }
  154204. /**
  154205. * Defines an optimization used to increase or decrease the rendering resolution
  154206. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  154207. */
  154208. export class HardwareScalingOptimization extends SceneOptimization {
  154209. /**
  154210. * Defines the priority of this optimization (0 by default which means first in the list)
  154211. */
  154212. priority: number;
  154213. /**
  154214. * Defines the maximum scale to use (2 by default)
  154215. */
  154216. maximumScale: number;
  154217. /**
  154218. * Defines the step to use between two passes (0.5 by default)
  154219. */
  154220. step: number;
  154221. private _currentScale;
  154222. private _directionOffset;
  154223. /**
  154224. * Gets a string describing the action executed by the current optimization
  154225. * @return description string
  154226. */
  154227. getDescription(): string;
  154228. /**
  154229. * Creates the HardwareScalingOptimization object
  154230. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  154231. * @param maximumScale defines the maximum scale to use (2 by default)
  154232. * @param step defines the step to use between two passes (0.5 by default)
  154233. */
  154234. constructor(
  154235. /**
  154236. * Defines the priority of this optimization (0 by default which means first in the list)
  154237. */
  154238. priority?: number,
  154239. /**
  154240. * Defines the maximum scale to use (2 by default)
  154241. */
  154242. maximumScale?: number,
  154243. /**
  154244. * Defines the step to use between two passes (0.5 by default)
  154245. */
  154246. step?: number);
  154247. /**
  154248. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  154249. * @param scene defines the current scene where to apply this optimization
  154250. * @param optimizer defines the current optimizer
  154251. * @returns true if everything that can be done was applied
  154252. */
  154253. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  154254. }
  154255. /**
  154256. * Defines an optimization used to remove shadows
  154257. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  154258. */
  154259. export class ShadowsOptimization extends SceneOptimization {
  154260. /**
  154261. * Gets a string describing the action executed by the current optimization
  154262. * @return description string
  154263. */
  154264. getDescription(): string;
  154265. /**
  154266. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  154267. * @param scene defines the current scene where to apply this optimization
  154268. * @param optimizer defines the current optimizer
  154269. * @returns true if everything that can be done was applied
  154270. */
  154271. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  154272. }
  154273. /**
  154274. * Defines an optimization used to turn post-processes off
  154275. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  154276. */
  154277. export class PostProcessesOptimization extends SceneOptimization {
  154278. /**
  154279. * Gets a string describing the action executed by the current optimization
  154280. * @return description string
  154281. */
  154282. getDescription(): string;
  154283. /**
  154284. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  154285. * @param scene defines the current scene where to apply this optimization
  154286. * @param optimizer defines the current optimizer
  154287. * @returns true if everything that can be done was applied
  154288. */
  154289. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  154290. }
  154291. /**
  154292. * Defines an optimization used to turn lens flares off
  154293. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  154294. */
  154295. export class LensFlaresOptimization extends SceneOptimization {
  154296. /**
  154297. * Gets a string describing the action executed by the current optimization
  154298. * @return description string
  154299. */
  154300. getDescription(): string;
  154301. /**
  154302. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  154303. * @param scene defines the current scene where to apply this optimization
  154304. * @param optimizer defines the current optimizer
  154305. * @returns true if everything that can be done was applied
  154306. */
  154307. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  154308. }
  154309. /**
  154310. * Defines an optimization based on user defined callback.
  154311. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  154312. */
  154313. export class CustomOptimization extends SceneOptimization {
  154314. /**
  154315. * Callback called to apply the custom optimization.
  154316. */
  154317. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  154318. /**
  154319. * Callback called to get custom description
  154320. */
  154321. onGetDescription: () => string;
  154322. /**
  154323. * Gets a string describing the action executed by the current optimization
  154324. * @returns description string
  154325. */
  154326. getDescription(): string;
  154327. /**
  154328. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  154329. * @param scene defines the current scene where to apply this optimization
  154330. * @param optimizer defines the current optimizer
  154331. * @returns true if everything that can be done was applied
  154332. */
  154333. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  154334. }
  154335. /**
  154336. * Defines an optimization used to turn particles off
  154337. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  154338. */
  154339. export class ParticlesOptimization extends SceneOptimization {
  154340. /**
  154341. * Gets a string describing the action executed by the current optimization
  154342. * @return description string
  154343. */
  154344. getDescription(): string;
  154345. /**
  154346. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  154347. * @param scene defines the current scene where to apply this optimization
  154348. * @param optimizer defines the current optimizer
  154349. * @returns true if everything that can be done was applied
  154350. */
  154351. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  154352. }
  154353. /**
  154354. * Defines an optimization used to turn render targets off
  154355. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  154356. */
  154357. export class RenderTargetsOptimization extends SceneOptimization {
  154358. /**
  154359. * Gets a string describing the action executed by the current optimization
  154360. * @return description string
  154361. */
  154362. getDescription(): string;
  154363. /**
  154364. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  154365. * @param scene defines the current scene where to apply this optimization
  154366. * @param optimizer defines the current optimizer
  154367. * @returns true if everything that can be done was applied
  154368. */
  154369. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  154370. }
  154371. /**
  154372. * Defines an optimization used to merge meshes with compatible materials
  154373. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  154374. */
  154375. export class MergeMeshesOptimization extends SceneOptimization {
  154376. private static _UpdateSelectionTree;
  154377. /**
  154378. * Gets or sets a boolean which defines if optimization octree has to be updated
  154379. */
  154380. static get UpdateSelectionTree(): boolean;
  154381. /**
  154382. * Gets or sets a boolean which defines if optimization octree has to be updated
  154383. */
  154384. static set UpdateSelectionTree(value: boolean);
  154385. /**
  154386. * Gets a string describing the action executed by the current optimization
  154387. * @return description string
  154388. */
  154389. getDescription(): string;
  154390. private _canBeMerged;
  154391. /**
  154392. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  154393. * @param scene defines the current scene where to apply this optimization
  154394. * @param optimizer defines the current optimizer
  154395. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  154396. * @returns true if everything that can be done was applied
  154397. */
  154398. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  154399. }
  154400. /**
  154401. * Defines a list of options used by SceneOptimizer
  154402. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  154403. */
  154404. export class SceneOptimizerOptions {
  154405. /**
  154406. * Defines the target frame rate to reach (60 by default)
  154407. */
  154408. targetFrameRate: number;
  154409. /**
  154410. * Defines the interval between two checkes (2000ms by default)
  154411. */
  154412. trackerDuration: number;
  154413. /**
  154414. * Gets the list of optimizations to apply
  154415. */
  154416. optimizations: SceneOptimization[];
  154417. /**
  154418. * Creates a new list of options used by SceneOptimizer
  154419. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  154420. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  154421. */
  154422. constructor(
  154423. /**
  154424. * Defines the target frame rate to reach (60 by default)
  154425. */
  154426. targetFrameRate?: number,
  154427. /**
  154428. * Defines the interval between two checkes (2000ms by default)
  154429. */
  154430. trackerDuration?: number);
  154431. /**
  154432. * Add a new optimization
  154433. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  154434. * @returns the current SceneOptimizerOptions
  154435. */
  154436. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  154437. /**
  154438. * Add a new custom optimization
  154439. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  154440. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  154441. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  154442. * @returns the current SceneOptimizerOptions
  154443. */
  154444. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  154445. /**
  154446. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  154447. * @param targetFrameRate defines the target frame rate (60 by default)
  154448. * @returns a SceneOptimizerOptions object
  154449. */
  154450. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  154451. /**
  154452. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  154453. * @param targetFrameRate defines the target frame rate (60 by default)
  154454. * @returns a SceneOptimizerOptions object
  154455. */
  154456. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  154457. /**
  154458. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  154459. * @param targetFrameRate defines the target frame rate (60 by default)
  154460. * @returns a SceneOptimizerOptions object
  154461. */
  154462. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  154463. }
  154464. /**
  154465. * Class used to run optimizations in order to reach a target frame rate
  154466. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  154467. */
  154468. export class SceneOptimizer implements IDisposable {
  154469. private _isRunning;
  154470. private _options;
  154471. private _scene;
  154472. private _currentPriorityLevel;
  154473. private _targetFrameRate;
  154474. private _trackerDuration;
  154475. private _currentFrameRate;
  154476. private _sceneDisposeObserver;
  154477. private _improvementMode;
  154478. /**
  154479. * Defines an observable called when the optimizer reaches the target frame rate
  154480. */
  154481. onSuccessObservable: Observable<SceneOptimizer>;
  154482. /**
  154483. * Defines an observable called when the optimizer enables an optimization
  154484. */
  154485. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  154486. /**
  154487. * Defines an observable called when the optimizer is not able to reach the target frame rate
  154488. */
  154489. onFailureObservable: Observable<SceneOptimizer>;
  154490. /**
  154491. * Gets a boolean indicating if the optimizer is in improvement mode
  154492. */
  154493. get isInImprovementMode(): boolean;
  154494. /**
  154495. * Gets the current priority level (0 at start)
  154496. */
  154497. get currentPriorityLevel(): number;
  154498. /**
  154499. * Gets the current frame rate checked by the SceneOptimizer
  154500. */
  154501. get currentFrameRate(): number;
  154502. /**
  154503. * Gets or sets the current target frame rate (60 by default)
  154504. */
  154505. get targetFrameRate(): number;
  154506. /**
  154507. * Gets or sets the current target frame rate (60 by default)
  154508. */
  154509. set targetFrameRate(value: number);
  154510. /**
  154511. * Gets or sets the current interval between two checks (every 2000ms by default)
  154512. */
  154513. get trackerDuration(): number;
  154514. /**
  154515. * Gets or sets the current interval between two checks (every 2000ms by default)
  154516. */
  154517. set trackerDuration(value: number);
  154518. /**
  154519. * Gets the list of active optimizations
  154520. */
  154521. get optimizations(): SceneOptimization[];
  154522. /**
  154523. * Creates a new SceneOptimizer
  154524. * @param scene defines the scene to work on
  154525. * @param options defines the options to use with the SceneOptimizer
  154526. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  154527. * @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)
  154528. */
  154529. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  154530. /**
  154531. * Stops the current optimizer
  154532. */
  154533. stop(): void;
  154534. /**
  154535. * Reset the optimizer to initial step (current priority level = 0)
  154536. */
  154537. reset(): void;
  154538. /**
  154539. * Start the optimizer. By default it will try to reach a specific framerate
  154540. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  154541. */
  154542. start(): void;
  154543. private _checkCurrentState;
  154544. /**
  154545. * Release all resources
  154546. */
  154547. dispose(): void;
  154548. /**
  154549. * Helper function to create a SceneOptimizer with one single line of code
  154550. * @param scene defines the scene to work on
  154551. * @param options defines the options to use with the SceneOptimizer
  154552. * @param onSuccess defines a callback to call on success
  154553. * @param onFailure defines a callback to call on failure
  154554. * @returns the new SceneOptimizer object
  154555. */
  154556. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  154557. }
  154558. }
  154559. declare module BABYLON {
  154560. /**
  154561. * Class used to serialize a scene into a string
  154562. */
  154563. export class SceneSerializer {
  154564. /**
  154565. * Clear cache used by a previous serialization
  154566. */
  154567. static ClearCache(): void;
  154568. /**
  154569. * Serialize a scene into a JSON compatible object
  154570. * @param scene defines the scene to serialize
  154571. * @returns a JSON compatible object
  154572. */
  154573. static Serialize(scene: Scene): any;
  154574. /**
  154575. * Serialize a mesh into a JSON compatible object
  154576. * @param toSerialize defines the mesh to serialize
  154577. * @param withParents defines if parents must be serialized as well
  154578. * @param withChildren defines if children must be serialized as well
  154579. * @returns a JSON compatible object
  154580. */
  154581. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  154582. }
  154583. }
  154584. declare module BABYLON {
  154585. /**
  154586. * Class used to host texture specific utilities
  154587. */
  154588. export class TextureTools {
  154589. /**
  154590. * Uses the GPU to create a copy texture rescaled at a given size
  154591. * @param texture Texture to copy from
  154592. * @param width defines the desired width
  154593. * @param height defines the desired height
  154594. * @param useBilinearMode defines if bilinear mode has to be used
  154595. * @return the generated texture
  154596. */
  154597. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  154598. }
  154599. }
  154600. declare module BABYLON {
  154601. /**
  154602. * This represents the different options available for the video capture.
  154603. */
  154604. export interface VideoRecorderOptions {
  154605. /** Defines the mime type of the video. */
  154606. mimeType: string;
  154607. /** Defines the FPS the video should be recorded at. */
  154608. fps: number;
  154609. /** Defines the chunk size for the recording data. */
  154610. recordChunckSize: number;
  154611. /** The audio tracks to attach to the recording. */
  154612. audioTracks?: MediaStreamTrack[];
  154613. }
  154614. /**
  154615. * This can help with recording videos from BabylonJS.
  154616. * This is based on the available WebRTC functionalities of the browser.
  154617. *
  154618. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  154619. */
  154620. export class VideoRecorder {
  154621. private static readonly _defaultOptions;
  154622. /**
  154623. * Returns whether or not the VideoRecorder is available in your browser.
  154624. * @param engine Defines the Babylon Engine.
  154625. * @returns true if supported otherwise false.
  154626. */
  154627. static IsSupported(engine: Engine): boolean;
  154628. private readonly _options;
  154629. private _canvas;
  154630. private _mediaRecorder;
  154631. private _recordedChunks;
  154632. private _fileName;
  154633. private _resolve;
  154634. private _reject;
  154635. /**
  154636. * True when a recording is already in progress.
  154637. */
  154638. get isRecording(): boolean;
  154639. /**
  154640. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  154641. * @param engine Defines the BabylonJS Engine you wish to record.
  154642. * @param options Defines options that can be used to customize the capture.
  154643. */
  154644. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  154645. /**
  154646. * Stops the current recording before the default capture timeout passed in the startRecording function.
  154647. */
  154648. stopRecording(): void;
  154649. /**
  154650. * Starts recording the canvas for a max duration specified in parameters.
  154651. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  154652. * If null no automatic download will start and you can rely on the promise to get the data back.
  154653. * @param maxDuration Defines the maximum recording time in seconds.
  154654. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  154655. * @return A promise callback at the end of the recording with the video data in Blob.
  154656. */
  154657. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  154658. /**
  154659. * Releases internal resources used during the recording.
  154660. */
  154661. dispose(): void;
  154662. private _handleDataAvailable;
  154663. private _handleError;
  154664. private _handleStop;
  154665. }
  154666. }
  154667. declare module BABYLON {
  154668. /**
  154669. * Class containing a set of static utilities functions for screenshots
  154670. */
  154671. export class ScreenshotTools {
  154672. /**
  154673. * Captures a screenshot of the current rendering
  154674. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  154675. * @param engine defines the rendering engine
  154676. * @param camera defines the source camera
  154677. * @param size This parameter can be set to a single number or to an object with the
  154678. * following (optional) properties: precision, width, height. If a single number is passed,
  154679. * it will be used for both width and height. If an object is passed, the screenshot size
  154680. * will be derived from the parameters. The precision property is a multiplier allowing
  154681. * rendering at a higher or lower resolution
  154682. * @param successCallback defines the callback receives a single parameter which contains the
  154683. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  154684. * src parameter of an <img> to display it
  154685. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  154686. * Check your browser for supported MIME types
  154687. */
  154688. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  154689. /**
  154690. * Captures a screenshot of the current rendering
  154691. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  154692. * @param engine defines the rendering engine
  154693. * @param camera defines the source camera
  154694. * @param size This parameter can be set to a single number or to an object with the
  154695. * following (optional) properties: precision, width, height. If a single number is passed,
  154696. * it will be used for both width and height. If an object is passed, the screenshot size
  154697. * will be derived from the parameters. The precision property is a multiplier allowing
  154698. * rendering at a higher or lower resolution
  154699. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  154700. * Check your browser for supported MIME types
  154701. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  154702. * to the src parameter of an <img> to display it
  154703. */
  154704. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  154705. /**
  154706. * Generates an image screenshot from the specified camera.
  154707. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  154708. * @param engine The engine to use for rendering
  154709. * @param camera The camera to use for rendering
  154710. * @param size This parameter can be set to a single number or to an object with the
  154711. * following (optional) properties: precision, width, height. If a single number is passed,
  154712. * it will be used for both width and height. If an object is passed, the screenshot size
  154713. * will be derived from the parameters. The precision property is a multiplier allowing
  154714. * rendering at a higher or lower resolution
  154715. * @param successCallback The callback receives a single parameter which contains the
  154716. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  154717. * src parameter of an <img> to display it
  154718. * @param mimeType The MIME type of the screenshot image (default: image/png).
  154719. * Check your browser for supported MIME types
  154720. * @param samples Texture samples (default: 1)
  154721. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  154722. * @param fileName A name for for the downloaded file.
  154723. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  154724. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  154725. */
  154726. 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;
  154727. /**
  154728. * Generates an image screenshot from the specified camera.
  154729. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  154730. * @param engine The engine to use for rendering
  154731. * @param camera The camera to use for rendering
  154732. * @param size This parameter can be set to a single number or to an object with the
  154733. * following (optional) properties: precision, width, height. If a single number is passed,
  154734. * it will be used for both width and height. If an object is passed, the screenshot size
  154735. * will be derived from the parameters. The precision property is a multiplier allowing
  154736. * rendering at a higher or lower resolution
  154737. * @param mimeType The MIME type of the screenshot image (default: image/png).
  154738. * Check your browser for supported MIME types
  154739. * @param samples Texture samples (default: 1)
  154740. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  154741. * @param fileName A name for for the downloaded file.
  154742. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  154743. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  154744. * to the src parameter of an <img> to display it
  154745. */
  154746. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  154747. /**
  154748. * Gets height and width for screenshot size
  154749. * @private
  154750. */
  154751. private static _getScreenshotSize;
  154752. }
  154753. }
  154754. declare module BABYLON {
  154755. /**
  154756. * Interface for a data buffer
  154757. */
  154758. export interface IDataBuffer {
  154759. /**
  154760. * Reads bytes from the data buffer.
  154761. * @param byteOffset The byte offset to read
  154762. * @param byteLength The byte length to read
  154763. * @returns A promise that resolves when the bytes are read
  154764. */
  154765. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  154766. /**
  154767. * The byte length of the buffer.
  154768. */
  154769. readonly byteLength: number;
  154770. }
  154771. /**
  154772. * Utility class for reading from a data buffer
  154773. */
  154774. export class DataReader {
  154775. /**
  154776. * The data buffer associated with this data reader.
  154777. */
  154778. readonly buffer: IDataBuffer;
  154779. /**
  154780. * The current byte offset from the beginning of the data buffer.
  154781. */
  154782. byteOffset: number;
  154783. private _dataView;
  154784. private _dataByteOffset;
  154785. /**
  154786. * Constructor
  154787. * @param buffer The buffer to read
  154788. */
  154789. constructor(buffer: IDataBuffer);
  154790. /**
  154791. * Loads the given byte length.
  154792. * @param byteLength The byte length to load
  154793. * @returns A promise that resolves when the load is complete
  154794. */
  154795. loadAsync(byteLength: number): Promise<void>;
  154796. /**
  154797. * Read a unsigned 32-bit integer from the currently loaded data range.
  154798. * @returns The 32-bit integer read
  154799. */
  154800. readUint32(): number;
  154801. /**
  154802. * Read a byte array from the currently loaded data range.
  154803. * @param byteLength The byte length to read
  154804. * @returns The byte array read
  154805. */
  154806. readUint8Array(byteLength: number): Uint8Array;
  154807. /**
  154808. * Read a string from the currently loaded data range.
  154809. * @param byteLength The byte length to read
  154810. * @returns The string read
  154811. */
  154812. readString(byteLength: number): string;
  154813. /**
  154814. * Skips the given byte length the currently loaded data range.
  154815. * @param byteLength The byte length to skip
  154816. */
  154817. skipBytes(byteLength: number): void;
  154818. }
  154819. }
  154820. declare module BABYLON {
  154821. /**
  154822. * Class for storing data to local storage if available or in-memory storage otherwise
  154823. */
  154824. export class DataStorage {
  154825. private static _Storage;
  154826. private static _GetStorage;
  154827. /**
  154828. * Reads a string from the data storage
  154829. * @param key The key to read
  154830. * @param defaultValue The value if the key doesn't exist
  154831. * @returns The string value
  154832. */
  154833. static ReadString(key: string, defaultValue: string): string;
  154834. /**
  154835. * Writes a string to the data storage
  154836. * @param key The key to write
  154837. * @param value The value to write
  154838. */
  154839. static WriteString(key: string, value: string): void;
  154840. /**
  154841. * Reads a boolean from the data storage
  154842. * @param key The key to read
  154843. * @param defaultValue The value if the key doesn't exist
  154844. * @returns The boolean value
  154845. */
  154846. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  154847. /**
  154848. * Writes a boolean to the data storage
  154849. * @param key The key to write
  154850. * @param value The value to write
  154851. */
  154852. static WriteBoolean(key: string, value: boolean): void;
  154853. /**
  154854. * Reads a number from the data storage
  154855. * @param key The key to read
  154856. * @param defaultValue The value if the key doesn't exist
  154857. * @returns The number value
  154858. */
  154859. static ReadNumber(key: string, defaultValue: number): number;
  154860. /**
  154861. * Writes a number to the data storage
  154862. * @param key The key to write
  154863. * @param value The value to write
  154864. */
  154865. static WriteNumber(key: string, value: number): void;
  154866. }
  154867. }
  154868. declare module BABYLON {
  154869. /**
  154870. * Class used to record delta files between 2 scene states
  154871. */
  154872. export class SceneRecorder {
  154873. private _trackedScene;
  154874. private _savedJSON;
  154875. /**
  154876. * Track a given scene. This means the current scene state will be considered the original state
  154877. * @param scene defines the scene to track
  154878. */
  154879. track(scene: Scene): void;
  154880. /**
  154881. * Get the delta between current state and original state
  154882. * @returns a string containing the delta
  154883. */
  154884. getDelta(): any;
  154885. private _compareArray;
  154886. private _compareObjects;
  154887. private _compareCollections;
  154888. private static GetShadowGeneratorById;
  154889. /**
  154890. * Apply a given delta to a given scene
  154891. * @param deltaJSON defines the JSON containing the delta
  154892. * @param scene defines the scene to apply the delta to
  154893. */
  154894. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  154895. private static _ApplyPropertiesToEntity;
  154896. private static _ApplyDeltaForEntity;
  154897. }
  154898. }
  154899. declare module BABYLON {
  154900. /**
  154901. * A 3D trajectory consisting of an order list of vectors describing a
  154902. * path of motion through 3D space.
  154903. */
  154904. export class Trajectory {
  154905. private _points;
  154906. private readonly _segmentLength;
  154907. /**
  154908. * Serialize to JSON.
  154909. * @returns serialized JSON string
  154910. */
  154911. serialize(): string;
  154912. /**
  154913. * Deserialize from JSON.
  154914. * @param json serialized JSON string
  154915. * @returns deserialized Trajectory
  154916. */
  154917. static Deserialize(json: string): Trajectory;
  154918. /**
  154919. * Create a new empty Trajectory.
  154920. * @param segmentLength radius of discretization for Trajectory points
  154921. */
  154922. constructor(segmentLength?: number);
  154923. /**
  154924. * Get the length of the Trajectory.
  154925. * @returns length of the Trajectory
  154926. */
  154927. getLength(): number;
  154928. /**
  154929. * Append a new point to the Trajectory.
  154930. * NOTE: This implementation has many allocations.
  154931. * @param point point to append to the Trajectory
  154932. */
  154933. add(point: DeepImmutable<Vector3>): void;
  154934. /**
  154935. * Create a new Trajectory with a segment length chosen to make it
  154936. * probable that the new Trajectory will have a specified number of
  154937. * segments. This operation is imprecise.
  154938. * @param targetResolution number of segments desired
  154939. * @returns new Trajectory with approximately the requested number of segments
  154940. */
  154941. resampleAtTargetResolution(targetResolution: number): Trajectory;
  154942. /**
  154943. * Convert Trajectory segments into tokenized representation. This
  154944. * representation is an array of numbers where each nth number is the
  154945. * index of the token which is most similar to the nth segment of the
  154946. * Trajectory.
  154947. * @param tokens list of vectors which serve as discrete tokens
  154948. * @returns list of indices of most similar token per segment
  154949. */
  154950. tokenize(tokens: DeepImmutable<Vector3[]>): number[];
  154951. private static _forwardDir;
  154952. private static _inverseFromVec;
  154953. private static _upDir;
  154954. private static _fromToVec;
  154955. private static _lookMatrix;
  154956. /**
  154957. * Transform the rotation (i.e., direction) of a segment to isolate
  154958. * the relative transformation represented by the segment. This operation
  154959. * may or may not succeed due to singularities in the equations that define
  154960. * motion relativity in this context.
  154961. * @param priorVec the origin of the prior segment
  154962. * @param fromVec the origin of the current segment
  154963. * @param toVec the destination of the current segment
  154964. * @param result reference to output variable
  154965. * @returns whether or not transformation was successful
  154966. */
  154967. private static _transformSegmentDirToRef;
  154968. private static _bestMatch;
  154969. private static _score;
  154970. private static _bestScore;
  154971. /**
  154972. * Determine which token vector is most similar to the
  154973. * segment vector.
  154974. * @param segment segment vector
  154975. * @param tokens token vector list
  154976. * @returns index of the most similar token to the segment
  154977. */
  154978. private static _tokenizeSegment;
  154979. }
  154980. /**
  154981. * Class representing a set of known, named trajectories to which Trajectories can be
  154982. * added and using which Trajectories can be recognized.
  154983. */
  154984. export class TrajectoryClassifier {
  154985. private _maximumAllowableMatchCost;
  154986. private _vector3Alphabet;
  154987. private _levenshteinAlphabet;
  154988. private _nameToDescribedTrajectory;
  154989. /**
  154990. * Serialize to JSON.
  154991. * @returns JSON serialization
  154992. */
  154993. serialize(): string;
  154994. /**
  154995. * Deserialize from JSON.
  154996. * @param json JSON serialization
  154997. * @returns deserialized TrajectorySet
  154998. */
  154999. static Deserialize(json: string): TrajectoryClassifier;
  155000. /**
  155001. * Initialize a new empty TrajectorySet with auto-generated Alphabets.
  155002. * VERY naive, need to be generating these things from known
  155003. * sets. Better version later, probably eliminating this one.
  155004. * @returns auto-generated TrajectorySet
  155005. */
  155006. static Generate(): TrajectoryClassifier;
  155007. private constructor();
  155008. /**
  155009. * Add a new Trajectory to the set with a given name.
  155010. * @param trajectory new Trajectory to be added
  155011. * @param classification name to which to add the Trajectory
  155012. */
  155013. addTrajectoryToClassification(trajectory: Trajectory, classification: string): void;
  155014. /**
  155015. * Remove a known named trajectory and all Trajectories associated with it.
  155016. * @param classification name to remove
  155017. * @returns whether anything was removed
  155018. */
  155019. deleteClassification(classification: string): boolean;
  155020. /**
  155021. * Attempt to recognize a Trajectory from among all the classifications
  155022. * already known to the classifier.
  155023. * @param trajectory Trajectory to be recognized
  155024. * @returns classification of Trajectory if recognized, null otherwise
  155025. */
  155026. classifyTrajectory(trajectory: Trajectory): Nullable<string>;
  155027. }
  155028. }
  155029. declare module BABYLON {
  155030. /**
  155031. * An interface for all Hit test features
  155032. */
  155033. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  155034. /**
  155035. * Triggered when new babylon (transformed) hit test results are available
  155036. */
  155037. onHitTestResultObservable: Observable<T[]>;
  155038. }
  155039. /**
  155040. * Options used for hit testing
  155041. */
  155042. export interface IWebXRLegacyHitTestOptions {
  155043. /**
  155044. * Only test when user interacted with the scene. Default - hit test every frame
  155045. */
  155046. testOnPointerDownOnly?: boolean;
  155047. /**
  155048. * The node to use to transform the local results to world coordinates
  155049. */
  155050. worldParentNode?: TransformNode;
  155051. }
  155052. /**
  155053. * Interface defining the babylon result of raycasting/hit-test
  155054. */
  155055. export interface IWebXRLegacyHitResult {
  155056. /**
  155057. * Transformation matrix that can be applied to a node that will put it in the hit point location
  155058. */
  155059. transformationMatrix: Matrix;
  155060. /**
  155061. * The native hit test result
  155062. */
  155063. xrHitResult: XRHitResult | XRHitTestResult;
  155064. }
  155065. /**
  155066. * The currently-working hit-test module.
  155067. * Hit test (or Ray-casting) is used to interact with the real world.
  155068. * For further information read here - https://github.com/immersive-web/hit-test
  155069. */
  155070. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  155071. /**
  155072. * options to use when constructing this feature
  155073. */
  155074. readonly options: IWebXRLegacyHitTestOptions;
  155075. private _direction;
  155076. private _mat;
  155077. private _onSelectEnabled;
  155078. private _origin;
  155079. /**
  155080. * The module's name
  155081. */
  155082. static readonly Name: string;
  155083. /**
  155084. * The (Babylon) version of this module.
  155085. * This is an integer representing the implementation version.
  155086. * This number does not correspond to the WebXR specs version
  155087. */
  155088. static readonly Version: number;
  155089. /**
  155090. * Populated with the last native XR Hit Results
  155091. */
  155092. lastNativeXRHitResults: XRHitResult[];
  155093. /**
  155094. * Triggered when new babylon (transformed) hit test results are available
  155095. */
  155096. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  155097. /**
  155098. * Creates a new instance of the (legacy version) hit test feature
  155099. * @param _xrSessionManager an instance of WebXRSessionManager
  155100. * @param options options to use when constructing this feature
  155101. */
  155102. constructor(_xrSessionManager: WebXRSessionManager,
  155103. /**
  155104. * options to use when constructing this feature
  155105. */
  155106. options?: IWebXRLegacyHitTestOptions);
  155107. /**
  155108. * execute a hit test with an XR Ray
  155109. *
  155110. * @param xrSession a native xrSession that will execute this hit test
  155111. * @param xrRay the ray (position and direction) to use for ray-casting
  155112. * @param referenceSpace native XR reference space to use for the hit-test
  155113. * @param filter filter function that will filter the results
  155114. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  155115. */
  155116. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  155117. /**
  155118. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  155119. * @param event the (select) event to use to select with
  155120. * @param referenceSpace the reference space to use for this hit test
  155121. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  155122. */
  155123. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  155124. /**
  155125. * attach this feature
  155126. * Will usually be called by the features manager
  155127. *
  155128. * @returns true if successful.
  155129. */
  155130. attach(): boolean;
  155131. /**
  155132. * detach this feature.
  155133. * Will usually be called by the features manager
  155134. *
  155135. * @returns true if successful.
  155136. */
  155137. detach(): boolean;
  155138. /**
  155139. * Dispose this feature and all of the resources attached
  155140. */
  155141. dispose(): void;
  155142. protected _onXRFrame(frame: XRFrame): void;
  155143. private _onHitTestResults;
  155144. private _onSelect;
  155145. }
  155146. }
  155147. declare module BABYLON {
  155148. /**
  155149. * Options used for hit testing (version 2)
  155150. */
  155151. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  155152. /**
  155153. * Do not create a permanent hit test. Will usually be used when only
  155154. * transient inputs are needed.
  155155. */
  155156. disablePermanentHitTest?: boolean;
  155157. /**
  155158. * Enable transient (for example touch-based) hit test inspections
  155159. */
  155160. enableTransientHitTest?: boolean;
  155161. /**
  155162. * Offset ray for the permanent hit test
  155163. */
  155164. offsetRay?: Vector3;
  155165. /**
  155166. * Offset ray for the transient hit test
  155167. */
  155168. transientOffsetRay?: Vector3;
  155169. /**
  155170. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  155171. */
  155172. useReferenceSpace?: boolean;
  155173. /**
  155174. * Override the default entity type(s) of the hit-test result
  155175. */
  155176. entityTypes?: XRHitTestTrackableType[];
  155177. }
  155178. /**
  155179. * Interface defining the babylon result of hit-test
  155180. */
  155181. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  155182. /**
  155183. * The input source that generated this hit test (if transient)
  155184. */
  155185. inputSource?: XRInputSource;
  155186. /**
  155187. * Is this a transient hit test
  155188. */
  155189. isTransient?: boolean;
  155190. /**
  155191. * Position of the hit test result
  155192. */
  155193. position: Vector3;
  155194. /**
  155195. * Rotation of the hit test result
  155196. */
  155197. rotationQuaternion: Quaternion;
  155198. /**
  155199. * The native hit test result
  155200. */
  155201. xrHitResult: XRHitTestResult;
  155202. }
  155203. /**
  155204. * The currently-working hit-test module.
  155205. * Hit test (or Ray-casting) is used to interact with the real world.
  155206. * For further information read here - https://github.com/immersive-web/hit-test
  155207. *
  155208. * Tested on chrome (mobile) 80.
  155209. */
  155210. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  155211. /**
  155212. * options to use when constructing this feature
  155213. */
  155214. readonly options: IWebXRHitTestOptions;
  155215. private _tmpMat;
  155216. private _tmpPos;
  155217. private _tmpQuat;
  155218. private _transientXrHitTestSource;
  155219. private _xrHitTestSource;
  155220. private initHitTestSource;
  155221. /**
  155222. * The module's name
  155223. */
  155224. static readonly Name: string;
  155225. /**
  155226. * The (Babylon) version of this module.
  155227. * This is an integer representing the implementation version.
  155228. * This number does not correspond to the WebXR specs version
  155229. */
  155230. static readonly Version: number;
  155231. /**
  155232. * When set to true, each hit test will have its own position/rotation objects
  155233. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  155234. * the developers will clone them or copy them as they see fit.
  155235. */
  155236. autoCloneTransformation: boolean;
  155237. /**
  155238. * Triggered when new babylon (transformed) hit test results are available
  155239. * Note - this will be called when results come back from the device. It can be an empty array!!
  155240. */
  155241. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  155242. /**
  155243. * Use this to temporarily pause hit test checks.
  155244. */
  155245. paused: boolean;
  155246. /**
  155247. * Creates a new instance of the hit test feature
  155248. * @param _xrSessionManager an instance of WebXRSessionManager
  155249. * @param options options to use when constructing this feature
  155250. */
  155251. constructor(_xrSessionManager: WebXRSessionManager,
  155252. /**
  155253. * options to use when constructing this feature
  155254. */
  155255. options?: IWebXRHitTestOptions);
  155256. /**
  155257. * attach this feature
  155258. * Will usually be called by the features manager
  155259. *
  155260. * @returns true if successful.
  155261. */
  155262. attach(): boolean;
  155263. /**
  155264. * detach this feature.
  155265. * Will usually be called by the features manager
  155266. *
  155267. * @returns true if successful.
  155268. */
  155269. detach(): boolean;
  155270. /**
  155271. * Dispose this feature and all of the resources attached
  155272. */
  155273. dispose(): void;
  155274. protected _onXRFrame(frame: XRFrame): void;
  155275. private _processWebXRHitTestResult;
  155276. }
  155277. }
  155278. declare module BABYLON {
  155279. /**
  155280. * Configuration options of the anchor system
  155281. */
  155282. export interface IWebXRAnchorSystemOptions {
  155283. /**
  155284. * a node that will be used to convert local to world coordinates
  155285. */
  155286. worldParentNode?: TransformNode;
  155287. /**
  155288. * If set to true a reference of the created anchors will be kept until the next session starts
  155289. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  155290. */
  155291. doNotRemoveAnchorsOnSessionEnded?: boolean;
  155292. }
  155293. /**
  155294. * A babylon container for an XR Anchor
  155295. */
  155296. export interface IWebXRAnchor {
  155297. /**
  155298. * A babylon-assigned ID for this anchor
  155299. */
  155300. id: number;
  155301. /**
  155302. * Transformation matrix to apply to an object attached to this anchor
  155303. */
  155304. transformationMatrix: Matrix;
  155305. /**
  155306. * The native anchor object
  155307. */
  155308. xrAnchor: XRAnchor;
  155309. /**
  155310. * if defined, this object will be constantly updated by the anchor's position and rotation
  155311. */
  155312. attachedNode?: TransformNode;
  155313. }
  155314. /**
  155315. * An implementation of the anchor system for WebXR.
  155316. * For further information see https://github.com/immersive-web/anchors/
  155317. */
  155318. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  155319. private _options;
  155320. private _lastFrameDetected;
  155321. private _trackedAnchors;
  155322. private _referenceSpaceForFrameAnchors;
  155323. private _futureAnchors;
  155324. /**
  155325. * The module's name
  155326. */
  155327. static readonly Name: string;
  155328. /**
  155329. * The (Babylon) version of this module.
  155330. * This is an integer representing the implementation version.
  155331. * This number does not correspond to the WebXR specs version
  155332. */
  155333. static readonly Version: number;
  155334. /**
  155335. * Observers registered here will be executed when a new anchor was added to the session
  155336. */
  155337. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  155338. /**
  155339. * Observers registered here will be executed when an anchor was removed from the session
  155340. */
  155341. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  155342. /**
  155343. * Observers registered here will be executed when an existing anchor updates
  155344. * This can execute N times every frame
  155345. */
  155346. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  155347. /**
  155348. * Set the reference space to use for anchor creation, when not using a hit test.
  155349. * Will default to the session's reference space if not defined
  155350. */
  155351. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  155352. /**
  155353. * constructs a new anchor system
  155354. * @param _xrSessionManager an instance of WebXRSessionManager
  155355. * @param _options configuration object for this feature
  155356. */
  155357. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  155358. private _tmpVector;
  155359. private _tmpQuaternion;
  155360. private _populateTmpTransformation;
  155361. /**
  155362. * Create a new anchor point using a hit test result at a specific point in the scene
  155363. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  155364. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  155365. *
  155366. * @param hitTestResult The hit test result to use for this anchor creation
  155367. * @param position an optional position offset for this anchor
  155368. * @param rotationQuaternion an optional rotation offset for this anchor
  155369. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  155370. */
  155371. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  155372. /**
  155373. * Add a new anchor at a specific position and rotation
  155374. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  155375. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  155376. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  155377. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  155378. *
  155379. * @param position the position in which to add an anchor
  155380. * @param rotationQuaternion an optional rotation for the anchor transformation
  155381. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  155382. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  155383. */
  155384. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  155385. /**
  155386. * detach this feature.
  155387. * Will usually be called by the features manager
  155388. *
  155389. * @returns true if successful.
  155390. */
  155391. detach(): boolean;
  155392. /**
  155393. * Dispose this feature and all of the resources attached
  155394. */
  155395. dispose(): void;
  155396. protected _onXRFrame(frame: XRFrame): void;
  155397. /**
  155398. * avoiding using Array.find for global support.
  155399. * @param xrAnchor the plane to find in the array
  155400. */
  155401. private _findIndexInAnchorArray;
  155402. private _updateAnchorWithXRFrame;
  155403. private _createAnchorAtTransformation;
  155404. }
  155405. }
  155406. declare module BABYLON {
  155407. /**
  155408. * Options used in the plane detector module
  155409. */
  155410. export interface IWebXRPlaneDetectorOptions {
  155411. /**
  155412. * The node to use to transform the local results to world coordinates
  155413. */
  155414. worldParentNode?: TransformNode;
  155415. /**
  155416. * If set to true a reference of the created planes will be kept until the next session starts
  155417. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  155418. */
  155419. doNotRemovePlanesOnSessionEnded?: boolean;
  155420. }
  155421. /**
  155422. * A babylon interface for a WebXR plane.
  155423. * A Plane is actually a polygon, built from N points in space
  155424. *
  155425. * Supported in chrome 79, not supported in canary 81 ATM
  155426. */
  155427. export interface IWebXRPlane {
  155428. /**
  155429. * a babylon-assigned ID for this polygon
  155430. */
  155431. id: number;
  155432. /**
  155433. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  155434. */
  155435. polygonDefinition: Array<Vector3>;
  155436. /**
  155437. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  155438. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  155439. */
  155440. transformationMatrix: Matrix;
  155441. /**
  155442. * the native xr-plane object
  155443. */
  155444. xrPlane: XRPlane;
  155445. }
  155446. /**
  155447. * The plane detector is used to detect planes in the real world when in AR
  155448. * For more information see https://github.com/immersive-web/real-world-geometry/
  155449. */
  155450. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  155451. private _options;
  155452. private _detectedPlanes;
  155453. private _enabled;
  155454. private _lastFrameDetected;
  155455. /**
  155456. * The module's name
  155457. */
  155458. static readonly Name: string;
  155459. /**
  155460. * The (Babylon) version of this module.
  155461. * This is an integer representing the implementation version.
  155462. * This number does not correspond to the WebXR specs version
  155463. */
  155464. static readonly Version: number;
  155465. /**
  155466. * Observers registered here will be executed when a new plane was added to the session
  155467. */
  155468. onPlaneAddedObservable: Observable<IWebXRPlane>;
  155469. /**
  155470. * Observers registered here will be executed when a plane is no longer detected in the session
  155471. */
  155472. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  155473. /**
  155474. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  155475. * This can execute N times every frame
  155476. */
  155477. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  155478. /**
  155479. * construct a new Plane Detector
  155480. * @param _xrSessionManager an instance of xr Session manager
  155481. * @param _options configuration to use when constructing this feature
  155482. */
  155483. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  155484. /**
  155485. * detach this feature.
  155486. * Will usually be called by the features manager
  155487. *
  155488. * @returns true if successful.
  155489. */
  155490. detach(): boolean;
  155491. /**
  155492. * Dispose this feature and all of the resources attached
  155493. */
  155494. dispose(): void;
  155495. protected _onXRFrame(frame: XRFrame): void;
  155496. private _init;
  155497. private _updatePlaneWithXRPlane;
  155498. /**
  155499. * avoiding using Array.find for global support.
  155500. * @param xrPlane the plane to find in the array
  155501. */
  155502. private findIndexInPlaneArray;
  155503. }
  155504. }
  155505. declare module BABYLON {
  155506. /**
  155507. * Options interface for the background remover plugin
  155508. */
  155509. export interface IWebXRBackgroundRemoverOptions {
  155510. /**
  155511. * Further background meshes to disable when entering AR
  155512. */
  155513. backgroundMeshes?: AbstractMesh[];
  155514. /**
  155515. * flags to configure the removal of the environment helper.
  155516. * If not set, the entire background will be removed. If set, flags should be set as well.
  155517. */
  155518. environmentHelperRemovalFlags?: {
  155519. /**
  155520. * Should the skybox be removed (default false)
  155521. */
  155522. skyBox?: boolean;
  155523. /**
  155524. * Should the ground be removed (default false)
  155525. */
  155526. ground?: boolean;
  155527. };
  155528. /**
  155529. * don't disable the environment helper
  155530. */
  155531. ignoreEnvironmentHelper?: boolean;
  155532. }
  155533. /**
  155534. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  155535. */
  155536. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  155537. /**
  155538. * read-only options to be used in this module
  155539. */
  155540. readonly options: IWebXRBackgroundRemoverOptions;
  155541. /**
  155542. * The module's name
  155543. */
  155544. static readonly Name: string;
  155545. /**
  155546. * The (Babylon) version of this module.
  155547. * This is an integer representing the implementation version.
  155548. * This number does not correspond to the WebXR specs version
  155549. */
  155550. static readonly Version: number;
  155551. /**
  155552. * registered observers will be triggered when the background state changes
  155553. */
  155554. onBackgroundStateChangedObservable: Observable<boolean>;
  155555. /**
  155556. * constructs a new background remover module
  155557. * @param _xrSessionManager the session manager for this module
  155558. * @param options read-only options to be used in this module
  155559. */
  155560. constructor(_xrSessionManager: WebXRSessionManager,
  155561. /**
  155562. * read-only options to be used in this module
  155563. */
  155564. options?: IWebXRBackgroundRemoverOptions);
  155565. /**
  155566. * attach this feature
  155567. * Will usually be called by the features manager
  155568. *
  155569. * @returns true if successful.
  155570. */
  155571. attach(): boolean;
  155572. /**
  155573. * detach this feature.
  155574. * Will usually be called by the features manager
  155575. *
  155576. * @returns true if successful.
  155577. */
  155578. detach(): boolean;
  155579. /**
  155580. * Dispose this feature and all of the resources attached
  155581. */
  155582. dispose(): void;
  155583. protected _onXRFrame(_xrFrame: XRFrame): void;
  155584. private _setBackgroundState;
  155585. }
  155586. }
  155587. declare module BABYLON {
  155588. /**
  155589. * Options for the controller physics feature
  155590. */
  155591. export class IWebXRControllerPhysicsOptions {
  155592. /**
  155593. * Should the headset get its own impostor
  155594. */
  155595. enableHeadsetImpostor?: boolean;
  155596. /**
  155597. * Optional parameters for the headset impostor
  155598. */
  155599. headsetImpostorParams?: {
  155600. /**
  155601. * The type of impostor to create. Default is sphere
  155602. */
  155603. impostorType: number;
  155604. /**
  155605. * the size of the impostor. Defaults to 10cm
  155606. */
  155607. impostorSize?: number | {
  155608. width: number;
  155609. height: number;
  155610. depth: number;
  155611. };
  155612. /**
  155613. * Friction definitions
  155614. */
  155615. friction?: number;
  155616. /**
  155617. * Restitution
  155618. */
  155619. restitution?: number;
  155620. };
  155621. /**
  155622. * The physics properties of the future impostors
  155623. */
  155624. physicsProperties?: {
  155625. /**
  155626. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  155627. * Note that this requires a physics engine that supports mesh impostors!
  155628. */
  155629. useControllerMesh?: boolean;
  155630. /**
  155631. * The type of impostor to create. Default is sphere
  155632. */
  155633. impostorType?: number;
  155634. /**
  155635. * the size of the impostor. Defaults to 10cm
  155636. */
  155637. impostorSize?: number | {
  155638. width: number;
  155639. height: number;
  155640. depth: number;
  155641. };
  155642. /**
  155643. * Friction definitions
  155644. */
  155645. friction?: number;
  155646. /**
  155647. * Restitution
  155648. */
  155649. restitution?: number;
  155650. };
  155651. /**
  155652. * the xr input to use with this pointer selection
  155653. */
  155654. xrInput: WebXRInput;
  155655. }
  155656. /**
  155657. * Add physics impostor to your webxr controllers,
  155658. * including naive calculation of their linear and angular velocity
  155659. */
  155660. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  155661. private readonly _options;
  155662. private _attachController;
  155663. private _controllers;
  155664. private _debugMode;
  155665. private _delta;
  155666. private _headsetImpostor?;
  155667. private _headsetMesh?;
  155668. private _lastTimestamp;
  155669. private _tmpQuaternion;
  155670. private _tmpVector;
  155671. /**
  155672. * The module's name
  155673. */
  155674. static readonly Name: string;
  155675. /**
  155676. * The (Babylon) version of this module.
  155677. * This is an integer representing the implementation version.
  155678. * This number does not correspond to the webxr specs version
  155679. */
  155680. static readonly Version: number;
  155681. /**
  155682. * Construct a new Controller Physics Feature
  155683. * @param _xrSessionManager the corresponding xr session manager
  155684. * @param _options options to create this feature with
  155685. */
  155686. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  155687. /**
  155688. * @hidden
  155689. * enable debugging - will show console outputs and the impostor mesh
  155690. */
  155691. _enablePhysicsDebug(): void;
  155692. /**
  155693. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  155694. * @param xrController the controller to add
  155695. */
  155696. addController(xrController: WebXRInputSource): void;
  155697. /**
  155698. * attach this feature
  155699. * Will usually be called by the features manager
  155700. *
  155701. * @returns true if successful.
  155702. */
  155703. attach(): boolean;
  155704. /**
  155705. * detach this feature.
  155706. * Will usually be called by the features manager
  155707. *
  155708. * @returns true if successful.
  155709. */
  155710. detach(): boolean;
  155711. /**
  155712. * Get the headset impostor, if enabled
  155713. * @returns the impostor
  155714. */
  155715. getHeadsetImpostor(): PhysicsImpostor | undefined;
  155716. /**
  155717. * Get the physics impostor of a specific controller.
  155718. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  155719. * @param controller the controller or the controller id of which to get the impostor
  155720. * @returns the impostor or null
  155721. */
  155722. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  155723. /**
  155724. * Update the physics properties provided in the constructor
  155725. * @param newProperties the new properties object
  155726. */
  155727. setPhysicsProperties(newProperties: {
  155728. impostorType?: number;
  155729. impostorSize?: number | {
  155730. width: number;
  155731. height: number;
  155732. depth: number;
  155733. };
  155734. friction?: number;
  155735. restitution?: number;
  155736. }): void;
  155737. protected _onXRFrame(_xrFrame: any): void;
  155738. private _detachController;
  155739. }
  155740. }
  155741. declare module BABYLON {
  155742. /**
  155743. * A babylon interface for a "WebXR" feature point.
  155744. * Represents the position and confidence value of a given feature point.
  155745. */
  155746. export interface IWebXRFeaturePoint {
  155747. /**
  155748. * Represents the position of the feature point in world space.
  155749. */
  155750. position: Vector3;
  155751. /**
  155752. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  155753. */
  155754. confidenceValue: number;
  155755. }
  155756. /**
  155757. * The feature point system is used to detect feature points from real world geometry.
  155758. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  155759. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  155760. */
  155761. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  155762. private _enabled;
  155763. private _featurePointCloud;
  155764. /**
  155765. * The module's name
  155766. */
  155767. static readonly Name: string;
  155768. /**
  155769. * The (Babylon) version of this module.
  155770. * This is an integer representing the implementation version.
  155771. * This number does not correspond to the WebXR specs version
  155772. */
  155773. static readonly Version: number;
  155774. /**
  155775. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  155776. * Will notify the observers about which feature points have been added.
  155777. */
  155778. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  155779. /**
  155780. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  155781. * Will notify the observers about which feature points have been updated.
  155782. */
  155783. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  155784. /**
  155785. * The current feature point cloud maintained across frames.
  155786. */
  155787. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  155788. /**
  155789. * construct the feature point system
  155790. * @param _xrSessionManager an instance of xr Session manager
  155791. */
  155792. constructor(_xrSessionManager: WebXRSessionManager);
  155793. /**
  155794. * Detach this feature.
  155795. * Will usually be called by the features manager
  155796. *
  155797. * @returns true if successful.
  155798. */
  155799. detach(): boolean;
  155800. /**
  155801. * Dispose this feature and all of the resources attached
  155802. */
  155803. dispose(): void;
  155804. /**
  155805. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  155806. */
  155807. protected _onXRFrame(frame: XRFrame): void;
  155808. /**
  155809. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  155810. */
  155811. private _init;
  155812. }
  155813. }
  155814. declare module BABYLON {
  155815. /**
  155816. * Configuration interface for the hand tracking feature
  155817. */
  155818. export interface IWebXRHandTrackingOptions {
  155819. /**
  155820. * The xrInput that will be used as source for new hands
  155821. */
  155822. xrInput: WebXRInput;
  155823. /**
  155824. * Configuration object for the joint meshes
  155825. */
  155826. jointMeshes?: {
  155827. /**
  155828. * Should the meshes created be invisible (defaults to false)
  155829. */
  155830. invisible?: boolean;
  155831. /**
  155832. * A source mesh to be used to create instances. Defaults to a sphere.
  155833. * This mesh will be the source for all other (25) meshes.
  155834. * It should have the general size of a single unit, as the instances will be scaled according to the provided radius
  155835. */
  155836. sourceMesh?: Mesh;
  155837. /**
  155838. * Should the source mesh stay visible. Defaults to false
  155839. */
  155840. keepOriginalVisible?: boolean;
  155841. /**
  155842. * Scale factor for all instances (defaults to 2)
  155843. */
  155844. scaleFactor?: number;
  155845. /**
  155846. * Should each instance have its own physics impostor
  155847. */
  155848. enablePhysics?: boolean;
  155849. /**
  155850. * If enabled, override default physics properties
  155851. */
  155852. physicsProps?: {
  155853. friction?: number;
  155854. restitution?: number;
  155855. impostorType?: number;
  155856. };
  155857. /**
  155858. * For future use - a single hand-mesh that will be updated according to the XRHand data provided
  155859. */
  155860. handMesh?: AbstractMesh;
  155861. };
  155862. }
  155863. /**
  155864. * Parts of the hands divided to writs and finger names
  155865. */
  155866. export const enum HandPart {
  155867. /**
  155868. * HandPart - Wrist
  155869. */
  155870. WRIST = "wrist",
  155871. /**
  155872. * HandPart - The THumb
  155873. */
  155874. THUMB = "thumb",
  155875. /**
  155876. * HandPart - Index finger
  155877. */
  155878. INDEX = "index",
  155879. /**
  155880. * HandPart - Middle finger
  155881. */
  155882. MIDDLE = "middle",
  155883. /**
  155884. * HandPart - Ring finger
  155885. */
  155886. RING = "ring",
  155887. /**
  155888. * HandPart - Little finger
  155889. */
  155890. LITTLE = "little"
  155891. }
  155892. /**
  155893. * Representing a single hand (with its corresponding native XRHand object)
  155894. */
  155895. export class WebXRHand implements IDisposable {
  155896. /** the controller to which the hand correlates */
  155897. readonly xrController: WebXRInputSource;
  155898. /** the meshes to be used to track the hand joints */
  155899. readonly trackedMeshes: AbstractMesh[];
  155900. /**
  155901. * Hand-parts definition (key is HandPart)
  155902. */
  155903. handPartsDefinition: {
  155904. [key: string]: number[];
  155905. };
  155906. /**
  155907. * Populate the HandPartsDefinition object.
  155908. * This is called as a side effect since certain browsers don't have XRHand defined.
  155909. */
  155910. private generateHandPartsDefinition;
  155911. /**
  155912. * Construct a new hand object
  155913. * @param xrController the controller to which the hand correlates
  155914. * @param trackedMeshes the meshes to be used to track the hand joints
  155915. */
  155916. constructor(
  155917. /** the controller to which the hand correlates */
  155918. xrController: WebXRInputSource,
  155919. /** the meshes to be used to track the hand joints */
  155920. trackedMeshes: AbstractMesh[]);
  155921. /**
  155922. * Update this hand from the latest xr frame
  155923. * @param xrFrame xrFrame to update from
  155924. * @param referenceSpace The current viewer reference space
  155925. * @param scaleFactor optional scale factor for the meshes
  155926. */
  155927. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace, scaleFactor?: number): void;
  155928. /**
  155929. * Get meshes of part of the hand
  155930. * @param part the part of hand to get
  155931. * @returns An array of meshes that correlate to the hand part requested
  155932. */
  155933. getHandPartMeshes(part: HandPart): AbstractMesh[];
  155934. /**
  155935. * Dispose this Hand object
  155936. */
  155937. dispose(): void;
  155938. }
  155939. /**
  155940. * WebXR Hand Joint tracking feature, available for selected browsers and devices
  155941. */
  155942. export class WebXRHandTracking extends WebXRAbstractFeature {
  155943. /**
  155944. * options to use when constructing this feature
  155945. */
  155946. readonly options: IWebXRHandTrackingOptions;
  155947. private static _idCounter;
  155948. /**
  155949. * The module's name
  155950. */
  155951. static readonly Name: string;
  155952. /**
  155953. * The (Babylon) version of this module.
  155954. * This is an integer representing the implementation version.
  155955. * This number does not correspond to the WebXR specs version
  155956. */
  155957. static readonly Version: number;
  155958. /**
  155959. * This observable will notify registered observers when a new hand object was added and initialized
  155960. */
  155961. onHandAddedObservable: Observable<WebXRHand>;
  155962. /**
  155963. * This observable will notify its observers right before the hand object is disposed
  155964. */
  155965. onHandRemovedObservable: Observable<WebXRHand>;
  155966. private _hands;
  155967. /**
  155968. * Creates a new instance of the hit test feature
  155969. * @param _xrSessionManager an instance of WebXRSessionManager
  155970. * @param options options to use when constructing this feature
  155971. */
  155972. constructor(_xrSessionManager: WebXRSessionManager,
  155973. /**
  155974. * options to use when constructing this feature
  155975. */
  155976. options: IWebXRHandTrackingOptions);
  155977. /**
  155978. * Check if the needed objects are defined.
  155979. * This does not mean that the feature is enabled, but that the objects needed are well defined.
  155980. */
  155981. isCompatible(): boolean;
  155982. /**
  155983. * attach this feature
  155984. * Will usually be called by the features manager
  155985. *
  155986. * @returns true if successful.
  155987. */
  155988. attach(): boolean;
  155989. /**
  155990. * detach this feature.
  155991. * Will usually be called by the features manager
  155992. *
  155993. * @returns true if successful.
  155994. */
  155995. detach(): boolean;
  155996. /**
  155997. * Dispose this feature and all of the resources attached
  155998. */
  155999. dispose(): void;
  156000. /**
  156001. * Get the hand object according to the controller id
  156002. * @param controllerId the controller id to which we want to get the hand
  156003. * @returns null if not found or the WebXRHand object if found
  156004. */
  156005. getHandByControllerId(controllerId: string): Nullable<WebXRHand>;
  156006. /**
  156007. * Get a hand object according to the requested handedness
  156008. * @param handedness the handedness to request
  156009. * @returns null if not found or the WebXRHand object if found
  156010. */
  156011. getHandByHandedness(handedness: XRHandedness): Nullable<WebXRHand>;
  156012. protected _onXRFrame(_xrFrame: XRFrame): void;
  156013. private _attachHand;
  156014. private _detachHand;
  156015. }
  156016. }
  156017. declare module BABYLON {
  156018. /**
  156019. * The motion controller class for all microsoft mixed reality controllers
  156020. */
  156021. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  156022. protected readonly _mapping: {
  156023. defaultButton: {
  156024. valueNodeName: string;
  156025. unpressedNodeName: string;
  156026. pressedNodeName: string;
  156027. };
  156028. defaultAxis: {
  156029. valueNodeName: string;
  156030. minNodeName: string;
  156031. maxNodeName: string;
  156032. };
  156033. buttons: {
  156034. "xr-standard-trigger": {
  156035. rootNodeName: string;
  156036. componentProperty: string;
  156037. states: string[];
  156038. };
  156039. "xr-standard-squeeze": {
  156040. rootNodeName: string;
  156041. componentProperty: string;
  156042. states: string[];
  156043. };
  156044. "xr-standard-touchpad": {
  156045. rootNodeName: string;
  156046. labelAnchorNodeName: string;
  156047. touchPointNodeName: string;
  156048. };
  156049. "xr-standard-thumbstick": {
  156050. rootNodeName: string;
  156051. componentProperty: string;
  156052. states: string[];
  156053. };
  156054. };
  156055. axes: {
  156056. "xr-standard-touchpad": {
  156057. "x-axis": {
  156058. rootNodeName: string;
  156059. };
  156060. "y-axis": {
  156061. rootNodeName: string;
  156062. };
  156063. };
  156064. "xr-standard-thumbstick": {
  156065. "x-axis": {
  156066. rootNodeName: string;
  156067. };
  156068. "y-axis": {
  156069. rootNodeName: string;
  156070. };
  156071. };
  156072. };
  156073. };
  156074. /**
  156075. * The base url used to load the left and right controller models
  156076. */
  156077. static MODEL_BASE_URL: string;
  156078. /**
  156079. * The name of the left controller model file
  156080. */
  156081. static MODEL_LEFT_FILENAME: string;
  156082. /**
  156083. * The name of the right controller model file
  156084. */
  156085. static MODEL_RIGHT_FILENAME: string;
  156086. profileId: string;
  156087. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  156088. protected _getFilenameAndPath(): {
  156089. filename: string;
  156090. path: string;
  156091. };
  156092. protected _getModelLoadingConstraints(): boolean;
  156093. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  156094. protected _setRootMesh(meshes: AbstractMesh[]): void;
  156095. protected _updateModel(): void;
  156096. }
  156097. }
  156098. declare module BABYLON {
  156099. /**
  156100. * The motion controller class for oculus touch (quest, rift).
  156101. * This class supports legacy mapping as well the standard xr mapping
  156102. */
  156103. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  156104. private _forceLegacyControllers;
  156105. private _modelRootNode;
  156106. /**
  156107. * The base url used to load the left and right controller models
  156108. */
  156109. static MODEL_BASE_URL: string;
  156110. /**
  156111. * The name of the left controller model file
  156112. */
  156113. static MODEL_LEFT_FILENAME: string;
  156114. /**
  156115. * The name of the right controller model file
  156116. */
  156117. static MODEL_RIGHT_FILENAME: string;
  156118. /**
  156119. * Base Url for the Quest controller model.
  156120. */
  156121. static QUEST_MODEL_BASE_URL: string;
  156122. profileId: string;
  156123. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  156124. protected _getFilenameAndPath(): {
  156125. filename: string;
  156126. path: string;
  156127. };
  156128. protected _getModelLoadingConstraints(): boolean;
  156129. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  156130. protected _setRootMesh(meshes: AbstractMesh[]): void;
  156131. protected _updateModel(): void;
  156132. /**
  156133. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  156134. * between the touch and touch 2.
  156135. */
  156136. private _isQuest;
  156137. }
  156138. }
  156139. declare module BABYLON {
  156140. /**
  156141. * The motion controller class for the standard HTC-Vive controllers
  156142. */
  156143. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  156144. private _modelRootNode;
  156145. /**
  156146. * The base url used to load the left and right controller models
  156147. */
  156148. static MODEL_BASE_URL: string;
  156149. /**
  156150. * File name for the controller model.
  156151. */
  156152. static MODEL_FILENAME: string;
  156153. profileId: string;
  156154. /**
  156155. * Create a new Vive motion controller object
  156156. * @param scene the scene to use to create this controller
  156157. * @param gamepadObject the corresponding gamepad object
  156158. * @param handedness the handedness of the controller
  156159. */
  156160. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  156161. protected _getFilenameAndPath(): {
  156162. filename: string;
  156163. path: string;
  156164. };
  156165. protected _getModelLoadingConstraints(): boolean;
  156166. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  156167. protected _setRootMesh(meshes: AbstractMesh[]): void;
  156168. protected _updateModel(): void;
  156169. }
  156170. }
  156171. declare module BABYLON {
  156172. /**
  156173. * A cursor which tracks a point on a path
  156174. */
  156175. export class PathCursor {
  156176. private path;
  156177. /**
  156178. * Stores path cursor callbacks for when an onchange event is triggered
  156179. */
  156180. private _onchange;
  156181. /**
  156182. * The value of the path cursor
  156183. */
  156184. value: number;
  156185. /**
  156186. * The animation array of the path cursor
  156187. */
  156188. animations: Animation[];
  156189. /**
  156190. * Initializes the path cursor
  156191. * @param path The path to track
  156192. */
  156193. constructor(path: Path2);
  156194. /**
  156195. * Gets the cursor point on the path
  156196. * @returns A point on the path cursor at the cursor location
  156197. */
  156198. getPoint(): Vector3;
  156199. /**
  156200. * Moves the cursor ahead by the step amount
  156201. * @param step The amount to move the cursor forward
  156202. * @returns This path cursor
  156203. */
  156204. moveAhead(step?: number): PathCursor;
  156205. /**
  156206. * Moves the cursor behind by the step amount
  156207. * @param step The amount to move the cursor back
  156208. * @returns This path cursor
  156209. */
  156210. moveBack(step?: number): PathCursor;
  156211. /**
  156212. * Moves the cursor by the step amount
  156213. * If the step amount is greater than one, an exception is thrown
  156214. * @param step The amount to move the cursor
  156215. * @returns This path cursor
  156216. */
  156217. move(step: number): PathCursor;
  156218. /**
  156219. * Ensures that the value is limited between zero and one
  156220. * @returns This path cursor
  156221. */
  156222. private ensureLimits;
  156223. /**
  156224. * Runs onchange callbacks on change (used by the animation engine)
  156225. * @returns This path cursor
  156226. */
  156227. private raiseOnChange;
  156228. /**
  156229. * Executes a function on change
  156230. * @param f A path cursor onchange callback
  156231. * @returns This path cursor
  156232. */
  156233. onchange(f: (cursor: PathCursor) => void): PathCursor;
  156234. }
  156235. }
  156236. declare module BABYLON {
  156237. /** @hidden */
  156238. export var blurPixelShader: {
  156239. name: string;
  156240. shader: string;
  156241. };
  156242. }
  156243. declare module BABYLON {
  156244. /** @hidden */
  156245. export var pointCloudVertexDeclaration: {
  156246. name: string;
  156247. shader: string;
  156248. };
  156249. }
  156250. // Mixins
  156251. interface Window {
  156252. mozIndexedDB: IDBFactory;
  156253. webkitIndexedDB: IDBFactory;
  156254. msIndexedDB: IDBFactory;
  156255. webkitURL: typeof URL;
  156256. mozRequestAnimationFrame(callback: FrameRequestCallback): number;
  156257. oRequestAnimationFrame(callback: FrameRequestCallback): number;
  156258. WebGLRenderingContext: WebGLRenderingContext;
  156259. MSGesture: MSGesture;
  156260. CANNON: any;
  156261. AudioContext: AudioContext;
  156262. webkitAudioContext: AudioContext;
  156263. PointerEvent: any;
  156264. Math: Math;
  156265. Uint8Array: Uint8ArrayConstructor;
  156266. Float32Array: Float32ArrayConstructor;
  156267. mozURL: typeof URL;
  156268. msURL: typeof URL;
  156269. VRFrameData: any; // WebVR, from specs 1.1
  156270. DracoDecoderModule: any;
  156271. setImmediate(handler: (...args: any[]) => void): number;
  156272. }
  156273. interface HTMLCanvasElement {
  156274. requestPointerLock(): void;
  156275. msRequestPointerLock?(): void;
  156276. mozRequestPointerLock?(): void;
  156277. webkitRequestPointerLock?(): void;
  156278. /** Track wether a record is in progress */
  156279. isRecording: boolean;
  156280. /** Capture Stream method defined by some browsers */
  156281. captureStream(fps?: number): MediaStream;
  156282. }
  156283. interface CanvasRenderingContext2D {
  156284. msImageSmoothingEnabled: boolean;
  156285. }
  156286. interface MouseEvent {
  156287. mozMovementX: number;
  156288. mozMovementY: number;
  156289. webkitMovementX: number;
  156290. webkitMovementY: number;
  156291. msMovementX: number;
  156292. msMovementY: number;
  156293. }
  156294. interface Navigator {
  156295. mozGetVRDevices: (any: any) => any;
  156296. webkitGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  156297. mozGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  156298. msGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  156299. webkitGetGamepads(): Gamepad[];
  156300. msGetGamepads(): Gamepad[];
  156301. webkitGamepads(): Gamepad[];
  156302. }
  156303. interface HTMLVideoElement {
  156304. mozSrcObject: any;
  156305. }
  156306. interface Math {
  156307. fround(x: number): number;
  156308. imul(a: number, b: number): number;
  156309. }
  156310. interface WebGLRenderingContext {
  156311. drawArraysInstanced(mode: number, first: number, count: number, primcount: number): void;
  156312. drawElementsInstanced(mode: number, count: number, type: number, offset: number, primcount: number): void;
  156313. vertexAttribDivisor(index: number, divisor: number): void;
  156314. createVertexArray(): any;
  156315. bindVertexArray(vao?: WebGLVertexArrayObject | null): void;
  156316. deleteVertexArray(vao: WebGLVertexArrayObject): void;
  156317. blitFramebuffer(srcX0: number, srcY0: number, srcX1: number, srcY1: number, dstX0: number, dstY0: number, dstX1: number, dstY1: number, mask: number, filter: number): void;
  156318. renderbufferStorageMultisample?(target: number, samples: number, internalformat: number, width: number, height: number): void;
  156319. bindBufferBase(target: number, index: number, buffer: WebGLBuffer | null): void;
  156320. getUniformBlockIndex(program: WebGLProgram, uniformBlockName: string): number;
  156321. uniformBlockBinding(program: WebGLProgram, uniformBlockIndex: number, uniformBlockBinding: number): void;
  156322. // Queries
  156323. createQuery(): WebGLQuery;
  156324. deleteQuery(query: WebGLQuery): void;
  156325. beginQuery(target: number, query: WebGLQuery): void;
  156326. endQuery(target: number): void;
  156327. getQueryParameter(query: WebGLQuery, pname: number): any;
  156328. getQuery(target: number, pname: number): any;
  156329. MAX_SAMPLES: number;
  156330. RGBA8: number;
  156331. READ_FRAMEBUFFER: number;
  156332. DRAW_FRAMEBUFFER: number;
  156333. UNIFORM_BUFFER: number;
  156334. HALF_FLOAT_OES: number;
  156335. RGBA16F: number;
  156336. RGBA32F: number;
  156337. R32F: number;
  156338. RG32F: number;
  156339. RGB32F: number;
  156340. R16F: number;
  156341. RG16F: number;
  156342. RGB16F: number;
  156343. RED: number;
  156344. RG: number;
  156345. R8: number;
  156346. RG8: number;
  156347. UNSIGNED_INT_24_8: number;
  156348. DEPTH24_STENCIL8: number;
  156349. MIN: number;
  156350. MAX: number;
  156351. /* Multiple Render Targets */
  156352. drawBuffers(buffers: number[]): void;
  156353. readBuffer(src: number): void;
  156354. readonly COLOR_ATTACHMENT0: number; // 0x8CE1
  156355. readonly COLOR_ATTACHMENT1: number; // 0x8CE2
  156356. readonly COLOR_ATTACHMENT2: number; // 0x8CE3
  156357. readonly COLOR_ATTACHMENT3: number; // 0x8CE4
  156358. // Occlusion Query
  156359. ANY_SAMPLES_PASSED_CONSERVATIVE: number;
  156360. ANY_SAMPLES_PASSED: number;
  156361. QUERY_RESULT_AVAILABLE: number;
  156362. QUERY_RESULT: number;
  156363. }
  156364. interface WebGLProgram {
  156365. __SPECTOR_rebuildProgram?: ((vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (program: WebGLProgram) => void, onError: (message: string) => void) => void) | null;
  156366. }
  156367. interface EXT_disjoint_timer_query {
  156368. QUERY_COUNTER_BITS_EXT: number;
  156369. TIME_ELAPSED_EXT: number;
  156370. TIMESTAMP_EXT: number;
  156371. GPU_DISJOINT_EXT: number;
  156372. QUERY_RESULT_EXT: number;
  156373. QUERY_RESULT_AVAILABLE_EXT: number;
  156374. queryCounterEXT(query: WebGLQuery, target: number): void;
  156375. createQueryEXT(): WebGLQuery;
  156376. beginQueryEXT(target: number, query: WebGLQuery): void;
  156377. endQueryEXT(target: number): void;
  156378. getQueryObjectEXT(query: WebGLQuery, target: number): any;
  156379. deleteQueryEXT(query: WebGLQuery): void;
  156380. }
  156381. interface WebGLUniformLocation {
  156382. _currentState: any;
  156383. }
  156384. // Type definitions for WebGL 2, Editor's Draft Fri Feb 24 16:10:18 2017 -0800
  156385. // Project: https://www.khronos.org/registry/webgl/specs/latest/2.0/
  156386. // Definitions by: Nico Kemnitz <https://github.com/nkemnitz/>
  156387. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  156388. interface WebGLRenderingContext {
  156389. readonly RASTERIZER_DISCARD: number;
  156390. readonly DEPTH_COMPONENT24: number;
  156391. readonly TEXTURE_3D: number;
  156392. readonly TEXTURE_2D_ARRAY: number;
  156393. readonly TEXTURE_COMPARE_FUNC: number;
  156394. readonly TEXTURE_COMPARE_MODE: number;
  156395. readonly COMPARE_REF_TO_TEXTURE: number;
  156396. readonly TEXTURE_WRAP_R: number;
  156397. readonly HALF_FLOAT: number;
  156398. readonly RGB8: number;
  156399. readonly RED_INTEGER: number;
  156400. readonly RG_INTEGER: number;
  156401. readonly RGB_INTEGER: number;
  156402. readonly RGBA_INTEGER: number;
  156403. readonly R8_SNORM: number;
  156404. readonly RG8_SNORM: number;
  156405. readonly RGB8_SNORM: number;
  156406. readonly RGBA8_SNORM: number;
  156407. readonly R8I: number;
  156408. readonly RG8I: number;
  156409. readonly RGB8I: number;
  156410. readonly RGBA8I: number;
  156411. readonly R8UI: number;
  156412. readonly RG8UI: number;
  156413. readonly RGB8UI: number;
  156414. readonly RGBA8UI: number;
  156415. readonly R16I: number;
  156416. readonly RG16I: number;
  156417. readonly RGB16I: number;
  156418. readonly RGBA16I: number;
  156419. readonly R16UI: number;
  156420. readonly RG16UI: number;
  156421. readonly RGB16UI: number;
  156422. readonly RGBA16UI: number;
  156423. readonly R32I: number;
  156424. readonly RG32I: number;
  156425. readonly RGB32I: number;
  156426. readonly RGBA32I: number;
  156427. readonly R32UI: number;
  156428. readonly RG32UI: number;
  156429. readonly RGB32UI: number;
  156430. readonly RGBA32UI: number;
  156431. readonly RGB10_A2UI: number;
  156432. readonly R11F_G11F_B10F: number;
  156433. readonly RGB9_E5: number;
  156434. readonly RGB10_A2: number;
  156435. readonly UNSIGNED_INT_2_10_10_10_REV: number;
  156436. readonly UNSIGNED_INT_10F_11F_11F_REV: number;
  156437. readonly UNSIGNED_INT_5_9_9_9_REV: number;
  156438. readonly FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  156439. readonly DEPTH_COMPONENT32F: number;
  156440. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView | null): void;
  156441. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView, offset: number): void;
  156442. 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;
  156443. framebufferTextureLayer(target: number, attachment: number, texture: WebGLTexture | null, level: number, layer: number): void;
  156444. compressedTexImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, data: ArrayBufferView, offset?: number, length?: number): void;
  156445. readonly TRANSFORM_FEEDBACK: number;
  156446. readonly INTERLEAVED_ATTRIBS: number;
  156447. readonly TRANSFORM_FEEDBACK_BUFFER: number;
  156448. createTransformFeedback(): WebGLTransformFeedback;
  156449. deleteTransformFeedback(transformFeedbac: WebGLTransformFeedback): void;
  156450. bindTransformFeedback(target: number, transformFeedback: WebGLTransformFeedback | null): void;
  156451. beginTransformFeedback(primitiveMode: number): void;
  156452. endTransformFeedback(): void;
  156453. transformFeedbackVaryings(program: WebGLProgram, varyings: string[], bufferMode: number): void;
  156454. clearBufferfv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  156455. clearBufferiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  156456. clearBufferuiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  156457. clearBufferfi(buffer: number, drawbuffer: number, depth: number, stencil: number): void;
  156458. }
  156459. interface ImageBitmap {
  156460. readonly width: number;
  156461. readonly height: number;
  156462. close(): void;
  156463. }
  156464. interface WebGLQuery extends WebGLObject {
  156465. }
  156466. declare var WebGLQuery: {
  156467. prototype: WebGLQuery;
  156468. new(): WebGLQuery;
  156469. };
  156470. interface WebGLSampler extends WebGLObject {
  156471. }
  156472. declare var WebGLSampler: {
  156473. prototype: WebGLSampler;
  156474. new(): WebGLSampler;
  156475. };
  156476. interface WebGLSync extends WebGLObject {
  156477. }
  156478. declare var WebGLSync: {
  156479. prototype: WebGLSync;
  156480. new(): WebGLSync;
  156481. };
  156482. interface WebGLTransformFeedback extends WebGLObject {
  156483. }
  156484. declare var WebGLTransformFeedback: {
  156485. prototype: WebGLTransformFeedback;
  156486. new(): WebGLTransformFeedback;
  156487. };
  156488. interface WebGLVertexArrayObject extends WebGLObject {
  156489. }
  156490. declare var WebGLVertexArrayObject: {
  156491. prototype: WebGLVertexArrayObject;
  156492. new(): WebGLVertexArrayObject;
  156493. };
  156494. // Type definitions for WebVR API
  156495. // Project: https://w3c.github.io/webvr/
  156496. // Definitions by: six a <https://github.com/lostfictions>
  156497. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  156498. interface VRDisplay extends EventTarget {
  156499. /**
  156500. * Dictionary of capabilities describing the VRDisplay.
  156501. */
  156502. readonly capabilities: VRDisplayCapabilities;
  156503. /**
  156504. * z-depth defining the far plane of the eye view frustum
  156505. * enables mapping of values in the render target depth
  156506. * attachment to scene coordinates. Initially set to 10000.0.
  156507. */
  156508. depthFar: number;
  156509. /**
  156510. * z-depth defining the near plane of the eye view frustum
  156511. * enables mapping of values in the render target depth
  156512. * attachment to scene coordinates. Initially set to 0.01.
  156513. */
  156514. depthNear: number;
  156515. /**
  156516. * An identifier for this distinct VRDisplay. Used as an
  156517. * association point in the Gamepad API.
  156518. */
  156519. readonly displayId: number;
  156520. /**
  156521. * A display name, a user-readable name identifying it.
  156522. */
  156523. readonly displayName: string;
  156524. readonly isConnected: boolean;
  156525. readonly isPresenting: boolean;
  156526. /**
  156527. * If this VRDisplay supports room-scale experiences, the optional
  156528. * stage attribute contains details on the room-scale parameters.
  156529. */
  156530. readonly stageParameters: VRStageParameters | null;
  156531. /**
  156532. * Passing the value returned by `requestAnimationFrame` to
  156533. * `cancelAnimationFrame` will unregister the callback.
  156534. * @param handle Define the hanle of the request to cancel
  156535. */
  156536. cancelAnimationFrame(handle: number): void;
  156537. /**
  156538. * Stops presenting to the VRDisplay.
  156539. * @returns a promise to know when it stopped
  156540. */
  156541. exitPresent(): Promise<void>;
  156542. /**
  156543. * Return the current VREyeParameters for the given eye.
  156544. * @param whichEye Define the eye we want the parameter for
  156545. * @returns the eye parameters
  156546. */
  156547. getEyeParameters(whichEye: string): VREyeParameters;
  156548. /**
  156549. * Populates the passed VRFrameData with the information required to render
  156550. * the current frame.
  156551. * @param frameData Define the data structure to populate
  156552. * @returns true if ok otherwise false
  156553. */
  156554. getFrameData(frameData: VRFrameData): boolean;
  156555. /**
  156556. * Get the layers currently being presented.
  156557. * @returns the list of VR layers
  156558. */
  156559. getLayers(): VRLayer[];
  156560. /**
  156561. * Return a VRPose containing the future predicted pose of the VRDisplay
  156562. * when the current frame will be presented. The value returned will not
  156563. * change until JavaScript has returned control to the browser.
  156564. *
  156565. * The VRPose will contain the position, orientation, velocity,
  156566. * and acceleration of each of these properties.
  156567. * @returns the pose object
  156568. */
  156569. getPose(): VRPose;
  156570. /**
  156571. * Return the current instantaneous pose of the VRDisplay, with no
  156572. * prediction applied.
  156573. * @returns the current instantaneous pose
  156574. */
  156575. getImmediatePose(): VRPose;
  156576. /**
  156577. * The callback passed to `requestAnimationFrame` will be called
  156578. * any time a new frame should be rendered. When the VRDisplay is
  156579. * presenting the callback will be called at the native refresh
  156580. * rate of the HMD. When not presenting this function acts
  156581. * identically to how window.requestAnimationFrame acts. Content should
  156582. * make no assumptions of frame rate or vsync behavior as the HMD runs
  156583. * asynchronously from other displays and at differing refresh rates.
  156584. * @param callback Define the eaction to run next frame
  156585. * @returns the request handle it
  156586. */
  156587. requestAnimationFrame(callback: FrameRequestCallback): number;
  156588. /**
  156589. * Begin presenting to the VRDisplay. Must be called in response to a user gesture.
  156590. * Repeat calls while already presenting will update the VRLayers being displayed.
  156591. * @param layers Define the list of layer to present
  156592. * @returns a promise to know when the request has been fulfilled
  156593. */
  156594. requestPresent(layers: VRLayer[]): Promise<void>;
  156595. /**
  156596. * Reset the pose for this display, treating its current position and
  156597. * orientation as the "origin/zero" values. VRPose.position,
  156598. * VRPose.orientation, and VRStageParameters.sittingToStandingTransform may be
  156599. * updated when calling resetPose(). This should be called in only
  156600. * sitting-space experiences.
  156601. */
  156602. resetPose(): void;
  156603. /**
  156604. * The VRLayer provided to the VRDisplay will be captured and presented
  156605. * in the HMD. Calling this function has the same effect on the source
  156606. * canvas as any other operation that uses its source image, and canvases
  156607. * created without preserveDrawingBuffer set to true will be cleared.
  156608. * @param pose Define the pose to submit
  156609. */
  156610. submitFrame(pose?: VRPose): void;
  156611. }
  156612. declare var VRDisplay: {
  156613. prototype: VRDisplay;
  156614. new(): VRDisplay;
  156615. };
  156616. interface VRLayer {
  156617. leftBounds?: number[] | Float32Array | null;
  156618. rightBounds?: number[] | Float32Array | null;
  156619. source?: HTMLCanvasElement | null;
  156620. }
  156621. interface VRDisplayCapabilities {
  156622. readonly canPresent: boolean;
  156623. readonly hasExternalDisplay: boolean;
  156624. readonly hasOrientation: boolean;
  156625. readonly hasPosition: boolean;
  156626. readonly maxLayers: number;
  156627. }
  156628. interface VREyeParameters {
  156629. /** @deprecated */
  156630. readonly fieldOfView: VRFieldOfView;
  156631. readonly offset: Float32Array;
  156632. readonly renderHeight: number;
  156633. readonly renderWidth: number;
  156634. }
  156635. interface VRFieldOfView {
  156636. readonly downDegrees: number;
  156637. readonly leftDegrees: number;
  156638. readonly rightDegrees: number;
  156639. readonly upDegrees: number;
  156640. }
  156641. interface VRFrameData {
  156642. readonly leftProjectionMatrix: Float32Array;
  156643. readonly leftViewMatrix: Float32Array;
  156644. readonly pose: VRPose;
  156645. readonly rightProjectionMatrix: Float32Array;
  156646. readonly rightViewMatrix: Float32Array;
  156647. readonly timestamp: number;
  156648. }
  156649. interface VRPose {
  156650. readonly angularAcceleration: Float32Array | null;
  156651. readonly angularVelocity: Float32Array | null;
  156652. readonly linearAcceleration: Float32Array | null;
  156653. readonly linearVelocity: Float32Array | null;
  156654. readonly orientation: Float32Array | null;
  156655. readonly position: Float32Array | null;
  156656. readonly timestamp: number;
  156657. }
  156658. interface VRStageParameters {
  156659. sittingToStandingTransform?: Float32Array;
  156660. sizeX?: number;
  156661. sizeY?: number;
  156662. }
  156663. interface Navigator {
  156664. getVRDisplays(): Promise<VRDisplay[]>;
  156665. readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
  156666. }
  156667. interface Window {
  156668. onvrdisplayconnected: ((this: Window, ev: Event) => any) | null;
  156669. onvrdisplaydisconnected: ((this: Window, ev: Event) => any) | null;
  156670. onvrdisplaypresentchange: ((this: Window, ev: Event) => any) | null;
  156671. addEventListener(type: "vrdisplayconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  156672. addEventListener(type: "vrdisplaydisconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  156673. addEventListener(type: "vrdisplaypresentchange", listener: (ev: Event) => any, useCapture?: boolean): void;
  156674. }
  156675. interface Gamepad {
  156676. readonly displayId: number;
  156677. }
  156678. type XRSessionMode = "inline" | "immersive-vr" | "immersive-ar";
  156679. type XRReferenceSpaceType = "viewer" | "local" | "local-floor" | "bounded-floor" | "unbounded";
  156680. type XREnvironmentBlendMode = "opaque" | "additive" | "alpha-blend";
  156681. type XRVisibilityState = "visible" | "visible-blurred" | "hidden";
  156682. type XRHandedness = "none" | "left" | "right";
  156683. type XRTargetRayMode = "gaze" | "tracked-pointer" | "screen";
  156684. type XREye = "none" | "left" | "right";
  156685. type XREventType = "devicechange" | "visibilitychange" | "end" | "inputsourceschange" | "select" | "selectstart" | "selectend" | "squeeze" | "squeezestart" | "squeezeend" | "reset";
  156686. interface XRSpace extends EventTarget {}
  156687. interface XRRenderState {
  156688. depthNear?: number;
  156689. depthFar?: number;
  156690. inlineVerticalFieldOfView?: number;
  156691. baseLayer?: XRWebGLLayer;
  156692. }
  156693. interface XRInputSource {
  156694. handedness: XRHandedness;
  156695. targetRayMode: XRTargetRayMode;
  156696. targetRaySpace: XRSpace;
  156697. gripSpace: XRSpace | undefined;
  156698. gamepad: Gamepad | undefined;
  156699. profiles: Array<string>;
  156700. hand: XRHand | undefined;
  156701. }
  156702. interface XRSessionInit {
  156703. optionalFeatures?: string[];
  156704. requiredFeatures?: string[];
  156705. }
  156706. interface XRSession {
  156707. addEventListener: Function;
  156708. removeEventListener: Function;
  156709. requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  156710. updateRenderState(XRRenderStateInit: XRRenderState): Promise<void>;
  156711. requestAnimationFrame: Function;
  156712. end(): Promise<void>;
  156713. renderState: XRRenderState;
  156714. inputSources: Array<XRInputSource>;
  156715. // hit test
  156716. requestHitTestSource(options: XRHitTestOptionsInit): Promise<XRHitTestSource>;
  156717. requestHitTestSourceForTransientInput(options: XRTransientInputHitTestOptionsInit): Promise<XRTransientInputHitTestSource>;
  156718. // legacy AR hit test
  156719. requestHitTest(ray: XRRay, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  156720. // legacy plane detection
  156721. updateWorldTrackingState(options: { planeDetectionState?: { enabled: boolean } }): void;
  156722. }
  156723. interface XRReferenceSpace extends XRSpace {
  156724. getOffsetReferenceSpace(originOffset: XRRigidTransform): XRReferenceSpace;
  156725. onreset: any;
  156726. }
  156727. type XRPlaneSet = Set<XRPlane>;
  156728. type XRAnchorSet = Set<XRAnchor>;
  156729. interface XRFrame {
  156730. session: XRSession;
  156731. getViewerPose(referenceSpace: XRReferenceSpace): XRViewerPose | undefined;
  156732. getPose(space: XRSpace, baseSpace: XRSpace): XRPose | undefined;
  156733. // AR
  156734. getHitTestResults(hitTestSource: XRHitTestSource): Array<XRHitTestResult>;
  156735. getHitTestResultsForTransientInput(hitTestSource: XRTransientInputHitTestSource): Array<XRTransientInputHitTestResult>;
  156736. // Anchors
  156737. trackedAnchors?: XRAnchorSet;
  156738. createAnchor(pose: XRRigidTransform, space: XRSpace): Promise<XRAnchor>;
  156739. // Planes
  156740. worldInformation: {
  156741. detectedPlanes?: XRPlaneSet;
  156742. };
  156743. // Hand tracking
  156744. getJointPose(joint: XRJointSpace, baseSpace: XRSpace): XRJointPose;
  156745. }
  156746. interface XRViewerPose extends XRPose {
  156747. views: Array<XRView>;
  156748. }
  156749. interface XRPose {
  156750. transform: XRRigidTransform;
  156751. emulatedPosition: boolean;
  156752. }
  156753. interface XRWebGLLayerOptions {
  156754. antialias?: boolean;
  156755. depth?: boolean;
  156756. stencil?: boolean;
  156757. alpha?: boolean;
  156758. multiview?: boolean;
  156759. framebufferScaleFactor?: number;
  156760. }
  156761. declare var XRWebGLLayer: {
  156762. prototype: XRWebGLLayer;
  156763. new (session: XRSession, context: WebGLRenderingContext | undefined, options?: XRWebGLLayerOptions): XRWebGLLayer;
  156764. };
  156765. interface XRWebGLLayer {
  156766. framebuffer: WebGLFramebuffer;
  156767. framebufferWidth: number;
  156768. framebufferHeight: number;
  156769. getViewport: Function;
  156770. }
  156771. declare class XRRigidTransform {
  156772. constructor(matrix: Float32Array | DOMPointInit, direction?: DOMPointInit);
  156773. position: DOMPointReadOnly;
  156774. orientation: DOMPointReadOnly;
  156775. matrix: Float32Array;
  156776. inverse: XRRigidTransform;
  156777. }
  156778. interface XRView {
  156779. eye: XREye;
  156780. projectionMatrix: Float32Array;
  156781. transform: XRRigidTransform;
  156782. }
  156783. interface XRInputSourceChangeEvent {
  156784. session: XRSession;
  156785. removed: Array<XRInputSource>;
  156786. added: Array<XRInputSource>;
  156787. }
  156788. interface XRInputSourceEvent extends Event {
  156789. readonly frame: XRFrame;
  156790. readonly inputSource: XRInputSource;
  156791. }
  156792. // Experimental(er) features
  156793. declare class XRRay {
  156794. constructor(transformOrOrigin: XRRigidTransform | DOMPointInit, direction?: DOMPointInit);
  156795. origin: DOMPointReadOnly;
  156796. direction: DOMPointReadOnly;
  156797. matrix: Float32Array;
  156798. }
  156799. declare enum XRHitTestTrackableType {
  156800. "point",
  156801. "plane",
  156802. "mesh",
  156803. }
  156804. interface XRHitResult {
  156805. hitMatrix: Float32Array;
  156806. }
  156807. interface XRTransientInputHitTestResult {
  156808. readonly inputSource: XRInputSource;
  156809. readonly results: Array<XRHitTestResult>;
  156810. }
  156811. interface XRHitTestResult {
  156812. getPose(baseSpace: XRSpace): XRPose | undefined;
  156813. // When anchor system is enabled
  156814. createAnchor?(pose: XRRigidTransform): Promise<XRAnchor>;
  156815. }
  156816. interface XRHitTestSource {
  156817. cancel(): void;
  156818. }
  156819. interface XRTransientInputHitTestSource {
  156820. cancel(): void;
  156821. }
  156822. interface XRHitTestOptionsInit {
  156823. space: XRSpace;
  156824. entityTypes?: Array<XRHitTestTrackableType>;
  156825. offsetRay?: XRRay;
  156826. }
  156827. interface XRTransientInputHitTestOptionsInit {
  156828. profile: string;
  156829. entityTypes?: Array<XRHitTestTrackableType>;
  156830. offsetRay?: XRRay;
  156831. }
  156832. interface XRAnchor {
  156833. anchorSpace: XRSpace;
  156834. delete(): void;
  156835. }
  156836. interface XRPlane {
  156837. orientation: "Horizontal" | "Vertical";
  156838. planeSpace: XRSpace;
  156839. polygon: Array<DOMPointReadOnly>;
  156840. lastChangedTime: number;
  156841. }
  156842. interface XRJointSpace extends XRSpace {}
  156843. interface XRJointPose extends XRPose {
  156844. radius: number | undefined;
  156845. }
  156846. interface XRHand /*extends Iterablele<XRJointSpace>*/ {
  156847. readonly length: number;
  156848. [index: number]: XRJointSpace;
  156849. // Specs have the function 'joint(idx: number)', but chrome doesn't support it yet.
  156850. readonly WRIST: number;
  156851. readonly THUMB_METACARPAL: number;
  156852. readonly THUMB_PHALANX_PROXIMAL: number;
  156853. readonly THUMB_PHALANX_DISTAL: number;
  156854. readonly THUMB_PHALANX_TIP: number;
  156855. readonly INDEX_METACARPAL: number;
  156856. readonly INDEX_PHALANX_PROXIMAL: number;
  156857. readonly INDEX_PHALANX_INTERMEDIATE: number;
  156858. readonly INDEX_PHALANX_DISTAL: number;
  156859. readonly INDEX_PHALANX_TIP: number;
  156860. readonly MIDDLE_METACARPAL: number;
  156861. readonly MIDDLE_PHALANX_PROXIMAL: number;
  156862. readonly MIDDLE_PHALANX_INTERMEDIATE: number;
  156863. readonly MIDDLE_PHALANX_DISTAL: number;
  156864. readonly MIDDLE_PHALANX_TIP: number;
  156865. readonly RING_METACARPAL: number;
  156866. readonly RING_PHALANX_PROXIMAL: number;
  156867. readonly RING_PHALANX_INTERMEDIATE: number;
  156868. readonly RING_PHALANX_DISTAL: number;
  156869. readonly RING_PHALANX_TIP: number;
  156870. readonly LITTLE_METACARPAL: number;
  156871. readonly LITTLE_PHALANX_PROXIMAL: number;
  156872. readonly LITTLE_PHALANX_INTERMEDIATE: number;
  156873. readonly LITTLE_PHALANX_DISTAL: number;
  156874. readonly LITTLE_PHALANX_TIP: number;
  156875. }
  156876. // This file contains native only extensions for WebXR These APIs are not supported in the browser yet.
  156877. // They are intended for use with either Babylon Native https://github.com/BabylonJS/BabylonNative or
  156878. // Babylon React Native: https://github.com/BabylonJS/BabylonReactNative
  156879. interface XRSession {
  156880. trySetFeaturePointCloudEnabled(enabled: boolean): boolean;
  156881. }
  156882. interface XRFrame {
  156883. featurePointCloud? : Array<number>;
  156884. }